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);
272 __atomic_store_n (&nm->pending_interrupts, 1, __ATOMIC_RELEASE);
275 always_inline vlib_process_t *
276 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
278 vlib_node_main_t *nm = &vm->node_main;
279 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
280 return vec_elt (nm->processes, node->runtime_index);
283 always_inline vlib_frame_t *
284 vlib_get_frame (vlib_main_t * vm, vlib_frame_t * f)
287 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
292 vlib_frame_no_append (vlib_frame_t * f)
294 f->frame_flags |= VLIB_FRAME_NO_APPEND;
297 /** \brief Get pointer to frame vector data.
298 @param f vlib_frame_t pointer
299 @return pointer to first vector element in frame
302 vlib_frame_vector_args (vlib_frame_t * f)
304 ASSERT (f->vector_offset);
305 return (void *) f + f->vector_offset;
308 /** \brief Get pointer to frame vector aux data.
309 @param f vlib_frame_t pointer
310 @return pointer to first vector aux data element in frame
313 vlib_frame_aux_args (vlib_frame_t *f)
315 ASSERT (f->aux_offset);
316 return (void *) f + f->aux_offset;
319 /** \brief Get pointer to frame scalar data.
321 @param f vlib_frame_t pointer
323 @return arbitrary node scalar data
325 @sa vlib_frame_vector_args
328 vlib_frame_scalar_args (vlib_frame_t * f)
330 ASSERT (f->scalar_offset);
331 return (void *) f + f->scalar_offset;
334 always_inline vlib_next_frame_t *
335 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
336 vlib_node_runtime_t * n, u32 next_index)
338 vlib_node_main_t *nm = &vm->node_main;
339 vlib_next_frame_t *nf;
341 ASSERT (next_index < n->n_next_nodes);
342 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
346 vlib_node_t *node, *next;
347 node = vec_elt (nm->nodes, n->node_index);
348 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
349 ASSERT (nf->node_runtime_index == next->runtime_index);
355 /** \brief Get pointer to frame by (@c node_index, @c next_index).
357 @warning This is not a function that you should call directly.
358 See @ref vlib_get_next_frame instead.
360 @param vm vlib_main_t pointer, varies by thread
361 @param node_index index of the node
362 @param next_index graph arc index
364 @return pointer to the requested vlib_next_frame_t
366 @sa vlib_get_next_frame
369 always_inline vlib_next_frame_t *
370 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
372 vlib_node_main_t *nm = &vm->node_main;
374 vlib_node_runtime_t *r;
376 n = vec_elt (nm->nodes, node_index);
377 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
378 return vlib_node_runtime_get_next_frame (vm, r, next_index);
381 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
382 vlib_node_runtime_t * node,
384 u32 alloc_new_frame);
386 #define vlib_get_next_frame_macro(vm, node, next_index, vectors, \
387 n_vectors_left, alloc_new_frame) \
390 vlib_frame_t *_f = vlib_get_next_frame_internal ( \
391 (vm), (node), (next_index), (alloc_new_frame)); \
392 u32 _n = _f->n_vectors; \
393 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
394 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
398 #define vlib_get_next_frame_macro_with_aux(vm, node, next_index, vectors, \
399 n_vectors_left, alloc_new_frame, \
400 aux_data, maybe_no_aux) \
403 vlib_frame_t *_f = vlib_get_next_frame_internal ( \
404 (vm), (node), (next_index), (alloc_new_frame)); \
405 u32 _n = _f->n_vectors; \
406 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
407 if ((maybe_no_aux) && (_f)->aux_offset == 0) \
410 (aux_data) = vlib_frame_aux_args (_f) + _n * sizeof ((aux_data)[0]); \
411 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
415 /** \brief Get pointer to next frame vector data by
416 (@c vlib_node_runtime_t, @c next_index).
417 Standard single/dual loop boilerplate element.
418 @attention This is a MACRO, with SIDE EFFECTS.
420 @param vm vlib_main_t pointer, varies by thread
421 @param node current node vlib_node_runtime_t pointer
422 @param next_index requested graph arc index
424 @return @c vectors -- pointer to next available vector slot
425 @return @c n_vectors_left -- number of vector slots available
427 #define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left) \
428 vlib_get_next_frame_macro (vm, node, next_index, vectors, n_vectors_left, \
429 /* alloc new frame */ 0)
431 #define vlib_get_new_next_frame(vm, node, next_index, vectors, \
433 vlib_get_next_frame_macro (vm, node, next_index, vectors, n_vectors_left, \
434 /* alloc new frame */ 1)
436 /** \brief Get pointer to next frame vector data and next frame aux data by
437 (@c vlib_node_runtime_t, @c next_index).
438 Standard single/dual loop boilerplate element.
439 @attention This is a MACRO, with SIDE EFFECTS.
440 @attention This MACRO is unsafe in case the next node does not support
443 @param vm vlib_main_t pointer, varies by thread
444 @param node current node vlib_node_runtime_t pointer
445 @param next_index requested graph arc index
447 @return @c vectors -- pointer to next available vector slot
448 @return @c aux_data -- pointer to next available aux data slot
449 @return @c n_vectors_left -- number of vector slots available
451 #define vlib_get_next_frame_with_aux(vm, node, next_index, vectors, aux_data, \
453 vlib_get_next_frame_macro_with_aux ( \
454 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 0, \
455 aux_data, /* maybe_no_aux */ 0)
457 #define vlib_get_new_next_frame_with_aux(vm, node, next_index, vectors, \
458 aux_data, n_vectors_left) \
459 vlib_get_next_frame_macro_with_aux ( \
460 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 1, \
461 aux_data, /* maybe_no_aux */ 0)
463 /** \brief Get pointer to next frame vector data and next frame aux data by
464 (@c vlib_node_runtime_t, @c next_index).
465 Standard single/dual loop boilerplate element.
466 @attention This is a MACRO, with SIDE EFFECTS.
467 @attention This MACRO is safe in case the next node does not support aux_data.
468 In that case aux_data is set to NULL.
470 @param vm vlib_main_t pointer, varies by thread
471 @param node current node vlib_node_runtime_t pointer
472 @param next_index requested graph arc index
474 @return @c vectors -- pointer to next available vector slot
475 @return @c aux_data -- pointer to next available aux data slot
476 @return @c n_vectors_left -- number of vector slots available
478 #define vlib_get_next_frame_with_aux_safe(vm, node, next_index, vectors, \
479 aux_data, n_vectors_left) \
480 vlib_get_next_frame_macro_with_aux ( \
481 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 0, \
482 aux_data, /* maybe_no_aux */ 1)
484 #define vlib_get_new_next_frame_with_aux_safe(vm, node, next_index, vectors, \
485 aux_data, n_vectors_left) \
486 vlib_get_next_frame_macro_with_aux ( \
487 vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 1, \
488 aux_data, /* maybe_no_aux */ 1)
490 /** \brief Release pointer to next frame vector data.
491 Standard single/dual loop boilerplate element.
492 @param vm vlib_main_t pointer, varies by thread
493 @param r current node vlib_node_runtime_t pointer
494 @param next_index graph arc index
495 @param n_packets_left number of slots still available in vector
498 vlib_put_next_frame (vlib_main_t * vm,
499 vlib_node_runtime_t * r,
500 u32 next_index, u32 n_packets_left);
502 /* Combination get plus put. Returns vector argument just added. */
503 #define vlib_set_next_frame(vm,node,next_index,v) \
506 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
507 ASSERT (_n_left > 0); \
508 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
512 #define vlib_set_next_frame_with_aux_safe(vm, node, next_index, v, aux) \
515 vlib_get_next_frame_with_aux_safe ((vm), (node), (next_index), (v), \
517 ASSERT (_n_left > 0); \
518 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
523 vlib_set_next_frame_buffer (vlib_main_t * vm,
524 vlib_node_runtime_t * node,
525 u32 next_index, u32 buffer_index)
528 p = vlib_set_next_frame (vm, node, next_index, p);
533 vlib_set_next_frame_buffer_with_aux_safe (vlib_main_t *vm,
534 vlib_node_runtime_t *node,
535 u32 next_index, u32 buffer_index,
540 p = vlib_set_next_frame_with_aux_safe (vm, node, next_index, p, a);
546 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
547 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
551 vlib_in_process_context (vlib_main_t * vm)
553 return vm->node_main.current_process_index != ~0;
556 always_inline vlib_process_t *
557 vlib_get_current_process (vlib_main_t * vm)
559 vlib_node_main_t *nm = &vm->node_main;
560 if (vlib_in_process_context (vm))
561 return vec_elt (nm->processes, nm->current_process_index);
566 vlib_current_process (vlib_main_t * vm)
568 return vlib_get_current_process (vm)->node_runtime.node_index;
572 vlib_get_current_process_node_index (vlib_main_t * vm)
574 vlib_process_t *process = vlib_get_current_process (vm);
575 return process->node_runtime.node_index;
578 /** Returns TRUE if a process suspend time is less than 10us
579 @param dt - remaining poll time in seconds
580 @returns 1 if dt < 10e-6, 0 otherwise
583 vlib_process_suspend_time_is_zero (f64 dt)
588 /** Suspend a vlib cooperative multi-tasking thread for a period of time
589 @param vm - vlib_main_t *
590 @param dt - suspend interval in seconds
591 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
595 vlib_process_suspend (vlib_main_t * vm, f64 dt)
598 vlib_node_main_t *nm = &vm->node_main;
599 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
601 if (vlib_process_suspend_time_is_zero (dt))
602 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
604 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
605 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
606 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
608 /* expiration time in 10us ticks */
609 p->resume_clock_interval = dt * 1e5;
610 vlib_process_start_switch_stack (vm, 0);
611 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
614 vlib_process_finish_switch_stack (vm);
620 vlib_process_free_event_type (vlib_process_t * p, uword t,
621 uword is_one_time_event)
623 ASSERT (!pool_is_free_index (p->event_type_pool, t));
624 pool_put_index (p->event_type_pool, t);
625 if (is_one_time_event)
626 p->one_time_event_type_bitmap =
627 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
631 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
633 ASSERT (!pool_is_free_index (p->event_type_pool, t));
634 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
635 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
639 vlib_process_get_event_data (vlib_main_t * vm,
640 uword * return_event_type_opaque)
642 vlib_node_main_t *nm = &vm->node_main;
644 vlib_process_event_type_t *et;
646 void *event_data_vector;
648 p = vec_elt (nm->processes, nm->current_process_index);
650 /* Find first type with events ready.
651 Return invalid type when there's nothing there. */
652 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
656 p->non_empty_event_type_bitmap =
657 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
659 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
660 event_data_vector = p->pending_event_data_by_type_index[t];
661 p->pending_event_data_by_type_index[t] = 0;
663 et = pool_elt_at_index (p->event_type_pool, t);
665 /* Return user's opaque value and possibly index. */
666 *return_event_type_opaque = et->opaque;
668 vlib_process_maybe_free_event_type (p, t);
670 return event_data_vector;
673 /* Return event data vector for later reuse. We reuse event data to avoid
674 repeatedly allocating event vectors in cases where we care about speed. */
676 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
678 vlib_node_main_t *nm = &vm->node_main;
679 vec_add1 (nm->recycled_event_data_vectors, event_data);
682 /** Return the first event type which has occurred and a vector of per-event
683 data of that type, or a timeout indication
685 @param vm - vlib_main_t pointer
686 @param data_vector - pointer to a (uword *) vector to receive event data
687 @returns either an event type and a vector of per-event instance data,
688 or ~0 to indicate a timeout.
692 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
694 vlib_node_main_t *nm = &vm->node_main;
696 vlib_process_event_type_t *et;
699 p = vec_elt (nm->processes, nm->current_process_index);
701 /* Find first type with events ready.
702 Return invalid type when there's nothing there. */
703 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
707 p->non_empty_event_type_bitmap =
708 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
710 l = _vec_len (p->pending_event_data_by_type_index[t]);
712 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
713 vec_set_len (p->pending_event_data_by_type_index[t], 0);
715 et = pool_elt_at_index (p->event_type_pool, t);
717 /* Return user's opaque value. */
720 vlib_process_maybe_free_event_type (p, t);
726 vlib_process_get_events_helper (vlib_process_t * p, uword t,
727 uword ** data_vector)
731 p->non_empty_event_type_bitmap =
732 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
734 l = _vec_len (p->pending_event_data_by_type_index[t]);
736 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
737 vec_set_len (p->pending_event_data_by_type_index[t], 0);
739 vlib_process_maybe_free_event_type (p, t);
744 /* As above but query as specified type of event. Returns number of
747 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
748 uword with_type_opaque)
750 vlib_node_main_t *nm = &vm->node_main;
754 p = vec_elt (nm->processes, nm->current_process_index);
755 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
757 /* This can happen when an event has not yet been
758 signaled with given opaque type. */
762 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
765 return vlib_process_get_events_helper (p, t, data_vector);
768 always_inline uword *
769 vlib_process_wait_for_event (vlib_main_t * vm)
771 vlib_node_main_t *nm = &vm->node_main;
775 p = vec_elt (nm->processes, nm->current_process_index);
776 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
778 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
780 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
781 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
783 vlib_process_start_switch_stack (vm, 0);
784 clib_longjmp (&p->return_longjmp,
785 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
788 vlib_process_finish_switch_stack (vm);
791 return p->non_empty_event_type_bitmap;
795 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
796 uword ** data_vector,
797 uword with_type_index)
799 vlib_node_main_t *nm = &vm->node_main;
803 p = vec_elt (nm->processes, nm->current_process_index);
804 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
805 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
807 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
809 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
810 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
812 vlib_process_start_switch_stack (vm, 0);
813 clib_longjmp (&p->return_longjmp,
814 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
817 vlib_process_finish_switch_stack (vm);
820 return vlib_process_get_events_helper (p, with_type_index, data_vector);
824 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
825 uword ** data_vector,
826 uword with_type_opaque)
828 vlib_node_main_t *nm = &vm->node_main;
832 p = vec_elt (nm->processes, nm->current_process_index);
833 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
834 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
836 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
838 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
839 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
841 vlib_process_start_switch_stack (vm, 0);
842 clib_longjmp (&p->return_longjmp,
843 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
846 vlib_process_finish_switch_stack (vm);
848 /* See if unknown event type has been signaled now. */
850 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
853 return vlib_process_get_events_helper (p, h[0], data_vector);
856 /** Suspend a cooperative multi-tasking thread
857 Waits for an event, or for the indicated number of seconds to elapse
858 @param vm - vlib_main_t pointer
859 @param dt - timeout, in seconds.
860 @returns the remaining time interval
864 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
866 vlib_node_main_t *nm = &vm->node_main;
871 p = vec_elt (nm->processes, nm->current_process_index);
873 if (vlib_process_suspend_time_is_zero (dt)
874 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
877 wakeup_time = vlib_time_now (vm) + dt;
879 /* Suspend waiting for both clock and event to occur. */
880 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
881 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
883 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
884 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
886 p->resume_clock_interval = dt * 1e5;
887 vlib_process_start_switch_stack (vm, 0);
888 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
891 vlib_process_finish_switch_stack (vm);
893 /* Return amount of time still left to sleep.
894 If <= 0 then we've been waken up by the clock (and not an event). */
895 return wakeup_time - vlib_time_now (vm);
898 always_inline vlib_process_event_type_t *
899 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
901 vlib_process_event_type_t *et;
902 pool_get (p->event_type_pool, et);
903 et->opaque = with_type_opaque;
908 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
909 uword with_type_opaque)
911 vlib_node_main_t *nm = &vm->node_main;
912 vlib_node_t *n = vlib_get_node (vm, node_index);
913 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
914 vlib_process_event_type_t *et;
917 et = vlib_process_new_event_type (p, with_type_opaque);
918 t = et - p->event_type_pool;
919 p->one_time_event_type_bitmap =
920 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
925 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
928 vlib_node_main_t *nm = &vm->node_main;
929 vlib_node_t *n = vlib_get_node (vm, node_index);
930 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
932 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
933 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
937 vlib_process_signal_event_helper (vlib_node_main_t * nm,
941 uword n_data_elts, uword n_data_elt_bytes)
943 uword p_flags, add_to_pending, delete_from_wheel;
944 u8 *data_to_be_written_by_caller;
945 vec_attr_t va = { .elt_sz = n_data_elt_bytes };
947 ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
949 ASSERT (!pool_is_free_index (p->event_type_pool, t));
951 vec_validate (p->pending_event_data_by_type_index, t);
953 /* Resize data vector and return caller's data to be written. */
955 u8 *data_vec = p->pending_event_data_by_type_index[t];
958 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
960 data_vec = vec_pop (nm->recycled_event_data_vectors);
961 vec_reset_length (data_vec);
964 l = vec_len (data_vec);
966 data_vec = _vec_realloc_internal (data_vec, l + n_data_elts, &va);
968 p->pending_event_data_by_type_index[t] = data_vec;
969 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
972 p->non_empty_event_type_bitmap =
973 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
977 /* Event was already signalled? */
978 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
980 /* Process will resume when suspend time elapses? */
981 delete_from_wheel = 0;
982 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
984 /* Waiting for both event and clock? */
985 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
987 if (!TW (tw_timer_handle_is_free)
988 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
989 p->stop_timer_handle))
990 delete_from_wheel = 1;
992 /* timer just popped so process should already be on the list */
996 /* Waiting only for clock. Event will be queue and may be
997 handled when timer expires. */
1001 /* Never add current process to pending vector since current process is
1003 add_to_pending &= nm->current_process_index != n->runtime_index;
1007 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
1008 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
1009 vec_add1 (nm->data_from_advancing_timing_wheel, x);
1010 if (delete_from_wheel)
1013 ((TWT (tw_timer_wheel) *) nm->timing_wheel, p->stop_timer_handle);
1014 p->stop_timer_handle = ~0;
1018 return data_to_be_written_by_caller;
1021 always_inline void *
1022 vlib_process_signal_event_data (vlib_main_t * vm,
1025 uword n_data_elts, uword n_data_elt_bytes)
1027 vlib_node_main_t *nm = &vm->node_main;
1028 vlib_node_t *n = vlib_get_node (vm, node_index);
1029 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1032 /* Must be in main thread */
1033 ASSERT (vlib_get_thread_index () == 0);
1035 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
1038 vlib_process_event_type_t *et =
1039 vlib_process_new_event_type (p, type_opaque);
1040 t = et - p->event_type_pool;
1041 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1046 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1050 always_inline void *
1051 vlib_process_signal_event_at_time (vlib_main_t * vm,
1055 uword n_data_elts, uword n_data_elt_bytes)
1057 vlib_node_main_t *nm = &vm->node_main;
1058 vlib_node_t *n = vlib_get_node (vm, node_index);
1059 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1062 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
1065 vlib_process_event_type_t *et =
1066 vlib_process_new_event_type (p, type_opaque);
1067 t = et - p->event_type_pool;
1068 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1073 if (vlib_process_suspend_time_is_zero (dt))
1074 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1078 vlib_signal_timed_event_data_t *te;
1080 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
1082 te->n_data_elts = n_data_elts;
1083 te->n_data_elt_bytes = n_data_elt_bytes;
1084 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
1086 /* Assert that structure fields are big enough. */
1087 ASSERT (te->n_data_elts == n_data_elts);
1088 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
1089 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
1091 te->process_node_index = n->runtime_index;
1092 te->event_type_index = t;
1094 p->stop_timer_handle =
1095 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1096 vlib_timing_wheel_data_set_timed_event
1097 (te - nm->signal_timed_event_data_pool),
1099 (vlib_time_now (vm) + dt) * 1e5);
1101 /* Inline data big enough to hold event? */
1102 if (te->n_data_bytes < sizeof (te->inline_event_data))
1103 return te->inline_event_data;
1106 te->event_data_as_vector = 0;
1107 vec_resize (te->event_data_as_vector, te->n_data_bytes);
1108 return te->event_data_as_vector;
1113 always_inline void *
1114 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
1118 uword n_data_elt_bytes)
1120 vlib_node_main_t *nm = &vm->node_main;
1121 vlib_node_t *n = vlib_get_node (vm, node_index);
1122 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1123 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
1128 vlib_process_signal_event (vlib_main_t * vm,
1129 uword node_index, uword type_opaque, uword data)
1131 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1132 1 /* elts */ , sizeof (uword));
1137 vlib_process_signal_event_pointer (vlib_main_t * vm,
1139 uword type_opaque, void *data)
1141 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1142 1 /* elts */ , sizeof (data));
1147 * Signal event to process from any thread.
1149 * When in doubt, use this.
1152 vlib_process_signal_event_mt (vlib_main_t * vm,
1153 uword node_index, uword type_opaque, uword data)
1155 if (vlib_get_thread_index () != 0)
1157 vlib_process_signal_event_mt_args_t args = {
1158 .node_index = node_index,
1159 .type_opaque = type_opaque,
1162 vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
1163 (u8 *) & args, sizeof (args));
1166 vlib_process_signal_event (vm, node_index, type_opaque, data);
1170 vlib_process_signal_one_time_event (vlib_main_t * vm,
1172 uword type_index, uword data)
1175 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1176 1 /* elts */ , sizeof (uword));
1181 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1182 vlib_one_time_waiting_process_t * p)
1184 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1186 clib_memset (p, ~0, sizeof (p[0]));
1190 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1191 vlib_one_time_waiting_process_t
1194 vlib_one_time_waiting_process_t *wp;
1195 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1200 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1201 vlib_one_time_waiting_process_t
1204 p->node_index = vlib_current_process (vm);
1205 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1207 vlib_process_wait_for_one_time_event (vm,
1208 /* don't care about data */ 0,
1213 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1214 vlib_one_time_waiting_process_t
1217 vlib_one_time_waiting_process_t *wp;
1218 vec_add2 (*wps, wp, 1);
1219 vlib_current_process_wait_for_one_time_event (vm, wp);
1223 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1224 vlib_node_runtime_t * node,
1230 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1231 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1232 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1235 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1237 (node->main_loop_count_last_dispatch >>
1238 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1239 vi0 = node->main_loop_vector_stats[i0];
1240 vi1 = node->main_loop_vector_stats[i1];
1241 vi0 = d == 0 ? vi0 : 0;
1242 vi1 = d <= 1 ? vi1 : 0;
1244 node->main_loop_vector_stats[i0] = vi0;
1245 node->main_loop_vector_stats[i1] = vi1;
1246 node->main_loop_count_last_dispatch = vm->main_loop_count;
1247 /* Return previous counter. */
1248 return node->main_loop_vector_stats[i1];
1252 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1254 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1257 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1259 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1263 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1265 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1268 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1270 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1273 void vlib_frame_free (vlib_main_t *vm, vlib_frame_t *f);
1275 /* Return the edge index if present, ~0 otherwise */
1276 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1278 /* Add next node to given node in given slot. */
1280 vlib_node_add_next_with_slot (vlib_main_t * vm,
1281 uword node, uword next_node, uword slot);
1283 /* As above but adds to end of node's next vector. */
1285 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1287 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1290 /* Add next node to given node in given slot. */
1292 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1293 uword node, char *next_name, uword slot);
1295 /* As above but adds to end of node's next vector. */
1297 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1299 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1306 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1307 int barrier_sync, vlib_node_t **** node_dupsp,
1308 vlib_main_t *** stat_vmsp);
1310 /* Query node given name. */
1311 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1313 /* Rename a node. */
1314 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1316 /* Register new packet processing node. Nodes can be registered
1317 dynamically via this call or statically via the VLIB_REGISTER_NODE
1319 u32 vlib_register_node (vlib_main_t *vm, vlib_node_registration_t *r,
1322 /* Register all node function variants */
1323 void vlib_register_all_node_march_variants (vlib_main_t *vm);
1325 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1326 void vlib_register_all_static_nodes (vlib_main_t * vm);
1328 /* Start a process. */
1329 void vlib_start_process (vlib_main_t * vm, uword process_index);
1331 /* Sync up runtime and main node stats. */
1332 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1333 void vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
1334 uword n_calls, uword n_vectors,
1336 void vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
1337 uword n_calls, uword n_vectors,
1340 /* Node graph initialization function. */
1341 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1343 format_function_t format_vlib_node_graph;
1344 format_function_t format_vlib_node_name;
1345 format_function_t format_vlib_next_node_name;
1346 format_function_t format_vlib_node_and_next;
1347 format_function_t format_vlib_cpu_time;
1348 format_function_t format_vlib_time;
1349 /* Parse node name -> node index. */
1350 unformat_function_t unformat_vlib_node;
1353 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1354 u32 counter_index, u64 increment)
1356 vlib_node_t *n = vlib_get_node (vm, node_index);
1357 vlib_error_main_t *em = &vm->error_main;
1358 u32 node_counter_base_index = n->error_heap_index;
1359 em->counters[node_counter_base_index + counter_index] += increment;
1362 /** @brief Create a vlib process
1363 * @param vm &vlib_global_main
1364 * @param f the process node function
1365 * @param log2_n_stack_bytes size of the process stack, defaults to 16K
1366 * @return newly-create node index
1367 * @warning call only on the main thread. Barrier sync required
1369 u32 vlib_process_create (vlib_main_t * vm, char *name,
1370 vlib_node_function_t * f, u32 log2_n_stack_bytes);
1373 vlib_node_set_dispatch_wrapper (vlib_main_t *vm, vlib_node_function_t *fn)
1375 if (fn && vm->dispatch_wrapper_fn)
1377 vm->dispatch_wrapper_fn = fn;
1381 int vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
1382 clib_march_variant_type_t march_variant);
1384 vlib_node_function_t *
1385 vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
1386 vlib_node_fn_registration_t *regs);
1389 * vlib_frame_bitmap functions
1392 #define VLIB_FRAME_BITMAP_N_UWORDS \
1393 (((VLIB_FRAME_SIZE + uword_bits - 1) & ~(uword_bits - 1)) / uword_bits)
1395 typedef uword vlib_frame_bitmap_t[VLIB_FRAME_BITMAP_N_UWORDS];
1397 static_always_inline void
1398 vlib_frame_bitmap_init (uword *bmp, u32 n_first_bits_set)
1400 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1401 while (n_first_bits_set >= (sizeof (uword) * 8) && n_left)
1404 n_first_bits_set -= sizeof (uword) * 8;
1408 if (n_first_bits_set && n_left)
1410 bmp++[0] = pow2_mask (n_first_bits_set);
1418 static_always_inline void
1419 vlib_frame_bitmap_set_bit_at_index (uword *bmp, uword bit_index)
1421 uword_bitmap_set_bits_at_index (bmp, bit_index, 1);
1424 static_always_inline void
1425 _vlib_frame_bitmap_clear_bit_at_index (uword *bmp, uword bit_index)
1427 uword_bitmap_clear_bits_at_index (bmp, bit_index, 1);
1430 static_always_inline void
1431 vlib_frame_bitmap_set_bits_at_index (uword *bmp, uword bit_index, uword n_bits)
1433 uword_bitmap_set_bits_at_index (bmp, bit_index, n_bits);
1436 static_always_inline void
1437 vlib_frame_bitmap_clear_bits_at_index (uword *bmp, uword bit_index,
1440 uword_bitmap_clear_bits_at_index (bmp, bit_index, n_bits);
1443 static_always_inline void
1444 vlib_frame_bitmap_clear (uword *bmp)
1446 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1451 static_always_inline void
1452 vlib_frame_bitmap_xor (uword *bmp, uword *bmp2)
1454 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1456 bmp++[0] ^= bmp2++[0];
1459 static_always_inline void
1460 vlib_frame_bitmap_or (uword *bmp, uword *bmp2)
1462 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1464 bmp++[0] |= bmp2++[0];
1467 static_always_inline void
1468 vlib_frame_bitmap_and (uword *bmp, uword *bmp2)
1470 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1472 bmp++[0] &= bmp2++[0];
1475 static_always_inline uword
1476 vlib_frame_bitmap_count_set_bits (uword *bmp)
1478 return uword_bitmap_count_set_bits (bmp, VLIB_FRAME_BITMAP_N_UWORDS);
1481 static_always_inline uword
1482 vlib_frame_bitmap_is_bit_set (uword *bmp, uword bit_index)
1484 return uword_bitmap_is_bit_set (bmp, bit_index);
1487 static_always_inline uword
1488 vlib_frame_bitmap_find_first_set (uword *bmp)
1490 uword rv = uword_bitmap_find_first_set (bmp);
1491 ASSERT (rv < VLIB_FRAME_BITMAP_N_UWORDS * uword_bits);
1495 #define foreach_vlib_frame_bitmap_set_bit_index(i, v) \
1496 for (uword _off = 0; _off < ARRAY_LEN (v); _off++) \
1498 (v[_off]) + 0 * (uword) (i = _off * uword_bits + \
1499 get_lowest_set_bit_index (v[_off])); \
1500 _tmp; i = _off * uword_bits + get_lowest_set_bit_index ( \
1501 _tmp = clear_lowest_set_bit (_tmp)))
1503 #endif /* included_vlib_node_funcs_h */
1506 * fd.io coding-style-patch-verification: ON
1509 * eval: (c-set-style "gnu")