FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
threads.h File Reference
+ Include dependency graph for threads.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  vlib_thread_registration_
 
struct  vlib_frame_queue_elt_t
 
struct  vlib_worker_thread_t
 
struct  vlib_frame_queue_t
 
struct  vlib_frame_queue_per_thread_data_t
 
struct  vlib_frame_queue_main_t
 
struct  vlib_process_signal_event_mt_args_t
 
struct  vlib_thread_callbacks_t
 
struct  vlib_thread_main_t
 

Macros

#define VLIB_MAX_CPUS   256
 
#define VLIB_CPU_MASK   (VLIB_MAX_CPUS - 1) /* 0x3f, max */
 
#define VLIB_OFFSET_MASK   (~VLIB_CPU_MASK)
 
#define VLIB_LOG2_THREAD_STACK_SIZE   (21)
 
#define VLIB_THREAD_STACK_SIZE   (1<<VLIB_LOG2_THREAD_STACK_SIZE)
 
#define BARRIER_SYNC_DELAY   (0.030000)
 
#define BARRIER_SYNC_TIMEOUT   (600.1)
 
#define vlib_worker_thread_barrier_sync(X)   {vlib_worker_thread_barrier_sync_int(X, __FUNCTION__);}
 
#define foreach_vlib_main(body)
 
#define foreach_sched_policy
 
#define VLIB_REGISTER_THREAD(x, ...)
 

Typedefs

typedef void() vlib_thread_function_t(void *arg)
 
typedef struct vlib_thread_registration_ vlib_thread_registration_t
 

Enumerations

enum  vlib_frame_queue_msg_type_t { VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME }
 
enum  vlib_fork_fixup_t { VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0, VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX }
 
enum  sched_policy_t { SCHED_POLICY_N }
 

Functions

void vlib_set_thread_name (char *name)
 
clib_error_tvlib_thread_init (vlib_main_t *vm)
 
int vlib_frame_queue_enqueue (vlib_main_t *vm, u32 node_runtime_index, u32 frame_queue_index, vlib_frame_t *frame, vlib_frame_queue_msg_type_t type)
 
int vlib_frame_queue_dequeue (vlib_main_t *vm, vlib_frame_queue_main_t *fqm)
 
void vlib_worker_thread_node_runtime_update (void)
 
void vlib_create_worker_threads (vlib_main_t *vm, int n, void(*thread_function)(void *))
 
void vlib_worker_thread_init (vlib_worker_thread_t *w)
 
u32 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
 
void vlib_worker_thread_barrier_sync_int (vlib_main_t *vm, const char *func_name)
 
void vlib_worker_thread_barrier_release (vlib_main_t *vm)
 
u8 vlib_worker_thread_barrier_held (void)
 Return true if the wroker thread barrier is held. More...
 
void vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t *vm)
 
void vlib_worker_thread_node_refork (void)
 
void vlib_worker_wait_one_loop (void)
 Wait until each of the workers has been once around the track. More...
 
static_always_inline uword vlib_get_thread_index (void)
 
static void vlib_smp_unsafe_warning (void)
 
void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
 
static u32 vlib_num_workers ()
 
static u32 vlib_get_worker_thread_index (u32 worker_index)
 
static u32 vlib_get_worker_index (u32 thread_index)
 
static u32 vlib_get_current_worker_index ()
 
static void vlib_worker_thread_barrier_check (void)
 
static vlib_main_tvlib_get_worker_vlib_main (u32 worker_index)
 
static u8 vlib_thread_is_main_w_barrier (void)
 
static void vlib_put_frame_queue_elt (vlib_frame_queue_elt_t *hf)
 
static vlib_frame_queue_elt_tvlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
 
static vlib_frame_queue_tis_vlib_frame_queue_congested (u32 frame_queue_index, u32 index, u32 queue_hi_thresh, vlib_frame_queue_t **handoff_queue_by_worker_index)
 
static vlib_frame_queue_elt_tvlib_get_worker_handoff_queue_elt (u32 frame_queue_index, u32 vlib_worker_index, vlib_frame_queue_elt_t **handoff_queue_elt_by_worker_index)
 
u8vlib_thread_stack_init (uword thread_index)
 
int vlib_thread_cb_register (struct vlib_main_t *vm, vlib_thread_callbacks_t *cb)
 
void vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *args)
 
void vlib_rpc_call_main_thread (void *function, u8 *args, u32 size)
 

Variables

vlib_main_t ** vlib_mains
 
vlib_worker_thread_tvlib_worker_threads
 
vlib_thread_main_t vlib_thread_main
 
void * rpc_call_main_thread_cb_fn
 

Macro Definition Documentation

◆ BARRIER_SYNC_DELAY

#define BARRIER_SYNC_DELAY   (0.030000)

Definition at line 195 of file threads.h.

◆ BARRIER_SYNC_TIMEOUT

#define BARRIER_SYNC_TIMEOUT   (600.1)

Definition at line 199 of file threads.h.

◆ foreach_sched_policy

#define foreach_sched_policy
Value:
_(SCHED_OTHER, OTHER, "other") \
_(SCHED_BATCH, BATCH, "batch") \
_(SCHED_IDLE, IDLE, "idle") \
_(SCHED_FIFO, FIFO, "fifo") \
_(SCHED_RR, RR, "rr")

Definition at line 264 of file threads.h.

◆ foreach_vlib_main

#define foreach_vlib_main (   body)
Value:
do { \
vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
int ii; \
for (ii = 0; ii < vec_len (vlib_mains); ii++) \
{ \
this_vlib_main = vlib_mains[ii]; \
ASSERT (ii == 0 || \
this_vlib_main->parked_at_barrier == 1); \
if (this_vlib_main) \
vec_add1 (__vlib_mains, this_vlib_main); \
} \
for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
{ \
this_vlib_main = __vlib_mains[ii]; \
/* body uses this_vlib_main... */ \
(body); \
} \
vec_free (__vlib_mains); \
} while (0);
for(i=1;i<=collision_buckets;i++)
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
vlib_main_t ** vlib_mains
Definition: buffer.c:332

Definition at line 241 of file threads.h.

◆ VLIB_CPU_MASK

#define VLIB_CPU_MASK   (VLIB_MAX_CPUS - 1) /* 0x3f, max */

Definition at line 62 of file threads.h.

◆ VLIB_LOG2_THREAD_STACK_SIZE

#define VLIB_LOG2_THREAD_STACK_SIZE   (21)

Definition at line 65 of file threads.h.

◆ VLIB_MAX_CPUS

#define VLIB_MAX_CPUS   256

Definition at line 55 of file threads.h.

◆ VLIB_OFFSET_MASK

#define VLIB_OFFSET_MASK   (~VLIB_CPU_MASK)

Definition at line 63 of file threads.h.

◆ VLIB_REGISTER_THREAD

#define VLIB_REGISTER_THREAD (   x,
  ... 
)
Value:
static void __vlib_add_thread_registration_##x (void) \
__attribute__((__constructor__)) ; \
static void __vlib_add_thread_registration_##x (void) \
{ \
vlib_thread_main_t * tm = &vlib_thread_main; \
x.next = tm->next; \
tm->next = &x; \
} \
static void __vlib_rm_thread_registration_##x (void) \
__attribute__((__destructor__)) ; \
static void __vlib_rm_thread_registration_##x (void) \
{ \
vlib_thread_main_t * tm = &vlib_thread_main; \
VLIB_REMOVE_FROM_LINKED_LIST (tm->next, &x, next); \
} \
struct vlib_thread_registration_ * next
Definition: threads.h:31
vlib_thread_registration_t * next
Definition: threads.h:289
vlib_thread_main_t vlib_thread_main
Definition: threads.c:38

Definition at line 352 of file threads.h.

◆ VLIB_THREAD_STACK_SIZE

#define VLIB_THREAD_STACK_SIZE   (1<<VLIB_LOG2_THREAD_STACK_SIZE)

