62a1fecabd6262ed43c33e69a2c2372d49e7f9a3
[vpp.git] / src / vlib / node_funcs.h
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 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
50 #include <vppinfra/interrupt.h>
51
52 #ifdef CLIB_SANITIZE_ADDR
53 #include <sanitizer/asan_interface.h>
54 #endif
55
56 static_always_inline void
57 vlib_process_start_switch_stack (vlib_main_t * vm, vlib_process_t * p)
58 {
59 #ifdef CLIB_SANITIZE_ADDR
60   void *stack = p ? (void *) p->stack : vlib_thread_stacks[vm->thread_index];
61   u32 stack_bytes = p ? p->log2_n_stack_bytes : VLIB_THREAD_STACK_SIZE;
62   __sanitizer_start_switch_fiber (&vm->asan_stack_save, stack, stack_bytes);
63 #endif
64 }
65
66 static_always_inline void
67 vlib_process_finish_switch_stack (vlib_main_t * vm)
68 {
69 #ifdef CLIB_SANITIZE_ADDR
70   const void *bottom_old;
71   size_t size_old;
72
73   __sanitizer_finish_switch_fiber (&vm->asan_stack_save, &bottom_old,
74                                    &size_old);
75 #endif
76 }
77
78 /** \brief Get vlib node by index.
79  @warning This function will ASSERT if @c i is out of range.
80  @param vm vlib_main_t pointer, varies by thread
81  @param i node index.
82  @return pointer to the requested vlib_node_t.
83 */
84
85 always_inline vlib_node_t *
86 vlib_get_node (vlib_main_t * vm, u32 i)
87 {
88   return vec_elt (vm->node_main.nodes, i);
89 }
90
91 /** \brief Get vlib node by graph arc (next) index.
92  @param vm vlib_main_t pointer, varies by thread
93  @param node_index index of original node
94  @param next_index graph arc index
95  @return pointer to the vlib_node_t at the end of the indicated arc
96 */
97
98 always_inline vlib_node_t *
99 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
100 {
101   vlib_node_main_t *nm = &vm->node_main;
102   vlib_node_t *n;
103
104   n = vec_elt (nm->nodes, node_index);
105   ASSERT (next_index < vec_len (n->next_nodes));
106   return vlib_get_node (vm, n->next_nodes[next_index]);
107 }
108
109 /** \brief Get node runtime by node index.
110  @param vm vlib_main_t pointer, varies by thread
111  @param node_index index of node
112  @return pointer to the indicated vlib_node_runtime_t
113 */
114
115 always_inline vlib_node_runtime_t *
116 vlib_node_get_runtime (vlib_main_t * vm, u32 node_index)
117 {
118   vlib_node_main_t *nm = &vm->node_main;
119   vlib_node_t *n = vec_elt (nm->nodes, node_index);
120   vlib_process_t *p;
121   if (n->type != VLIB_NODE_TYPE_PROCESS)
122     return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
123   else
124     {
125       p = vec_elt (nm->processes, n->runtime_index);
126       return &p->node_runtime;
127     }
128 }
129
130 /** \brief Get node runtime private data by node index.
131  @param vm vlib_main_t pointer, varies by thread
132  @param node_index index of the node
133  @return pointer to the indicated vlib_node_runtime_t private data
134 */
135
136 always_inline void *
137 vlib_node_get_runtime_data (vlib_main_t * vm, u32 node_index)
138 {
139   vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
140   return r->runtime_data;
141 }
142
143 /** \brief Set node runtime private data.
144  @param vm vlib_main_t pointer, varies by thread
145  @param node_index index of the node
146  @param runtime_data arbitrary runtime private data
147  @param n_runtime_data_bytes size of runtime private data
148 */
149
150 always_inline void
151 vlib_node_set_runtime_data (vlib_main_t * vm, u32 node_index,
152                             void *runtime_data, u32 n_runtime_data_bytes)
153 {
154   vlib_node_t *n = vlib_get_node (vm, node_index);
155   vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
156
157   n->runtime_data_bytes = n_runtime_data_bytes;
158   vec_free (n->runtime_data);
159   vec_add (n->runtime_data, runtime_data, n_runtime_data_bytes);
160
161   ASSERT (vec_len (n->runtime_data) <= sizeof (vlib_node_runtime_t) -
162           STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
163
164   if (vec_len (n->runtime_data) > 0)
165     clib_memcpy_fast (r->runtime_data, n->runtime_data,
166                       vec_len (n->runtime_data));
167 }
168
169 /** \brief Set node dispatch state.
170  @param vm vlib_main_t pointer, varies by thread
171  @param node_index index of the node
172  @param new_state new state for node, see vlib_node_state_t
173 */
174 always_inline void
175 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
176                      vlib_node_state_t new_state)
177 {
178   vlib_node_main_t *nm = &vm->node_main;
179   vlib_node_t *n;
180   vlib_node_runtime_t *r;
181
182   n = vec_elt (nm->nodes, node_index);
183   if (n->type == VLIB_NODE_TYPE_PROCESS)
184     {
185       vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
186       r = &p->node_runtime;
187
188       /* When disabling make sure flags are cleared. */
189       p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
190                     | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
191                     | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
192     }
193   else
194     r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
195
196   ASSERT (new_state < VLIB_N_NODE_STATE);
197
198   if (n->type == VLIB_NODE_TYPE_INPUT)
199     {
200       ASSERT (nm->input_node_counts_by_state[n->state] > 0);
201       nm->input_node_counts_by_state[n->state] -= 1;
202       nm->input_node_counts_by_state[new_state] += 1;
203     }
204
205   if (PREDICT_FALSE (r->state == VLIB_NODE_STATE_DISABLED))
206     vlib_node_runtime_perf_counter (vm, r, 0, 0, 0,
207                                     VLIB_NODE_RUNTIME_PERF_RESET);
208
209   n->state = new_state;
210   r->state = new_state;
211 }
212
213 /** \brief Get node dispatch state.
214  @param vm vlib_main_t pointer, varies by thread
215  @param node_index index of the node
216  @return state for node, see vlib_node_state_t
217 */
218 always_inline vlib_node_state_t
219 vlib_node_get_state (vlib_main_t * vm, u32 node_index)
220 {
221   vlib_node_main_t *nm = &vm->node_main;
222   vlib_node_t *n;
223   n = vec_elt (nm->nodes, node_index);
224   return n->state;
225 }
226
227 always_inline void
228 vlib_node_set_flag (vlib_main_t *vm, u32 node_index, u16 flag, u8 enable)
229 {
230   vlib_node_runtime_t *r;
231   vlib_node_t *n;
232
233   n = vlib_get_node (vm, node_index);
234   r = vlib_node_get_runtime (vm, node_index);
235
236   if (enable)
237     {
238       n->flags |= flag;
239       r->flags |= flag;
240     }
241   else
242     {
243       n->flags &= ~flag;
244       r->flags &= ~flag;
245     }
246 }
247
248 always_inline void
249 vlib_node_set_interrupt_pending (vlib_main_t *vm, u32 node_index)
250 {
251   vlib_node_main_t *nm = &vm->node_main;
252   vlib_node_t *n = vec_elt (nm->nodes, node_index);
253
254   ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
255
256   if (vm != vlib_get_main ())
257     clib_interrupt_set_atomic (nm->interrupts, n->runtime_index);
258   else
259     clib_interrupt_set (nm->interrupts, n->runtime_index);
260
261   __atomic_store_n (nm->pending_interrupts, 1, __ATOMIC_RELEASE);
262 }
263
264 always_inline vlib_process_t *
265 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
266 {
267   vlib_node_main_t *nm = &vm->node_main;
268   ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
269   return vec_elt (nm->processes, node->runtime_index);
270 }
271
272 always_inline vlib_frame_t *
273 vlib_get_frame (vlib_main_t * vm, vlib_frame_t * f)
274 {
275   ASSERT (f != NULL);
276   ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
277   return f;
278 }
279
280 always_inline void
281 vlib_frame_no_append (vlib_frame_t * f)
282 {
283   f->frame_flags |= VLIB_FRAME_NO_APPEND;
284 }
285
286 /** \brief Get pointer to frame vector data.
287  @param f vlib_frame_t pointer
288  @return pointer to first vector element in frame
289 */
290 always_inline void *
291 vlib_frame_vector_args (vlib_frame_t * f)
292 {
293   ASSERT (f->vector_offset);
294   return (void *) f + f->vector_offset;
295 }
296
297 /** \brief Get pointer to frame vector aux data.
298  @param f vlib_frame_t pointer
299  @return pointer to first vector aux data element in frame
300 */
301 always_inline void *
302 vlib_frame_aux_args (vlib_frame_t *f)
303 {
304   ASSERT (f->aux_offset);
305   return (void *) f + f->aux_offset;
306 }
307
308 /** \brief Get pointer to frame scalar data.
309
310  @param f vlib_frame_t pointer
311
312  @return arbitrary node scalar data
313
314  @sa vlib_frame_vector_args
315 */
316 always_inline void *
317 vlib_frame_scalar_args (vlib_frame_t * f)
318 {
319   ASSERT (f->scalar_offset);
320   return (void *) f + f->scalar_offset;
321 }
322
323 always_inline vlib_next_frame_t *
324 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
325                                   vlib_node_runtime_t * n, u32 next_index)
326 {
327   vlib_node_main_t *nm = &vm->node_main;
328   vlib_next_frame_t *nf;
329
330   ASSERT (next_index < n->n_next_nodes);
331   nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
332
333   if (CLIB_DEBUG > 0)
334     {
335       vlib_node_t *node, *next;
336       node = vec_elt (nm->nodes, n->node_index);
337       next = vec_elt (nm->nodes, node->next_nodes[next_index]);
338       ASSERT (nf->node_runtime_index == next->runtime_index);
339     }
340
341   return nf;
342 }
343
344 /** \brief Get pointer to frame by (@c node_index, @c next_index).
345
346  @warning This is not a function that you should call directly.
347  See @ref vlib_get_next_frame instead.
348
349  @param vm vlib_main_t pointer, varies by thread
350  @param node_index index of the node
351  @param next_index graph arc index
352
353  @return pointer to the requested vlib_next_frame_t
354
355  @sa vlib_get_next_frame
356 */
357
358 always_inline vlib_next_frame_t *
359 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
360 {
361   vlib_node_main_t *nm = &vm->node_main;
362   vlib_node_t *n;
363   vlib_node_runtime_t *r;
364
365   n = vec_elt (nm->nodes, node_index);
366   r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
367   return vlib_node_runtime_get_next_frame (vm, r, next_index);
368 }
369
370 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
371                                             vlib_node_runtime_t * node,
372                                             u32 next_index,
373                                             u32 alloc_new_frame);
374
375 #define vlib_get_next_frame_macro(vm, node, next_index, vectors,              \
376                                   n_vectors_left, alloc_new_frame)            \
377   do                                                                          \
378     {                                                                         \
379       vlib_frame_t *_f = vlib_get_next_frame_internal (                       \
380         (vm), (node), (next_index), (alloc_new_frame));                       \
381       u32 _n = _f->n_vectors;                                                 \
382       (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]);   \
383       (n_vectors_left) = VLIB_FRAME_SIZE - _n;                                \
384     }                                                                         \
385   while (0)
386
387 #define vlib_get_next_frame_macro_with_aux(vm, node, next_index, vectors,     \
388                                            n_vectors_left, alloc_new_frame,   \
389                                            aux_data, maybe_no_aux)            \
390   do                                                                          \
391     {                                                                         \
392       vlib_frame_t *_f = vlib_get_next_frame_internal (                       \
393         (vm), (node), (next_index), (alloc_new_frame));                       \
394       u32 _n = _f->n_vectors;                                                 \
395       (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]);   \
396       if ((maybe_no_aux) && (_f)->aux_offset == 0)                            \
397         (aux_data) = NULL;                                                    \
398       else                                                                    \
399         (aux_data) = vlib_frame_aux_args (_f) + _n * sizeof ((aux_data)[0]);  \
400       (n_vectors_left) = VLIB_FRAME_SIZE - _n;                                \
401     }                                                                         \
402   while (0)
403
404 /** \brief Get pointer to next frame vector data by
405     (@c vlib_node_runtime_t, @c next_index).
406  Standard single/dual loop boilerplate element.
407  @attention This is a MACRO, with SIDE EFFECTS.
408
409  @param vm vlib_main_t pointer, varies by thread
410  @param node current node vlib_node_runtime_t pointer
411  @param next_index requested graph arc index
412
413  @return @c vectors -- pointer to next available vector slot
414  @return @c n_vectors_left -- number of vector slots available
415 */
416 #define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left)    \
417   vlib_get_next_frame_macro (vm, node, next_index, vectors, n_vectors_left,   \
418                              /* alloc new frame */ 0)
419
420 #define vlib_get_new_next_frame(vm, node, next_index, vectors,                \
421                                 n_vectors_left)                               \
422   vlib_get_next_frame_macro (vm, node, next_index, vectors, n_vectors_left,   \
423                              /* alloc new frame */ 1)
424
425 /** \brief Get pointer to next frame vector data and next frame aux data by
426     (@c vlib_node_runtime_t, @c next_index).
427  Standard single/dual loop boilerplate element.
428  @attention This is a MACRO, with SIDE EFFECTS.
429  @attention This MACRO is unsafe in case the next node does not support
430  aux_data
431
432  @param vm vlib_main_t pointer, varies by thread
433  @param node current node vlib_node_runtime_t pointer
434  @param next_index requested graph arc index
435
436  @return @c vectors -- pointer to next available vector slot
437  @return @c aux_data -- pointer to next available aux data slot
438  @return @c n_vectors_left -- number of vector slots available
439 */
440 #define vlib_get_next_frame_with_aux(vm, node, next_index, vectors, aux_data, \
441                                      n_vectors_left)                          \
442   vlib_get_next_frame_macro_with_aux (                                        \
443     vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 0,   \
444     aux_data, /* maybe_no_aux */ 0)
445
446 #define vlib_get_new_next_frame_with_aux(vm, node, next_index, vectors,       \
447                                          aux_data, n_vectors_left)            \
448   vlib_get_next_frame_macro_with_aux (                                        \
449     vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 1,   \
450     aux_data, /* maybe_no_aux */ 0)
451
452 /** \brief Get pointer to next frame vector data and next frame aux data by
453     (@c vlib_node_runtime_t, @c next_index).
454  Standard single/dual loop boilerplate element.
455  @attention This is a MACRO, with SIDE EFFECTS.
456  @attention This MACRO is safe in case the next node does not support aux_data.
457  In that case aux_data is set to NULL.
458
459  @param vm vlib_main_t pointer, varies by thread
460  @param node current node vlib_node_runtime_t pointer
461  @param next_index requested graph arc index
462
463  @return @c vectors -- pointer to next available vector slot
464  @return @c aux_data -- pointer to next available aux data slot
465  @return @c n_vectors_left -- number of vector slots available
466 */
467 #define vlib_get_next_frame_with_aux_safe(vm, node, next_index, vectors,      \
468                                           aux_data, n_vectors_left)           \
469   vlib_get_next_frame_macro_with_aux (                                        \
470     vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 0,   \
471     aux_data, /* maybe_no_aux */ 1)
472
473 #define vlib_get_new_next_frame_with_aux_safe(vm, node, next_index, vectors,  \
474                                               aux_data, n_vectors_left)       \
475   vlib_get_next_frame_macro_with_aux (                                        \
476     vm, node, next_index, vectors, n_vectors_left, /* alloc new frame */ 1,   \
477     aux_data, /* maybe_no_aux */ 1)
478
479 /** \brief Release pointer to next frame vector data.
480  Standard single/dual loop boilerplate element.
481  @param vm vlib_main_t pointer, varies by thread
482  @param r current node vlib_node_runtime_t pointer
483  @param next_index graph arc index
484  @param n_packets_left number of slots still available in vector
485 */
486 void
487 vlib_put_next_frame (vlib_main_t * vm,
488                      vlib_node_runtime_t * r,
489                      u32 next_index, u32 n_packets_left);
490
491 /* Combination get plus put.  Returns vector argument just added. */
492 #define vlib_set_next_frame(vm,node,next_index,v)                       \
493 ({                                                                      \
494   uword _n_left;                                                        \
495   vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left);       \
496   ASSERT (_n_left > 0);                                                 \
497   vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1);        \
498   (v);                                                                  \
499 })
500
501 always_inline void
502 vlib_set_next_frame_buffer (vlib_main_t * vm,
503                             vlib_node_runtime_t * node,
504                             u32 next_index, u32 buffer_index)
505 {
506   u32 *p;
507   p = vlib_set_next_frame (vm, node, next_index, p);
508   p[0] = buffer_index;
509 }
510
511 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
512 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
513                              vlib_frame_t * f);
514
515 always_inline uword
516 vlib_in_process_context (vlib_main_t * vm)
517 {
518   return vm->node_main.current_process_index != ~0;
519 }
520
521 always_inline vlib_process_t *
522 vlib_get_current_process (vlib_main_t * vm)
523 {
524   vlib_node_main_t *nm = &vm->node_main;
525   if (vlib_in_process_context (vm))
526     return vec_elt (nm->processes, nm->current_process_index);
527   return 0;
528 }
529
530 always_inline uword
531 vlib_current_process (vlib_main_t * vm)
532 {
533   return vlib_get_current_process (vm)->node_runtime.node_index;
534 }
535
536 always_inline u32
537 vlib_get_current_process_node_index (vlib_main_t * vm)
538 {
539   vlib_process_t *process = vlib_get_current_process (vm);
540   return process->node_runtime.node_index;
541 }
542
543 /** Returns TRUE if a process suspend time is less than 10us
544     @param dt - remaining poll time in seconds
545     @returns 1 if dt < 10e-6, 0 otherwise
546 */
547 always_inline uword
548 vlib_process_suspend_time_is_zero (f64 dt)
549 {
550   return dt < 10e-6;
551 }
552
553 /** Suspend a vlib cooperative multi-tasking thread for a period of time
554     @param vm - vlib_main_t *
555     @param dt - suspend interval in seconds
556     @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
557 */
558
559 always_inline uword
560 vlib_process_suspend (vlib_main_t * vm, f64 dt)
561 {
562   uword r;
563   vlib_node_main_t *nm = &vm->node_main;
564   vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
565
566   if (vlib_process_suspend_time_is_zero (dt))
567     return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
568
569   p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
570   r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
571   if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
572     {
573       /* expiration time in 10us ticks */
574       p->resume_clock_interval = dt * 1e5;
575       vlib_process_start_switch_stack (vm, 0);
576       clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
577     }
578   else
579     vlib_process_finish_switch_stack (vm);
580
581   return r;
582 }
583
584 always_inline void
585 vlib_process_free_event_type (vlib_process_t * p, uword t,
586                               uword is_one_time_event)
587 {
588   ASSERT (!pool_is_free_index (p->event_type_pool, t));
589   pool_put_index (p->event_type_pool, t);
590   if (is_one_time_event)
591     p->one_time_event_type_bitmap =
592       clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
593 }
594
595 always_inline void
596 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
597 {
598   ASSERT (!pool_is_free_index (p->event_type_pool, t));
599   if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
600     vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
601 }
602
603 always_inline void *
604 vlib_process_get_event_data (vlib_main_t * vm,
605                              uword * return_event_type_opaque)
606 {
607   vlib_node_main_t *nm = &vm->node_main;
608   vlib_process_t *p;
609   vlib_process_event_type_t *et;
610   uword t;
611   void *event_data_vector;
612
613   p = vec_elt (nm->processes, nm->current_process_index);
614
615   /* Find first type with events ready.
616      Return invalid type when there's nothing there. */
617   t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
618   if (t == ~0)
619     return 0;
620
621   p->non_empty_event_type_bitmap =
622     clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
623
624   ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
625   event_data_vector = p->pending_event_data_by_type_index[t];
626   p->pending_event_data_by_type_index[t] = 0;
627
628   et = pool_elt_at_index (p->event_type_pool, t);
629
630   /* Return user's opaque value and possibly index. */
631   *return_event_type_opaque = et->opaque;
632
633   vlib_process_maybe_free_event_type (p, t);
634
635   return event_data_vector;
636 }
637
638 /* Return event data vector for later reuse.  We reuse event data to avoid
639    repeatedly allocating event vectors in cases where we care about speed. */
640 always_inline void
641 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
642 {
643   vlib_node_main_t *nm = &vm->node_main;
644   vec_add1 (nm->recycled_event_data_vectors, event_data);
645 }
646
647 /** Return the first event type which has occurred and a vector of per-event
648     data of that type, or a timeout indication
649
650     @param vm - vlib_main_t pointer
651     @param data_vector - pointer to a (uword *) vector to receive event data
652     @returns either an event type and a vector of per-event instance data,
653     or ~0 to indicate a timeout.
654 */
655
656 always_inline uword
657 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
658 {
659   vlib_node_main_t *nm = &vm->node_main;
660   vlib_process_t *p;
661   vlib_process_event_type_t *et;
662   uword r, t, l;
663
664   p = vec_elt (nm->processes, nm->current_process_index);
665
666   /* Find first type with events ready.
667      Return invalid type when there's nothing there. */
668   t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
669   if (t == ~0)
670     return t;
671
672   p->non_empty_event_type_bitmap =
673     clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
674
675   l = _vec_len (p->pending_event_data_by_type_index[t]);
676   if (data_vector)
677     vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
678   vec_set_len (p->pending_event_data_by_type_index[t], 0);
679
680   et = pool_elt_at_index (p->event_type_pool, t);
681
682   /* Return user's opaque value. */
683   r = et->opaque;
684
685   vlib_process_maybe_free_event_type (p, t);
686
687   return r;
688 }
689
690 always_inline uword
691 vlib_process_get_events_helper (vlib_process_t * p, uword t,
692                                 uword ** data_vector)
693 {
694   uword l;
695
696   p->non_empty_event_type_bitmap =
697     clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
698
699   l = _vec_len (p->pending_event_data_by_type_index[t]);
700   if (data_vector)
701     vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
702   vec_set_len (p->pending_event_data_by_type_index[t], 0);
703
704   vlib_process_maybe_free_event_type (p, t);
705
706   return l;
707 }
708
709 /* As above but query as specified type of event.  Returns number of
710    events found. */
711 always_inline uword
712 vlib_process_get_events_with_type (vlib_main_t * vm, 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 t, *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   if (!h)
722     /* This can happen when an event has not yet been
723        signaled with given opaque type. */
724     return 0;
725
726   t = h[0];
727   if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
728     return 0;
729
730   return vlib_process_get_events_helper (p, t, data_vector);
731 }
732
733 always_inline uword *
734 vlib_process_wait_for_event (vlib_main_t * vm)
735 {
736   vlib_node_main_t *nm = &vm->node_main;
737   vlib_process_t *p;
738   uword r;
739
740   p = vec_elt (nm->processes, nm->current_process_index);
741   if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
742     {
743       p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
744       r =
745         clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
746       if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
747         {
748           vlib_process_start_switch_stack (vm, 0);
749           clib_longjmp (&p->return_longjmp,
750                         VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
751         }
752       else
753         vlib_process_finish_switch_stack (vm);
754     }
755
756   return p->non_empty_event_type_bitmap;
757 }
758
759 always_inline uword
760 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
761                                       uword ** data_vector,
762                                       uword with_type_index)
763 {
764   vlib_node_main_t *nm = &vm->node_main;
765   vlib_process_t *p;
766   uword r;
767
768   p = vec_elt (nm->processes, nm->current_process_index);
769   ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
770   while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
771     {
772       p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
773       r =
774         clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
775       if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
776         {
777           vlib_process_start_switch_stack (vm, 0);
778           clib_longjmp (&p->return_longjmp,
779                         VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
780         }
781       else
782         vlib_process_finish_switch_stack (vm);
783     }
784
785   return vlib_process_get_events_helper (p, with_type_index, data_vector);
786 }
787
788 always_inline uword
789 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
790                                        uword ** data_vector,
791                                        uword with_type_opaque)
792 {
793   vlib_node_main_t *nm = &vm->node_main;
794   vlib_process_t *p;
795   uword r, *h;
796
797   p = vec_elt (nm->processes, nm->current_process_index);
798   h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
799   while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
800     {
801       p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
802       r =
803         clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
804       if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
805         {
806           vlib_process_start_switch_stack (vm, 0);
807           clib_longjmp (&p->return_longjmp,
808                         VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
809         }
810       else
811         vlib_process_finish_switch_stack (vm);
812
813       /* See if unknown event type has been signaled now. */
814       if (!h)
815         h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
816     }
817
818   return vlib_process_get_events_helper (p, h[0], data_vector);
819 }
820
821 /** Suspend a cooperative multi-tasking thread
822     Waits for an event, or for the indicated number of seconds to elapse
823     @param vm - vlib_main_t pointer
824     @param dt - timeout, in seconds.
825     @returns the remaining time interval
826 */
827
828 always_inline f64
829 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
830 {
831   vlib_node_main_t *nm = &vm->node_main;
832   vlib_process_t *p;
833   f64 wakeup_time;
834   uword r;
835
836   p = vec_elt (nm->processes, nm->current_process_index);
837
838   if (vlib_process_suspend_time_is_zero (dt)
839       || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
840     return dt;
841
842   wakeup_time = vlib_time_now (vm) + dt;
843
844   /* Suspend waiting for both clock and event to occur. */
845   p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
846                | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
847
848   r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
849   if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
850     {
851       p->resume_clock_interval = dt * 1e5;
852       vlib_process_start_switch_stack (vm, 0);
853       clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
854     }
855   else
856     vlib_process_finish_switch_stack (vm);
857
858   /* Return amount of time still left to sleep.
859      If <= 0 then we've been waken up by the clock (and not an event). */
860   return wakeup_time - vlib_time_now (vm);
861 }
862
863 always_inline vlib_process_event_type_t *
864 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
865 {
866   vlib_process_event_type_t *et;
867   pool_get (p->event_type_pool, et);
868   et->opaque = with_type_opaque;
869   return et;
870 }
871
872 always_inline uword
873 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
874                                     uword with_type_opaque)
875 {
876   vlib_node_main_t *nm = &vm->node_main;
877   vlib_node_t *n = vlib_get_node (vm, node_index);
878   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
879   vlib_process_event_type_t *et;
880   uword t;
881
882   et = vlib_process_new_event_type (p, with_type_opaque);
883   t = et - p->event_type_pool;
884   p->one_time_event_type_bitmap =
885     clib_bitmap_ori (p->one_time_event_type_bitmap, t);
886   return t;
887 }
888
889 always_inline void
890 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
891                                     uword t)
892 {
893   vlib_node_main_t *nm = &vm->node_main;
894   vlib_node_t *n = vlib_get_node (vm, node_index);
895   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
896
897   ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
898   vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
899 }
900
901 always_inline void *
902 vlib_process_signal_event_helper (vlib_node_main_t * nm,
903                                   vlib_node_t * n,
904                                   vlib_process_t * p,
905                                   uword t,
906                                   uword n_data_elts, uword n_data_elt_bytes)
907 {
908   uword p_flags, add_to_pending, delete_from_wheel;
909   u8 *data_to_be_written_by_caller;
910   vec_attr_t va = { .elt_sz = n_data_elt_bytes };
911
912   ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
913
914   ASSERT (!pool_is_free_index (p->event_type_pool, t));
915
916   vec_validate (p->pending_event_data_by_type_index, t);
917
918   /* Resize data vector and return caller's data to be written. */
919   {
920     u8 *data_vec = p->pending_event_data_by_type_index[t];
921     uword l;
922
923     if (!data_vec && vec_len (nm->recycled_event_data_vectors))
924       {
925         data_vec = vec_pop (nm->recycled_event_data_vectors);
926         vec_reset_length (data_vec);
927       }
928
929     l = vec_len (data_vec);
930
931     data_vec = _vec_realloc_internal (data_vec, l + n_data_elts, &va);
932
933     p->pending_event_data_by_type_index[t] = data_vec;
934     data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
935   }
936
937   p->non_empty_event_type_bitmap =
938     clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
939
940   p_flags = p->flags;
941
942   /* Event was already signalled? */
943   add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
944
945   /* Process will resume when suspend time elapses? */
946   delete_from_wheel = 0;
947   if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
948     {
949       /* Waiting for both event and clock? */
950       if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
951         {
952           if (!TW (tw_timer_handle_is_free)
953               ((TWT (tw_timer_wheel) *) nm->timing_wheel,
954                p->stop_timer_handle))
955             delete_from_wheel = 1;
956           else
957             /* timer just popped so process should already be on the list */
958             add_to_pending = 0;
959         }
960       else
961         /* Waiting only for clock.  Event will be queue and may be
962            handled when timer expires. */
963         add_to_pending = 0;
964     }
965
966   /* Never add current process to pending vector since current process is
967      already running. */
968   add_to_pending &= nm->current_process_index != n->runtime_index;
969
970   if (add_to_pending)
971     {
972       u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
973       p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
974       vec_add1 (nm->data_from_advancing_timing_wheel, x);
975       if (delete_from_wheel)
976         TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
977                             p->stop_timer_handle);
978     }
979
980   return data_to_be_written_by_caller;
981 }
982
983 always_inline void *
984 vlib_process_signal_event_data (vlib_main_t * vm,
985                                 uword node_index,
986                                 uword type_opaque,
987                                 uword n_data_elts, uword n_data_elt_bytes)
988 {
989   vlib_node_main_t *nm = &vm->node_main;
990   vlib_node_t *n = vlib_get_node (vm, node_index);
991   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
992   uword *h, t;
993
994   /* Must be in main thread */
995   ASSERT (vlib_get_thread_index () == 0);
996
997   h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
998   if (!h)
999     {
1000       vlib_process_event_type_t *et =
1001         vlib_process_new_event_type (p, type_opaque);
1002       t = et - p->event_type_pool;
1003       hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1004     }
1005   else
1006     t = h[0];
1007
1008   return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1009                                            n_data_elt_bytes);
1010 }
1011
1012 always_inline void *
1013 vlib_process_signal_event_at_time (vlib_main_t * vm,
1014                                    f64 dt,
1015                                    uword node_index,
1016                                    uword type_opaque,
1017                                    uword n_data_elts, uword n_data_elt_bytes)
1018 {
1019   vlib_node_main_t *nm = &vm->node_main;
1020   vlib_node_t *n = vlib_get_node (vm, node_index);
1021   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1022   uword *h, t;
1023
1024   h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
1025   if (!h)
1026     {
1027       vlib_process_event_type_t *et =
1028         vlib_process_new_event_type (p, type_opaque);
1029       t = et - p->event_type_pool;
1030       hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
1031     }
1032   else
1033     t = h[0];
1034
1035   if (vlib_process_suspend_time_is_zero (dt))
1036     return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
1037                                              n_data_elt_bytes);
1038   else
1039     {
1040       vlib_signal_timed_event_data_t *te;
1041
1042       pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
1043
1044       te->n_data_elts = n_data_elts;
1045       te->n_data_elt_bytes = n_data_elt_bytes;
1046       te->n_data_bytes = n_data_elts * n_data_elt_bytes;
1047
1048       /* Assert that structure fields are big enough. */
1049       ASSERT (te->n_data_elts == n_data_elts);
1050       ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
1051       ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
1052
1053       te->process_node_index = n->runtime_index;
1054       te->event_type_index = t;
1055
1056       p->stop_timer_handle =
1057         TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1058                              vlib_timing_wheel_data_set_timed_event
1059                              (te - nm->signal_timed_event_data_pool),
1060                              0 /* timer_id */ ,
1061                              (vlib_time_now (vm) + dt) * 1e5);
1062
1063       /* Inline data big enough to hold event? */
1064       if (te->n_data_bytes < sizeof (te->inline_event_data))
1065         return te->inline_event_data;
1066       else
1067         {
1068           te->event_data_as_vector = 0;
1069           vec_resize (te->event_data_as_vector, te->n_data_bytes);
1070           return te->event_data_as_vector;
1071         }
1072     }
1073 }
1074
1075 always_inline void *
1076 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
1077                                          uword node_index,
1078                                          uword type_index,
1079                                          uword n_data_elts,
1080                                          uword n_data_elt_bytes)
1081 {
1082   vlib_node_main_t *nm = &vm->node_main;
1083   vlib_node_t *n = vlib_get_node (vm, node_index);
1084   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
1085   return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
1086                                            n_data_elt_bytes);
1087 }
1088
1089 always_inline void
1090 vlib_process_signal_event (vlib_main_t * vm,
1091                            uword node_index, uword type_opaque, uword data)
1092 {
1093   uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1094                                              1 /* elts */ , sizeof (uword));
1095   d[0] = data;
1096 }
1097
1098 always_inline void
1099 vlib_process_signal_event_pointer (vlib_main_t * vm,
1100                                    uword node_index,
1101                                    uword type_opaque, void *data)
1102 {
1103   void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
1104                                              1 /* elts */ , sizeof (data));
1105   d[0] = data;
1106 }
1107
1108 /**
1109  * Signal event to process from any thread.
1110  *
1111  * When in doubt, use this.
1112  */
1113 always_inline void
1114 vlib_process_signal_event_mt (vlib_main_t * vm,
1115                               uword node_index, uword type_opaque, uword data)
1116 {
1117   if (vlib_get_thread_index () != 0)
1118     {
1119       vlib_process_signal_event_mt_args_t args = {
1120         .node_index = node_index,
1121         .type_opaque = type_opaque,
1122         .data = data,
1123       };
1124       vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
1125                                  (u8 *) & args, sizeof (args));
1126     }
1127   else
1128     vlib_process_signal_event (vm, node_index, type_opaque, data);
1129 }
1130
1131 always_inline void
1132 vlib_process_signal_one_time_event (vlib_main_t * vm,
1133                                     uword node_index,
1134                                     uword type_index, uword data)
1135 {
1136   uword *d =
1137     vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1138                                              1 /* elts */ , sizeof (uword));
1139   d[0] = data;
1140 }
1141
1142 always_inline void
1143 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1144                                       vlib_one_time_waiting_process_t * p)
1145 {
1146   vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1147                                       /* data */ ~0);
1148   clib_memset (p, ~0, sizeof (p[0]));
1149 }
1150
1151 always_inline void
1152 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1153                                              vlib_one_time_waiting_process_t
1154                                              ** wps)
1155 {
1156   vlib_one_time_waiting_process_t *wp;
1157   vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1158   vec_free (*wps);
1159 }
1160
1161 always_inline void
1162 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1163                                               vlib_one_time_waiting_process_t
1164                                               * p)
1165 {
1166   p->node_index = vlib_current_process (vm);
1167   p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index,    /* type opaque */
1168                                                           ~0);
1169   vlib_process_wait_for_one_time_event (vm,
1170                                         /* don't care about data */ 0,
1171                                         p->one_time_event);
1172 }
1173
1174 always_inline void
1175 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1176                                                      vlib_one_time_waiting_process_t
1177                                                      ** wps)
1178 {
1179   vlib_one_time_waiting_process_t *wp;
1180   vec_add2 (*wps, wp, 1);
1181   vlib_current_process_wait_for_one_time_event (vm, wp);
1182 }
1183
1184 always_inline u32
1185 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1186                                                  vlib_node_runtime_t * node,
1187                                                  uword n_vectors)
1188 {
1189   u32 i, d, vi0, vi1;
1190   u32 i0, i1;
1191
1192   ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1193   i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1194        & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1195   i0 = i ^ 0;
1196   i1 = i ^ 1;
1197   d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1198        -
1199        (node->main_loop_count_last_dispatch >>
1200         VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1201   vi0 = node->main_loop_vector_stats[i0];
1202   vi1 = node->main_loop_vector_stats[i1];
1203   vi0 = d == 0 ? vi0 : 0;
1204   vi1 = d <= 1 ? vi1 : 0;
1205   vi0 += n_vectors;
1206   node->main_loop_vector_stats[i0] = vi0;
1207   node->main_loop_vector_stats[i1] = vi1;
1208   node->main_loop_count_last_dispatch = vm->main_loop_count;
1209   /* Return previous counter. */
1210   return node->main_loop_vector_stats[i1];
1211 }
1212
1213 always_inline f64
1214 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1215 {
1216   vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1217   u32 v;
1218
1219   v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt,  /* n_vectors */
1220                                                        0);
1221   return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1222 }
1223
1224 always_inline u32
1225 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1226 {
1227   vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1228   u32 v;
1229
1230   v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt,  /* n_vectors */
1231                                                        0);
1232   return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1233 }
1234
1235 void
1236 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1237
1238 /* Return the edge index if present, ~0 otherwise */
1239 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1240
1241 /* Add next node to given node in given slot. */
1242 uword
1243 vlib_node_add_next_with_slot (vlib_main_t * vm,
1244                               uword node, uword next_node, uword slot);
1245
1246 /* As above but adds to end of node's next vector. */
1247 always_inline uword
1248 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1249 {
1250   return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1251 }
1252
1253 /* Add next node to given node in given slot. */
1254 uword
1255 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1256                                     uword node, char *next_name, uword slot);
1257
1258 /* As above but adds to end of node's next vector. */
1259 always_inline uword
1260 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1261 {
1262   return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1263 }
1264
1265 /**
1266  * Get list of nodes
1267  */
1268 void
1269 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1270                      int barrier_sync, vlib_node_t **** node_dupsp,
1271                      vlib_main_t *** stat_vmsp);
1272
1273 /* Query node given name. */
1274 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1275
1276 /* Rename a node. */
1277 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1278
1279 /* Register new packet processing node.  Nodes can be registered
1280    dynamically via this call or statically via the VLIB_REGISTER_NODE
1281    macro. */
1282 u32 vlib_register_node (vlib_main_t *vm, vlib_node_registration_t *r,
1283                         char *fmt, ...);
1284
1285 /* Register all node function variants */
1286 void vlib_register_all_node_march_variants (vlib_main_t *vm);
1287
1288 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1289 void vlib_register_all_static_nodes (vlib_main_t * vm);
1290
1291 /* Start a process. */
1292 void vlib_start_process (vlib_main_t * vm, uword process_index);
1293
1294 /* Sync up runtime and main node stats. */
1295 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1296 void vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
1297                                    uword n_calls, uword n_vectors,
1298                                    uword n_clocks);
1299 void vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
1300                                         uword n_calls, uword n_vectors,
1301                                         uword n_clocks);
1302
1303 /* Node graph initialization function. */
1304 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1305
1306 format_function_t format_vlib_node_graph;
1307 format_function_t format_vlib_node_name;
1308 format_function_t format_vlib_next_node_name;
1309 format_function_t format_vlib_node_and_next;
1310 format_function_t format_vlib_cpu_time;
1311 format_function_t format_vlib_time;
1312 /* Parse node name -> node index. */
1313 unformat_function_t unformat_vlib_node;
1314
1315 always_inline void
1316 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1317                              u32 counter_index, u64 increment)
1318 {
1319   vlib_node_t *n = vlib_get_node (vm, node_index);
1320   vlib_error_main_t *em = &vm->error_main;
1321   u32 node_counter_base_index = n->error_heap_index;
1322   em->counters[node_counter_base_index + counter_index] += increment;
1323 }
1324
1325 /** @brief Create a vlib process
1326  *  @param vm &vlib_global_main
1327  *  @param f the process node function
1328  *  @param log2_n_stack_bytes size of the process stack, defaults to 16K
1329  *  @return newly-create node index
1330  *  @warning call only on the main thread. Barrier sync required
1331  */
1332 u32 vlib_process_create (vlib_main_t * vm, char *name,
1333                          vlib_node_function_t * f, u32 log2_n_stack_bytes);
1334
1335 always_inline int
1336 vlib_node_set_dispatch_wrapper (vlib_main_t *vm, vlib_node_function_t *fn)
1337 {
1338   if (fn && vm->dispatch_wrapper_fn)
1339     return 1;
1340   vm->dispatch_wrapper_fn = fn;
1341   return 0;
1342 }
1343
1344 int vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
1345                                  clib_march_variant_type_t march_variant);
1346
1347 vlib_node_function_t *
1348 vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
1349                                          vlib_node_fn_registration_t *regs);
1350
1351 /*
1352  * vlib_frame_bitmap functions
1353  */
1354
1355 #define VLIB_FRAME_BITMAP_N_UWORDS                                            \
1356   (((VLIB_FRAME_SIZE + uword_bits - 1) & ~(uword_bits - 1)) / uword_bits)
1357
1358 typedef uword vlib_frame_bitmap_t[VLIB_FRAME_BITMAP_N_UWORDS];
1359
1360 static_always_inline void
1361 vlib_frame_bitmap_init (uword *bmp, u32 n_first_bits_set)
1362 {
1363   u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1364   while (n_first_bits_set >= (sizeof (uword) * 8) && n_left)
1365     {
1366       bmp++[0] = ~0;
1367       n_first_bits_set -= sizeof (uword) * 8;
1368       n_left--;
1369     }
1370
1371   if (n_first_bits_set && n_left)
1372     {
1373       bmp++[0] = pow2_mask (n_first_bits_set);
1374       n_left--;
1375     }
1376
1377   while (n_left--)
1378     bmp++[0] = 0;
1379 }
1380
1381 static_always_inline void
1382 vlib_frame_bitmap_clear (uword *bmp)
1383 {
1384   u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1385   while (n_left--)
1386     bmp++[0] = 0;
1387 }
1388
1389 static_always_inline void
1390 vlib_frame_bitmap_xor (uword *bmp, uword *bmp2)
1391 {
1392   u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1393   while (n_left--)
1394     bmp++[0] ^= bmp2++[0];
1395 }
1396
1397 static_always_inline void
1398 vlib_frame_bitmap_or (uword *bmp, uword *bmp2)
1399 {
1400   u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1401   while (n_left--)
1402     bmp++[0] |= bmp2++[0];
1403 }
1404
1405 static_always_inline void
1406 vlib_frame_bitmap_and (uword *bmp, uword *bmp2)
1407 {
1408   u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1409   while (n_left--)
1410     bmp++[0] &= bmp2++[0];
1411 }
1412
1413 static_always_inline u32
1414 vlib_frame_bitmap_count_set_bits (uword *bmp)
1415 {
1416   u32 n_left = VLIB_FRAME_BITMAP_N_UWORDS;
1417   u32 count = 0;
1418   while (n_left--)
1419     count += count_set_bits (bmp++[0]);
1420   return count;
1421 }
1422
1423 static_always_inline int
1424 vlib_frame_bitmap_find_first_set (uword *bmp)
1425 {
1426   uword *b = bmp;
1427   while (b[0] == 0)
1428     {
1429       ASSERT (b - bmp < VLIB_FRAME_BITMAP_N_UWORDS);
1430       b++;
1431     }
1432
1433   return (b - bmp) * uword_bits + get_lowest_set_bit_index (b[0]);
1434 }
1435
1436 #define foreach_vlib_frame_bitmap_set_bit_index(i, v)                         \
1437   for (uword _off = 0; _off < ARRAY_LEN (v); _off++)                          \
1438     for (uword _tmp =                                                         \
1439            (v[_off]) + 0 * (uword) (i = _off * uword_bits +                   \
1440                                         get_lowest_set_bit_index (v[_off]));  \
1441          _tmp; i = _off * uword_bits + get_lowest_set_bit_index (             \
1442                                          _tmp = clear_lowest_set_bit (_tmp)))
1443
1444 #endif /* included_vlib_node_funcs_h */
1445
1446 /*
1447  * fd.io coding-style-patch-verification: ON
1448  *
1449  * Local Variables:
1450  * eval: (c-set-style "gnu")
1451  * End:
1452  */