FD.io VPP  v18.07.1-19-g511ce25
Vector Packet Processing
node.h File Reference
+ Include dependency graph for node.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  vlib_node_stats_t
 
struct  vlib_node_t
 
struct  vlib_frame_t
 
struct  vlib_next_frame_t
 
struct  vlib_pending_frame_t
 
struct  vlib_node_runtime_t
 
struct  vlib_frame_size_t
 
struct  vlib_process_event_type_t
 
struct  vlib_process_t
 
struct  vlib_one_time_waiting_process_t
 
struct  vlib_signal_timed_event_data_t
 
struct  vlib_node_main_t
 
struct  frame_queue_trace_t
 
struct  frame_queue_nelt_counter_t
 

Macros

#define VLIB_REGISTER_NODE(x, ...)
 
#define VLIB_NODE_FN(node)
 
#define VLIB_NODE_FUNCTION_CLONE_TEMPLATE(arch, fn)
 
#define VLIB_NODE_FUNCTION_MULTIARCH_CLONE(fn)
 
#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
 
#define foreach_vlib_node_state
 
#define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH   (1 << 0)
 
#define VLIB_NODE_FLAG_IS_OUTPUT   (1 << 1)
 
#define VLIB_NODE_FLAG_IS_DROP   (1 << 2)
 
#define VLIB_NODE_FLAG_IS_PUNT   (1 << 3)
 
#define VLIB_NODE_FLAG_IS_HANDOFF   (1 << 4)
 
#define VLIB_NODE_FLAG_TRACE   (1 << 5)
 
#define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE   (1 << 6)
 
#define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE   (1 << 7)
 
#define VLIB_INVALID_NODE_INDEX   ((u32) ~0)
 
#define VLIB_FRAME_SIZE   256
 
#define VLIB_FRAME_ALIGN   CLIB_CACHE_LINE_BYTES
 
#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH   VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
 
#define VLIB_FRAME_OWNER   (1 << 15)
 
#define VLIB_FRAME_IS_ALLOCATED   VLIB_NODE_FLAG_IS_OUTPUT
 
#define VLIB_FRAME_PENDING   VLIB_NODE_FLAG_IS_DROP
 
#define VLIB_FRAME_FREE_AFTER_DISPATCH   VLIB_NODE_FLAG_IS_PUNT
 
#define VLIB_FRAME_TRACE   VLIB_NODE_FLAG_TRACE
 
#define VLIB_PENDING_FRAME_NO_NEXT_FRAME   ((u32) ~0)
 
#define VLIB_NODE_RUNTIME_DATA_SIZE   (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))
 
#define VLIB_PROCESS_RETURN_LONGJMP_RETURN   ((uword) ~0 - 0)
 
#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND   ((uword) ~0 - 1)
 
#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND   0
 
#define VLIB_PROCESS_RESUME_LONGJMP_RESUME   1
 
#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK   (1 << 0)
 
#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT   (1 << 1)
 
#define VLIB_PROCESS_RESUME_PENDING   (1 << 2)
 
#define VLIB_PROCESS_IS_RUNNING   (1 << 3)
 
#define PAGE_SIZE_MULTIPLE   0x1000
 
#define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT   __attribute__ ((aligned (PAGE_SIZE_MULTIPLE)))
 
#define VLIB_PROCESS_STACK_MAGIC   (0xdead7ead)
 
#define VLIB_NODE_MAIN_RUNTIME_STARTED   (1 << 0)
 
#define FRAME_QUEUE_MAX_NELTS   32
 

Typedefs

typedef uwordvlib_node_function_t) (struct vlib_main_t *vm, struct vlib_node_runtime_t *node, struct vlib_frame_t *frame)
 
typedef struct _vlib_node_fn_registration vlib_node_fn_registration_t
 
typedef struct _vlib_node_registration vlib_node_registration_t
 
typedef struct vlib_node_t vlib_node_t
 
typedef struct vlib_frame_t vlib_frame_t
 
typedef struct vlib_node_runtime_t vlib_node_runtime_t
 
typedef char assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof(vlib_process_t)-PAGE_SIZE_MULTIPLE)==0?0:-1]
 

Enumerations

enum  vlib_node_type_t {
  VLIB_NODE_TYPE_INTERNAL, VLIB_NODE_TYPE_INPUT, VLIB_NODE_TYPE_PRE_INPUT, VLIB_NODE_TYPE_PROCESS,
  VLIB_N_NODE_TYPE
}
 
enum  vlib_node_state_t { VLIB_N_NODE_STATE }
 

Functions

static vlib_node_registration_tvlib_node_next_registered (vlib_node_registration_t *c)
 
static void vlib_next_frame_init (vlib_next_frame_t *nf)
 
static uword vlib_timing_wheel_data_is_timed_event (u32 d)
 
static u32 vlib_timing_wheel_data_set_suspended_process (u32 i)
 
static u32 vlib_timing_wheel_data_set_timed_event (u32 i)
 
static uword vlib_timing_wheel_data_get_index (u32 d)
 

Macro Definition Documentation

#define ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT   __attribute__ ((aligned (PAGE_SIZE_MULTIPLE)))

Definition at line 594 of file node.h.

#define foreach_vlib_node_state
Value:
/* Input node is called each iteration of main loop. \
This is the default (zero). */ \
_ (POLLING) \
/* Input node is called when device signals an interrupt. */ \
_ (INTERRUPT) \
/* Input node is never called. */ \
_ (DISABLED)

Definition at line 234 of file node.h.

#define FRAME_QUEUE_MAX_NELTS   32

Definition at line 745 of file node.h.

#define PAGE_SIZE_MULTIPLE   0x1000

Definition at line 593 of file node.h.

#define VLIB_FRAME_ALIGN   CLIB_CACHE_LINE_BYTES

Definition at line 365 of file node.h.

#define VLIB_FRAME_FREE_AFTER_DISPATCH   VLIB_NODE_FLAG_IS_PUNT

Definition at line 412 of file node.h.

#define VLIB_FRAME_IS_ALLOCATED   VLIB_NODE_FLAG_IS_OUTPUT

Definition at line 406 of file node.h.

#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH   VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH

Definition at line 398 of file node.h.

#define VLIB_FRAME_OWNER   (1 << 15)

Definition at line 403 of file node.h.

#define VLIB_FRAME_PENDING   VLIB_NODE_FLAG_IS_DROP

Definition at line 409 of file node.h.

#define VLIB_FRAME_SIZE   256

Definition at line 364 of file node.h.

#define VLIB_FRAME_TRACE   VLIB_NODE_FLAG_TRACE

Definition at line 415 of file node.h.

#define VLIB_INVALID_NODE_INDEX   ((u32) ~0)

Definition at line 361 of file node.h.

#define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH   (1 << 0)

Definition at line 286 of file node.h.

#define VLIB_NODE_FLAG_IS_DROP   (1 << 2)

Definition at line 290 of file node.h.

#define VLIB_NODE_FLAG_IS_HANDOFF   (1 << 4)

Definition at line 292 of file node.h.

#define VLIB_NODE_FLAG_IS_OUTPUT   (1 << 1)

Definition at line 289 of file node.h.

#define VLIB_NODE_FLAG_IS_PUNT   (1 << 3)

Definition at line 291 of file node.h.

#define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE   (1 << 6)

Definition at line 297 of file node.h.

#define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE   (1 << 7)

Definition at line 298 of file node.h.

#define VLIB_NODE_FLAG_TRACE   (1 << 5)

Definition at line 295 of file node.h.

#define VLIB_NODE_FN (   node)
Value:
uword CLIB_MARCH_SFX (node##_fn)(); \
CLIB_MARCH_SFX(node##_fn_registration) = \
{ .function = &CLIB_MARCH_SFX (node##_fn), }; \
\
CLIB_MARCH_SFX (node##_multiarch_register) (void) \
{ \
r = & CLIB_MARCH_SFX (node##_fn_registration); \
r->priority = CLIB_MARCH_FN_PRIORITY(); \
r->next_registration = node.node_fn_registrations; \
node.node_fn_registrations = r; \
} \
struct _vlib_node_fn_registration vlib_node_fn_registration_t
#define CLIB_CPU_OPTIMIZED
Definition: cpu.h:39
#define CLIB_MARCH_SFX
Definition: cpu.h:62
struct _vlib_node_registration vlib_node_registration_t
u64 uword
Definition: types.h:112
#define CLIB_MARCH_FN_PRIORITY()
Definition: cpu.h:189

Definition at line 173 of file node.h.

#define VLIB_NODE_FUNCTION_CLONE_TEMPLATE (   arch,
  fn 
)

Definition at line 192 of file node.h.

#define VLIB_NODE_FUNCTION_MULTIARCH (   node,
  fn 
)

Definition at line 194 of file node.h.

#define VLIB_NODE_FUNCTION_MULTIARCH_CLONE (   fn)

Definition at line 193 of file node.h.

#define VLIB_NODE_MAIN_RUNTIME_STARTED   (1 << 0)

Definition at line 682 of file node.h.

#define VLIB_NODE_RUNTIME_DATA_SIZE   (sizeof (vlib_node_runtime_t) - STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data))

Definition at line 511 of file node.h.

#define VLIB_PENDING_FRAME_NO_NEXT_FRAME   ((u32) ~0)

Definition at line 442 of file node.h.

#define VLIB_PROCESS_IS_RUNNING   (1 << 3)

Definition at line 551 of file node.h.

#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK   (1 << 0)

Definition at line 545 of file node.h.

#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT   (1 << 1)

Definition at line 546 of file node.h.

#define VLIB_PROCESS_RESUME_LONGJMP_RESUME   1

Definition at line 542 of file node.h.

#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND   0

Definition at line 541 of file node.h.

#define VLIB_PROCESS_RESUME_PENDING   (1 << 2)

Definition at line 548 of file node.h.

#define VLIB_PROCESS_RETURN_LONGJMP_RETURN   ((uword) ~0 - 0)

Definition at line 536 of file node.h.

#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND   ((uword) ~0 - 1)

Definition at line 537 of file node.h.

#define VLIB_PROCESS_STACK_MAGIC   (0xdead7ead)

Definition at line 602 of file node.h.

#define VLIB_REGISTER_NODE (   x,
  ... 
)
Value:
__VA_ARGS__ vlib_node_registration_t x; \
static void __vlib_add_node_registration_##x (void) \
__attribute__((__constructor__)) ; \
static void __vlib_add_node_registration_##x (void) \
{ \
x.next_registration = vm->node_main.node_registrations; \
} \
static void __vlib_rm_node_registration_##x (void) \
__attribute__((__destructor__)) ; \
static void __vlib_rm_node_registration_##x (void) \
{ \
VLIB_REMOVE_FROM_LINKED_LIST (vm->node_main.node_registrations, \
&x, next_registration); \
} \
#define VLIB_REMOVE_FROM_LINKED_LIST(first, p, next)
Definition: init.h:82
struct vlib_main_t vlib_main_t
vlib_node_registration_t * node_registrations
Definition: node.h:741
vlib_main_t * vm
Definition: buffer.c:294
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
struct _vlib_node_registration vlib_node_registration_t
vlib_node_main_t node_main
Definition: main.h:135

Definition at line 153 of file node.h.

Typedef Documentation

typedef char assert_process_stack_must_be_aligned_exactly_to_page_size_multiple[(sizeof(vlib_process_t)-PAGE_SIZE_MULTIPLE)==0?0:-1]

Definition at line 615 of file node.h.

typedef struct vlib_frame_t vlib_frame_t
typedef struct _vlib_node_fn_registration vlib_node_fn_registration_t
typedef uword( vlib_node_function_t) (struct vlib_main_t *vm, struct vlib_node_runtime_t *node, struct vlib_frame_t *frame)

Definition at line 54 of file node.h.

typedef struct _vlib_node_registration vlib_node_registration_t
typedef struct vlib_node_t vlib_node_t

Enumeration Type Documentation

Enumerator
VLIB_N_NODE_STATE 

Definition at line 243 of file node.h.

Enumerator
VLIB_NODE_TYPE_INTERNAL 
VLIB_NODE_TYPE_INPUT 
VLIB_NODE_TYPE_PRE_INPUT 
VLIB_NODE_TYPE_PROCESS 
VLIB_N_NODE_TYPE 

Definition at line 58 of file node.h.

Function Documentation

static void vlib_next_frame_init ( vlib_next_frame_t nf)
inlinestatic

Definition at line 422 of file node.h.

+ Here is the caller graph for this function:

static vlib_node_registration_t* vlib_node_next_registered ( vlib_node_registration_t c)
inlinestatic

Definition at line 218 of file node.h.

static uword vlib_timing_wheel_data_get_index ( u32  d)
inlinestatic

Definition at line 668 of file node.h.

+ Here is the caller graph for this function:

static uword vlib_timing_wheel_data_is_timed_event ( u32  d)
inlinestatic

Definition at line 650 of file node.h.

+ Here is the caller graph for this function:

static u32 vlib_timing_wheel_data_set_suspended_process ( u32  i)
inlinestatic

Definition at line 656 of file node.h.

+ Here is the caller graph for this function:

static u32 vlib_timing_wheel_data_set_timed_event ( u32  i)
inlinestatic

Definition at line 662 of file node.h.

+ Here is the caller graph for this function: