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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * node.c: VLIB processing nodes
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #include <vlib/vlib.h>
41 #include <vlib/threads.h>
43 /* Query node given name. */
45 vlib_get_node_by_name (vlib_main_t * vm, u8 * name)
47 vlib_node_main_t *nm = &vm->node_main;
50 if (!clib_mem_is_heap_object (vec_header (key, 0)))
51 key = format (0, "%s", key);
52 p = hash_get (nm->node_by_name, key);
55 return p ? vec_elt (nm->nodes, p[0]) : 0;
59 node_set_elog_name (vlib_main_t * vm, uword node_index)
61 vlib_node_t *n = vlib_get_node (vm, node_index);
64 t = vec_elt_at_index (vm->node_call_elog_event_types, node_index);
66 t->format = (char *) format (0, "%v-call: %%d%c", n->name, 0);
68 t = vec_elt_at_index (vm->node_return_elog_event_types, node_index);
70 t->format = (char *) format (0, "%v-return: %%d%c", n->name, 0);
72 n->name_elog_string = elog_string (&vm->elog_main, "%v%c", n->name, 0);
76 vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...)
79 vlib_node_main_t *nm = &vm->node_main;
80 vlib_node_t *n = vlib_get_node (vm, node_index);
83 hash_unset (nm->node_by_name, n->name);
85 n->name = va_format (0, fmt, &va);
87 hash_set (nm->node_by_name, n->name, n->index);
89 node_set_elog_name (vm, node_index);
91 /* Propagate the change to all worker threads */
92 vlib_worker_thread_node_runtime_update ();
96 vlib_node_runtime_update (vlib_main_t * vm, u32 node_index, u32 next_index)
98 vlib_node_main_t *nm = &vm->node_main;
99 vlib_node_runtime_t *r, *s;
100 vlib_node_t *node, *next_node;
101 vlib_next_frame_t *nf;
102 vlib_pending_frame_t *pf;
105 node = vec_elt (nm->nodes, node_index);
106 r = vlib_node_get_runtime (vm, node_index);
108 n_insert = vec_len (node->next_nodes) - r->n_next_nodes;
111 i = r->next_frame_index + r->n_next_nodes;
112 vec_insert (nm->next_frames, n_insert, i);
114 /* Initialize newly inserted next frames. */
115 for (j = 0; j < n_insert; j++)
116 vlib_next_frame_init (nm->next_frames + i + j);
118 /* Relocate other next frames at higher indices. */
119 for (j = 0; j < vec_len (nm->nodes); j++)
121 s = vlib_node_get_runtime (vm, j);
122 if (j != node_index && s->next_frame_index >= i)
123 s->next_frame_index += n_insert;
126 /* Pending frames may need to be relocated also. */
127 vec_foreach (pf, nm->pending_frames)
129 if (pf->next_frame_index != VLIB_PENDING_FRAME_NO_NEXT_FRAME
130 && pf->next_frame_index >= i)
131 pf->next_frame_index += n_insert;
134 pool_foreach (pf, nm->suspended_process_frames, ({
135 if (pf->next_frame_index != ~0 && pf->next_frame_index >= i)
136 pf->next_frame_index += n_insert;
140 r->n_next_nodes = vec_len (node->next_nodes);
143 /* Set frame's node runtime index. */
144 next_node = vlib_get_node (vm, node->next_nodes[next_index]);
145 nf = nm->next_frames + r->next_frame_index + next_index;
146 nf->node_runtime_index = next_node->runtime_index;
148 vlib_worker_thread_node_runtime_update ();
152 vlib_node_get_next (vlib_main_t * vm, uword node_index, uword next_node_index)
154 vlib_node_main_t *nm = &vm->node_main;
158 node = vec_elt (nm->nodes, node_index);
160 /* Runtime has to be initialized. */
161 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
163 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
171 /* Add next node to given node in given slot. */
173 vlib_node_add_next_with_slot (vlib_main_t * vm,
175 uword next_node_index, uword slot)
177 vlib_node_main_t *nm = &vm->node_main;
178 vlib_node_t *node, *next, *old_next;
182 ASSERT (vlib_get_thread_index () == 0);
184 node = vec_elt (nm->nodes, node_index);
185 next = vec_elt (nm->nodes, next_node_index);
187 /* Runtime has to be initialized. */
188 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
190 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
192 /* Next already exists: slot must match. */
194 ASSERT (slot == p[0]);
198 vlib_worker_thread_barrier_sync (vm);
201 slot = vec_len (node->next_nodes);
203 vec_validate_init_empty (node->next_nodes, slot, ~0);
204 vec_validate (node->n_vectors_by_next_node, slot);
206 if ((old_next_index = node->next_nodes[slot]) != ~0u)
208 hash_unset (node->next_slot_by_node, old_next_index);
209 old_next = vlib_get_node (vm, old_next_index);
210 old_next->prev_node_bitmap =
211 clib_bitmap_andnoti (old_next->prev_node_bitmap, node_index);
214 node->next_nodes[slot] = next_node_index;
215 hash_set (node->next_slot_by_node, next_node_index, slot);
217 vlib_node_runtime_update (vm, node_index, slot);
219 next->prev_node_bitmap = clib_bitmap_ori (next->prev_node_bitmap,
222 /* Siblings all get same node structure. */
224 uword sib_node_index, sib_slot;
225 vlib_node_t *sib_node;
227 clib_bitmap_foreach (sib_node_index, node->sibling_bitmap, ({
228 sib_node = vec_elt (nm->nodes, sib_node_index);
229 if (sib_node != node)
231 sib_slot = vlib_node_add_next_with_slot (vm, sib_node_index, next_node_index, slot);
232 ASSERT (sib_slot == slot);
238 vlib_worker_thread_barrier_release (vm);
242 /* Add named next node to given node in given slot. */
244 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
245 uword node, char *name, uword slot)
247 vlib_node_main_t *nm;
248 vlib_node_t *n, *n_next;
251 n = vlib_get_node (vm, node);
253 n_next = vlib_get_node_by_name (vm, (u8 *) name);
256 if (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED)
260 slot = clib_max (vec_len (n->next_node_names),
261 vec_len (n->next_nodes));
262 vec_validate (n->next_node_names, slot);
263 n->next_node_names[slot] = name;
267 return vlib_node_add_next_with_slot (vm, node, n_next->index, slot);
271 node_elog_init (vlib_main_t * vm, uword ni)
275 clib_memset (&t, 0, sizeof (t));
277 /* 2 event types for this node: one when node function is called.
278 One when it returns. */
279 vec_validate (vm->node_call_elog_event_types, ni);
280 vm->node_call_elog_event_types[ni] = t;
282 vec_validate (vm->node_return_elog_event_types, ni);
283 vm->node_return_elog_event_types[ni] = t;
285 node_set_elog_name (vm, ni);
289 #define STACK_ALIGN (clib_mem_get_page_size())
291 #define STACK_ALIGN CLIB_CACHE_LINE_BYTES
295 register_node (vlib_main_t * vm, vlib_node_registration_t * r)
297 vlib_node_main_t *nm = &vm->node_main;
299 u32 page_size = clib_mem_get_page_size ();
304 /* Default (0) type should match INTERNAL. */
305 vlib_node_t zero = { 0 };
306 ASSERT (VLIB_NODE_TYPE_INTERNAL == zero.type);
309 if (r->node_fn_registrations)
311 vlib_node_fn_registration_t *fnr = r->node_fn_registrations;
314 /* to avoid confusion, please remove ".function " statiement from
315 CLIB_NODE_REGISTRATION() if using function function candidates */
316 ASSERT (r->function == 0);
320 if (fnr->priority > priority)
322 priority = fnr->priority;
323 r->function = fnr->function;
325 fnr = fnr->next_registration;
329 ASSERT (r->function != 0);
331 n = clib_mem_alloc_no_fail (sizeof (n[0]));
332 clib_memset (n, 0, sizeof (n[0]));
333 n->index = vec_len (nm->nodes);
334 n->node_fn_registrations = r->node_fn_registrations;
335 n->protocol_hint = r->protocol_hint;
337 vec_add1 (nm->nodes, n);
339 /* Name is always a vector so it can be formatted with %v. */
340 if (clib_mem_is_heap_object (vec_header (r->name, 0)))
341 n->name = vec_dup ((u8 *) r->name);
343 n->name = format (0, "%s", r->name);
345 if (!nm->node_by_name)
346 nm->node_by_name = hash_create_vec ( /* size */ 32,
347 sizeof (n->name[0]), sizeof (uword));
349 /* Node names must be unique. */
351 vlib_node_t *o = vlib_get_node_by_name (vm, n->name);
353 clib_error ("more than one node named `%v'", n->name);
356 hash_set (nm->node_by_name, n->name, n->index);
358 r->index = n->index; /* save index in registration */
359 n->function = r->function;
361 /* Node index of next sibling will be filled in by vlib_node_main_init. */
362 n->sibling_of = r->sibling_of;
363 if (r->sibling_of && r->n_next_nodes > 0)
364 clib_error ("sibling node should not have any next nodes `%v'", n->name);
366 if (r->type == VLIB_NODE_TYPE_INTERNAL)
367 ASSERT (r->vector_size > 0);
369 #define _(f) n->f = r->f
381 /* Register error counters. */
382 vlib_register_errors (vm, n->index, r->n_errors, r->error_strings);
383 node_elog_init (vm, n->index);
385 _(runtime_data_bytes);
386 if (r->runtime_data_bytes > 0)
388 vec_resize (n->runtime_data, r->runtime_data_bytes);
390 clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
393 vec_resize (n->next_node_names, r->n_next_nodes);
394 for (i = 0; i < r->n_next_nodes; i++)
395 n->next_node_names[i] = r->next_nodes[i];
397 vec_validate_init_empty (n->next_nodes, r->n_next_nodes - 1, ~0);
398 vec_validate (n->n_vectors_by_next_node, r->n_next_nodes - 1);
400 n->owner_node_index = n->owner_next_index = ~0;
402 /* Initialize node runtime. */
404 vlib_node_runtime_t *rt;
407 if (n->type == VLIB_NODE_TYPE_PROCESS)
411 uword log2_n_stack_bytes, stack_bytes;
412 int mmap_flags = MAP_PRIVATE | MAP_ANONYMOUS;
414 log2_n_stack_bytes = clib_max (r->process_log2_n_stack_bytes,
415 VLIB_PROCESS_LOG2_STACK_SIZE);
416 log2_n_stack_bytes = clib_max (log2_n_stack_bytes,
417 min_log2 (page_size));
419 p = clib_mem_alloc_aligned (sizeof (p[0]), CLIB_CACHE_LINE_BYTES);
420 clib_memset (p, 0, sizeof (p[0]));
421 p->log2_n_stack_bytes = log2_n_stack_bytes;
423 stack_bytes = 1ULL << log2_n_stack_bytes;
424 /* map stack size + 2 extra guard pages */
425 map = mmap (0, stack_bytes + page_size, PROT_READ | PROT_WRITE,
428 if (map == MAP_FAILED)
429 clib_panic ("failed to allocate process stack (%d bytes)",
432 /* skip the guard page */
433 p->stack = map + page_size;
435 mmap_flags |= MAP_FIXED;
436 map = mmap (map, page_size, PROT_NONE, mmap_flags, -1, 0);
438 if (map == MAP_FAILED)
439 clib_unix_warning ("failed to create stack guard page");
441 /* Process node's runtime index is really index into process
443 n->runtime_index = vec_len (nm->processes);
445 vec_add1 (nm->processes, p);
447 /* Paint first stack word with magic number so we can at least
448 detect process stack overruns. */
449 p->stack[0] = VLIB_PROCESS_STACK_MAGIC;
451 /* Node runtime is stored inside of process. */
452 rt = &p->node_runtime;
456 vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
457 /* align */ CLIB_CACHE_LINE_BYTES);
458 n->runtime_index = rt - nm->nodes_by_type[n->type];
461 if (n->type == VLIB_NODE_TYPE_INPUT)
462 nm->input_node_counts_by_state[n->state] += 1;
464 rt->function = n->function;
465 rt->flags = n->flags;
466 rt->state = n->state;
467 rt->node_index = n->index;
469 rt->n_next_nodes = r->n_next_nodes;
470 rt->next_frame_index = vec_len (nm->next_frames);
472 vec_resize (nm->next_frames, rt->n_next_nodes);
473 for (i = 0; i < rt->n_next_nodes; i++)
474 vlib_next_frame_init (nm->next_frames + rt->next_frame_index + i);
476 vec_resize (rt->errors, r->n_errors);
477 for (i = 0; i < vec_len (rt->errors); i++)
478 rt->errors[i] = n->error_heap_index + i;
480 STATIC_ASSERT_SIZEOF (vlib_node_runtime_t, 128);
481 ASSERT (vec_len (n->runtime_data) <= VLIB_NODE_RUNTIME_DATA_SIZE);
483 if (vec_len (n->runtime_data) > 0)
484 clib_memcpy (rt->runtime_data, n->runtime_data,
485 vec_len (n->runtime_data));
487 vec_free (n->runtime_data);
491 /* Register new packet processing node. */
493 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r)
495 register_node (vm, r);
500 null_node_fn (vlib_main_t * vm,
501 vlib_node_runtime_t * node, vlib_frame_t * frame)
503 u16 n_vectors = frame->n_vectors;
505 vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
506 vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_vectors);
507 vlib_frame_free (vm, node, frame);
513 vlib_register_all_static_nodes (vlib_main_t * vm)
515 vlib_node_registration_t *r;
517 static char *null_node_error_strings[] = {
518 "blackholed packets",
521 static vlib_node_registration_t null_node_reg = {
522 .function = null_node_fn,
523 .vector_size = sizeof (u32),
526 .error_strings = null_node_error_strings,
529 /* make sure that node index 0 is not used by
531 register_node (vm, &null_node_reg);
533 r = vm->node_main.node_registrations;
536 register_node (vm, r);
537 r = r->next_registration;
542 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
543 int barrier_sync, vlib_node_t **** node_dupsp,
544 vlib_main_t *** stat_vmsp)
546 vlib_node_main_t *nm = &vm->node_main;
548 vlib_node_t ***node_dups = *node_dupsp;
550 vlib_main_t **stat_vms = *stat_vmsp;
551 vlib_main_t *stat_vm;
553 u32 threads_to_serialize;
555 if (vec_len (stat_vms) == 0)
557 for (i = 0; i < vec_len (vlib_mains); i++)
559 stat_vm = vlib_mains[i];
561 vec_add1 (stat_vms, stat_vm);
565 threads_to_serialize = clib_min (max_threads, vec_len (stat_vms));
567 vec_validate (node_dups, threads_to_serialize - 1);
570 * Barrier sync across stats scraping.
571 * Otherwise, the counts will be grossly inaccurate.
574 vlib_worker_thread_barrier_sync (vm);
576 for (j = 0; j < threads_to_serialize; j++)
578 stat_vm = stat_vms[j];
579 nm = &stat_vm->node_main;
583 for (i = 0; i < vec_len (nm->nodes); i++)
586 vlib_node_sync_stats (stat_vm, n);
590 nodes = node_dups[j];
591 vec_validate (nodes, vec_len (nm->nodes) - 1);
592 clib_memcpy (nodes, nm->nodes, vec_len (nm->nodes) * sizeof (nodes[0]));
593 node_dups[j] = nodes;
597 vlib_worker_thread_barrier_release (vm);
599 *node_dupsp = node_dups;
600 *stat_vmsp = stat_vms;
604 vlib_node_main_init (vlib_main_t * vm)
606 vlib_node_main_t *nm = &vm->node_main;
607 clib_error_t *error = 0;
611 nm->frame_sizes = vec_new (vlib_frame_size_t, 1);
612 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
613 nm->frame_size_hash = hash_create (0, sizeof (uword));
615 nm->flags |= VLIB_NODE_MAIN_RUNTIME_STARTED;
617 /* Generate sibling relationships */
619 vlib_node_t *n, *sib;
622 for (ni = 0; ni < vec_len (nm->nodes); ni++)
624 n = vec_elt (nm->nodes, ni);
629 sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
632 error = clib_error_create ("sibling `%s' not found for node `%v'",
633 n->sibling_of, n->name);
638 clib_bitmap_foreach (si, sib->sibling_bitmap, ({
639 vlib_node_t * m = vec_elt (nm->nodes, si);
641 /* Connect all of sibling's siblings to us. */
642 m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
644 /* Connect us to all of sibling's siblings. */
645 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
649 /* Connect sibling to us. */
650 sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
652 /* Connect us to sibling. */
653 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
657 /* Resolve next names into next indices. */
658 for (ni = 0; ni < vec_len (nm->nodes); ni++)
662 n = vec_elt (nm->nodes, ni);
664 for (i = 0; i < vec_len (n->next_node_names); i++)
666 char *a = n->next_node_names[i];
671 if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
673 error = clib_error_create
674 ("node `%v' refers to unknown node `%s'", n->name, a);
679 vec_free (n->next_node_names);
682 /* Set previous node pointers. */
683 for (ni = 0; ni < vec_len (nm->nodes); ni++)
688 n = vec_elt (nm->nodes, ni);
690 for (i = 0; i < vec_len (n->next_nodes); i++)
692 if (n->next_nodes[i] >= vec_len (nm->nodes))
695 n_next = vec_elt (nm->nodes, n->next_nodes[i]);
696 n_next->prev_node_bitmap =
697 clib_bitmap_ori (n_next->prev_node_bitmap, n->index);
702 vlib_next_frame_t *nf;
703 vlib_node_runtime_t *r;
707 vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
709 if (r->n_next_nodes == 0)
712 n = vlib_get_node (vm, r->node_index);
713 nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
715 for (i = 0; i < vec_len (n->next_nodes); i++)
717 next = vlib_get_node (vm, n->next_nodes[i]);
719 /* Validate node runtime indices are correctly initialized. */
720 ASSERT (nf[i].node_runtime_index == next->runtime_index);
723 if (next->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH)
724 nf[i].flags |= VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
734 vlib_process_create (vlib_main_t * vm, char *name,
735 vlib_node_function_t * f, u32 log2_n_stack_bytes)
737 vlib_node_registration_t r;
740 memset (&r, 0, sizeof (r));
742 r.name = (char *) format (0, "%s", name, 0);
744 r.process_log2_n_stack_bytes = log2_n_stack_bytes;
745 r.type = VLIB_NODE_TYPE_PROCESS;
747 vlib_worker_thread_barrier_sync (vm);
749 vlib_register_node (vm, &r);
752 vlib_worker_thread_node_runtime_update ();
753 vlib_worker_thread_barrier_release (vm);
755 n = vlib_get_node (vm, r.index);
756 vlib_start_process (vm, n->runtime_index);
762 * fd.io coding-style-patch-verification: ON
765 * eval: (c-set-style "gnu")