2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * node_funcs.h: processing nodes global functions/inlines
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
45 #ifndef included_vlib_node_funcs_h
46 #define included_vlib_node_funcs_h
48 #include <vppinfra/fifo.h>
49 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
50 #include <vppinfra/interrupt.h>
52 #ifdef CLIB_SANITIZE_ADDR
53 #include <sanitizer/asan_interface.h>
56 static_always_inline void
57 vlib_process_start_switch_stack (vlib_main_t * vm, vlib_process_t * p)
59 #ifdef CLIB_SANITIZE_ADDR
60 void *stack = p ? (void *) p->stack : vlib_thread_stacks[vm->thread_index];
61 u32 stack_bytes = p ? p->log2_n_stack_bytes : VLIB_THREAD_STACK_SIZE;
62 __sanitizer_start_switch_fiber (&vm->asan_stack_save, stack, stack_bytes);
66 static_always_inline void
67 vlib_process_finish_switch_stack (vlib_main_t * vm)
69 #ifdef CLIB_SANITIZE_ADDR
70 const void *bottom_old;
73 __sanitizer_finish_switch_fiber (&vm->asan_stack_save, &bottom_old,
78 /** \brief Get vlib node by index.
79 @warning This function will ASSERT if @c i is out of range.
80 @param vm vlib_main_t pointer, varies by thread
82 @return pointer to the requested vlib_node_t.
85 always_inline vlib_node_t *
86 vlib_get_node (vlib_main_t * vm, u32 i)
88 return vec_elt (vm->node_main.nodes, i);
91 /** \brief Get vlib node by graph arc (next) index.
92 @param vm vlib_main_t pointer, varies by thread
93 @param node_index index of original node
94 @param next_index graph arc index
95 @return pointer to the vlib_node_t at the end of the indicated arc
98 always_inline vlib_node_t *
99 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
101 vlib_node_main_t *nm = &vm->node_main;
104 n = vec_elt (nm->nodes, node_index);
105 ASSERT (next_index < vec_len (n->next_nodes));
106 return vlib_get_node (vm, n->next_nodes[next_index]);
109 /** \brief Get node runtime by node index.
110 @param vm vlib_main_t pointer, varies by thread
111 @param node_index index of node
112 @return pointer to the indicated vlib_node_runtime_t
115 always_inline vlib_node_runtime_t *
116 vlib_node_get_runtime (vlib_main_t * vm, u32 node_index)
118 vlib_node_main_t *nm = &vm->node_main;
119 vlib_node_t *n = vec_elt (nm->nodes, node_index);
121 if (n->type != VLIB_NODE_TYPE_PROCESS)
122 return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
125 p = vec_elt (nm->processes, n->runtime_index);
126 return &p->node_runtime;
130 /** \brief Get node runtime private data by node index.
131 @param vm vlib_main_t pointer, varies by thread
132 @param node_index index of the node
133 @return pointer to the indicated vlib_node_runtime_t private data
137 vlib_node_get_runtime_data (vlib_main_t * vm, u32 node_index)
139 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
140 return r->runtime_data;
143 /** \brief Set node runtime private data.
144 @param vm vlib_main_t pointer, varies by thread
145 @param node_index index of the node
146 @param runtime_data arbitrary runtime private data
147 @param n_runtime_data_bytes size of runtime private data
151 vlib_node_set_runtime_data (vlib_main_t * vm, u32 node_index,
152 void *runtime_data, u32 n_runtime_data_bytes)
154 vlib_node_t *n = vlib_get_node (vm, node_index);
155 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
157 n->runtime_data_bytes = n_runtime_data_bytes;
158 vec_free (n->runtime_data);
159 vec_add (n->runtime_data, runtime_data, n_runtime_data_bytes);
161 ASSERT (vec_len (n->runtime_data) <= sizeof (vlib_node_runtime_t) -
162 STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
164 if (vec_len (n->runtime_data) > 0)
165 clib_memcpy_fast (r->runtime_data, n->runtime_data,
166 vec_len (n->runtime_data));
169 /** \brief Set node dispatch state.
170 @param vm vlib_main_t pointer, varies by thread
171 @param node_index index of the node
172 @param new_state new state for node, see vlib_node_state_t
175 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
176 vlib_node_state_t new_state)
178 vlib_node_main_t *nm = &vm->node_main;
180 vlib_node_runtime_t *r;
182 n = vec_elt (nm->nodes, node_index);
183 if (n->type == VLIB_NODE_TYPE_PROCESS)
185 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
186 r = &p->node_runtime;
188 /* When disabling make sure flags are cleared. */
189 p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
190 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
191 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
194 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
196 ASSERT (new_state < VLIB_N_NODE_STATE);
198 if (n->type == VLIB_NODE_TYPE_INPUT)
200 ASSERT (nm->input_node_counts_by_state[n->state] > 0);
201 nm->input_node_counts_by_state[n->state] -= 1;
202 nm->input_node_counts_by_state[new_state] += 1;
205 if (PREDICT_FALSE (r->state == VLIB_NODE_STATE_DISABLED))
206 vlib_node_runtime_perf_counter (vm, r, 0, 0, 0,
207 VLIB_NODE_RUNTIME_PERF_RESET);
209 n->state = new_state;
210 r->state = new_state;
213 /** \brief Get node dispatch state.
214 @param vm vlib_main_t pointer, varies by thread
215 @param node_index index of the node
216 @return state for node, see vlib_node_state_t
218 always_inline vlib_node_state_t
219 vlib_node_get_state (vlib_main_t * vm, u32 node_index)
221 vlib_node_main_t *nm = &vm->node_main;
223 n = vec_elt (nm->nodes, node_index);
228 vlib_node_set_flag (vlib_main_t *vm, u32 node_index, u16 flag, u8 enable)
230 vlib_node_runtime_t *r;
233 n = vlib_get_node (vm, node_index);
234 r = vlib_node_get_runtime (vm, node_index);
249 vlib_node_set_interrupt_pending (vlib_main_t *vm, u32 node_index)
251 vlib_node_main_t *nm = &vm->node_main;
252 vlib_node_t *n = vec_elt (nm->nodes, node_index);
254 ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
256 if (vm != vlib_get_main ())
257 clib_interrupt_set_atomic (nm->interrupts, n->runtime_index);
259 clib_interrupt_set (nm->interrupts, n->runtime_index);
261 __atomic_store_n (nm->pending_interrupts, 1, __ATOMIC_RELEASE);
264 always_inline vlib_process_t *
265 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
267 vlib_node_main_t *nm = &vm->node_main;
268 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
269 return vec_elt (nm->processes, node->runtime_index);
272 always_inline vlib_frame_t *
273 vlib_get_frame (vlib_main_t * vm, vlib_frame_t * f)
276 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
281 vlib_frame_no_append (vlib_frame_t * f)
283 f->frame_flags |= VLIB_FRAME_NO_APPEND;
286 /** \brief Get pointer to frame vector data.
287 @param f vlib_frame_t pointer
288 @return pointer to first vector element in frame
291 vlib_frame_vector_args (vlib_frame_t * f)
293 ASSERT (f->vector_offset);
294 return (void *) f + f->vector_offset;
297 /** \brief Get pointer to frame vector aux data.
298 @param f vlib_frame_t pointer
299 @return pointer to first vector aux data element in frame
302 vlib_frame_aux_args (vlib_frame_t *f)
304 ASSERT (f->aux_offset);
305 return (void *) f + f->aux_offset;
308 /** \brief Get pointer to frame scalar data.
310 @param f vlib_frame_t pointer
312 @return arbitrary node scalar data
314 @sa vlib_frame_vector_args
317 vlib_frame_scalar_args (vlib_frame_t * f)
319 ASSERT (f->scalar_offset);
320 return (void *) f + f->scalar_offset;
323 always_inline vlib_next_frame_t *
324 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
325 vlib_node_runtime_t * n, u32 next_index)
327 vlib_node_main_t *nm = &vm->node_main;
328 vlib_next_frame_t *nf;
330 ASSERT (next_index < n->n_next_nodes);
331 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
335 vlib_node_t *node, *next;
336 node = vec_elt (nm->nodes, n->node_index);
337 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
338 ASSERT (nf->node_runtime_index == next->runtime_index);
344 /** \brief Get pointer to frame by (@c node_index, @c next_index).
346 @warning This is not a function that you should call directly.
347 See @ref vlib_get_next_frame instead.
349 @param vm vlib_main_t pointer, varies by thread
350 @param node_index index of the node
351 @param next_index graph arc index
353 @return pointer to the requested vlib_next_frame_t
355 @sa vlib_get_next_frame
358 always_inline vlib_next_frame_t *
359 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
361 vlib_node_main_t *nm = &vm->node_main;
363 vlib_node_runtime_t *r;
365 n = vec_elt (nm->nodes, node_index);
366 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
367 return vlib_node_runtime_get_next_frame (vm, r, next_index);
370 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
371 vlib_node_runtime_t * node,
373 u32 alloc_new_frame);
375 #define vlib_get_next_frame_macro(vm, node, next_index, vectors, \
376 n_vectors_left, alloc_new_frame) \
379 vlib_frame_t *_f = vlib_get_next_frame_internal ( \
380 (vm), (node), (next_index), (alloc_new_frame)); \
381 u32 _n = _f->n_vectors; \
382 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
383 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
387 #define vlib_get_next_frame_macro_with_aux(vm, node, next_index, vectors, \
388 n_vectors_left, alloc_new_frame, \
389 aux_data, maybe_no_aux) \
392 vlib_frame_t *_f = vlib_get_next_frame_internal ( \
393 (vm), (node), (next_index), (alloc_new_frame)); \
394 u32 _n = _f->n_vectors; \
395 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
396 if ((maybe_no_aux) && (_f)->aux_offset == 0) \
399 (aux_data) = vlib_frame_aux_args (_f) + _n * sizeof ((aux_data)[0]); \
400 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
404 /** \brief Get pointer to next frame vector data by
405 (@c vlib_node_runtime_t, @c next_index).
406 Standard single/dual loop boilerplate element.
407 @attention This is a MACRO, with SIDE EFFECTS.
409 @param vm vlib_main_t pointer, varies by thread
410 @param node current node vlib_node_runtime_t pointer
411 @param next_index requested graph arc index
413 @return @c vectors -- pointer to next available vector slot
414 @return @c n_vectors_left -- number of vector slots available
416 #define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left) \
417 vlib_get_next_frame_macro (vm, node, next_index, vectors, n_vectors_left, \
418 /* alloc new frame */ 0)
420 #define vlib_get_new_next_frame(vm, node, next_index, vectors, \
422 vlib_get_next_frame_macro (vm, node, next_index, vectors, n_vectors_left, \
423 /* alloc new frame */ 1)
425 /** \brief Get pointer to next frame vector data and next frame aux data by
426 (@c vlib_node_runtime_t, @c next_index).
427 Standard single/dual loop boilerplate element.
428 @attention This is a MACRO, with SIDE EFFECTS.
429 @attention This MACRO is unsafe in case the next node does not support
432 @param vm vlib_main_t pointer, varies by thread
433 @param node current node vlib_node_runtime_t pointer
434 @param next_index requested graph arc index
436 @return @c vectors -- pointer to next available vector slot
437 @return @c aux_data -- pointer to next available aux data slot
438 @return @c n_vectors_left -- number of vector slots available
440 #define vlib_get_next_frame_with_aux(vm, node, next_index, vectors, aux_data, \
442 vlib_get_next_frame_macro_with_aux ( \
443 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 0, \
444 aux_data, /* maybe_no_aux */ 0)
446 #define vlib_get_new_next_frame_with_aux(vm, node, next_index, vectors, \
447 aux_data, n_vectors_left) \
448 vlib_get_next_frame_macro_with_aux ( \
449 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 1, \
450 aux_data, /* maybe_no_aux */ 0)
452 /** \brief Get pointer to next frame vector data and next frame aux data by
453 (@c vlib_node_runtime_t, @c next_index).
454 Standard single/dual loop boilerplate element.
455 @attention This is a MACRO, with SIDE EFFECTS.
456 @attention This MACRO is safe in case the next node does not support aux_data.
457 In that case aux_data is set to NULL.
459 @param vm vlib_main_t pointer, varies by thread
460 @param node current node vlib_node_runtime_t pointer
461 @param next_index requested graph arc index
463 @return @c vectors -- pointer to next available vector slot
464 @return @c aux_data -- pointer to next available aux data slot
465 @return @c n_vectors_left -- number of vector slots available
467 #define vlib_get_next_frame_with_aux_safe(vm, node, next_index, vectors, \
468 aux_data, n_vectors_left) \
469 vlib_get_next_frame_macro_with_aux ( \
470 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 0, \
471 aux_data, /* maybe_no_aux */ 1)
473 #define vlib_get_new_next_frame_with_aux_safe(vm, node, next_index, vectors, \
474 aux_data, n_vectors_left) \
475 vlib_get_next_frame_macro_with_aux ( \
476 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 1, \
477 aux_data, /* maybe_no_aux */ 1)
479 /** \brief Release pointer to next frame vector data.
480 Standard single/dual loop boilerplate element.
481 @param vm vlib_main_t pointer, varies by thread
482 @param r current node vlib_node_runtime_t pointer
483 @param next_index graph arc index
484 @param n_packets_left number of slots still available in vector
487 vlib_put_next_frame (vlib_main_t * vm,
488 vlib_node_runtime_t * r,
489 u32 next_index, u32 n_packets_left);
491 /* Combination get plus put. Returns vector argument just added. */
492 #define vlib_set_next_frame(vm,node,next_index,v) \
495 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
496 ASSERT (_n_left > 0); \
497 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
501 #define vlib_set_next_frame_with_aux_safe(vm, node, next_index, v, aux) \
504 vlib_get_next_frame_with_aux_safe ((vm), (node), (next_index), (v), \
506 ASSERT (_n_left > 0); \
507 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
512 vlib_set_next_frame_buffer (vlib_main_t * vm,
513 vlib_node_runtime_t * node,
514 u32 next_index, u32 buffer_index)
517 p = vlib_set_next_frame (vm, node, next_index, p);
522 vlib_set_next_frame_buffer_with_aux_safe (vlib_main_t *vm,
523 vlib_node_runtime_t *node,
524 u32 next_index, u32 buffer_index,
529 p = vlib_set_next_frame_with_aux_safe (vm, node, next_index, p, a);
535 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
536 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
540 vlib_in_process_context (vlib_main_t * vm)
542 return vm->node_main.current_process_index != ~0;
545 always_inline vlib_process_t *
546 vlib_get_current_process (vlib_main_t * vm)
548 vlib_node_main_t *nm = &vm->node_main;
549 if (vlib_in_process_context (vm))
550 return vec_elt (nm->processes, nm->current_process_index);
555 vlib_current_process (vlib_main_t * vm)
557 return vlib_get_current_process (vm)->node_runtime.node_index;
561 vlib_get_current_process_node_index (vlib_main_t * vm)
563 vlib_process_t *process = vlib_get_current_process (vm);
564 return process->node_runtime.node_index;
567 /** Returns TRUE if a process suspend time is less than 10us
568 @param dt - remaining poll time in seconds
569 @returns 1 if dt < 10e-6, 0 otherwise
572 vlib_process_suspend_time_is_zero (f64 dt)
577 /** Suspend a vlib cooperative multi-tasking thread for a period of time
578 @param vm - vlib_main_t *
579 @param dt - suspend interval in seconds
580 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
584 vlib_process_suspend (vlib_main_t * vm, f64 dt)
587 vlib_node_main_t *nm = &vm->node_main;
588 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
590 if (vlib_process_suspend_time_is_zero (dt))
591 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
593 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
594 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
595 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
597 /* expiration time in 10us ticks */
598 p->resume_clock_interval = dt * 1e5;
599 vlib_process_start_switch_stack (vm, 0);
600 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
603 vlib_process_finish_switch_stack (vm);
609 vlib_process_free_event_type (vlib_process_t * p, uword t,
610 uword is_one_time_event)
612 ASSERT (!pool_is_free_index (p->event_type_pool, t));
613 pool_put_index (p->event_type_pool, t);
614 if (is_one_time_event)
615 p->one_time_event_type_bitmap =
616 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
620 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
622 ASSERT (!pool_is_free_index (p->event_type_pool, t));
623 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
624 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
628 vlib_process_get_event_data (vlib_main_t * vm,
629 uword * return_event_type_opaque)
631 vlib_node_main_t *nm = &vm->node_main;
633 vlib_process_event_type_t *et;
635 void *event_data_vector;
637 p = vec_elt (nm->processes, nm->current_process_index);
639 /* Find first type with events ready.
640 Return invalid type when there's nothing there. */
641 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
645 p->non_empty_event_type_bitmap =
646 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
648 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
649 event_data_vector = p->pending_event_data_by_type_index[t];
650 p->pending_event_data_by_type_index[t] = 0;
652 et = pool_elt_at_index (p->event_type_pool, t);
654 /* Return user's opaque value and possibly index. */
655 *return_event_type_opaque = et->opaque;
657 vlib_process_maybe_free_event_type (p, t);
659 return event_data_vector;
662 /* Return event data vector for later reuse. We reuse event data to avoid
663 repeatedly allocating event vectors in cases where we care about speed. */
665 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
667 vlib_node_main_t *nm = &vm->node_main;
668 vec_add1 (nm->recycled_event_data_vectors, event_data);
671 /** Return the first event type which has occurred and a vector of per-event
672 data of that type, or a timeout indication
674 @param vm - vlib_main_t pointer
675 @param data_vector - pointer to a (uword *) vector to receive event data
676 @returns either an event type and a vector of per-event instance data,
677 or ~0 to indicate a timeout.
681 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
683 vlib_node_main_t *nm = &vm->node_main;
685 vlib_process_event_type_t *et;
688 p = vec_elt (nm->processes, nm->current_process_index);
690 /* Find first type with events ready.
691 Return invalid type when there's nothing there. */
692 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
696 p->non_empty_event_type_bitmap =
697 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
699 l = _vec_len (p->pending_event_data_by_type_index[t]);
701 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
702 vec_set_len (p->pending_event_data_by_type_index[t], 0);
704 et = pool_elt_at_index (p->event_type_pool, t);
706 /* Return user's opaque value. */
709 vlib_process_maybe_free_event_type (p, t);
715 vlib_process_get_events_helper (vlib_process_t * p, uword t,
716 uword ** data_vector)
720 p->non_empty_event_type_bitmap =
721 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
723 l = _vec_len (p->pending_event_data_by_type_index[t]);
725 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
726 vec_set_len (p->pending_event_data_by_type_index[t], 0);
728 vlib_process_maybe_free_event_type (p, t);
733 /* As above but query as specified type of event. Returns number of
736 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
737 uword with_type_opaque)
739 vlib_node_main_t *nm = &vm->node_main;
743 p = vec_elt (nm->processes, nm->current_process_index);
744 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
746 /* This can happen when an event has not yet been
747 signaled with given opaque type. */
751 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
754 return vlib_process_get_events_helper (p, t, data_vector);
757 always_inline uword *
758 vlib_process_wait_for_event (vlib_main_t * vm)
760 vlib_node_main_t *nm = &vm->node_main;
764 p = vec_elt (nm->processes, nm->current_process_index);
765 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
767 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
769 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
770 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
772 vlib_process_start_switch_stack (vm, 0);
773 clib_longjmp (&p->return_longjmp,
774 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
777 vlib_process_finish_switch_stack (vm);
780 return p->non_empty_event_type_bitmap;
784 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
785 uword ** data_vector,
786 uword with_type_index)
788 vlib_node_main_t *nm = &vm->node_main;
792 p = vec_elt (nm->processes, nm->current_process_index);
793 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
794 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
796 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
798 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
799 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
801 vlib_process_start_switch_stack (vm, 0);
802 clib_longjmp (&p->return_longjmp,
803 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
806 vlib_process_finish_switch_stack (vm);
809 return vlib_process_get_events_helper (p, with_type_index, data_vector);
813 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
814 uword ** data_vector,
815 uword with_type_opaque)
817 vlib_node_main_t *nm = &vm->node_main;
821 p = vec_elt (nm->processes, nm->current_process_index);
822 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
823 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
825 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
827 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
828 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
830 vlib_process_start_switch_stack (vm, 0);
831 clib_longjmp (&p->return_longjmp,
832 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
835 vlib_process_finish_switch_stack (vm);
837 /* See if unknown event type has been signaled now. */
839 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
842 return vlib_process_get_events_helper (p, h[0], data_vector);
845 /** Suspend a cooperative multi-tasking thread
846 Waits for an event, or for the indicated number of seconds to elapse
847 @param vm - vlib_main_t pointer
848 @param dt - timeout, in seconds.
849 @returns the remaining time interval
853 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
855 vlib_node_main_t *nm = &vm->node_main;
860 p = vec_elt (nm->processes, nm->current_process_index);
862 if (vlib_process_suspend_time_is_zero (dt)
863 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
866 wakeup_time = vlib_time_now (vm) + dt;
868 /* Suspend waiting for both clock and event to occur. */
869 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
870 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
872 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
873 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
875 p->resume_clock_interval = dt * 1e5;
876 vlib_process_start_switch_stack (vm, 0);
877 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
880 vlib_process_finish_switch_stack (vm);
882 /* Return amount of time still left to sleep.
883 If <= 0 then we've been waken up by the clock (and not an event). */
884 return wakeup_time - vlib_time_now (vm);
887 always_inline vlib_process_event_type_t *
888 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
890 vlib_process_event_type_t *et;
891 pool_get (p->event_type_pool, et);
892 et->opaque = with_type_opaque;
897 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
898 uword with_type_opaque)
900 vlib_node_main_t *nm = &vm->node_main;
901 vlib_node_t *n = vlib_get_node (vm, node_index);
902 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
903 vlib_process_event_type_t *et;
906 et = vlib_process_new_event_type (p, with_type_opaque);
907 t = et - p->event_type_pool;
908 p->one_time_event_type_bitmap =
909 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
914 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
917 vlib_node_main_t *nm = &vm->node_main;
918 vlib_node_t *n = vlib_get_node (vm, node_index);
919 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
921 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
922 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
926 vlib_process_signal_event_helper (vlib_node_main_t * nm,
930 uword n_data_elts, uword n_data_elt_bytes)
932 uword p_flags, add_to_pending, delete_from_wheel;
933 u8 *data_to_be_written_by_caller;
934 vec_attr_t va = { .elt_sz = n_data_elt_bytes };
936 ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
938 ASSERT (!pool_is_free_index (p->event_type_pool, t));
940 vec_validate (p->pending_event_data_by_type_index, t);
942 /* Resize data vector and return caller's data to be written. */
944 u8 *data_vec = p->pending_event_data_by_type_index[t];
947 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
949 data_vec = vec_pop (nm->recycled_event_data_vectors);
950 vec_reset_length (data_vec);
953 l = vec_len (data_vec);
955 data_vec = _vec_realloc_internal (data_vec, l + n_data_elts, &va);
957 p->pending_event_data_by_type_index[t] = data_vec;
958 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
961 p->non_empty_event_type_bitmap =
962 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
966 /* Event was already signalled? */
967 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
969 /* Process will resume when suspend time elapses? */
970 delete_from_wheel = 0;
971 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
973 /* Waiting for both event and clock? */
974 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
976 if (!TW (tw_timer_handle_is_free)
977 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
978 p->stop_timer_handle))
979 delete_from_wheel = 1;
981 /* timer just popped so process should already be on the list */
985 /* Waiting only for clock. Event will be queue and may be
986 handled when timer expires. */
990 /* Never add current process to pending vector since current process is
992 add_to_pending &= nm->current_process_index != n->runtime_index;
996 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
997 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
998 vec_add1 (nm->data_from_advancing_timing_wheel, x);
999 if (delete_from_wheel)
1000 TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1001 p->stop_timer_handle);
1004 return data_to_be_written_by_caller;
1007 always_inline void *
1008 vlib_process_signal_event_data (vlib_main_t * vm,
1011 uword n_data_elts, uword n_data_elt_bytes)
1013 vlib_node_main_t *nm = &vm->node_main;
1014 vlib_node_t *n = vlib_get_node (vm, node_index);
1015 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1018 /* Must be in main thread */
1019 ASSERT (vlib_get_thread_index () == 0);
1021 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
1024 vlib_process_event_type_t *et =
1025 vlib_process_new_event_type (p, type_opaque);
1026 t = et - p->event_type_pool;
1027 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1032 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1036 always_inline void *
1037 vlib_process_signal_event_at_time (vlib_main_t * vm,
1041 uword n_data_elts, uword n_data_elt_bytes)
1043 vlib_node_main_t *nm = &vm->node_main;
1044 vlib_node_t *n = vlib_get_node (vm, node_index);
1045 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1048 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
1051 vlib_process_event_type_t *et =
1052 vlib_process_new_event_type (p, type_opaque);
1053 t = et - p->event_type_pool;
1054 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1059 if (vlib_process_suspend_time_is_zero (dt))
1060 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1064 vlib_signal_timed_event_data_t *te;
1066 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
1068 te->n_data_elts = n_data_elts;
1069 te->n_data_elt_bytes = n_data_elt_bytes;
1070 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
1072 /* Assert that structure fields are big enough. */
1073 ASSERT (te->n_data_elts == n_data_elts);
1074 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
1075 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
1077 te->process_node_index = n->runtime_index;
1078 te->event_type_index = t;
1080 p->stop_timer_handle =
1081 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1082 vlib_timing_wheel_data_set_timed_event
1083 (te - nm->signal_timed_event_data_pool),
1085 (vlib_time_now (vm) + dt) * 1e5);
1087 /* Inline data big enough to hold event? */
1088 if (te->n_data_bytes < sizeof (te->inline_event_data))
1089 return te->inline_event_data;
1092 te->event_data_as_vector = 0;
1093 vec_resize (te->event_data_as_vector, te->n_data_bytes);
1094 return te->event_data_as_vector;
1099 always_inline void *
1100 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
1104 uword n_data_elt_bytes)
1106 vlib_node_main_t *nm = &vm->node_main;
1107 vlib_node_t *n = vlib_get_node (vm, node_index);
1108 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1109 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
1114 vlib_process_signal_event (vlib_main_t * vm,
1115 uword node_index, uword type_opaque, uword data)
1117 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1118 1 /* elts */ , sizeof (uword));
1123 vlib_process_signal_event_pointer (vlib_main_t * vm,
1125 uword type_opaque, void *data)
1127 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1128 1 /* elts */ , sizeof (data));
1133 * Signal event to process from any thread.
1135 * When in doubt, use this.
1138 vlib_process_signal_event_mt (vlib_main_t * vm,
1139 uword node_index, uword type_opaque, uword data)
1141 if (vlib_get_thread_index () != 0)
1143 vlib_process_signal_event_mt_args_t args = {
1144 .node_index = node_index,
1145 .type_opaque = type_opaque,
1148 vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
1149 (u8 *) & args, sizeof (args));
1152 vlib_process_signal_event (vm, node_index, type_opaque, data);
1156 vlib_process_signal_one_time_event (vlib_main_t * vm,
1158 uword type_index, uword data)
1161 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1162 1 /* elts */ , sizeof (uword));
1167 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1168 vlib_one_time_waiting_process_t * p)
1170 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1172 clib_memset (p, ~0, sizeof (p[0]));
1176 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1177 vlib_one_time_waiting_process_t
1180 vlib_one_time_waiting_process_t *wp;
1181 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1186 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1187 vlib_one_time_waiting_process_t
1190 p->node_index = vlib_current_process (vm);
1191 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1193 vlib_process_wait_for_one_time_event (vm,
1194 /* don't care about data */ 0,
1199 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1200 vlib_one_time_waiting_process_t
1203 vlib_one_time_waiting_process_t *wp;
1204 vec_add2 (*wps, wp, 1);
1205 vlib_current_process_wait_for_one_time_event (vm, wp);
1209 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1210 vlib_node_runtime_t * node,
1216 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1217 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1218 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1221 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1223 (node->main_loop_count_last_dispatch >>
1224 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1225 vi0 = node->main_loop_vector_stats[i0];
1226 vi1 = node->main_loop_vector_stats[i1];
1227 vi0 = d == 0 ? vi0 : 0;
1228 vi1 = d <= 1 ? vi1 : 0;
1230 node->main_loop_vector_stats[i0] = vi0;
1231 node->main_loop_vector_stats[i1] = vi1;
1232 node->main_loop_count_last_dispatch = vm->main_loop_count;
1233 /* Return previous counter. */
1234 return node->main_loop_vector_stats[i1];
1238 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1240 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1243 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1245 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1249 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1251 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1254 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1256 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1260 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1262 /* Return the edge index if present, ~0 otherwise */
1263 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1265 /* Add next node to given node in given slot. */
1267 vlib_node_add_next_with_slot (vlib_main_t * vm,
1268 uword node, uword next_node, uword slot);
1270 /* As above but adds to end of node's next vector. */
1272 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1274 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1277 /* Add next node to given node in given slot. */
1279 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1280 uword node, char *next_name, uword slot);
1282 /* As above but adds to end of node's next vector. */
1284 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1286 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1293 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1294 int barrier_sync, vlib_node_t **** node_dupsp,
1295 vlib_main_t *** stat_vmsp);
1297 /* Query node given name. */
1298 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1300 /* Rename a node. */
1301 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1303 /* Register new packet processing node. Nodes can be registered
1304 dynamically via this call or statically via the VLIB_REGISTER_NODE
1306 u32 vlib_register_node (vlib_main_t *vm, vlib_node_registration_t *r,
1309 /* Register all node function variants */
1310 void vlib_register_all_node_march_variants (vlib_main_t *vm);
1312 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1313 void vlib_register_all_static_nodes (vlib_main_t * vm);
1315 /* Start a process. */
1316 void vlib_start_process (vlib_main_t * vm, uword process_index);
1318 /* Sync up runtime and main node stats. */
1319 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1320 void vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
1321 uword n_calls, uword n_vectors,
1323 void vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
1324 uword n_calls, uword n_vectors,
1327 /* Node graph initialization function. */
1328 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1330 format_function_t format_vlib_node_graph;
1331 format_function_t format_vlib_node_name;
1332 format_function_t format_vlib_next_node_name;
1333 format_function_t format_vlib_node_and_next;
1334 format_function_t format_vlib_cpu_time;
1335 format_function_t format_vlib_time;
1336 /* Parse node name -> node index. */
1337 unformat_function_t unformat_vlib_node;
1340 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1341 u32 counter_index, u64 increment)
1343 vlib_node_t *n = vlib_get_node (vm, node_index);
1344 vlib_error_main_t *em = &vm->error_main;
1345 u32 node_counter_base_index = n->error_heap_index;
1346 em->counters[node_counter_base_index + counter_index] += increment;
1349 /** @brief Create a vlib process
1350 * @param vm &vlib_global_main
1351 * @param f the process node function
1352 * @param log2_n_stack_bytes size of the process stack, defaults to 16K
1353 * @return newly-create node index
1354 * @warning call only on the main thread. Barrier sync required
1356 u32 vlib_process_create (vlib_main_t * vm, char *name,
1357 vlib_node_function_t * f, u32 log2_n_stack_bytes);
1360 vlib_node_set_dispatch_wrapper (vlib_main_t *vm, vlib_node_function_t *fn)
1362 if (fn && vm->dispatch_wrapper_fn)
1364 vm->dispatch_wrapper_fn = fn;
1368 int vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
1369 clib_march_variant_type_t march_variant);
1371 vlib_node_function_t *
1372 vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
1373 vlib_node_fn_registration_t *regs);
1376 * vlib_frame_bitmap functions
1379 #define VLIB_FRAME_BITMAP_N_UWORDS \
1380 (((VLIB_FRAME_SIZE + uword_bits - 1) & ~(uword_bits - 1)) / uword_bits)
1382 typedef uword vlib_frame_bitmap_t[VLIB_FRAME_BITMAP_N_UWORDS];
1384 static_always_inline void
1385 vlib_frame_bitmap_init (uword *bmp, u32 n_first_bits_set)
1387 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1388 while (n_first_bits_set >= (sizeof (uword) * 8) && n_left)
1391 n_first_bits_set -= sizeof (uword) * 8;
1395 if (n_first_bits_set && n_left)
1397 bmp++[0] = pow2_mask (n_first_bits_set);
1405 static_always_inline void
1406 vlib_frame_bitmap_clear (uword *bmp)
1408 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1413 static_always_inline void
1414 vlib_frame_bitmap_xor (uword *bmp, uword *bmp2)
1416 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1418 bmp++[0] ^= bmp2++[0];
1421 static_always_inline void
1422 vlib_frame_bitmap_or (uword *bmp, uword *bmp2)
1424 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1426 bmp++[0] |= bmp2++[0];
1429 static_always_inline void
1430 vlib_frame_bitmap_and (uword *bmp, uword *bmp2)
1432 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1434 bmp++[0] &= bmp2++[0];
1437 static_always_inline u32
1438 vlib_frame_bitmap_count_set_bits (uword *bmp)
1440 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1443 count += count_set_bits (bmp++[0]);
1447 static_always_inline int
1448 vlib_frame_bitmap_find_first_set (uword *bmp)
1453 ASSERT (b - bmp < VLIB_FRAME_BITMAP_N_UWORDS);
1457 return (b - bmp) * uword_bits + get_lowest_set_bit_index (b[0]);
1460 #define foreach_vlib_frame_bitmap_set_bit_index(i, v) \
1461 for (uword _off = 0; _off < ARRAY_LEN (v); _off++) \
1463 (v[_off]) + 0 * (uword) (i = _off * uword_bits + \
1464 get_lowest_set_bit_index (v[_off])); \
1465 _tmp; i = _off * uword_bits + get_lowest_set_bit_index ( \
1466 _tmp = clear_lowest_set_bit (_tmp)))
1468 #endif /* included_vlib_node_funcs_h */
1471 * fd.io coding-style-patch-verification: ON
1474 * eval: (c-set-style "gnu")