2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * node_funcs.h: processing nodes global functions/inlines
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
45 #ifndef included_vlib_node_funcs_h
46 #define included_vlib_node_funcs_h
48 #include <vppinfra/fifo.h>
49 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
50 #include <vppinfra/interrupt.h>
52 #ifdef CLIB_SANITIZE_ADDR
53 #include <sanitizer/asan_interface.h>
56 static_always_inline void
57 vlib_process_start_switch_stack (vlib_main_t * vm, vlib_process_t * p)
59 #ifdef CLIB_SANITIZE_ADDR
60 void *stack = p ? (void *) p->stack : vlib_thread_stacks[vm->thread_index];
61 u32 stack_bytes = p ? p->log2_n_stack_bytes : VLIB_THREAD_STACK_SIZE;
62 __sanitizer_start_switch_fiber (&vm->asan_stack_save, stack, stack_bytes);
66 static_always_inline void
67 vlib_process_finish_switch_stack (vlib_main_t * vm)
69 #ifdef CLIB_SANITIZE_ADDR
70 const void *bottom_old;
73 __sanitizer_finish_switch_fiber (&vm->asan_stack_save, &bottom_old,
78 /** \brief Get vlib node by index.
79 @warning This function will ASSERT if @c i is out of range.
80 @param vm vlib_main_t pointer, varies by thread
82 @return pointer to the requested vlib_node_t.
85 always_inline vlib_node_t *
86 vlib_get_node (vlib_main_t * vm, u32 i)
88 return vec_elt (vm->node_main.nodes, i);
91 /** \brief Get vlib node by graph arc (next) index.
92 @param vm vlib_main_t pointer, varies by thread
93 @param node_index index of original node
94 @param next_index graph arc index
95 @return pointer to the vlib_node_t at the end of the indicated arc
98 always_inline vlib_node_t *
99 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
101 vlib_node_main_t *nm = &vm->node_main;
104 n = vec_elt (nm->nodes, node_index);
105 ASSERT (next_index < vec_len (n->next_nodes));
106 return vlib_get_node (vm, n->next_nodes[next_index]);
109 /** \brief Get node runtime by node index.
110 @param vm vlib_main_t pointer, varies by thread
111 @param node_index index of node
112 @return pointer to the indicated vlib_node_runtime_t
115 always_inline vlib_node_runtime_t *
116 vlib_node_get_runtime (vlib_main_t * vm, u32 node_index)
118 vlib_node_main_t *nm = &vm->node_main;
119 vlib_node_t *n = vec_elt (nm->nodes, node_index);
121 if (n->type != VLIB_NODE_TYPE_PROCESS)
122 return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
125 p = vec_elt (nm->processes, n->runtime_index);
126 return &p->node_runtime;
130 /** \brief Get node runtime private data by node index.
131 @param vm vlib_main_t pointer, varies by thread
132 @param node_index index of the node
133 @return pointer to the indicated vlib_node_runtime_t private data
137 vlib_node_get_runtime_data (vlib_main_t * vm, u32 node_index)
139 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
140 return r->runtime_data;
143 /** \brief Set node runtime private data.
144 @param vm vlib_main_t pointer, varies by thread
145 @param node_index index of the node
146 @param runtime_data arbitrary runtime private data
147 @param n_runtime_data_bytes size of runtime private data
151 vlib_node_set_runtime_data (vlib_main_t * vm, u32 node_index,
152 void *runtime_data, u32 n_runtime_data_bytes)
154 vlib_node_t *n = vlib_get_node (vm, node_index);
155 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
157 n->runtime_data_bytes = n_runtime_data_bytes;
158 vec_free (n->runtime_data);
159 vec_add (n->runtime_data, runtime_data, n_runtime_data_bytes);
161 ASSERT (vec_len (n->runtime_data) <= sizeof (vlib_node_runtime_t) -
162 STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
164 if (vec_len (n->runtime_data) > 0)
165 clib_memcpy_fast (r->runtime_data, n->runtime_data,
166 vec_len (n->runtime_data));
169 /** \brief Set node dispatch state.
170 @param vm vlib_main_t pointer, varies by thread
171 @param node_index index of the node
172 @param new_state new state for node, see vlib_node_state_t
175 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
176 vlib_node_state_t new_state)
178 vlib_node_main_t *nm = &vm->node_main;
180 vlib_node_runtime_t *r;
182 n = vec_elt (nm->nodes, node_index);
183 if (n->type == VLIB_NODE_TYPE_PROCESS)
185 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
186 r = &p->node_runtime;
188 /* When disabling make sure flags are cleared. */
189 p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
190 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
191 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
194 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
196 ASSERT (new_state < VLIB_N_NODE_STATE);
198 if (n->type == VLIB_NODE_TYPE_INPUT)
200 ASSERT (nm->input_node_counts_by_state[n->state] > 0);
201 nm->input_node_counts_by_state[n->state] -= 1;
202 nm->input_node_counts_by_state[new_state] += 1;
205 if (PREDICT_FALSE (r->state == VLIB_NODE_STATE_DISABLED))
206 vlib_node_runtime_perf_counter (vm, r, 0, 0, 0,
207 VLIB_NODE_RUNTIME_PERF_RESET);
209 n->state = new_state;
210 r->state = new_state;
213 /** \brief Get node dispatch state.
214 @param vm vlib_main_t pointer, varies by thread
215 @param node_index index of the node
216 @return state for node, see vlib_node_state_t
218 always_inline vlib_node_state_t
219 vlib_node_get_state (vlib_main_t * vm, u32 node_index)
221 vlib_node_main_t *nm = &vm->node_main;
223 n = vec_elt (nm->nodes, node_index);
228 vlib_node_set_flag (vlib_main_t *vm, u32 node_index, u16 flag, u8 enable)
230 vlib_node_runtime_t *r;
233 n = vlib_get_node (vm, node_index);
234 r = vlib_node_get_runtime (vm, node_index);
249 vlib_node_set_interrupt_pending (vlib_main_t *vm, u32 node_index)
251 vlib_node_main_t *nm = &vm->node_main;
252 vlib_node_t *n = vec_elt (nm->nodes, node_index);
254 ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
256 if (vm != vlib_get_main ())
257 clib_interrupt_set_atomic (nm->interrupts, n->runtime_index);
259 clib_interrupt_set (nm->interrupts, n->runtime_index);
261 __atomic_store_n (nm->pending_interrupts, 1, __ATOMIC_RELEASE);
264 always_inline vlib_process_t *
265 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
267 vlib_node_main_t *nm = &vm->node_main;
268 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
269 return vec_elt (nm->processes, node->runtime_index);
272 always_inline vlib_frame_t *
273 vlib_get_frame (vlib_main_t * vm, vlib_frame_t * f)
276 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
281 vlib_frame_no_append (vlib_frame_t * f)
283 f->frame_flags |= VLIB_FRAME_NO_APPEND;
286 /** \brief Get pointer to frame vector data.
287 @param f vlib_frame_t pointer
288 @return pointer to first vector element in frame
291 vlib_frame_vector_args (vlib_frame_t * f)
293 ASSERT (f->vector_offset);
294 return (void *) f + f->vector_offset;
297 /** \brief Get pointer to frame vector aux data.
298 @param f vlib_frame_t pointer
299 @return pointer to first vector aux data element in frame
302 vlib_frame_aux_args (vlib_frame_t *f)
304 ASSERT (f->aux_offset);
305 return (void *) f + f->aux_offset;
308 /** \brief Get pointer to frame scalar data.
310 @param f vlib_frame_t pointer
312 @return arbitrary node scalar data
314 @sa vlib_frame_vector_args
317 vlib_frame_scalar_args (vlib_frame_t * f)
319 ASSERT (f->scalar_offset);
320 return (void *) f + f->scalar_offset;
323 always_inline vlib_next_frame_t *
324 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
325 vlib_node_runtime_t * n, u32 next_index)
327 vlib_node_main_t *nm = &vm->node_main;
328 vlib_next_frame_t *nf;
330 ASSERT (next_index < n->n_next_nodes);
331 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
335 vlib_node_t *node, *next;
336 node = vec_elt (nm->nodes, n->node_index);
337 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
338 ASSERT (nf->node_runtime_index == next->runtime_index);
344 /** \brief Get pointer to frame by (@c node_index, @c next_index).
346 @warning This is not a function that you should call directly.
347 See @ref vlib_get_next_frame instead.
349 @param vm vlib_main_t pointer, varies by thread
350 @param node_index index of the node
351 @param next_index graph arc index
353 @return pointer to the requested vlib_next_frame_t
355 @sa vlib_get_next_frame
358 always_inline vlib_next_frame_t *
359 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
361 vlib_node_main_t *nm = &vm->node_main;
363 vlib_node_runtime_t *r;
365 n = vec_elt (nm->nodes, node_index);
366 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
367 return vlib_node_runtime_get_next_frame (vm, r, next_index);
370 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
371 vlib_node_runtime_t * node,
373 u32 alloc_new_frame);
375 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
378 = vlib_get_next_frame_internal ((vm), (node), (next_index), \
379 (alloc_new_frame)); \
380 u32 _n = _f->n_vectors; \
381 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
382 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
386 /** \brief Get pointer to next frame vector data by
387 (@c vlib_node_runtime_t, @c next_index).
388 Standard single/dual loop boilerplate element.
389 @attention This is a MACRO, with SIDE EFFECTS.
391 @param vm vlib_main_t pointer, varies by thread
392 @param node current node vlib_node_runtime_t pointer
393 @param next_index requested graph arc index
395 @return @c vectors -- pointer to next available vector slot
396 @return @c n_vectors_left -- number of vector slots available
398 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left) \
399 vlib_get_next_frame_macro (vm, node, next_index, \
400 vectors, n_vectors_left, \
401 /* alloc new frame */ 0)
403 #define vlib_get_new_next_frame(vm,node,next_index,vectors,n_vectors_left) \
404 vlib_get_next_frame_macro (vm, node, next_index, \
405 vectors, n_vectors_left, \
406 /* alloc new frame */ 1)
408 /** \brief Release pointer to next frame vector data.
409 Standard single/dual loop boilerplate element.
410 @param vm vlib_main_t pointer, varies by thread
411 @param r current node vlib_node_runtime_t pointer
412 @param next_index graph arc index
413 @param n_packets_left number of slots still available in vector
416 vlib_put_next_frame (vlib_main_t * vm,
417 vlib_node_runtime_t * r,
418 u32 next_index, u32 n_packets_left);
420 /* Combination get plus put. Returns vector argument just added. */
421 #define vlib_set_next_frame(vm,node,next_index,v) \
424 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
425 ASSERT (_n_left > 0); \
426 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
431 vlib_set_next_frame_buffer (vlib_main_t * vm,
432 vlib_node_runtime_t * node,
433 u32 next_index, u32 buffer_index)
436 p = vlib_set_next_frame (vm, node, next_index, p);
440 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
441 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
445 vlib_in_process_context (vlib_main_t * vm)
447 return vm->node_main.current_process_index != ~0;
450 always_inline vlib_process_t *
451 vlib_get_current_process (vlib_main_t * vm)
453 vlib_node_main_t *nm = &vm->node_main;
454 if (vlib_in_process_context (vm))
455 return vec_elt (nm->processes, nm->current_process_index);
460 vlib_current_process (vlib_main_t * vm)
462 return vlib_get_current_process (vm)->node_runtime.node_index;
466 vlib_get_current_process_node_index (vlib_main_t * vm)
468 vlib_process_t *process = vlib_get_current_process (vm);
469 return process->node_runtime.node_index;
472 /** Returns TRUE if a process suspend time is less than 10us
473 @param dt - remaining poll time in seconds
474 @returns 1 if dt < 10e-6, 0 otherwise
477 vlib_process_suspend_time_is_zero (f64 dt)
482 /** Suspend a vlib cooperative multi-tasking thread for a period of time
483 @param vm - vlib_main_t *
484 @param dt - suspend interval in seconds
485 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
489 vlib_process_suspend (vlib_main_t * vm, f64 dt)
492 vlib_node_main_t *nm = &vm->node_main;
493 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
495 if (vlib_process_suspend_time_is_zero (dt))
496 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
498 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
499 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
500 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
502 /* expiration time in 10us ticks */
503 p->resume_clock_interval = dt * 1e5;
504 vlib_process_start_switch_stack (vm, 0);
505 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
508 vlib_process_finish_switch_stack (vm);
514 vlib_process_free_event_type (vlib_process_t * p, uword t,
515 uword is_one_time_event)
517 ASSERT (!pool_is_free_index (p->event_type_pool, t));
518 pool_put_index (p->event_type_pool, t);
519 if (is_one_time_event)
520 p->one_time_event_type_bitmap =
521 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
525 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
527 ASSERT (!pool_is_free_index (p->event_type_pool, t));
528 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
529 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
533 vlib_process_get_event_data (vlib_main_t * vm,
534 uword * return_event_type_opaque)
536 vlib_node_main_t *nm = &vm->node_main;
538 vlib_process_event_type_t *et;
540 void *event_data_vector;
542 p = vec_elt (nm->processes, nm->current_process_index);
544 /* Find first type with events ready.
545 Return invalid type when there's nothing there. */
546 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
550 p->non_empty_event_type_bitmap =
551 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
553 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
554 event_data_vector = p->pending_event_data_by_type_index[t];
555 p->pending_event_data_by_type_index[t] = 0;
557 et = pool_elt_at_index (p->event_type_pool, t);
559 /* Return user's opaque value and possibly index. */
560 *return_event_type_opaque = et->opaque;
562 vlib_process_maybe_free_event_type (p, t);
564 return event_data_vector;
567 /* Return event data vector for later reuse. We reuse event data to avoid
568 repeatedly allocating event vectors in cases where we care about speed. */
570 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
572 vlib_node_main_t *nm = &vm->node_main;
573 vec_add1 (nm->recycled_event_data_vectors, event_data);
576 /** Return the first event type which has occurred and a vector of per-event
577 data of that type, or a timeout indication
579 @param vm - vlib_main_t pointer
580 @param data_vector - pointer to a (uword *) vector to receive event data
581 @returns either an event type and a vector of per-event instance data,
582 or ~0 to indicate a timeout.
586 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
588 vlib_node_main_t *nm = &vm->node_main;
590 vlib_process_event_type_t *et;
593 p = vec_elt (nm->processes, nm->current_process_index);
595 /* Find first type with events ready.
596 Return invalid type when there's nothing there. */
597 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
601 p->non_empty_event_type_bitmap =
602 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
604 l = _vec_len (p->pending_event_data_by_type_index[t]);
606 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
607 vec_set_len (p->pending_event_data_by_type_index[t], 0);
609 et = pool_elt_at_index (p->event_type_pool, t);
611 /* Return user's opaque value. */
614 vlib_process_maybe_free_event_type (p, t);
620 vlib_process_get_events_helper (vlib_process_t * p, uword t,
621 uword ** data_vector)
625 p->non_empty_event_type_bitmap =
626 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
628 l = _vec_len (p->pending_event_data_by_type_index[t]);
630 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
631 vec_set_len (p->pending_event_data_by_type_index[t], 0);
633 vlib_process_maybe_free_event_type (p, t);
638 /* As above but query as specified type of event. Returns number of
641 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
642 uword with_type_opaque)
644 vlib_node_main_t *nm = &vm->node_main;
648 p = vec_elt (nm->processes, nm->current_process_index);
649 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
651 /* This can happen when an event has not yet been
652 signaled with given opaque type. */
656 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
659 return vlib_process_get_events_helper (p, t, data_vector);
662 always_inline uword *
663 vlib_process_wait_for_event (vlib_main_t * vm)
665 vlib_node_main_t *nm = &vm->node_main;
669 p = vec_elt (nm->processes, nm->current_process_index);
670 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
672 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
674 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
675 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
677 vlib_process_start_switch_stack (vm, 0);
678 clib_longjmp (&p->return_longjmp,
679 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
682 vlib_process_finish_switch_stack (vm);
685 return p->non_empty_event_type_bitmap;
689 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
690 uword ** data_vector,
691 uword with_type_index)
693 vlib_node_main_t *nm = &vm->node_main;
697 p = vec_elt (nm->processes, nm->current_process_index);
698 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
699 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
701 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
703 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
704 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
706 vlib_process_start_switch_stack (vm, 0);
707 clib_longjmp (&p->return_longjmp,
708 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
711 vlib_process_finish_switch_stack (vm);
714 return vlib_process_get_events_helper (p, with_type_index, data_vector);
718 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
719 uword ** data_vector,
720 uword with_type_opaque)
722 vlib_node_main_t *nm = &vm->node_main;
726 p = vec_elt (nm->processes, nm->current_process_index);
727 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
728 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
730 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
732 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
733 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
735 vlib_process_start_switch_stack (vm, 0);
736 clib_longjmp (&p->return_longjmp,
737 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
740 vlib_process_finish_switch_stack (vm);
742 /* See if unknown event type has been signaled now. */
744 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
747 return vlib_process_get_events_helper (p, h[0], data_vector);
750 /** Suspend a cooperative multi-tasking thread
751 Waits for an event, or for the indicated number of seconds to elapse
752 @param vm - vlib_main_t pointer
753 @param dt - timeout, in seconds.
754 @returns the remaining time interval
758 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
760 vlib_node_main_t *nm = &vm->node_main;
765 p = vec_elt (nm->processes, nm->current_process_index);
767 if (vlib_process_suspend_time_is_zero (dt)
768 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
771 wakeup_time = vlib_time_now (vm) + dt;
773 /* Suspend waiting for both clock and event to occur. */
774 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
775 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
777 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
778 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
780 p->resume_clock_interval = dt * 1e5;
781 vlib_process_start_switch_stack (vm, 0);
782 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
785 vlib_process_finish_switch_stack (vm);
787 /* Return amount of time still left to sleep.
788 If <= 0 then we've been waken up by the clock (and not an event). */
789 return wakeup_time - vlib_time_now (vm);
792 always_inline vlib_process_event_type_t *
793 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
795 vlib_process_event_type_t *et;
796 pool_get (p->event_type_pool, et);
797 et->opaque = with_type_opaque;
802 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
803 uword with_type_opaque)
805 vlib_node_main_t *nm = &vm->node_main;
806 vlib_node_t *n = vlib_get_node (vm, node_index);
807 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
808 vlib_process_event_type_t *et;
811 et = vlib_process_new_event_type (p, with_type_opaque);
812 t = et - p->event_type_pool;
813 p->one_time_event_type_bitmap =
814 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
819 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
822 vlib_node_main_t *nm = &vm->node_main;
823 vlib_node_t *n = vlib_get_node (vm, node_index);
824 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
826 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
827 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
831 vlib_process_signal_event_helper (vlib_node_main_t * nm,
835 uword n_data_elts, uword n_data_elt_bytes)
837 uword p_flags, add_to_pending, delete_from_wheel;
838 u8 *data_to_be_written_by_caller;
839 vec_attr_t va = { .elt_sz = n_data_elt_bytes };
841 ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
843 ASSERT (!pool_is_free_index (p->event_type_pool, t));
845 vec_validate (p->pending_event_data_by_type_index, t);
847 /* Resize data vector and return caller's data to be written. */
849 u8 *data_vec = p->pending_event_data_by_type_index[t];
852 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
854 data_vec = vec_pop (nm->recycled_event_data_vectors);
855 vec_reset_length (data_vec);
858 l = vec_len (data_vec);
860 data_vec = _vec_realloc_internal (data_vec, l + n_data_elts, &va);
862 p->pending_event_data_by_type_index[t] = data_vec;
863 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
866 p->non_empty_event_type_bitmap =
867 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
871 /* Event was already signalled? */
872 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
874 /* Process will resume when suspend time elapses? */
875 delete_from_wheel = 0;
876 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
878 /* Waiting for both event and clock? */
879 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
881 if (!TW (tw_timer_handle_is_free)
882 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
883 p->stop_timer_handle))
884 delete_from_wheel = 1;
886 /* timer just popped so process should already be on the list */
890 /* Waiting only for clock. Event will be queue and may be
891 handled when timer expires. */
895 /* Never add current process to pending vector since current process is
897 add_to_pending &= nm->current_process_index != n->runtime_index;
901 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
902 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
903 vec_add1 (nm->data_from_advancing_timing_wheel, x);
904 if (delete_from_wheel)
905 TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
906 p->stop_timer_handle);
909 return data_to_be_written_by_caller;
913 vlib_process_signal_event_data (vlib_main_t * vm,
916 uword n_data_elts, uword n_data_elt_bytes)
918 vlib_node_main_t *nm = &vm->node_main;
919 vlib_node_t *n = vlib_get_node (vm, node_index);
920 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
923 /* Must be in main thread */
924 ASSERT (vlib_get_thread_index () == 0);
926 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
929 vlib_process_event_type_t *et =
930 vlib_process_new_event_type (p, type_opaque);
931 t = et - p->event_type_pool;
932 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
937 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
942 vlib_process_signal_event_at_time (vlib_main_t * vm,
946 uword n_data_elts, uword n_data_elt_bytes)
948 vlib_node_main_t *nm = &vm->node_main;
949 vlib_node_t *n = vlib_get_node (vm, node_index);
950 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
953 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
956 vlib_process_event_type_t *et =
957 vlib_process_new_event_type (p, type_opaque);
958 t = et - p->event_type_pool;
959 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
964 if (vlib_process_suspend_time_is_zero (dt))
965 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
969 vlib_signal_timed_event_data_t *te;
971 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
973 te->n_data_elts = n_data_elts;
974 te->n_data_elt_bytes = n_data_elt_bytes;
975 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
977 /* Assert that structure fields are big enough. */
978 ASSERT (te->n_data_elts == n_data_elts);
979 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
980 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
982 te->process_node_index = n->runtime_index;
983 te->event_type_index = t;
985 p->stop_timer_handle =
986 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
987 vlib_timing_wheel_data_set_timed_event
988 (te - nm->signal_timed_event_data_pool),
990 (vlib_time_now (vm) + dt) * 1e5);
992 /* Inline data big enough to hold event? */
993 if (te->n_data_bytes < sizeof (te->inline_event_data))
994 return te->inline_event_data;
997 te->event_data_as_vector = 0;
998 vec_resize (te->event_data_as_vector, te->n_data_bytes);
999 return te->event_data_as_vector;
1004 always_inline void *
1005 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
1009 uword n_data_elt_bytes)
1011 vlib_node_main_t *nm = &vm->node_main;
1012 vlib_node_t *n = vlib_get_node (vm, node_index);
1013 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1014 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
1019 vlib_process_signal_event (vlib_main_t * vm,
1020 uword node_index, uword type_opaque, uword data)
1022 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1023 1 /* elts */ , sizeof (uword));
1028 vlib_process_signal_event_pointer (vlib_main_t * vm,
1030 uword type_opaque, void *data)
1032 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1033 1 /* elts */ , sizeof (data));
1038 * Signal event to process from any thread.
1040 * When in doubt, use this.
1043 vlib_process_signal_event_mt (vlib_main_t * vm,
1044 uword node_index, uword type_opaque, uword data)
1046 if (vlib_get_thread_index () != 0)
1048 vlib_process_signal_event_mt_args_t args = {
1049 .node_index = node_index,
1050 .type_opaque = type_opaque,
1053 vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
1054 (u8 *) & args, sizeof (args));
1057 vlib_process_signal_event (vm, node_index, type_opaque, data);
1061 vlib_process_signal_one_time_event (vlib_main_t * vm,
1063 uword type_index, uword data)
1066 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1067 1 /* elts */ , sizeof (uword));
1072 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1073 vlib_one_time_waiting_process_t * p)
1075 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1077 clib_memset (p, ~0, sizeof (p[0]));
1081 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1082 vlib_one_time_waiting_process_t
1085 vlib_one_time_waiting_process_t *wp;
1086 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1091 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1092 vlib_one_time_waiting_process_t
1095 p->node_index = vlib_current_process (vm);
1096 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1098 vlib_process_wait_for_one_time_event (vm,
1099 /* don't care about data */ 0,
1104 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1105 vlib_one_time_waiting_process_t
1108 vlib_one_time_waiting_process_t *wp;
1109 vec_add2 (*wps, wp, 1);
1110 vlib_current_process_wait_for_one_time_event (vm, wp);
1114 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1115 vlib_node_runtime_t * node,
1121 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1122 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1123 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1126 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1128 (node->main_loop_count_last_dispatch >>
1129 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1130 vi0 = node->main_loop_vector_stats[i0];
1131 vi1 = node->main_loop_vector_stats[i1];
1132 vi0 = d == 0 ? vi0 : 0;
1133 vi1 = d <= 1 ? vi1 : 0;
1135 node->main_loop_vector_stats[i0] = vi0;
1136 node->main_loop_vector_stats[i1] = vi1;
1137 node->main_loop_count_last_dispatch = vm->main_loop_count;
1138 /* Return previous counter. */
1139 return node->main_loop_vector_stats[i1];
1143 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1145 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1148 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1150 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1154 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1156 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1159 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1161 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1165 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1167 /* Return the edge index if present, ~0 otherwise */
1168 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1170 /* Add next node to given node in given slot. */
1172 vlib_node_add_next_with_slot (vlib_main_t * vm,
1173 uword node, uword next_node, uword slot);
1175 /* As above but adds to end of node's next vector. */
1177 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1179 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1182 /* Add next node to given node in given slot. */
1184 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1185 uword node, char *next_name, uword slot);
1187 /* As above but adds to end of node's next vector. */
1189 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1191 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1198 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1199 int barrier_sync, vlib_node_t **** node_dupsp,
1200 vlib_main_t *** stat_vmsp);
1202 /* Query node given name. */
1203 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1205 /* Rename a node. */
1206 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1208 /* Register new packet processing node. Nodes can be registered
1209 dynamically via this call or statically via the VLIB_REGISTER_NODE
1211 u32 vlib_register_node (vlib_main_t *vm, vlib_node_registration_t *r,
1214 /* Register all node function variants */
1215 void vlib_register_all_node_march_variants (vlib_main_t *vm);
1217 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1218 void vlib_register_all_static_nodes (vlib_main_t * vm);
1220 /* Start a process. */
1221 void vlib_start_process (vlib_main_t * vm, uword process_index);
1223 /* Sync up runtime and main node stats. */
1224 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1225 void vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
1226 uword n_calls, uword n_vectors,
1228 void vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
1229 uword n_calls, uword n_vectors,
1232 /* Node graph initialization function. */
1233 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1235 format_function_t format_vlib_node_graph;
1236 format_function_t format_vlib_node_name;
1237 format_function_t format_vlib_next_node_name;
1238 format_function_t format_vlib_node_and_next;
1239 format_function_t format_vlib_cpu_time;
1240 format_function_t format_vlib_time;
1241 /* Parse node name -> node index. */
1242 unformat_function_t unformat_vlib_node;
1245 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1246 u32 counter_index, u64 increment)
1248 vlib_node_t *n = vlib_get_node (vm, node_index);
1249 vlib_error_main_t *em = &vm->error_main;
1250 u32 node_counter_base_index = n->error_heap_index;
1251 em->counters[node_counter_base_index + counter_index] += increment;
1254 /** @brief Create a vlib process
1255 * @param vm &vlib_global_main
1256 * @param f the process node function
1257 * @param log2_n_stack_bytes size of the process stack, defaults to 16K
1258 * @return newly-create node index
1259 * @warning call only on the main thread. Barrier sync required
1261 u32 vlib_process_create (vlib_main_t * vm, char *name,
1262 vlib_node_function_t * f, u32 log2_n_stack_bytes);
1265 vlib_node_set_dispatch_wrapper (vlib_main_t *vm, vlib_node_function_t *fn)
1267 if (fn && vm->dispatch_wrapper_fn)
1269 vm->dispatch_wrapper_fn = fn;
1273 int vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
1274 clib_march_variant_type_t march_variant);
1276 vlib_node_function_t *
1277 vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
1278 vlib_node_fn_registration_t *regs);
1281 * vlib_frame_bitmap functions
1284 #define VLIB_FRAME_BITMAP_N_UWORDS \
1285 (((VLIB_FRAME_SIZE + uword_bits - 1) & ~(uword_bits - 1)) / uword_bits)
1287 typedef uword vlib_frame_bitmap_t[VLIB_FRAME_BITMAP_N_UWORDS];
1289 static_always_inline void
1290 vlib_frame_bitmap_init (uword *bmp, u32 n_first_bits_set)
1292 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1293 while (n_first_bits_set >= (sizeof (uword) * 8) && n_left)
1296 n_first_bits_set -= sizeof (uword) * 8;
1300 if (n_first_bits_set && n_left)
1302 bmp++[0] = pow2_mask (n_first_bits_set);
1310 static_always_inline void
1311 vlib_frame_bitmap_clear (uword *bmp)
1313 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1318 static_always_inline void
1319 vlib_frame_bitmap_xor (uword *bmp, uword *bmp2)
1321 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1323 bmp++[0] ^= bmp2++[0];
1326 static_always_inline void
1327 vlib_frame_bitmap_or (uword *bmp, uword *bmp2)
1329 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1331 bmp++[0] |= bmp2++[0];
1334 static_always_inline void
1335 vlib_frame_bitmap_and (uword *bmp, uword *bmp2)
1337 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1339 bmp++[0] &= bmp2++[0];
1342 static_always_inline u32
1343 vlib_frame_bitmap_count_set_bits (uword *bmp)
1345 u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1348 count += count_set_bits (bmp++[0]);
1352 static_always_inline int
1353 vlib_frame_bitmap_find_first_set (uword *bmp)
1358 ASSERT (b - bmp < VLIB_FRAME_BITMAP_N_UWORDS);
1362 return (b - bmp) * uword_bits + get_lowest_set_bit_index (b[0]);
1365 #define foreach_vlib_frame_bitmap_set_bit_index(i, v) \
1366 for (uword _off = 0; _off < ARRAY_LEN (v); _off++) \
1368 (v[_off]) + 0 * (uword) (i = _off * uword_bits + \
1369 get_lowest_set_bit_index (v[_off])); \
1370 _tmp; i = _off * uword_bits + get_lowest_set_bit_index ( \
1371 _tmp = clear_lowest_set_bit (_tmp)))
1373 #endif /* included_vlib_node_funcs_h */
1376 * fd.io coding-style-patch-verification: ON
1379 * eval: (c-set-style "gnu")