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>
50 /** \brief Get vlib node by index.
51 @warning This function will ASSERT if @c i is out of range.
52 @param vm vlib_main_t pointer, varies by thread
54 @return pointer to the requested vlib_node_t.
57 always_inline vlib_node_t *
58 vlib_get_node (vlib_main_t * vm, u32 i)
60 return vec_elt (vm->node_main.nodes, i);
63 /** \brief Get vlib node by graph arc (next) index.
64 @param vm vlib_main_t pointer, varies by thread
65 @param node_index index of original node
66 @param next_index graph arc index
67 @return pointer to the vlib_node_t at the end of the indicated arc
70 always_inline vlib_node_t *
71 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
73 vlib_node_main_t *nm = &vm->node_main;
76 n = vec_elt (nm->nodes, node_index);
77 ASSERT (next_index < vec_len (n->next_nodes));
78 return vlib_get_node (vm, n->next_nodes[next_index]);
81 /** \brief Get node runtime by node index.
82 @param vm vlib_main_t pointer, varies by thread
83 @param node_index index of node
84 @return pointer to the indicated vlib_node_runtime_t
87 always_inline vlib_node_runtime_t *
88 vlib_node_get_runtime (vlib_main_t * vm, u32 node_index)
90 vlib_node_main_t *nm = &vm->node_main;
91 vlib_node_t *n = vec_elt (nm->nodes, node_index);
93 if (n->type != VLIB_NODE_TYPE_PROCESS)
94 return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
97 p = vec_elt (nm->processes, n->runtime_index);
98 return &p->node_runtime;
102 /** \brief Get node runtime private data by node index.
103 @param vm vlib_main_t pointer, varies by thread
104 @param node_index index of the node
105 @return pointer to the indicated vlib_node_runtime_t private data
109 vlib_node_get_runtime_data (vlib_main_t * vm, u32 node_index)
111 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
112 return r->runtime_data;
115 /** \brief Set node runtime private data.
116 @param vm vlib_main_t pointer, varies by thread
117 @param node_index index of the node
118 @param runtime_data arbitrary runtime private data
119 @param n_runtime_data_bytes size of runtime private data
123 vlib_node_set_runtime_data (vlib_main_t * vm, u32 node_index,
124 void *runtime_data, u32 n_runtime_data_bytes)
126 vlib_node_t *n = vlib_get_node (vm, node_index);
127 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
129 n->runtime_data_bytes = n_runtime_data_bytes;
130 vec_free (n->runtime_data);
131 vec_add (n->runtime_data, runtime_data, n_runtime_data_bytes);
133 ASSERT (vec_len (n->runtime_data) <= sizeof (r->runtime_data));
134 if (vec_len (n->runtime_data) > 0)
135 clib_memcpy (r->runtime_data, n->runtime_data, vec_len (n->runtime_data));
138 /** \brief Set node dispatch state.
139 @param vm vlib_main_t pointer, varies by thread
140 @param node_index index of the node
141 @param new_state new state for node, see vlib_node_state_t
144 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
145 vlib_node_state_t new_state)
147 vlib_node_main_t *nm = &vm->node_main;
149 vlib_node_runtime_t *r;
151 n = vec_elt (nm->nodes, node_index);
152 if (n->type == VLIB_NODE_TYPE_PROCESS)
154 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
155 r = &p->node_runtime;
157 /* When disabling make sure flags are cleared. */
158 p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
159 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
160 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
163 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
165 ASSERT (new_state < VLIB_N_NODE_STATE);
167 if (n->type == VLIB_NODE_TYPE_INPUT)
169 ASSERT (nm->input_node_counts_by_state[n->state] > 0);
170 nm->input_node_counts_by_state[n->state] -= 1;
171 nm->input_node_counts_by_state[new_state] += 1;
174 n->state = new_state;
175 r->state = new_state;
179 vlib_node_set_interrupt_pending (vlib_main_t * vm, u32 node_index)
181 vlib_node_main_t *nm = &vm->node_main;
182 vlib_node_t *n = vec_elt (nm->nodes, node_index);
183 ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
184 vec_add1 (nm->pending_interrupt_node_runtime_indices, n->runtime_index);
187 always_inline vlib_process_t *
188 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
190 vlib_node_main_t *nm = &vm->node_main;
191 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
192 return vec_elt (nm->processes, node->runtime_index);
195 /* Fetches frame with given handle. */
196 always_inline vlib_frame_t *
197 vlib_get_frame_no_check (vlib_main_t * vm, uword frame_index)
200 u32 cpu_index = frame_index & VLIB_CPU_MASK;
201 u32 offset = frame_index & VLIB_OFFSET_MASK;
202 vm = vlib_mains ? vlib_mains[cpu_index] : vm;
203 f = vm->heap_base + offset;
208 vlib_frame_index_no_check (vlib_main_t * vm, vlib_frame_t * f)
212 ASSERT (((uword) f & VLIB_CPU_MASK) == 0);
214 vm = vlib_mains ? vlib_mains[f->cpu_index] : vm;
216 i = ((u8 *) f - (u8 *) vm->heap_base);
217 return i | f->cpu_index;
220 always_inline vlib_frame_t *
221 vlib_get_frame (vlib_main_t * vm, uword frame_index)
223 vlib_frame_t *f = vlib_get_frame_no_check (vm, frame_index);
224 ASSERT (f->flags & VLIB_FRAME_IS_ALLOCATED);
229 vlib_frame_index (vlib_main_t * vm, vlib_frame_t * f)
231 uword i = vlib_frame_index_no_check (vm, f);
232 ASSERT (vlib_get_frame (vm, i) == f);
236 /* Byte alignment for vector arguments. */
237 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
240 vlib_frame_vector_byte_offset (u32 scalar_size)
242 return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
243 VLIB_FRAME_VECTOR_ALIGN);
246 /** \brief Get pointer to frame vector data.
247 @param f vlib_frame_t pointer
248 @return pointer to first vector element in frame
251 vlib_frame_vector_args (vlib_frame_t * f)
253 return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
256 /** \brief Get pointer to frame scalar data.
258 @warning This is almost certainly not the function you wish to call.
259 See @ref vlib_frame_vector_args instead.
261 @param f vlib_frame_t pointer
263 @return arbitrary node scalar data
265 @sa vlib_frame_vector_args
268 vlib_frame_args (vlib_frame_t * f)
270 return vlib_frame_vector_args (f) - f->scalar_size;
273 always_inline vlib_next_frame_t *
274 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
275 vlib_node_runtime_t * n, u32 next_index)
277 vlib_node_main_t *nm = &vm->node_main;
278 vlib_next_frame_t *nf;
280 ASSERT (next_index < n->n_next_nodes);
281 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
285 vlib_node_t *node, *next;
286 node = vec_elt (nm->nodes, n->node_index);
287 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
288 ASSERT (nf->node_runtime_index == next->runtime_index);
294 /** \brief Get pointer to frame by (@c node_index, @c next_index).
296 @warning This is not a function that you should call directly.
297 See @ref vlib_get_next_frame instead.
299 @param vm vlib_main_t pointer, varies by thread
300 @param node_index index of the node
301 @param next_index graph arc index
303 @return pointer to the requested vlib_next_frame_t
305 @sa vlib_get_next_frame
308 always_inline vlib_next_frame_t *
309 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
311 vlib_node_main_t *nm = &vm->node_main;
313 vlib_node_runtime_t *r;
315 n = vec_elt (nm->nodes, node_index);
316 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
317 return vlib_node_runtime_get_next_frame (vm, r, next_index);
320 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
321 vlib_node_runtime_t * node,
323 u32 alloc_new_frame);
325 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
328 = vlib_get_next_frame_internal ((vm), (node), (next_index), \
329 (alloc_new_frame)); \
330 u32 _n = _f->n_vectors; \
331 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
332 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
336 /** \brief Get pointer to next frame vector data by
337 (@c vlib_node_runtime_t, @c next_index).
338 Standard single/dual loop boilerplate element.
339 @attention This is a MACRO, with SIDE EFFECTS.
341 @param vm vlib_main_t pointer, varies by thread
342 @param node current node vlib_node_runtime_t pointer
343 @param next_index requested graph arc index
345 @return @c vectors -- pointer to next available vector slot
346 @return @c n_vectors_left -- number of vector slots available
348 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left) \
349 vlib_get_next_frame_macro (vm, node, next_index, \
350 vectors, n_vectors_left, \
351 /* alloc new frame */ 0)
353 #define vlib_get_new_next_frame(vm,node,next_index,vectors,n_vectors_left) \
354 vlib_get_next_frame_macro (vm, node, next_index, \
355 vectors, n_vectors_left, \
356 /* alloc new frame */ 1)
358 /** \brief Release pointer to next frame vector data.
359 Standard single/dual loop boilerplate element.
360 @param vm vlib_main_t pointer, varies by thread
361 @param r current node vlib_node_runtime_t pointer
362 @param next_index graph arc index
363 @param n_packets_left number of slots still available in vector
366 vlib_put_next_frame (vlib_main_t * vm,
367 vlib_node_runtime_t * r,
368 u32 next_index, u32 n_packets_left);
370 /* Combination get plus put. Returns vector argument just added. */
371 #define vlib_set_next_frame(vm,node,next_index,v) \
374 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
375 ASSERT (_n_left > 0); \
376 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
381 vlib_set_next_frame_buffer (vlib_main_t * vm,
382 vlib_node_runtime_t * node,
383 u32 next_index, u32 buffer_index)
386 p = vlib_set_next_frame (vm, node, next_index, p);
390 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
391 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
394 always_inline vlib_process_t *
395 vlib_get_current_process (vlib_main_t * vm)
397 vlib_node_main_t *nm = &vm->node_main;
398 return vec_elt (nm->processes, nm->current_process_index);
402 vlib_in_process_context (vlib_main_t * vm)
404 return vm->node_main.current_process_index != ~0;
408 vlib_current_process (vlib_main_t * vm)
410 return vlib_get_current_process (vm)->node_runtime.node_index;
413 /** Returns TRUE if a process suspend time is less than 1us
414 @param dt - remaining poll time in seconds
415 @returns 1 if dt < 1e-6, 0 otherwise
418 vlib_process_suspend_time_is_zero (f64 dt)
423 /** Suspend a vlib cooperative multi-tasking thread for a period of time
424 @param vm - vlib_main_t *
425 @param dt - suspend interval in seconds
426 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
430 vlib_process_suspend (vlib_main_t * vm, f64 dt)
433 vlib_node_main_t *nm = &vm->node_main;
434 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
435 u64 dt_cpu = dt * vm->clib_time.clocks_per_second;
437 if (vlib_process_suspend_time_is_zero (dt))
438 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
440 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
441 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
442 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
444 p->resume_cpu_time = clib_cpu_time_now () + dt_cpu;
445 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
452 vlib_process_free_event_type (vlib_process_t * p, uword t,
453 uword is_one_time_event)
455 ASSERT (!pool_is_free_index (p->event_type_pool, t));
456 pool_put_index (p->event_type_pool, t);
457 if (is_one_time_event)
458 p->one_time_event_type_bitmap =
459 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
463 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
465 ASSERT (!pool_is_free_index (p->event_type_pool, t));
466 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
467 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
471 vlib_process_get_event_data (vlib_main_t * vm,
472 uword * return_event_type_opaque)
474 vlib_node_main_t *nm = &vm->node_main;
476 vlib_process_event_type_t *et;
478 void *event_data_vector;
480 p = vec_elt (nm->processes, nm->current_process_index);
482 /* Find first type with events ready.
483 Return invalid type when there's nothing there. */
484 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
488 p->non_empty_event_type_bitmap =
489 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
491 l = _vec_len (p->pending_event_data_by_type_index[t]);
493 event_data_vector = p->pending_event_data_by_type_index[t];
494 p->pending_event_data_by_type_index[t] = 0;
496 et = pool_elt_at_index (p->event_type_pool, t);
498 /* Return user's opaque value and possibly index. */
499 *return_event_type_opaque = et->opaque;
501 vlib_process_maybe_free_event_type (p, t);
503 return event_data_vector;
506 /* Return event data vector for later reuse. We reuse event data to avoid
507 repeatedly allocating event vectors in cases where we care about speed. */
509 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
511 vlib_node_main_t *nm = &vm->node_main;
512 vec_add1 (nm->recycled_event_data_vectors, event_data);
515 /** Return the first event type which has occurred and a vector of per-event
516 data of that type, or a timeout indication
518 @param vm - vlib_main_t pointer
519 @param data_vector - pointer to a (uword *) vector to receive event data
520 @returns either an event type and a vector of per-event instance data,
521 or ~0 to indicate a timeout.
525 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
527 vlib_node_main_t *nm = &vm->node_main;
529 vlib_process_event_type_t *et;
532 p = vec_elt (nm->processes, nm->current_process_index);
534 /* Find first type with events ready.
535 Return invalid type when there's nothing there. */
536 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
540 p->non_empty_event_type_bitmap =
541 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
543 l = _vec_len (p->pending_event_data_by_type_index[t]);
545 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
546 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
548 et = pool_elt_at_index (p->event_type_pool, t);
550 /* Return user's opaque value. */
553 vlib_process_maybe_free_event_type (p, t);
559 vlib_process_get_events_helper (vlib_process_t * p, uword t,
560 uword ** data_vector)
564 p->non_empty_event_type_bitmap =
565 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
567 l = _vec_len (p->pending_event_data_by_type_index[t]);
569 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
570 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
572 vlib_process_maybe_free_event_type (p, t);
577 /* As above but query as specified type of event. Returns number of
580 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
581 uword with_type_opaque)
583 vlib_node_main_t *nm = &vm->node_main;
587 p = vec_elt (nm->processes, nm->current_process_index);
588 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
590 /* This can happen when an event has not yet been
591 signaled with given opaque type. */
595 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
598 return vlib_process_get_events_helper (p, t, data_vector);
601 always_inline uword *
602 vlib_process_wait_for_event (vlib_main_t * vm)
604 vlib_node_main_t *nm = &vm->node_main;
608 p = vec_elt (nm->processes, nm->current_process_index);
609 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
611 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
613 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
614 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
615 clib_longjmp (&p->return_longjmp,
616 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
619 return p->non_empty_event_type_bitmap;
623 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
624 uword ** data_vector,
625 uword with_type_index)
627 vlib_node_main_t *nm = &vm->node_main;
631 p = vec_elt (nm->processes, nm->current_process_index);
632 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
633 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
635 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
637 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
638 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
639 clib_longjmp (&p->return_longjmp,
640 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
643 return vlib_process_get_events_helper (p, with_type_index, data_vector);
647 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
648 uword ** data_vector,
649 uword with_type_opaque)
651 vlib_node_main_t *nm = &vm->node_main;
655 p = vec_elt (nm->processes, nm->current_process_index);
656 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
657 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
659 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
661 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
662 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
663 clib_longjmp (&p->return_longjmp,
664 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
666 /* See if unknown event type has been signaled now. */
668 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
671 return vlib_process_get_events_helper (p, h[0], data_vector);
674 /** Suspend a cooperative multi-tasking thread
675 Waits for an event, or for the indicated number of seconds to elapse
676 @param vm - vlib_main_t pointer
677 @param dt - timeout, in seconds.
678 @returns the remaining time interval
682 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
684 vlib_node_main_t *nm = &vm->node_main;
689 p = vec_elt (nm->processes, nm->current_process_index);
691 if (vlib_process_suspend_time_is_zero (dt)
692 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
695 wakeup_time = vlib_time_now (vm) + dt;
697 /* Suspend waiting for both clock and event to occur. */
698 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
699 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
701 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
702 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
704 p->resume_cpu_time = (clib_cpu_time_now ()
705 + (dt * vm->clib_time.clocks_per_second));
706 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
709 /* Return amount of time still left to sleep.
710 If <= 0 then we've been waken up by the clock (and not an event). */
711 return wakeup_time - vlib_time_now (vm);
714 always_inline vlib_process_event_type_t *
715 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
717 vlib_process_event_type_t *et;
718 pool_get (p->event_type_pool, et);
719 et->opaque = with_type_opaque;
724 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
725 uword with_type_opaque)
727 vlib_node_main_t *nm = &vm->node_main;
728 vlib_node_t *n = vlib_get_node (vm, node_index);
729 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
730 vlib_process_event_type_t *et;
733 et = vlib_process_new_event_type (p, with_type_opaque);
734 t = et - p->event_type_pool;
735 p->one_time_event_type_bitmap =
736 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
741 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
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);
748 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
749 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
753 vlib_process_signal_event_helper (vlib_node_main_t * nm,
757 uword n_data_elts, uword n_data_elt_bytes)
759 uword p_flags, add_to_pending, delete_from_wheel;
760 void *data_to_be_written_by_caller;
762 ASSERT (!pool_is_free_index (p->event_type_pool, t));
764 vec_validate (p->pending_event_data_by_type_index, t);
766 /* Resize data vector and return caller's data to be written. */
768 void *data_vec = p->pending_event_data_by_type_index[t];
771 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
773 data_vec = vec_pop (nm->recycled_event_data_vectors);
774 _vec_len (data_vec) = 0;
777 l = vec_len (data_vec);
779 data_vec = _vec_resize (data_vec,
780 /* length_increment */ n_data_elts,
781 /* total size after increment */
782 (l + n_data_elts) * n_data_elt_bytes,
783 /* header_bytes */ 0, /* data_align */ 0);
785 p->pending_event_data_by_type_index[t] = data_vec;
786 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
789 p->non_empty_event_type_bitmap =
790 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
794 /* Event was already signalled? */
795 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
797 /* Process will resume when suspend time elapses? */
798 delete_from_wheel = 0;
799 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
801 /* Waiting for both event and clock? */
802 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
803 delete_from_wheel = 1;
805 /* Waiting only for clock. Event will be queue and may be
806 handled when timer expires. */
810 /* Never add current process to pending vector since current process is
812 add_to_pending &= nm->current_process_index != n->runtime_index;
816 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
817 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
818 vec_add1 (nm->data_from_advancing_timing_wheel, x);
819 if (delete_from_wheel)
820 timing_wheel_delete (&nm->timing_wheel, x);
823 return data_to_be_written_by_caller;
827 vlib_process_signal_event_data (vlib_main_t * vm,
830 uword n_data_elts, uword n_data_elt_bytes)
832 vlib_node_main_t *nm = &vm->node_main;
833 vlib_node_t *n = vlib_get_node (vm, node_index);
834 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
837 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
840 vlib_process_event_type_t *et =
841 vlib_process_new_event_type (p, type_opaque);
842 t = et - p->event_type_pool;
843 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
848 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
853 vlib_process_signal_event_at_time (vlib_main_t * vm,
857 uword n_data_elts, uword n_data_elt_bytes)
859 vlib_node_main_t *nm = &vm->node_main;
860 vlib_node_t *n = vlib_get_node (vm, node_index);
861 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
864 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
867 vlib_process_event_type_t *et =
868 vlib_process_new_event_type (p, type_opaque);
869 t = et - p->event_type_pool;
870 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
875 if (vlib_process_suspend_time_is_zero (dt))
876 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
880 vlib_signal_timed_event_data_t *te;
881 u64 dt_cpu = dt * vm->clib_time.clocks_per_second;
883 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
885 te->n_data_elts = n_data_elts;
886 te->n_data_elt_bytes = n_data_elt_bytes;
887 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
889 /* Assert that structure fields are big enough. */
890 ASSERT (te->n_data_elts == n_data_elts);
891 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
892 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
894 te->process_node_index = n->runtime_index;
895 te->event_type_index = t;
897 timing_wheel_insert (&nm->timing_wheel, clib_cpu_time_now () + dt_cpu,
898 vlib_timing_wheel_data_set_timed_event (te -
900 signal_timed_event_data_pool));
902 /* Inline data big enough to hold event? */
903 if (te->n_data_bytes < sizeof (te->inline_event_data))
904 return te->inline_event_data;
907 te->event_data_as_vector = 0;
908 vec_resize (te->event_data_as_vector, te->n_data_bytes);
909 return te->event_data_as_vector;
915 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
919 uword n_data_elt_bytes)
921 vlib_node_main_t *nm = &vm->node_main;
922 vlib_node_t *n = vlib_get_node (vm, node_index);
923 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
924 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
929 vlib_process_signal_event (vlib_main_t * vm,
930 uword node_index, uword type_opaque, uword data)
932 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
933 1 /* elts */ , sizeof (uword));
938 vlib_process_signal_event_pointer (vlib_main_t * vm,
940 uword type_opaque, void *data)
942 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
943 1 /* elts */ , sizeof (data));
948 vlib_process_signal_one_time_event (vlib_main_t * vm,
950 uword type_index, uword data)
953 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
954 1 /* elts */ , sizeof (uword));
959 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
960 vlib_one_time_waiting_process_t * p)
962 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
964 memset (p, ~0, sizeof (p[0]));
968 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
969 vlib_one_time_waiting_process_t
972 vlib_one_time_waiting_process_t *wp;
973 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
978 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
979 vlib_one_time_waiting_process_t
982 p->node_index = vlib_current_process (vm);
983 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
985 vlib_process_wait_for_one_time_event (vm,
986 /* don't care about data */ 0,
991 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
992 vlib_one_time_waiting_process_t
995 vlib_one_time_waiting_process_t *wp;
996 vec_add2 (*wps, wp, 1);
997 vlib_current_process_wait_for_one_time_event (vm, wp);
1001 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1002 vlib_node_runtime_t * node,
1008 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1009 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1010 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1013 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1015 (node->main_loop_count_last_dispatch >>
1016 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1017 vi0 = node->main_loop_vector_stats[i0];
1018 vi1 = node->main_loop_vector_stats[i1];
1019 vi0 = d == 0 ? vi0 : 0;
1020 vi1 = d <= 1 ? vi1 : 0;
1022 node->main_loop_vector_stats[i0] = vi0;
1023 node->main_loop_vector_stats[i1] = vi1;
1024 node->main_loop_count_last_dispatch = vm->main_loop_count;
1025 /* Return previous counter. */
1026 return node->main_loop_vector_stats[i1];
1030 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1032 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1035 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1037 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1041 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1043 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1046 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1048 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1052 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1054 /* Add next node to given node in given slot. */
1056 vlib_node_add_next_with_slot (vlib_main_t * vm,
1057 uword node, uword next_node, uword slot);
1059 /* As above but adds to end of node's next vector. */
1061 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1063 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1066 /* Add next node to given node in given slot. */
1068 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1069 uword node, char *next_name, uword slot);
1071 /* As above but adds to end of node's next vector. */
1073 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1075 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1078 /* Query node given name. */
1079 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1081 /* Rename a node. */
1082 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1084 /* Register new packet processing node. Nodes can be registered
1085 dynamically via this call or statically via the VLIB_REGISTER_NODE
1087 u32 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r);
1089 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1090 void vlib_register_all_static_nodes (vlib_main_t * vm);
1092 /* Start a process. */
1093 void vlib_start_process (vlib_main_t * vm, uword process_index);
1095 /* Sync up runtime and main node stats. */
1096 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1098 /* Node graph initialization function. */
1099 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1101 format_function_t format_vlib_node_graph;
1102 format_function_t format_vlib_node_name;
1103 format_function_t format_vlib_next_node_name;
1104 format_function_t format_vlib_node_and_next;
1105 format_function_t format_vlib_cpu_time;
1106 format_function_t format_vlib_time;
1107 /* Parse node name -> node index. */
1108 unformat_function_t unformat_vlib_node;
1111 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1112 u32 counter_index, u64 increment)
1114 vlib_node_t *n = vlib_get_node (vm, node_index);
1115 vlib_error_main_t *em = &vm->error_main;
1116 u32 node_counter_base_index = n->error_heap_index;
1117 em->counters[node_counter_base_index + counter_index] += increment;
1120 #endif /* included_vlib_node_funcs_h */
1123 * fd.io coding-style-patch-verification: ON
1126 * eval: (c-set-style "gnu")