2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * node_funcs.h: processing nodes global functions/inlines
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
45 #ifndef included_vlib_node_funcs_h
46 #define included_vlib_node_funcs_h
48 #include <vppinfra/fifo.h>
49 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
51 /** \brief Get vlib node by index.
52 @warning This function will ASSERT if @c i is out of range.
53 @param vm vlib_main_t pointer, varies by thread
55 @return pointer to the requested vlib_node_t.
58 always_inline vlib_node_t *
59 vlib_get_node (vlib_main_t * vm, u32 i)
61 return vec_elt (vm->node_main.nodes, i);
64 /** \brief Get vlib node by graph arc (next) index.
65 @param vm vlib_main_t pointer, varies by thread
66 @param node_index index of original node
67 @param next_index graph arc index
68 @return pointer to the vlib_node_t at the end of the indicated arc
71 always_inline vlib_node_t *
72 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
74 vlib_node_main_t *nm = &vm->node_main;
77 n = vec_elt (nm->nodes, node_index);
78 ASSERT (next_index < vec_len (n->next_nodes));
79 return vlib_get_node (vm, n->next_nodes[next_index]);
82 /** \brief Get node runtime by node index.
83 @param vm vlib_main_t pointer, varies by thread
84 @param node_index index of node
85 @return pointer to the indicated vlib_node_runtime_t
88 always_inline vlib_node_runtime_t *
89 vlib_node_get_runtime (vlib_main_t * vm, u32 node_index)
91 vlib_node_main_t *nm = &vm->node_main;
92 vlib_node_t *n = vec_elt (nm->nodes, node_index);
94 if (n->type != VLIB_NODE_TYPE_PROCESS)
95 return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
98 p = vec_elt (nm->processes, n->runtime_index);
99 return &p->node_runtime;
103 /** \brief Get node runtime private data by node index.
104 @param vm vlib_main_t pointer, varies by thread
105 @param node_index index of the node
106 @return pointer to the indicated vlib_node_runtime_t private data
110 vlib_node_get_runtime_data (vlib_main_t * vm, u32 node_index)
112 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
113 return r->runtime_data;
116 /** \brief Set node runtime private data.
117 @param vm vlib_main_t pointer, varies by thread
118 @param node_index index of the node
119 @param runtime_data arbitrary runtime private data
120 @param n_runtime_data_bytes size of runtime private data
124 vlib_node_set_runtime_data (vlib_main_t * vm, u32 node_index,
125 void *runtime_data, u32 n_runtime_data_bytes)
127 vlib_node_t *n = vlib_get_node (vm, node_index);
128 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
130 n->runtime_data_bytes = n_runtime_data_bytes;
131 vec_free (n->runtime_data);
132 vec_add (n->runtime_data, runtime_data, n_runtime_data_bytes);
134 ASSERT (vec_len (n->runtime_data) <= sizeof (vlib_node_runtime_t) -
135 STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
137 if (vec_len (n->runtime_data) > 0)
138 clib_memcpy (r->runtime_data, n->runtime_data, vec_len (n->runtime_data));
141 /** \brief Set node dispatch state.
142 @param vm vlib_main_t pointer, varies by thread
143 @param node_index index of the node
144 @param new_state new state for node, see vlib_node_state_t
147 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
148 vlib_node_state_t new_state)
150 vlib_node_main_t *nm = &vm->node_main;
152 vlib_node_runtime_t *r;
154 n = vec_elt (nm->nodes, node_index);
155 if (n->type == VLIB_NODE_TYPE_PROCESS)
157 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
158 r = &p->node_runtime;
160 /* When disabling make sure flags are cleared. */
161 p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
162 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
163 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
166 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
168 ASSERT (new_state < VLIB_N_NODE_STATE);
170 if (n->type == VLIB_NODE_TYPE_INPUT)
172 ASSERT (nm->input_node_counts_by_state[n->state] > 0);
173 nm->input_node_counts_by_state[n->state] -= 1;
174 nm->input_node_counts_by_state[new_state] += 1;
177 n->state = new_state;
178 r->state = new_state;
181 /** \brief Get node dispatch state.
182 @param vm vlib_main_t pointer, varies by thread
183 @param node_index index of the node
184 @return state for node, see vlib_node_state_t
186 always_inline vlib_node_state_t
187 vlib_node_get_state (vlib_main_t * vm, u32 node_index)
189 vlib_node_main_t *nm = &vm->node_main;
191 n = vec_elt (nm->nodes, node_index);
196 vlib_node_set_interrupt_pending (vlib_main_t * vm, u32 node_index)
198 vlib_node_main_t *nm = &vm->node_main;
199 vlib_node_t *n = vec_elt (nm->nodes, node_index);
200 ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
201 clib_spinlock_lock_if_init (&nm->pending_interrupt_lock);
202 vec_add1 (nm->pending_interrupt_node_runtime_indices, n->runtime_index);
203 clib_spinlock_unlock_if_init (&nm->pending_interrupt_lock);
206 always_inline vlib_process_t *
207 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
209 vlib_node_main_t *nm = &vm->node_main;
210 ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
211 return vec_elt (nm->processes, node->runtime_index);
214 /* Fetches frame with given handle. */
215 always_inline vlib_frame_t *
216 vlib_get_frame_no_check (vlib_main_t * vm, uword frame_index)
219 f = vm->heap_aligned_base + (frame_index * VLIB_FRAME_ALIGN);
224 vlib_frame_index_no_check (vlib_main_t * vm, vlib_frame_t * f)
228 ASSERT (((uword) f & (VLIB_FRAME_ALIGN - 1)) == 0);
230 i = ((u8 *) f - (u8 *) vm->heap_aligned_base);
231 ASSERT ((i / VLIB_FRAME_ALIGN) <= 0xFFFFFFFFULL);
233 return i / VLIB_FRAME_ALIGN;
236 always_inline vlib_frame_t *
237 vlib_get_frame (vlib_main_t * vm, uword frame_index)
239 vlib_frame_t *f = vlib_get_frame_no_check (vm, frame_index);
240 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
245 vlib_frame_index (vlib_main_t * vm, vlib_frame_t * f)
247 uword i = vlib_frame_index_no_check (vm, f);
248 ASSERT (vlib_get_frame (vm, i) == f);
252 /* Byte alignment for vector arguments. */
253 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
256 vlib_frame_vector_byte_offset (u32 scalar_size)
258 return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
259 VLIB_FRAME_VECTOR_ALIGN);
262 /** \brief Get pointer to frame vector data.
263 @param f vlib_frame_t pointer
264 @return pointer to first vector element in frame
267 vlib_frame_vector_args (vlib_frame_t * f)
269 return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
272 /** \brief Get pointer to frame scalar data.
274 @param f vlib_frame_t pointer
276 @return arbitrary node scalar data
278 @sa vlib_frame_vector_args
281 vlib_frame_scalar_args (vlib_frame_t * f)
283 return vlib_frame_vector_args (f) - f->scalar_size;
286 always_inline vlib_next_frame_t *
287 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
288 vlib_node_runtime_t * n, u32 next_index)
290 vlib_node_main_t *nm = &vm->node_main;
291 vlib_next_frame_t *nf;
293 ASSERT (next_index < n->n_next_nodes);
294 nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
298 vlib_node_t *node, *next;
299 node = vec_elt (nm->nodes, n->node_index);
300 next = vec_elt (nm->nodes, node->next_nodes[next_index]);
301 ASSERT (nf->node_runtime_index == next->runtime_index);
307 /** \brief Get pointer to frame by (@c node_index, @c next_index).
309 @warning This is not a function that you should call directly.
310 See @ref vlib_get_next_frame instead.
312 @param vm vlib_main_t pointer, varies by thread
313 @param node_index index of the node
314 @param next_index graph arc index
316 @return pointer to the requested vlib_next_frame_t
318 @sa vlib_get_next_frame
321 always_inline vlib_next_frame_t *
322 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
324 vlib_node_main_t *nm = &vm->node_main;
326 vlib_node_runtime_t *r;
328 n = vec_elt (nm->nodes, node_index);
329 r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
330 return vlib_node_runtime_get_next_frame (vm, r, next_index);
333 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
334 vlib_node_runtime_t * node,
336 u32 alloc_new_frame);
338 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
341 = vlib_get_next_frame_internal ((vm), (node), (next_index), \
342 (alloc_new_frame)); \
343 u32 _n = _f->n_vectors; \
344 (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
345 (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
349 /** \brief Get pointer to next frame vector data by
350 (@c vlib_node_runtime_t, @c next_index).
351 Standard single/dual loop boilerplate element.
352 @attention This is a MACRO, with SIDE EFFECTS.
354 @param vm vlib_main_t pointer, varies by thread
355 @param node current node vlib_node_runtime_t pointer
356 @param next_index requested graph arc index
358 @return @c vectors -- pointer to next available vector slot
359 @return @c n_vectors_left -- number of vector slots available
361 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left) \
362 vlib_get_next_frame_macro (vm, node, next_index, \
363 vectors, n_vectors_left, \
364 /* alloc new frame */ 0)
366 #define vlib_get_new_next_frame(vm,node,next_index,vectors,n_vectors_left) \
367 vlib_get_next_frame_macro (vm, node, next_index, \
368 vectors, n_vectors_left, \
369 /* alloc new frame */ 1)
371 /** \brief Release pointer to next frame vector data.
372 Standard single/dual loop boilerplate element.
373 @param vm vlib_main_t pointer, varies by thread
374 @param r current node vlib_node_runtime_t pointer
375 @param next_index graph arc index
376 @param n_packets_left number of slots still available in vector
379 vlib_put_next_frame (vlib_main_t * vm,
380 vlib_node_runtime_t * r,
381 u32 next_index, u32 n_packets_left);
383 /* Combination get plus put. Returns vector argument just added. */
384 #define vlib_set_next_frame(vm,node,next_index,v) \
387 vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
388 ASSERT (_n_left > 0); \
389 vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
394 vlib_set_next_frame_buffer (vlib_main_t * vm,
395 vlib_node_runtime_t * node,
396 u32 next_index, u32 buffer_index)
399 p = vlib_set_next_frame (vm, node, next_index, p);
403 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
404 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
408 vlib_in_process_context (vlib_main_t * vm)
410 return vm->node_main.current_process_index != ~0;
413 always_inline vlib_process_t *
414 vlib_get_current_process (vlib_main_t * vm)
416 vlib_node_main_t *nm = &vm->node_main;
417 if (vlib_in_process_context (vm))
418 return vec_elt (nm->processes, nm->current_process_index);
423 vlib_current_process (vlib_main_t * vm)
425 return vlib_get_current_process (vm)->node_runtime.node_index;
428 /** Returns TRUE if a process suspend time is less than 10us
429 @param dt - remaining poll time in seconds
430 @returns 1 if dt < 10e-6, 0 otherwise
433 vlib_process_suspend_time_is_zero (f64 dt)
438 /** Suspend a vlib cooperative multi-tasking thread for a period of time
439 @param vm - vlib_main_t *
440 @param dt - suspend interval in seconds
441 @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
445 vlib_process_suspend (vlib_main_t * vm, f64 dt)
448 vlib_node_main_t *nm = &vm->node_main;
449 vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
451 if (vlib_process_suspend_time_is_zero (dt))
452 return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
454 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
455 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
456 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
458 /* expiration time in 10us ticks */
459 p->resume_clock_interval = dt * 1e5;
460 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
467 vlib_process_free_event_type (vlib_process_t * p, uword t,
468 uword is_one_time_event)
470 ASSERT (!pool_is_free_index (p->event_type_pool, t));
471 pool_put_index (p->event_type_pool, t);
472 if (is_one_time_event)
473 p->one_time_event_type_bitmap =
474 clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
478 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
480 ASSERT (!pool_is_free_index (p->event_type_pool, t));
481 if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
482 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
486 vlib_process_get_event_data (vlib_main_t * vm,
487 uword * return_event_type_opaque)
489 vlib_node_main_t *nm = &vm->node_main;
491 vlib_process_event_type_t *et;
493 void *event_data_vector;
495 p = vec_elt (nm->processes, nm->current_process_index);
497 /* Find first type with events ready.
498 Return invalid type when there's nothing there. */
499 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
503 p->non_empty_event_type_bitmap =
504 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
506 ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
507 event_data_vector = p->pending_event_data_by_type_index[t];
508 p->pending_event_data_by_type_index[t] = 0;
510 et = pool_elt_at_index (p->event_type_pool, t);
512 /* Return user's opaque value and possibly index. */
513 *return_event_type_opaque = et->opaque;
515 vlib_process_maybe_free_event_type (p, t);
517 return event_data_vector;
520 /* Return event data vector for later reuse. We reuse event data to avoid
521 repeatedly allocating event vectors in cases where we care about speed. */
523 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
525 vlib_node_main_t *nm = &vm->node_main;
526 vec_add1 (nm->recycled_event_data_vectors, event_data);
529 /** Return the first event type which has occurred and a vector of per-event
530 data of that type, or a timeout indication
532 @param vm - vlib_main_t pointer
533 @param data_vector - pointer to a (uword *) vector to receive event data
534 @returns either an event type and a vector of per-event instance data,
535 or ~0 to indicate a timeout.
539 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
541 vlib_node_main_t *nm = &vm->node_main;
543 vlib_process_event_type_t *et;
546 p = vec_elt (nm->processes, nm->current_process_index);
548 /* Find first type with events ready.
549 Return invalid type when there's nothing there. */
550 t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
554 p->non_empty_event_type_bitmap =
555 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
557 l = _vec_len (p->pending_event_data_by_type_index[t]);
559 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
560 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
562 et = pool_elt_at_index (p->event_type_pool, t);
564 /* Return user's opaque value. */
567 vlib_process_maybe_free_event_type (p, t);
573 vlib_process_get_events_helper (vlib_process_t * p, uword t,
574 uword ** data_vector)
578 p->non_empty_event_type_bitmap =
579 clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
581 l = _vec_len (p->pending_event_data_by_type_index[t]);
583 vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
584 _vec_len (p->pending_event_data_by_type_index[t]) = 0;
586 vlib_process_maybe_free_event_type (p, t);
591 /* As above but query as specified type of event. Returns number of
594 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
595 uword with_type_opaque)
597 vlib_node_main_t *nm = &vm->node_main;
601 p = vec_elt (nm->processes, nm->current_process_index);
602 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
604 /* This can happen when an event has not yet been
605 signaled with given opaque type. */
609 if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
612 return vlib_process_get_events_helper (p, t, data_vector);
615 always_inline uword *
616 vlib_process_wait_for_event (vlib_main_t * vm)
618 vlib_node_main_t *nm = &vm->node_main;
622 p = vec_elt (nm->processes, nm->current_process_index);
623 if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
625 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
627 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
628 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
629 clib_longjmp (&p->return_longjmp,
630 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
633 return p->non_empty_event_type_bitmap;
637 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
638 uword ** data_vector,
639 uword with_type_index)
641 vlib_node_main_t *nm = &vm->node_main;
645 p = vec_elt (nm->processes, nm->current_process_index);
646 ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
647 while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
649 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
651 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
652 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
653 clib_longjmp (&p->return_longjmp,
654 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
657 return vlib_process_get_events_helper (p, with_type_index, data_vector);
661 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
662 uword ** data_vector,
663 uword with_type_opaque)
665 vlib_node_main_t *nm = &vm->node_main;
669 p = vec_elt (nm->processes, nm->current_process_index);
670 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
671 while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
673 p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
675 clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
676 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
677 clib_longjmp (&p->return_longjmp,
678 VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
680 /* See if unknown event type has been signaled now. */
682 h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
685 return vlib_process_get_events_helper (p, h[0], data_vector);
688 /** Suspend a cooperative multi-tasking thread
689 Waits for an event, or for the indicated number of seconds to elapse
690 @param vm - vlib_main_t pointer
691 @param dt - timeout, in seconds.
692 @returns the remaining time interval
696 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
698 vlib_node_main_t *nm = &vm->node_main;
703 p = vec_elt (nm->processes, nm->current_process_index);
705 if (vlib_process_suspend_time_is_zero (dt)
706 || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
709 wakeup_time = vlib_time_now (vm) + dt;
711 /* Suspend waiting for both clock and event to occur. */
712 p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
713 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
715 r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
716 if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
718 p->resume_clock_interval = dt * 1e5;
719 clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
722 /* Return amount of time still left to sleep.
723 If <= 0 then we've been waken up by the clock (and not an event). */
724 return wakeup_time - vlib_time_now (vm);
727 always_inline vlib_process_event_type_t *
728 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
730 vlib_process_event_type_t *et;
731 pool_get (p->event_type_pool, et);
732 et->opaque = with_type_opaque;
737 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
738 uword with_type_opaque)
740 vlib_node_main_t *nm = &vm->node_main;
741 vlib_node_t *n = vlib_get_node (vm, node_index);
742 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
743 vlib_process_event_type_t *et;
746 et = vlib_process_new_event_type (p, with_type_opaque);
747 t = et - p->event_type_pool;
748 p->one_time_event_type_bitmap =
749 clib_bitmap_ori (p->one_time_event_type_bitmap, t);
754 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
757 vlib_node_main_t *nm = &vm->node_main;
758 vlib_node_t *n = vlib_get_node (vm, node_index);
759 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
761 ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
762 vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
766 vlib_process_signal_event_helper (vlib_node_main_t * nm,
770 uword n_data_elts, uword n_data_elt_bytes)
772 uword p_flags, add_to_pending, delete_from_wheel;
773 void *data_to_be_written_by_caller;
775 ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
777 ASSERT (!pool_is_free_index (p->event_type_pool, t));
779 vec_validate (p->pending_event_data_by_type_index, t);
781 /* Resize data vector and return caller's data to be written. */
783 void *data_vec = p->pending_event_data_by_type_index[t];
786 if (!data_vec && vec_len (nm->recycled_event_data_vectors))
788 data_vec = vec_pop (nm->recycled_event_data_vectors);
789 _vec_len (data_vec) = 0;
792 l = vec_len (data_vec);
794 data_vec = _vec_resize (data_vec,
795 /* length_increment */ n_data_elts,
796 /* total size after increment */
797 (l + n_data_elts) * n_data_elt_bytes,
798 /* header_bytes */ 0, /* data_align */ 0);
800 p->pending_event_data_by_type_index[t] = data_vec;
801 data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
804 p->non_empty_event_type_bitmap =
805 clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
809 /* Event was already signalled? */
810 add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
812 /* Process will resume when suspend time elapses? */
813 delete_from_wheel = 0;
814 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
816 /* Waiting for both event and clock? */
817 if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
819 if (!TW (tw_timer_handle_is_free)
820 ((TWT (tw_timer_wheel) *) nm->timing_wheel,
821 p->stop_timer_handle))
822 delete_from_wheel = 1;
824 /* timer just popped so process should already be on the list */
828 /* Waiting only for clock. Event will be queue and may be
829 handled when timer expires. */
833 /* Never add current process to pending vector since current process is
835 add_to_pending &= nm->current_process_index != n->runtime_index;
839 u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
840 p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
841 vec_add1 (nm->data_from_advancing_timing_wheel, x);
842 if (delete_from_wheel)
843 TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
844 p->stop_timer_handle);
847 return data_to_be_written_by_caller;
851 vlib_process_signal_event_data (vlib_main_t * vm,
854 uword n_data_elts, uword n_data_elt_bytes)
856 vlib_node_main_t *nm = &vm->node_main;
857 vlib_node_t *n = vlib_get_node (vm, node_index);
858 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
861 /* Must be in main thread */
862 ASSERT (vlib_get_thread_index () == 0);
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 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
880 vlib_process_signal_event_at_time (vlib_main_t * vm,
884 uword n_data_elts, uword n_data_elt_bytes)
886 vlib_node_main_t *nm = &vm->node_main;
887 vlib_node_t *n = vlib_get_node (vm, node_index);
888 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
891 h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
894 vlib_process_event_type_t *et =
895 vlib_process_new_event_type (p, type_opaque);
896 t = et - p->event_type_pool;
897 hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
902 if (vlib_process_suspend_time_is_zero (dt))
903 return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
907 vlib_signal_timed_event_data_t *te;
909 pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
911 te->n_data_elts = n_data_elts;
912 te->n_data_elt_bytes = n_data_elt_bytes;
913 te->n_data_bytes = n_data_elts * n_data_elt_bytes;
915 /* Assert that structure fields are big enough. */
916 ASSERT (te->n_data_elts == n_data_elts);
917 ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
918 ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
920 te->process_node_index = n->runtime_index;
921 te->event_type_index = t;
923 p->stop_timer_handle =
924 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
925 vlib_timing_wheel_data_set_timed_event
926 (te - nm->signal_timed_event_data_pool),
928 (vlib_time_now (vm) + dt) * 1e5);
930 /* Inline data big enough to hold event? */
931 if (te->n_data_bytes < sizeof (te->inline_event_data))
932 return te->inline_event_data;
935 te->event_data_as_vector = 0;
936 vec_resize (te->event_data_as_vector, te->n_data_bytes);
937 return te->event_data_as_vector;
943 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
947 uword n_data_elt_bytes)
949 vlib_node_main_t *nm = &vm->node_main;
950 vlib_node_t *n = vlib_get_node (vm, node_index);
951 vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
952 return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
957 vlib_process_signal_event (vlib_main_t * vm,
958 uword node_index, uword type_opaque, uword data)
960 uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
961 1 /* elts */ , sizeof (uword));
966 vlib_process_signal_event_pointer (vlib_main_t * vm,
968 uword type_opaque, void *data)
970 void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
971 1 /* elts */ , sizeof (data));
976 * Signal event to process from any thread.
978 * When in doubt, use this.
981 vlib_process_signal_event_mt (vlib_main_t * vm,
982 uword node_index, uword type_opaque, uword data)
984 if (vlib_get_thread_index () != 0)
986 vlib_process_signal_event_mt_args_t args = {
987 .node_index = node_index,
988 .type_opaque = type_opaque,
991 vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
992 (u8 *) & args, sizeof (args));
995 vlib_process_signal_event (vm, node_index, type_opaque, data);
999 vlib_process_signal_one_time_event (vlib_main_t * vm,
1001 uword type_index, uword data)
1004 vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1005 1 /* elts */ , sizeof (uword));
1010 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1011 vlib_one_time_waiting_process_t * p)
1013 vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1015 clib_memset (p, ~0, sizeof (p[0]));
1019 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1020 vlib_one_time_waiting_process_t
1023 vlib_one_time_waiting_process_t *wp;
1024 vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1029 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1030 vlib_one_time_waiting_process_t
1033 p->node_index = vlib_current_process (vm);
1034 p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1036 vlib_process_wait_for_one_time_event (vm,
1037 /* don't care about data */ 0,
1042 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1043 vlib_one_time_waiting_process_t
1046 vlib_one_time_waiting_process_t *wp;
1047 vec_add2 (*wps, wp, 1);
1048 vlib_current_process_wait_for_one_time_event (vm, wp);
1052 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1053 vlib_node_runtime_t * node,
1059 ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1060 i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1061 & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1064 d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1066 (node->main_loop_count_last_dispatch >>
1067 VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1068 vi0 = node->main_loop_vector_stats[i0];
1069 vi1 = node->main_loop_vector_stats[i1];
1070 vi0 = d == 0 ? vi0 : 0;
1071 vi1 = d <= 1 ? vi1 : 0;
1073 node->main_loop_vector_stats[i0] = vi0;
1074 node->main_loop_vector_stats[i1] = vi1;
1075 node->main_loop_count_last_dispatch = vm->main_loop_count;
1076 /* Return previous counter. */
1077 return node->main_loop_vector_stats[i1];
1081 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1083 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1086 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1088 return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1092 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1094 vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1097 v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1099 return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1103 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1105 /* Return the edge index if present, ~0 otherwise */
1106 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1108 /* Add next node to given node in given slot. */
1110 vlib_node_add_next_with_slot (vlib_main_t * vm,
1111 uword node, uword next_node, uword slot);
1113 /* As above but adds to end of node's next vector. */
1115 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1117 return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1120 /* Add next node to given node in given slot. */
1122 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1123 uword node, char *next_name, uword slot);
1125 /* As above but adds to end of node's next vector. */
1127 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1129 return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1136 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1137 int barrier_sync, vlib_node_t **** node_dupsp,
1138 vlib_main_t *** stat_vmsp);
1140 /* Query node given name. */
1141 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1143 /* Rename a node. */
1144 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1146 /* Register new packet processing node. Nodes can be registered
1147 dynamically via this call or statically via the VLIB_REGISTER_NODE
1149 u32 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r);
1151 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1152 void vlib_register_all_static_nodes (vlib_main_t * vm);
1154 /* Start a process. */
1155 void vlib_start_process (vlib_main_t * vm, uword process_index);
1157 /* Sync up runtime and main node stats. */
1158 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1160 /* Node graph initialization function. */
1161 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1163 format_function_t format_vlib_node_graph;
1164 format_function_t format_vlib_node_name;
1165 format_function_t format_vlib_next_node_name;
1166 format_function_t format_vlib_node_and_next;
1167 format_function_t format_vlib_cpu_time;
1168 format_function_t format_vlib_time;
1169 /* Parse node name -> node index. */
1170 unformat_function_t unformat_vlib_node;
1173 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1174 u32 counter_index, u64 increment)
1176 vlib_node_t *n = vlib_get_node (vm, node_index);
1177 vlib_error_main_t *em = &vm->error_main;
1178 u32 node_counter_base_index = n->error_heap_index;
1179 em->counters[node_counter_base_index + counter_index] += increment;
1182 #endif /* included_vlib_node_funcs_h */
1185 * fd.io coding-style-patch-verification: ON
1188 * eval: (c-set-style "gnu")