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