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