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>
51 #ifdef CLIB_SANITIZE_ADDR
52 #include <sanitizer/asan_interface.h>
55 static_always_inline void
56 vlib_process_start_switch_stack (vlib_main_t * vm, vlib_process_t * p)
58 #ifdef CLIB_SANITIZE_ADDR
59 void *stack = p ? (void *) p->stack : vlib_thread_stacks[vm->thread_index];
60 u32 stack_bytes = p ? p->log2_n_stack_bytes : VLIB_THREAD_STACK_SIZE;
61 __sanitizer_start_switch_fiber (&vm->asan_stack_save, stack, stack_bytes);
65 static_always_inline void
66 vlib_process_finish_switch_stack (vlib_main_t * vm)
68 #ifdef CLIB_SANITIZE_ADDR
69 const void *bottom_old;
72 __sanitizer_finish_switch_fiber (&vm->asan_stack_save, &bottom_old,
77 /** \brief Get vlib node by index.
78 @warning This function will ASSERT if @c i is out of range.
79 @param vm vlib_main_t pointer, varies by thread
81 @return pointer to the requested vlib_node_t.
84 always_inline vlib_node_t *
85 vlib_get_node (vlib_main_t * vm, u32 i)
87 return vec_elt (vm->node_main.nodes, i);
90 /** \brief Get vlib node by graph arc (next) index.
91 @param vm vlib_main_t pointer, varies by thread
92 @param node_index index of original node
93 @param next_index graph arc index
94 @return pointer to the vlib_node_t at the end of the indicated arc
97 always_inline vlib_node_t *
98 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
100 vlib_node_main_t *nm = &vm->node_main;
103 n = vec_elt (nm->nodes, node_index);
104 ASSERT (next_index < vec_len (n->next_nodes));
105 return vlib_get_node (vm, n->next_nodes[next_index]);
108 /** \brief Get node runtime by node index.
109 @param vm vlib_main_t pointer, varies by thread
110 @param node_index index of node
111 @return pointer to the indicated vlib_node_runtime_t
114 always_inline vlib_node_runtime_t *
115 vlib_node_get_runtime (vlib_main_t * vm, u32 node_index)
117 vlib_node_main_t *nm = &vm->node_main;
118 vlib_node_t *n = vec_elt (nm->nodes, node_index);
120 if (n->type != VLIB_NODE_TYPE_PROCESS)
121 return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
124 p = vec_elt (nm->processes, n->runtime_index);
125 return &p->node_runtime;
129 /** \brief Get node runtime private data by node index.
130 @param vm vlib_main_t pointer, varies by thread
131 @param node_index index of the node
132 @return pointer to the indicated vlib_node_runtime_t private data
136 vlib_node_get_runtime_data (vlib_main_t * vm, u32 node_index)
138 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
139 return r->runtime_data;
142 /** \brief Set node runtime private data.
143 @param vm vlib_main_t pointer, varies by thread
144 @param node_index index of the node
145 @param runtime_data arbitrary runtime private data
146 @param n_runtime_data_bytes size of runtime private data
150 vlib_node_set_runtime_data (vlib_main_t * vm, u32 node_index,
151 void *runtime_data, u32 n_runtime_data_bytes)
153 vlib_node_t *n = vlib_get_node (vm, node_index);
154 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
156 n->runtime_data_bytes = n_runtime_data_bytes;
157 vec_free (n->runtime_data);
158 vec_add (n->runtime_data, runtime_data, n_runtime_data_bytes);
160 ASSERT (vec_len (n->runtime_data) <= sizeof (vlib_node_runtime_t) -
161 STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
163 if (vec_len (n->runtime_data) > 0)
164 clib_memcpy_fast (r->runtime_data, n->runtime_data,
165 vec_len (n->runtime_data));
168 /** \brief Set node dispatch state.
169 @param vm vlib_main_t pointer, varies by thread
170 @param node_index index of the node
171 @param new_state new state for node, see vlib_node_state_t
174 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
175 vlib_node_state_t new_state)
177 vlib_node_main_t *nm = &vm->node_main;
179 vlib_node_runtime_t *r;
181 n = vec_elt (nm->nodes, node_index);
182 if (n->type == VLIB_NODE_TYPE_PROCESS)
184 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
185 r = &p->node_runtime;
187 /* When disabling make sure flags are cleared. */
188 p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
189 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
190 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
193 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
195 ASSERT (new_state < VLIB_N_NODE_STATE);
197 if (n->type == VLIB_NODE_TYPE_INPUT)
199 ASSERT (nm->input_node_counts_by_state[n->state] > 0);
200 nm->input_node_counts_by_state[n->state] -= 1;
201 nm->input_node_counts_by_state[new_state] += 1;
204 if (PREDICT_FALSE (r->state == VLIB_NODE_STATE_DISABLED))
205 vlib_node_runtime_perf_counter (vm, r, 0, 0, 0,
206 VLIB_NODE_RUNTIME_PERF_RESET);
208 n->state = new_state;
209 r->state = new_state;
212 /** \brief Get node dispatch state.
213 @param vm vlib_main_t pointer, varies by thread
214 @param node_index index of the node
215 @return state for node, see vlib_node_state_t
217 always_inline vlib_node_state_t
218 vlib_node_get_state (vlib_main_t * vm, u32 node_index)
220 vlib_node_main_t *nm = &vm->node_main;
222 n = vec_elt (nm->nodes, node_index);
227 vlib_node_set_interrupt_pending_with_data (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);
232 vlib_node_interrupt_t *i;
233 ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
235 if (vm == vlib_get_main ())
238 vec_add2 (nm->pending_local_interrupts, i, 1);
239 i->node_runtime_index = n->runtime_index;
245 clib_spinlock_lock (&nm->pending_interrupt_lock);
246 vec_add2 (nm->pending_remote_interrupts, i, 1);
247 i->node_runtime_index = n->runtime_index;
249 *nm->pending_remote_interrupts_notify = 1;
250 clib_spinlock_unlock (&nm->pending_interrupt_lock);
255 vlib_node_set_interrupt_pending (vlib_main_t * vm, u32 node_index)
257 vlib_node_set_interrupt_pending_with_data (vm, node_index, 0);
260 always_inline vlib_process_t *
261 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
263 vlib_node_main_t *nm = &vm->node_main;
264 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
265 return vec_elt (nm->processes, node->runtime_index);
268 always_inline vlib_frame_t *
269 vlib_get_frame (vlib_main_t * vm, vlib_frame_t * f)
272 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
277 vlib_frame_no_append (vlib_frame_t * f)
279 f->frame_flags |= VLIB_FRAME_NO_APPEND;
282 /* Byte alignment for vector arguments. */
283 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
286 vlib_frame_vector_byte_offset (u32 scalar_size)
288 return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
289 VLIB_FRAME_VECTOR_ALIGN);
292 /** \brief Get pointer to frame vector data.
293 @param f vlib_frame_t pointer
294 @return pointer to first vector element in frame
297 vlib_frame_vector_args (vlib_frame_t * f)
299 return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
302 /** \brief Get pointer to frame scalar data.
304 @param f vlib_frame_t pointer
306 @return arbitrary node scalar data
308 @sa vlib_frame_vector_args
311 vlib_frame_scalar_args (vlib_frame_t * f)
313 return vlib_frame_vector_args (f) - f->scalar_size;
316 always_inline vlib_next_frame_t *
317 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
318 vlib_node_runtime_t * n, u32 next_index)
320 vlib_node_main_t *nm = &vm->node_main;
321 vlib_next_frame_t *nf;
323 ASSERT (next_index < n->n_next_nodes);
324 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
328 vlib_node_t *node, *next;
329 node = vec_elt (nm->nodes, n->node_index);
330 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
331 ASSERT (nf->node_runtime_index == next->runtime_index);
337 /** \brief Get pointer to frame by (@c node_index, @c next_index).
339 @warning This is not a function that you should call directly.
340 See @ref vlib_get_next_frame instead.
342 @param vm vlib_main_t pointer, varies by thread
343 @param node_index index of the node
344 @param next_index graph arc index
346 @return pointer to the requested vlib_next_frame_t
348 @sa vlib_get_next_frame
351 always_inline vlib_next_frame_t *
352 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
354 vlib_node_main_t *nm = &vm->node_main;
356 vlib_node_runtime_t *r;
358 n = vec_elt (nm->nodes, node_index);
359 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
360 return vlib_node_runtime_get_next_frame (vm, r, next_index);
363 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
364 vlib_node_runtime_t * node,
366 u32 alloc_new_frame);
368 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
371 = vlib_get_next_frame_internal ((vm), (node), (next_index), \
372 (alloc_new_frame)); \
373 u32 _n = _f->n_vectors; \
374 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
375 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
379 /** \brief Get pointer to next frame vector data by
380 (@c vlib_node_runtime_t, @c next_index).
381 Standard single/dual loop boilerplate element.
382 @attention This is a MACRO, with SIDE EFFECTS.
384 @param vm vlib_main_t pointer, varies by thread
385 @param node current node vlib_node_runtime_t pointer
386 @param next_index requested graph arc index
388 @return @c vectors -- pointer to next available vector slot
389 @return @c n_vectors_left -- number of vector slots available
391 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left) \
392 vlib_get_next_frame_macro (vm, node, next_index, \
393 vectors, n_vectors_left, \
394 /* alloc new frame */ 0)
396 #define vlib_get_new_next_frame(vm,node,next_index,vectors,n_vectors_left) \
397 vlib_get_next_frame_macro (vm, node, next_index, \
398 vectors, n_vectors_left, \
399 /* alloc new frame */ 1)
401 /** \brief Release pointer to next frame vector data.
402 Standard single/dual loop boilerplate element.
403 @param vm vlib_main_t pointer, varies by thread
404 @param r current node vlib_node_runtime_t pointer
405 @param next_index graph arc index
406 @param n_packets_left number of slots still available in vector
409 vlib_put_next_frame (vlib_main_t * vm,
410 vlib_node_runtime_t * r,
411 u32 next_index, u32 n_packets_left);
413 /* Combination get plus put. Returns vector argument just added. */
414 #define vlib_set_next_frame(vm,node,next_index,v) \
417 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
418 ASSERT (_n_left > 0); \
419 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
424 vlib_set_next_frame_buffer (vlib_main_t * vm,
425 vlib_node_runtime_t * node,
426 u32 next_index, u32 buffer_index)
429 p = vlib_set_next_frame (vm, node, next_index, p);
433 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
434 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
438 vlib_in_process_context (vlib_main_t * vm)
440 return vm->node_main.current_process_index != ~0;
443 always_inline vlib_process_t *
444 vlib_get_current_process (vlib_main_t * vm)
446 vlib_node_main_t *nm = &vm->node_main;
447 if (vlib_in_process_context (vm))
448 return vec_elt (nm->processes, nm->current_process_index);
453 vlib_current_process (vlib_main_t * vm)
455 return vlib_get_current_process (vm)->node_runtime.node_index;
458 /** Returns TRUE if a process suspend time is less than 10us
459 @param dt - remaining poll time in seconds
460 @returns 1 if dt < 10e-6, 0 otherwise
463 vlib_process_suspend_time_is_zero (f64 dt)
468 /** Suspend a vlib cooperative multi-tasking thread for a period of time
469 @param vm - vlib_main_t *
470 @param dt - suspend interval in seconds
471 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
475 vlib_process_suspend (vlib_main_t * vm, f64 dt)
478 vlib_node_main_t *nm = &vm->node_main;
479 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
481 if (vlib_process_suspend_time_is_zero (dt))
482 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
484 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
485 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
486 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
488 /* expiration time in 10us ticks */
489 p->resume_clock_interval = dt * 1e5;
490 vlib_process_start_switch_stack (vm, 0);
491 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
494 vlib_process_finish_switch_stack (vm);
500 vlib_process_free_event_type (vlib_process_t * p, uword t,
501 uword is_one_time_event)
503 ASSERT (!pool_is_free_index (p->event_type_pool, t));
504 pool_put_index (p->event_type_pool, t);
505 if (is_one_time_event)
506 p->one_time_event_type_bitmap =
507 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
511 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
513 ASSERT (!pool_is_free_index (p->event_type_pool, t));
514 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
515 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
519 vlib_process_get_event_data (vlib_main_t * vm,
520 uword * return_event_type_opaque)
522 vlib_node_main_t *nm = &vm->node_main;
524 vlib_process_event_type_t *et;
526 void *event_data_vector;
528 p = vec_elt (nm->processes, nm->current_process_index);
530 /* Find first type with events ready.
531 Return invalid type when there's nothing there. */
532 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
536 p->non_empty_event_type_bitmap =
537 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
539 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
540 event_data_vector = p->pending_event_data_by_type_index[t];
541 p->pending_event_data_by_type_index[t] = 0;
543 et = pool_elt_at_index (p->event_type_pool, t);
545 /* Return user's opaque value and possibly index. */
546 *return_event_type_opaque = et->opaque;
548 vlib_process_maybe_free_event_type (p, t);
550 return event_data_vector;
553 /* Return event data vector for later reuse. We reuse event data to avoid
554 repeatedly allocating event vectors in cases where we care about speed. */
556 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
558 vlib_node_main_t *nm = &vm->node_main;
559 vec_add1 (nm->recycled_event_data_vectors, event_data);
562 /** Return the first event type which has occurred and a vector of per-event
563 data of that type, or a timeout indication
565 @param vm - vlib_main_t pointer
566 @param data_vector - pointer to a (uword *) vector to receive event data
567 @returns either an event type and a vector of per-event instance data,
568 or ~0 to indicate a timeout.
572 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
574 vlib_node_main_t *nm = &vm->node_main;
576 vlib_process_event_type_t *et;
579 p = vec_elt (nm->processes, nm->current_process_index);
581 /* Find first type with events ready.
582 Return invalid type when there's nothing there. */
583 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
587 p->non_empty_event_type_bitmap =
588 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
590 l = _vec_len (p->pending_event_data_by_type_index[t]);
592 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
593 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
595 et = pool_elt_at_index (p->event_type_pool, t);
597 /* Return user's opaque value. */
600 vlib_process_maybe_free_event_type (p, t);
606 vlib_process_get_events_helper (vlib_process_t * p, uword t,
607 uword ** data_vector)
611 p->non_empty_event_type_bitmap =
612 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
614 l = _vec_len (p->pending_event_data_by_type_index[t]);
616 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
617 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
619 vlib_process_maybe_free_event_type (p, t);
624 /* As above but query as specified type of event. Returns number of
627 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
628 uword with_type_opaque)
630 vlib_node_main_t *nm = &vm->node_main;
634 p = vec_elt (nm->processes, nm->current_process_index);
635 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
637 /* This can happen when an event has not yet been
638 signaled with given opaque type. */
642 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
645 return vlib_process_get_events_helper (p, t, data_vector);
648 always_inline uword *
649 vlib_process_wait_for_event (vlib_main_t * vm)
651 vlib_node_main_t *nm = &vm->node_main;
655 p = vec_elt (nm->processes, nm->current_process_index);
656 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
658 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
660 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
661 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
663 vlib_process_start_switch_stack (vm, 0);
664 clib_longjmp (&p->return_longjmp,
665 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
668 vlib_process_finish_switch_stack (vm);
671 return p->non_empty_event_type_bitmap;
675 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
676 uword ** data_vector,
677 uword with_type_index)
679 vlib_node_main_t *nm = &vm->node_main;
683 p = vec_elt (nm->processes, nm->current_process_index);
684 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
685 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
687 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
689 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
690 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
692 vlib_process_start_switch_stack (vm, 0);
693 clib_longjmp (&p->return_longjmp,
694 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
697 vlib_process_finish_switch_stack (vm);
700 return vlib_process_get_events_helper (p, with_type_index, data_vector);
704 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
705 uword ** data_vector,
706 uword with_type_opaque)
708 vlib_node_main_t *nm = &vm->node_main;
712 p = vec_elt (nm->processes, nm->current_process_index);
713 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
714 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
716 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
718 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
719 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
721 vlib_process_start_switch_stack (vm, 0);
722 clib_longjmp (&p->return_longjmp,
723 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
726 vlib_process_finish_switch_stack (vm);
728 /* See if unknown event type has been signaled now. */
730 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
733 return vlib_process_get_events_helper (p, h[0], data_vector);
736 /** Suspend a cooperative multi-tasking thread
737 Waits for an event, or for the indicated number of seconds to elapse
738 @param vm - vlib_main_t pointer
739 @param dt - timeout, in seconds.
740 @returns the remaining time interval
744 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
746 vlib_node_main_t *nm = &vm->node_main;
751 p = vec_elt (nm->processes, nm->current_process_index);
753 if (vlib_process_suspend_time_is_zero (dt)
754 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
757 wakeup_time = vlib_time_now (vm) + dt;
759 /* Suspend waiting for both clock and event to occur. */
760 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
761 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
763 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
764 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
766 p->resume_clock_interval = dt * 1e5;
767 vlib_process_start_switch_stack (vm, 0);
768 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
771 vlib_process_finish_switch_stack (vm);
773 /* Return amount of time still left to sleep.
774 If <= 0 then we've been waken up by the clock (and not an event). */
775 return wakeup_time - vlib_time_now (vm);
778 always_inline vlib_process_event_type_t *
779 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
781 vlib_process_event_type_t *et;
782 pool_get (p->event_type_pool, et);
783 et->opaque = with_type_opaque;
788 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
789 uword with_type_opaque)
791 vlib_node_main_t *nm = &vm->node_main;
792 vlib_node_t *n = vlib_get_node (vm, node_index);
793 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
794 vlib_process_event_type_t *et;
797 et = vlib_process_new_event_type (p, with_type_opaque);
798 t = et - p->event_type_pool;
799 p->one_time_event_type_bitmap =
800 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
805 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
808 vlib_node_main_t *nm = &vm->node_main;
809 vlib_node_t *n = vlib_get_node (vm, node_index);
810 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
812 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
813 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
817 vlib_process_signal_event_helper (vlib_node_main_t * nm,
821 uword n_data_elts, uword n_data_elt_bytes)
823 uword p_flags, add_to_pending, delete_from_wheel;
824 void *data_to_be_written_by_caller;
826 ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
828 ASSERT (!pool_is_free_index (p->event_type_pool, t));
830 vec_validate (p->pending_event_data_by_type_index, t);
832 /* Resize data vector and return caller's data to be written. */
834 void *data_vec = p->pending_event_data_by_type_index[t];
837 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
839 data_vec = vec_pop (nm->recycled_event_data_vectors);
840 _vec_len (data_vec) = 0;
843 l = vec_len (data_vec);
845 data_vec = _vec_resize (data_vec,
846 /* length_increment */ n_data_elts,
847 /* total size after increment */
848 (l + n_data_elts) * n_data_elt_bytes,
849 /* header_bytes */ 0, /* data_align */ 0);
851 p->pending_event_data_by_type_index[t] = data_vec;
852 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
855 p->non_empty_event_type_bitmap =
856 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
860 /* Event was already signalled? */
861 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
863 /* Process will resume when suspend time elapses? */
864 delete_from_wheel = 0;
865 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
867 /* Waiting for both event and clock? */
868 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
870 if (!TW (tw_timer_handle_is_free)
871 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
872 p->stop_timer_handle))
873 delete_from_wheel = 1;
875 /* timer just popped so process should already be on the list */
879 /* Waiting only for clock. Event will be queue and may be
880 handled when timer expires. */
884 /* Never add current process to pending vector since current process is
886 add_to_pending &= nm->current_process_index != n->runtime_index;
890 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
891 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
892 vec_add1 (nm->data_from_advancing_timing_wheel, x);
893 if (delete_from_wheel)
894 TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
895 p->stop_timer_handle);
898 return data_to_be_written_by_caller;
902 vlib_process_signal_event_data (vlib_main_t * vm,
905 uword n_data_elts, uword n_data_elt_bytes)
907 vlib_node_main_t *nm = &vm->node_main;
908 vlib_node_t *n = vlib_get_node (vm, node_index);
909 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
912 /* Must be in main thread */
913 ASSERT (vlib_get_thread_index () == 0);
915 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
918 vlib_process_event_type_t *et =
919 vlib_process_new_event_type (p, type_opaque);
920 t = et - p->event_type_pool;
921 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
926 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
931 vlib_process_signal_event_at_time (vlib_main_t * vm,
935 uword n_data_elts, uword n_data_elt_bytes)
937 vlib_node_main_t *nm = &vm->node_main;
938 vlib_node_t *n = vlib_get_node (vm, node_index);
939 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
942 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
945 vlib_process_event_type_t *et =
946 vlib_process_new_event_type (p, type_opaque);
947 t = et - p->event_type_pool;
948 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
953 if (vlib_process_suspend_time_is_zero (dt))
954 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
958 vlib_signal_timed_event_data_t *te;
960 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
962 te->n_data_elts = n_data_elts;
963 te->n_data_elt_bytes = n_data_elt_bytes;
964 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
966 /* Assert that structure fields are big enough. */
967 ASSERT (te->n_data_elts == n_data_elts);
968 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
969 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
971 te->process_node_index = n->runtime_index;
972 te->event_type_index = t;
974 p->stop_timer_handle =
975 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
976 vlib_timing_wheel_data_set_timed_event
977 (te - nm->signal_timed_event_data_pool),
979 (vlib_time_now (vm) + dt) * 1e5);
981 /* Inline data big enough to hold event? */
982 if (te->n_data_bytes < sizeof (te->inline_event_data))
983 return te->inline_event_data;
986 te->event_data_as_vector = 0;
987 vec_resize (te->event_data_as_vector, te->n_data_bytes);
988 return te->event_data_as_vector;
994 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
998 uword n_data_elt_bytes)
1000 vlib_node_main_t *nm = &vm->node_main;
1001 vlib_node_t *n = vlib_get_node (vm, node_index);
1002 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1003 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
1008 vlib_process_signal_event (vlib_main_t * vm,
1009 uword node_index, uword type_opaque, uword data)
1011 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1012 1 /* elts */ , sizeof (uword));
1017 vlib_process_signal_event_pointer (vlib_main_t * vm,
1019 uword type_opaque, void *data)
1021 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1022 1 /* elts */ , sizeof (data));
1027 * Signal event to process from any thread.
1029 * When in doubt, use this.
1032 vlib_process_signal_event_mt (vlib_main_t * vm,
1033 uword node_index, uword type_opaque, uword data)
1035 if (vlib_get_thread_index () != 0)
1037 vlib_process_signal_event_mt_args_t args = {
1038 .node_index = node_index,
1039 .type_opaque = type_opaque,
1042 vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
1043 (u8 *) & args, sizeof (args));
1046 vlib_process_signal_event (vm, node_index, type_opaque, data);
1050 vlib_process_signal_one_time_event (vlib_main_t * vm,
1052 uword type_index, uword data)
1055 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1056 1 /* elts */ , sizeof (uword));
1061 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1062 vlib_one_time_waiting_process_t * p)
1064 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1066 clib_memset (p, ~0, sizeof (p[0]));
1070 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1071 vlib_one_time_waiting_process_t
1074 vlib_one_time_waiting_process_t *wp;
1075 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1080 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1081 vlib_one_time_waiting_process_t
1084 p->node_index = vlib_current_process (vm);
1085 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1087 vlib_process_wait_for_one_time_event (vm,
1088 /* don't care about data */ 0,
1093 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1094 vlib_one_time_waiting_process_t
1097 vlib_one_time_waiting_process_t *wp;
1098 vec_add2 (*wps, wp, 1);
1099 vlib_current_process_wait_for_one_time_event (vm, wp);
1103 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1104 vlib_node_runtime_t * node,
1110 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1111 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1112 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1115 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1117 (node->main_loop_count_last_dispatch >>
1118 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1119 vi0 = node->main_loop_vector_stats[i0];
1120 vi1 = node->main_loop_vector_stats[i1];
1121 vi0 = d == 0 ? vi0 : 0;
1122 vi1 = d <= 1 ? vi1 : 0;
1124 node->main_loop_vector_stats[i0] = vi0;
1125 node->main_loop_vector_stats[i1] = vi1;
1126 node->main_loop_count_last_dispatch = vm->main_loop_count;
1127 /* Return previous counter. */
1128 return node->main_loop_vector_stats[i1];
1132 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1134 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1137 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1139 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1143 vlib_node_vectors_per_main_loop_as_integer (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 v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1154 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1156 /* Return the edge index if present, ~0 otherwise */
1157 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1159 /* Add next node to given node in given slot. */
1161 vlib_node_add_next_with_slot (vlib_main_t * vm,
1162 uword node, uword next_node, uword slot);
1164 /* As above but adds to end of node's next vector. */
1166 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1168 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1171 /* Add next node to given node in given slot. */
1173 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1174 uword node, char *next_name, uword slot);
1176 /* As above but adds to end of node's next vector. */
1178 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1180 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1187 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1188 int barrier_sync, vlib_node_t **** node_dupsp,
1189 vlib_main_t *** stat_vmsp);
1191 /* Query node given name. */
1192 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1194 /* Rename a node. */
1195 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1197 /* Register new packet processing node. Nodes can be registered
1198 dynamically via this call or statically via the VLIB_REGISTER_NODE
1200 u32 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r);
1202 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1203 void vlib_register_all_static_nodes (vlib_main_t * vm);
1205 /* Start a process. */
1206 void vlib_start_process (vlib_main_t * vm, uword process_index);
1208 /* Sync up runtime and main node stats. */
1209 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1211 /* Node graph initialization function. */
1212 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1214 format_function_t format_vlib_node_graph;
1215 format_function_t format_vlib_node_name;
1216 format_function_t format_vlib_next_node_name;
1217 format_function_t format_vlib_node_and_next;
1218 format_function_t format_vlib_cpu_time;
1219 format_function_t format_vlib_time;
1220 /* Parse node name -> node index. */
1221 unformat_function_t unformat_vlib_node;
1224 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1225 u32 counter_index, u64 increment)
1227 vlib_node_t *n = vlib_get_node (vm, node_index);
1228 vlib_error_main_t *em = &vm->error_main;
1229 u32 node_counter_base_index = n->error_heap_index;
1230 em->counters[node_counter_base_index + counter_index] += increment;
1233 /** @brief Create a vlib process
1234 * @param vm &vlib_global_main
1235 * @param f the process node function
1236 * @param log2_n_stack_bytes size of the process stack, defaults to 16K
1237 * @return newly-create node index
1238 * @warning call only on the main thread. Barrier sync required
1240 u32 vlib_process_create (vlib_main_t * vm, char *name,
1241 vlib_node_function_t * f, u32 log2_n_stack_bytes);
1243 #endif /* included_vlib_node_funcs_h */
1246 * fd.io coding-style-patch-verification: ON
1249 * eval: (c-set-style "gnu")