vlib rename vlib_frame_args(...) to vlib_frame_scalar_args(..)
[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
51 /** \brief Get vlib node by index.
52  @warning This function will ASSERT if @c i is out of range.
53  @param vm vlib_main_t pointer, varies by thread
54  @param i node index.
55  @return pointer to the requested vlib_node_t.
56 */
57
58 always_inline vlib_node_t *
59 vlib_get_node (vlib_main_t * vm, u32 i)
60 {
61   return vec_elt (vm->node_main.nodes, i);
62 }
63
64 /** \brief Get vlib node by graph arc (next) index.
65  @param vm vlib_main_t pointer, varies by thread
66  @param node_index index of original node
67  @param next_index graph arc index
68  @return pointer to the vlib_node_t at the end of the indicated arc
69 */
70
71 always_inline vlib_node_t *
72 vlib_get_next_node (vlib_main_t * vm, u32 node_index, u32 next_index)
73 {
74   vlib_node_main_t *nm = &vm->node_main;
75   vlib_node_t *n;
76
77   n = vec_elt (nm->nodes, node_index);
78   ASSERT (next_index < vec_len (n->next_nodes));
79   return vlib_get_node (vm, n->next_nodes[next_index]);
80 }
81
82 /** \brief Get node runtime by node index.
83  @param vm vlib_main_t pointer, varies by thread
84  @param node_index index of node
85  @return pointer to the indicated vlib_node_runtime_t
86 */
87
88 always_inline vlib_node_runtime_t *
89 vlib_node_get_runtime (vlib_main_t * vm, u32 node_index)
90 {
91   vlib_node_main_t *nm = &vm->node_main;
92   vlib_node_t *n = vec_elt (nm->nodes, node_index);
93   vlib_process_t *p;
94   if (n->type != VLIB_NODE_TYPE_PROCESS)
95     return vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
96   else
97     {
98       p = vec_elt (nm->processes, n->runtime_index);
99       return &p->node_runtime;
100     }
101 }
102
103 /** \brief Get node runtime private data by node index.
104  @param vm vlib_main_t pointer, varies by thread
105  @param node_index index of the node
106  @return pointer to the indicated vlib_node_runtime_t private data
107 */
108
109 always_inline void *
110 vlib_node_get_runtime_data (vlib_main_t * vm, u32 node_index)
111 {
112   vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
113   return r->runtime_data;
114 }
115
116 /** \brief Set node runtime private data.
117  @param vm vlib_main_t pointer, varies by thread
118  @param node_index index of the node
119  @param runtime_data arbitrary runtime private data
120  @param n_runtime_data_bytes size of runtime private data
121 */
122
123 always_inline void
124 vlib_node_set_runtime_data (vlib_main_t * vm, u32 node_index,
125                             void *runtime_data, u32 n_runtime_data_bytes)
126 {
127   vlib_node_t *n = vlib_get_node (vm, node_index);
128   vlib_node_runtime_t *r = vlib_node_get_runtime (vm, node_index);
129
130   n->runtime_data_bytes = n_runtime_data_bytes;
131   vec_free (n->runtime_data);
132   vec_add (n->runtime_data, runtime_data, n_runtime_data_bytes);
133
134   ASSERT (vec_len (n->runtime_data) <= sizeof (vlib_node_runtime_t) -
135           STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
136
137   if (vec_len (n->runtime_data) > 0)
138     clib_memcpy (r->runtime_data, n->runtime_data, vec_len (n->runtime_data));
139 }
140
141 /** \brief Set node dispatch state.
142  @param vm vlib_main_t pointer, varies by thread
143  @param node_index index of the node
144  @param new_state new state for node, see vlib_node_state_t
145 */
146 always_inline void
147 vlib_node_set_state (vlib_main_t * vm, u32 node_index,
148                      vlib_node_state_t new_state)
149 {
150   vlib_node_main_t *nm = &vm->node_main;
151   vlib_node_t *n;
152   vlib_node_runtime_t *r;
153
154   n = vec_elt (nm->nodes, node_index);
155   if (n->type == VLIB_NODE_TYPE_PROCESS)
156     {
157       vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
158       r = &p->node_runtime;
159
160       /* When disabling make sure flags are cleared. */
161       p->flags &= ~(VLIB_PROCESS_RESUME_PENDING
162                     | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
163                     | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT);
164     }
165   else
166     r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
167
168   ASSERT (new_state < VLIB_N_NODE_STATE);
169
170   if (n->type == VLIB_NODE_TYPE_INPUT)
171     {
172       ASSERT (nm->input_node_counts_by_state[n->state] > 0);
173       nm->input_node_counts_by_state[n->state] -= 1;
174       nm->input_node_counts_by_state[new_state] += 1;
175     }
176
177   n->state = new_state;
178   r->state = new_state;
179 }
180
181 /** \brief Get node dispatch state.
182  @param vm vlib_main_t pointer, varies by thread
183  @param node_index index of the node
184  @return state for node, see vlib_node_state_t
185 */
186 always_inline vlib_node_state_t
187 vlib_node_get_state (vlib_main_t * vm, u32 node_index)
188 {
189   vlib_node_main_t *nm = &vm->node_main;
190   vlib_node_t *n;
191   n = vec_elt (nm->nodes, node_index);
192   return n->state;
193 }
194
195 always_inline void
196 vlib_node_set_interrupt_pending (vlib_main_t * vm, u32 node_index)
197 {
198   vlib_node_main_t *nm = &vm->node_main;
199   vlib_node_t *n = vec_elt (nm->nodes, node_index);
200   ASSERT (n->type == VLIB_NODE_TYPE_INPUT);
201   clib_spinlock_lock_if_init (&nm->pending_interrupt_lock);
202   vec_add1 (nm->pending_interrupt_node_runtime_indices, n->runtime_index);
203   clib_spinlock_unlock_if_init (&nm->pending_interrupt_lock);
204 }
205
206 always_inline vlib_process_t *
207 vlib_get_process_from_node (vlib_main_t * vm, vlib_node_t * node)
208 {
209   vlib_node_main_t *nm = &vm->node_main;
210   ASSERT (node->type == VLIB_NODE_TYPE_PROCESS);
211   return vec_elt (nm->processes, node->runtime_index);
212 }
213
214 /* Fetches frame with given handle. */
215 always_inline vlib_frame_t *
216 vlib_get_frame_no_check (vlib_main_t * vm, uword frame_index)
217 {
218   vlib_frame_t *f;
219   f = vm->heap_aligned_base + (frame_index * VLIB_FRAME_ALIGN);
220   return f;
221 }
222
223 always_inline u32
224 vlib_frame_index_no_check (vlib_main_t * vm, vlib_frame_t * f)
225 {
226   uword i;
227
228   ASSERT (((uword) f & (VLIB_FRAME_ALIGN - 1)) == 0);
229
230   i = ((u8 *) f - (u8 *) vm->heap_aligned_base);
231   ASSERT ((i / VLIB_FRAME_ALIGN) <= 0xFFFFFFFFULL);
232
233   return i / VLIB_FRAME_ALIGN;
234 }
235
236 always_inline vlib_frame_t *
237 vlib_get_frame (vlib_main_t * vm, uword frame_index)
238 {
239   vlib_frame_t *f = vlib_get_frame_no_check (vm, frame_index);
240   ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
241   return f;
242 }
243
244 always_inline u32
245 vlib_frame_index (vlib_main_t * vm, vlib_frame_t * f)
246 {
247   uword i = vlib_frame_index_no_check (vm, f);
248   ASSERT (vlib_get_frame (vm, i) == f);
249   return i;
250 }
251
252 /* Byte alignment for vector arguments. */
253 #define VLIB_FRAME_VECTOR_ALIGN (1 << 4)
254
255 always_inline u32
256 vlib_frame_vector_byte_offset (u32 scalar_size)
257 {
258   return round_pow2 (sizeof (vlib_frame_t) + scalar_size,
259                      VLIB_FRAME_VECTOR_ALIGN);
260 }
261
262 /** \brief Get pointer to frame vector data.
263  @param f vlib_frame_t pointer
264  @return pointer to first vector element in frame
265 */
266 always_inline void *
267 vlib_frame_vector_args (vlib_frame_t * f)
268 {
269   return (void *) f + vlib_frame_vector_byte_offset (f->scalar_size);
270 }
271
272 /** \brief Get pointer to frame scalar data.
273
274  @param f vlib_frame_t pointer
275
276  @return arbitrary node scalar data
277
278  @sa vlib_frame_vector_args
279 */
280 always_inline void *
281 vlib_frame_scalar_args (vlib_frame_t * f)
282 {
283   return vlib_frame_vector_args (f) - f->scalar_size;
284 }
285
286 always_inline vlib_next_frame_t *
287 vlib_node_runtime_get_next_frame (vlib_main_t * vm,
288                                   vlib_node_runtime_t * n, u32 next_index)
289 {
290   vlib_node_main_t *nm = &vm->node_main;
291   vlib_next_frame_t *nf;
292
293   ASSERT (next_index < n->n_next_nodes);
294   nf = vec_elt_at_index (nm->next_frames, n->next_frame_index + next_index);
295
296   if (CLIB_DEBUG > 0)
297     {
298       vlib_node_t *node, *next;
299       node = vec_elt (nm->nodes, n->node_index);
300       next = vec_elt (nm->nodes, node->next_nodes[next_index]);
301       ASSERT (nf->node_runtime_index == next->runtime_index);
302     }
303
304   return nf;
305 }
306
307 /** \brief Get pointer to frame by (@c node_index, @c next_index).
308
309  @warning This is not a function that you should call directly.
310  See @ref vlib_get_next_frame instead.
311
312  @param vm vlib_main_t pointer, varies by thread
313  @param node_index index of the node
314  @param next_index graph arc index
315
316  @return pointer to the requested vlib_next_frame_t
317
318  @sa vlib_get_next_frame
319 */
320
321 always_inline vlib_next_frame_t *
322 vlib_node_get_next_frame (vlib_main_t * vm, u32 node_index, u32 next_index)
323 {
324   vlib_node_main_t *nm = &vm->node_main;
325   vlib_node_t *n;
326   vlib_node_runtime_t *r;
327
328   n = vec_elt (nm->nodes, node_index);
329   r = vec_elt_at_index (nm->nodes_by_type[n->type], n->runtime_index);
330   return vlib_node_runtime_get_next_frame (vm, r, next_index);
331 }
332
333 vlib_frame_t *vlib_get_next_frame_internal (vlib_main_t * vm,
334                                             vlib_node_runtime_t * node,
335                                             u32 next_index,
336                                             u32 alloc_new_frame);
337
338 #define vlib_get_next_frame_macro(vm,node,next_index,vectors,n_vectors_left,alloc_new_frame) \
339 do {                                                                    \
340   vlib_frame_t * _f                                                     \
341     = vlib_get_next_frame_internal ((vm), (node), (next_index),         \
342                                     (alloc_new_frame));                 \
343   u32 _n = _f->n_vectors;                                               \
344   (vectors) = vlib_frame_vector_args (_f) + _n * sizeof ((vectors)[0]); \
345   (n_vectors_left) = VLIB_FRAME_SIZE - _n;                              \
346 } while (0)
347
348
349 /** \brief Get pointer to next frame vector data by
350     (@c vlib_node_runtime_t, @c next_index).
351  Standard single/dual loop boilerplate element.
352  @attention This is a MACRO, with SIDE EFFECTS.
353
354  @param vm vlib_main_t pointer, varies by thread
355  @param node current node vlib_node_runtime_t pointer
356  @param next_index requested graph arc index
357
358  @return @c vectors -- pointer to next available vector slot
359  @return @c n_vectors_left -- number of vector slots available
360 */
361 #define vlib_get_next_frame(vm,node,next_index,vectors,n_vectors_left)  \
362   vlib_get_next_frame_macro (vm, node, next_index,                      \
363                              vectors, n_vectors_left,                   \
364                              /* alloc new frame */ 0)
365
366 #define vlib_get_new_next_frame(vm,node,next_index,vectors,n_vectors_left) \
367   vlib_get_next_frame_macro (vm, node, next_index,                      \
368                              vectors, n_vectors_left,                   \
369                              /* alloc new frame */ 1)
370
371 /** \brief Release pointer to next frame vector data.
372  Standard single/dual loop boilerplate element.
373  @param vm vlib_main_t pointer, varies by thread
374  @param r current node vlib_node_runtime_t pointer
375  @param next_index graph arc index
376  @param n_packets_left number of slots still available in vector
377 */
378 void
379 vlib_put_next_frame (vlib_main_t * vm,
380                      vlib_node_runtime_t * r,
381                      u32 next_index, u32 n_packets_left);
382
383 /* Combination get plus put.  Returns vector argument just added. */
384 #define vlib_set_next_frame(vm,node,next_index,v)                       \
385 ({                                                                      \
386   uword _n_left;                                                        \
387   vlib_get_next_frame ((vm), (node), (next_index), (v), _n_left);       \
388   ASSERT (_n_left > 0);                                                 \
389   vlib_put_next_frame ((vm), (node), (next_index), _n_left - 1);        \
390   (v);                                                                  \
391 })
392
393 always_inline void
394 vlib_set_next_frame_buffer (vlib_main_t * vm,
395                             vlib_node_runtime_t * node,
396                             u32 next_index, u32 buffer_index)
397 {
398   u32 *p;
399   p = vlib_set_next_frame (vm, node, next_index, p);
400   p[0] = buffer_index;
401 }
402
403 vlib_frame_t *vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index);
404 void vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index,
405                              vlib_frame_t * f);
406
407 always_inline uword
408 vlib_in_process_context (vlib_main_t * vm)
409 {
410   return vm->node_main.current_process_index != ~0;
411 }
412
413 always_inline vlib_process_t *
414 vlib_get_current_process (vlib_main_t * vm)
415 {
416   vlib_node_main_t *nm = &vm->node_main;
417   if (vlib_in_process_context (vm))
418     return vec_elt (nm->processes, nm->current_process_index);
419   return 0;
420 }
421
422 always_inline uword
423 vlib_current_process (vlib_main_t * vm)
424 {
425   return vlib_get_current_process (vm)->node_runtime.node_index;
426 }
427
428 /** Returns TRUE if a process suspend time is less than 10us
429     @param dt - remaining poll time in seconds
430     @returns 1 if dt < 10e-6, 0 otherwise
431 */
432 always_inline uword
433 vlib_process_suspend_time_is_zero (f64 dt)
434 {
435   return dt < 10e-6;
436 }
437
438 /** Suspend a vlib cooperative multi-tasking thread for a period of time
439     @param vm - vlib_main_t *
440     @param dt - suspend interval in seconds
441     @returns VLIB_PROCESS_RESUME_LONGJMP_RESUME, routinely ignored
442 */
443
444 always_inline uword
445 vlib_process_suspend (vlib_main_t * vm, f64 dt)
446 {
447   uword r;
448   vlib_node_main_t *nm = &vm->node_main;
449   vlib_process_t *p = vec_elt (nm->processes, nm->current_process_index);
450
451   if (vlib_process_suspend_time_is_zero (dt))
452     return VLIB_PROCESS_RESUME_LONGJMP_RESUME;
453
454   p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK;
455   r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
456   if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
457     {
458       /* expiration time in 10us ticks */
459       p->resume_clock_interval = dt * 1e5;
460       clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
461     }
462
463   return r;
464 }
465
466 always_inline void
467 vlib_process_free_event_type (vlib_process_t * p, uword t,
468                               uword is_one_time_event)
469 {
470   ASSERT (!pool_is_free_index (p->event_type_pool, t));
471   pool_put_index (p->event_type_pool, t);
472   if (is_one_time_event)
473     p->one_time_event_type_bitmap =
474       clib_bitmap_andnoti (p->one_time_event_type_bitmap, t);
475 }
476
477 always_inline void
478 vlib_process_maybe_free_event_type (vlib_process_t * p, uword t)
479 {
480   ASSERT (!pool_is_free_index (p->event_type_pool, t));
481   if (clib_bitmap_get (p->one_time_event_type_bitmap, t))
482     vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
483 }
484
485 always_inline void *
486 vlib_process_get_event_data (vlib_main_t * vm,
487                              uword * return_event_type_opaque)
488 {
489   vlib_node_main_t *nm = &vm->node_main;
490   vlib_process_t *p;
491   vlib_process_event_type_t *et;
492   uword t;
493   void *event_data_vector;
494
495   p = vec_elt (nm->processes, nm->current_process_index);
496
497   /* Find first type with events ready.
498      Return invalid type when there's nothing there. */
499   t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
500   if (t == ~0)
501     return 0;
502
503   p->non_empty_event_type_bitmap =
504     clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
505
506   ASSERT (_vec_len (p->pending_event_data_by_type_index[t]) > 0);
507   event_data_vector = p->pending_event_data_by_type_index[t];
508   p->pending_event_data_by_type_index[t] = 0;
509
510   et = pool_elt_at_index (p->event_type_pool, t);
511
512   /* Return user's opaque value and possibly index. */
513   *return_event_type_opaque = et->opaque;
514
515   vlib_process_maybe_free_event_type (p, t);
516
517   return event_data_vector;
518 }
519
520 /* Return event data vector for later reuse.  We reuse event data to avoid
521    repeatedly allocating event vectors in cases where we care about speed. */
522 always_inline void
523 vlib_process_put_event_data (vlib_main_t * vm, void *event_data)
524 {
525   vlib_node_main_t *nm = &vm->node_main;
526   vec_add1 (nm->recycled_event_data_vectors, event_data);
527 }
528
529 /** Return the first event type which has occurred and a vector of per-event
530     data of that type, or a timeout indication
531
532     @param vm - vlib_main_t pointer
533     @param data_vector - pointer to a (uword *) vector to receive event data
534     @returns either an event type and a vector of per-event instance data,
535     or ~0 to indicate a timeout.
536 */
537
538 always_inline uword
539 vlib_process_get_events (vlib_main_t * vm, uword ** data_vector)
540 {
541   vlib_node_main_t *nm = &vm->node_main;
542   vlib_process_t *p;
543   vlib_process_event_type_t *et;
544   uword r, t, l;
545
546   p = vec_elt (nm->processes, nm->current_process_index);
547
548   /* Find first type with events ready.
549      Return invalid type when there's nothing there. */
550   t = clib_bitmap_first_set (p->non_empty_event_type_bitmap);
551   if (t == ~0)
552     return t;
553
554   p->non_empty_event_type_bitmap =
555     clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
556
557   l = _vec_len (p->pending_event_data_by_type_index[t]);
558   if (data_vector)
559     vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
560   _vec_len (p->pending_event_data_by_type_index[t]) = 0;
561
562   et = pool_elt_at_index (p->event_type_pool, t);
563
564   /* Return user's opaque value. */
565   r = et->opaque;
566
567   vlib_process_maybe_free_event_type (p, t);
568
569   return r;
570 }
571
572 always_inline uword
573 vlib_process_get_events_helper (vlib_process_t * p, uword t,
574                                 uword ** data_vector)
575 {
576   uword l;
577
578   p->non_empty_event_type_bitmap =
579     clib_bitmap_andnoti (p->non_empty_event_type_bitmap, t);
580
581   l = _vec_len (p->pending_event_data_by_type_index[t]);
582   if (data_vector)
583     vec_add (*data_vector, p->pending_event_data_by_type_index[t], l);
584   _vec_len (p->pending_event_data_by_type_index[t]) = 0;
585
586   vlib_process_maybe_free_event_type (p, t);
587
588   return l;
589 }
590
591 /* As above but query as specified type of event.  Returns number of
592    events found. */
593 always_inline uword
594 vlib_process_get_events_with_type (vlib_main_t * vm, uword ** data_vector,
595                                    uword with_type_opaque)
596 {
597   vlib_node_main_t *nm = &vm->node_main;
598   vlib_process_t *p;
599   uword t, *h;
600
601   p = vec_elt (nm->processes, nm->current_process_index);
602   h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
603   if (!h)
604     /* This can happen when an event has not yet been
605        signaled with given opaque type. */
606     return 0;
607
608   t = h[0];
609   if (!clib_bitmap_get (p->non_empty_event_type_bitmap, t))
610     return 0;
611
612   return vlib_process_get_events_helper (p, t, data_vector);
613 }
614
615 always_inline uword *
616 vlib_process_wait_for_event (vlib_main_t * vm)
617 {
618   vlib_node_main_t *nm = &vm->node_main;
619   vlib_process_t *p;
620   uword r;
621
622   p = vec_elt (nm->processes, nm->current_process_index);
623   if (clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
624     {
625       p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
626       r =
627         clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
628       if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
629         clib_longjmp (&p->return_longjmp,
630                       VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
631     }
632
633   return p->non_empty_event_type_bitmap;
634 }
635
636 always_inline uword
637 vlib_process_wait_for_one_time_event (vlib_main_t * vm,
638                                       uword ** data_vector,
639                                       uword with_type_index)
640 {
641   vlib_node_main_t *nm = &vm->node_main;
642   vlib_process_t *p;
643   uword r;
644
645   p = vec_elt (nm->processes, nm->current_process_index);
646   ASSERT (!pool_is_free_index (p->event_type_pool, with_type_index));
647   while (!clib_bitmap_get (p->non_empty_event_type_bitmap, with_type_index))
648     {
649       p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
650       r =
651         clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
652       if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
653         clib_longjmp (&p->return_longjmp,
654                       VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
655     }
656
657   return vlib_process_get_events_helper (p, with_type_index, data_vector);
658 }
659
660 always_inline uword
661 vlib_process_wait_for_event_with_type (vlib_main_t * vm,
662                                        uword ** data_vector,
663                                        uword with_type_opaque)
664 {
665   vlib_node_main_t *nm = &vm->node_main;
666   vlib_process_t *p;
667   uword r, *h;
668
669   p = vec_elt (nm->processes, nm->current_process_index);
670   h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
671   while (!h || !clib_bitmap_get (p->non_empty_event_type_bitmap, h[0]))
672     {
673       p->flags |= VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT;
674       r =
675         clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
676       if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
677         clib_longjmp (&p->return_longjmp,
678                       VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
679
680       /* See if unknown event type has been signaled now. */
681       if (!h)
682         h = hash_get (p->event_type_index_by_type_opaque, with_type_opaque);
683     }
684
685   return vlib_process_get_events_helper (p, h[0], data_vector);
686 }
687
688 /** Suspend a cooperative multi-tasking thread
689     Waits for an event, or for the indicated number of seconds to elapse
690     @param vm - vlib_main_t pointer
691     @param dt - timeout, in seconds.
692     @returns the remaining time interval
693 */
694
695 always_inline f64
696 vlib_process_wait_for_event_or_clock (vlib_main_t * vm, f64 dt)
697 {
698   vlib_node_main_t *nm = &vm->node_main;
699   vlib_process_t *p;
700   f64 wakeup_time;
701   uword r;
702
703   p = vec_elt (nm->processes, nm->current_process_index);
704
705   if (vlib_process_suspend_time_is_zero (dt)
706       || !clib_bitmap_is_zero (p->non_empty_event_type_bitmap))
707     return dt;
708
709   wakeup_time = vlib_time_now (vm) + dt;
710
711   /* Suspend waiting for both clock and event to occur. */
712   p->flags |= (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
713                | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK);
714
715   r = clib_setjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_SUSPEND);
716   if (r == VLIB_PROCESS_RESUME_LONGJMP_SUSPEND)
717     {
718       p->resume_clock_interval = dt * 1e5;
719       clib_longjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_SUSPEND);
720     }
721
722   /* Return amount of time still left to sleep.
723      If <= 0 then we've been waken up by the clock (and not an event). */
724   return wakeup_time - vlib_time_now (vm);
725 }
726
727 always_inline vlib_process_event_type_t *
728 vlib_process_new_event_type (vlib_process_t * p, uword with_type_opaque)
729 {
730   vlib_process_event_type_t *et;
731   pool_get (p->event_type_pool, et);
732   et->opaque = with_type_opaque;
733   return et;
734 }
735
736 always_inline uword
737 vlib_process_create_one_time_event (vlib_main_t * vm, uword node_index,
738                                     uword with_type_opaque)
739 {
740   vlib_node_main_t *nm = &vm->node_main;
741   vlib_node_t *n = vlib_get_node (vm, node_index);
742   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
743   vlib_process_event_type_t *et;
744   uword t;
745
746   et = vlib_process_new_event_type (p, with_type_opaque);
747   t = et - p->event_type_pool;
748   p->one_time_event_type_bitmap =
749     clib_bitmap_ori (p->one_time_event_type_bitmap, t);
750   return t;
751 }
752
753 always_inline void
754 vlib_process_delete_one_time_event (vlib_main_t * vm, uword node_index,
755                                     uword t)
756 {
757   vlib_node_main_t *nm = &vm->node_main;
758   vlib_node_t *n = vlib_get_node (vm, node_index);
759   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
760
761   ASSERT (clib_bitmap_get (p->one_time_event_type_bitmap, t));
762   vlib_process_free_event_type (p, t, /* is_one_time_event */ 1);
763 }
764
765 always_inline void *
766 vlib_process_signal_event_helper (vlib_node_main_t * nm,
767                                   vlib_node_t * n,
768                                   vlib_process_t * p,
769                                   uword t,
770                                   uword n_data_elts, uword n_data_elt_bytes)
771 {
772   uword p_flags, add_to_pending, delete_from_wheel;
773   void *data_to_be_written_by_caller;
774
775   ASSERT (n->type == VLIB_NODE_TYPE_PROCESS);
776
777   ASSERT (!pool_is_free_index (p->event_type_pool, t));
778
779   vec_validate (p->pending_event_data_by_type_index, t);
780
781   /* Resize data vector and return caller's data to be written. */
782   {
783     void *data_vec = p->pending_event_data_by_type_index[t];
784     uword l;
785
786     if (!data_vec && vec_len (nm->recycled_event_data_vectors))
787       {
788         data_vec = vec_pop (nm->recycled_event_data_vectors);
789         _vec_len (data_vec) = 0;
790       }
791
792     l = vec_len (data_vec);
793
794     data_vec = _vec_resize (data_vec,
795                             /* length_increment */ n_data_elts,
796                             /* total size after increment */
797                             (l + n_data_elts) * n_data_elt_bytes,
798                             /* header_bytes */ 0, /* data_align */ 0);
799
800     p->pending_event_data_by_type_index[t] = data_vec;
801     data_to_be_written_by_caller = data_vec + l * n_data_elt_bytes;
802   }
803
804   p->non_empty_event_type_bitmap =
805     clib_bitmap_ori (p->non_empty_event_type_bitmap, t);
806
807   p_flags = p->flags;
808
809   /* Event was already signalled? */
810   add_to_pending = (p_flags & VLIB_PROCESS_RESUME_PENDING) == 0;
811
812   /* Process will resume when suspend time elapses? */
813   delete_from_wheel = 0;
814   if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
815     {
816       /* Waiting for both event and clock? */
817       if (p_flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)
818         {
819           if (!TW (tw_timer_handle_is_free)
820               ((TWT (tw_timer_wheel) *) nm->timing_wheel,
821                p->stop_timer_handle))
822             delete_from_wheel = 1;
823           else
824             /* timer just popped so process should already be on the list */
825             add_to_pending = 0;
826         }
827       else
828         /* Waiting only for clock.  Event will be queue and may be
829            handled when timer expires. */
830         add_to_pending = 0;
831     }
832
833   /* Never add current process to pending vector since current process is
834      already running. */
835   add_to_pending &= nm->current_process_index != n->runtime_index;
836
837   if (add_to_pending)
838     {
839       u32 x = vlib_timing_wheel_data_set_suspended_process (n->runtime_index);
840       p->flags = p_flags | VLIB_PROCESS_RESUME_PENDING;
841       vec_add1 (nm->data_from_advancing_timing_wheel, x);
842       if (delete_from_wheel)
843         TW (tw_timer_stop) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
844                             p->stop_timer_handle);
845     }
846
847   return data_to_be_written_by_caller;
848 }
849
850 always_inline void *
851 vlib_process_signal_event_data (vlib_main_t * vm,
852                                 uword node_index,
853                                 uword type_opaque,
854                                 uword n_data_elts, uword n_data_elt_bytes)
855 {
856   vlib_node_main_t *nm = &vm->node_main;
857   vlib_node_t *n = vlib_get_node (vm, node_index);
858   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
859   uword *h, t;
860
861   /* Must be in main thread */
862   ASSERT (vlib_get_thread_index () == 0);
863
864   h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
865   if (!h)
866     {
867       vlib_process_event_type_t *et =
868         vlib_process_new_event_type (p, type_opaque);
869       t = et - p->event_type_pool;
870       hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
871     }
872   else
873     t = h[0];
874
875   return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
876                                            n_data_elt_bytes);
877 }
878
879 always_inline void *
880 vlib_process_signal_event_at_time (vlib_main_t * vm,
881                                    f64 dt,
882                                    uword node_index,
883                                    uword type_opaque,
884                                    uword n_data_elts, uword n_data_elt_bytes)
885 {
886   vlib_node_main_t *nm = &vm->node_main;
887   vlib_node_t *n = vlib_get_node (vm, node_index);
888   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
889   uword *h, t;
890
891   h = hash_get (p->event_type_index_by_type_opaque, type_opaque);
892   if (!h)
893     {
894       vlib_process_event_type_t *et =
895         vlib_process_new_event_type (p, type_opaque);
896       t = et - p->event_type_pool;
897       hash_set (p->event_type_index_by_type_opaque, type_opaque, t);
898     }
899   else
900     t = h[0];
901
902   if (vlib_process_suspend_time_is_zero (dt))
903     return vlib_process_signal_event_helper (nm, n, p, t, n_data_elts,
904                                              n_data_elt_bytes);
905   else
906     {
907       vlib_signal_timed_event_data_t *te;
908
909       pool_get_aligned (nm->signal_timed_event_data_pool, te, sizeof (te[0]));
910
911       te->n_data_elts = n_data_elts;
912       te->n_data_elt_bytes = n_data_elt_bytes;
913       te->n_data_bytes = n_data_elts * n_data_elt_bytes;
914
915       /* Assert that structure fields are big enough. */
916       ASSERT (te->n_data_elts == n_data_elts);
917       ASSERT (te->n_data_elt_bytes == n_data_elt_bytes);
918       ASSERT (te->n_data_bytes == n_data_elts * n_data_elt_bytes);
919
920       te->process_node_index = n->runtime_index;
921       te->event_type_index = t;
922
923       p->stop_timer_handle =
924         TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
925                              vlib_timing_wheel_data_set_timed_event
926                              (te - nm->signal_timed_event_data_pool),
927                              0 /* timer_id */ ,
928                              (vlib_time_now (vm) + dt) * 1e5);
929
930       /* Inline data big enough to hold event? */
931       if (te->n_data_bytes < sizeof (te->inline_event_data))
932         return te->inline_event_data;
933       else
934         {
935           te->event_data_as_vector = 0;
936           vec_resize (te->event_data_as_vector, te->n_data_bytes);
937           return te->event_data_as_vector;
938         }
939     }
940 }
941
942 always_inline void *
943 vlib_process_signal_one_time_event_data (vlib_main_t * vm,
944                                          uword node_index,
945                                          uword type_index,
946                                          uword n_data_elts,
947                                          uword n_data_elt_bytes)
948 {
949   vlib_node_main_t *nm = &vm->node_main;
950   vlib_node_t *n = vlib_get_node (vm, node_index);
951   vlib_process_t *p = vec_elt (nm->processes, n->runtime_index);
952   return vlib_process_signal_event_helper (nm, n, p, type_index, n_data_elts,
953                                            n_data_elt_bytes);
954 }
955
956 always_inline void
957 vlib_process_signal_event (vlib_main_t * vm,
958                            uword node_index, uword type_opaque, uword data)
959 {
960   uword *d = vlib_process_signal_event_data (vm, node_index, type_opaque,
961                                              1 /* elts */ , sizeof (uword));
962   d[0] = data;
963 }
964
965 always_inline void
966 vlib_process_signal_event_pointer (vlib_main_t * vm,
967                                    uword node_index,
968                                    uword type_opaque, void *data)
969 {
970   void **d = vlib_process_signal_event_data (vm, node_index, type_opaque,
971                                              1 /* elts */ , sizeof (data));
972   d[0] = data;
973 }
974
975 /**
976  * Signal event to process from any thread.
977  *
978  * When in doubt, use this.
979  */
980 always_inline void
981 vlib_process_signal_event_mt (vlib_main_t * vm,
982                               uword node_index, uword type_opaque, uword data)
983 {
984   if (vlib_get_thread_index () != 0)
985     {
986       vlib_process_signal_event_mt_args_t args = {
987         .node_index = node_index,
988         .type_opaque = type_opaque,
989         .data = data,
990       };
991       vlib_rpc_call_main_thread (vlib_process_signal_event_mt_helper,
992                                  (u8 *) & args, sizeof (args));
993     }
994   else
995     vlib_process_signal_event (vm, node_index, type_opaque, data);
996 }
997
998 always_inline void
999 vlib_process_signal_one_time_event (vlib_main_t * vm,
1000                                     uword node_index,
1001                                     uword type_index, uword data)
1002 {
1003   uword *d =
1004     vlib_process_signal_one_time_event_data (vm, node_index, type_index,
1005                                              1 /* elts */ , sizeof (uword));
1006   d[0] = data;
1007 }
1008
1009 always_inline void
1010 vlib_signal_one_time_waiting_process (vlib_main_t * vm,
1011                                       vlib_one_time_waiting_process_t * p)
1012 {
1013   vlib_process_signal_one_time_event (vm, p->node_index, p->one_time_event,
1014                                       /* data */ ~0);
1015   clib_memset (p, ~0, sizeof (p[0]));
1016 }
1017
1018 always_inline void
1019 vlib_signal_one_time_waiting_process_vector (vlib_main_t * vm,
1020                                              vlib_one_time_waiting_process_t
1021                                              ** wps)
1022 {
1023   vlib_one_time_waiting_process_t *wp;
1024   vec_foreach (wp, *wps) vlib_signal_one_time_waiting_process (vm, wp);
1025   vec_free (*wps);
1026 }
1027
1028 always_inline void
1029 vlib_current_process_wait_for_one_time_event (vlib_main_t * vm,
1030                                               vlib_one_time_waiting_process_t
1031                                               * p)
1032 {
1033   p->node_index = vlib_current_process (vm);
1034   p->one_time_event = vlib_process_create_one_time_event (vm, p->node_index,    /* type opaque */
1035                                                           ~0);
1036   vlib_process_wait_for_one_time_event (vm,
1037                                         /* don't care about data */ 0,
1038                                         p->one_time_event);
1039 }
1040
1041 always_inline void
1042 vlib_current_process_wait_for_one_time_event_vector (vlib_main_t * vm,
1043                                                      vlib_one_time_waiting_process_t
1044                                                      ** wps)
1045 {
1046   vlib_one_time_waiting_process_t *wp;
1047   vec_add2 (*wps, wp, 1);
1048   vlib_current_process_wait_for_one_time_event (vm, wp);
1049 }
1050
1051 always_inline u32
1052 vlib_node_runtime_update_main_loop_vector_stats (vlib_main_t * vm,
1053                                                  vlib_node_runtime_t * node,
1054                                                  uword n_vectors)
1055 {
1056   u32 i, d, vi0, vi1;
1057   u32 i0, i1;
1058
1059   ASSERT (is_pow2 (ARRAY_LEN (node->main_loop_vector_stats)));
1060   i = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1061        & (ARRAY_LEN (node->main_loop_vector_stats) - 1));
1062   i0 = i ^ 0;
1063   i1 = i ^ 1;
1064   d = ((vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)
1065        -
1066        (node->main_loop_count_last_dispatch >>
1067         VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE));
1068   vi0 = node->main_loop_vector_stats[i0];
1069   vi1 = node->main_loop_vector_stats[i1];
1070   vi0 = d == 0 ? vi0 : 0;
1071   vi1 = d <= 1 ? vi1 : 0;
1072   vi0 += n_vectors;
1073   node->main_loop_vector_stats[i0] = vi0;
1074   node->main_loop_vector_stats[i1] = vi1;
1075   node->main_loop_count_last_dispatch = vm->main_loop_count;
1076   /* Return previous counter. */
1077   return node->main_loop_vector_stats[i1];
1078 }
1079
1080 always_inline f64
1081 vlib_node_vectors_per_main_loop_as_float (vlib_main_t * vm, u32 node_index)
1082 {
1083   vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1084   u32 v;
1085
1086   v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt,  /* n_vectors */
1087                                                        0);
1088   return (f64) v / (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
1089 }
1090
1091 always_inline u32
1092 vlib_node_vectors_per_main_loop_as_integer (vlib_main_t * vm, u32 node_index)
1093 {
1094   vlib_node_runtime_t *rt = vlib_node_get_runtime (vm, node_index);
1095   u32 v;
1096
1097   v = vlib_node_runtime_update_main_loop_vector_stats (vm, rt,  /* n_vectors */
1098                                                        0);
1099   return v >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
1100 }
1101
1102 void
1103 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f);
1104
1105 /* Return the edge index if present, ~0 otherwise */
1106 uword vlib_node_get_next (vlib_main_t * vm, uword node, uword next_node);
1107
1108 /* Add next node to given node in given slot. */
1109 uword
1110 vlib_node_add_next_with_slot (vlib_main_t * vm,
1111                               uword node, uword next_node, uword slot);
1112
1113 /* As above but adds to end of node's next vector. */
1114 always_inline uword
1115 vlib_node_add_next (vlib_main_t * vm, uword node, uword next_node)
1116 {
1117   return vlib_node_add_next_with_slot (vm, node, next_node, ~0);
1118 }
1119
1120 /* Add next node to given node in given slot. */
1121 uword
1122 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
1123                                     uword node, char *next_name, uword slot);
1124
1125 /* As above but adds to end of node's next vector. */
1126 always_inline uword
1127 vlib_node_add_named_next (vlib_main_t * vm, uword node, char *name)
1128 {
1129   return vlib_node_add_named_next_with_slot (vm, node, name, ~0);
1130 }
1131
1132 /**
1133  * Get list of nodes
1134  */
1135 void
1136 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
1137                      int barrier_sync, vlib_node_t **** node_dupsp,
1138                      vlib_main_t *** stat_vmsp);
1139
1140 /* Query node given name. */
1141 vlib_node_t *vlib_get_node_by_name (vlib_main_t * vm, u8 * name);
1142
1143 /* Rename a node. */
1144 void vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...);
1145
1146 /* Register new packet processing node.  Nodes can be registered
1147    dynamically via this call or statically via the VLIB_REGISTER_NODE
1148    macro. */
1149 u32 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r);
1150
1151 /* Register all static nodes registered via VLIB_REGISTER_NODE. */
1152 void vlib_register_all_static_nodes (vlib_main_t * vm);
1153
1154 /* Start a process. */
1155 void vlib_start_process (vlib_main_t * vm, uword process_index);
1156
1157 /* Sync up runtime and main node stats. */
1158 void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
1159
1160 /* Node graph initialization function. */
1161 clib_error_t *vlib_node_main_init (vlib_main_t * vm);
1162
1163 format_function_t format_vlib_node_graph;
1164 format_function_t format_vlib_node_name;
1165 format_function_t format_vlib_next_node_name;
1166 format_function_t format_vlib_node_and_next;
1167 format_function_t format_vlib_cpu_time;
1168 format_function_t format_vlib_time;
1169 /* Parse node name -> node index. */
1170 unformat_function_t unformat_vlib_node;
1171
1172 always_inline void
1173 vlib_node_increment_counter (vlib_main_t * vm, u32 node_index,
1174                              u32 counter_index, u64 increment)
1175 {
1176   vlib_node_t *n = vlib_get_node (vm, node_index);
1177   vlib_error_main_t *em = &vm->error_main;
1178   u32 node_counter_base_index = n->error_heap_index;
1179   em->counters[node_counter_base_index + counter_index] += increment;
1180 }
1181
1182 #endif /* included_vlib_node_funcs_h */
1183
1184 /*
1185  * fd.io coding-style-patch-verification: ON
1186  *
1187  * Local Variables:
1188  * eval: (c-set-style "gnu")
1189  * End:
1190  */