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_index (vlib_main_t * vm, vlib_frame_t * f)
248 uword i = vlib_frame_index_no_check (vm, f);
249 ASSERT (vlib_get_frame (vm, i) == f);
253 /* Byte alignment for vector arguments. */
254 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
257 vlib_frame_vector_byte_offset (u32 scalar_size)
259 return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
260 VLIB_FRAME_VECTOR_ALIGN);
263 /** \brief Get pointer to frame vector data.
264 @param f vlib_frame_t pointer
265 @return pointer to first vector element in frame
268 vlib_frame_vector_args (vlib_frame_t * f)
270 return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
273 /** \brief Get pointer to frame scalar data.
275 @param f vlib_frame_t pointer
277 @return arbitrary node scalar data
279 @sa vlib_frame_vector_args
282 vlib_frame_scalar_args (vlib_frame_t * f)
284 return vlib_frame_vector_args (f) - f->scalar_size;
287 always_inline vlib_next_frame_t *
288 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
289 vlib_node_runtime_t * n, u32 next_index)
291 vlib_node_main_t *nm = &vm->node_main;
292 vlib_next_frame_t *nf;
294 ASSERT (next_index < n->n_next_nodes);
295 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
299 vlib_node_t *node, *next;
300 node = vec_elt (nm->nodes, n->node_index);
301 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
302 ASSERT (nf->node_runtime_index == next->runtime_index);
308 /** \brief Get pointer to frame by (@c node_index, @c next_index).
310 @warning This is not a function that you should call directly.
311 See @ref vlib_get_next_frame instead.
313 @param vm vlib_main_t pointer, varies by thread
314 @param node_index index of the node
315 @param next_index graph arc index
317 @return pointer to the requested vlib_next_frame_t
319 @sa vlib_get_next_frame
322 always_inline vlib_next_frame_t *
323 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
325 vlib_node_main_t *nm = &vm->node_main;
327 vlib_node_runtime_t *r;
329 n = vec_elt (nm->nodes, node_index);
330 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
331 return vlib_node_runtime_get_next_frame (vm, r, next_index);
334 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
335 vlib_node_runtime_t * node,
337 u32 alloc_new_frame);
339 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
342 = vlib_get_next_frame_internal ((vm), (node), (next_index), \
343 (alloc_new_frame)); \
344 u32 _n = _f->n_vectors; \
345 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
346 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
350 /** \brief Get pointer to next frame vector data by
351 (@c vlib_node_runtime_t, @c next_index).
352 Standard single/dual loop boilerplate element.
353 @attention This is a MACRO, with SIDE EFFECTS.
355 @param vm vlib_main_t pointer, varies by thread
356 @param node current node vlib_node_runtime_t pointer
357 @param next_index requested graph arc index
359 @return @c vectors -- pointer to next available vector slot
360 @return @c n_vectors_left -- number of vector slots available
362 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left) \
363 vlib_get_next_frame_macro (vm, node, next_index, \
364 vectors, n_vectors_left, \
365 /* alloc new frame */ 0)
367 #define vlib_get_new_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 */ 1)
372 /** \brief Release pointer to next frame vector data.
373 Standard single/dual loop boilerplate element.
374 @param vm vlib_main_t pointer, varies by thread
375 @param r current node vlib_node_runtime_t pointer
376 @param next_index graph arc index
377 @param n_packets_left number of slots still available in vector
380 vlib_put_next_frame (vlib_main_t * vm,
381 vlib_node_runtime_t * r,
382 u32 next_index, u32 n_packets_left);
384 /* Combination get plus put. Returns vector argument just added. */
385 #define vlib_set_next_frame(vm,node,next_index,v) \
388 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
389 ASSERT (_n_left > 0); \
390 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
395 vlib_set_next_frame_buffer (vlib_main_t * vm,
396 vlib_node_runtime_t * node,
397 u32 next_index, u32 buffer_index)
400 p = vlib_set_next_frame (vm, node, next_index, p);
404 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
405 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
409 vlib_in_process_context (vlib_main_t * vm)
411 return vm->node_main.current_process_index != ~0;
414 always_inline vlib_process_t *
415 vlib_get_current_process (vlib_main_t * vm)
417 vlib_node_main_t *nm = &vm->node_main;
418 if (vlib_in_process_context (vm))
419 return vec_elt (nm->processes, nm->current_process_index);
424 vlib_current_process (vlib_main_t * vm)
426 return vlib_get_current_process (vm)->node_runtime.node_index;
429 /** Returns TRUE if a process suspend time is less than 10us
430 @param dt - remaining poll time in seconds
431 @returns 1 if dt < 10e-6, 0 otherwise
434 vlib_process_suspend_time_is_zero (f64 dt)
439 /** Suspend a vlib cooperative multi-tasking thread for a period of time
440 @param vm - vlib_main_t *
441 @param dt - suspend interval in seconds
442 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
446 vlib_process_suspend (vlib_main_t * vm, f64 dt)
449 vlib_node_main_t *nm = &vm->node_main;
450 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
452 if (vlib_process_suspend_time_is_zero (dt))
453 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
455 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
456 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
457 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
459 /* expiration time in 10us ticks */
460 p->resume_clock_interval = dt * 1e5;
461 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
468 vlib_process_free_event_type (vlib_process_t * p, uword t,
469 uword is_one_time_event)
471 ASSERT (!pool_is_free_index (p->event_type_pool, t));
472 pool_put_index (p->event_type_pool, t);
473 if (is_one_time_event)
474 p->one_time_event_type_bitmap =
475 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
479 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
481 ASSERT (!pool_is_free_index (p->event_type_pool, t));
482 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
483 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
487 vlib_process_get_event_data (vlib_main_t * vm,
488 uword * return_event_type_opaque)
490 vlib_node_main_t *nm = &vm->node_main;
492 vlib_process_event_type_t *et;
494 void *event_data_vector;
496 p = vec_elt (nm->processes, nm->current_process_index);
498 /* Find first type with events ready.
499 Return invalid type when there's nothing there. */
500 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
504 p->non_empty_event_type_bitmap =
505 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
507 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
508 event_data_vector = p->pending_event_data_by_type_index[t];
509 p->pending_event_data_by_type_index[t] = 0;
511 et = pool_elt_at_index (p->event_type_pool, t);
513 /* Return user's opaque value and possibly index. */
514 *return_event_type_opaque = et->opaque;
516 vlib_process_maybe_free_event_type (p, t);
518 return event_data_vector;
521 /* Return event data vector for later reuse. We reuse event data to avoid
522 repeatedly allocating event vectors in cases where we care about speed. */
524 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
526 vlib_node_main_t *nm = &vm->node_main;
527 vec_add1 (nm->recycled_event_data_vectors, event_data);
530 /** Return the first event type which has occurred and a vector of per-event
531 data of that type, or a timeout indication
533 @param vm - vlib_main_t pointer
534 @param data_vector - pointer to a (uword *) vector to receive event data
535 @returns either an event type and a vector of per-event instance data,
536 or ~0 to indicate a timeout.
540 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
542 vlib_node_main_t *nm = &vm->node_main;
544 vlib_process_event_type_t *et;
547 p = vec_elt (nm->processes, nm->current_process_index);
549 /* Find first type with events ready.
550 Return invalid type when there's nothing there. */
551 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
555 p->non_empty_event_type_bitmap =
556 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
558 l = _vec_len (p->pending_event_data_by_type_index[t]);
560 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
561 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
563 et = pool_elt_at_index (p->event_type_pool, t);
565 /* Return user's opaque value. */
568 vlib_process_maybe_free_event_type (p, t);
574 vlib_process_get_events_helper (vlib_process_t * p, uword t,
575 uword ** data_vector)
579 p->non_empty_event_type_bitmap =
580 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
582 l = _vec_len (p->pending_event_data_by_type_index[t]);
584 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
585 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
587 vlib_process_maybe_free_event_type (p, t);
592 /* As above but query as specified type of event. Returns number of
595 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
596 uword with_type_opaque)
598 vlib_node_main_t *nm = &vm->node_main;
602 p = vec_elt (nm->processes, nm->current_process_index);
603 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
605 /* This can happen when an event has not yet been
606 signaled with given opaque type. */
610 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
613 return vlib_process_get_events_helper (p, t, data_vector);
616 always_inline uword *
617 vlib_process_wait_for_event (vlib_main_t * vm)
619 vlib_node_main_t *nm = &vm->node_main;
623 p = vec_elt (nm->processes, nm->current_process_index);
624 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
626 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
628 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
629 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
630 clib_longjmp (&p->return_longjmp,
631 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
634 return p->non_empty_event_type_bitmap;
638 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
639 uword ** data_vector,
640 uword with_type_index)
642 vlib_node_main_t *nm = &vm->node_main;
646 p = vec_elt (nm->processes, nm->current_process_index);
647 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
648 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
650 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
652 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
653 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
654 clib_longjmp (&p->return_longjmp,
655 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
658 return vlib_process_get_events_helper (p, with_type_index, data_vector);
662 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
663 uword ** data_vector,
664 uword with_type_opaque)
666 vlib_node_main_t *nm = &vm->node_main;
670 p = vec_elt (nm->processes, nm->current_process_index);
671 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
672 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
674 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
676 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
677 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
678 clib_longjmp (&p->return_longjmp,
679 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
681 /* See if unknown event type has been signaled now. */
683 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
686 return vlib_process_get_events_helper (p, h[0], data_vector);
689 /** Suspend a cooperative multi-tasking thread
690 Waits for an event, or for the indicated number of seconds to elapse
691 @param vm - vlib_main_t pointer
692 @param dt - timeout, in seconds.
693 @returns the remaining time interval
697 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
699 vlib_node_main_t *nm = &vm->node_main;
704 p = vec_elt (nm->processes, nm->current_process_index);
706 if (vlib_process_suspend_time_is_zero (dt)
707 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
710 wakeup_time = vlib_time_now (vm) + dt;
712 /* Suspend waiting for both clock and event to occur. */
713 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
714 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
716 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
717 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
719 p->resume_clock_interval = dt * 1e5;
720 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
723 /* Return amount of time still left to sleep.
724 If <= 0 then we've been waken up by the clock (and not an event). */
725 return wakeup_time - vlib_time_now (vm);
728 always_inline vlib_process_event_type_t *
729 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
731 vlib_process_event_type_t *et;
732 pool_get (p->event_type_pool, et);
733 et->opaque = with_type_opaque;
738 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
739 uword with_type_opaque)
741 vlib_node_main_t *nm = &vm->node_main;
742 vlib_node_t *n = vlib_get_node (vm, node_index);
743 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
744 vlib_process_event_type_t *et;
747 et = vlib_process_new_event_type (p, with_type_opaque);
748 t = et - p->event_type_pool;
749 p->one_time_event_type_bitmap =
750 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
755 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
758 vlib_node_main_t *nm = &vm->node_main;
759 vlib_node_t *n = vlib_get_node (vm, node_index);
760 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
762 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
763 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
767 vlib_process_signal_event_helper (vlib_node_main_t * nm,
771 uword n_data_elts, uword n_data_elt_bytes)
773 uword p_flags, add_to_pending, delete_from_wheel;
774 void *data_to_be_written_by_caller;
776 ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
778 ASSERT (!pool_is_free_index (p->event_type_pool, t));
780 vec_validate (p->pending_event_data_by_type_index, t);
782 /* Resize data vector and return caller's data to be written. */
784 void *data_vec = p->pending_event_data_by_type_index[t];
787 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
789 data_vec = vec_pop (nm->recycled_event_data_vectors);
790 _vec_len (data_vec) = 0;
793 l = vec_len (data_vec);
795 data_vec = _vec_resize (data_vec,
796 /* length_increment */ n_data_elts,
797 /* total size after increment */
798 (l + n_data_elts) * n_data_elt_bytes,
799 /* header_bytes */ 0, /* data_align */ 0);
801 p->pending_event_data_by_type_index[t] = data_vec;
802 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
805 p->non_empty_event_type_bitmap =
806 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
810 /* Event was already signalled? */
811 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
813 /* Process will resume when suspend time elapses? */
814 delete_from_wheel = 0;
815 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
817 /* Waiting for both event and clock? */
818 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
820 if (!TW (tw_timer_handle_is_free)
821 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
822 p->stop_timer_handle))
823 delete_from_wheel = 1;
825 /* timer just popped so process should already be on the list */
829 /* Waiting only for clock. Event will be queue and may be
830 handled when timer expires. */
834 /* Never add current process to pending vector since current process is
836 add_to_pending &= nm->current_process_index != n->runtime_index;
840 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
841 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
842 vec_add1 (nm->data_from_advancing_timing_wheel, x);
843 if (delete_from_wheel)
844 TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
845 p->stop_timer_handle);
848 return data_to_be_written_by_caller;
852 vlib_process_signal_event_data (vlib_main_t * vm,
855 uword n_data_elts, uword n_data_elt_bytes)
857 vlib_node_main_t *nm = &vm->node_main;
858 vlib_node_t *n = vlib_get_node (vm, node_index);
859 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
862 /* Must be in main thread */
863 ASSERT (vlib_get_thread_index () == 0);
865 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
868 vlib_process_event_type_t *et =
869 vlib_process_new_event_type (p, type_opaque);
870 t = et - p->event_type_pool;
871 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
876 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
881 vlib_process_signal_event_at_time (vlib_main_t * vm,
885 uword n_data_elts, uword n_data_elt_bytes)
887 vlib_node_main_t *nm = &vm->node_main;
888 vlib_node_t *n = vlib_get_node (vm, node_index);
889 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
892 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
895 vlib_process_event_type_t *et =
896 vlib_process_new_event_type (p, type_opaque);
897 t = et - p->event_type_pool;
898 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
903 if (vlib_process_suspend_time_is_zero (dt))
904 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
908 vlib_signal_timed_event_data_t *te;
910 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
912 te->n_data_elts = n_data_elts;
913 te->n_data_elt_bytes = n_data_elt_bytes;
914 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
916 /* Assert that structure fields are big enough. */
917 ASSERT (te->n_data_elts == n_data_elts);
918 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
919 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
921 te->process_node_index = n->runtime_index;
922 te->event_type_index = t;
924 p->stop_timer_handle =
925 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
926 vlib_timing_wheel_data_set_timed_event
927 (te - nm->signal_timed_event_data_pool),
929 (vlib_time_now (vm) + dt) * 1e5);
931 /* Inline data big enough to hold event? */
932 if (te->n_data_bytes < sizeof (te->inline_event_data))
933 return te->inline_event_data;
936 te->event_data_as_vector = 0;
937 vec_resize (te->event_data_as_vector, te->n_data_bytes);
938 return te->event_data_as_vector;
944 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
948 uword n_data_elt_bytes)
950 vlib_node_main_t *nm = &vm->node_main;
951 vlib_node_t *n = vlib_get_node (vm, node_index);
952 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
953 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
958 vlib_process_signal_event (vlib_main_t * vm,
959 uword node_index, uword type_opaque, uword data)
961 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
962 1 /* elts */ , sizeof (uword));
967 vlib_process_signal_event_pointer (vlib_main_t * vm,
969 uword type_opaque, void *data)
971 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
972 1 /* elts */ , sizeof (data));
977 * Signal event to process from any thread.
979 * When in doubt, use this.
982 vlib_process_signal_event_mt (vlib_main_t * vm,
983 uword node_index, uword type_opaque, uword data)
985 if (vlib_get_thread_index () != 0)
987 vlib_process_signal_event_mt_args_t args = {
988 .node_index = node_index,
989 .type_opaque = type_opaque,
992 vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
993 (u8 *) & args, sizeof (args));
996 vlib_process_signal_event (vm, node_index, type_opaque, data);
1000 vlib_process_signal_one_time_event (vlib_main_t * vm,
1002 uword type_index, uword data)
1005 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1006 1 /* elts */ , sizeof (uword));
1011 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1012 vlib_one_time_waiting_process_t * p)
1014 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1016 clib_memset (p, ~0, sizeof (p[0]));
1020 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1021 vlib_one_time_waiting_process_t
1024 vlib_one_time_waiting_process_t *wp;
1025 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1030 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1031 vlib_one_time_waiting_process_t
1034 p->node_index = vlib_current_process (vm);
1035 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1037 vlib_process_wait_for_one_time_event (vm,
1038 /* don't care about data */ 0,
1043 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1044 vlib_one_time_waiting_process_t
1047 vlib_one_time_waiting_process_t *wp;
1048 vec_add2 (*wps, wp, 1);
1049 vlib_current_process_wait_for_one_time_event (vm, wp);
1053 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1054 vlib_node_runtime_t * node,
1060 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1061 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1062 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1065 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1067 (node->main_loop_count_last_dispatch >>
1068 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1069 vi0 = node->main_loop_vector_stats[i0];
1070 vi1 = node->main_loop_vector_stats[i1];
1071 vi0 = d == 0 ? vi0 : 0;
1072 vi1 = d <= 1 ? vi1 : 0;
1074 node->main_loop_vector_stats[i0] = vi0;
1075 node->main_loop_vector_stats[i1] = vi1;
1076 node->main_loop_count_last_dispatch = vm->main_loop_count;
1077 /* Return previous counter. */
1078 return node->main_loop_vector_stats[i1];
1082 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1084 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1087 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1089 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1093 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1095 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1098 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1100 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1104 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1106 /* Return the edge index if present, ~0 otherwise */
1107 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1109 /* Add next node to given node in given slot. */
1111 vlib_node_add_next_with_slot (vlib_main_t * vm,
1112 uword node, uword next_node, uword slot);
1114 /* As above but adds to end of node's next vector. */
1116 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1118 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1121 /* Add next node to given node in given slot. */
1123 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1124 uword node, char *next_name, uword slot);
1126 /* As above but adds to end of node's next vector. */
1128 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1130 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1137 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1138 int barrier_sync, vlib_node_t **** node_dupsp,
1139 vlib_main_t *** stat_vmsp);
1141 /* Query node given name. */
1142 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1144 /* Rename a node. */
1145 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1147 /* Register new packet processing node. Nodes can be registered
1148 dynamically via this call or statically via the VLIB_REGISTER_NODE
1150 u32 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r);
1152 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1153 void vlib_register_all_static_nodes (vlib_main_t * vm);
1155 /* Start a process. */
1156 void vlib_start_process (vlib_main_t * vm, uword process_index);
1158 /* Sync up runtime and main node stats. */
1159 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1161 /* Node graph initialization function. */
1162 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1164 format_function_t format_vlib_node_graph;
1165 format_function_t format_vlib_node_name;
1166 format_function_t format_vlib_next_node_name;
1167 format_function_t format_vlib_node_and_next;
1168 format_function_t format_vlib_cpu_time;
1169 format_function_t format_vlib_time;
1170 /* Parse node name -> node index. */
1171 unformat_function_t unformat_vlib_node;
1174 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1175 u32 counter_index, u64 increment)
1177 vlib_node_t *n = vlib_get_node (vm, node_index);
1178 vlib_error_main_t *em = &vm->error_main;
1179 u32 node_counter_base_index = n->error_heap_index;
1180 em->counters[node_counter_base_index + counter_index] += increment;
1183 #endif /* included_vlib_node_funcs_h */
1186 * fd.io coding-style-patch-verification: ON
1189 * eval: (c-set-style "gnu")