FD.io VPP  v17.01-9-ge7dcee4
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>
49 
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
53  @param i node index.
54  @return pointer to the requested vlib_node_t.
55 */
56 
59 {
60  return vec_elt (vm->node_main.nodes, i);
61 }
62 
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
68 */
69 
71 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
72 {
73  vlib_node_main_t *nm = &vm->node_main;
74  vlib_node_t *n;
75 
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]);
79 }
80 
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
85 */
86 
89 {
90  vlib_node_main_t *nm = &vm->node_main;
91  vlib_node_t *n = vec_elt (nm->nodes, node_index);
92  vlib_process_t *p;
93  if (n->type != VLIB_NODE_TYPE_PROCESS)
94  return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
95  else
96  {
97  p = vec_elt (nm->processes, n->runtime_index);
98  return &p->node_runtime;
99  }
100 }
101 
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
106 */
107 
108 always_inline void *
110 {
111  vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
112  return r->runtime_data;
113 }
114 
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
120 */
121 
122 always_inline void
124  void *runtime_data, u32 n_runtime_data_bytes)
125 {
126  vlib_node_t *n = vlib_get_node (vm, node_index);
127  vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
128 
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);
132 
133  ASSERT (vec_len (n->runtime_data) <= sizeof (vlib_node_runtime_t) -
134  STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
135 
136  if (vec_len (n->runtime_data) > 0)
138 }
139 
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
144 */
145 always_inline void
147  vlib_node_state_t new_state)
148 {
149  vlib_node_main_t *nm = &vm->node_main;
150  vlib_node_t *n;
152 
153  n = vec_elt (nm->nodes, node_index);
154  if (n->type == VLIB_NODE_TYPE_PROCESS)
155  {
157  r = &p->node_runtime;
158 
159  /* When disabling make sure flags are cleared. */
163  }
164  else
166 
167  ASSERT (new_state < VLIB_N_NODE_STATE);
168 
169  if (n->type == VLIB_NODE_TYPE_INPUT)
170  {
172  nm->input_node_counts_by_state[n->state] -= 1;
173  nm->input_node_counts_by_state[new_state] += 1;
174  }
175 
176  n->state = new_state;
177  r->state = new_state;
178 }
179 
180 always_inline void
182 {
183  vlib_node_main_t *nm = &vm->node_main;
184  vlib_node_t *n = vec_elt (nm->nodes, node_index);
187 }
188 
191 {
192  vlib_node_main_t *nm = &vm->node_main;
194  return vec_elt (nm->processes, node->runtime_index);
195 }
196 
197 /* Fetches frame with given handle. */
200 {
201  vlib_frame_t *f;
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;
206  return f;
207 }
208 
211 {
212  u32 i;
213 
214  ASSERT (((uword) f & VLIB_CPU_MASK) == 0);
215 
216  vm = vlib_mains ? vlib_mains[f->cpu_index] : vm;
217 
218  i = ((u8 *) f - (u8 *) vm->heap_base);
219  return i | f->cpu_index;
220 }
221 
223 vlib_get_frame (vlib_main_t * vm, uword frame_index)
224 {
225  vlib_frame_t *f = vlib_get_frame_no_check (vm, frame_index);
227  return f;
228 }
229 
232 {
234  ASSERT (vlib_get_frame (vm, i) == f);
235  return i;
236 }
237 
238 /* Byte alignment for vector arguments. */
239 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
240 
243 {
244  return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
246 }
247 
248 /** \brief Get pointer to frame vector data.
249  @param f vlib_frame_t pointer
250  @return pointer to first vector element in frame
251 */
252 always_inline void *
254 {
255  return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
256 }
257 
258 /** \brief Get pointer to frame scalar data.
259 
260  @warning This is almost certainly not the function you wish to call.
261  See @ref vlib_frame_vector_args instead.
262 
263  @param f vlib_frame_t pointer
264 
265  @return arbitrary node scalar data
266 
267  @sa vlib_frame_vector_args
268 */
269 always_inline void *
271 {
272  return vlib_frame_vector_args (f) - f->scalar_size;
273 }
274 
277  vlib_node_runtime_t * n, u32 next_index)
278 {
279  vlib_node_main_t *nm = &vm->node_main;
280  vlib_next_frame_t *nf;
281 
282  ASSERT (next_index < n->n_next_nodes);
283  nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
284 
285  if (CLIB_DEBUG > 0)
286  {
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);
291  }
292 
293  return nf;
294 }
295 
296 /** \brief Get pointer to frame by (@c node_index, @c next_index).
297 
298  @warning This is not a function that you should call directly.
299  See @ref vlib_get_next_frame instead.
300 
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
304 
305  @return pointer to the requested vlib_next_frame_t
306 
307  @sa vlib_get_next_frame
308 */
309 
311 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
312 {
313  vlib_node_main_t *nm = &vm->node_main;
314  vlib_node_t *n;
316 
317  n = vec_elt (nm->nodes, node_index);
319  return vlib_node_runtime_get_next_frame (vm, r, next_index);
320 }
321 
323  vlib_node_runtime_t * node,
324  u32 next_index,
325  u32 alloc_new_frame);
326 
327 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
328 do { \
329  vlib_frame_t * _f \
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; \
335 } while (0)
336 
337 
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.
342 
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
346 
347  @return @c vectors -- pointer to next available vector slot
348  @return @c n_vectors_left -- number of vector slots available
349 */
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)
354 
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)
359 
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
366 */
367 void
370  u32 next_index, u32 n_packets_left);
371 
372 /* Combination get plus put. Returns vector argument just added. */
373 #define vlib_set_next_frame(vm,node,next_index,v) \
374 ({ \
375  uword _n_left; \
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); \
379  (v); \
380 })
381 
382 always_inline void
384  vlib_node_runtime_t * node,
385  u32 next_index, u32 buffer_index)
386 {
387  u32 *p;
388  p = vlib_set_next_frame (vm, node, next_index, p);
389  p[0] = buffer_index;
390 }
391 
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,
394  vlib_frame_t * f);
395 
398 {
399  vlib_node_main_t *nm = &vm->node_main;
400  return vec_elt (nm->processes, nm->current_process_index);
401 }
402 
405 {
406  return vm->node_main.current_process_index != ~0;
407 }
408 
411 {
413 }
414 
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
418 */
421 {
422  return dt < 1e-6;
423 }
424 
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
429 */
430 
433 {
434  uword r;
435  vlib_node_main_t *nm = &vm->node_main;
437  u64 dt_cpu = dt * vm->clib_time.clocks_per_second;
438 
441 
445  {
446  p->resume_cpu_time = clib_cpu_time_now () + dt_cpu;
448  }
449 
450  return r;
451 }
452 
453 always_inline void
455  uword is_one_time_event)
456 {
459  if (is_one_time_event)
461  clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
462 }
463 
464 always_inline void
466 {
469  vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
470 }
471 
472 always_inline void *
474  uword * return_event_type_opaque)
475 {
476  vlib_node_main_t *nm = &vm->node_main;
477  vlib_process_t *p;
479  uword t, l;
480  void *event_data_vector;
481 
482  p = vec_elt (nm->processes, nm->current_process_index);
483 
484  /* Find first type with events ready.
485  Return invalid type when there's nothing there. */
487  if (t == ~0)
488  return 0;
489 
491  clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
492 
493  l = _vec_len (p->pending_event_data_by_type_index[t]);
494  ASSERT (l > 0);
495  event_data_vector = p->pending_event_data_by_type_index[t];
497 
498  et = pool_elt_at_index (p->event_type_pool, t);
499 
500  /* Return user's opaque value and possibly index. */
501  *return_event_type_opaque = et->opaque;
502 
504 
505  return event_data_vector;
506 }
507 
508 /* Return event data vector for later reuse. We reuse event data to avoid
509  repeatedly allocating event vectors in cases where we care about speed. */
510 always_inline void
511 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
512 {
513  vlib_node_main_t *nm = &vm->node_main;
514  vec_add1 (nm->recycled_event_data_vectors, event_data);
515 }
516 
517 /** Return the first event type which has occurred and a vector of per-event
518  data of that type, or a timeout indication
519 
520  @param vm - vlib_main_t pointer
521  @param data_vector - pointer to a (uword *) vector to receive event data
522  @returns either an event type and a vector of per-event instance data,
523  or ~0 to indicate a timeout.
524 */
525 
528 {
529  vlib_node_main_t *nm = &vm->node_main;
530  vlib_process_t *p;
532  uword r, t, l;
533 
534  p = vec_elt (nm->processes, nm->current_process_index);
535 
536  /* Find first type with events ready.
537  Return invalid type when there's nothing there. */
539  if (t == ~0)
540  return t;
541 
543  clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
544 
545  l = _vec_len (p->pending_event_data_by_type_index[t]);
546  if (data_vector)
547  vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
548  _vec_len (p->pending_event_data_by_type_index[t]) = 0;
549 
550  et = pool_elt_at_index (p->event_type_pool, t);
551 
552  /* Return user's opaque value. */
553  r = et->opaque;
554 
556 
557  return r;
558 }
559 
562  uword ** data_vector)
563 {
564  uword l;
565 
567  clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
568 
569  l = _vec_len (p->pending_event_data_by_type_index[t]);
570  if (data_vector)
571  vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
572  _vec_len (p->pending_event_data_by_type_index[t]) = 0;
573 
575 
576  return l;
577 }
578 
579 /* As above but query as specified type of event. Returns number of
580  events found. */
583  uword with_type_opaque)
584 {
585  vlib_node_main_t *nm = &vm->node_main;
586  vlib_process_t *p;
587  uword t, *h;
588 
589  p = vec_elt (nm->processes, nm->current_process_index);
590  h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
591  if (!h)
592  /* This can happen when an event has not yet been
593  signaled with given opaque type. */
594  return 0;
595 
596  t = h[0];
598  return 0;
599 
600  return vlib_process_get_events_helper (p, t, data_vector);
601 }
602 
605 {
606  vlib_node_main_t *nm = &vm->node_main;
607  vlib_process_t *p;
608  uword r;
609 
610  p = vec_elt (nm->processes, nm->current_process_index);
612  {
614  r =
619  }
620 
621  return p->non_empty_event_type_bitmap;
622 }
623 
626  uword ** data_vector,
627  uword with_type_index)
628 {
629  vlib_node_main_t *nm = &vm->node_main;
630  vlib_process_t *p;
631  uword r;
632 
633  p = vec_elt (nm->processes, nm->current_process_index);
634  ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
635  while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
636  {
638  r =
643  }
644 
645  return vlib_process_get_events_helper (p, with_type_index, data_vector);
646 }
647 
650  uword ** data_vector,
651  uword with_type_opaque)
652 {
653  vlib_node_main_t *nm = &vm->node_main;
654  vlib_process_t *p;
655  uword r, *h;
656 
657  p = vec_elt (nm->processes, nm->current_process_index);
658  h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
659  while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
660  {
662  r =
667 
668  /* See if unknown event type has been signaled now. */
669  if (!h)
670  h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
671  }
672 
673  return vlib_process_get_events_helper (p, h[0], data_vector);
674 }
675 
676 /** Suspend a cooperative multi-tasking thread
677  Waits for an event, or for the indicated number of seconds to elapse
678  @param vm - vlib_main_t pointer
679  @param dt - timeout, in seconds.
680  @returns the remaining time interval
681 */
682 
685 {
686  vlib_node_main_t *nm = &vm->node_main;
687  vlib_process_t *p;
688  f64 wakeup_time;
689  uword r;
690 
691  p = vec_elt (nm->processes, nm->current_process_index);
692 
695  return dt;
696 
697  wakeup_time = vlib_time_now (vm) + dt;
698 
699  /* Suspend waiting for both clock and event to occur. */
702 
705  {
707  + (dt * vm->clib_time.clocks_per_second));
709  }
710 
711  /* Return amount of time still left to sleep.
712  If <= 0 then we've been waken up by the clock (and not an event). */
713  return wakeup_time - vlib_time_now (vm);
714 }
715 
718 {
720  pool_get (p->event_type_pool, et);
721  et->opaque = with_type_opaque;
722  return et;
723 }
724 
727  uword with_type_opaque)
728 {
729  vlib_node_main_t *nm = &vm->node_main;
730  vlib_node_t *n = vlib_get_node (vm, node_index);
733  uword t;
734 
735  et = vlib_process_new_event_type (p, with_type_opaque);
736  t = et - p->event_type_pool;
738  clib_bitmap_ori (p->one_time_event_type_bitmap, t);
739  return t;
740 }
741 
742 always_inline void
744  uword t)
745 {
746  vlib_node_main_t *nm = &vm->node_main;
747  vlib_node_t *n = vlib_get_node (vm, node_index);
749 
751  vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
752 }
753 
754 always_inline void *
756  vlib_node_t * n,
757  vlib_process_t * p,
758  uword t,
759  uword n_data_elts, uword n_data_elt_bytes)
760 {
761  uword p_flags, add_to_pending, delete_from_wheel;
762  void *data_to_be_written_by_caller;
763 
765 
767 
768  /* Resize data vector and return caller's data to be written. */
769  {
770  void *data_vec = p->pending_event_data_by_type_index[t];
771  uword l;
772 
773  if (!data_vec && vec_len (nm->recycled_event_data_vectors))
774  {
775  data_vec = vec_pop (nm->recycled_event_data_vectors);
776  _vec_len (data_vec) = 0;
777  }
778 
779  l = vec_len (data_vec);
780 
781  data_vec = _vec_resize (data_vec,
782  /* length_increment */ n_data_elts,
783  /* total size after increment */
784  (l + n_data_elts) * n_data_elt_bytes,
785  /* header_bytes */ 0, /* data_align */ 0);
786 
787  p->pending_event_data_by_type_index[t] = data_vec;
788  data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
789  }
790 
792  clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
793 
794  p_flags = p->flags;
795 
796  /* Event was already signalled? */
797  add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
798 
799  /* Process will resume when suspend time elapses? */
800  delete_from_wheel = 0;
802  {
803  /* Waiting for both event and clock? */
805  delete_from_wheel = 1;
806  else
807  /* Waiting only for clock. Event will be queue and may be
808  handled when timer expires. */
809  add_to_pending = 0;
810  }
811 
812  /* Never add current process to pending vector since current process is
813  already running. */
814  add_to_pending &= nm->current_process_index != n->runtime_index;
815 
816  if (add_to_pending)
817  {
819  p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
821  if (delete_from_wheel)
823  }
824 
825  return data_to_be_written_by_caller;
826 }
827 
828 always_inline void *
830  uword node_index,
831  uword type_opaque,
832  uword n_data_elts, uword n_data_elt_bytes)
833 {
834  vlib_node_main_t *nm = &vm->node_main;
835  vlib_node_t *n = vlib_get_node (vm, node_index);
837  uword *h, t;
838 
839  h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
840  if (!h)
841  {
843  vlib_process_new_event_type (p, type_opaque);
844  t = et - p->event_type_pool;
845  hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
846  }
847  else
848  t = h[0];
849 
850  return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
851  n_data_elt_bytes);
852 }
853 
854 always_inline void *
856  f64 dt,
857  uword node_index,
858  uword type_opaque,
859  uword n_data_elts, uword n_data_elt_bytes)
860 {
861  vlib_node_main_t *nm = &vm->node_main;
862  vlib_node_t *n = vlib_get_node (vm, node_index);
864  uword *h, t;
865 
866  h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
867  if (!h)
868  {
870  vlib_process_new_event_type (p, type_opaque);
871  t = et - p->event_type_pool;
872  hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
873  }
874  else
875  t = h[0];
876 
878  return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
879  n_data_elt_bytes);
880  else
881  {
883  u64 dt_cpu = dt * vm->clib_time.clocks_per_second;
884 
885  pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
886 
887  te->n_data_elts = n_data_elts;
888  te->n_data_elt_bytes = n_data_elt_bytes;
889  te->n_data_bytes = n_data_elts * n_data_elt_bytes;
890 
891  /* Assert that structure fields are big enough. */
892  ASSERT (te->n_data_elts == n_data_elts);
893  ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
894  ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
895 
897  te->event_type_index = t;
898 
901  nm->
902  signal_timed_event_data_pool));
903 
904  /* Inline data big enough to hold event? */
905  if (te->n_data_bytes < sizeof (te->inline_event_data))
906  return te->inline_event_data;
907  else
908  {
909  te->event_data_as_vector = 0;
911  return te->event_data_as_vector;
912  }
913  }
914 }
915 
916 always_inline void *
918  uword node_index,
919  uword type_index,
920  uword n_data_elts,
921  uword n_data_elt_bytes)
922 {
923  vlib_node_main_t *nm = &vm->node_main;
924  vlib_node_t *n = vlib_get_node (vm, node_index);
926  return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
927  n_data_elt_bytes);
928 }
929 
930 always_inline void
932  uword node_index, uword type_opaque, uword data)
933 {
934  uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
935  1 /* elts */ , sizeof (uword));
936  d[0] = data;
937 }
938 
939 always_inline void
941  uword node_index,
942  uword type_opaque, void *data)
943 {
944  void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
945  1 /* elts */ , sizeof (data));
946  d[0] = data;
947 }
948 
949 always_inline void
951  uword node_index,
952  uword type_index, uword data)
953 {
954  uword *d =
955  vlib_process_signal_one_time_event_data (vm, node_index, type_index,
956  1 /* elts */ , sizeof (uword));
957  d[0] = data;
958 }
959 
960 always_inline void
963 {
965  /* data */ ~0);
966  memset (p, ~0, sizeof (p[0]));
967 }
968 
969 always_inline void
972  ** wps)
973 {
976  vec_free (*wps);
977 }
978 
979 always_inline void
982  * p)
983 {
985  p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index, /* type opaque */
986  ~0);
988  /* don't care about data */ 0,
989  p->one_time_event);
990 }
991 
992 always_inline void
995  ** wps)
996 {
998  vec_add2 (*wps, wp, 1);
1000 }
1001 
1004  vlib_node_runtime_t * node,
1005  uword n_vectors)
1006 {
1007  u32 i, d, vi0, vi1;
1008  u32 i0, i1;
1009 
1012  & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1013  i0 = i ^ 0;
1014  i1 = i ^ 1;
1016  -
1019  vi0 = node->main_loop_vector_stats[i0];
1020  vi1 = node->main_loop_vector_stats[i1];
1021  vi0 = d == 0 ? vi0 : 0;
1022  vi1 = d <= 1 ? vi1 : 0;
1023  vi0 += n_vectors;
1024  node->main_loop_vector_stats[i0] = vi0;
1025  node->main_loop_vector_stats[i1] = vi1;
1027  /* Return previous counter. */
1028  return node->main_loop_vector_stats[i1];
1029 }
1030 
1033 {
1034  vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1035  u32 v;
1036 
1037  v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1038  0);
1039  return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1040 }
1041 
1044 {
1045  vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1046  u32 v;
1047 
1048  v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt, /* n_vectors */
1049  0);
1051 }
1052 
1053 void
1055 
1056 /* Add next node to given node in given slot. */
1057 uword
1059  uword node, uword next_node, uword slot);
1060 
1061 /* As above but adds to end of node's next vector. */
1064 {
1065  return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1066 }
1067 
1068 /* Add next node to given node in given slot. */
1069 uword
1071  uword node, char *next_name, uword slot);
1072 
1073 /* As above but adds to end of node's next vector. */
1076 {
1077  return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1078 }
1079 
1080 /* Query node given name. */
1082 
1083 /* Rename a node. */
1084 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1085 
1086 /* Register new packet processing node. Nodes can be registered
1087  dynamically via this call or statically via the VLIB_REGISTER_NODE
1088  macro. */
1090 
1091 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1093 
1094 /* Start a process. */
1095 void vlib_start_process (vlib_main_t * vm, uword process_index);
1096 
1097 /* Sync up runtime and main node stats. */
1099 
1100 /* Node graph initialization function. */
1102 
1109 /* Parse node name -> node index. */
1111 
1112 always_inline void
1114  u32 counter_index, u64 increment)
1115 {
1116  vlib_node_t *n = vlib_get_node (vm, node_index);
1117  vlib_error_main_t *em = &vm->error_main;
1118  u32 node_counter_base_index = n->error_heap_index;
1119  em->counters[node_counter_base_index + counter_index] += increment;
1120 }
1121 
1122 #endif /* included_vlib_node_funcs_h */
1123 
1124 /*
1125  * fd.io coding-style-patch-verification: ON
1126  *
1127  * Local Variables:
1128  * eval: (c-set-style "gnu")
1129  * End:
1130  */
u32 * next_nodes
Definition: node.h:288
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:396
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:123
static void vlib_process_free_event_type(vlib_process_t *p, uword t, uword is_one_time_event)
Definition: node_funcs.h:454
#define VLIB_OFFSET_MASK
Definition: threads.h:63
u32 error_heap_index
Definition: node.h:278
u32 next_frame_index
Definition: node.h:437
#define hash_set(h, key, value)
Definition: hash.h:254
static void vlib_signal_one_time_waiting_process_vector(vlib_main_t *vm, vlib_one_time_waiting_process_t **wps)
Definition: node_funcs.h:970
sll srl srl sll sra u16x4 i
Definition: vector_sse2.h:343
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:311
uword( unformat_function_t)(unformat_input_t *input, va_list *args)
Definition: format.h:231
static void vlib_signal_one_time_waiting_process(vlib_main_t *vm, vlib_one_time_waiting_process_t *p)
Definition: node_funcs.h:961
vlib_process_t ** processes
Definition: node.h:670
#define VLIB_CPU_MASK
Definition: threads.h:62
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:684
format_function_t format_vlib_node_name
Definition: node_funcs.h:1104
static f64 vlib_node_vectors_per_main_loop_as_float(vlib_main_t *vm, u32 node_index)
Definition: node_funcs.h:1032
vlib_node_runtime_t node_runtime
Definition: node.h:491
void vlib_put_frame_to_node(vlib_main_t *vm, u32 to_node_index, vlib_frame_t *f)
Definition: main.c:196
u8 runtime_data[0]
Definition: node.h:469
static uword * vlib_process_wait_for_event(vlib_main_t *vm)
Definition: node_funcs.h:604
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:383
static uword vlib_current_process(vlib_main_t *vm)
Definition: node_funcs.h:410
#define VLIB_FRAME_IS_ALLOCATED
Definition: node.h:373
static void vlib_node_set_interrupt_pending(vlib_main_t *vm, u32 node_index)
Definition: node_funcs.h:181
static u32 vlib_timing_wheel_data_set_timed_event(u32 i)
Definition: node.h:616
static uword vlib_node_add_named_next(vlib_main_t *vm, uword node, char *name)
Definition: node_funcs.h:1075
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:182
f64 clocks_per_second
Definition: time.h:53
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:450
void ** pending_event_data_by_type_index
Definition: node.h:522
u32 current_process_index
Definition: node.h:673
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:482
static u64 clib_cpu_time_now(void)
Definition: time.h:73
#define vlib_set_next_frame(vm, node, next_index, v)
Definition: node_funcs.h:373
struct _vlib_node_registration vlib_node_registration_t
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:521
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:62
void clib_longjmp(clib_longjmp_t *save, uword return_value)
format_function_t format_vlib_cpu_time
Definition: node_funcs.h:1107
clib_time_t clib_time
Definition: main.h:62
void * runtime_data
Definition: node.h:243
void timing_wheel_insert(timing_wheel_t *w, u64 insert_cpu_time, u32 user_data)
Definition: timing_wheel.c:292
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:200
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:1063
vlib_node_state_t
Definition: node.h:207
#define VLIB_PROCESS_RESUME_PENDING
Definition: node.h:508
#define vec_pop(V)
Returns last element of a vector and decrements its length.
Definition: vec.h:576
static uword vlib_process_suspend_time_is_zero(f64 dt)
Returns TRUE if a process suspend time is less than 1us.
Definition: node_funcs.h:420
static vlib_frame_t * vlib_get_frame_no_check(vlib_main_t *vm, uword frame_index)
Definition: node_funcs.h:199
static vlib_process_event_type_t * vlib_process_new_event_type(vlib_process_t *p, uword with_type_opaque)
Definition: node_funcs.h:717
u8 state
Definition: node.h:265
#define vec_add(V, E, N)
Add N elements to end of vector V (no header, unspecified alignment)
Definition: vec.h:559
u32 * pending_interrupt_node_runtime_indices
Definition: node.h:643
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:432
u32 main_loop_count_last_dispatch
Definition: node.h:448
void vlib_node_rename(vlib_main_t *vm, u32 node_index, char *fmt,...)
Definition: node.c:76
void ** recycled_event_data_vectors
Definition: node.h:679
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:527
#define always_inline
Definition: clib.h:84
format_function_t format_vlib_node_and_next
Definition: node_funcs.h:1106
static uword clib_bitmap_is_zero(uword *ai)
predicate function; is an entire bitmap empty?
Definition: bitmap.h:57
static u32 counter_index(vlib_main_t *vm, vlib_error_t e)
vlib_node_t ** nodes
Definition: node.h:630
#define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
Definition: main.h:84
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
unsigned long u64
Definition: types.h:89
format_function_t format_vlib_next_node_name
Definition: node_funcs.h:1105
#define vec_resize(V, N)
Resize a vector (no header, unspecified alignment) Add N elements to end of given vector V...
Definition: vec.h:201
void vlib_frame_free(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_frame_t *f)
Definition: main.c:216
static void vlib_process_delete_one_time_event(vlib_main_t *vm, uword node_index, uword t)
Definition: node_funcs.h:743
vlib_node_runtime_t * nodes_by_type[VLIB_N_NODE_TYPE]
Definition: node.h:640
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:276
clib_error_t * vlib_node_main_init(vlib_main_t *vm)
Definition: node.c:500
#define hash_get(h, key)
Definition: hash.h:248
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:369
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:755
u32 vlib_register_node(vlib_main_t *vm, vlib_node_registration_t *r)
Definition: node.c:451
static void vlib_process_signal_event(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Definition: node_funcs.h:931
vlib_signal_timed_event_data_t * signal_timed_event_data_pool
Definition: node.h:660
static uword clib_bitmap_first_set(uword *ai)
Return the lowest numbered set bit in a bitmap.
Definition: bitmap.h:385
vlib_error_main_t error_main
Definition: main.h:124
static u32 vlib_frame_index(vlib_main_t *vm, vlib_frame_t *f)
Definition: node_funcs.h:231
#define v
Definition: acl.c:314
static void vlib_process_maybe_free_event_type(vlib_process_t *p, uword t)
Definition: node_funcs.h:465
u8 inline_event_data[64-3 *sizeof(u32)-2 *sizeof(u16)]
Definition: node.h:595
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:829
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:109
static void vlib_process_signal_one_time_event(vlib_main_t *vm, uword node_index, uword type_index, uword data)
Definition: node_funcs.h:950
#define VLIB_PROCESS_RESUME_LONGJMP_SUSPEND
Definition: node.h:501
static u32 vlib_timing_wheel_data_set_suspended_process(u32 i)
Definition: node.h:610
static vlib_frame_t * vlib_get_frame(vlib_main_t *vm, uword frame_index)
Definition: node_funcs.h:223
#define VLIB_PROCESS_RETURN_LONGJMP_SUSPEND
Definition: node.h:497
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1113
#define pool_get_aligned(P, E, A)
Allocate an object E from a pool P (general version).
Definition: pool.h:169
timing_wheel_t timing_wheel
Definition: node.h:658
static uword vlib_process_get_events_with_type(vlib_main_t *vm, uword **data_vector, uword with_type_opaque)
Definition: node_funcs.h:582
static u32 vlib_frame_index_no_check(vlib_main_t *vm, vlib_frame_t *f)
Definition: node_funcs.h:210
#define VLIB_FRAME_VECTOR_ALIGN
Definition: node_funcs.h:239
u64 * counters
Definition: error.h:78
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:1003
static void vlib_process_signal_event_pointer(vlib_main_t *vm, uword node_index, uword type_opaque, void *data)
Definition: node_funcs.h:940
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:855
u32 runtime_index
Definition: node.h:240
uword vlib_node_add_named_next_with_slot(vlib_main_t *vm, uword node, char *next_name, uword slot)
Definition: node.c:213
static vlib_process_t * vlib_get_current_process(vlib_main_t *vm)
Definition: node_funcs.h:397
static uword vlib_process_wait_for_one_time_event(vlib_main_t *vm, uword **data_vector, uword with_type_index)
Definition: node_funcs.h:625
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:300
void * heap_base
Definition: main.h:101
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:88
#define clib_memcpy(a, b, c)
Definition: string.h:69
void timing_wheel_delete(timing_wheel_t *w, u32 user_data)
Definition: timing_wheel.c:329
static uword vlib_process_create_one_time_event(vlib_main_t *vm, uword node_index, uword with_type_opaque)
Definition: node_funcs.h:726
uword vlib_node_add_next_with_slot(vlib_main_t *vm, uword node, uword next_node, uword slot)
Definition: node.c:156
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:211
static u32 vlib_frame_vector_byte_offset(u32 scalar_size)
Definition: node_funcs.h:242
#define ARRAY_LEN(x)
Definition: clib.h:59
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:272
uword * one_time_event_type_bitmap
Definition: node.h:528
static u32 vlib_node_vectors_per_main_loop_as_integer(vlib_main_t *vm, u32 node_index)
Definition: node_funcs.h:1043
#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
Definition: node.h:506
void vlib_start_process(vlib_main_t *vm, uword process_index)
Definition: main.c:1324
#define pool_put_index(p, i)
Free pool element with given index.
Definition: pool.h:228
#define ASSERT(truth)
static uword vlib_process_get_events_helper(vlib_process_t *p, uword t, uword **data_vector)
Definition: node_funcs.h:561
unsigned int u32
Definition: types.h:88
u16 flags
Definition: node.h:335
u16 cpu_index
Definition: node.h:347
#define VLIB_PROCESS_RESUME_LONGJMP_RESUME
Definition: node.h:502
static void * vlib_frame_args(vlib_frame_t *f)
Get pointer to frame scalar data.
Definition: node_funcs.h:270
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:146
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
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:361
static uword is_pow2(uword x)
Definition: clib.h:266
u64 uword
Definition: types.h:112
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:993
#define vec_elt(v, i)
Get vector value at index i.
template key/value backing page structure
Definition: bihash_doc.h:44
void vlib_node_sync_stats(vlib_main_t *vm, vlib_node_t *n)
Definition: main.c:575
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:459
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:71
static void * vlib_process_get_event_data(vlib_main_t *vm, uword *return_event_type_opaque)
Definition: node_funcs.h:473
vlib_process_event_type_t * event_type_pool
Definition: node.h:535
u32 * data_from_advancing_timing_wheel
Definition: node.h:663
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
double f64
Definition: types.h:142
u32 input_node_counts_by_state[VLIB_N_NODE_STATE]
Definition: node.h:682
unsigned char u8
Definition: types.h:56
vlib_node_main_t node_main
Definition: main.h:115
static uword vlib_process_wait_for_event_with_type(vlib_main_t *vm, uword **data_vector, uword with_type_opaque)
Definition: node_funcs.h:649
format_function_t format_vlib_time
Definition: node_funcs.h:1108
vlib_next_frame_t * next_frames
Definition: node.h:652
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:253
vlib_main_t ** vlib_mains
uword * event_type_index_by_type_opaque
Definition: node.h:532
#define VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
Definition: node.h:505
unformat_function_t unformat_vlib_node
Definition: node_funcs.h:1110
struct clib_bihash_value offset
template key/value backing page structure
u16 flags
Definition: node.h:504
static uword vlib_in_process_context(vlib_main_t *vm)
Definition: node_funcs.h:404
vlib_node_type_t type
Definition: node.h:234
static vlib_process_t * vlib_get_process_from_node(vlib_main_t *vm, vlib_node_t *node)
Definition: node_funcs.h:190
static void vlib_process_put_event_data(vlib_main_t *vm, void *event_data)
Definition: node_funcs.h:511
void vlib_register_all_static_nodes(vlib_main_t *vm)
Definition: node.c:471
u64 resume_cpu_time
Definition: node.h:538
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:58
#define vec_foreach(var, vec)
Vector iterator.
clib_longjmp_t return_longjmp
Definition: node.h:494
u32 node_runtime_index
Definition: node.h:359
u8 scalar_size
Definition: node.h:338
clib_longjmp_t resume_longjmp
Definition: node.h:500
u32 main_loop_count
Definition: main.h:71
vlib_frame_t * vlib_get_frame_to_node(vlib_main_t *vm, u32 to_node_index)
Definition: main.c:187
u8 runtime_data_bytes
Definition: node.h:268
format_function_t format_vlib_node_graph
Definition: node_funcs.h:1103
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:980
uword * non_empty_event_type_bitmap
Definition: node.h:525
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:917