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_interrupt_pending (vlib_main_t *vm, u32 node_index)
230 vlib_node_main_t *nm = &vm->node_main;
231 vlib_node_t *n = vec_elt (nm->nodes, node_index);
233 ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
235 if (vm != vlib_get_main ())
236 clib_interrupt_set_atomic (nm->interrupts, n->runtime_index);
238 clib_interrupt_set (nm->interrupts, n->runtime_index);
240 __atomic_store_n (nm->pending_interrupts, 1, __ATOMIC_RELEASE);
243 always_inline vlib_process_t *
244 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
246 vlib_node_main_t *nm = &vm->node_main;
247 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
248 return vec_elt (nm->processes, node->runtime_index);
251 always_inline vlib_frame_t *
252 vlib_get_frame (vlib_main_t * vm, vlib_frame_t * f)
255 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
260 vlib_frame_no_append (vlib_frame_t * f)
262 f->frame_flags |= VLIB_FRAME_NO_APPEND;
265 /* Byte alignment for vector arguments. */
266 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
269 vlib_frame_vector_byte_offset (u32 scalar_size)
271 return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
272 VLIB_FRAME_VECTOR_ALIGN);
275 /** \brief Get pointer to frame vector data.
276 @param f vlib_frame_t pointer
277 @return pointer to first vector element in frame
280 vlib_frame_vector_args (vlib_frame_t * f)
282 return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
285 /** \brief Get pointer to frame scalar data.
287 @param f vlib_frame_t pointer
289 @return arbitrary node scalar data
291 @sa vlib_frame_vector_args
294 vlib_frame_scalar_args (vlib_frame_t * f)
296 return vlib_frame_vector_args (f) - f->scalar_size;
299 always_inline vlib_next_frame_t *
300 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
301 vlib_node_runtime_t * n, u32 next_index)
303 vlib_node_main_t *nm = &vm->node_main;
304 vlib_next_frame_t *nf;
306 ASSERT (next_index < n->n_next_nodes);
307 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
311 vlib_node_t *node, *next;
312 node = vec_elt (nm->nodes, n->node_index);
313 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
314 ASSERT (nf->node_runtime_index == next->runtime_index);
320 /** \brief Get pointer to frame by (@c node_index, @c next_index).
322 @warning This is not a function that you should call directly.
323 See @ref vlib_get_next_frame instead.
325 @param vm vlib_main_t pointer, varies by thread
326 @param node_index index of the node
327 @param next_index graph arc index
329 @return pointer to the requested vlib_next_frame_t
331 @sa vlib_get_next_frame
334 always_inline vlib_next_frame_t *
335 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
337 vlib_node_main_t *nm = &vm->node_main;
339 vlib_node_runtime_t *r;
341 n = vec_elt (nm->nodes, node_index);
342 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
343 return vlib_node_runtime_get_next_frame (vm, r, next_index);
346 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
347 vlib_node_runtime_t * node,
349 u32 alloc_new_frame);
351 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
354 = vlib_get_next_frame_internal ((vm), (node), (next_index), \
355 (alloc_new_frame)); \
356 u32 _n = _f->n_vectors; \
357 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
358 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
362 /** \brief Get pointer to next frame vector data by
363 (@c vlib_node_runtime_t, @c next_index).
364 Standard single/dual loop boilerplate element.
365 @attention This is a MACRO, with SIDE EFFECTS.
367 @param vm vlib_main_t pointer, varies by thread
368 @param node current node vlib_node_runtime_t pointer
369 @param next_index requested graph arc index
371 @return @c vectors -- pointer to next available vector slot
372 @return @c n_vectors_left -- number of vector slots available
374 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left) \
375 vlib_get_next_frame_macro (vm, node, next_index, \
376 vectors, n_vectors_left, \
377 /* alloc new frame */ 0)
379 #define vlib_get_new_next_frame(vm,node,next_index,vectors,n_vectors_left) \
380 vlib_get_next_frame_macro (vm, node, next_index, \
381 vectors, n_vectors_left, \
382 /* alloc new frame */ 1)
384 /** \brief Release pointer to next frame vector data.
385 Standard single/dual loop boilerplate element.
386 @param vm vlib_main_t pointer, varies by thread
387 @param r current node vlib_node_runtime_t pointer
388 @param next_index graph arc index
389 @param n_packets_left number of slots still available in vector
392 vlib_put_next_frame (vlib_main_t * vm,
393 vlib_node_runtime_t * r,
394 u32 next_index, u32 n_packets_left);
396 /* Combination get plus put. Returns vector argument just added. */
397 #define vlib_set_next_frame(vm,node,next_index,v) \
400 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
401 ASSERT (_n_left > 0); \
402 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
407 vlib_set_next_frame_buffer (vlib_main_t * vm,
408 vlib_node_runtime_t * node,
409 u32 next_index, u32 buffer_index)
412 p = vlib_set_next_frame (vm, node, next_index, p);
416 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
417 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
421 vlib_in_process_context (vlib_main_t * vm)
423 return vm->node_main.current_process_index != ~0;
426 always_inline vlib_process_t *
427 vlib_get_current_process (vlib_main_t * vm)
429 vlib_node_main_t *nm = &vm->node_main;
430 if (vlib_in_process_context (vm))
431 return vec_elt (nm->processes, nm->current_process_index);
436 vlib_current_process (vlib_main_t * vm)
438 return vlib_get_current_process (vm)->node_runtime.node_index;
442 vlib_get_current_process_node_index (vlib_main_t * vm)
444 vlib_process_t *process = vlib_get_current_process (vm);
445 return process->node_runtime.node_index;
448 /** Returns TRUE if a process suspend time is less than 10us
449 @param dt - remaining poll time in seconds
450 @returns 1 if dt < 10e-6, 0 otherwise
453 vlib_process_suspend_time_is_zero (f64 dt)
458 /** Suspend a vlib cooperative multi-tasking thread for a period of time
459 @param vm - vlib_main_t *
460 @param dt - suspend interval in seconds
461 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
465 vlib_process_suspend (vlib_main_t * vm, f64 dt)
468 vlib_node_main_t *nm = &vm->node_main;
469 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
471 if (vlib_process_suspend_time_is_zero (dt))
472 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
474 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
475 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
476 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
478 /* expiration time in 10us ticks */
479 p->resume_clock_interval = dt * 1e5;
480 vlib_process_start_switch_stack (vm, 0);
481 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
484 vlib_process_finish_switch_stack (vm);
490 vlib_process_free_event_type (vlib_process_t * p, uword t,
491 uword is_one_time_event)
493 ASSERT (!pool_is_free_index (p->event_type_pool, t));
494 pool_put_index (p->event_type_pool, t);
495 if (is_one_time_event)
496 p->one_time_event_type_bitmap =
497 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
501 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
503 ASSERT (!pool_is_free_index (p->event_type_pool, t));
504 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
505 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
509 vlib_process_get_event_data (vlib_main_t * vm,
510 uword * return_event_type_opaque)
512 vlib_node_main_t *nm = &vm->node_main;
514 vlib_process_event_type_t *et;
516 void *event_data_vector;
518 p = vec_elt (nm->processes, nm->current_process_index);
520 /* Find first type with events ready.
521 Return invalid type when there's nothing there. */
522 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
526 p->non_empty_event_type_bitmap =
527 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
529 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
530 event_data_vector = p->pending_event_data_by_type_index[t];
531 p->pending_event_data_by_type_index[t] = 0;
533 et = pool_elt_at_index (p->event_type_pool, t);
535 /* Return user's opaque value and possibly index. */
536 *return_event_type_opaque = et->opaque;
538 vlib_process_maybe_free_event_type (p, t);
540 return event_data_vector;
543 /* Return event data vector for later reuse. We reuse event data to avoid
544 repeatedly allocating event vectors in cases where we care about speed. */
546 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
548 vlib_node_main_t *nm = &vm->node_main;
549 vec_add1 (nm->recycled_event_data_vectors, event_data);
552 /** Return the first event type which has occurred and a vector of per-event
553 data of that type, or a timeout indication
555 @param vm - vlib_main_t pointer
556 @param data_vector - pointer to a (uword *) vector to receive event data
557 @returns either an event type and a vector of per-event instance data,
558 or ~0 to indicate a timeout.
562 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
564 vlib_node_main_t *nm = &vm->node_main;
566 vlib_process_event_type_t *et;
569 p = vec_elt (nm->processes, nm->current_process_index);
571 /* Find first type with events ready.
572 Return invalid type when there's nothing there. */
573 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
577 p->non_empty_event_type_bitmap =
578 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
580 l = _vec_len (p->pending_event_data_by_type_index[t]);
582 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
583 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
585 et = pool_elt_at_index (p->event_type_pool, t);
587 /* Return user's opaque value. */
590 vlib_process_maybe_free_event_type (p, t);
596 vlib_process_get_events_helper (vlib_process_t * p, uword t,
597 uword ** data_vector)
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_len (p->pending_event_data_by_type_index[t]) = 0;
609 vlib_process_maybe_free_event_type (p, t);
614 /* As above but query as specified type of event. Returns number of
617 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
618 uword with_type_opaque)
620 vlib_node_main_t *nm = &vm->node_main;
624 p = vec_elt (nm->processes, nm->current_process_index);
625 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
627 /* This can happen when an event has not yet been
628 signaled with given opaque type. */
632 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
635 return vlib_process_get_events_helper (p, t, data_vector);
638 always_inline uword *
639 vlib_process_wait_for_event (vlib_main_t * vm)
641 vlib_node_main_t *nm = &vm->node_main;
645 p = vec_elt (nm->processes, nm->current_process_index);
646 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
648 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
650 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
651 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
653 vlib_process_start_switch_stack (vm, 0);
654 clib_longjmp (&p->return_longjmp,
655 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
658 vlib_process_finish_switch_stack (vm);
661 return p->non_empty_event_type_bitmap;
665 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
666 uword ** data_vector,
667 uword with_type_index)
669 vlib_node_main_t *nm = &vm->node_main;
673 p = vec_elt (nm->processes, nm->current_process_index);
674 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
675 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
677 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
679 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
680 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
682 vlib_process_start_switch_stack (vm, 0);
683 clib_longjmp (&p->return_longjmp,
684 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
687 vlib_process_finish_switch_stack (vm);
690 return vlib_process_get_events_helper (p, with_type_index, data_vector);
694 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
695 uword ** data_vector,
696 uword with_type_opaque)
698 vlib_node_main_t *nm = &vm->node_main;
702 p = vec_elt (nm->processes, nm->current_process_index);
703 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
704 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
706 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
708 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
709 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
711 vlib_process_start_switch_stack (vm, 0);
712 clib_longjmp (&p->return_longjmp,
713 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
716 vlib_process_finish_switch_stack (vm);
718 /* See if unknown event type has been signaled now. */
720 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
723 return vlib_process_get_events_helper (p, h[0], data_vector);
726 /** Suspend a cooperative multi-tasking thread
727 Waits for an event, or for the indicated number of seconds to elapse
728 @param vm - vlib_main_t pointer
729 @param dt - timeout, in seconds.
730 @returns the remaining time interval
734 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
736 vlib_node_main_t *nm = &vm->node_main;
741 p = vec_elt (nm->processes, nm->current_process_index);
743 if (vlib_process_suspend_time_is_zero (dt)
744 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
747 wakeup_time = vlib_time_now (vm) + dt;
749 /* Suspend waiting for both clock and event to occur. */
750 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
751 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
753 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
754 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
756 p->resume_clock_interval = dt * 1e5;
757 vlib_process_start_switch_stack (vm, 0);
758 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
761 vlib_process_finish_switch_stack (vm);
763 /* Return amount of time still left to sleep.
764 If <= 0 then we've been waken up by the clock (and not an event). */
765 return wakeup_time - vlib_time_now (vm);
768 always_inline vlib_process_event_type_t *
769 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
771 vlib_process_event_type_t *et;
772 pool_get (p->event_type_pool, et);
773 et->opaque = with_type_opaque;
778 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
779 uword with_type_opaque)
781 vlib_node_main_t *nm = &vm->node_main;
782 vlib_node_t *n = vlib_get_node (vm, node_index);
783 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
784 vlib_process_event_type_t *et;
787 et = vlib_process_new_event_type (p, with_type_opaque);
788 t = et - p->event_type_pool;
789 p->one_time_event_type_bitmap =
790 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
795 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
798 vlib_node_main_t *nm = &vm->node_main;
799 vlib_node_t *n = vlib_get_node (vm, node_index);
800 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
802 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
803 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
807 vlib_process_signal_event_helper (vlib_node_main_t * nm,
811 uword n_data_elts, uword n_data_elt_bytes)
813 uword p_flags, add_to_pending, delete_from_wheel;
814 void *data_to_be_written_by_caller;
816 ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
818 ASSERT (!pool_is_free_index (p->event_type_pool, t));
820 vec_validate (p->pending_event_data_by_type_index, t);
822 /* Resize data vector and return caller's data to be written. */
824 void *data_vec = p->pending_event_data_by_type_index[t];
827 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
829 data_vec = vec_pop (nm->recycled_event_data_vectors);
830 _vec_len (data_vec) = 0;
833 l = vec_len (data_vec);
835 data_vec = _vec_resize (data_vec,
836 /* length_increment */ n_data_elts,
837 /* total size after increment */
838 (l + n_data_elts) * n_data_elt_bytes,
839 /* header_bytes */ 0, /* data_align */ 0);
841 p->pending_event_data_by_type_index[t] = data_vec;
842 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
845 p->non_empty_event_type_bitmap =
846 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
850 /* Event was already signalled? */
851 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
853 /* Process will resume when suspend time elapses? */
854 delete_from_wheel = 0;
855 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
857 /* Waiting for both event and clock? */
858 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
860 if (!TW (tw_timer_handle_is_free)
861 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
862 p->stop_timer_handle))
863 delete_from_wheel = 1;
865 /* timer just popped so process should already be on the list */
869 /* Waiting only for clock. Event will be queue and may be
870 handled when timer expires. */
874 /* Never add current process to pending vector since current process is
876 add_to_pending &= nm->current_process_index != n->runtime_index;
880 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
881 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
882 vec_add1 (nm->data_from_advancing_timing_wheel, x);
883 if (delete_from_wheel)
884 TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
885 p->stop_timer_handle);
888 return data_to_be_written_by_caller;
892 vlib_process_signal_event_data (vlib_main_t * vm,
895 uword n_data_elts, uword n_data_elt_bytes)
897 vlib_node_main_t *nm = &vm->node_main;
898 vlib_node_t *n = vlib_get_node (vm, node_index);
899 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
902 /* Must be in main thread */
903 ASSERT (vlib_get_thread_index () == 0);
905 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
908 vlib_process_event_type_t *et =
909 vlib_process_new_event_type (p, type_opaque);
910 t = et - p->event_type_pool;
911 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
916 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
921 vlib_process_signal_event_at_time (vlib_main_t * vm,
925 uword n_data_elts, uword n_data_elt_bytes)
927 vlib_node_main_t *nm = &vm->node_main;
928 vlib_node_t *n = vlib_get_node (vm, node_index);
929 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
932 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
935 vlib_process_event_type_t *et =
936 vlib_process_new_event_type (p, type_opaque);
937 t = et - p->event_type_pool;
938 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
943 if (vlib_process_suspend_time_is_zero (dt))
944 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
948 vlib_signal_timed_event_data_t *te;
950 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
952 te->n_data_elts = n_data_elts;
953 te->n_data_elt_bytes = n_data_elt_bytes;
954 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
956 /* Assert that structure fields are big enough. */
957 ASSERT (te->n_data_elts == n_data_elts);
958 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
959 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
961 te->process_node_index = n->runtime_index;
962 te->event_type_index = t;
964 p->stop_timer_handle =
965 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
966 vlib_timing_wheel_data_set_timed_event
967 (te - nm->signal_timed_event_data_pool),
969 (vlib_time_now (vm) + dt) * 1e5);
971 /* Inline data big enough to hold event? */
972 if (te->n_data_bytes < sizeof (te->inline_event_data))
973 return te->inline_event_data;
976 te->event_data_as_vector = 0;
977 vec_resize (te->event_data_as_vector, te->n_data_bytes);
978 return te->event_data_as_vector;
984 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
988 uword n_data_elt_bytes)
990 vlib_node_main_t *nm = &vm->node_main;
991 vlib_node_t *n = vlib_get_node (vm, node_index);
992 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
993 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
998 vlib_process_signal_event (vlib_main_t * vm,
999 uword node_index, uword type_opaque, uword data)
1001 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1002 1 /* elts */ , sizeof (uword));
1007 vlib_process_signal_event_pointer (vlib_main_t * vm,
1009 uword type_opaque, void *data)
1011 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1012 1 /* elts */ , sizeof (data));
1017 * Signal event to process from any thread.
1019 * When in doubt, use this.
1022 vlib_process_signal_event_mt (vlib_main_t * vm,
1023 uword node_index, uword type_opaque, uword data)
1025 if (vlib_get_thread_index () != 0)
1027 vlib_process_signal_event_mt_args_t args = {
1028 .node_index = node_index,
1029 .type_opaque = type_opaque,
1032 vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
1033 (u8 *) & args, sizeof (args));
1036 vlib_process_signal_event (vm, node_index, type_opaque, data);
1040 vlib_process_signal_one_time_event (vlib_main_t * vm,
1042 uword type_index, uword data)
1045 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1046 1 /* elts */ , sizeof (uword));
1051 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1052 vlib_one_time_waiting_process_t * p)
1054 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1056 clib_memset (p, ~0, sizeof (p[0]));
1060 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1061 vlib_one_time_waiting_process_t
1064 vlib_one_time_waiting_process_t *wp;
1065 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1070 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1071 vlib_one_time_waiting_process_t
1074 p->node_index = vlib_current_process (vm);
1075 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1077 vlib_process_wait_for_one_time_event (vm,
1078 /* don't care about data */ 0,
1083 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1084 vlib_one_time_waiting_process_t
1087 vlib_one_time_waiting_process_t *wp;
1088 vec_add2 (*wps, wp, 1);
1089 vlib_current_process_wait_for_one_time_event (vm, wp);
1093 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1094 vlib_node_runtime_t * node,
1100 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1101 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1102 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1105 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1107 (node->main_loop_count_last_dispatch >>
1108 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1109 vi0 = node->main_loop_vector_stats[i0];
1110 vi1 = node->main_loop_vector_stats[i1];
1111 vi0 = d == 0 ? vi0 : 0;
1112 vi1 = d <= 1 ? vi1 : 0;
1114 node->main_loop_vector_stats[i0] = vi0;
1115 node->main_loop_vector_stats[i1] = vi1;
1116 node->main_loop_count_last_dispatch = vm->main_loop_count;
1117 /* Return previous counter. */
1118 return node->main_loop_vector_stats[i1];
1122 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1124 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1127 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1129 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1133 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1135 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1138 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1140 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1144 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1146 /* Return the edge index if present, ~0 otherwise */
1147 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1149 /* Add next node to given node in given slot. */
1151 vlib_node_add_next_with_slot (vlib_main_t * vm,
1152 uword node, uword next_node, uword slot);
1154 /* As above but adds to end of node's next vector. */
1156 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1158 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1161 /* Add next node to given node in given slot. */
1163 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1164 uword node, char *next_name, uword slot);
1166 /* As above but adds to end of node's next vector. */
1168 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1170 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1177 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1178 int barrier_sync, vlib_node_t **** node_dupsp,
1179 vlib_main_t *** stat_vmsp);
1181 /* Query node given name. */
1182 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1184 /* Rename a node. */
1185 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1187 /* Register new packet processing node. Nodes can be registered
1188 dynamically via this call or statically via the VLIB_REGISTER_NODE
1190 u32 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r);
1192 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1193 void vlib_register_all_static_nodes (vlib_main_t * vm);
1195 /* Start a process. */
1196 void vlib_start_process (vlib_main_t * vm, uword process_index);
1198 /* Sync up runtime and main node stats. */
1199 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1201 /* Node graph initialization function. */
1202 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1204 format_function_t format_vlib_node_graph;
1205 format_function_t format_vlib_node_name;
1206 format_function_t format_vlib_next_node_name;
1207 format_function_t format_vlib_node_and_next;
1208 format_function_t format_vlib_cpu_time;
1209 format_function_t format_vlib_time;
1210 /* Parse node name -> node index. */
1211 unformat_function_t unformat_vlib_node;
1214 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1215 u32 counter_index, u64 increment)
1217 vlib_node_t *n = vlib_get_node (vm, node_index);
1218 vlib_error_main_t *em = &vm->error_main;
1219 u32 node_counter_base_index = n->error_heap_index;
1220 em->counters[node_counter_base_index + counter_index] += increment;
1223 /** @brief Create a vlib process
1224 * @param vm &vlib_global_main
1225 * @param f the process node function
1226 * @param log2_n_stack_bytes size of the process stack, defaults to 16K
1227 * @return newly-create node index
1228 * @warning call only on the main thread. Barrier sync required
1230 u32 vlib_process_create (vlib_main_t * vm, char *name,
1231 vlib_node_function_t * f, u32 log2_n_stack_bytes);
1234 vlib_node_set_dispatch_wrapper (vlib_main_t *vm, vlib_node_function_t *fn)
1236 if (fn && vm->dispatch_wrapper_fn)
1238 vm->dispatch_wrapper_fn = fn;
1242 #endif /* included_vlib_node_funcs_h */
1245 * fd.io coding-style-patch-verification: ON
1248 * eval: (c-set-style "gnu")