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);
256 ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
258 if (vm != vlib_get_main ())
259 clib_interrupt_set_atomic (nm->interrupts, n->runtime_index);
261 clib_interrupt_set (nm->interrupts, n->runtime_index);
263 __atomic_store_n (nm->pending_interrupts, 1, __ATOMIC_RELEASE);
266 always_inline vlib_process_t *
267 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
269 vlib_node_main_t *nm = &vm->node_main;
270 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
271 return vec_elt (nm->processes, node->runtime_index);
274 always_inline vlib_frame_t *
275 vlib_get_frame (vlib_main_t * vm, vlib_frame_t * f)
278 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
283 vlib_frame_no_append (vlib_frame_t * f)
285 f->frame_flags |= VLIB_FRAME_NO_APPEND;
288 /** \brief Get pointer to frame vector data.
289 @param f vlib_frame_t pointer
290 @return pointer to first vector element in frame
293 vlib_frame_vector_args (vlib_frame_t * f)
295 ASSERT (f->vector_offset);
296 return (void *) f + f->vector_offset;
299 /** \brief Get pointer to frame vector aux data.
300 @param f vlib_frame_t pointer
301 @return pointer to first vector aux data element in frame
304 vlib_frame_aux_args (vlib_frame_t *f)
306 ASSERT (f->aux_offset);
307 return (void *) f + f->aux_offset;
310 /** \brief Get pointer to frame scalar data.
312 @param f vlib_frame_t pointer
314 @return arbitrary node scalar data
316 @sa vlib_frame_vector_args
319 vlib_frame_scalar_args (vlib_frame_t * f)
321 ASSERT (f->scalar_offset);
322 return (void *) f + f->scalar_offset;
325 always_inline vlib_next_frame_t *
326 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
327 vlib_node_runtime_t * n, u32 next_index)
329 vlib_node_main_t *nm = &vm->node_main;
330 vlib_next_frame_t *nf;
332 ASSERT (next_index < n->n_next_nodes);
333 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
337 vlib_node_t *node, *next;
338 node = vec_elt (nm->nodes, n->node_index);
339 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
340 ASSERT (nf->node_runtime_index == next->runtime_index);
346 /** \brief Get pointer to frame by (@c node_index, @c next_index).
348 @warning This is not a function that you should call directly.
349 See @ref vlib_get_next_frame instead.
351 @param vm vlib_main_t pointer, varies by thread
352 @param node_index index of the node
353 @param next_index graph arc index
355 @return pointer to the requested vlib_next_frame_t
357 @sa vlib_get_next_frame
360 always_inline vlib_next_frame_t *
361 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
363 vlib_node_main_t *nm = &vm->node_main;
365 vlib_node_runtime_t *r;
367 n = vec_elt (nm->nodes, node_index);
368 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
369 return vlib_node_runtime_get_next_frame (vm, r, next_index);
372 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
373 vlib_node_runtime_t * node,
375 u32 alloc_new_frame);
377 #define vlib_get_next_frame_macro(vm, node, next_index, vectors, \
378 n_vectors_left, alloc_new_frame) \
381 vlib_frame_t *_f = vlib_get_next_frame_internal ( \
382 (vm), (node), (next_index), (alloc_new_frame)); \
383 u32 _n = _f->n_vectors; \
384 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
385 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
389 #define vlib_get_next_frame_macro_with_aux(vm, node, next_index, vectors, \
390 n_vectors_left, alloc_new_frame, \
391 aux_data, maybe_no_aux) \
394 vlib_frame_t *_f = vlib_get_next_frame_internal ( \
395 (vm), (node), (next_index), (alloc_new_frame)); \
396 u32 _n = _f->n_vectors; \
397 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
398 if ((maybe_no_aux) && (_f)->aux_offset == 0) \
401 (aux_data) = vlib_frame_aux_args (_f) + _n * sizeof ((aux_data)[0]); \
402 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
406 /** \brief Get pointer to next frame vector data by
407 (@c vlib_node_runtime_t, @c next_index).
408 Standard single/dual loop boilerplate element.
409 @attention This is a MACRO, with SIDE EFFECTS.
411 @param vm vlib_main_t pointer, varies by thread
412 @param node current node vlib_node_runtime_t pointer
413 @param next_index requested graph arc index
415 @return @c vectors -- pointer to next available vector slot
416 @return @c n_vectors_left -- number of vector slots available
418 #define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left) \
419 vlib_get_next_frame_macro (vm, node, next_index, vectors, n_vectors_left, \
420 /* alloc new frame */ 0)
422 #define vlib_get_new_next_frame(vm, node, next_index, vectors, \
424 vlib_get_next_frame_macro (vm, node, next_index, vectors, n_vectors_left, \
425 /* alloc new frame */ 1)
427 /** \brief Get pointer to next frame vector data and next frame aux data by
428 (@c vlib_node_runtime_t, @c next_index).
429 Standard single/dual loop boilerplate element.
430 @attention This is a MACRO, with SIDE EFFECTS.
431 @attention This MACRO is unsafe in case the next node does not support
434 @param vm vlib_main_t pointer, varies by thread
435 @param node current node vlib_node_runtime_t pointer
436 @param next_index requested graph arc index
438 @return @c vectors -- pointer to next available vector slot
439 @return @c aux_data -- pointer to next available aux data slot
440 @return @c n_vectors_left -- number of vector slots available
442 #define vlib_get_next_frame_with_aux(vm, node, next_index, vectors, aux_data, \
444 vlib_get_next_frame_macro_with_aux ( \
445 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 0, \
446 aux_data, /* maybe_no_aux */ 0)
448 #define vlib_get_new_next_frame_with_aux(vm, node, next_index, vectors, \
449 aux_data, n_vectors_left) \
450 vlib_get_next_frame_macro_with_aux ( \
451 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 1, \
452 aux_data, /* maybe_no_aux */ 0)
454 /** \brief Get pointer to next frame vector data and next frame aux data by
455 (@c vlib_node_runtime_t, @c next_index).
456 Standard single/dual loop boilerplate element.
457 @attention This is a MACRO, with SIDE EFFECTS.
458 @attention This MACRO is safe in case the next node does not support aux_data.
459 In that case aux_data is set to NULL.
461 @param vm vlib_main_t pointer, varies by thread
462 @param node current node vlib_node_runtime_t pointer
463 @param next_index requested graph arc index
465 @return @c vectors -- pointer to next available vector slot
466 @return @c aux_data -- pointer to next available aux data slot
467 @return @c n_vectors_left -- number of vector slots available
469 #define vlib_get_next_frame_with_aux_safe(vm, node, next_index, vectors, \
470 aux_data, n_vectors_left) \
471 vlib_get_next_frame_macro_with_aux ( \
472 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 0, \
473 aux_data, /* maybe_no_aux */ 1)
475 #define vlib_get_new_next_frame_with_aux_safe(vm, node, next_index, vectors, \
476 aux_data, n_vectors_left) \
477 vlib_get_next_frame_macro_with_aux ( \
478 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 1, \
479 aux_data, /* maybe_no_aux */ 1)
481 /** \brief Release pointer to next frame vector data.
482 Standard single/dual loop boilerplate element.
483 @param vm vlib_main_t pointer, varies by thread
484 @param r current node vlib_node_runtime_t pointer
485 @param next_index graph arc index
486 @param n_packets_left number of slots still available in vector
489 vlib_put_next_frame (vlib_main_t * vm,
490 vlib_node_runtime_t * r,
491 u32 next_index, u32 n_packets_left);
493 /* Combination get plus put. Returns vector argument just added. */
494 #define vlib_set_next_frame(vm,node,next_index,v) \
497 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
498 ASSERT (_n_left > 0); \
499 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
503 #define vlib_set_next_frame_with_aux_safe(vm, node, next_index, v, aux) \
506 vlib_get_next_frame_with_aux_safe ((vm), (node), (next_index), (v), \
508 ASSERT (_n_left > 0); \
509 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
514 vlib_set_next_frame_buffer (vlib_main_t * vm,
515 vlib_node_runtime_t * node,
516 u32 next_index, u32 buffer_index)
519 p = vlib_set_next_frame (vm, node, next_index, p);
524 vlib_set_next_frame_buffer_with_aux_safe (vlib_main_t *vm,
525 vlib_node_runtime_t *node,
526 u32 next_index, u32 buffer_index,
531 p = vlib_set_next_frame_with_aux_safe (vm, node, next_index, p, a);
537 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
538 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
542 vlib_in_process_context (vlib_main_t * vm)
544 return vm->node_main.current_process_index != ~0;
547 always_inline vlib_process_t *
548 vlib_get_current_process (vlib_main_t * vm)
550 vlib_node_main_t *nm = &vm->node_main;
551 if (vlib_in_process_context (vm))
552 return vec_elt (nm->processes, nm->current_process_index);
557 vlib_current_process (vlib_main_t * vm)
559 return vlib_get_current_process (vm)->node_runtime.node_index;
563 vlib_get_current_process_node_index (vlib_main_t * vm)
565 vlib_process_t *process = vlib_get_current_process (vm);
566 return process->node_runtime.node_index;
569 /** Returns TRUE if a process suspend time is less than 10us
570 @param dt - remaining poll time in seconds
571 @returns 1 if dt < 10e-6, 0 otherwise
574 vlib_process_suspend_time_is_zero (f64 dt)
579 /** Suspend a vlib cooperative multi-tasking thread for a period of time
580 @param vm - vlib_main_t *
581 @param dt - suspend interval in seconds
582 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
586 vlib_process_suspend (vlib_main_t * vm, f64 dt)
589 vlib_node_main_t *nm = &vm->node_main;
590 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
592 if (vlib_process_suspend_time_is_zero (dt))
593 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
595 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
596 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
597 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
599 /* expiration time in 10us ticks */
600 p->resume_clock_interval = dt * 1e5;
601 vlib_process_start_switch_stack (vm, 0);
602 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
605 vlib_process_finish_switch_stack (vm);
611 vlib_process_free_event_type (vlib_process_t * p, uword t,
612 uword is_one_time_event)
614 ASSERT (!pool_is_free_index (p->event_type_pool, t));
615 pool_put_index (p->event_type_pool, t);
616 if (is_one_time_event)
617 p->one_time_event_type_bitmap =
618 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
622 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
624 ASSERT (!pool_is_free_index (p->event_type_pool, t));
625 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
626 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
630 vlib_process_get_event_data (vlib_main_t * vm,
631 uword * return_event_type_opaque)
633 vlib_node_main_t *nm = &vm->node_main;
635 vlib_process_event_type_t *et;
637 void *event_data_vector;
639 p = vec_elt (nm->processes, nm->current_process_index);
641 /* Find first type with events ready.
642 Return invalid type when there's nothing there. */
643 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
647 p->non_empty_event_type_bitmap =
648 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
650 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
651 event_data_vector = p->pending_event_data_by_type_index[t];
652 p->pending_event_data_by_type_index[t] = 0;
654 et = pool_elt_at_index (p->event_type_pool, t);
656 /* Return user's opaque value and possibly index. */
657 *return_event_type_opaque = et->opaque;
659 vlib_process_maybe_free_event_type (p, t);
661 return event_data_vector;
664 /* Return event data vector for later reuse. We reuse event data to avoid
665 repeatedly allocating event vectors in cases where we care about speed. */
667 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
669 vlib_node_main_t *nm = &vm->node_main;
670 vec_add1 (nm->recycled_event_data_vectors, event_data);
673 /** Return the first event type which has occurred and a vector of per-event
674 data of that type, or a timeout indication
676 @param vm - vlib_main_t pointer
677 @param data_vector - pointer to a (uword *) vector to receive event data
678 @returns either an event type and a vector of per-event instance data,
679 or ~0 to indicate a timeout.
683 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
685 vlib_node_main_t *nm = &vm->node_main;
687 vlib_process_event_type_t *et;
690 p = vec_elt (nm->processes, nm->current_process_index);
692 /* Find first type with events ready.
693 Return invalid type when there's nothing there. */
694 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
698 p->non_empty_event_type_bitmap =
699 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
701 l = _vec_len (p->pending_event_data_by_type_index[t]);
703 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
704 vec_set_len (p->pending_event_data_by_type_index[t], 0);
706 et = pool_elt_at_index (p->event_type_pool, t);
708 /* Return user's opaque value. */
711 vlib_process_maybe_free_event_type (p, t);
717 vlib_process_get_events_helper (vlib_process_t * p, uword t,
718 uword ** data_vector)
722 p->non_empty_event_type_bitmap =
723 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
725 l = _vec_len (p->pending_event_data_by_type_index[t]);
727 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
728 vec_set_len (p->pending_event_data_by_type_index[t], 0);
730 vlib_process_maybe_free_event_type (p, t);
735 /* As above but query as specified type of event. Returns number of
738 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
739 uword with_type_opaque)
741 vlib_node_main_t *nm = &vm->node_main;
745 p = vec_elt (nm->processes, nm->current_process_index);
746 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
748 /* This can happen when an event has not yet been
749 signaled with given opaque type. */
753 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
756 return vlib_process_get_events_helper (p, t, data_vector);
759 always_inline uword *
760 vlib_process_wait_for_event (vlib_main_t * vm)
762 vlib_node_main_t *nm = &vm->node_main;
766 p = vec_elt (nm->processes, nm->current_process_index);
767 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
769 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
771 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
772 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
774 vlib_process_start_switch_stack (vm, 0);
775 clib_longjmp (&p->return_longjmp,
776 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
779 vlib_process_finish_switch_stack (vm);
782 return p->non_empty_event_type_bitmap;
786 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
787 uword ** data_vector,
788 uword with_type_index)
790 vlib_node_main_t *nm = &vm->node_main;
794 p = vec_elt (nm->processes, nm->current_process_index);
795 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
796 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
798 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
800 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
801 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
803 vlib_process_start_switch_stack (vm, 0);
804 clib_longjmp (&p->return_longjmp,
805 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
808 vlib_process_finish_switch_stack (vm);
811 return vlib_process_get_events_helper (p, with_type_index, data_vector);
815 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
816 uword ** data_vector,
817 uword with_type_opaque)
819 vlib_node_main_t *nm = &vm->node_main;
823 p = vec_elt (nm->processes, nm->current_process_index);
824 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
825 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
827 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
829 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
830 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
832 vlib_process_start_switch_stack (vm, 0);
833 clib_longjmp (&p->return_longjmp,
834 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
837 vlib_process_finish_switch_stack (vm);
839 /* See if unknown event type has been signaled now. */
841 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
844 return vlib_process_get_events_helper (p, h[0], data_vector);
847 /** Suspend a cooperative multi-tasking thread
848 Waits for an event, or for the indicated number of seconds to elapse
849 @param vm - vlib_main_t pointer
850 @param dt - timeout, in seconds.
851 @returns the remaining time interval
855 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
857 vlib_node_main_t *nm = &vm->node_main;
862 p = vec_elt (nm->processes, nm->current_process_index);
864 if (vlib_process_suspend_time_is_zero (dt)
865 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
868 wakeup_time = vlib_time_now (vm) + dt;
870 /* Suspend waiting for both clock and event to occur. */
871 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
872 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
874 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
875 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
877 p->resume_clock_interval = dt * 1e5;
878 vlib_process_start_switch_stack (vm, 0);
879 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
882 vlib_process_finish_switch_stack (vm);
884 /* Return amount of time still left to sleep.
885 If <= 0 then we've been waken up by the clock (and not an event). */
886 return wakeup_time - vlib_time_now (vm);
889 always_inline vlib_process_event_type_t *
890 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
892 vlib_process_event_type_t *et;
893 pool_get (p->event_type_pool, et);
894 et->opaque = with_type_opaque;
899 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
900 uword with_type_opaque)
902 vlib_node_main_t *nm = &vm->node_main;
903 vlib_node_t *n = vlib_get_node (vm, node_index);
904 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
905 vlib_process_event_type_t *et;
908 et = vlib_process_new_event_type (p, with_type_opaque);
909 t = et - p->event_type_pool;
910 p->one_time_event_type_bitmap =
911 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
916 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
919 vlib_node_main_t *nm = &vm->node_main;
920 vlib_node_t *n = vlib_get_node (vm, node_index);
921 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
923 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
924 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
928 vlib_process_signal_event_helper (vlib_node_main_t * nm,
932 uword n_data_elts, uword n_data_elt_bytes)
934 uword p_flags, add_to_pending, delete_from_wheel;
935 u8 *data_to_be_written_by_caller;
936 vec_attr_t va = { .elt_sz = n_data_elt_bytes };
938 ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
940 ASSERT (!pool_is_free_index (p->event_type_pool, t));
942 vec_validate (p->pending_event_data_by_type_index, t);
944 /* Resize data vector and return caller's data to be written. */
946 u8 *data_vec = p->pending_event_data_by_type_index[t];
949 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
951 data_vec = vec_pop (nm->recycled_event_data_vectors);
952 vec_reset_length (data_vec);
955 l = vec_len (data_vec);
957 data_vec = _vec_realloc_internal (data_vec, l + n_data_elts, &va);
959 p->pending_event_data_by_type_index[t] = data_vec;
960 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
963 p->non_empty_event_type_bitmap =
964 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
968 /* Event was already signalled? */
969 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
971 /* Process will resume when suspend time elapses? */
972 delete_from_wheel = 0;
973 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
975 /* Waiting for both event and clock? */
976 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
978 if (!TW (tw_timer_handle_is_free)
979 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
980 p->stop_timer_handle))
981 delete_from_wheel = 1;
983 /* timer just popped so process should already be on the list */
987 /* Waiting only for clock. Event will be queue and may be
988 handled when timer expires. */
992 /* Never add current process to pending vector since current process is
994 add_to_pending &= nm->current_process_index != n->runtime_index;
998 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
999 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
1000 vec_add1 (nm->data_from_advancing_timing_wheel, x);
1001 if (delete_from_wheel)
1002 TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1003 p->stop_timer_handle);
1006 return data_to_be_written_by_caller;
1009 always_inline void *
1010 vlib_process_signal_event_data (vlib_main_t * vm,
1013 uword n_data_elts, uword n_data_elt_bytes)
1015 vlib_node_main_t *nm = &vm->node_main;
1016 vlib_node_t *n = vlib_get_node (vm, node_index);
1017 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1020 /* Must be in main thread */
1021 ASSERT (vlib_get_thread_index () == 0);
1023 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
1026 vlib_process_event_type_t *et =
1027 vlib_process_new_event_type (p, type_opaque);
1028 t = et - p->event_type_pool;
1029 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1034 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1038 always_inline void *
1039 vlib_process_signal_event_at_time (vlib_main_t * vm,
1043 uword n_data_elts, uword n_data_elt_bytes)
1045 vlib_node_main_t *nm = &vm->node_main;
1046 vlib_node_t *n = vlib_get_node (vm, node_index);
1047 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1050 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
1053 vlib_process_event_type_t *et =
1054 vlib_process_new_event_type (p, type_opaque);
1055 t = et - p->event_type_pool;
1056 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1061 if (vlib_process_suspend_time_is_zero (dt))
1062 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1066 vlib_signal_timed_event_data_t *te;
1068 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
1070 te->n_data_elts = n_data_elts;
1071 te->n_data_elt_bytes = n_data_elt_bytes;
1072 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
1074 /* Assert that structure fields are big enough. */
1075 ASSERT (te->n_data_elts == n_data_elts);
1076 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
1077 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
1079 te->process_node_index = n->runtime_index;
1080 te->event_type_index = t;
1082 p->stop_timer_handle =
1083 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1084 vlib_timing_wheel_data_set_timed_event
1085 (te - nm->signal_timed_event_data_pool),
1087 (vlib_time_now (vm) + dt) * 1e5);
1089 /* Inline data big enough to hold event? */
1090 if (te->n_data_bytes < sizeof (te->inline_event_data))
1091 return te->inline_event_data;
1094 te->event_data_as_vector = 0;
1095 vec_resize (te->event_data_as_vector, te->n_data_bytes);
1096 return te->event_data_as_vector;
1101 always_inline void *
1102 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
1106 uword n_data_elt_bytes)
1108 vlib_node_main_t *nm = &vm->node_main;
1109 vlib_node_t *n = vlib_get_node (vm, node_index);
1110 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1111 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
1116 vlib_process_signal_event (vlib_main_t * vm,
1117 uword node_index, uword type_opaque, uword data)
1119 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1120 1 /* elts */ , sizeof (uword));
1125 vlib_process_signal_event_pointer (vlib_main_t * vm,
1127 uword type_opaque, void *data)
1129 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1130 1 /* elts */ , sizeof (data));
1135 * Signal event to process from any thread.
1137 * When in doubt, use this.
1140 vlib_process_signal_event_mt (vlib_main_t * vm,
1141 uword node_index, uword type_opaque, uword data)
1143 if (vlib_get_thread_index () != 0)
1145 vlib_process_signal_event_mt_args_t args = {
1146 .node_index = node_index,
1147 .type_opaque = type_opaque,
1150 vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
1151 (u8 *) & args, sizeof (args));
1154 vlib_process_signal_event (vm, node_index, type_opaque, data);
1158 vlib_process_signal_one_time_event (vlib_main_t * vm,
1160 uword type_index, uword data)
1163 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1164 1 /* elts */ , sizeof (uword));
1169 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1170 vlib_one_time_waiting_process_t * p)
1172 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1174 clib_memset (p, ~0, sizeof (p[0]));
1178 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1179 vlib_one_time_waiting_process_t
1182 vlib_one_time_waiting_process_t *wp;
1183 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1188 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1189 vlib_one_time_waiting_process_t
1192 p->node_index = vlib_current_process (vm);
1193 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1195 vlib_process_wait_for_one_time_event (vm,
1196 /* don't care about data */ 0,
1201 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1202 vlib_one_time_waiting_process_t
1205 vlib_one_time_waiting_process_t *wp;
1206 vec_add2 (*wps, wp, 1);
1207 vlib_current_process_wait_for_one_time_event (vm, wp);
1211 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1212 vlib_node_runtime_t * node,
1218 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1219 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1220 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1223 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1225 (node->main_loop_count_last_dispatch >>
1226 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1227 vi0 = node->main_loop_vector_stats[i0];
1228 vi1 = node->main_loop_vector_stats[i1];
1229 vi0 = d == 0 ? vi0 : 0;
1230 vi1 = d <= 1 ? vi1 : 0;
1232 node->main_loop_vector_stats[i0] = vi0;
1233 node->main_loop_vector_stats[i1] = vi1;
1234 node->main_loop_count_last_dispatch = vm->main_loop_count;
1235 /* Return previous counter. */
1236 return node->main_loop_vector_stats[i1];
1240 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1242 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1245 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1247 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1251 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1253 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1256 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1258 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1261 void vlib_frame_free (vlib_main_t *vm, vlib_frame_t *f);
1263 /* Return the edge index if present, ~0 otherwise */
1264 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1266 /* Add next node to given node in given slot. */
1268 vlib_node_add_next_with_slot (vlib_main_t * vm,
1269 uword node, uword next_node, uword slot);
1271 /* As above but adds to end of node's next vector. */
1273 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1275 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1278 /* Add next node to given node in given slot. */
1280 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1281 uword node, char *next_name, uword slot);
1283 /* As above but adds to end of node's next vector. */
1285 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1287 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1294 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1295 int barrier_sync, vlib_node_t **** node_dupsp,
1296 vlib_main_t *** stat_vmsp);
1298 /* Query node given name. */
1299 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1301 /* Rename a node. */
1302 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1304 /* Register new packet processing node. Nodes can be registered
1305 dynamically via this call or statically via the VLIB_REGISTER_NODE
1307 u32 vlib_register_node (vlib_main_t *vm, vlib_node_registration_t *r,
1310 /* Register all node function variants */
1311 void vlib_register_all_node_march_variants (vlib_main_t *vm);
1313 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1314 void vlib_register_all_static_nodes (vlib_main_t * vm);
1316 /* Start a process. */
1317 void vlib_start_process (vlib_main_t * vm, uword process_index);
1319 /* Sync up runtime and main node stats. */
1320 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1321 void vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
1322 uword n_calls, uword n_vectors,
1324 void vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
1325 uword n_calls, uword n_vectors,
1328 /* Node graph initialization function. */
1329 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1331 format_function_t format_vlib_node_graph;
1332 format_function_t format_vlib_node_name;
1333 format_function_t format_vlib_next_node_name;
1334 format_function_t format_vlib_node_and_next;
1335 format_function_t format_vlib_cpu_time;
1336 format_function_t format_vlib_time;
1337 /* Parse node name -> node index. */
1338 unformat_function_t unformat_vlib_node;
1341 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1342 u32 counter_index, u64 increment)
1344 vlib_node_t *n = vlib_get_node (vm, node_index);
1345 vlib_error_main_t *em = &vm->error_main;
1346 u32 node_counter_base_index = n->error_heap_index;
1347 em->counters[node_counter_base_index + counter_index] += increment;
1350 /** @brief Create a vlib process
1351 * @param vm &vlib_global_main
1352 * @param f the process node function
1353 * @param log2_n_stack_bytes size of the process stack, defaults to 16K
1354 * @return newly-create node index
1355 * @warning call only on the main thread. Barrier sync required
1357 u32 vlib_process_create (vlib_main_t * vm, char *name,
1358 vlib_node_function_t * f, u32 log2_n_stack_bytes);
1361 vlib_node_set_dispatch_wrapper (vlib_main_t *vm, vlib_node_function_t *fn)
1363 if (fn && vm->dispatch_wrapper_fn)
1365 vm->dispatch_wrapper_fn = fn;
1369 int vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
1370 clib_march_variant_type_t march_variant);
1372 vlib_node_function_t *
1373 vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
1374 vlib_node_fn_registration_t *regs);
1377 * vlib_frame_bitmap functions
1380 #define VLIB_FRAME_BITMAP_N_UWORDS \
1381 (((VLIB_FRAME_SIZE + uword_bits - 1) & ~(uword_bits - 1)) / uword_bits)
1383 typedef uword vlib_frame_bitmap_t[VLIB_FRAME_BITMAP_N_UWORDS];
1385 static_always_inline void
1386 vlib_frame_bitmap_init (uword *bmp, u32 n_first_bits_set)
1388 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1389 while (n_first_bits_set >= (sizeof (uword) * 8) && n_left)
1392 n_first_bits_set -= sizeof (uword) * 8;
1396 if (n_first_bits_set && n_left)
1398 bmp++[0] = pow2_mask (n_first_bits_set);
1406 static_always_inline void
1407 vlib_frame_bitmap_set_bit_at_index (uword *bmp, uword bit_index)
1409 bmp += bit_index / uword_bits;
1410 bit_index %= uword_bits;
1411 bmp[0] |= 1 << bit_index;
1414 static_always_inline void
1415 _vlib_frame_bitmap_clear_bit_at_index (uword *bmp, uword bit_index)
1417 bmp += bit_index / uword_bits;
1418 bit_index %= uword_bits;
1419 bmp[0] &= ~((uword) 1 << bit_index);
1422 static_always_inline void
1423 vlib_frame_bitmap_clear (uword *bmp)
1425 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1430 static_always_inline void
1431 vlib_frame_bitmap_xor (uword *bmp, uword *bmp2)
1433 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1435 bmp++[0] ^= bmp2++[0];
1438 static_always_inline void
1439 vlib_frame_bitmap_or (uword *bmp, uword *bmp2)
1441 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1443 bmp++[0] |= bmp2++[0];
1446 static_always_inline void
1447 vlib_frame_bitmap_and (uword *bmp, uword *bmp2)
1449 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1451 bmp++[0] &= bmp2++[0];
1454 static_always_inline u32
1455 vlib_frame_bitmap_count_set_bits (uword *bmp)
1457 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1460 count += count_set_bits (bmp++[0]);
1464 static_always_inline uword
1465 vlib_frame_bitmap_is_bit_set (uword *bmp, uword bit_index)
1467 bmp += bit_index / uword_bits;
1468 bit_index %= uword_bits;
1469 return (bmp[0] >> bit_index) & 1;
1472 static_always_inline int
1473 vlib_frame_bitmap_find_first_set (uword *bmp)
1478 ASSERT (b - bmp < VLIB_FRAME_BITMAP_N_UWORDS);
1482 return (b - bmp) * uword_bits + get_lowest_set_bit_index (b[0]);
1485 #define foreach_vlib_frame_bitmap_set_bit_index(i, v) \
1486 for (uword _off = 0; _off < ARRAY_LEN (v); _off++) \
1488 (v[_off]) + 0 * (uword) (i = _off * uword_bits + \
1489 get_lowest_set_bit_index (v[_off])); \
1490 _tmp; i = _off * uword_bits + get_lowest_set_bit_index ( \
1491 _tmp = clear_lowest_set_bit (_tmp)))
1493 #endif /* included_vlib_node_funcs_h */
1496 * fd.io coding-style-patch-verification: ON
1499 * eval: (c-set-style "gnu")