FD.io VPP  v20.01-46-g7006026de
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 CLIB_MARCH_VARIANT_STR   "default"
 
#define VLIB_NODE_FN(node)
 
#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_NODE_FLAG_TRACE_SUPPORTED   (1 << 8)
 
#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_NO_APPEND   (1 << 14)
 
#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   64
 

Typedefs

typedef uword() vlib_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]
 
typedef u16 vlib_error_t
 

Enumerations

enum  vlib_node_proto_hint_t {
  VLIB_NODE_PROTO_HINT_NONE = 0, VLIB_NODE_PROTO_HINT_ETHERNET, VLIB_NODE_PROTO_HINT_IP4, VLIB_NODE_PROTO_HINT_IP6,
  VLIB_NODE_PROTO_HINT_TCP, VLIB_NODE_PROTO_HINT_UDP, VLIB_NODE_N_PROTO_HINTS
}
 
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)
 
static u32 vlib_error_get_node (vlib_node_main_t *nm, vlib_error_t e)
 
static u32 vlib_error_get_code (vlib_node_main_t *nm, vlib_error_t e)
 

Macro Definition Documentation

◆ ALIGN_ON_MULTIPLE_PAGE_BOUNDARY_FOR_MPROTECT

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

Definition at line 617 of file node.h.

◆ CLIB_MARCH_VARIANT_STR

#define CLIB_MARCH_VARIANT_STR   "default"

Definition at line 195 of file node.h.

◆ foreach_vlib_node_state

#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 241 of file node.h.

◆ FRAME_QUEUE_MAX_NELTS

#define FRAME_QUEUE_MAX_NELTS   64

Definition at line 787 of file node.h.

◆ PAGE_SIZE_MULTIPLE

#define PAGE_SIZE_MULTIPLE   0x1000

Definition at line 616 of file node.h.

◆ VLIB_FRAME_ALIGN

#define VLIB_FRAME_ALIGN   CLIB_CACHE_LINE_BYTES

Definition at line 379 of file node.h.

◆ VLIB_FRAME_FREE_AFTER_DISPATCH

#define VLIB_FRAME_FREE_AFTER_DISPATCH   VLIB_NODE_FLAG_IS_PUNT

Definition at line 432 of file node.h.

◆ VLIB_FRAME_IS_ALLOCATED

#define VLIB_FRAME_IS_ALLOCATED   VLIB_NODE_FLAG_IS_OUTPUT

Definition at line 426 of file node.h.

◆ VLIB_FRAME_NO_APPEND

#define VLIB_FRAME_NO_APPEND   (1 << 14)

Definition at line 419 of file node.h.

◆ VLIB_FRAME_NO_FREE_AFTER_DISPATCH

#define VLIB_FRAME_NO_FREE_AFTER_DISPATCH   VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH

Definition at line 415 of file node.h.

◆ VLIB_FRAME_OWNER

#define VLIB_FRAME_OWNER   (1 << 15)

Definition at line 423 of file node.h.

◆ VLIB_FRAME_PENDING

#define VLIB_FRAME_PENDING   VLIB_NODE_FLAG_IS_DROP

Definition at line 429 of file node.h.

◆ VLIB_FRAME_SIZE

#define VLIB_FRAME_SIZE   256

Definition at line 378 of file node.h.

◆ VLIB_FRAME_TRACE

#define VLIB_FRAME_TRACE   VLIB_NODE_FLAG_TRACE

Definition at line 435 of file node.h.

◆ VLIB_INVALID_NODE_INDEX

#define VLIB_INVALID_NODE_INDEX   ((u32) ~0)

Definition at line 375 of file node.h.

◆ VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH

#define VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH   (1 << 0)

Definition at line 293 of file node.h.

◆ VLIB_NODE_FLAG_IS_DROP

#define VLIB_NODE_FLAG_IS_DROP   (1 << 2)

Definition at line 297 of file node.h.

◆ VLIB_NODE_FLAG_IS_HANDOFF

#define VLIB_NODE_FLAG_IS_HANDOFF   (1 << 4)

Definition at line 299 of file node.h.

◆ VLIB_NODE_FLAG_IS_OUTPUT

#define VLIB_NODE_FLAG_IS_OUTPUT   (1 << 1)

Definition at line 296 of file node.h.

◆ VLIB_NODE_FLAG_IS_PUNT

#define VLIB_NODE_FLAG_IS_PUNT   (1 << 3)

Definition at line 298 of file node.h.

◆ VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE

#define VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE   (1 << 6)

Definition at line 304 of file node.h.

◆ VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE

#define VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE   (1 << 7)

Definition at line 305 of file node.h.

◆ VLIB_NODE_FLAG_TRACE

#define VLIB_NODE_FLAG_TRACE   (1 << 5)

Definition at line 302 of file node.h.

◆ VLIB_NODE_FLAG_TRACE_SUPPORTED

#define VLIB_NODE_FLAG_TRACE_SUPPORTED   (1 << 8)

Definition at line 306 of file node.h.

◆ VLIB_NODE_FN

#define VLIB_NODE_FN (   node)
Value:
CLIB_MARCH_SFX(node##_fn_registration) = \
{ .function = &CLIB_MARCH_SFX (node##_fn), }; \
\
CLIB_MARCH_SFX (node##_multiarch_register) (void) \
{ \
vlib_node_fn_registration_t *r; \
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; \
} \
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1810
#define CLIB_CPU_OPTIMIZED
Definition: cpu.h:40
#define CLIB_MARCH_SFX
Definition: cpu.h:59
struct _vlib_node_registration vlib_node_registration_t
u64 uword
Definition: types.h:112
#define CLIB_MARCH_VARIANT_STR
Definition: node.h:195
#define CLIB_MARCH_FN_PRIORITY()
Definition: cpu.h:356

Definition at line 202 of file node.h.

◆ VLIB_NODE_MAIN_RUNTIME_STARTED

#define VLIB_NODE_MAIN_RUNTIME_STARTED   (1 << 0)

Definition at line 705 of file node.h.

◆ VLIB_NODE_RUNTIME_DATA_SIZE

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

Definition at line 534 of file node.h.

◆ VLIB_PENDING_FRAME_NO_NEXT_FRAME

#define VLIB_PENDING_FRAME_NO_NEXT_FRAME   ((u32) ~0)

Definition at line 461 of file node.h.

◆ VLIB_PROCESS_IS_RUNNING

#define VLIB_PROCESS_IS_RUNNING   (1 << 3)

Definition at line 574 of file node.h.

◆ VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK

#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK   (1 << 0)

Definition at line 568 of file node.h.

◆ VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT

#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT   (1 << 1)

Definition at line 569 of file node.h.

◆ VLIB_PROCESS_RESUME_LONGJMP_RESUME

#define VLIB_PROCESS_RESUME_LONGJMP_RESUME   1

Definition at line 565 of file node.h.

◆ VLIB_PROCESS_RESUME_LONGJMP_SUSPEND

#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND   0

Definition at line 564 of file node.h.

◆ VLIB_PROCESS_RESUME_PENDING

#define VLIB_PROCESS_RESUME_PENDING   (1 << 2)

Definition at line 571 of file node.h.

◆ VLIB_PROCESS_RETURN_LONGJMP_RETURN

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

Definition at line 559 of file node.h.

◆ VLIB_PROCESS_RETURN_LONGJMP_SUSPEND

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

Definition at line 560 of file node.h.

◆ VLIB_PROCESS_STACK_MAGIC

#define VLIB_PROCESS_STACK_MAGIC   (0xdead7ead)

Definition at line 625 of file node.h.

◆ VLIB_REGISTER_NODE

#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) \
{ \
vlib_main_t * vm = vlib_get_main(); \
x.next_registration = vm->node_main.node_registrations; \
vm->node_main.node_registrations = &x; \
} \
static void __vlib_rm_node_registration_##x (void) \
__attribute__((__destructor__)) ; \
static void __vlib_rm_node_registration_##x (void) \
{ \
vlib_main_t * vm = vlib_get_main(); \
VLIB_REMOVE_FROM_LINKED_LIST (vm->node_main.node_registrations, \
&x, next_registration); \
} \
vlib_main_t * vm
Definition: in2out_ed.c:1810
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
struct _vlib_node_registration vlib_node_registration_t

Definition at line 169 of file node.h.

Typedef Documentation

◆ assert_process_stack_must_be_aligned_exactly_to_page_size_multiple

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 638 of file node.h.

◆ vlib_error_t

typedef u16 vlib_error_t

Definition at line 770 of file node.h.

◆ vlib_frame_t

typedef struct vlib_frame_t vlib_frame_t

◆ vlib_node_fn_registration_t

typedef struct _vlib_node_fn_registration vlib_node_fn_registration_t

◆ vlib_node_function_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.

◆ vlib_node_registration_t

typedef struct _vlib_node_registration vlib_node_registration_t

◆ vlib_node_runtime_t

◆ vlib_node_t

typedef struct vlib_node_t vlib_node_t

Enumeration Type Documentation

◆ vlib_node_proto_hint_t

Enumerator
VLIB_NODE_PROTO_HINT_NONE 
VLIB_NODE_PROTO_HINT_ETHERNET 
VLIB_NODE_PROTO_HINT_IP4 
VLIB_NODE_PROTO_HINT_IP6 
VLIB_NODE_PROTO_HINT_TCP 
VLIB_NODE_PROTO_HINT_UDP 
VLIB_NODE_N_PROTO_HINTS 

Definition at line 58 of file node.h.

◆ vlib_node_state_t

Enumerator
VLIB_N_NODE_STATE 

Definition at line 250 of file node.h.

◆ vlib_node_type_t

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 69 of file node.h.

Function Documentation

◆ vlib_error_get_code()

static u32 vlib_error_get_code ( vlib_node_main_t nm,
vlib_error_t  e 
)
inlinestatic

Definition at line 779 of file node.h.

+ Here is the caller graph for this function:

◆ vlib_error_get_node()

static u32 vlib_error_get_node ( vlib_node_main_t nm,
vlib_error_t  e 
)
inlinestatic

Definition at line 773 of file node.h.

+ Here is the caller graph for this function:

◆ vlib_next_frame_init()

static void vlib_next_frame_init ( vlib_next_frame_t nf)
inlinestatic

Definition at line 442 of file node.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vlib_node_next_registered()

static vlib_node_registration_t* vlib_node_next_registered ( vlib_node_registration_t c)
inlinestatic

Definition at line 222 of file node.h.

◆ vlib_timing_wheel_data_get_index()

static uword vlib_timing_wheel_data_get_index ( u32  d)
inlinestatic

Definition at line 691 of file node.h.

◆ vlib_timing_wheel_data_is_timed_event()

static uword vlib_timing_wheel_data_is_timed_event ( u32  d)
inlinestatic

Definition at line 673 of file node.h.

◆ vlib_timing_wheel_data_set_suspended_process()

static u32 vlib_timing_wheel_data_set_suspended_process ( u32  i)
inlinestatic

Definition at line 679 of file node.h.

+ Here is the caller graph for this function:

◆ vlib_timing_wheel_data_set_timed_event()

static u32 vlib_timing_wheel_data_set_timed_event ( u32  i)
inlinestatic

Definition at line 685 of file node.h.

+ Here is the caller graph for this function: