init.h File Reference

Include dependency graph for init.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	vlib_config_function_runtime_t

Macros
#define	VLIB_REMOVE_FROM_LINKED_LIST(first, p, next)
#define	VLIB_INIT_FUNCTION_SYMBOL(x)   _VLIB_INIT_FUNCTION_SYMBOL(x, init)
#define	VLIB_MAIN_LOOP_ENTER_FUNCTION_SYMBOL(x)   _VLIB_INIT_FUNCTION_SYMBOL(x, main_loop_enter)
#define	VLIB_MAIN_LOOP_EXIT_FUNCTION_SYMBOL(x)   _VLIB_INIT_FUNCTION_SYMBOL(x, main_loop_exit)
#define	VLIB_CONFIG_FUNCTION_SYMBOL(x)   _VLIB_INIT_FUNCTION_SYMBOL(x, config)
#define	VLIB_DECLARE_INIT_FUNCTION(x, tag)
#define	VLIB_INIT_FUNCTION(x)   VLIB_DECLARE_INIT_FUNCTION(x,init)
#define	VLIB_WORKER_INIT_FUNCTION(x)   VLIB_DECLARE_INIT_FUNCTION(x,worker_init)
#define	VLIB_MAIN_LOOP_ENTER_FUNCTION(x)   VLIB_DECLARE_INIT_FUNCTION(x,main_loop_enter)
#define	VLIB_MAIN_LOOP_EXIT_FUNCTION(x)   VLIB_DECLARE_INIT_FUNCTION(x,main_loop_exit)
#define	VLIB_CONFIG_FUNCTION(x, n, ...)
#define	VLIB_EARLY_CONFIG_FUNCTION(x, n, ...)
#define	vlib_call_init_function(vm, x)
#define	vlib_mark_init_function_complete(vm, x)
#define	vlib_call_post_graph_init_function(vm, x)
#define	vlib_call_config_function(vm, x)
#define	foreach_vlib_module_reference

Typedefs
typedef clib_error_t *()	vlib_init_function_t(struct vlib_main_t *vm)
typedef clib_error_t *()	vlib_config_function_t(struct vlib_main_t *vm, unformat_input_t *input)
typedef struct vlib_config_function_runtime_t	vlib_config_function_runtime_t

Functions
clib_error_t *	vlib_call_all_init_functions (struct vlib_main_t *vm)
clib_error_t *	vlib_call_all_config_functions (struct vlib_main_t *vm, unformat_input_t *input, int is_early)
clib_error_t *	vlib_call_all_main_loop_enter_functions (struct vlib_main_t *vm)
clib_error_t *	vlib_call_all_main_loop_exit_functions (struct vlib_main_t *vm)
clib_error_t *	vlib_call_init_exit_functions (struct vlib_main_t *vm, _vlib_init_function_list_elt_t *head, int call_once)

Macro Definition Documentation

foreach_vlib_module_reference

#define foreach_vlib_module_reference

Value:

_ (node_cli)                                    \
  _ (trace_cli)

Definition at line 322 of file init.h.

vlib_call_config_function

#define vlib_call_config_function	(		vm,
			x
	)

Value:

({                                                              \
    vlib_config_function_runtime_t * _r;                        \
    clib_error_t * _error = 0;                                  \
    extern vlib_config_function_runtime_t			\
      VLIB_CONFIG_FUNCTION_SYMBOL (x);                          \
                                                                \
    _r = &VLIB_CONFIG_FUNCTION_SYMBOL (x);                      \
    if (! hash_get (vm->init_functions_called, _r->function))   \
      {                                                         \
        hash_set1 (vm->init_functions_called, _r->function);    \
        _error = _r->function (vm, &_r->input);                 \
      }                                                         \
    _error;                                                     \
  })

Definition at line 294 of file init.h.

vlib_call_init_function

#define vlib_call_init_function	(		vm,
			x
	)

Value:

({                                                                      \
    extern vlib_init_function_t * VLIB_INIT_FUNCTION_SYMBOL (x);        \
    vlib_init_function_t * _f = VLIB_INIT_FUNCTION_SYMBOL (x);          \
    clib_error_t * _error = 0;                                          \
    if (! hash_get (vm->init_functions_called, _f))                     \
      {                                                                 \
        hash_set1 (vm->init_functions_called, _f);                      \
        _error = _f (vm);                                               \
      }                                                                 \
    _error;                                                             \
  })

Definition at line 260 of file init.h.

vlib_call_post_graph_init_function

#define vlib_call_post_graph_init_function	(		vm,
			x
	)

Value:

({                                                                      \
    extern vlib_init_function_t * VLIB_POST_GRAPH_INIT_FUNCTION_SYMBOL (x); \
    vlib_init_function_t * _f = VLIB_POST_GRAPH_INIT_FUNCTION_SYMBOL (x); \
    clib_error_t * _error = 0;                                          \
    if (! hash_get (vm->init_functions_called, _f))                     \
      {                                                                 \
        hash_set1 (vm->init_functions_called, _f);                      \
        _error = _f (vm);                                               \
      }                                                                 \
    _error;                                                             \
  })

Definition at line 281 of file init.h.

VLIB_CONFIG_FUNCTION

#define VLIB_CONFIG_FUNCTION	(		x,
			n,
			...
	)

Value:

__VA_ARGS__ vlib_config_function_runtime_t                  \
    VLIB_CONFIG_FUNCTION_SYMBOL(x);                             \
static void __vlib_add_config_function_##x (void)               \
    __attribute__((__constructor__)) ;                          \
static void __vlib_add_config_function_##x (void)               \
{                                                               \
    vlib_main_t * vm = vlib_get_main();                         \
    VLIB_CONFIG_FUNCTION_SYMBOL(x).next_registration            \
       = vm->config_function_registrations;                     \
    vm->config_function_registrations                           \
       = &VLIB_CONFIG_FUNCTION_SYMBOL(x);                       \
}                                                               \
static void __vlib_rm_config_function_##x (void)                \
    __attribute__((__destructor__)) ;                           \
static void __vlib_rm_config_function_##x (void)                \
{                                                               \
    vlib_main_t * vm = vlib_get_main();                         \
    vlib_config_function_runtime_t *p =                         \
       & VLIB_CONFIG_FUNCTION_SYMBOL (x);                       \
    VLIB_REMOVE_FROM_LINKED_LIST                                \
      (vm->config_function_registrations, p, next_registration);\
}                                                               \
  vlib_config_function_runtime_t                                \
    VLIB_CONFIG_FUNCTION_SYMBOL (x)                             \
  = {                                                           \
    .name = n,                                                  \
    .function = x,                                              \
    .is_early = 0,                                              \
  }

Definition at line 172 of file init.h.

VLIB_CONFIG_FUNCTION_SYMBOL

#define VLIB_CONFIG_FUNCTION_SYMBOL

(

x

)

_VLIB_INIT_FUNCTION_SYMBOL(x, config)

Definition at line 112 of file init.h.

VLIB_DECLARE_INIT_FUNCTION

#define VLIB_DECLARE_INIT_FUNCTION	(		x,
			tag
	)

Value:

vlib_init_function_t * _VLIB_INIT_FUNCTION_SYMBOL (x, tag) = x; \
static void __vlib_add_##tag##_function_##x (void)              \
    __attribute__((__constructor__)) ;                          \
static void __vlib_add_##tag##_function_##x (void)              \
{                                                               \
 vlib_main_t * vm = vlib_get_main();                            \
 static _vlib_init_function_list_elt_t _vlib_init_function;     \
 _vlib_init_function.next_init_function                         \
    = vm->tag##_function_registrations;                         \
  vm->tag##_function_registrations = &_vlib_init_function;      \
 _vlib_init_function.f = &x;                                    \
}                                                               \
static void __vlib_rm_##tag##_function_##x (void)               \
    __attribute__((__destructor__)) ;                           \
static void __vlib_rm_##tag##_function_##x (void)               \
{                                                               \
  vlib_main_t * vm = vlib_get_main();                           \
  _vlib_init_function_list_elt_t *next;                         \
  if (vm->tag##_function_registrations->f == &x)                \
    {                                                           \
      vm->tag##_function_registrations =                        \
        vm->tag##_function_registrations->next_init_function;   \
      return;                                                   \
    }                                                           \
  next = vm->tag##_function_registrations;                      \
  while (next->next_init_function)                              \
    {                                                           \
      if (next->next_init_function->f == &x)                    \
        {                                                       \
          next->next_init_function =                            \
            next->next_init_function->next_init_function;       \
          return;                                               \
        }                                                       \
      next = next->next_init_function;                          \
    }                                                           \
}

Definition at line 119 of file init.h.

VLIB_EARLY_CONFIG_FUNCTION

#define VLIB_EARLY_CONFIG_FUNCTION	(		x,
			n,
			...
	)

Value:

__VA_ARGS__ vlib_config_function_runtime_t                  \
    VLIB_CONFIG_FUNCTION_SYMBOL(x);                             \
static void __vlib_add_config_function_##x (void)               \
    __attribute__((__constructor__)) ;                          \
static void __vlib_add_config_function_##x (void)               \
{                                                               \
    vlib_main_t * vm = vlib_get_main();                         \
    VLIB_CONFIG_FUNCTION_SYMBOL(x).next_registration            \
       = vm->config_function_registrations;                     \
    vm->config_function_registrations                           \
       = &VLIB_CONFIG_FUNCTION_SYMBOL(x);                       \
}                                                               \
static void __vlib_rm_config_function_##x (void)                \
    __attribute__((__destructor__)) ;                           \
static void __vlib_rm_config_function_##x (void)                \
{                                                               \
    vlib_main_t * vm = vlib_get_main();                         \
    vlib_config_function_runtime_t *p =                         \
       & VLIB_CONFIG_FUNCTION_SYMBOL (x);                       \
    VLIB_REMOVE_FROM_LINKED_LIST                                \
      (vm->config_function_registrations, p, next_registration);\
}                                                               \
  vlib_config_function_runtime_t                                \
    VLIB_CONFIG_FUNCTION_SYMBOL (x)                             \
  = {                                                           \
    .name = n,                                                  \
    .function = x,                                              \
    .is_early = 1,                                              \
  }

Definition at line 216 of file init.h.

VLIB_INIT_FUNCTION

#define VLIB_INIT_FUNCTION

(

x

)

VLIB_DECLARE_INIT_FUNCTION(x,init)

Definition at line 163 of file init.h.

VLIB_INIT_FUNCTION_SYMBOL

#define VLIB_INIT_FUNCTION_SYMBOL

(

x

)

_VLIB_INIT_FUNCTION_SYMBOL(x, init)

Definition at line 106 of file init.h.

VLIB_MAIN_LOOP_ENTER_FUNCTION

#define VLIB_MAIN_LOOP_ENTER_FUNCTION

(

x

)

VLIB_DECLARE_INIT_FUNCTION(x,main_loop_enter)

Definition at line 166 of file init.h.

VLIB_MAIN_LOOP_ENTER_FUNCTION_SYMBOL

#define VLIB_MAIN_LOOP_ENTER_FUNCTION_SYMBOL

(

x

)

_VLIB_INIT_FUNCTION_SYMBOL(x, main_loop_enter)

Definition at line 108 of file init.h.

VLIB_MAIN_LOOP_EXIT_FUNCTION

#define VLIB_MAIN_LOOP_EXIT_FUNCTION

(

x

)

VLIB_DECLARE_INIT_FUNCTION(x,main_loop_exit)

Definition at line 168 of file init.h.

VLIB_MAIN_LOOP_EXIT_FUNCTION_SYMBOL

#define VLIB_MAIN_LOOP_EXIT_FUNCTION_SYMBOL

(

x

)

_VLIB_INIT_FUNCTION_SYMBOL(x, main_loop_exit)

Definition at line 110 of file init.h.

vlib_mark_init_function_complete

#define vlib_mark_init_function_complete	(		vm,
			x
	)

Value:

({                                                                      \
    extern vlib_init_function_t * VLIB_INIT_FUNCTION_SYMBOL (x);        \
    vlib_init_function_t * _f = VLIB_INIT_FUNCTION_SYMBOL (x);          \
    hash_set1 (vm->init_functions_called, _f);                          \
  })

Definition at line 274 of file init.h.

VLIB_REMOVE_FROM_LINKED_LIST

#define VLIB_REMOVE_FROM_LINKED_LIST	(		first,
			p,
			next
	)

Value:

{                                                               \
  ASSERT (first);                                               \
  if (first == p)                                               \
      first = (p)->next;                                        \
  else                                                          \
    {                                                           \
      __typeof__ (p) current = first;                           \
      while (current->next)                                     \
        {                                                       \
          if (current->next == p)                               \
            {                                                   \
              current->next = current->next->next;              \
              break;                                            \
            }                                                   \
          current = current->next;                              \
        }                                                       \
      ASSERT (current);                                         \
    }                                                           \
}

Definition at line 82 of file init.h.

VLIB_WORKER_INIT_FUNCTION

#define VLIB_WORKER_INIT_FUNCTION

(

x

)

VLIB_DECLARE_INIT_FUNCTION(x,worker_init)

Definition at line 164 of file init.h.

Typedef Documentation

vlib_config_function_runtime_t

typedef struct vlib_config_function_runtime_t vlib_config_function_runtime_t

vlib_config_function_t

typedef clib_error_t*() vlib_config_function_t(struct vlib_main_t *vm, unformat_input_t *input)

Definition at line 61 of file init.h.

vlib_init_function_t

typedef clib_error_t*() vlib_init_function_t(struct vlib_main_t *vm)

Definition at line 51 of file init.h.

Function Documentation

vlib_call_all_config_functions()

clib_error_t* vlib_call_all_config_functions	(	struct vlib_main_t *	vm,
		unformat_input_t *	input,
		int	is_early
	)

Definition at line 94 of file init.c.

Here is the call graph for this function:

Here is the caller graph for this function:

vlib_call_all_init_functions()

clib_error_t* vlib_call_all_init_functions

(

struct vlib_main_t *

vm

)

Definition at line 67 of file init.c.

Here is the call graph for this function:

Here is the caller graph for this function:

vlib_call_all_main_loop_enter_functions()

clib_error_t* vlib_call_all_main_loop_enter_functions

(

struct vlib_main_t *

vm

)

Definition at line 80 of file init.c.

Here is the call graph for this function:

vlib_call_all_main_loop_exit_functions()

clib_error_t* vlib_call_all_main_loop_exit_functions

(

struct vlib_main_t *

vm

)

Definition at line 87 of file init.c.

Here is the call graph for this function:

vlib_call_init_exit_functions()

clib_error_t* vlib_call_init_exit_functions	(	struct vlib_main_t *	vm,
		_vlib_init_function_list_elt_t *	head,
		int	call_once
	)

Definition at line 43 of file init.c.

Here is the caller graph for this function: