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