Definition at line 66 of file threads.h.

◆ vlib_worker_thread_barrier_sync

#define vlib_worker_thread_barrier_sync (   X)    {vlib_worker_thread_barrier_sync_int(X, __FUNCTION__);}

Definition at line 204 of file threads.h.

Typedef Documentation

◆ vlib_thread_function_t

typedef void() vlib_thread_function_t(void *arg)

Definition at line 26 of file threads.h.

◆ vlib_thread_registration_t

Enumeration Type Documentation

◆ sched_policy_t

Enumerator
SCHED_POLICY_N 

Definition at line 271 of file threads.h.

◆ vlib_fork_fixup_t

Enumerator
VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL 
VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX 

Definition at line 233 of file threads.h.

◆ vlib_frame_queue_msg_type_t

Enumerator
VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME 

Definition at line 68 of file threads.h.

Function Documentation

◆ is_vlib_frame_queue_congested()

static vlib_frame_queue_t* is_vlib_frame_queue_congested ( u32  frame_queue_index,
u32  index,
u32  queue_hi_thresh,
vlib_frame_queue_t **  handoff_queue_by_worker_index 
)
inlinestatic

Definition at line 563 of file threads.h.

+ Here is the caller graph for this function:

◆ vlib_create_worker_threads()

void vlib_create_worker_threads ( vlib_main_t vm,
int  n,
void(*)(void *)  thread_function 
)

◆ vlib_frame_queue_dequeue()

int vlib_frame_queue_dequeue ( vlib_main_t vm,
vlib_frame_queue_main_t fqm 
)

Definition at line 1642 of file threads.c.

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

◆ vlib_frame_queue_enqueue()

int vlib_frame_queue_enqueue ( vlib_main_t vm,
u32  node_runtime_index,
u32  frame_queue_index,
vlib_frame_t frame,
vlib_frame_queue_msg_type_t  type 
)
+ Here is the caller graph for this function:

◆ vlib_frame_queue_main_init()

u32 vlib_frame_queue_main_init ( u32  node_index,
u32  frame_queue_nelts 
)

Definition at line 1810 of file threads.c.

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

◆ vlib_get_current_worker_index()

static u32 vlib_get_current_worker_index ( )
inlinestatic

Definition at line 390 of file threads.h.

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

◆ vlib_get_frame_queue_elt()

static vlib_frame_queue_elt_t* vlib_get_frame_queue_elt ( u32  frame_queue_index,
u32  index 
)
inlinestatic

Definition at line 532 of file threads.h.

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

◆ vlib_get_thread_index()

static_always_inline uword vlib_get_thread_index ( void  )

Definition at line 218 of file threads.h.

◆ vlib_get_worker_handoff_queue_elt()

static vlib_frame_queue_elt_t* vlib_get_worker_handoff_queue_elt ( u32  frame_queue_index,
u32  vlib_worker_index,
vlib_frame_queue_elt_t **  handoff_queue_elt_by_worker_index 
)
inlinestatic

Definition at line 595 of file threads.h.

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

◆ vlib_get_worker_index()

static u32 vlib_get_worker_index ( u32  thread_index)
inlinestatic

Definition at line 384 of file threads.h.

◆ vlib_get_worker_thread_index()

static u32 vlib_get_worker_thread_index ( u32  worker_index)
inlinestatic

Definition at line 378 of file threads.h.

◆ vlib_get_worker_vlib_main()

static vlib_main_t* vlib_get_worker_vlib_main ( u32  worker_index)
inlinestatic

Definition at line 506 of file threads.h.

+ Here is the caller graph for this function:

◆ vlib_num_workers()

static u32 vlib_num_workers ( )
inlinestatic

Definition at line 372 of file threads.h.

+ Here is the caller graph for this function:

◆ vlib_process_signal_event_mt_helper()

void vlib_process_signal_event_mt_helper ( vlib_process_signal_event_mt_args_t args)

Definition at line 1862 of file threads.c.

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

◆ vlib_put_frame_queue_elt()

static void vlib_put_frame_queue_elt ( vlib_frame_queue_elt_t hf)
inlinestatic

Definition at line 525 of file threads.h.

+ Here is the caller graph for this function:

◆ vlib_rpc_call_main_thread()

void vlib_rpc_call_main_thread ( void *  function,
u8 args,
u32  size 
)

Definition at line 1873 of file threads.c.

+ Here is the caller graph for this function:

◆ vlib_set_thread_name()

void vlib_set_thread_name ( char *  name)

Definition at line 155 of file threads.c.

+ Here is the caller graph for this function:

◆ vlib_smp_unsafe_warning()

static void vlib_smp_unsafe_warning ( void  )
inlinestatic

Definition at line 224 of file threads.h.

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

◆ vlib_thread_cb_register()

int vlib_thread_cb_register ( struct vlib_main_t vm,
vlib_thread_callbacks_t cb 
)

Definition at line 1849 of file threads.c.

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

◆ vlib_thread_init()

clib_error_t* vlib_thread_init ( vlib_main_t vm)

Definition at line 210 of file threads.c.

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

◆ vlib_thread_is_main_w_barrier()

static u8 vlib_thread_is_main_w_barrier ( void  )
inlinestatic

Definition at line 517 of file threads.h.

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

◆ vlib_thread_stack_init()

u8* vlib_thread_stack_init ( uword  thread_index)

Definition at line 657 of file main.c.

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

◆ vlib_worker_thread_barrier_check()

static void vlib_worker_thread_barrier_check ( void  )
inlinestatic

Definition at line 396 of file threads.h.

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

◆ vlib_worker_thread_barrier_held()

u8 vlib_worker_thread_barrier_held ( void  )

Return true if the wroker thread barrier is held.

Definition at line 1397 of file threads.c.

+ Here is the caller graph for this function:

◆ vlib_worker_thread_barrier_release()

void vlib_worker_thread_barrier_release ( vlib_main_t vm)

Definition at line 1496 of file threads.c.

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

◆ vlib_worker_thread_barrier_sync_int()

void vlib_worker_thread_barrier_sync_int ( vlib_main_t vm,
const char *  func_name 
)

Definition at line 1406 of file threads.c.

+ Here is the call graph for this function:

◆ vlib_worker_thread_fork_fixup()

void vlib_worker_thread_fork_fixup ( vlib_fork_fixup_t  which)

Definition at line 1331 of file threads.c.

+ Here is the call graph for this function:

◆ vlib_worker_thread_init()

void vlib_worker_thread_init ( vlib_worker_thread_t w)

Definition at line 526 of file threads.c.

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

◆ vlib_worker_thread_initial_barrier_sync_and_release()

void vlib_worker_thread_initial_barrier_sync_and_release ( vlib_main_t vm)

Definition at line 1369 of file threads.c.

+ Here is the call graph for this function:

◆ vlib_worker_thread_node_refork()

void vlib_worker_thread_node_refork ( void  )

Definition at line 1001 of file threads.c.

+ Here is the call graph for this function:

◆ vlib_worker_thread_node_runtime_update()

void vlib_worker_thread_node_runtime_update ( void  )

Definition at line 1187 of file threads.c.

+ Here is the caller graph for this function:

◆ vlib_worker_wait_one_loop()

void vlib_worker_wait_one_loop ( void  )

Wait until each of the workers has been once around the track.

Definition at line 1605 of file threads.c.

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

Variable Documentation

◆ rpc_call_main_thread_cb_fn

void* rpc_call_main_thread_cb_fn

Definition at line 1870 of file threads.c.

◆ vlib_mains

vlib_main_t** vlib_mains

Definition at line 332 of file buffer.c.

◆ vlib_thread_main

vlib_thread_main_t vlib_thread_main

Definition at line 38 of file threads.c.

◆ vlib_worker_threads

vlib_worker_thread_t* vlib_worker_threads

Definition at line 37 of file threads.c.