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/clib.h>
49 #include <vppinfra/fifo.h>
50 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
51 #include <vppinfra/interrupt.h>
53 #ifdef CLIB_SANITIZE_ADDR
54 #include <sanitizer/asan_interface.h>
57 static_always_inline void
58 vlib_process_start_switch_stack (vlib_main_t * vm, vlib_process_t * p)
60 #ifdef CLIB_SANITIZE_ADDR
61 void *stack = p ? (void *) p->stack : vlib_thread_stacks[vm->thread_index];
63 p ? (1ULL < p->log2_n_stack_bytes) : VLIB_THREAD_STACK_SIZE;
64 __sanitizer_start_switch_fiber (&vm->asan_stack_save, stack, stack_bytes);
68 static_always_inline void
69 vlib_process_finish_switch_stack (vlib_main_t * vm)
71 #ifdef CLIB_SANITIZE_ADDR
72 const void *bottom_old;
75 __sanitizer_finish_switch_fiber (&vm->asan_stack_save, &bottom_old,
80 /** \brief Get vlib node by index.
81 @warning This function will ASSERT if @c i is out of range.
82 @param vm vlib_main_t pointer, varies by thread
84 @return pointer to the requested vlib_node_t.
87 always_inline vlib_node_t *
88 vlib_get_node (vlib_main_t * vm, u32 i)
90 return vec_elt (vm->node_main.nodes, i);
93 /** \brief Get vlib node by graph arc (next) index.
94 @param vm vlib_main_t pointer, varies by thread
95 @param node_index index of original node
96 @param next_index graph arc index
97 @return pointer to the vlib_node_t at the end of the indicated arc
100 always_inline vlib_node_t *
101 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
103 vlib_node_main_t *nm = &vm->node_main;
106 n = vec_elt (nm->nodes, node_index);
107 ASSERT (next_index < vec_len (n->next_nodes));
108 return vlib_get_node (vm, n->next_nodes[next_index]);
111 /** \brief Get node runtime by node index.
112 @param vm vlib_main_t pointer, varies by thread
113 @param node_index index of node
114 @return pointer to the indicated vlib_node_runtime_t
117 always_inline vlib_node_runtime_t *
118 vlib_node_get_runtime (vlib_main_t * vm, u32 node_index)
120 vlib_node_main_t *nm = &vm->node_main;
121 vlib_node_t *n = vec_elt (nm->nodes, node_index);
123 if (n->type != VLIB_NODE_TYPE_PROCESS)
124 return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
127 p = vec_elt (nm->processes, n->runtime_index);
128 return &p->node_runtime;
132 /** \brief Get node runtime private data by node index.
133 @param vm vlib_main_t pointer, varies by thread
134 @param node_index index of the node
135 @return pointer to the indicated vlib_node_runtime_t private data
139 vlib_node_get_runtime_data (vlib_main_t * vm, u32 node_index)
141 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
142 return r->runtime_data;
145 /** \brief Set node runtime private data.
146 @param vm vlib_main_t pointer, varies by thread
147 @param node_index index of the node
148 @param runtime_data arbitrary runtime private data
149 @param n_runtime_data_bytes size of runtime private data
153 vlib_node_set_runtime_data (vlib_main_t * vm, u32 node_index,
154 void *runtime_data, u32 n_runtime_data_bytes)
156 vlib_node_t *n = vlib_get_node (vm, node_index);
157 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
159 n->runtime_data_bytes = n_runtime_data_bytes;
160 vec_free (n->runtime_data);
161 vec_add (n->runtime_data, runtime_data, n_runtime_data_bytes);
163 ASSERT (vec_len (n->runtime_data) <= sizeof (vlib_node_runtime_t) -
164 STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
166 if (vec_len (n->runtime_data) > 0)
167 clib_memcpy_fast (r->runtime_data, n->runtime_data,
168 vec_len (n->runtime_data));
171 /** \brief Set node dispatch state.
172 @param vm vlib_main_t pointer, varies by thread
173 @param node_index index of the node
174 @param new_state new state for node, see vlib_node_state_t
177 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
178 vlib_node_state_t new_state)
180 vlib_node_main_t *nm = &vm->node_main;
182 vlib_node_runtime_t *r;
184 n = vec_elt (nm->nodes, node_index);
185 if (n->type == VLIB_NODE_TYPE_PROCESS)
187 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
188 r = &p->node_runtime;
190 /* When disabling make sure flags are cleared. */
191 p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
192 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
193 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
196 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
198 ASSERT (new_state < VLIB_N_NODE_STATE);
200 if (n->type == VLIB_NODE_TYPE_INPUT)
202 ASSERT (nm->input_node_counts_by_state[n->state] > 0);
203 nm->input_node_counts_by_state[n->state] -= 1;
204 nm->input_node_counts_by_state[new_state] += 1;
207 if (PREDICT_FALSE (r->state == VLIB_NODE_STATE_DISABLED))
208 vlib_node_runtime_perf_counter (vm, r, 0, 0, 0,
209 VLIB_NODE_RUNTIME_PERF_RESET);
211 n->state = new_state;
212 r->state = new_state;
215 /** \brief Get node dispatch state.
216 @param vm vlib_main_t pointer, varies by thread
217 @param node_index index of the node
218 @return state for node, see vlib_node_state_t
220 always_inline vlib_node_state_t
221 vlib_node_get_state (vlib_main_t * vm, u32 node_index)
223 vlib_node_main_t *nm = &vm->node_main;
225 n = vec_elt (nm->nodes, node_index);
230 vlib_node_set_flag (vlib_main_t *vm, u32 node_index, u16 flag, u8 enable)
232 vlib_node_runtime_t *r;
235 n = vlib_get_node (vm, node_index);
236 r = vlib_node_get_runtime (vm, node_index);
251 vlib_node_set_interrupt_pending (vlib_main_t *vm, u32 node_index)
253 vlib_node_main_t *nm = &vm->node_main;
254 vlib_node_t *n = vec_elt (nm->nodes, node_index);
255 void *interrupts = 0;
257 if (n->type == VLIB_NODE_TYPE_INPUT)
258 interrupts = nm->input_node_interrupts;
259 else if (n->type == VLIB_NODE_TYPE_PRE_INPUT)
260 interrupts = nm->pre_input_node_interrupts;
267 if (vm != vlib_get_main ())
268 clib_interrupt_set_atomic (interrupts, n->runtime_index);
270 clib_interrupt_set (interrupts, n->runtime_index);
273 always_inline vlib_process_t *
274 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
276 vlib_node_main_t *nm = &vm->node_main;
277 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
278 return vec_elt (nm->processes, node->runtime_index);
281 always_inline vlib_frame_t *
282 vlib_get_frame (vlib_main_t * vm, vlib_frame_t * f)
285 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
290 vlib_frame_no_append (vlib_frame_t * f)
292 f->frame_flags |= VLIB_FRAME_NO_APPEND;
295 /** \brief Get pointer to frame vector data.
296 @param f vlib_frame_t pointer
297 @return pointer to first vector element in frame
300 vlib_frame_vector_args (vlib_frame_t * f)
302 ASSERT (f->vector_offset);
303 return (void *) f + f->vector_offset;
306 /** \brief Get pointer to frame vector aux data.
307 @param f vlib_frame_t pointer
308 @return pointer to first vector aux data element in frame
311 vlib_frame_aux_args (vlib_frame_t *f)
313 ASSERT (f->aux_offset);
314 return (void *) f + f->aux_offset;
317 /** \brief Get pointer to frame scalar data.
319 @param f vlib_frame_t pointer
321 @return arbitrary node scalar data
323 @sa vlib_frame_vector_args
326 vlib_frame_scalar_args (vlib_frame_t * f)
328 ASSERT (f->scalar_offset);
329 return (void *) f + f->scalar_offset;
332 always_inline vlib_next_frame_t *
333 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
334 vlib_node_runtime_t * n, u32 next_index)
336 vlib_node_main_t *nm = &vm->node_main;
337 vlib_next_frame_t *nf;
339 ASSERT (next_index < n->n_next_nodes);
340 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
344 vlib_node_t *node, *next;
345 node = vec_elt (nm->nodes, n->node_index);
346 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
347 ASSERT (nf->node_runtime_index == next->runtime_index);
353 /** \brief Get pointer to frame by (@c node_index, @c next_index).
355 @warning This is not a function that you should call directly.
356 See @ref vlib_get_next_frame instead.
358 @param vm vlib_main_t pointer, varies by thread
359 @param node_index index of the node
360 @param next_index graph arc index
362 @return pointer to the requested vlib_next_frame_t
364 @sa vlib_get_next_frame
367 always_inline vlib_next_frame_t *
368 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
370 vlib_node_main_t *nm = &vm->node_main;
372 vlib_node_runtime_t *r;
374 n = vec_elt (nm->nodes, node_index);
375 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
376 return vlib_node_runtime_get_next_frame (vm, r, next_index);
379 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
380 vlib_node_runtime_t * node,
382 u32 alloc_new_frame);
384 #define vlib_get_next_frame_macro(vm, node, next_index, vectors, \
385 n_vectors_left, alloc_new_frame) \
388 vlib_frame_t *_f = vlib_get_next_frame_internal ( \
389 (vm), (node), (next_index), (alloc_new_frame)); \
390 u32 _n = _f->n_vectors; \
391 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
392 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
396 #define vlib_get_next_frame_macro_with_aux(vm, node, next_index, vectors, \
397 n_vectors_left, alloc_new_frame, \
398 aux_data, maybe_no_aux) \
401 vlib_frame_t *_f = vlib_get_next_frame_internal ( \
402 (vm), (node), (next_index), (alloc_new_frame)); \
403 u32 _n = _f->n_vectors; \
404 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
405 if ((maybe_no_aux) && (_f)->aux_offset == 0) \
408 (aux_data) = vlib_frame_aux_args (_f) + _n * sizeof ((aux_data)[0]); \
409 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
413 /** \brief Get pointer to next frame vector data by
414 (@c vlib_node_runtime_t, @c next_index).
415 Standard single/dual loop boilerplate element.
416 @attention This is a MACRO, with SIDE EFFECTS.
418 @param vm vlib_main_t pointer, varies by thread
419 @param node current node vlib_node_runtime_t pointer
420 @param next_index requested graph arc index
422 @return @c vectors -- pointer to next available vector slot
423 @return @c n_vectors_left -- number of vector slots available
425 #define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left) \
426 vlib_get_next_frame_macro (vm, node, next_index, vectors, n_vectors_left, \
427 /* alloc new frame */ 0)
429 #define vlib_get_new_next_frame(vm, node, next_index, vectors, \
431 vlib_get_next_frame_macro (vm, node, next_index, vectors, n_vectors_left, \
432 /* alloc new frame */ 1)
434 /** \brief Get pointer to next frame vector data and next frame aux data by
435 (@c vlib_node_runtime_t, @c next_index).
436 Standard single/dual loop boilerplate element.
437 @attention This is a MACRO, with SIDE EFFECTS.
438 @attention This MACRO is unsafe in case the next node does not support
441 @param vm vlib_main_t pointer, varies by thread
442 @param node current node vlib_node_runtime_t pointer
443 @param next_index requested graph arc index
445 @return @c vectors -- pointer to next available vector slot
446 @return @c aux_data -- pointer to next available aux data slot
447 @return @c n_vectors_left -- number of vector slots available
449 #define vlib_get_next_frame_with_aux(vm, node, next_index, vectors, aux_data, \
451 vlib_get_next_frame_macro_with_aux ( \
452 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 0, \
453 aux_data, /* maybe_no_aux */ 0)
455 #define vlib_get_new_next_frame_with_aux(vm, node, next_index, vectors, \
456 aux_data, n_vectors_left) \
457 vlib_get_next_frame_macro_with_aux ( \
458 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 1, \
459 aux_data, /* maybe_no_aux */ 0)
461 /** \brief Get pointer to next frame vector data and next frame aux data by
462 (@c vlib_node_runtime_t, @c next_index).
463 Standard single/dual loop boilerplate element.
464 @attention This is a MACRO, with SIDE EFFECTS.
465 @attention This MACRO is safe in case the next node does not support aux_data.
466 In that case aux_data is set to NULL.
468 @param vm vlib_main_t pointer, varies by thread
469 @param node current node vlib_node_runtime_t pointer
470 @param next_index requested graph arc index
472 @return @c vectors -- pointer to next available vector slot
473 @return @c aux_data -- pointer to next available aux data slot
474 @return @c n_vectors_left -- number of vector slots available
476 #define vlib_get_next_frame_with_aux_safe(vm, node, next_index, vectors, \
477 aux_data, n_vectors_left) \
478 vlib_get_next_frame_macro_with_aux ( \
479 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 0, \
480 aux_data, /* maybe_no_aux */ 1)
482 #define vlib_get_new_next_frame_with_aux_safe(vm, node, next_index, vectors, \
483 aux_data, n_vectors_left) \
484 vlib_get_next_frame_macro_with_aux ( \
485 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 1, \
486 aux_data, /* maybe_no_aux */ 1)
488 /** \brief Release pointer to next frame vector data.
489 Standard single/dual loop boilerplate element.
490 @param vm vlib_main_t pointer, varies by thread
491 @param r current node vlib_node_runtime_t pointer
492 @param next_index graph arc index
493 @param n_packets_left number of slots still available in vector
496 vlib_put_next_frame (vlib_main_t * vm,
497 vlib_node_runtime_t * r,
498 u32 next_index, u32 n_packets_left);
500 /* Combination get plus put. Returns vector argument just added. */
501 #define vlib_set_next_frame(vm,node,next_index,v) \
504 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
505 ASSERT (_n_left > 0); \
506 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
510 #define vlib_set_next_frame_with_aux_safe(vm, node, next_index, v, aux) \
513 vlib_get_next_frame_with_aux_safe ((vm), (node), (next_index), (v), \
515 ASSERT (_n_left > 0); \
516 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
521 vlib_set_next_frame_buffer (vlib_main_t * vm,
522 vlib_node_runtime_t * node,
523 u32 next_index, u32 buffer_index)
526 p = vlib_set_next_frame (vm, node, next_index, p);
531 vlib_set_next_frame_buffer_with_aux_safe (vlib_main_t *vm,
532 vlib_node_runtime_t *node,
533 u32 next_index, u32 buffer_index,
538 p = vlib_set_next_frame_with_aux_safe (vm, node, next_index, p, a);
544 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
545 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
549 vlib_in_process_context (vlib_main_t * vm)
551 return vm->node_main.current_process_index != ~0;
554 always_inline vlib_process_t *
555 vlib_get_current_process (vlib_main_t * vm)
557 vlib_node_main_t *nm = &vm->node_main;
558 if (vlib_in_process_context (vm))
559 return vec_elt (nm->processes, nm->current_process_index);
564 vlib_current_process (vlib_main_t * vm)
566 return vlib_get_current_process (vm)->node_runtime.node_index;
570 vlib_get_current_process_node_index (vlib_main_t * vm)
572 vlib_process_t *process = vlib_get_current_process (vm);
573 return process->node_runtime.node_index;
576 /** Returns TRUE if a process suspend time is less than 10us
577 @param dt - remaining poll time in seconds
578 @returns 1 if dt < 10e-6, 0 otherwise
581 vlib_process_suspend_time_is_zero (f64 dt)
586 /** Suspend a vlib cooperative multi-tasking thread for a period of time
587 @param vm - vlib_main_t *
588 @param dt - suspend interval in seconds
589 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
593 vlib_process_suspend (vlib_main_t * vm, f64 dt)
596 vlib_node_main_t *nm = &vm->node_main;
597 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
599 if (vlib_process_suspend_time_is_zero (dt))
600 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
602 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
603 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
604 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
606 /* expiration time in 10us ticks */
607 p->resume_clock_interval = dt * 1e5;
608 vlib_process_start_switch_stack (vm, 0);
609 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
612 vlib_process_finish_switch_stack (vm);
618 vlib_process_free_event_type (vlib_process_t * p, uword t,
619 uword is_one_time_event)
621 ASSERT (!pool_is_free_index (p->event_type_pool, t));
622 pool_put_index (p->event_type_pool, t);
623 if (is_one_time_event)
624 p->one_time_event_type_bitmap =
625 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
629 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
631 ASSERT (!pool_is_free_index (p->event_type_pool, t));
632 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
633 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
637 vlib_process_get_event_data (vlib_main_t * vm,
638 uword * return_event_type_opaque)
640 vlib_node_main_t *nm = &vm->node_main;
642 vlib_process_event_type_t *et;
644 void *event_data_vector;
646 p = vec_elt (nm->processes, nm->current_process_index);
648 /* Find first type with events ready.
649 Return invalid type when there's nothing there. */
650 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
654 p->non_empty_event_type_bitmap =
655 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
657 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
658 event_data_vector = p->pending_event_data_by_type_index[t];
659 p->pending_event_data_by_type_index[t] = 0;
661 et = pool_elt_at_index (p->event_type_pool, t);
663 /* Return user's opaque value and possibly index. */
664 *return_event_type_opaque = et->opaque;
666 vlib_process_maybe_free_event_type (p, t);
668 return event_data_vector;
671 /* Return event data vector for later reuse. We reuse event data to avoid
672 repeatedly allocating event vectors in cases where we care about speed. */
674 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
676 vlib_node_main_t *nm = &vm->node_main;
677 vec_add1 (nm->recycled_event_data_vectors, event_data);
680 /** Return the first event type which has occurred and a vector of per-event
681 data of that type, or a timeout indication
683 @param vm - vlib_main_t pointer
684 @param data_vector - pointer to a (uword *) vector to receive event data
685 @returns either an event type and a vector of per-event instance data,
686 or ~0 to indicate a timeout.
690 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
692 vlib_node_main_t *nm = &vm->node_main;
694 vlib_process_event_type_t *et;
697 p = vec_elt (nm->processes, nm->current_process_index);
699 /* Find first type with events ready.
700 Return invalid type when there's nothing there. */
701 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
705 p->non_empty_event_type_bitmap =
706 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
708 l = _vec_len (p->pending_event_data_by_type_index[t]);
710 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
711 vec_set_len (p->pending_event_data_by_type_index[t], 0);
713 et = pool_elt_at_index (p->event_type_pool, t);
715 /* Return user's opaque value. */
718 vlib_process_maybe_free_event_type (p, t);
724 vlib_process_get_events_helper (vlib_process_t * p, uword t,
725 uword ** data_vector)
729 p->non_empty_event_type_bitmap =
730 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
732 l = _vec_len (p->pending_event_data_by_type_index[t]);
734 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
735 vec_set_len (p->pending_event_data_by_type_index[t], 0);
737 vlib_process_maybe_free_event_type (p, t);
742 /* As above but query as specified type of event. Returns number of
745 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
746 uword with_type_opaque)
748 vlib_node_main_t *nm = &vm->node_main;
752 p = vec_elt (nm->processes, nm->current_process_index);
753 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
755 /* This can happen when an event has not yet been
756 signaled with given opaque type. */
760 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
763 return vlib_process_get_events_helper (p, t, data_vector);
766 always_inline uword *
767 vlib_process_wait_for_event (vlib_main_t * vm)
769 vlib_node_main_t *nm = &vm->node_main;
773 p = vec_elt (nm->processes, nm->current_process_index);
774 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
776 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
778 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
779 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
781 vlib_process_start_switch_stack (vm, 0);
782 clib_longjmp (&p->return_longjmp,
783 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
786 vlib_process_finish_switch_stack (vm);
789 return p->non_empty_event_type_bitmap;
793 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
794 uword ** data_vector,
795 uword with_type_index)
797 vlib_node_main_t *nm = &vm->node_main;
801 p = vec_elt (nm->processes, nm->current_process_index);
802 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
803 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
805 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
807 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
808 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
810 vlib_process_start_switch_stack (vm, 0);
811 clib_longjmp (&p->return_longjmp,
812 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
815 vlib_process_finish_switch_stack (vm);
818 return vlib_process_get_events_helper (p, with_type_index, data_vector);
822 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
823 uword ** data_vector,
824 uword with_type_opaque)
826 vlib_node_main_t *nm = &vm->node_main;
830 p = vec_elt (nm->processes, nm->current_process_index);
831 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
832 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
834 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
836 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
837 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
839 vlib_process_start_switch_stack (vm, 0);
840 clib_longjmp (&p->return_longjmp,
841 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
844 vlib_process_finish_switch_stack (vm);
846 /* See if unknown event type has been signaled now. */
848 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
851 return vlib_process_get_events_helper (p, h[0], data_vector);
854 /** Suspend a cooperative multi-tasking thread
855 Waits for an event, or for the indicated number of seconds to elapse
856 @param vm - vlib_main_t pointer
857 @param dt - timeout, in seconds.
858 @returns the remaining time interval
862 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
864 vlib_node_main_t *nm = &vm->node_main;
869 p = vec_elt (nm->processes, nm->current_process_index);
871 if (vlib_process_suspend_time_is_zero (dt)
872 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
875 wakeup_time = vlib_time_now (vm) + dt;
877 /* Suspend waiting for both clock and event to occur. */
878 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
879 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
881 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
882 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
884 p->resume_clock_interval = dt * 1e5;
885 vlib_process_start_switch_stack (vm, 0);
886 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
889 vlib_process_finish_switch_stack (vm);
891 /* Return amount of time still left to sleep.
892 If <= 0 then we've been waken up by the clock (and not an event). */
893 return wakeup_time - vlib_time_now (vm);
896 always_inline vlib_process_event_type_t *
897 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
899 vlib_process_event_type_t *et;
900 pool_get (p->event_type_pool, et);
901 et->opaque = with_type_opaque;
906 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
907 uword with_type_opaque)
909 vlib_node_main_t *nm = &vm->node_main;
910 vlib_node_t *n = vlib_get_node (vm, node_index);
911 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
912 vlib_process_event_type_t *et;
915 et = vlib_process_new_event_type (p, with_type_opaque);
916 t = et - p->event_type_pool;
917 p->one_time_event_type_bitmap =
918 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
923 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
926 vlib_node_main_t *nm = &vm->node_main;
927 vlib_node_t *n = vlib_get_node (vm, node_index);
928 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
930 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
931 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
935 vlib_process_signal_event_helper (vlib_node_main_t * nm,
939 uword n_data_elts, uword n_data_elt_bytes)
941 uword p_flags, add_to_pending, delete_from_wheel;
942 u8 *data_to_be_written_by_caller;
943 vec_attr_t va = { .elt_sz = n_data_elt_bytes };
945 ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
947 ASSERT (!pool_is_free_index (p->event_type_pool, t));
949 vec_validate (p->pending_event_data_by_type_index, t);
951 /* Resize data vector and return caller's data to be written. */
953 u8 *data_vec = p->pending_event_data_by_type_index[t];
956 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
958 data_vec = vec_pop (nm->recycled_event_data_vectors);
959 vec_reset_length (data_vec);
962 l = vec_len (data_vec);
964 data_vec = _vec_realloc_internal (data_vec, l + n_data_elts, &va);
966 p->pending_event_data_by_type_index[t] = data_vec;
967 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
970 p->non_empty_event_type_bitmap =
971 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
975 /* Event was already signalled? */
976 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
978 /* Process will resume when suspend time elapses? */
979 delete_from_wheel = 0;
980 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
982 /* Waiting for both event and clock? */
983 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
985 if (!TW (tw_timer_handle_is_free)
986 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
987 p->stop_timer_handle))
988 delete_from_wheel = 1;
990 /* timer just popped so process should already be on the list */
994 /* Waiting only for clock. Event will be queue and may be
995 handled when timer expires. */
999 /* Never add current process to pending vector since current process is
1001 add_to_pending &= nm->current_process_index != n->runtime_index;
1005 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
1006 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
1007 vec_add1 (nm->data_from_advancing_timing_wheel, x);
1008 if (delete_from_wheel)
1011 ((TWT (tw_timer_wheel) *) nm->timing_wheel, p->stop_timer_handle);
1012 p->stop_timer_handle = ~0;
1016 return data_to_be_written_by_caller;
1019 always_inline void *
1020 vlib_process_signal_event_data (vlib_main_t * vm,
1023 uword n_data_elts, uword n_data_elt_bytes)
1025 vlib_node_main_t *nm = &vm->node_main;
1026 vlib_node_t *n = vlib_get_node (vm, node_index);
1027 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1030 /* Must be in main thread */
1031 ASSERT (vlib_get_thread_index () == 0);
1033 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
1036 vlib_process_event_type_t *et =
1037 vlib_process_new_event_type (p, type_opaque);
1038 t = et - p->event_type_pool;
1039 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1044 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1048 always_inline void *
1049 vlib_process_signal_event_at_time (vlib_main_t * vm,
1053 uword n_data_elts, uword n_data_elt_bytes)
1055 vlib_node_main_t *nm = &vm->node_main;
1056 vlib_node_t *n = vlib_get_node (vm, node_index);
1057 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1060 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
1063 vlib_process_event_type_t *et =
1064 vlib_process_new_event_type (p, type_opaque);
1065 t = et - p->event_type_pool;
1066 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1071 if (vlib_process_suspend_time_is_zero (dt))
1072 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1076 vlib_signal_timed_event_data_t *te;
1078 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
1080 te->n_data_elts = n_data_elts;
1081 te->n_data_elt_bytes = n_data_elt_bytes;
1082 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
1084 /* Assert that structure fields are big enough. */
1085 ASSERT (te->n_data_elts == n_data_elts);
1086 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
1087 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
1089 te->process_node_index = n->runtime_index;
1090 te->event_type_index = t;
1092 p->stop_timer_handle =
1093 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1094 vlib_timing_wheel_data_set_timed_event
1095 (te - nm->signal_timed_event_data_pool),
1097 (vlib_time_now (vm) + dt) * 1e5);
1099 /* Inline data big enough to hold event? */
1100 if (te->n_data_bytes < sizeof (te->inline_event_data))
1101 return te->inline_event_data;
1104 te->event_data_as_vector = 0;
1105 vec_resize (te->event_data_as_vector, te->n_data_bytes);
1106 return te->event_data_as_vector;
1111 always_inline void *
1112 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
1116 uword n_data_elt_bytes)
1118 vlib_node_main_t *nm = &vm->node_main;
1119 vlib_node_t *n = vlib_get_node (vm, node_index);
1120 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1121 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
1126 vlib_process_signal_event (vlib_main_t * vm,
1127 uword node_index, uword type_opaque, uword data)
1129 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1130 1 /* elts */ , sizeof (uword));
1135 vlib_process_signal_event_pointer (vlib_main_t * vm,
1137 uword type_opaque, void *data)
1139 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1140 1 /* elts */ , sizeof (data));
1145 * Signal event to process from any thread.
1147 * When in doubt, use this.
1150 vlib_process_signal_event_mt (vlib_main_t * vm,
1151 uword node_index, uword type_opaque, uword data)
1153 if (vlib_get_thread_index () != 0)
1155 vlib_process_signal_event_mt_args_t args = {
1156 .node_index = node_index,
1157 .type_opaque = type_opaque,
1160 vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
1161 (u8 *) & args, sizeof (args));
1164 vlib_process_signal_event (vm, node_index, type_opaque, data);
1168 vlib_process_signal_one_time_event (vlib_main_t * vm,
1170 uword type_index, uword data)
1173 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1174 1 /* elts */ , sizeof (uword));
1179 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1180 vlib_one_time_waiting_process_t * p)
1182 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1184 clib_memset (p, ~0, sizeof (p[0]));
1188 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1189 vlib_one_time_waiting_process_t
1192 vlib_one_time_waiting_process_t *wp;
1193 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1198 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1199 vlib_one_time_waiting_process_t
1202 p->node_index = vlib_current_process (vm);
1203 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1205 vlib_process_wait_for_one_time_event (vm,
1206 /* don't care about data */ 0,
1211 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1212 vlib_one_time_waiting_process_t
1215 vlib_one_time_waiting_process_t *wp;
1216 vec_add2 (*wps, wp, 1);
1217 vlib_current_process_wait_for_one_time_event (vm, wp);
1221 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1222 vlib_node_runtime_t * node,
1228 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1229 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1230 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1233 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1235 (node->main_loop_count_last_dispatch >>
1236 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1237 vi0 = node->main_loop_vector_stats[i0];
1238 vi1 = node->main_loop_vector_stats[i1];
1239 vi0 = d == 0 ? vi0 : 0;
1240 vi1 = d <= 1 ? vi1 : 0;
1242 node->main_loop_vector_stats[i0] = vi0;
1243 node->main_loop_vector_stats[i1] = vi1;
1244 node->main_loop_count_last_dispatch = vm->main_loop_count;
1245 /* Return previous counter. */
1246 return node->main_loop_vector_stats[i1];
1250 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1252 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1255 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1257 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1261 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1263 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1266 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1268 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1271 void vlib_frame_free (vlib_main_t *vm, vlib_frame_t *f);
1273 /* Return the edge index if present, ~0 otherwise */
1274 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1276 /* Add next node to given node in given slot. */
1278 vlib_node_add_next_with_slot (vlib_main_t * vm,
1279 uword node, uword next_node, uword slot);
1281 /* As above but adds to end of node's next vector. */
1283 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1285 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1288 /* Add next node to given node in given slot. */
1290 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1291 uword node, char *next_name, uword slot);
1293 /* As above but adds to end of node's next vector. */
1295 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1297 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1304 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1305 int barrier_sync, vlib_node_t **** node_dupsp,
1306 vlib_main_t *** stat_vmsp);
1308 /* Query node given name. */
1309 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1311 /* Rename a node. */
1312 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1314 /* Register new packet processing node. Nodes can be registered
1315 dynamically via this call or statically via the VLIB_REGISTER_NODE
1317 u32 vlib_register_node (vlib_main_t *vm, vlib_node_registration_t *r,
1320 /* Register all node function variants */
1321 void vlib_register_all_node_march_variants (vlib_main_t *vm);
1323 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1324 void vlib_register_all_static_nodes (vlib_main_t * vm);
1326 /* Start a process. */
1327 void vlib_start_process (vlib_main_t * vm, uword process_index);
1329 /* Sync up runtime and main node stats. */
1330 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1331 void vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
1332 uword n_calls, uword n_vectors,
1334 void vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
1335 uword n_calls, uword n_vectors,
1338 /* Node graph initialization function. */
1339 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1341 format_function_t format_vlib_node_graph;
1342 format_function_t format_vlib_node_name;
1343 format_function_t format_vlib_next_node_name;
1344 format_function_t format_vlib_node_and_next;
1345 format_function_t format_vlib_cpu_time;
1346 format_function_t format_vlib_time;
1347 /* Parse node name -> node index. */
1348 unformat_function_t unformat_vlib_node;
1351 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1352 u32 counter_index, u64 increment)
1354 vlib_node_t *n = vlib_get_node (vm, node_index);
1355 vlib_error_main_t *em = &vm->error_main;
1356 u32 node_counter_base_index = n->error_heap_index;
1357 em->counters[node_counter_base_index + counter_index] += increment;
1360 /** @brief Create a vlib process
1361 * @param vm &vlib_global_main
1362 * @param f the process node function
1363 * @param log2_n_stack_bytes size of the process stack, defaults to 16K
1364 * @return newly-create node index
1365 * @warning call only on the main thread. Barrier sync required
1367 u32 vlib_process_create (vlib_main_t * vm, char *name,
1368 vlib_node_function_t * f, u32 log2_n_stack_bytes);
1371 vlib_node_set_dispatch_wrapper (vlib_main_t *vm, vlib_node_function_t *fn)
1373 if (fn && vm->dispatch_wrapper_fn)
1375 vm->dispatch_wrapper_fn = fn;
1379 int vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
1380 clib_march_variant_type_t march_variant);
1382 vlib_node_function_t *
1383 vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
1384 vlib_node_fn_registration_t *regs);
1387 * vlib_frame_bitmap functions
1390 #define VLIB_FRAME_BITMAP_N_UWORDS \
1391 (((VLIB_FRAME_SIZE + uword_bits - 1) & ~(uword_bits - 1)) / uword_bits)
1393 typedef uword vlib_frame_bitmap_t[VLIB_FRAME_BITMAP_N_UWORDS];
1395 static_always_inline void
1396 vlib_frame_bitmap_init (uword *bmp, u32 n_first_bits_set)
1398 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1399 while (n_first_bits_set >= (sizeof (uword) * 8) && n_left)
1402 n_first_bits_set -= sizeof (uword) * 8;
1406 if (n_first_bits_set && n_left)
1408 bmp++[0] = pow2_mask (n_first_bits_set);
1416 static_always_inline void
1417 vlib_frame_bitmap_set_bit_at_index (uword *bmp, uword bit_index)
1419 uword_bitmap_set_bits_at_index (bmp, bit_index, 1);
1422 static_always_inline void
1423 _vlib_frame_bitmap_clear_bit_at_index (uword *bmp, uword bit_index)
1425 uword_bitmap_clear_bits_at_index (bmp, bit_index, 1);
1428 static_always_inline void
1429 vlib_frame_bitmap_set_bits_at_index (uword *bmp, uword bit_index, uword n_bits)
1431 uword_bitmap_set_bits_at_index (bmp, bit_index, n_bits);
1434 static_always_inline void
1435 vlib_frame_bitmap_clear_bits_at_index (uword *bmp, uword bit_index,
1438 uword_bitmap_clear_bits_at_index (bmp, bit_index, n_bits);
1441 static_always_inline void
1442 vlib_frame_bitmap_clear (uword *bmp)
1444 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1449 static_always_inline void
1450 vlib_frame_bitmap_xor (uword *bmp, uword *bmp2)
1452 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1454 bmp++[0] ^= bmp2++[0];
1457 static_always_inline void
1458 vlib_frame_bitmap_or (uword *bmp, uword *bmp2)
1460 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1462 bmp++[0] |= bmp2++[0];
1465 static_always_inline void
1466 vlib_frame_bitmap_and (uword *bmp, uword *bmp2)
1468 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1470 bmp++[0] &= bmp2++[0];
1473 static_always_inline uword
1474 vlib_frame_bitmap_count_set_bits (uword *bmp)
1476 return uword_bitmap_count_set_bits (bmp, VLIB_FRAME_BITMAP_N_UWORDS);
1479 static_always_inline uword
1480 vlib_frame_bitmap_is_bit_set (uword *bmp, uword bit_index)
1482 return uword_bitmap_is_bit_set (bmp, bit_index);
1485 static_always_inline uword
1486 vlib_frame_bitmap_find_first_set (uword *bmp)
1488 uword rv = uword_bitmap_find_first_set (bmp);
1489 ASSERT (rv < VLIB_FRAME_BITMAP_N_UWORDS * uword_bits);
1493 #define foreach_vlib_frame_bitmap_set_bit_index(i, v) \
1494 for (uword _off = 0; _off < ARRAY_LEN (v); _off++) \
1496 (v[_off]) + 0 * (uword) (i = _off * uword_bits + \
1497 get_lowest_set_bit_index (v[_off])); \
1498 _tmp; i = _off * uword_bits + get_lowest_set_bit_index ( \
1499 _tmp = clear_lowest_set_bit (_tmp)))
1501 #endif /* included_vlib_node_funcs_h */
1504 * fd.io coding-style-patch-verification: ON
1507 * eval: (c-set-style "gnu")