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); \
502 vlib_set_next_frame_buffer (vlib_main_t * vm,
503 vlib_node_runtime_t * node,
504 u32 next_index, u32 buffer_index)
507 p = vlib_set_next_frame (vm, node, next_index, p);
511 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
512 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
516 vlib_in_process_context (vlib_main_t * vm)
518 return vm->node_main.current_process_index != ~0;
521 always_inline vlib_process_t *
522 vlib_get_current_process (vlib_main_t * vm)
524 vlib_node_main_t *nm = &vm->node_main;
525 if (vlib_in_process_context (vm))
526 return vec_elt (nm->processes, nm->current_process_index);
531 vlib_current_process (vlib_main_t * vm)
533 return vlib_get_current_process (vm)->node_runtime.node_index;
537 vlib_get_current_process_node_index (vlib_main_t * vm)
539 vlib_process_t *process = vlib_get_current_process (vm);
540 return process->node_runtime.node_index;
543 /** Returns TRUE if a process suspend time is less than 10us
544 @param dt - remaining poll time in seconds
545 @returns 1 if dt < 10e-6, 0 otherwise
548 vlib_process_suspend_time_is_zero (f64 dt)
553 /** Suspend a vlib cooperative multi-tasking thread for a period of time
554 @param vm - vlib_main_t *
555 @param dt - suspend interval in seconds
556 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
560 vlib_process_suspend (vlib_main_t * vm, f64 dt)
563 vlib_node_main_t *nm = &vm->node_main;
564 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
566 if (vlib_process_suspend_time_is_zero (dt))
567 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
569 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
570 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
571 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
573 /* expiration time in 10us ticks */
574 p->resume_clock_interval = dt * 1e5;
575 vlib_process_start_switch_stack (vm, 0);
576 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
579 vlib_process_finish_switch_stack (vm);
585 vlib_process_free_event_type (vlib_process_t * p, uword t,
586 uword is_one_time_event)
588 ASSERT (!pool_is_free_index (p->event_type_pool, t));
589 pool_put_index (p->event_type_pool, t);
590 if (is_one_time_event)
591 p->one_time_event_type_bitmap =
592 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
596 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
598 ASSERT (!pool_is_free_index (p->event_type_pool, t));
599 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
600 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
604 vlib_process_get_event_data (vlib_main_t * vm,
605 uword * return_event_type_opaque)
607 vlib_node_main_t *nm = &vm->node_main;
609 vlib_process_event_type_t *et;
611 void *event_data_vector;
613 p = vec_elt (nm->processes, nm->current_process_index);
615 /* Find first type with events ready.
616 Return invalid type when there's nothing there. */
617 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
621 p->non_empty_event_type_bitmap =
622 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
624 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
625 event_data_vector = p->pending_event_data_by_type_index[t];
626 p->pending_event_data_by_type_index[t] = 0;
628 et = pool_elt_at_index (p->event_type_pool, t);
630 /* Return user's opaque value and possibly index. */
631 *return_event_type_opaque = et->opaque;
633 vlib_process_maybe_free_event_type (p, t);
635 return event_data_vector;
638 /* Return event data vector for later reuse. We reuse event data to avoid
639 repeatedly allocating event vectors in cases where we care about speed. */
641 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
643 vlib_node_main_t *nm = &vm->node_main;
644 vec_add1 (nm->recycled_event_data_vectors, event_data);
647 /** Return the first event type which has occurred and a vector of per-event
648 data of that type, or a timeout indication
650 @param vm - vlib_main_t pointer
651 @param data_vector - pointer to a (uword *) vector to receive event data
652 @returns either an event type and a vector of per-event instance data,
653 or ~0 to indicate a timeout.
657 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
659 vlib_node_main_t *nm = &vm->node_main;
661 vlib_process_event_type_t *et;
664 p = vec_elt (nm->processes, nm->current_process_index);
666 /* Find first type with events ready.
667 Return invalid type when there's nothing there. */
668 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
672 p->non_empty_event_type_bitmap =
673 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
675 l = _vec_len (p->pending_event_data_by_type_index[t]);
677 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
678 vec_set_len (p->pending_event_data_by_type_index[t], 0);
680 et = pool_elt_at_index (p->event_type_pool, t);
682 /* Return user's opaque value. */
685 vlib_process_maybe_free_event_type (p, t);
691 vlib_process_get_events_helper (vlib_process_t * p, uword t,
692 uword ** data_vector)
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 vlib_process_maybe_free_event_type (p, t);
709 /* As above but query as specified type of event. Returns number of
712 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
713 uword with_type_opaque)
715 vlib_node_main_t *nm = &vm->node_main;
719 p = vec_elt (nm->processes, nm->current_process_index);
720 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
722 /* This can happen when an event has not yet been
723 signaled with given opaque type. */
727 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
730 return vlib_process_get_events_helper (p, t, data_vector);
733 always_inline uword *
734 vlib_process_wait_for_event (vlib_main_t * vm)
736 vlib_node_main_t *nm = &vm->node_main;
740 p = vec_elt (nm->processes, nm->current_process_index);
741 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
743 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
745 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
746 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
748 vlib_process_start_switch_stack (vm, 0);
749 clib_longjmp (&p->return_longjmp,
750 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
753 vlib_process_finish_switch_stack (vm);
756 return p->non_empty_event_type_bitmap;
760 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
761 uword ** data_vector,
762 uword with_type_index)
764 vlib_node_main_t *nm = &vm->node_main;
768 p = vec_elt (nm->processes, nm->current_process_index);
769 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
770 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
772 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
774 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
775 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
777 vlib_process_start_switch_stack (vm, 0);
778 clib_longjmp (&p->return_longjmp,
779 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
782 vlib_process_finish_switch_stack (vm);
785 return vlib_process_get_events_helper (p, with_type_index, data_vector);
789 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
790 uword ** data_vector,
791 uword with_type_opaque)
793 vlib_node_main_t *nm = &vm->node_main;
797 p = vec_elt (nm->processes, nm->current_process_index);
798 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
799 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
801 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
803 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
804 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
806 vlib_process_start_switch_stack (vm, 0);
807 clib_longjmp (&p->return_longjmp,
808 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
811 vlib_process_finish_switch_stack (vm);
813 /* See if unknown event type has been signaled now. */
815 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
818 return vlib_process_get_events_helper (p, h[0], data_vector);
821 /** Suspend a cooperative multi-tasking thread
822 Waits for an event, or for the indicated number of seconds to elapse
823 @param vm - vlib_main_t pointer
824 @param dt - timeout, in seconds.
825 @returns the remaining time interval
829 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
831 vlib_node_main_t *nm = &vm->node_main;
836 p = vec_elt (nm->processes, nm->current_process_index);
838 if (vlib_process_suspend_time_is_zero (dt)
839 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
842 wakeup_time = vlib_time_now (vm) + dt;
844 /* Suspend waiting for both clock and event to occur. */
845 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
846 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
848 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
849 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
851 p->resume_clock_interval = dt * 1e5;
852 vlib_process_start_switch_stack (vm, 0);
853 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
856 vlib_process_finish_switch_stack (vm);
858 /* Return amount of time still left to sleep.
859 If <= 0 then we've been waken up by the clock (and not an event). */
860 return wakeup_time - vlib_time_now (vm);
863 always_inline vlib_process_event_type_t *
864 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
866 vlib_process_event_type_t *et;
867 pool_get (p->event_type_pool, et);
868 et->opaque = with_type_opaque;
873 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
874 uword with_type_opaque)
876 vlib_node_main_t *nm = &vm->node_main;
877 vlib_node_t *n = vlib_get_node (vm, node_index);
878 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
879 vlib_process_event_type_t *et;
882 et = vlib_process_new_event_type (p, with_type_opaque);
883 t = et - p->event_type_pool;
884 p->one_time_event_type_bitmap =
885 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
890 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
893 vlib_node_main_t *nm = &vm->node_main;
894 vlib_node_t *n = vlib_get_node (vm, node_index);
895 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
897 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
898 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
902 vlib_process_signal_event_helper (vlib_node_main_t * nm,
906 uword n_data_elts, uword n_data_elt_bytes)
908 uword p_flags, add_to_pending, delete_from_wheel;
909 u8 *data_to_be_written_by_caller;
910 vec_attr_t va = { .elt_sz = n_data_elt_bytes };
912 ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
914 ASSERT (!pool_is_free_index (p->event_type_pool, t));
916 vec_validate (p->pending_event_data_by_type_index, t);
918 /* Resize data vector and return caller's data to be written. */
920 u8 *data_vec = p->pending_event_data_by_type_index[t];
923 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
925 data_vec = vec_pop (nm->recycled_event_data_vectors);
926 vec_reset_length (data_vec);
929 l = vec_len (data_vec);
931 data_vec = _vec_realloc_internal (data_vec, l + n_data_elts, &va);
933 p->pending_event_data_by_type_index[t] = data_vec;
934 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
937 p->non_empty_event_type_bitmap =
938 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
942 /* Event was already signalled? */
943 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
945 /* Process will resume when suspend time elapses? */
946 delete_from_wheel = 0;
947 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
949 /* Waiting for both event and clock? */
950 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
952 if (!TW (tw_timer_handle_is_free)
953 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
954 p->stop_timer_handle))
955 delete_from_wheel = 1;
957 /* timer just popped so process should already be on the list */
961 /* Waiting only for clock. Event will be queue and may be
962 handled when timer expires. */
966 /* Never add current process to pending vector since current process is
968 add_to_pending &= nm->current_process_index != n->runtime_index;
972 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
973 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
974 vec_add1 (nm->data_from_advancing_timing_wheel, x);
975 if (delete_from_wheel)
976 TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
977 p->stop_timer_handle);
980 return data_to_be_written_by_caller;
984 vlib_process_signal_event_data (vlib_main_t * vm,
987 uword n_data_elts, uword n_data_elt_bytes)
989 vlib_node_main_t *nm = &vm->node_main;
990 vlib_node_t *n = vlib_get_node (vm, node_index);
991 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
994 /* Must be in main thread */
995 ASSERT (vlib_get_thread_index () == 0);
997 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
1000 vlib_process_event_type_t *et =
1001 vlib_process_new_event_type (p, type_opaque);
1002 t = et - p->event_type_pool;
1003 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1008 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1012 always_inline void *
1013 vlib_process_signal_event_at_time (vlib_main_t * vm,
1017 uword n_data_elts, uword n_data_elt_bytes)
1019 vlib_node_main_t *nm = &vm->node_main;
1020 vlib_node_t *n = vlib_get_node (vm, node_index);
1021 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1024 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
1027 vlib_process_event_type_t *et =
1028 vlib_process_new_event_type (p, type_opaque);
1029 t = et - p->event_type_pool;
1030 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1035 if (vlib_process_suspend_time_is_zero (dt))
1036 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1040 vlib_signal_timed_event_data_t *te;
1042 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
1044 te->n_data_elts = n_data_elts;
1045 te->n_data_elt_bytes = n_data_elt_bytes;
1046 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
1048 /* Assert that structure fields are big enough. */
1049 ASSERT (te->n_data_elts == n_data_elts);
1050 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
1051 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
1053 te->process_node_index = n->runtime_index;
1054 te->event_type_index = t;
1056 p->stop_timer_handle =
1057 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1058 vlib_timing_wheel_data_set_timed_event
1059 (te - nm->signal_timed_event_data_pool),
1061 (vlib_time_now (vm) + dt) * 1e5);
1063 /* Inline data big enough to hold event? */
1064 if (te->n_data_bytes < sizeof (te->inline_event_data))
1065 return te->inline_event_data;
1068 te->event_data_as_vector = 0;
1069 vec_resize (te->event_data_as_vector, te->n_data_bytes);
1070 return te->event_data_as_vector;
1075 always_inline void *
1076 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
1080 uword n_data_elt_bytes)
1082 vlib_node_main_t *nm = &vm->node_main;
1083 vlib_node_t *n = vlib_get_node (vm, node_index);
1084 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1085 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
1090 vlib_process_signal_event (vlib_main_t * vm,
1091 uword node_index, uword type_opaque, uword data)
1093 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1094 1 /* elts */ , sizeof (uword));
1099 vlib_process_signal_event_pointer (vlib_main_t * vm,
1101 uword type_opaque, void *data)
1103 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1104 1 /* elts */ , sizeof (data));
1109 * Signal event to process from any thread.
1111 * When in doubt, use this.
1114 vlib_process_signal_event_mt (vlib_main_t * vm,
1115 uword node_index, uword type_opaque, uword data)
1117 if (vlib_get_thread_index () != 0)
1119 vlib_process_signal_event_mt_args_t args = {
1120 .node_index = node_index,
1121 .type_opaque = type_opaque,
1124 vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
1125 (u8 *) & args, sizeof (args));
1128 vlib_process_signal_event (vm, node_index, type_opaque, data);
1132 vlib_process_signal_one_time_event (vlib_main_t * vm,
1134 uword type_index, uword data)
1137 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1138 1 /* elts */ , sizeof (uword));
1143 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1144 vlib_one_time_waiting_process_t * p)
1146 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1148 clib_memset (p, ~0, sizeof (p[0]));
1152 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1153 vlib_one_time_waiting_process_t
1156 vlib_one_time_waiting_process_t *wp;
1157 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1162 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1163 vlib_one_time_waiting_process_t
1166 p->node_index = vlib_current_process (vm);
1167 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1169 vlib_process_wait_for_one_time_event (vm,
1170 /* don't care about data */ 0,
1175 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1176 vlib_one_time_waiting_process_t
1179 vlib_one_time_waiting_process_t *wp;
1180 vec_add2 (*wps, wp, 1);
1181 vlib_current_process_wait_for_one_time_event (vm, wp);
1185 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1186 vlib_node_runtime_t * node,
1192 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1193 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1194 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1197 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1199 (node->main_loop_count_last_dispatch >>
1200 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1201 vi0 = node->main_loop_vector_stats[i0];
1202 vi1 = node->main_loop_vector_stats[i1];
1203 vi0 = d == 0 ? vi0 : 0;
1204 vi1 = d <= 1 ? vi1 : 0;
1206 node->main_loop_vector_stats[i0] = vi0;
1207 node->main_loop_vector_stats[i1] = vi1;
1208 node->main_loop_count_last_dispatch = vm->main_loop_count;
1209 /* Return previous counter. */
1210 return node->main_loop_vector_stats[i1];
1214 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1216 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1219 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1221 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1225 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1227 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1230 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1232 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1236 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1238 /* Return the edge index if present, ~0 otherwise */
1239 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1241 /* Add next node to given node in given slot. */
1243 vlib_node_add_next_with_slot (vlib_main_t * vm,
1244 uword node, uword next_node, uword slot);
1246 /* As above but adds to end of node's next vector. */
1248 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1250 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1253 /* Add next node to given node in given slot. */
1255 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1256 uword node, char *next_name, uword slot);
1258 /* As above but adds to end of node's next vector. */
1260 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1262 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1269 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1270 int barrier_sync, vlib_node_t **** node_dupsp,
1271 vlib_main_t *** stat_vmsp);
1273 /* Query node given name. */
1274 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1276 /* Rename a node. */
1277 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1279 /* Register new packet processing node. Nodes can be registered
1280 dynamically via this call or statically via the VLIB_REGISTER_NODE
1282 u32 vlib_register_node (vlib_main_t *vm, vlib_node_registration_t *r,
1285 /* Register all node function variants */
1286 void vlib_register_all_node_march_variants (vlib_main_t *vm);
1288 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1289 void vlib_register_all_static_nodes (vlib_main_t * vm);
1291 /* Start a process. */
1292 void vlib_start_process (vlib_main_t * vm, uword process_index);
1294 /* Sync up runtime and main node stats. */
1295 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1296 void vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
1297 uword n_calls, uword n_vectors,
1299 void vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
1300 uword n_calls, uword n_vectors,
1303 /* Node graph initialization function. */
1304 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1306 format_function_t format_vlib_node_graph;
1307 format_function_t format_vlib_node_name;
1308 format_function_t format_vlib_next_node_name;
1309 format_function_t format_vlib_node_and_next;
1310 format_function_t format_vlib_cpu_time;
1311 format_function_t format_vlib_time;
1312 /* Parse node name -> node index. */
1313 unformat_function_t unformat_vlib_node;
1316 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1317 u32 counter_index, u64 increment)
1319 vlib_node_t *n = vlib_get_node (vm, node_index);
1320 vlib_error_main_t *em = &vm->error_main;
1321 u32 node_counter_base_index = n->error_heap_index;
1322 em->counters[node_counter_base_index + counter_index] += increment;
1325 /** @brief Create a vlib process
1326 * @param vm &vlib_global_main
1327 * @param f the process node function
1328 * @param log2_n_stack_bytes size of the process stack, defaults to 16K
1329 * @return newly-create node index
1330 * @warning call only on the main thread. Barrier sync required
1332 u32 vlib_process_create (vlib_main_t * vm, char *name,
1333 vlib_node_function_t * f, u32 log2_n_stack_bytes);
1336 vlib_node_set_dispatch_wrapper (vlib_main_t *vm, vlib_node_function_t *fn)
1338 if (fn && vm->dispatch_wrapper_fn)
1340 vm->dispatch_wrapper_fn = fn;
1344 int vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
1345 clib_march_variant_type_t march_variant);
1347 vlib_node_function_t *
1348 vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
1349 vlib_node_fn_registration_t *regs);
1352 * vlib_frame_bitmap functions
1355 #define VLIB_FRAME_BITMAP_N_UWORDS \
1356 (((VLIB_FRAME_SIZE + uword_bits - 1) & ~(uword_bits - 1)) / uword_bits)
1358 typedef uword vlib_frame_bitmap_t[VLIB_FRAME_BITMAP_N_UWORDS];
1360 static_always_inline void
1361 vlib_frame_bitmap_init (uword *bmp, u32 n_first_bits_set)
1363 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1364 while (n_first_bits_set >= (sizeof (uword) * 8) && n_left)
1367 n_first_bits_set -= sizeof (uword) * 8;
1371 if (n_first_bits_set && n_left)
1373 bmp++[0] = pow2_mask (n_first_bits_set);
1381 static_always_inline void
1382 vlib_frame_bitmap_clear (uword *bmp)
1384 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1389 static_always_inline void
1390 vlib_frame_bitmap_xor (uword *bmp, uword *bmp2)
1392 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1394 bmp++[0] ^= bmp2++[0];
1397 static_always_inline void
1398 vlib_frame_bitmap_or (uword *bmp, uword *bmp2)
1400 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1402 bmp++[0] |= bmp2++[0];
1405 static_always_inline void
1406 vlib_frame_bitmap_and (uword *bmp, uword *bmp2)
1408 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1410 bmp++[0] &= bmp2++[0];
1413 static_always_inline u32
1414 vlib_frame_bitmap_count_set_bits (uword *bmp)
1416 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1419 count += count_set_bits (bmp++[0]);
1423 static_always_inline int
1424 vlib_frame_bitmap_find_first_set (uword *bmp)
1429 ASSERT (b - bmp < VLIB_FRAME_BITMAP_N_UWORDS);
1433 return (b - bmp) * uword_bits + get_lowest_set_bit_index (b[0]);
1436 #define foreach_vlib_frame_bitmap_set_bit_index(i, v) \
1437 for (uword _off = 0; _off < ARRAY_LEN (v); _off++) \
1439 (v[_off]) + 0 * (uword) (i = _off * uword_bits + \
1440 get_lowest_set_bit_index (v[_off])); \
1441 _tmp; i = _off * uword_bits + get_lowest_set_bit_index ( \
1442 _tmp = clear_lowest_set_bit (_tmp)))
1444 #endif /* included_vlib_node_funcs_h */
1447 * fd.io coding-style-patch-verification: ON
1450 * eval: (c-set-style "gnu")