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 (vlib_node_runtime_t) -
134 STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
136 if (vec_len (n->runtime_data) > 0)
137 clib_memcpy (r->runtime_data, n->runtime_data, vec_len (n->runtime_data));
140 /** \brief Set node dispatch state.
141 @param vm vlib_main_t pointer, varies by thread
142 @param node_index index of the node
143 @param new_state new state for node, see vlib_node_state_t
146 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
147 vlib_node_state_t new_state)
149 vlib_node_main_t *nm = &vm->node_main;
151 vlib_node_runtime_t *r;
153 n = vec_elt (nm->nodes, node_index);
154 if (n->type == VLIB_NODE_TYPE_PROCESS)
156 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
157 r = &p->node_runtime;
159 /* When disabling make sure flags are cleared. */
160 p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
161 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
162 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
165 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
167 ASSERT (new_state < VLIB_N_NODE_STATE);
169 if (n->type == VLIB_NODE_TYPE_INPUT)
171 ASSERT (nm->input_node_counts_by_state[n->state] > 0);
172 nm->input_node_counts_by_state[n->state] -= 1;
173 nm->input_node_counts_by_state[new_state] += 1;
176 n->state = new_state;
177 r->state = new_state;
181 vlib_node_set_interrupt_pending (vlib_main_t * vm, u32 node_index)
183 vlib_node_main_t *nm = &vm->node_main;
184 vlib_node_t *n = vec_elt (nm->nodes, node_index);
185 ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
186 vec_add1 (nm->pending_interrupt_node_runtime_indices, n->runtime_index);
189 always_inline vlib_process_t *
190 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
192 vlib_node_main_t *nm = &vm->node_main;
193 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
194 return vec_elt (nm->processes, node->runtime_index);
197 /* Fetches frame with given handle. */
198 always_inline vlib_frame_t *
199 vlib_get_frame_no_check (vlib_main_t * vm, uword frame_index)
202 u32 cpu_index = frame_index & VLIB_CPU_MASK;
203 u32 offset = frame_index & VLIB_OFFSET_MASK;
204 vm = vlib_mains ? vlib_mains[cpu_index] : vm;
205 f = vm->heap_base + offset;
210 vlib_frame_index_no_check (vlib_main_t * vm, vlib_frame_t * f)
214 ASSERT (((uword) f & VLIB_CPU_MASK) == 0);
216 vm = vlib_mains ? vlib_mains[f->cpu_index] : vm;
218 i = ((u8 *) f - (u8 *) vm->heap_base);
219 return i | f->cpu_index;
222 always_inline vlib_frame_t *
223 vlib_get_frame (vlib_main_t * vm, uword frame_index)
225 vlib_frame_t *f = vlib_get_frame_no_check (vm, frame_index);
226 ASSERT (f->flags & VLIB_FRAME_IS_ALLOCATED);
231 vlib_frame_index (vlib_main_t * vm, vlib_frame_t * f)
233 uword i = vlib_frame_index_no_check (vm, f);
234 ASSERT (vlib_get_frame (vm, i) == f);
238 /* Byte alignment for vector arguments. */
239 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
242 vlib_frame_vector_byte_offset (u32 scalar_size)
244 return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
245 VLIB_FRAME_VECTOR_ALIGN);
248 /** \brief Get pointer to frame vector data.
249 @param f vlib_frame_t pointer
250 @return pointer to first vector element in frame
253 vlib_frame_vector_args (vlib_frame_t * f)
255 return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
258 /** \brief Get pointer to frame scalar data.
260 @warning This is almost certainly not the function you wish to call.
261 See @ref vlib_frame_vector_args instead.
263 @param f vlib_frame_t pointer
265 @return arbitrary node scalar data
267 @sa vlib_frame_vector_args
270 vlib_frame_args (vlib_frame_t * f)
272 return vlib_frame_vector_args (f) - f->scalar_size;
275 always_inline vlib_next_frame_t *
276 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
277 vlib_node_runtime_t * n, u32 next_index)
279 vlib_node_main_t *nm = &vm->node_main;
280 vlib_next_frame_t *nf;
282 ASSERT (next_index < n->n_next_nodes);
283 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
287 vlib_node_t *node, *next;
288 node = vec_elt (nm->nodes, n->node_index);
289 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
290 ASSERT (nf->node_runtime_index == next->runtime_index);
296 /** \brief Get pointer to frame by (@c node_index, @c next_index).
298 @warning This is not a function that you should call directly.
299 See @ref vlib_get_next_frame instead.
301 @param vm vlib_main_t pointer, varies by thread
302 @param node_index index of the node
303 @param next_index graph arc index
305 @return pointer to the requested vlib_next_frame_t
307 @sa vlib_get_next_frame
310 always_inline vlib_next_frame_t *
311 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
313 vlib_node_main_t *nm = &vm->node_main;
315 vlib_node_runtime_t *r;
317 n = vec_elt (nm->nodes, node_index);
318 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
319 return vlib_node_runtime_get_next_frame (vm, r, next_index);
322 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
323 vlib_node_runtime_t * node,
325 u32 alloc_new_frame);
327 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
330 = vlib_get_next_frame_internal ((vm), (node), (next_index), \
331 (alloc_new_frame)); \
332 u32 _n = _f->n_vectors; \
333 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
334 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
338 /** \brief Get pointer to next frame vector data by
339 (@c vlib_node_runtime_t, @c next_index).
340 Standard single/dual loop boilerplate element.
341 @attention This is a MACRO, with SIDE EFFECTS.
343 @param vm vlib_main_t pointer, varies by thread
344 @param node current node vlib_node_runtime_t pointer
345 @param next_index requested graph arc index
347 @return @c vectors -- pointer to next available vector slot
348 @return @c n_vectors_left -- number of vector slots available
350 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left) \
351 vlib_get_next_frame_macro (vm, node, next_index, \
352 vectors, n_vectors_left, \
353 /* alloc new frame */ 0)
355 #define vlib_get_new_next_frame(vm,node,next_index,vectors,n_vectors_left) \
356 vlib_get_next_frame_macro (vm, node, next_index, \
357 vectors, n_vectors_left, \
358 /* alloc new frame */ 1)
360 /** \brief Release pointer to next frame vector data.
361 Standard single/dual loop boilerplate element.
362 @param vm vlib_main_t pointer, varies by thread
363 @param r current node vlib_node_runtime_t pointer
364 @param next_index graph arc index
365 @param n_packets_left number of slots still available in vector
368 vlib_put_next_frame (vlib_main_t * vm,
369 vlib_node_runtime_t * r,
370 u32 next_index, u32 n_packets_left);
372 /* Combination get plus put. Returns vector argument just added. */
373 #define vlib_set_next_frame(vm,node,next_index,v) \
376 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
377 ASSERT (_n_left > 0); \
378 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
383 vlib_set_next_frame_buffer (vlib_main_t * vm,
384 vlib_node_runtime_t * node,
385 u32 next_index, u32 buffer_index)
388 p = vlib_set_next_frame (vm, node, next_index, p);
392 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
393 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
396 always_inline vlib_process_t *
397 vlib_get_current_process (vlib_main_t * vm)
399 vlib_node_main_t *nm = &vm->node_main;
400 return vec_elt (nm->processes, nm->current_process_index);
404 vlib_in_process_context (vlib_main_t * vm)
406 return vm->node_main.current_process_index != ~0;
410 vlib_current_process (vlib_main_t * vm)
412 return vlib_get_current_process (vm)->node_runtime.node_index;
415 /** Returns TRUE if a process suspend time is less than 1us
416 @param dt - remaining poll time in seconds
417 @returns 1 if dt < 1e-6, 0 otherwise
420 vlib_process_suspend_time_is_zero (f64 dt)
425 /** Suspend a vlib cooperative multi-tasking thread for a period of time
426 @param vm - vlib_main_t *
427 @param dt - suspend interval in seconds
428 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
432 vlib_process_suspend (vlib_main_t * vm, f64 dt)
435 vlib_node_main_t *nm = &vm->node_main;
436 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
437 u64 dt_cpu = dt * vm->clib_time.clocks_per_second;
439 if (vlib_process_suspend_time_is_zero (dt))
440 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
442 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
443 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
444 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
446 p->resume_cpu_time = clib_cpu_time_now () + dt_cpu;
447 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
454 vlib_process_free_event_type (vlib_process_t * p, uword t,
455 uword is_one_time_event)
457 ASSERT (!pool_is_free_index (p->event_type_pool, t));
458 pool_put_index (p->event_type_pool, t);
459 if (is_one_time_event)
460 p->one_time_event_type_bitmap =
461 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
465 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
467 ASSERT (!pool_is_free_index (p->event_type_pool, t));
468 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
469 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
473 vlib_process_get_event_data (vlib_main_t * vm,
474 uword * return_event_type_opaque)
476 vlib_node_main_t *nm = &vm->node_main;
478 vlib_process_event_type_t *et;
480 void *event_data_vector;
482 p = vec_elt (nm->processes, nm->current_process_index);
484 /* Find first type with events ready.
485 Return invalid type when there's nothing there. */
486 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
490 p->non_empty_event_type_bitmap =
491 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
493 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
494 event_data_vector = p->pending_event_data_by_type_index[t];
495 p->pending_event_data_by_type_index[t] = 0;
497 et = pool_elt_at_index (p->event_type_pool, t);
499 /* Return user's opaque value and possibly index. */
500 *return_event_type_opaque = et->opaque;
502 vlib_process_maybe_free_event_type (p, t);
504 return event_data_vector;
507 /* Return event data vector for later reuse. We reuse event data to avoid
508 repeatedly allocating event vectors in cases where we care about speed. */
510 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
512 vlib_node_main_t *nm = &vm->node_main;
513 vec_add1 (nm->recycled_event_data_vectors, event_data);
516 /** Return the first event type which has occurred and a vector of per-event
517 data of that type, or a timeout indication
519 @param vm - vlib_main_t pointer
520 @param data_vector - pointer to a (uword *) vector to receive event data
521 @returns either an event type and a vector of per-event instance data,
522 or ~0 to indicate a timeout.
526 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
528 vlib_node_main_t *nm = &vm->node_main;
530 vlib_process_event_type_t *et;
533 p = vec_elt (nm->processes, nm->current_process_index);
535 /* Find first type with events ready.
536 Return invalid type when there's nothing there. */
537 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
541 p->non_empty_event_type_bitmap =
542 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
544 l = _vec_len (p->pending_event_data_by_type_index[t]);
546 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
547 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
549 et = pool_elt_at_index (p->event_type_pool, t);
551 /* Return user's opaque value. */
554 vlib_process_maybe_free_event_type (p, t);
560 vlib_process_get_events_helper (vlib_process_t * p, uword t,
561 uword ** data_vector)
565 p->non_empty_event_type_bitmap =
566 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
568 l = _vec_len (p->pending_event_data_by_type_index[t]);
570 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
571 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
573 vlib_process_maybe_free_event_type (p, t);
578 /* As above but query as specified type of event. Returns number of
581 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
582 uword with_type_opaque)
584 vlib_node_main_t *nm = &vm->node_main;
588 p = vec_elt (nm->processes, nm->current_process_index);
589 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
591 /* This can happen when an event has not yet been
592 signaled with given opaque type. */
596 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
599 return vlib_process_get_events_helper (p, t, data_vector);
602 always_inline uword *
603 vlib_process_wait_for_event (vlib_main_t * vm)
605 vlib_node_main_t *nm = &vm->node_main;
609 p = vec_elt (nm->processes, nm->current_process_index);
610 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
612 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
614 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
615 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
616 clib_longjmp (&p->return_longjmp,
617 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
620 return p->non_empty_event_type_bitmap;
624 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
625 uword ** data_vector,
626 uword with_type_index)
628 vlib_node_main_t *nm = &vm->node_main;
632 p = vec_elt (nm->processes, nm->current_process_index);
633 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
634 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
636 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
638 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
639 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
640 clib_longjmp (&p->return_longjmp,
641 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
644 return vlib_process_get_events_helper (p, with_type_index, data_vector);
648 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
649 uword ** data_vector,
650 uword with_type_opaque)
652 vlib_node_main_t *nm = &vm->node_main;
656 p = vec_elt (nm->processes, nm->current_process_index);
657 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
658 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
660 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
662 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
663 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
664 clib_longjmp (&p->return_longjmp,
665 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
667 /* See if unknown event type has been signaled now. */
669 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
672 return vlib_process_get_events_helper (p, h[0], data_vector);
675 /** Suspend a cooperative multi-tasking thread
676 Waits for an event, or for the indicated number of seconds to elapse
677 @param vm - vlib_main_t pointer
678 @param dt - timeout, in seconds.
679 @returns the remaining time interval
683 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
685 vlib_node_main_t *nm = &vm->node_main;
690 p = vec_elt (nm->processes, nm->current_process_index);
692 if (vlib_process_suspend_time_is_zero (dt)
693 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
696 wakeup_time = vlib_time_now (vm) + dt;
698 /* Suspend waiting for both clock and event to occur. */
699 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
700 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
702 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
703 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
705 p->resume_cpu_time = (clib_cpu_time_now ()
706 + (dt * vm->clib_time.clocks_per_second));
707 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
710 /* Return amount of time still left to sleep.
711 If <= 0 then we've been waken up by the clock (and not an event). */
712 return wakeup_time - vlib_time_now (vm);
715 always_inline vlib_process_event_type_t *
716 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
718 vlib_process_event_type_t *et;
719 pool_get (p->event_type_pool, et);
720 et->opaque = with_type_opaque;
725 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
726 uword with_type_opaque)
728 vlib_node_main_t *nm = &vm->node_main;
729 vlib_node_t *n = vlib_get_node (vm, node_index);
730 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
731 vlib_process_event_type_t *et;
734 et = vlib_process_new_event_type (p, with_type_opaque);
735 t = et - p->event_type_pool;
736 p->one_time_event_type_bitmap =
737 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
742 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
745 vlib_node_main_t *nm = &vm->node_main;
746 vlib_node_t *n = vlib_get_node (vm, node_index);
747 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
749 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
750 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
754 vlib_process_signal_event_helper (vlib_node_main_t * nm,
758 uword n_data_elts, uword n_data_elt_bytes)
760 uword p_flags, add_to_pending, delete_from_wheel;
761 void *data_to_be_written_by_caller;
763 ASSERT (!pool_is_free_index (p->event_type_pool, t));
765 vec_validate (p->pending_event_data_by_type_index, t);
767 /* Resize data vector and return caller's data to be written. */
769 void *data_vec = p->pending_event_data_by_type_index[t];
772 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
774 data_vec = vec_pop (nm->recycled_event_data_vectors);
775 _vec_len (data_vec) = 0;
778 l = vec_len (data_vec);
780 data_vec = _vec_resize (data_vec,
781 /* length_increment */ n_data_elts,
782 /* total size after increment */
783 (l + n_data_elts) * n_data_elt_bytes,
784 /* header_bytes */ 0, /* data_align */ 0);
786 p->pending_event_data_by_type_index[t] = data_vec;
787 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
790 p->non_empty_event_type_bitmap =
791 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
795 /* Event was already signalled? */
796 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
798 /* Process will resume when suspend time elapses? */
799 delete_from_wheel = 0;
800 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
802 /* Waiting for both event and clock? */
803 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
804 delete_from_wheel = 1;
806 /* Waiting only for clock. Event will be queue and may be
807 handled when timer expires. */
811 /* Never add current process to pending vector since current process is
813 add_to_pending &= nm->current_process_index != n->runtime_index;
817 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
818 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
819 vec_add1 (nm->data_from_advancing_timing_wheel, x);
820 if (delete_from_wheel)
821 timing_wheel_delete (&nm->timing_wheel, x);
824 return data_to_be_written_by_caller;
828 vlib_process_signal_event_data (vlib_main_t * vm,
831 uword n_data_elts, uword n_data_elt_bytes)
833 vlib_node_main_t *nm = &vm->node_main;
834 vlib_node_t *n = vlib_get_node (vm, node_index);
835 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
838 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
841 vlib_process_event_type_t *et =
842 vlib_process_new_event_type (p, type_opaque);
843 t = et - p->event_type_pool;
844 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
849 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
854 vlib_process_signal_event_at_time (vlib_main_t * vm,
858 uword n_data_elts, uword n_data_elt_bytes)
860 vlib_node_main_t *nm = &vm->node_main;
861 vlib_node_t *n = vlib_get_node (vm, node_index);
862 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
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 if (vlib_process_suspend_time_is_zero (dt))
877 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
881 vlib_signal_timed_event_data_t *te;
882 u64 dt_cpu = dt * vm->clib_time.clocks_per_second;
884 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
886 te->n_data_elts = n_data_elts;
887 te->n_data_elt_bytes = n_data_elt_bytes;
888 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
890 /* Assert that structure fields are big enough. */
891 ASSERT (te->n_data_elts == n_data_elts);
892 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
893 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
895 te->process_node_index = n->runtime_index;
896 te->event_type_index = t;
898 timing_wheel_insert (&nm->timing_wheel, clib_cpu_time_now () + dt_cpu,
899 vlib_timing_wheel_data_set_timed_event (te -
901 signal_timed_event_data_pool));
903 /* Inline data big enough to hold event? */
904 if (te->n_data_bytes < sizeof (te->inline_event_data))
905 return te->inline_event_data;
908 te->event_data_as_vector = 0;
909 vec_resize (te->event_data_as_vector, te->n_data_bytes);
910 return te->event_data_as_vector;
916 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
920 uword n_data_elt_bytes)
922 vlib_node_main_t *nm = &vm->node_main;
923 vlib_node_t *n = vlib_get_node (vm, node_index);
924 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
925 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
930 vlib_process_signal_event (vlib_main_t * vm,
931 uword node_index, uword type_opaque, uword data)
933 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
934 1 /* elts */ , sizeof (uword));
939 vlib_process_signal_event_pointer (vlib_main_t * vm,
941 uword type_opaque, void *data)
943 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
944 1 /* elts */ , sizeof (data));
949 vlib_process_signal_one_time_event (vlib_main_t * vm,
951 uword type_index, uword data)
954 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
955 1 /* elts */ , sizeof (uword));
960 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
961 vlib_one_time_waiting_process_t * p)
963 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
965 memset (p, ~0, sizeof (p[0]));
969 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
970 vlib_one_time_waiting_process_t
973 vlib_one_time_waiting_process_t *wp;
974 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
979 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
980 vlib_one_time_waiting_process_t
983 p->node_index = vlib_current_process (vm);
984 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
986 vlib_process_wait_for_one_time_event (vm,
987 /* don't care about data */ 0,
992 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
993 vlib_one_time_waiting_process_t
996 vlib_one_time_waiting_process_t *wp;
997 vec_add2 (*wps, wp, 1);
998 vlib_current_process_wait_for_one_time_event (vm, wp);
1002 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1003 vlib_node_runtime_t * node,
1009 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1010 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1011 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1014 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1016 (node->main_loop_count_last_dispatch >>
1017 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1018 vi0 = node->main_loop_vector_stats[i0];
1019 vi1 = node->main_loop_vector_stats[i1];
1020 vi0 = d == 0 ? vi0 : 0;
1021 vi1 = d <= 1 ? vi1 : 0;
1023 node->main_loop_vector_stats[i0] = vi0;
1024 node->main_loop_vector_stats[i1] = vi1;
1025 node->main_loop_count_last_dispatch = vm->main_loop_count;
1026 /* Return previous counter. */
1027 return node->main_loop_vector_stats[i1];
1031 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1033 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1036 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1038 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1042 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1044 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1047 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1049 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1053 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1055 /* Add next node to given node in given slot. */
1057 vlib_node_add_next_with_slot (vlib_main_t * vm,
1058 uword node, uword next_node, uword slot);
1060 /* As above but adds to end of node's next vector. */
1062 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1064 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1067 /* Add next node to given node in given slot. */
1069 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1070 uword node, char *next_name, uword slot);
1072 /* As above but adds to end of node's next vector. */
1074 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1076 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1079 /* Query node given name. */
1080 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1082 /* Rename a node. */
1083 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1085 /* Register new packet processing node. Nodes can be registered
1086 dynamically via this call or statically via the VLIB_REGISTER_NODE
1088 u32 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r);
1090 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1091 void vlib_register_all_static_nodes (vlib_main_t * vm);
1093 /* Start a process. */
1094 void vlib_start_process (vlib_main_t * vm, uword process_index);
1096 /* Sync up runtime and main node stats. */
1097 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1099 /* Node graph initialization function. */
1100 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1102 format_function_t format_vlib_node_graph;
1103 format_function_t format_vlib_node_name;
1104 format_function_t format_vlib_next_node_name;
1105 format_function_t format_vlib_node_and_next;
1106 format_function_t format_vlib_cpu_time;
1107 format_function_t format_vlib_time;
1108 /* Parse node name -> node index. */
1109 unformat_function_t unformat_vlib_node;
1112 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1113 u32 counter_index, u64 increment)
1115 vlib_node_t *n = vlib_get_node (vm, node_index);
1116 vlib_error_main_t *em = &vm->error_main;
1117 u32 node_counter_base_index = n->error_heap_index;
1118 em->counters[node_counter_base_index + counter_index] += increment;
1121 #endif /* included_vlib_node_funcs_h */
1124 * fd.io coding-style-patch-verification: ON
1127 * eval: (c-set-style "gnu")