FD.io VPP  v21.01
Vector Packet Processing
node_funcs.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * node_funcs.h: processing nodes global functions/inlines
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39 
40 /** \file
41  vlib node functions
42 */
43 
44 
45 #ifndef included_vlib_node_funcs_h
46 #define included_vlib_node_funcs_h
47 
48 #include <vppinfra/fifo.h>
50 
51 #ifdef CLIB_SANITIZE_ADDR
52 #include <sanitizer/asan_interface.h>
53 #endif
54 
57 {
58 #ifdef CLIB_SANITIZE_ADDR
59  void *stack = p ? (void *) p->stack : vlib_thread_stacks[vm->thread_index];
60  u32 stack_bytes = p ? p->log2_n_stack_bytes : VLIB_THREAD_STACK_SIZE;
61  __sanitizer_start_switch_fiber (&vm->asan_stack_save, stack, stack_bytes);
62 #endif
63 }
64 
67 {
68 #ifdef CLIB_SANITIZE_ADDR
69  const void *bottom_old;
70  size_t size_old;
71 
72  __sanitizer_finish_switch_fiber (&vm->asan_stack_save, &bottom_old,
73  &size_old);
74 #endif
75 }
76 
77 /** \brief Get vlib node by index.
78  @warning This function will ASSERT if @c i is out of range.
79  @param vm vlib_main_t pointer, varies by thread
80  @param i node index.
81  @return pointer to the requested vlib_node_t.
82 */
83 
86 {
87  return vec_elt (vm->node_main.nodes, i);
88 }
89 
90 /** \brief Get vlib node by graph arc (next) index.
91  @param vm vlib_main_t pointer, varies by thread
92  @param node_index index of original node
93  @param next_index graph arc index
94  @return pointer to the vlib_node_t at the end of the indicated arc
95 */
96 
98 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
99 {
100  vlib_node_main_t *nm = &vm->node_main;
101  vlib_node_t *n;
102 
103  n = vec_elt (nm->nodes, node_index);
104  ASSERT (next_index < vec_len (n->next_nodes));
105  return vlib_get_node (vm, n->next_nodes[next_index]);
106 }
107 
108 /** \brief Get node runtime by node index.
109  @param vm vlib_main_t pointer, varies by thread
110  @param node_index index of node
111  @return pointer to the indicated vlib_node_runtime_t
112 */
113 
116 {
117  vlib_node_main_t *nm = &vm->node_main;
118  vlib_node_t *n = vec_elt (nm->nodes, node_index);
119  vlib_process_t *p;
120  if (n->type != VLIB_NODE_TYPE_PROCESS)
121  return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
122  else
123  {
124  p = vec_elt (nm->processes, n->runtime_index);
125  return &p->node_runtime;
126  }
127 }
128 
129 /** \brief Get node runtime private data by node index.
130  @param vm vlib_main_t pointer, varies by thread
131  @param node_index index of the node
132  @return pointer to the indicated vlib_node_runtime_t private data
133 */
134 
135 always_inline void *
137 {
138  vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
139  return r->runtime_data;
140 }
141 
142 /** \brief Set node runtime private data.
143  @param vm vlib_main_t pointer, varies by thread
144  @param node_index index of the node
145  @param runtime_data arbitrary runtime private data
146  @param n_runtime_data_bytes size of runtime private data
147 */
148 
149 always_inline void
151  void *runtime_data, u32 n_runtime_data_bytes)
152 {
153  vlib_node_t *n = vlib_get_node (vm, node_index);
154  vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
155 
156  n->runtime_data_bytes = n_runtime_data_bytes;
157  vec_free (n->runtime_data);
158  vec_add (n->runtime_data, runtime_data, n_runtime_data_bytes);
159 
160  ASSERT (vec_len (n->runtime_data) <= sizeof (vlib_node_runtime_t) -
161  STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
162 
163  if (vec_len (n->runtime_data) > 0)
165  vec_len (n->runtime_data));
166 }
167 
168 /** \brief Set node dispatch state.
169  @param vm vlib_main_t pointer, varies by thread
170  @param node_index index of the node
171  @param new_state new state for node, see vlib_node_state_t
172 */
173 always_inline void
175  vlib_node_state_t new_state)
176 {
177  vlib_node_main_t *nm = &vm->node_main;
178  vlib_node_t *n;
180 
181  n = vec_elt (nm->nodes, node_index);
182  if (n->type == VLIB_NODE_TYPE_PROCESS)
183  {
185  r = &p->node_runtime;
186 
187  /* When disabling make sure flags are cleared. */
191  }
192  else
194 
195  ASSERT (new_state < VLIB_N_NODE_STATE);
196 
197  if (n->type == VLIB_NODE_TYPE_INPUT)
198  {
200  nm->input_node_counts_by_state[n->state] -= 1;
201  nm->input_node_counts_by_state[new_state] += 1;
202  }
203 
204  if (PREDICT_FALSE (r->state == VLIB_NODE_STATE_DISABLED))
205  vlib_node_runtime_perf_counter (vm, r, 0, 0, 0,
207 
208  n->state = new_state;
209  r->state = new_state;
210 }
211 
212 /** \brief Get node dispatch state.
213  @param vm vlib_main_t pointer, varies by thread
214  @param node_index index of the node
215  @return state for node, see vlib_node_state_t
216 */
219 {
220  vlib_node_main_t *nm = &vm->node_main;
221  vlib_node_t *n;
222  n = vec_elt (nm->nodes, node_index);
223  return n->state;
224 }
225 
226 always_inline void
228  u32 data)
229 {
230  vlib_node_main_t *nm = &vm->node_main;
231  vlib_node_t *n = vec_elt (nm->nodes, node_index);
234 
235  if (vm == vlib_get_main ())
236  {
237  /* local thread */
240  i->data = data;
241  }
242  else
243  {
244  /* remote thread */
248  i->data = data;
251  }
252 }
253 
254 always_inline void
256 {
257  vlib_node_set_interrupt_pending_with_data (vm, node_index, 0);
258 }
259 
262 {
263  vlib_node_main_t *nm = &vm->node_main;
265  return vec_elt (nm->processes, node->runtime_index);
266 }
267 
270 {
271  ASSERT (f != NULL);
273  return f;
274 }
275 
276 always_inline void
278 {
280 }
281 
282 /* Byte alignment for vector arguments. */
283 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
284 
287 {
288  return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
290 }
291 
292 /** \brief Get pointer to frame vector data.
293  @param f vlib_frame_t pointer
294  @return pointer to first vector element in frame
295 */
296 always_inline void *
298 {
299  return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
300 }
301 
302 /** \brief Get pointer to frame scalar data.
303 
304  @param f vlib_frame_t pointer
305 
306  @return arbitrary node scalar data
307 
308  @sa vlib_frame_vector_args
309 */
310 always_inline void *
312 {
313  return vlib_frame_vector_args (f) - f->scalar_size;
314 }
315 
318  vlib_node_runtime_t * n, u32 next_index)
319 {
320  vlib_node_main_t *nm = &vm->node_main;
321  vlib_next_frame_t *nf;
322 
323  ASSERT (next_index < n->n_next_nodes);
324  nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
325 
326  if (CLIB_DEBUG > 0)
327  {
328  vlib_node_t *node, *next;
329  node = vec_elt (nm->nodes, n->node_index);
330  next = vec_elt (nm->nodes, node->next_nodes[next_index]);
331  ASSERT (nf->node_runtime_index == next->runtime_index);
332  }
333 
334  return nf;
335 }
336 
337 /** \brief Get pointer to frame by (@c node_index, @c next_index).
338 
339  @warning This is not a function that you should call directly.
340  See @ref vlib_get_next_frame instead.
341 
342  @param vm vlib_main_t pointer, varies by thread
343  @param node_index index of the node
344  @param next_index graph arc index
345 
346  @return pointer to the requested vlib_next_frame_t
347 
348  @sa vlib_get_next_frame
349 */
350 
352 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
353 {
354  vlib_node_main_t *nm = &vm->node_main;
355  vlib_node_t *n;
357 
358  n = vec_elt (nm->nodes, node_index);
360  return vlib_node_runtime_get_next_frame (vm, r, next_index);
361 }
362 
364  vlib_node_runtime_t * node,
365  u32 next_index,
366  u32 alloc_new_frame);
367 
368 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
369 do { \
370  vlib_frame_t * _f \
371  = vlib_get_next_frame_internal ((vm), (node), (next_index), \
372  (alloc_new_frame)); \
373  u32 _n = _f->n_vectors; \
374  (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
375  (n_vectors_left) = VLIB_FRAME_SIZE - _n; \
376 } while (0)
377 
378 
379 /** \brief Get pointer to next frame vector data by
380  (@c vlib_node_runtime_t, @c next_index).
381  Standard single/dual loop boilerplate element.
382  @attention This is a MACRO, with SIDE EFFECTS.
383 
384  @param vm vlib_main_t pointer, varies by thread
385  @param node current node vlib_node_runtime_t pointer
386  @param next_index requested graph arc index
387 
388  @return @c vectors -- pointer to next available vector slot
389  @return @c n_vectors_left -- number of vector slots available
390 */
391 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left) \
392  vlib_get_next_frame_macro (vm, node, next_index, \
393  vectors, n_vectors_left, \
394  /* alloc new frame */ 0)
395 
396 #define vlib_get_new_next_frame(vm,node,next_index,vectors,n_vectors_left) \
397  vlib_get_next_frame_macro (vm, node, next_index, \
398  vectors, n_vectors_left, \
399  /* alloc new frame */ 1)
400 
401 /** \brief Release pointer to next frame vector data.
402  Standard single/dual loop boilerplate element.
403  @param vm vlib_main_t pointer, varies by thread
404  @param r current node vlib_node_runtime_t pointer
405  @param next_index graph arc index
406  @param n_packets_left number of slots still available in vector
407 */
408 void
411  u32 next_index, u32 n_packets_left);
412 
413 /* Combination get plus put. Returns vector argument just added. */
414 #define vlib_set_next_frame(vm,node,next_index,v) \
415 ({ \
416  uword _n_left; \
417  vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left); \
418  ASSERT (_n_left > 0); \
419  vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1); \
420  (v); \
421 })
422 
423 always_inline void
425  vlib_node_runtime_t * node,
426  u32 next_index, u32 buffer_index)
427 {
428  u32 *p;
429  p = vlib_set_next_frame (vm, node, next_index, p);
430  p[0] = buffer_index;
431 }
432 
433 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
434 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
435  vlib_frame_t * f);
436 
439 {
440  return vm->node_main.current_process_index != ~0;
441 }
442 
445 {
446  vlib_node_main_t *nm = &vm->node_main;
447  if (vlib_in_process_context (vm))
448  return vec_elt (nm->processes, nm->current_process_index);
449  return 0;
450 }
451 
454 {
456 }
457 
460 {
462  return process->node_runtime.node_index;
463 }
464 
465 /** Returns TRUE if a process suspend time is less than 10us
466  @param dt - remaining poll time in seconds
467  @returns 1 if dt < 10e-6, 0 otherwise
468 */
471 {
472  return dt < 10e-6;
473 }
474 
475 /** Suspend a vlib cooperative multi-tasking thread for a period of time
476  @param vm - vlib_main_t *
477  @param dt - suspend interval in seconds
478  @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
479 */
480 
483 {
484  uword r;
485  vlib_node_main_t *nm = &vm->node_main;
487 
490 
494  {
495  /* expiration time in 10us ticks */
496  p->resume_clock_interval = dt * 1e5;
499  }
500  else
502 
503  return r;
504 }
505 
506 always_inline void
508  uword is_one_time_event)
509 {
512  if (is_one_time_event)
514  clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
515 }
516 
517 always_inline void
519 {
522  vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
523 }
524 
525 always_inline void *
527  uword * return_event_type_opaque)
528 {
529  vlib_node_main_t *nm = &vm->node_main;
530  vlib_process_t *p;
532  uword t;
533  void *event_data_vector;
534 
535  p = vec_elt (nm->processes, nm->current_process_index);
536 
537  /* Find first type with events ready.
538  Return invalid type when there's nothing there. */
540  if (t == ~0)
541  return 0;
542 
544  clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
545 
546  ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
547  event_data_vector = p->pending_event_data_by_type_index[t];
549 
550  et = pool_elt_at_index (p->event_type_pool, t);
551 
552  /* Return user's opaque value and possibly index. */
553  *return_event_type_opaque = et->opaque;
554 
556 
557  return event_data_vector;
558 }
559 
560 /* Return event data vector for later reuse. We reuse event data to avoid
561  repeatedly allocating event vectors in cases where we care about speed. */
562 always_inline void
563 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
564 {
565  vlib_node_main_t *nm = &vm->node_main;
566  vec_add1 (nm->recycled_event_data_vectors, event_data);
567 }
568 
569 /** Return the first event type which has occurred and a vector of per-event
570  data of that type, or a timeout indication
571 
572  @param vm - vlib_main_t pointer
573  @param data_vector - pointer to a (uword *) vector to receive event data
574  @returns either an event type and a vector of per-event instance data,
575  or ~0 to indicate a timeout.
576 */
577 
580 {
581  vlib_node_main_t *nm = &vm->node_main;
582  vlib_process_t *p;
584  uword r, t, l;
585 
586  p = vec_elt (nm->processes, nm->current_process_index);
587 
588  /* Find first type with events ready.
589  Return invalid type when there's nothing there. */
591  if (t == ~0)
592  return t;
593 
595  clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
596 
597  l = _vec_len (p->pending_event_data_by_type_index[t]);
598  if (data_vector)
599  vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
600  _vec_len (p->pending_event_data_by_type_index[t]) = 0;
601 
602  et = pool_elt_at_index (p->event_type_pool, t);
603 
604  /* Return user's opaque value. */
605  r = et->opaque;
606 
608 
609  return r;
610 }
611 
614  uword ** data_vector)
615 {
616  uword l;
617 
619  clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
620 
621  l = _vec_len (p->pending_event_data_by_type_index[t]);
622  if (data_vector)
623  vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
624  _vec_len (p->pending_event_data_by_type_index[t]) = 0;
625 
627 
628  return l;
629 }
630 
631 /* As above but query as specified type of event. Returns number of
632  events found. */
635  uword with_type_opaque)
636 {
637  vlib_node_main_t *nm = &vm->node_main;
638  vlib_process_t *p;
639  uword t, *h;
640 
641  p = vec_elt (nm->processes, nm->current_process_index);
642  h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
643  if (!h)
644  /* This can happen when an event has not yet been
645  signaled with given opaque type. */
646  return 0;
647 
648  t = h[0];
650  return 0;
651 
652  return vlib_process_get_events_helper (p, t, data_vector);
653 }
654 
657 {
658  vlib_node_main_t *nm = &vm->node_main;
659  vlib_process_t *p;
660  uword r;
661 
662  p = vec_elt (nm->processes, nm->current_process_index);
664  {
666  r =
669  {
673  }
674  else
676  }
677 
678  return p->non_empty_event_type_bitmap;
679 }
680 
683  uword ** data_vector,
684  uword with_type_index)
685 {
686  vlib_node_main_t *nm = &vm->node_main;
687  vlib_process_t *p;
688  uword r;
689 
690  p = vec_elt (nm->processes, nm->current_process_index);
691  ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
692  while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
693  {
695  r =
698  {
702  }
703  else
705  }
706 
707  return vlib_process_get_events_helper (p, with_type_index, data_vector);
708 }
709 
712  uword ** data_vector,
713  uword with_type_opaque)
714 {
715  vlib_node_main_t *nm = &vm->node_main;
716  vlib_process_t *p;
717  uword r, *h;
718 
719  p = vec_elt (nm->processes, nm->current_process_index);
720  h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
721  while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
722  {
724  r =
727  {
731  }
732  else
734 
735  /* See if unknown event type has been signaled now. */
736  if (!h)
737  h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
738  }
739 
740  return vlib_process_get_events_helper (p, h[0], data_vector);
741 }
742 
743 /** Suspend a cooperative multi-tasking thread
744  Waits for an event, or for the indicated number of seconds to elapse
745  @param vm - vlib_main_t pointer
746  @param dt - timeout, in seconds.
747  @returns the remaining time interval
748 */
749 
752 {
753  vlib_node_main_t *nm = &vm->node_main;
754  vlib_process_t *p;
755  f64 wakeup_time;
756  uword r;
757 
758  p = vec_elt (nm->processes, nm->current_process_index);
759 
762  return dt;
763 
764  wakeup_time = vlib_time_now (vm) + dt;
765 
766  /* Suspend waiting for both clock and event to occur. */
769 
772  {
773  p->resume_clock_interval = dt * 1e5;
776  }
777  else
779 
780  /* Return amount of time still left to sleep.
781  If <= 0 then we've been waken up by the clock (and not an event). */
782  return wakeup_time - vlib_time_now (vm);
783 }
784 
787 {
789  pool_get (p->event_type_pool, et);
790  et->opaque = with_type_opaque;
791  return et;
792 }
793 
796  uword with_type_opaque)
797 {
798  vlib_node_main_t *nm = &vm->node_main;
799  vlib_node_t *n = vlib_get_node (vm, node_index);
802  uword t;
803 
804  et = vlib_process_new_event_type (p, with_type_opaque);
805  t = et - p->event_type_pool;
807  clib_bitmap_ori (p->one_time_event_type_bitmap, t);
808  return t;
809 }
810 
811 always_inline void
813  uword t)
814 {
815  vlib_node_main_t *nm = &vm->node_main;
816  vlib_node_t *n = vlib_get_node (vm, node_index);
818 
820  vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
821 }
822 
823 always_inline void *
825  vlib_node_t * n,
826  vlib_process_t * p,
827  uword t,
828  uword n_data_elts, uword n_data_elt_bytes)
829 {
830  uword p_flags, add_to_pending, delete_from_wheel;
831  void *data_to_be_written_by_caller;
832 
834 
836 
838 
839  /* Resize data vector and return caller's data to be written. */
840  {
841  void *data_vec = p->pending_event_data_by_type_index[t];
842  uword l;
843 
844  if (!data_vec && vec_len (nm->recycled_event_data_vectors))
845  {
846  data_vec = vec_pop (nm->recycled_event_data_vectors);
847  _vec_len (data_vec) = 0;
848  }
849 
850  l = vec_len (data_vec);
851 
852  data_vec = _vec_resize (data_vec,
853  /* length_increment */ n_data_elts,
854  /* total size after increment */
855  (l + n_data_elts) * n_data_elt_bytes,
856  /* header_bytes */ 0, /* data_align */ 0);
857 
858  p->pending_event_data_by_type_index[t] = data_vec;
859  data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
860  }
861 
863  clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
864 
865  p_flags = p->flags;
866 
867  /* Event was already signalled? */
868  add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
869 
870  /* Process will resume when suspend time elapses? */
871  delete_from_wheel = 0;
873  {
874  /* Waiting for both event and clock? */
876  {
878  ((TWT (tw_timer_wheel) *) nm->timing_wheel,
879  p->stop_timer_handle))
880  delete_from_wheel = 1;
881  else
882  /* timer just popped so process should already be on the list */
883  add_to_pending = 0;
884  }
885  else
886  /* Waiting only for clock. Event will be queue and may be
887  handled when timer expires. */
888  add_to_pending = 0;
889  }
890 
891  /* Never add current process to pending vector since current process is
892  already running. */
893  add_to_pending &= nm->current_process_index != n->runtime_index;
894 
895  if (add_to_pending)
896  {
898  p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
900  if (delete_from_wheel)
901  TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
902  p->stop_timer_handle);
903  }
904 
905  return data_to_be_written_by_caller;
906 }
907 
908 always_inline void *
910  uword node_index,
911  uword type_opaque,
912  uword n_data_elts, uword n_data_elt_bytes)
913 {
914  vlib_node_main_t *nm = &vm->node_main;
915  vlib_node_t *n = vlib_get_node (vm, node_index);
917  uword *h, t;
918 
919  /* Must be in main thread */
920  ASSERT (vlib_get_thread_index () == 0);
921 
922  h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
923  if (!h)
924  {
926  vlib_process_new_event_type (p, type_opaque);
927  t = et - p->event_type_pool;
928  hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
929  }
930  else
931  t = h[0];
932 
933  return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
934  n_data_elt_bytes);
935 }
936 
937 always_inline void *
939  f64 dt,
940  uword node_index,
941  uword type_opaque,
942  uword n_data_elts, uword n_data_elt_bytes)
943 {
944  vlib_node_main_t *nm = &vm->node_main;
945  vlib_node_t *n = vlib_get_node (vm, node_index);
947  uword *h, t;
948 
949  h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
950  if (!h)
951  {
953  vlib_process_new_event_type (p, type_opaque);
954  t = et - p->event_type_pool;
955  hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
956  }
957  else
958  t = h[0];
959 
961  return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
962  n_data_elt_bytes);
963  else
964  {
966 
967  pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
968 
969  te->n_data_elts = n_data_elts;
970  te->n_data_elt_bytes = n_data_elt_bytes;
971  te->n_data_bytes = n_data_elts * n_data_elt_bytes;
972 
973  /* Assert that structure fields are big enough. */
974  ASSERT (te->n_data_elts == n_data_elts);
975  ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
976  ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
977 
979  te->event_type_index = t;
980 
981  p->stop_timer_handle =
982  TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
984  (te - nm->signal_timed_event_data_pool),
985  0 /* timer_id */ ,
986  (vlib_time_now (vm) + dt) * 1e5);
987 
988  /* Inline data big enough to hold event? */
989  if (te->n_data_bytes < sizeof (te->inline_event_data))
990  return te->inline_event_data;
991  else
992  {
993  te->event_data_as_vector = 0;
995  return te->event_data_as_vector;
996  }
997  }
998 }
999 
1000 always_inline void *
1002  uword node_index,
1003  uword type_index,
1004  uword n_data_elts,
1005  uword n_data_elt_bytes)
1006 {
1007  vlib_node_main_t *nm = &vm->node_main;
1008  vlib_node_t *n = vlib_get_node (vm, node_index);
1010  return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
1011  n_data_elt_bytes);
1012 }
1013 
1014 always_inline void
1016  uword node_index, uword type_opaque, uword data)
1017 {
1018  uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1019  1 /* elts */ , sizeof (uword));
1020  d[0] = data;
1021 }
1022 
1023 always_inline void
1025  uword node_index,
1026  uword type_opaque, void *data)
1027 {
1028  void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1029  1 /* elts */ , sizeof (data));
1030  d[0] = data;
1031 }
1032 
1033 /**
1034  * Signal event to process from any thread.
1035  *
1036  * When in doubt, use this.
1037  */
1038 always_inline void
1040  uword node_index, uword type_opaque, uword data)
1041 {
1042  if (vlib_get_thread_index () != 0)
1043  {
1045  .node_index = node_index,
1046  .type_opaque = type_opaque,
1047  .data = data,
1048  };
1050  (u8 *) & args, sizeof (args));
1051  }
1052  else
1053  vlib_process_signal_event (vm, node_index, type_opaque, data);
1054 }
1055 
1056 always_inline void
1058  uword node_index,
1059  uword type_index, uword data)
1060 {
1061  uword *d =
1062  vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1063  1 /* elts */ , sizeof (uword));
1064  d[0] = data;
1065 }
1066 
1067 always_inline void
1070 {
1072  /* data */ ~0);
1073  clib_memset (p, ~0, sizeof (p[0]));
1074 }
1075 
1076 always_inline void
1079  ** wps)
1080 {
1083  vec_free (*wps);
1084 }
1085 
1086 always_inline void
1089  * p)
1090 {
1091  p->node_index = vlib_current_process (vm);
1092  p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
1093  ~0);
1095  /* don't care about data */ 0,
1096  p->one_time_event);
1097 }
1098 
1099 always_inline void
1102  ** wps)
1103 {
1105  vec_add2 (*wps, wp, 1);
1107 }
1108 
1111  vlib_node_runtime_t * node,
1112  uword n_vectors)
1113 {
1114  u32 i, d, vi0, vi1;
1115  u32 i0, i1;
1116 
1119  & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1120  i0 = i ^ 0;
1121  i1 = i ^ 1;
1123  -
1126  vi0 = node->main_loop_vector_stats[i0];
1127  vi1 = node->main_loop_vector_stats[i1];
1128  vi0 = d == 0 ? vi0 : 0;
1129  vi1 = d <= 1 ? vi1 : 0;
1130  vi0 += n_vectors;
1131  node->main_loop_vector_stats[i0] = vi0;
1132  node->main_loop_vector_stats[i1] = vi1;
1134  /* Return previous counter. */
1135  return node->main_loop_vector_stats[i1];
1136 }
1137 
1140 {
1141  vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1142  u32 v;
1143 
1144  v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1145  0);
1146  return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1147 }
1148 
1151 {
1152  vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1153  u32 v;
1154 
1155  v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1156  0);
1158 }
1159 
1160 void
1162 
1163 /* Return the edge index if present, ~0 otherwise */
1164 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1165 
1166 /* Add next node to given node in given slot. */
1167 uword
1169  uword node, uword next_node, uword slot);
1170 
1171 /* As above but adds to end of node's next vector. */
1174 {
1175  return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1176 }
1177 
1178 /* Add next node to given node in given slot. */
1179 uword
1181  uword node, char *next_name, uword slot);
1182 
1183 /* As above but adds to end of node's next vector. */
1186 {
1187  return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1188 }
1189 
1190 /**
1191  * Get list of nodes
1192  */
1193 void
1194 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1195  int barrier_sync, vlib_node_t **** node_dupsp,
1196  vlib_main_t *** stat_vmsp);
1197 
1198 /* Query node given name. */
1200 
1201 /* Rename a node. */
1202 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1203 
1204 /* Register new packet processing node. Nodes can be registered
1205  dynamically via this call or statically via the VLIB_REGISTER_NODE
1206  macro. */
1208 
1209 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1211 
1212 /* Start a process. */
1213 void vlib_start_process (vlib_main_t * vm, uword process_index);
1214 
1215 /* Sync up runtime and main node stats. */
1217 
1218 /* Node graph initialization function. */
1220 
1227 /* Parse node name -> node index. */
1229 
1230 always_inline void
1232  u32 counter_index, u64 increment)
1233 {
1234  vlib_node_t *n = vlib_get_node (vm, node_index);
1235  vlib_error_main_t *em = &vm->error_main;
1236  u32 node_counter_base_index = n->error_heap_index;
1237  em->counters[node_counter_base_index + counter_index] += increment;
1238 }
1239 
1240 /** @brief Create a vlib process
1241  * @param vm &vlib_global_main
1242  * @param f the process node function
1243  * @param log2_n_stack_bytes size of the process stack, defaults to 16K
1244  * @return newly-create node index
1245  * @warning call only on the main thread. Barrier sync required
1246  */
1248  vlib_node_function_t * f, u32 log2_n_stack_bytes);
1249 
1250 #endif /* included_vlib_node_funcs_h */
1251 
1252 /*
1253  * fd.io coding-style-patch-verification: ON
1254  *
1255  * Local Variables:
1256  * eval: (c-set-style "gnu")
1257  * End:
1258  */
u32 * next_nodes
Definition: node.h:335
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:509
static void vlib_node_set_runtime_data(vlib_main_t *vm, u32 node_index, void *runtime_data, u32 n_runtime_data_bytes)
Set node runtime private data.
Definition: node_funcs.h:150
volatile u32 main_loop_count
Definition: main.h:135
static void vlib_process_free_event_type(vlib_process_t *p, uword t, uword is_one_time_event)
Definition: node_funcs.h:507
volatile u32 * pending_remote_interrupts_notify
Definition: node.h:695
u32 error_heap_index
Definition: node.h:325
u32 next_frame_index
Start of next frames for this node.
Definition: node.h:485
#define hash_set(h, key, value)
Definition: hash.h:255
static void vlib_signal_one_time_waiting_process_vector(vlib_main_t *vm, vlib_one_time_waiting_process_t **wps)
Definition: node_funcs.h:1077
static_always_inline void clib_spinlock_unlock(clib_spinlock_t *p)
Definition: lock.h:121
static_always_inline void clib_spinlock_lock(clib_spinlock_t *p)
Definition: lock.h:82
__clib_export void TW() tw_timer_stop(TWT(tw_timer_wheel) *tw, u32 handle)
Stop a tw timer.
static vlib_next_frame_t * vlib_node_get_next_frame(vlib_main_t *vm, u32 node_index, u32 next_index)
Get pointer to frame by (node_index, next_index).
Definition: node_funcs.h:352
static void vlib_signal_one_time_waiting_process(vlib_main_t *vm, vlib_one_time_waiting_process_t *p)
Definition: node_funcs.h:1068
vlib_process_t ** processes
Definition: node.h:723
static f64 vlib_process_wait_for_event_or_clock(vlib_main_t *vm, f64 dt)
Suspend a cooperative multi-tasking thread Waits for an event, or for the indicated number of seconds...
Definition: node_funcs.h:751
format_function_t format_vlib_node_name
Definition: node_funcs.h:1222
static f64 vlib_node_vectors_per_main_loop_as_float(vlib_main_t *vm, u32 node_index)
Definition: node_funcs.h:1139
vlib_node_runtime_t node_runtime
Definition: node.h:551
uword vlib_node_get_next(vlib_main_t *vm, uword node, uword next_node)
Definition: node.c:151
void vlib_put_frame_to_node(vlib_main_t *vm, u32 to_node_index, vlib_frame_t *f)
Definition: main.c:216
u8 runtime_data[0]
Function dependent node-runtime data.
Definition: node.h:519
static uword * vlib_process_wait_for_event(vlib_main_t *vm)
Definition: node_funcs.h:656
static void vlib_set_next_frame_buffer(vlib_main_t *vm, vlib_node_runtime_t *node, u32 next_index, u32 buffer_index)
Definition: node_funcs.h:424
static uword vlib_current_process(vlib_main_t *vm)
Definition: node_funcs.h:453
unsigned long u64
Definition: types.h:89
static void vlib_node_set_interrupt_pending(vlib_main_t *vm, u32 node_index)
Definition: node_funcs.h:255
#define clib_memcpy_fast(a, b, c)
Definition: string.h:81
static uword vlib_node_add_named_next(vlib_main_t *vm, uword node, char *name)
Definition: node_funcs.h:1185
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:334
vlib_node_t * vlib_get_node_by_name(vlib_main_t *vm, u8 *name)
Definition: node.c:45
u32 main_loop_vector_stats[2]
Definition: node.h:499
void ** pending_event_data_by_type_index
Definition: node.h:582
u32 current_process_index
Definition: node.h:726
u32 thread_index
Definition: main.h:250
static vlib_frame_t * vlib_get_frame(vlib_main_t *vm, vlib_frame_t *f)
Definition: node_funcs.h:269
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:592
#define vlib_set_next_frame(vm, node, next_index, v)
Definition: node_funcs.h:414
void vlib_process_signal_event_mt_helper(vlib_process_signal_event_mt_args_t *args)
Definition: threads.c:1934
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:630
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:70
void clib_longjmp(clib_longjmp_t *save, uword return_value)
static void vlib_node_set_interrupt_pending_with_data(vlib_main_t *vm, u32 node_index, u32 data)
Definition: node_funcs.h:227
format_function_t format_vlib_cpu_time
Definition: node_funcs.h:1225
clib_spinlock_t pending_interrupt_lock
Definition: node.h:696
void * runtime_data
Definition: node.h:286
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:251
uword clib_setjmp(clib_longjmp_t *save, uword return_value_not_taken)
static uword vlib_node_add_next(vlib_main_t *vm, uword node, uword next_node)
Definition: node_funcs.h:1173
unsigned char u8
Definition: types.h:56
#define vec_pop(V)
Returns last element of a vector and decrements its length.
Definition: vec.h:685
static uword vlib_process_suspend_time_is_zero(f64 dt)
Returns TRUE if a process suspend time is less than 10us.
Definition: node_funcs.h:470
u8 data[128]
Definition: ipsec_types.api:90
static vlib_process_event_type_t * vlib_process_new_event_type(vlib_process_t *p, uword with_type_opaque)
Definition: node_funcs.h:786
double f64
Definition: types.h:142
u8 state
Definition: node.h:309
#define vec_add(V, E, N)
Add N elements to end of vector V (no header, unspecified alignment)
Definition: vec.h:668
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
static uword vlib_process_suspend(vlib_main_t *vm, f64 dt)
Suspend a vlib cooperative multi-tasking thread for a period of time.
Definition: node_funcs.h:482
u32 main_loop_count_last_dispatch
Saved main loop counter of last dispatch of this node.
Definition: node.h:496
void vlib_node_rename(vlib_main_t *vm, u32 node_index, char *fmt,...)
Definition: node.c:75
#define static_always_inline
Definition: clib.h:109
#define VLIB_FRAME_NO_APPEND
Definition: node.h:419
void ** recycled_event_data_vectors
Definition: node.h:732
static uword vlib_process_get_events(vlib_main_t *vm, uword **data_vector)
Return the first event type which has occurred and a vector of per-event data of that type...
Definition: node_funcs.h:579
format_function_t format_vlib_node_and_next
Definition: node_funcs.h:1224
static uword clib_bitmap_is_zero(uword *ai)
predicate function; is an entire bitmap empty?
Definition: bitmap.h:57
u16 log2_n_stack_bytes
Definition: node.h:574
vlib_node_t ** nodes
Definition: node.h:680
#define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
Definition: main.h:154
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
format_function_t format_vlib_next_node_name
Definition: node_funcs.h:1223
#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
Definition: node.h:565
#define vec_resize(V, N)
Resize a vector (no header, unspecified alignment) Add N elements to end of given vector V...
Definition: vec.h:281
vlib_node_interrupt_t * pending_remote_interrupts
Definition: node.h:694
void vlib_frame_free(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_frame_t *f)
Definition: main.c:238
static_always_inline void vlib_process_start_switch_stack(vlib_main_t *vm, vlib_process_t *p)
Definition: node_funcs.h:56
unsigned int u32
Definition: types.h:88
u32 vlib_process_create(vlib_main_t *vm, char *name, vlib_node_function_t *f, u32 log2_n_stack_bytes)
Create a vlib process.
Definition: node.c:726
static void vlib_process_delete_one_time_event(vlib_main_t *vm, uword node_index, uword t)
Definition: node_funcs.h:812
vlib_node_runtime_t * nodes_by_type[VLIB_N_NODE_TYPE]
Definition: node.h:690
static vlib_next_frame_t * vlib_node_runtime_get_next_frame(vlib_main_t *vm, vlib_node_runtime_t *n, u32 next_index)
Definition: node_funcs.h:317
static vlib_node_state_t vlib_node_get_state(vlib_main_t *vm, u32 node_index)
Get node dispatch state.
Definition: node_funcs.h:218
clib_error_t * vlib_node_main_init(vlib_main_t *vm)
Definition: node.c:596
#define hash_get(h, key)
Definition: hash.h:249
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:546
static void * vlib_process_signal_event_helper(vlib_node_main_t *nm, vlib_node_t *n, vlib_process_t *p, uword t, uword n_data_elts, uword n_data_elt_bytes)
Definition: node_funcs.h:824
u16 state
Input node state.
Definition: node.h:503
u32 vlib_register_node(vlib_main_t *vm, vlib_node_registration_t *r)
Definition: node.c:485
static void vlib_process_signal_event(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Definition: node_funcs.h:1015
vlib_signal_timed_event_data_t * signal_timed_event_data_pool
Definition: node.h:713
static uword clib_bitmap_first_set(uword *ai)
Return the lowest numbered set bit in a bitmap.
Definition: bitmap.h:391
vlib_error_main_t error_main
Definition: main.h:210
u16 frame_flags
Definition: node.h:385
#define VLIB_FRAME_IS_ALLOCATED
Definition: node.h:426
static void vlib_process_maybe_free_event_type(vlib_process_t *p, uword t)
Definition: node_funcs.h:518
vec_header_t h
Definition: buffer.c:322
#define TWT(a)
static void * vlib_process_signal_event_data(vlib_main_t *vm, uword node_index, uword type_opaque, uword n_data_elts, uword n_data_elt_bytes)
Definition: node_funcs.h:909
static void * vlib_node_get_runtime_data(vlib_main_t *vm, u32 node_index)
Get node runtime private data by node index.
Definition: node_funcs.h:136
static void vlib_process_signal_one_time_event(vlib_main_t *vm, uword node_index, uword type_index, uword data)
Definition: node_funcs.h:1057
#define PREDICT_FALSE(x)
Definition: clib.h:121
#define always_inline
Definition: ipsec.h:28
u32 node_index
Node index.
Definition: node.h:488
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:232
#define VLIB_PROCESS_RESUME_LONGJMP_RESUME
Definition: node.h:562
int cJSON_bool fmt
Definition: cJSON.h:160
static u32 counter_index(vlib_main_t *vm, vlib_error_t e)
Definition: drop.c:67
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1231
#define pool_get_aligned(P, E, A)
Allocate an object E from a pool P with alignment A.
Definition: pool.h:245
static uword vlib_process_get_events_with_type(vlib_main_t *vm, uword **data_vector, uword with_type_opaque)
Definition: node_funcs.h:634
#define VLIB_FRAME_VECTOR_ALIGN
Definition: node_funcs.h:283
u8 slot
Definition: pci_types.api:22
u64 * counters
Definition: error.h:62
static u32 vlib_node_runtime_update_main_loop_vector_stats(vlib_main_t *vm, vlib_node_runtime_t *node, uword n_vectors)
Definition: node_funcs.h:1110
static void vlib_process_signal_event_pointer(vlib_main_t *vm, uword node_index, uword type_opaque, void *data)
Definition: node_funcs.h:1024
u8 inline_event_data[64 - 3 *sizeof(u32) - 2 *sizeof(u16)]
Definition: node.h:639
static void * vlib_process_signal_event_at_time(vlib_main_t *vm, f64 dt, uword node_index, uword type_opaque, uword n_data_elts, uword n_data_elt_bytes)
Definition: node_funcs.h:938
u32 runtime_index
Definition: node.h:283
uword vlib_node_add_named_next_with_slot(vlib_main_t *vm, uword node, char *next_name, uword slot)
Definition: node.c:243
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:219
static vlib_process_t * vlib_get_current_process(vlib_main_t *vm)
Definition: node_funcs.h:444
#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND
Definition: node.h:561
static uword vlib_process_wait_for_one_time_event(vlib_main_t *vm, uword **data_vector, uword with_type_index)
Definition: node_funcs.h:682
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:317
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:380
static void vlib_process_signal_event_mt(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Signal event to process from any thread.
Definition: node_funcs.h:1039
__clib_export int TW() tw_timer_handle_is_free(TWT(tw_timer_wheel) *tw, u32 handle)
#define VLIB_PROCESS_RESUME_PENDING
Definition: node.h:568
static vlib_node_runtime_t * vlib_node_get_runtime(vlib_main_t *vm, u32 node_index)
Get node runtime by node index.
Definition: node_funcs.h:115
static uword vlib_process_create_one_time_event(vlib_main_t *vm, uword node_index, uword with_type_opaque)
Definition: node_funcs.h:795
uword vlib_node_add_next_with_slot(vlib_main_t *vm, uword node, uword next_node, uword slot)
Definition: node.c:172
static void * vlib_frame_scalar_args(vlib_frame_t *f)
Get pointer to frame scalar data.
Definition: node_funcs.h:311
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:298
static u32 vlib_frame_vector_byte_offset(u32 scalar_size)
Definition: node_funcs.h:286
#define ARRAY_LEN(x)
Definition: clib.h:67
static uword clib_bitmap_get(uword *ai, uword i)
Gets the ith bit value from a bitmap.
Definition: bitmap.h:197
static uword round_pow2(uword x, uword pow2)
Definition: clib.h:265
string name[64]
Definition: ip.api:44
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1578
uword * one_time_event_type_bitmap
Definition: node.h:588
static u32 vlib_node_vectors_per_main_loop_as_integer(vlib_main_t *vm, u32 node_index)
Definition: node_funcs.h:1150
u32 node_runtime_index
Definition: node.h:673
vlib_node_interrupt_t * pending_local_interrupts
Definition: node.h:693
static void vlib_node_runtime_perf_counter(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame, uword n, u64 t, vlib_node_runtime_perf_call_type_t call_type)
Definition: main.h:442
void vlib_start_process(vlib_main_t *vm, uword process_index)
Definition: main.c:1609
#define pool_put_index(p, i)
Free pool element with given index.
Definition: pool.h:330
#define ASSERT(truth)
static uword vlib_process_get_events_helper(vlib_process_t *p, uword t, uword **data_vector)
Definition: node_funcs.h:613
__clib_export u32 TW() tw_timer_start(TWT(tw_timer_wheel) *tw, u32 user_id, u32 timer_id, u64 interval)
Start a Tw Timer.
uword() vlib_node_function_t(struct vlib_main_t *vm, struct vlib_node_runtime_t *node, struct vlib_frame_t *frame)
Definition: node.h:54
static_always_inline void vlib_process_finish_switch_stack(vlib_main_t *vm)
Definition: node_funcs.h:66
static void vlib_node_set_state(vlib_main_t *vm, u32 node_index, vlib_node_state_t new_state)
Set node dispatch state.
Definition: node_funcs.h:174
vlib_frame_t * vlib_get_next_frame_internal(vlib_main_t *vm, vlib_node_runtime_t *node, u32 next_index, u32 alloc_new_frame)
Definition: main.c:379
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
static uword is_pow2(uword x)
Definition: clib.h:253
static void vlib_current_process_wait_for_one_time_event_vector(vlib_main_t *vm, vlib_one_time_waiting_process_t **wps)
Definition: node_funcs.h:1100
#define vec_elt(v, i)
Get vector value at index i.
struct _vlib_node_registration vlib_node_registration_t
void vlib_node_sync_stats(vlib_main_t *vm, vlib_node_t *n)
Definition: main.c:599
void vlib_put_next_frame(vlib_main_t *vm, vlib_node_runtime_t *r, u32 next_index, u32 n_packets_left)
Release pointer to next frame vector data.
Definition: main.c:483
static vlib_node_t * vlib_get_next_node(vlib_main_t *vm, u32 node_index, u32 next_index)
Get vlib node by graph arc (next) index.
Definition: node_funcs.h:98
static u32 vlib_get_current_process_node_index(vlib_main_t *vm)
Definition: node_funcs.h:459
static void * vlib_process_get_event_data(vlib_main_t *vm, uword *return_event_type_opaque)
Definition: node_funcs.h:526
vlib_process_event_type_t * event_type_pool
Definition: node.h:595
u32 * data_from_advancing_timing_wheel
Definition: node.h:716
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
void vlib_rpc_call_main_thread(void *callback, u8 *args, u32 arg_size)
Definition: threads.c:1945
u32 input_node_counts_by_state[VLIB_N_NODE_STATE]
Definition: node.h:735
vlib_node_main_t node_main
Definition: main.h:188
static uword vlib_process_wait_for_event_with_type(vlib_main_t *vm, uword **data_vector, uword with_type_opaque)
Definition: node_funcs.h:711
u64 uword
Definition: types.h:112
format_function_t format_vlib_time
Definition: node_funcs.h:1226
vlib_next_frame_t * next_frames
Definition: node.h:705
static u32 vlib_timing_wheel_data_set_timed_event(u32 i)
Definition: node.h:660
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:297
u32 stop_timer_handle
Definition: node.h:604
uword * event_type_index_by_type_opaque
Definition: node.h:592
#define VLIB_THREAD_STACK_SIZE
Definition: threads.h:67
unformat_function_t unformat_vlib_node
Definition: node_funcs.h:1228
u64 resume_clock_interval
Definition: node.h:601
u16 flags
Definition: node.h:564
static uword vlib_in_process_context(vlib_main_t *vm)
Definition: node_funcs.h:438
vlib_node_type_t type
Definition: node.h:277
static vlib_process_t * vlib_get_process_from_node(vlib_main_t *vm, vlib_node_t *node)
Definition: node_funcs.h:261
vlib_node_state_t
Definition: node.h:250
static void vlib_process_put_event_data(vlib_main_t *vm, void *event_data)
Definition: node_funcs.h:563
u32 * stack
Definition: node.h:613
void vlib_register_all_static_nodes(vlib_main_t *vm)
Definition: node.c:505
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:85
#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
Definition: node.h:566
#define vec_foreach(var, vec)
Vector iterator.
clib_longjmp_t return_longjmp
Definition: node.h:554
u32 node_runtime_index
Definition: node.h:409
static void vlib_frame_no_append(vlib_frame_t *f)
Definition: node_funcs.h:277
u8 scalar_size
Definition: node.h:391
clib_longjmp_t resume_longjmp
Definition: node.h:560
#define TW(a)
u8 ** vlib_thread_stacks
Definition: main.c:658
static u32 vlib_timing_wheel_data_set_suspended_process(u32 i)
Definition: node.h:654
void * timing_wheel
Definition: node.h:711
vlib_frame_t * vlib_get_frame_to_node(vlib_main_t *vm, u32 to_node_index)
Definition: main.c:182
u8 runtime_data_bytes
Definition: node.h:312
format_function_t format_vlib_node_graph
Definition: node_funcs.h:1221
static void vlib_current_process_wait_for_one_time_event(vlib_main_t *vm, vlib_one_time_waiting_process_t *p)
Definition: node_funcs.h:1087
uword * non_empty_event_type_bitmap
Definition: node.h:585
static void * vlib_process_signal_one_time_event_data(vlib_main_t *vm, uword node_index, uword type_index, uword n_data_elts, uword n_data_elt_bytes)
Definition: node_funcs.h:1001
#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND
Definition: node.h:557
void vlib_node_get_nodes(vlib_main_t *vm, u32 max_threads, int include_stats, int barrier_sync, vlib_node_t ****node_dupsp, vlib_main_t ***stat_vmsp)
Get list of nodes.
Definition: node.c:534