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 /** \brief Get vlib node by index.
52 @warning This function will ASSERT if @c i is out of range.
53 @param vm vlib_main_t pointer, varies by thread
55 @return pointer to the requested vlib_node_t.
58 always_inline vlib_node_t *
59 vlib_get_node (vlib_main_t * vm, u32 i)
61 return vec_elt (vm->node_main.nodes, i);
64 /** \brief Get vlib node by graph arc (next) index.
65 @param vm vlib_main_t pointer, varies by thread
66 @param node_index index of original node
67 @param next_index graph arc index
68 @return pointer to the vlib_node_t at the end of the indicated arc
71 always_inline vlib_node_t *
72 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
74 vlib_node_main_t *nm = &vm->node_main;
77 n = vec_elt (nm->nodes, node_index);
78 ASSERT (next_index < vec_len (n->next_nodes));
79 return vlib_get_node (vm, n->next_nodes[next_index]);
82 /** \brief Get node runtime by node index.
83 @param vm vlib_main_t pointer, varies by thread
84 @param node_index index of node
85 @return pointer to the indicated vlib_node_runtime_t
88 always_inline vlib_node_runtime_t *
89 vlib_node_get_runtime (vlib_main_t * vm, u32 node_index)
91 vlib_node_main_t *nm = &vm->node_main;
92 vlib_node_t *n = vec_elt (nm->nodes, node_index);
94 if (n->type != VLIB_NODE_TYPE_PROCESS)
95 return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
98 p = vec_elt (nm->processes, n->runtime_index);
99 return &p->node_runtime;
103 /** \brief Get node runtime private data by node index.
104 @param vm vlib_main_t pointer, varies by thread
105 @param node_index index of the node
106 @return pointer to the indicated vlib_node_runtime_t private data
110 vlib_node_get_runtime_data (vlib_main_t * vm, u32 node_index)
112 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
113 return r->runtime_data;
116 /** \brief Set node runtime private data.
117 @param vm vlib_main_t pointer, varies by thread
118 @param node_index index of the node
119 @param runtime_data arbitrary runtime private data
120 @param n_runtime_data_bytes size of runtime private data
124 vlib_node_set_runtime_data (vlib_main_t * vm, u32 node_index,
125 void *runtime_data, u32 n_runtime_data_bytes)
127 vlib_node_t *n = vlib_get_node (vm, node_index);
128 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
130 n->runtime_data_bytes = n_runtime_data_bytes;
131 vec_free (n->runtime_data);
132 vec_add (n->runtime_data, runtime_data, n_runtime_data_bytes);
134 ASSERT (vec_len (n->runtime_data) <= sizeof (vlib_node_runtime_t) -
135 STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
137 if (vec_len (n->runtime_data) > 0)
138 clib_memcpy_fast (r->runtime_data, n->runtime_data,
139 vec_len (n->runtime_data));
142 /** \brief Set node dispatch state.
143 @param vm vlib_main_t pointer, varies by thread
144 @param node_index index of the node
145 @param new_state new state for node, see vlib_node_state_t
148 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
149 vlib_node_state_t new_state)
151 vlib_node_main_t *nm = &vm->node_main;
153 vlib_node_runtime_t *r;
155 n = vec_elt (nm->nodes, node_index);
156 if (n->type == VLIB_NODE_TYPE_PROCESS)
158 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
159 r = &p->node_runtime;
161 /* When disabling make sure flags are cleared. */
162 p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
163 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
164 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
167 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
169 ASSERT (new_state < VLIB_N_NODE_STATE);
171 if (n->type == VLIB_NODE_TYPE_INPUT)
173 ASSERT (nm->input_node_counts_by_state[n->state] > 0);
174 nm->input_node_counts_by_state[n->state] -= 1;
175 nm->input_node_counts_by_state[new_state] += 1;
178 n->state = new_state;
179 r->state = new_state;
182 /** \brief Get node dispatch state.
183 @param vm vlib_main_t pointer, varies by thread
184 @param node_index index of the node
185 @return state for node, see vlib_node_state_t
187 always_inline vlib_node_state_t
188 vlib_node_get_state (vlib_main_t * vm, u32 node_index)
190 vlib_node_main_t *nm = &vm->node_main;
192 n = vec_elt (nm->nodes, node_index);
197 vlib_node_set_interrupt_pending (vlib_main_t * vm, u32 node_index)
199 vlib_node_main_t *nm = &vm->node_main;
200 vlib_node_t *n = vec_elt (nm->nodes, node_index);
201 ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
202 clib_spinlock_lock_if_init (&nm->pending_interrupt_lock);
203 vec_add1 (nm->pending_interrupt_node_runtime_indices, n->runtime_index);
204 clib_spinlock_unlock_if_init (&nm->pending_interrupt_lock);
207 always_inline vlib_process_t *
208 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
210 vlib_node_main_t *nm = &vm->node_main;
211 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
212 return vec_elt (nm->processes, node->runtime_index);
215 /* Fetches frame with given handle. */
216 always_inline vlib_frame_t *
217 vlib_get_frame_no_check (vlib_main_t * vm, uword frame_index)
220 f = vm->heap_aligned_base + (frame_index * VLIB_FRAME_ALIGN);
225 vlib_frame_index_no_check (vlib_main_t * vm, vlib_frame_t * f)
229 ASSERT (((uword) f & (VLIB_FRAME_ALIGN - 1)) == 0);
231 i = ((u8 *) f - (u8 *) vm->heap_aligned_base);
232 ASSERT ((i / VLIB_FRAME_ALIGN) <= 0xFFFFFFFFULL);
234 return i / VLIB_FRAME_ALIGN;
237 always_inline vlib_frame_t *
238 vlib_get_frame (vlib_main_t * vm, uword frame_index)
240 vlib_frame_t *f = vlib_get_frame_no_check (vm, frame_index);
241 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
246 vlib_frame_no_append (vlib_frame_t * f)
248 f->frame_flags |= VLIB_FRAME_NO_APPEND;
252 vlib_frame_index (vlib_main_t * vm, vlib_frame_t * f)
254 uword i = vlib_frame_index_no_check (vm, f);
255 ASSERT (vlib_get_frame (vm, i) == f);
259 /* Byte alignment for vector arguments. */
260 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
263 vlib_frame_vector_byte_offset (u32 scalar_size)
265 return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
266 VLIB_FRAME_VECTOR_ALIGN);
269 /** \brief Get pointer to frame vector data.
270 @param f vlib_frame_t pointer
271 @return pointer to first vector element in frame
274 vlib_frame_vector_args (vlib_frame_t * f)
276 return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
279 /** \brief Get pointer to frame scalar data.
281 @param f vlib_frame_t pointer
283 @return arbitrary node scalar data
285 @sa vlib_frame_vector_args
288 vlib_frame_scalar_args (vlib_frame_t * f)
290 return vlib_frame_vector_args (f) - f->scalar_size;
293 always_inline vlib_next_frame_t *
294 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
295 vlib_node_runtime_t * n, u32 next_index)
297 vlib_node_main_t *nm = &vm->node_main;
298 vlib_next_frame_t *nf;
300 ASSERT (next_index < n->n_next_nodes);
301 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
305 vlib_node_t *node, *next;
306 node = vec_elt (nm->nodes, n->node_index);
307 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
308 ASSERT (nf->node_runtime_index == next->runtime_index);
314 /** \brief Get pointer to frame by (@c node_index, @c next_index).
316 @warning This is not a function that you should call directly.
317 See @ref vlib_get_next_frame instead.
319 @param vm vlib_main_t pointer, varies by thread
320 @param node_index index of the node
321 @param next_index graph arc index
323 @return pointer to the requested vlib_next_frame_t
325 @sa vlib_get_next_frame
328 always_inline vlib_next_frame_t *
329 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
331 vlib_node_main_t *nm = &vm->node_main;
333 vlib_node_runtime_t *r;
335 n = vec_elt (nm->nodes, node_index);
336 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
337 return vlib_node_runtime_get_next_frame (vm, r, next_index);
340 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
341 vlib_node_runtime_t * node,
343 u32 alloc_new_frame);
345 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
348 = vlib_get_next_frame_internal ((vm), (node), (next_index), \
349 (alloc_new_frame)); \
350 u32 _n = _f->n_vectors; \
351 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
352 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
356 /** \brief Get pointer to next frame vector data by
357 (@c vlib_node_runtime_t, @c next_index).
358 Standard single/dual loop boilerplate element.
359 @attention This is a MACRO, with SIDE EFFECTS.
361 @param vm vlib_main_t pointer, varies by thread
362 @param node current node vlib_node_runtime_t pointer
363 @param next_index requested graph arc index
365 @return @c vectors -- pointer to next available vector slot
366 @return @c n_vectors_left -- number of vector slots available
368 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left) \
369 vlib_get_next_frame_macro (vm, node, next_index, \
370 vectors, n_vectors_left, \
371 /* alloc new frame */ 0)
373 #define vlib_get_new_next_frame(vm,node,next_index,vectors,n_vectors_left) \
374 vlib_get_next_frame_macro (vm, node, next_index, \
375 vectors, n_vectors_left, \
376 /* alloc new frame */ 1)
378 /** \brief Release pointer to next frame vector data.
379 Standard single/dual loop boilerplate element.
380 @param vm vlib_main_t pointer, varies by thread
381 @param r current node vlib_node_runtime_t pointer
382 @param next_index graph arc index
383 @param n_packets_left number of slots still available in vector
386 vlib_put_next_frame (vlib_main_t * vm,
387 vlib_node_runtime_t * r,
388 u32 next_index, u32 n_packets_left);
390 /* Combination get plus put. Returns vector argument just added. */
391 #define vlib_set_next_frame(vm,node,next_index,v) \
394 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
395 ASSERT (_n_left > 0); \
396 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
401 vlib_set_next_frame_buffer (vlib_main_t * vm,
402 vlib_node_runtime_t * node,
403 u32 next_index, u32 buffer_index)
406 p = vlib_set_next_frame (vm, node, next_index, p);
410 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
411 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
415 vlib_in_process_context (vlib_main_t * vm)
417 return vm->node_main.current_process_index != ~0;
420 always_inline vlib_process_t *
421 vlib_get_current_process (vlib_main_t * vm)
423 vlib_node_main_t *nm = &vm->node_main;
424 if (vlib_in_process_context (vm))
425 return vec_elt (nm->processes, nm->current_process_index);
430 vlib_current_process (vlib_main_t * vm)
432 return vlib_get_current_process (vm)->node_runtime.node_index;
435 /** Returns TRUE if a process suspend time is less than 10us
436 @param dt - remaining poll time in seconds
437 @returns 1 if dt < 10e-6, 0 otherwise
440 vlib_process_suspend_time_is_zero (f64 dt)
445 /** Suspend a vlib cooperative multi-tasking thread for a period of time
446 @param vm - vlib_main_t *
447 @param dt - suspend interval in seconds
448 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
452 vlib_process_suspend (vlib_main_t * vm, f64 dt)
455 vlib_node_main_t *nm = &vm->node_main;
456 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
458 if (vlib_process_suspend_time_is_zero (dt))
459 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
461 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
462 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
463 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
465 /* expiration time in 10us ticks */
466 p->resume_clock_interval = dt * 1e5;
467 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
474 vlib_process_free_event_type (vlib_process_t * p, uword t,
475 uword is_one_time_event)
477 ASSERT (!pool_is_free_index (p->event_type_pool, t));
478 pool_put_index (p->event_type_pool, t);
479 if (is_one_time_event)
480 p->one_time_event_type_bitmap =
481 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
485 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
487 ASSERT (!pool_is_free_index (p->event_type_pool, t));
488 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
489 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
493 vlib_process_get_event_data (vlib_main_t * vm,
494 uword * return_event_type_opaque)
496 vlib_node_main_t *nm = &vm->node_main;
498 vlib_process_event_type_t *et;
500 void *event_data_vector;
502 p = vec_elt (nm->processes, nm->current_process_index);
504 /* Find first type with events ready.
505 Return invalid type when there's nothing there. */
506 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
510 p->non_empty_event_type_bitmap =
511 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
513 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
514 event_data_vector = p->pending_event_data_by_type_index[t];
515 p->pending_event_data_by_type_index[t] = 0;
517 et = pool_elt_at_index (p->event_type_pool, t);
519 /* Return user's opaque value and possibly index. */
520 *return_event_type_opaque = et->opaque;
522 vlib_process_maybe_free_event_type (p, t);
524 return event_data_vector;
527 /* Return event data vector for later reuse. We reuse event data to avoid
528 repeatedly allocating event vectors in cases where we care about speed. */
530 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
532 vlib_node_main_t *nm = &vm->node_main;
533 vec_add1 (nm->recycled_event_data_vectors, event_data);
536 /** Return the first event type which has occurred and a vector of per-event
537 data of that type, or a timeout indication
539 @param vm - vlib_main_t pointer
540 @param data_vector - pointer to a (uword *) vector to receive event data
541 @returns either an event type and a vector of per-event instance data,
542 or ~0 to indicate a timeout.
546 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
548 vlib_node_main_t *nm = &vm->node_main;
550 vlib_process_event_type_t *et;
553 p = vec_elt (nm->processes, nm->current_process_index);
555 /* Find first type with events ready.
556 Return invalid type when there's nothing there. */
557 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
561 p->non_empty_event_type_bitmap =
562 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
564 l = _vec_len (p->pending_event_data_by_type_index[t]);
566 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
567 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
569 et = pool_elt_at_index (p->event_type_pool, t);
571 /* Return user's opaque value. */
574 vlib_process_maybe_free_event_type (p, t);
580 vlib_process_get_events_helper (vlib_process_t * p, uword t,
581 uword ** data_vector)
585 p->non_empty_event_type_bitmap =
586 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
588 l = _vec_len (p->pending_event_data_by_type_index[t]);
590 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
591 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
593 vlib_process_maybe_free_event_type (p, t);
598 /* As above but query as specified type of event. Returns number of
601 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
602 uword with_type_opaque)
604 vlib_node_main_t *nm = &vm->node_main;
608 p = vec_elt (nm->processes, nm->current_process_index);
609 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
611 /* This can happen when an event has not yet been
612 signaled with given opaque type. */
616 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
619 return vlib_process_get_events_helper (p, t, data_vector);
622 always_inline uword *
623 vlib_process_wait_for_event (vlib_main_t * vm)
625 vlib_node_main_t *nm = &vm->node_main;
629 p = vec_elt (nm->processes, nm->current_process_index);
630 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
632 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
634 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
635 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
636 clib_longjmp (&p->return_longjmp,
637 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
640 return p->non_empty_event_type_bitmap;
644 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
645 uword ** data_vector,
646 uword with_type_index)
648 vlib_node_main_t *nm = &vm->node_main;
652 p = vec_elt (nm->processes, nm->current_process_index);
653 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
654 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
656 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
658 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
659 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
660 clib_longjmp (&p->return_longjmp,
661 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
664 return vlib_process_get_events_helper (p, with_type_index, data_vector);
668 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
669 uword ** data_vector,
670 uword with_type_opaque)
672 vlib_node_main_t *nm = &vm->node_main;
676 p = vec_elt (nm->processes, nm->current_process_index);
677 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
678 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
680 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
682 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
683 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
684 clib_longjmp (&p->return_longjmp,
685 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
687 /* See if unknown event type has been signaled now. */
689 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
692 return vlib_process_get_events_helper (p, h[0], data_vector);
695 /** Suspend a cooperative multi-tasking thread
696 Waits for an event, or for the indicated number of seconds to elapse
697 @param vm - vlib_main_t pointer
698 @param dt - timeout, in seconds.
699 @returns the remaining time interval
703 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
705 vlib_node_main_t *nm = &vm->node_main;
710 p = vec_elt (nm->processes, nm->current_process_index);
712 if (vlib_process_suspend_time_is_zero (dt)
713 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
716 wakeup_time = vlib_time_now (vm) + dt;
718 /* Suspend waiting for both clock and event to occur. */
719 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
720 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
722 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
723 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
725 p->resume_clock_interval = dt * 1e5;
726 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
729 /* Return amount of time still left to sleep.
730 If <= 0 then we've been waken up by the clock (and not an event). */
731 return wakeup_time - vlib_time_now (vm);
734 always_inline vlib_process_event_type_t *
735 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
737 vlib_process_event_type_t *et;
738 pool_get (p->event_type_pool, et);
739 et->opaque = with_type_opaque;
744 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
745 uword with_type_opaque)
747 vlib_node_main_t *nm = &vm->node_main;
748 vlib_node_t *n = vlib_get_node (vm, node_index);
749 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
750 vlib_process_event_type_t *et;
753 et = vlib_process_new_event_type (p, with_type_opaque);
754 t = et - p->event_type_pool;
755 p->one_time_event_type_bitmap =
756 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
761 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
764 vlib_node_main_t *nm = &vm->node_main;
765 vlib_node_t *n = vlib_get_node (vm, node_index);
766 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
768 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
769 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
773 vlib_process_signal_event_helper (vlib_node_main_t * nm,
777 uword n_data_elts, uword n_data_elt_bytes)
779 uword p_flags, add_to_pending, delete_from_wheel;
780 void *data_to_be_written_by_caller;
782 ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
784 ASSERT (!pool_is_free_index (p->event_type_pool, t));
786 vec_validate (p->pending_event_data_by_type_index, t);
788 /* Resize data vector and return caller's data to be written. */
790 void *data_vec = p->pending_event_data_by_type_index[t];
793 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
795 data_vec = vec_pop (nm->recycled_event_data_vectors);
796 _vec_len (data_vec) = 0;
799 l = vec_len (data_vec);
801 data_vec = _vec_resize (data_vec,
802 /* length_increment */ n_data_elts,
803 /* total size after increment */
804 (l + n_data_elts) * n_data_elt_bytes,
805 /* header_bytes */ 0, /* data_align */ 0);
807 p->pending_event_data_by_type_index[t] = data_vec;
808 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
811 p->non_empty_event_type_bitmap =
812 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
816 /* Event was already signalled? */
817 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
819 /* Process will resume when suspend time elapses? */
820 delete_from_wheel = 0;
821 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
823 /* Waiting for both event and clock? */
824 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
826 if (!TW (tw_timer_handle_is_free)
827 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
828 p->stop_timer_handle))
829 delete_from_wheel = 1;
831 /* timer just popped so process should already be on the list */
835 /* Waiting only for clock. Event will be queue and may be
836 handled when timer expires. */
840 /* Never add current process to pending vector since current process is
842 add_to_pending &= nm->current_process_index != n->runtime_index;
846 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
847 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
848 vec_add1 (nm->data_from_advancing_timing_wheel, x);
849 if (delete_from_wheel)
850 TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
851 p->stop_timer_handle);
854 return data_to_be_written_by_caller;
858 vlib_process_signal_event_data (vlib_main_t * vm,
861 uword n_data_elts, uword n_data_elt_bytes)
863 vlib_node_main_t *nm = &vm->node_main;
864 vlib_node_t *n = vlib_get_node (vm, node_index);
865 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
868 /* Must be in main thread */
869 ASSERT (vlib_get_thread_index () == 0);
871 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
874 vlib_process_event_type_t *et =
875 vlib_process_new_event_type (p, type_opaque);
876 t = et - p->event_type_pool;
877 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
882 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
887 vlib_process_signal_event_at_time (vlib_main_t * vm,
891 uword n_data_elts, uword n_data_elt_bytes)
893 vlib_node_main_t *nm = &vm->node_main;
894 vlib_node_t *n = vlib_get_node (vm, node_index);
895 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
898 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
901 vlib_process_event_type_t *et =
902 vlib_process_new_event_type (p, type_opaque);
903 t = et - p->event_type_pool;
904 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
909 if (vlib_process_suspend_time_is_zero (dt))
910 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
914 vlib_signal_timed_event_data_t *te;
916 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
918 te->n_data_elts = n_data_elts;
919 te->n_data_elt_bytes = n_data_elt_bytes;
920 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
922 /* Assert that structure fields are big enough. */
923 ASSERT (te->n_data_elts == n_data_elts);
924 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
925 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
927 te->process_node_index = n->runtime_index;
928 te->event_type_index = t;
930 p->stop_timer_handle =
931 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
932 vlib_timing_wheel_data_set_timed_event
933 (te - nm->signal_timed_event_data_pool),
935 (vlib_time_now (vm) + dt) * 1e5);
937 /* Inline data big enough to hold event? */
938 if (te->n_data_bytes < sizeof (te->inline_event_data))
939 return te->inline_event_data;
942 te->event_data_as_vector = 0;
943 vec_resize (te->event_data_as_vector, te->n_data_bytes);
944 return te->event_data_as_vector;
950 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
954 uword n_data_elt_bytes)
956 vlib_node_main_t *nm = &vm->node_main;
957 vlib_node_t *n = vlib_get_node (vm, node_index);
958 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
959 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
964 vlib_process_signal_event (vlib_main_t * vm,
965 uword node_index, uword type_opaque, uword data)
967 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
968 1 /* elts */ , sizeof (uword));
973 vlib_process_signal_event_pointer (vlib_main_t * vm,
975 uword type_opaque, void *data)
977 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
978 1 /* elts */ , sizeof (data));
983 * Signal event to process from any thread.
985 * When in doubt, use this.
988 vlib_process_signal_event_mt (vlib_main_t * vm,
989 uword node_index, uword type_opaque, uword data)
991 if (vlib_get_thread_index () != 0)
993 vlib_process_signal_event_mt_args_t args = {
994 .node_index = node_index,
995 .type_opaque = type_opaque,
998 vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
999 (u8 *) & args, sizeof (args));
1002 vlib_process_signal_event (vm, node_index, type_opaque, data);
1006 vlib_process_signal_one_time_event (vlib_main_t * vm,
1008 uword type_index, uword data)
1011 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1012 1 /* elts */ , sizeof (uword));
1017 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1018 vlib_one_time_waiting_process_t * p)
1020 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1022 clib_memset (p, ~0, sizeof (p[0]));
1026 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1027 vlib_one_time_waiting_process_t
1030 vlib_one_time_waiting_process_t *wp;
1031 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1036 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1037 vlib_one_time_waiting_process_t
1040 p->node_index = vlib_current_process (vm);
1041 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1043 vlib_process_wait_for_one_time_event (vm,
1044 /* don't care about data */ 0,
1049 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1050 vlib_one_time_waiting_process_t
1053 vlib_one_time_waiting_process_t *wp;
1054 vec_add2 (*wps, wp, 1);
1055 vlib_current_process_wait_for_one_time_event (vm, wp);
1059 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1060 vlib_node_runtime_t * node,
1066 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1067 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1068 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1071 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1073 (node->main_loop_count_last_dispatch >>
1074 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1075 vi0 = node->main_loop_vector_stats[i0];
1076 vi1 = node->main_loop_vector_stats[i1];
1077 vi0 = d == 0 ? vi0 : 0;
1078 vi1 = d <= 1 ? vi1 : 0;
1080 node->main_loop_vector_stats[i0] = vi0;
1081 node->main_loop_vector_stats[i1] = vi1;
1082 node->main_loop_count_last_dispatch = vm->main_loop_count;
1083 /* Return previous counter. */
1084 return node->main_loop_vector_stats[i1];
1088 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1090 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1093 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1095 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1099 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1101 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1104 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1106 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1110 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1112 /* Return the edge index if present, ~0 otherwise */
1113 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1115 /* Add next node to given node in given slot. */
1117 vlib_node_add_next_with_slot (vlib_main_t * vm,
1118 uword node, uword next_node, uword slot);
1120 /* As above but adds to end of node's next vector. */
1122 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1124 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1127 /* Add next node to given node in given slot. */
1129 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1130 uword node, char *next_name, uword slot);
1132 /* As above but adds to end of node's next vector. */
1134 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1136 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1143 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1144 int barrier_sync, vlib_node_t **** node_dupsp,
1145 vlib_main_t *** stat_vmsp);
1147 /* Query node given name. */
1148 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1150 /* Rename a node. */
1151 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1153 /* Register new packet processing node. Nodes can be registered
1154 dynamically via this call or statically via the VLIB_REGISTER_NODE
1156 u32 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r);
1158 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1159 void vlib_register_all_static_nodes (vlib_main_t * vm);
1161 /* Start a process. */
1162 void vlib_start_process (vlib_main_t * vm, uword process_index);
1164 /* Sync up runtime and main node stats. */
1165 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1167 /* Node graph initialization function. */
1168 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1170 format_function_t format_vlib_node_graph;
1171 format_function_t format_vlib_node_name;
1172 format_function_t format_vlib_next_node_name;
1173 format_function_t format_vlib_node_and_next;
1174 format_function_t format_vlib_cpu_time;
1175 format_function_t format_vlib_time;
1176 /* Parse node name -> node index. */
1177 unformat_function_t unformat_vlib_node;
1180 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1181 u32 counter_index, u64 increment)
1183 vlib_node_t *n = vlib_get_node (vm, node_index);
1184 vlib_error_main_t *em = &vm->error_main;
1185 u32 node_counter_base_index = n->error_heap_index;
1186 em->counters[node_counter_base_index + counter_index] += increment;
1189 /** @brief Create a vlib process
1190 * @param vm &vlib_global_main
1191 * @param f the process node function
1192 * @param log2_n_stack_bytes size of the process stack, defaults to 16K
1193 * @return newly-create node index
1194 * @warning call only on the main thread. Barrier sync required
1196 u32 vlib_process_create (vlib_main_t * vm, char *name,
1197 vlib_node_function_t * f, u32 log2_n_stack_bytes);
1199 #endif /* included_vlib_node_funcs_h */
1202 * fd.io coding-style-patch-verification: ON
1205 * eval: (c-set-style "gnu")