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 (r->runtime_data, n->runtime_data, vec_len (n->runtime_data));
141 /** \brief Set node dispatch state.
142 @param vm vlib_main_t pointer, varies by thread
143 @param node_index index of the node
144 @param new_state new state for node, see vlib_node_state_t
147 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
148 vlib_node_state_t new_state)
150 vlib_node_main_t *nm = &vm->node_main;
152 vlib_node_runtime_t *r;
154 n = vec_elt (nm->nodes, node_index);
155 if (n->type == VLIB_NODE_TYPE_PROCESS)
157 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
158 r = &p->node_runtime;
160 /* When disabling make sure flags are cleared. */
161 p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
162 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
163 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
166 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
168 ASSERT (new_state < VLIB_N_NODE_STATE);
170 if (n->type == VLIB_NODE_TYPE_INPUT)
172 ASSERT (nm->input_node_counts_by_state[n->state] > 0);
173 nm->input_node_counts_by_state[n->state] -= 1;
174 nm->input_node_counts_by_state[new_state] += 1;
177 n->state = new_state;
178 r->state = new_state;
181 /** \brief Get node dispatch state.
182 @param vm vlib_main_t pointer, varies by thread
183 @param node_index index of the node
184 @return state for node, see vlib_node_state_t
186 always_inline vlib_node_state_t
187 vlib_node_get_state (vlib_main_t * vm, u32 node_index)
189 vlib_node_main_t *nm = &vm->node_main;
191 n = vec_elt (nm->nodes, node_index);
196 vlib_node_set_interrupt_pending (vlib_main_t * vm, u32 node_index)
198 vlib_node_main_t *nm = &vm->node_main;
199 vlib_node_t *n = vec_elt (nm->nodes, node_index);
200 ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
201 clib_spinlock_lock_if_init (&nm->pending_interrupt_lock);
202 vec_add1 (nm->pending_interrupt_node_runtime_indices, n->runtime_index);
203 clib_spinlock_unlock_if_init (&nm->pending_interrupt_lock);
206 always_inline vlib_process_t *
207 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
209 vlib_node_main_t *nm = &vm->node_main;
210 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
211 return vec_elt (nm->processes, node->runtime_index);
214 /* Fetches frame with given handle. */
215 always_inline vlib_frame_t *
216 vlib_get_frame_no_check (vlib_main_t * vm, uword frame_index)
219 u32 thread_index = frame_index & VLIB_CPU_MASK;
220 u32 offset = frame_index & VLIB_OFFSET_MASK;
221 vm = vlib_mains[thread_index];
222 f = vm->heap_base + offset;
227 vlib_frame_index_no_check (vlib_main_t * vm, vlib_frame_t * f)
231 ASSERT (((uword) f & VLIB_CPU_MASK) == 0);
233 vm = vlib_mains[f->thread_index];
235 i = ((u8 *) f - (u8 *) vm->heap_base);
236 return i | f->thread_index;
239 always_inline vlib_frame_t *
240 vlib_get_frame (vlib_main_t * vm, uword frame_index)
242 vlib_frame_t *f = vlib_get_frame_no_check (vm, frame_index);
243 ASSERT (f->flags & VLIB_FRAME_IS_ALLOCATED);
248 vlib_frame_index (vlib_main_t * vm, vlib_frame_t * f)
250 uword i = vlib_frame_index_no_check (vm, f);
251 ASSERT (vlib_get_frame (vm, i) == f);
255 /* Byte alignment for vector arguments. */
256 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
259 vlib_frame_vector_byte_offset (u32 scalar_size)
261 return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
262 VLIB_FRAME_VECTOR_ALIGN);
265 /** \brief Get pointer to frame vector data.
266 @param f vlib_frame_t pointer
267 @return pointer to first vector element in frame
270 vlib_frame_vector_args (vlib_frame_t * f)
272 return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
275 /** \brief Get pointer to frame scalar data.
277 @warning This is almost certainly not the function you wish to call.
278 See @ref vlib_frame_vector_args instead.
280 @param f vlib_frame_t pointer
282 @return arbitrary node scalar data
284 @sa vlib_frame_vector_args
287 vlib_frame_args (vlib_frame_t * f)
289 return vlib_frame_vector_args (f) - f->scalar_size;
292 always_inline vlib_next_frame_t *
293 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
294 vlib_node_runtime_t * n, u32 next_index)
296 vlib_node_main_t *nm = &vm->node_main;
297 vlib_next_frame_t *nf;
299 ASSERT (next_index < n->n_next_nodes);
300 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
304 vlib_node_t *node, *next;
305 node = vec_elt (nm->nodes, n->node_index);
306 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
307 ASSERT (nf->node_runtime_index == next->runtime_index);
313 /** \brief Get pointer to frame by (@c node_index, @c next_index).
315 @warning This is not a function that you should call directly.
316 See @ref vlib_get_next_frame instead.
318 @param vm vlib_main_t pointer, varies by thread
319 @param node_index index of the node
320 @param next_index graph arc index
322 @return pointer to the requested vlib_next_frame_t
324 @sa vlib_get_next_frame
327 always_inline vlib_next_frame_t *
328 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
330 vlib_node_main_t *nm = &vm->node_main;
332 vlib_node_runtime_t *r;
334 n = vec_elt (nm->nodes, node_index);
335 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
336 return vlib_node_runtime_get_next_frame (vm, r, next_index);
339 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
340 vlib_node_runtime_t * node,
342 u32 alloc_new_frame);
344 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
347 = vlib_get_next_frame_internal ((vm), (node), (next_index), \
348 (alloc_new_frame)); \
349 u32 _n = _f->n_vectors; \
350 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
351 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
355 /** \brief Get pointer to next frame vector data by
356 (@c vlib_node_runtime_t, @c next_index).
357 Standard single/dual loop boilerplate element.
358 @attention This is a MACRO, with SIDE EFFECTS.
360 @param vm vlib_main_t pointer, varies by thread
361 @param node current node vlib_node_runtime_t pointer
362 @param next_index requested graph arc index
364 @return @c vectors -- pointer to next available vector slot
365 @return @c n_vectors_left -- number of vector slots available
367 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left) \
368 vlib_get_next_frame_macro (vm, node, next_index, \
369 vectors, n_vectors_left, \
370 /* alloc new frame */ 0)
372 #define vlib_get_new_next_frame(vm,node,next_index,vectors,n_vectors_left) \
373 vlib_get_next_frame_macro (vm, node, next_index, \
374 vectors, n_vectors_left, \
375 /* alloc new frame */ 1)
377 /** \brief Release pointer to next frame vector data.
378 Standard single/dual loop boilerplate element.
379 @param vm vlib_main_t pointer, varies by thread
380 @param r current node vlib_node_runtime_t pointer
381 @param next_index graph arc index
382 @param n_packets_left number of slots still available in vector
385 vlib_put_next_frame (vlib_main_t * vm,
386 vlib_node_runtime_t * r,
387 u32 next_index, u32 n_packets_left);
389 /* Combination get plus put. Returns vector argument just added. */
390 #define vlib_set_next_frame(vm,node,next_index,v) \
393 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
394 ASSERT (_n_left > 0); \
395 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
400 vlib_set_next_frame_buffer (vlib_main_t * vm,
401 vlib_node_runtime_t * node,
402 u32 next_index, u32 buffer_index)
405 p = vlib_set_next_frame (vm, node, next_index, p);
409 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
410 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
413 always_inline vlib_process_t *
414 vlib_get_current_process (vlib_main_t * vm)
416 vlib_node_main_t *nm = &vm->node_main;
417 return vec_elt (nm->processes, nm->current_process_index);
421 vlib_in_process_context (vlib_main_t * vm)
423 return vm->node_main.current_process_index != ~0;
427 vlib_current_process (vlib_main_t * vm)
429 return vlib_get_current_process (vm)->node_runtime.node_index;
432 /** Returns TRUE if a process suspend time is less than 10us
433 @param dt - remaining poll time in seconds
434 @returns 1 if dt < 10e-6, 0 otherwise
437 vlib_process_suspend_time_is_zero (f64 dt)
442 /** Suspend a vlib cooperative multi-tasking thread for a period of time
443 @param vm - vlib_main_t *
444 @param dt - suspend interval in seconds
445 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
449 vlib_process_suspend (vlib_main_t * vm, f64 dt)
452 vlib_node_main_t *nm = &vm->node_main;
453 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
455 if (vlib_process_suspend_time_is_zero (dt))
456 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
458 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
459 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
460 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
462 /* expiration time in 10us ticks */
463 p->resume_clock_interval = dt * 1e5;
464 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
471 vlib_process_free_event_type (vlib_process_t * p, uword t,
472 uword is_one_time_event)
474 ASSERT (!pool_is_free_index (p->event_type_pool, t));
475 pool_put_index (p->event_type_pool, t);
476 if (is_one_time_event)
477 p->one_time_event_type_bitmap =
478 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
482 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
484 ASSERT (!pool_is_free_index (p->event_type_pool, t));
485 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
486 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
490 vlib_process_get_event_data (vlib_main_t * vm,
491 uword * return_event_type_opaque)
493 vlib_node_main_t *nm = &vm->node_main;
495 vlib_process_event_type_t *et;
497 void *event_data_vector;
499 p = vec_elt (nm->processes, nm->current_process_index);
501 /* Find first type with events ready.
502 Return invalid type when there's nothing there. */
503 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
507 p->non_empty_event_type_bitmap =
508 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
510 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
511 event_data_vector = p->pending_event_data_by_type_index[t];
512 p->pending_event_data_by_type_index[t] = 0;
514 et = pool_elt_at_index (p->event_type_pool, t);
516 /* Return user's opaque value and possibly index. */
517 *return_event_type_opaque = et->opaque;
519 vlib_process_maybe_free_event_type (p, t);
521 return event_data_vector;
524 /* Return event data vector for later reuse. We reuse event data to avoid
525 repeatedly allocating event vectors in cases where we care about speed. */
527 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
529 vlib_node_main_t *nm = &vm->node_main;
530 vec_add1 (nm->recycled_event_data_vectors, event_data);
533 /** Return the first event type which has occurred and a vector of per-event
534 data of that type, or a timeout indication
536 @param vm - vlib_main_t pointer
537 @param data_vector - pointer to a (uword *) vector to receive event data
538 @returns either an event type and a vector of per-event instance data,
539 or ~0 to indicate a timeout.
543 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
545 vlib_node_main_t *nm = &vm->node_main;
547 vlib_process_event_type_t *et;
550 p = vec_elt (nm->processes, nm->current_process_index);
552 /* Find first type with events ready.
553 Return invalid type when there's nothing there. */
554 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
558 p->non_empty_event_type_bitmap =
559 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
561 l = _vec_len (p->pending_event_data_by_type_index[t]);
563 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
564 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
566 et = pool_elt_at_index (p->event_type_pool, t);
568 /* Return user's opaque value. */
571 vlib_process_maybe_free_event_type (p, t);
577 vlib_process_get_events_helper (vlib_process_t * p, uword t,
578 uword ** data_vector)
582 p->non_empty_event_type_bitmap =
583 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
585 l = _vec_len (p->pending_event_data_by_type_index[t]);
587 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
588 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
590 vlib_process_maybe_free_event_type (p, t);
595 /* As above but query as specified type of event. Returns number of
598 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
599 uword with_type_opaque)
601 vlib_node_main_t *nm = &vm->node_main;
605 p = vec_elt (nm->processes, nm->current_process_index);
606 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
608 /* This can happen when an event has not yet been
609 signaled with given opaque type. */
613 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
616 return vlib_process_get_events_helper (p, t, data_vector);
619 always_inline uword *
620 vlib_process_wait_for_event (vlib_main_t * vm)
622 vlib_node_main_t *nm = &vm->node_main;
626 p = vec_elt (nm->processes, nm->current_process_index);
627 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
629 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
631 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
632 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
633 clib_longjmp (&p->return_longjmp,
634 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
637 return p->non_empty_event_type_bitmap;
641 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
642 uword ** data_vector,
643 uword with_type_index)
645 vlib_node_main_t *nm = &vm->node_main;
649 p = vec_elt (nm->processes, nm->current_process_index);
650 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
651 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
653 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
655 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
656 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
657 clib_longjmp (&p->return_longjmp,
658 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
661 return vlib_process_get_events_helper (p, with_type_index, data_vector);
665 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
666 uword ** data_vector,
667 uword with_type_opaque)
669 vlib_node_main_t *nm = &vm->node_main;
673 p = vec_elt (nm->processes, nm->current_process_index);
674 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
675 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
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)
681 clib_longjmp (&p->return_longjmp,
682 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
684 /* See if unknown event type has been signaled now. */
686 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
689 return vlib_process_get_events_helper (p, h[0], data_vector);
692 /** Suspend a cooperative multi-tasking thread
693 Waits for an event, or for the indicated number of seconds to elapse
694 @param vm - vlib_main_t pointer
695 @param dt - timeout, in seconds.
696 @returns the remaining time interval
700 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
702 vlib_node_main_t *nm = &vm->node_main;
707 p = vec_elt (nm->processes, nm->current_process_index);
709 if (vlib_process_suspend_time_is_zero (dt)
710 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
713 wakeup_time = vlib_time_now (vm) + dt;
715 /* Suspend waiting for both clock and event to occur. */
716 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
717 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
719 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
720 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
722 p->resume_clock_interval = dt * 1e5;
723 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
726 /* Return amount of time still left to sleep.
727 If <= 0 then we've been waken up by the clock (and not an event). */
728 return wakeup_time - vlib_time_now (vm);
731 always_inline vlib_process_event_type_t *
732 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
734 vlib_process_event_type_t *et;
735 pool_get (p->event_type_pool, et);
736 et->opaque = with_type_opaque;
741 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
742 uword with_type_opaque)
744 vlib_node_main_t *nm = &vm->node_main;
745 vlib_node_t *n = vlib_get_node (vm, node_index);
746 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
747 vlib_process_event_type_t *et;
750 et = vlib_process_new_event_type (p, with_type_opaque);
751 t = et - p->event_type_pool;
752 p->one_time_event_type_bitmap =
753 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
758 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
761 vlib_node_main_t *nm = &vm->node_main;
762 vlib_node_t *n = vlib_get_node (vm, node_index);
763 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
765 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
766 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
770 vlib_process_signal_event_helper (vlib_node_main_t * nm,
774 uword n_data_elts, uword n_data_elt_bytes)
776 uword p_flags, add_to_pending, delete_from_wheel;
777 void *data_to_be_written_by_caller;
779 ASSERT (!pool_is_free_index (p->event_type_pool, t));
781 vec_validate (p->pending_event_data_by_type_index, t);
783 /* Resize data vector and return caller's data to be written. */
785 void *data_vec = p->pending_event_data_by_type_index[t];
788 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
790 data_vec = vec_pop (nm->recycled_event_data_vectors);
791 _vec_len (data_vec) = 0;
794 l = vec_len (data_vec);
796 data_vec = _vec_resize (data_vec,
797 /* length_increment */ n_data_elts,
798 /* total size after increment */
799 (l + n_data_elts) * n_data_elt_bytes,
800 /* header_bytes */ 0, /* data_align */ 0);
802 p->pending_event_data_by_type_index[t] = data_vec;
803 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
806 p->non_empty_event_type_bitmap =
807 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
811 /* Event was already signalled? */
812 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
814 /* Process will resume when suspend time elapses? */
815 delete_from_wheel = 0;
816 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
818 /* Waiting for both event and clock? */
819 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
820 delete_from_wheel = 1;
822 /* Waiting only for clock. Event will be queue and may be
823 handled when timer expires. */
827 /* Never add current process to pending vector since current process is
829 add_to_pending &= nm->current_process_index != n->runtime_index;
833 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
834 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
835 vec_add1 (nm->data_from_advancing_timing_wheel, x);
836 if (delete_from_wheel)
837 TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
838 p->stop_timer_handle);
841 return data_to_be_written_by_caller;
845 vlib_process_signal_event_data (vlib_main_t * vm,
848 uword n_data_elts, uword n_data_elt_bytes)
850 vlib_node_main_t *nm = &vm->node_main;
851 vlib_node_t *n = vlib_get_node (vm, node_index);
852 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
855 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
858 vlib_process_event_type_t *et =
859 vlib_process_new_event_type (p, type_opaque);
860 t = et - p->event_type_pool;
861 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
866 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
871 vlib_process_signal_event_at_time (vlib_main_t * vm,
875 uword n_data_elts, uword n_data_elt_bytes)
877 vlib_node_main_t *nm = &vm->node_main;
878 vlib_node_t *n = vlib_get_node (vm, node_index);
879 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
882 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
885 vlib_process_event_type_t *et =
886 vlib_process_new_event_type (p, type_opaque);
887 t = et - p->event_type_pool;
888 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
893 if (vlib_process_suspend_time_is_zero (dt))
894 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
898 vlib_signal_timed_event_data_t *te;
900 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
902 te->n_data_elts = n_data_elts;
903 te->n_data_elt_bytes = n_data_elt_bytes;
904 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
906 /* Assert that structure fields are big enough. */
907 ASSERT (te->n_data_elts == n_data_elts);
908 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
909 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
911 te->process_node_index = n->runtime_index;
912 te->event_type_index = t;
914 p->stop_timer_handle =
915 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
916 vlib_timing_wheel_data_set_timed_event
917 (te - nm->signal_timed_event_data_pool),
919 (vlib_time_now (vm) + dt) * 1e5);
921 /* Inline data big enough to hold event? */
922 if (te->n_data_bytes < sizeof (te->inline_event_data))
923 return te->inline_event_data;
926 te->event_data_as_vector = 0;
927 vec_resize (te->event_data_as_vector, te->n_data_bytes);
928 return te->event_data_as_vector;
934 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
938 uword n_data_elt_bytes)
940 vlib_node_main_t *nm = &vm->node_main;
941 vlib_node_t *n = vlib_get_node (vm, node_index);
942 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
943 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
948 vlib_process_signal_event (vlib_main_t * vm,
949 uword node_index, uword type_opaque, uword data)
951 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
952 1 /* elts */ , sizeof (uword));
957 vlib_process_signal_event_pointer (vlib_main_t * vm,
959 uword type_opaque, void *data)
961 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
962 1 /* elts */ , sizeof (data));
967 vlib_process_signal_one_time_event (vlib_main_t * vm,
969 uword type_index, uword data)
972 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
973 1 /* elts */ , sizeof (uword));
978 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
979 vlib_one_time_waiting_process_t * p)
981 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
983 memset (p, ~0, sizeof (p[0]));
987 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
988 vlib_one_time_waiting_process_t
991 vlib_one_time_waiting_process_t *wp;
992 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
997 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
998 vlib_one_time_waiting_process_t
1001 p->node_index = vlib_current_process (vm);
1002 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1004 vlib_process_wait_for_one_time_event (vm,
1005 /* don't care about data */ 0,
1010 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1011 vlib_one_time_waiting_process_t
1014 vlib_one_time_waiting_process_t *wp;
1015 vec_add2 (*wps, wp, 1);
1016 vlib_current_process_wait_for_one_time_event (vm, wp);
1020 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1021 vlib_node_runtime_t * node,
1027 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1028 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1029 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1032 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1034 (node->main_loop_count_last_dispatch >>
1035 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1036 vi0 = node->main_loop_vector_stats[i0];
1037 vi1 = node->main_loop_vector_stats[i1];
1038 vi0 = d == 0 ? vi0 : 0;
1039 vi1 = d <= 1 ? vi1 : 0;
1041 node->main_loop_vector_stats[i0] = vi0;
1042 node->main_loop_vector_stats[i1] = vi1;
1043 node->main_loop_count_last_dispatch = vm->main_loop_count;
1044 /* Return previous counter. */
1045 return node->main_loop_vector_stats[i1];
1049 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1051 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1054 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1056 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1060 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1062 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1065 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1067 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1071 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1073 /* Return the edge index if present, ~0 otherwise */
1074 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1076 /* Add next node to given node in given slot. */
1078 vlib_node_add_next_with_slot (vlib_main_t * vm,
1079 uword node, uword next_node, uword slot);
1081 /* As above but adds to end of node's next vector. */
1083 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1085 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1088 /* Add next node to given node in given slot. */
1090 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1091 uword node, char *next_name, uword slot);
1093 /* As above but adds to end of node's next vector. */
1095 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1097 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1100 /* Query node given name. */
1101 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1103 /* Rename a node. */
1104 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1106 /* Register new packet processing node. Nodes can be registered
1107 dynamically via this call or statically via the VLIB_REGISTER_NODE
1109 u32 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r);
1111 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1112 void vlib_register_all_static_nodes (vlib_main_t * vm);
1114 /* Start a process. */
1115 void vlib_start_process (vlib_main_t * vm, uword process_index);
1117 /* Sync up runtime and main node stats. */
1118 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1120 /* Node graph initialization function. */
1121 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1123 format_function_t format_vlib_node_graph;
1124 format_function_t format_vlib_node_name;
1125 format_function_t format_vlib_next_node_name;
1126 format_function_t format_vlib_node_and_next;
1127 format_function_t format_vlib_cpu_time;
1128 format_function_t format_vlib_time;
1129 /* Parse node name -> node index. */
1130 unformat_function_t unformat_vlib_node;
1133 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1134 u32 counter_index, u64 increment)
1136 vlib_node_t *n = vlib_get_node (vm, node_index);
1137 vlib_error_main_t *em = &vm->error_main;
1138 u32 node_counter_base_index = n->error_heap_index;
1139 em->counters[node_counter_base_index + counter_index] += increment;
1142 #endif /* included_vlib_node_funcs_h */
1145 * fd.io coding-style-patch-verification: ON
1148 * eval: (c-set-style "gnu")