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 key = format (0, "%s", key);
51 p = hash_get (nm->node_by_name, key);
54 return p ? vec_elt (nm->nodes, p[0]) : 0;
58 node_set_elog_name (vlib_main_t * vm, uword node_index)
60 vlib_node_t *n = vlib_get_node (vm, node_index);
63 t = vec_elt_at_index (vm->node_call_elog_event_types, node_index);
65 t->format = (char *) format (0, "%v-call: %%d%c", n->name, 0);
67 t = vec_elt_at_index (vm->node_return_elog_event_types, node_index);
69 t->format = (char *) format (0, "%v-return: %%d%c", n->name, 0);
71 n->name_elog_string = elog_string (&vm->elog_main, "%v%c", n->name, 0);
75 vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...)
78 vlib_node_main_t *nm = &vm->node_main;
79 vlib_node_t *n = vlib_get_node (vm, node_index);
82 hash_unset (nm->node_by_name, n->name);
84 n->name = va_format (0, fmt, &va);
86 hash_set (nm->node_by_name, n->name, n->index);
88 node_set_elog_name (vm, node_index);
90 /* Propagate the change to all worker threads */
91 vlib_worker_thread_node_runtime_update ();
95 vlib_node_runtime_update (vlib_main_t * vm, u32 node_index, u32 next_index)
97 vlib_node_main_t *nm = &vm->node_main;
98 vlib_node_runtime_t *r, *s;
99 vlib_node_t *node, *next_node;
100 vlib_next_frame_t *nf;
101 vlib_pending_frame_t *pf;
104 node = vec_elt (nm->nodes, node_index);
105 r = vlib_node_get_runtime (vm, node_index);
107 n_insert = vec_len (node->next_nodes) - r->n_next_nodes;
110 i = r->next_frame_index + r->n_next_nodes;
111 vec_insert (nm->next_frames, n_insert, i);
113 /* Initialize newly inserted next frames. */
114 for (j = 0; j < n_insert; j++)
115 vlib_next_frame_init (nm->next_frames + i + j);
117 /* Relocate other next frames at higher indices. */
118 for (j = 0; j < vec_len (nm->nodes); j++)
120 s = vlib_node_get_runtime (vm, j);
121 if (j != node_index && s->next_frame_index >= i)
122 s->next_frame_index += n_insert;
125 /* Pending frames may need to be relocated also. */
126 vec_foreach (pf, nm->pending_frames)
128 if (pf->next_frame_index != VLIB_PENDING_FRAME_NO_NEXT_FRAME
129 && pf->next_frame_index >= i)
130 pf->next_frame_index += n_insert;
133 pool_foreach (pf, nm->suspended_process_frames) {
134 if (pf->next_frame_index != ~0 && pf->next_frame_index >= i)
135 pf->next_frame_index += n_insert;
139 r->n_next_nodes = vec_len (node->next_nodes);
142 /* Set frame's node runtime index. */
143 next_node = vlib_get_node (vm, node->next_nodes[next_index]);
144 nf = nm->next_frames + r->next_frame_index + next_index;
145 nf->node_runtime_index = next_node->runtime_index;
147 vlib_worker_thread_node_runtime_update ();
151 vlib_node_get_next (vlib_main_t * vm, uword node_index, uword next_node_index)
153 vlib_node_main_t *nm = &vm->node_main;
157 node = vec_elt (nm->nodes, node_index);
159 /* Runtime has to be initialized. */
160 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
162 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
170 /* Add next node to given node in given slot. */
172 vlib_node_add_next_with_slot (vlib_main_t * vm,
174 uword next_node_index, uword slot)
176 vlib_node_main_t *nm = &vm->node_main;
177 vlib_node_t *node, *next, *old_next;
181 ASSERT (vlib_get_thread_index () == 0);
183 node = vec_elt (nm->nodes, node_index);
184 next = vec_elt (nm->nodes, next_node_index);
186 /* Runtime has to be initialized. */
187 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
189 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
191 /* Next already exists: slot must match. */
193 ASSERT (slot == p[0]);
197 vlib_worker_thread_barrier_sync (vm);
200 slot = vec_len (node->next_nodes);
202 vec_validate_init_empty (node->next_nodes, slot, ~0);
203 vec_validate (node->n_vectors_by_next_node, slot);
205 if ((old_next_index = node->next_nodes[slot]) != ~0u)
207 hash_unset (node->next_slot_by_node, old_next_index);
208 old_next = vlib_get_node (vm, old_next_index);
209 old_next->prev_node_bitmap =
210 clib_bitmap_andnoti (old_next->prev_node_bitmap, node_index);
213 node->next_nodes[slot] = next_node_index;
214 hash_set (node->next_slot_by_node, next_node_index, slot);
216 vlib_node_runtime_update (vm, node_index, slot);
218 next->prev_node_bitmap = clib_bitmap_ori (next->prev_node_bitmap,
221 /* Siblings all get same node structure. */
223 uword sib_node_index, sib_slot;
224 vlib_node_t *sib_node;
226 clib_bitmap_foreach (sib_node_index, node->sibling_bitmap) {
227 sib_node = vec_elt (nm->nodes, sib_node_index);
228 if (sib_node != node)
230 sib_slot = vlib_node_add_next_with_slot (vm, sib_node_index, next_node_index, slot);
231 ASSERT (sib_slot == slot);
237 vlib_worker_thread_barrier_release (vm);
241 /* Add named next node to given node in given slot. */
243 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
244 uword node, char *name, uword slot)
246 vlib_node_main_t *nm;
247 vlib_node_t *n, *n_next;
250 n = vlib_get_node (vm, node);
252 n_next = vlib_get_node_by_name (vm, (u8 *) name);
255 if (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED)
259 slot = clib_max (vec_len (n->next_node_names),
260 vec_len (n->next_nodes));
261 vec_validate (n->next_node_names, slot);
262 n->next_node_names[slot] = name;
266 return vlib_node_add_next_with_slot (vm, node, n_next->index, slot);
270 node_elog_init (vlib_main_t * vm, uword ni)
274 clib_memset (&t, 0, sizeof (t));
276 /* 2 event types for this node: one when node function is called.
277 One when it returns. */
278 vec_validate (vm->node_call_elog_event_types, ni);
279 vm->node_call_elog_event_types[ni] = t;
281 vec_validate (vm->node_return_elog_event_types, ni);
282 vm->node_return_elog_event_types[ni] = t;
284 node_set_elog_name (vm, ni);
288 #define STACK_ALIGN (clib_mem_get_page_size())
290 #define STACK_ALIGN CLIB_CACHE_LINE_BYTES
293 vlib_node_function_t *
294 vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
295 vlib_node_fn_registration_t *regs)
297 vlib_node_main_t *nm = &vm->node_main;
298 vlib_node_fn_registration_t *r;
299 vlib_node_fn_variant_t *v;
300 vlib_node_function_t *fn = 0;
303 if (nm->node_fn_default_march_variant != ~0)
308 if (r->march_variant == nm->node_fn_default_march_variant)
310 r = r->next_registration;
317 v = vec_elt_at_index (nm->variants, r->march_variant);
318 if (v->priority > priority)
320 priority = v->priority;
323 r = r->next_registration;
331 register_node (vlib_main_t * vm, vlib_node_registration_t * r)
333 vlib_node_main_t *nm = &vm->node_main;
339 /* Default (0) type should match INTERNAL. */
340 vlib_node_t zero = { 0 };
341 ASSERT (VLIB_NODE_TYPE_INTERNAL == zero.type);
344 if (r->node_fn_registrations)
346 /* to avoid confusion, please remove ".function " statiement from
347 CLIB_NODE_REGISTRATION() if using function function candidates */
348 ASSERT (r->function == 0);
351 vlib_node_get_preferred_node_fn_variant (vm, r->node_fn_registrations);
354 ASSERT (r->function != 0);
356 n = clib_mem_alloc_no_fail (sizeof (n[0]));
357 clib_memset (n, 0, sizeof (n[0]));
358 n->index = vec_len (nm->nodes);
359 n->node_fn_registrations = r->node_fn_registrations;
360 n->protocol_hint = r->protocol_hint;
362 vec_add1 (nm->nodes, n);
364 /* Name is always a vector so it can be formatted with %v. */
365 if (clib_mem_is_heap_object (vec_header (r->name, 0)))
366 n->name = vec_dup ((u8 *) r->name);
368 n->name = format (0, "%s", r->name);
370 if (!nm->node_by_name)
371 nm->node_by_name = hash_create_vec ( /* size */ 32,
372 sizeof (n->name[0]), sizeof (uword));
374 /* Node names must be unique. */
376 /* vlib_get_node_by_name() expects NULL-terminated strings */
377 u8 *name = format (0, "%v%c", n->name, 0);
378 vlib_node_t *o = vlib_get_node_by_name (vm, name);
381 clib_error ("more than one node named `%v'", n->name);
384 hash_set (nm->node_by_name, n->name, n->index);
386 r->index = n->index; /* save index in registration */
387 n->function = r->function;
389 /* Node index of next sibling will be filled in by vlib_node_main_init. */
390 n->sibling_of = r->sibling_of;
391 if (r->sibling_of && r->n_next_nodes > 0)
392 clib_error ("sibling node should not have any next nodes `%v'", n->name);
394 if (r->type == VLIB_NODE_TYPE_INTERNAL)
395 ASSERT (r->vector_size > 0);
397 #define _(f) n->f = r->f
409 /* Register error counters. */
410 vlib_register_errors (vm, n->index, r->n_errors, r->error_strings,
412 node_elog_init (vm, n->index);
414 _(runtime_data_bytes);
415 if (r->runtime_data_bytes > 0)
417 vec_resize (n->runtime_data, r->runtime_data_bytes);
419 clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
422 vec_resize (n->next_node_names, r->n_next_nodes);
423 for (i = 0; i < r->n_next_nodes; i++)
424 n->next_node_names[i] = r->next_nodes[i];
426 vec_validate_init_empty (n->next_nodes, r->n_next_nodes - 1, ~0);
427 vec_validate (n->n_vectors_by_next_node, r->n_next_nodes - 1);
429 n->owner_node_index = n->owner_next_index = ~0;
431 /* Initialize node runtime. */
433 vlib_node_runtime_t *rt;
436 if (n->type == VLIB_NODE_TYPE_PROCESS)
439 uword log2_n_stack_bytes;
441 log2_n_stack_bytes = clib_max (r->process_log2_n_stack_bytes,
442 VLIB_PROCESS_LOG2_STACK_SIZE);
443 log2_n_stack_bytes = clib_max (log2_n_stack_bytes,
444 clib_mem_get_log2_page_size ());
446 p = clib_mem_alloc_aligned (sizeof (p[0]), CLIB_CACHE_LINE_BYTES);
447 clib_memset (p, 0, sizeof (p[0]));
448 p->log2_n_stack_bytes = log2_n_stack_bytes;
450 p->stack = clib_mem_vm_map_stack (1ULL << log2_n_stack_bytes,
451 CLIB_MEM_PAGE_SZ_DEFAULT,
453 format_vlib_node_name, vm,
456 if (p->stack == CLIB_MEM_VM_MAP_FAILED)
457 clib_panic ("failed to allocate process stack (%d bytes)",
458 1ULL << log2_n_stack_bytes);
460 /* Process node's runtime index is really index into process
462 n->runtime_index = vec_len (nm->processes);
464 vec_add1 (nm->processes, p);
466 /* Paint first stack word with magic number so we can at least
467 detect process stack overruns. */
468 p->stack[0] = VLIB_PROCESS_STACK_MAGIC;
470 /* Node runtime is stored inside of process. */
471 rt = &p->node_runtime;
475 vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
476 /* align */ CLIB_CACHE_LINE_BYTES);
477 if (n->type == VLIB_NODE_TYPE_INPUT)
478 clib_interrupt_resize (&nm->interrupts,
479 vec_len (nm->nodes_by_type[n->type]));
480 n->runtime_index = rt - nm->nodes_by_type[n->type];
483 if (n->type == VLIB_NODE_TYPE_INPUT)
484 nm->input_node_counts_by_state[n->state] += 1;
486 rt->function = n->function;
487 rt->flags = n->flags;
488 rt->state = n->state;
489 rt->node_index = n->index;
491 rt->n_next_nodes = r->n_next_nodes;
492 rt->next_frame_index = vec_len (nm->next_frames);
494 vec_resize (nm->next_frames, rt->n_next_nodes);
495 for (i = 0; i < rt->n_next_nodes; i++)
496 vlib_next_frame_init (nm->next_frames + rt->next_frame_index + i);
498 vec_resize (rt->errors, r->n_errors);
499 for (i = 0; i < vec_len (rt->errors); i++)
500 rt->errors[i] = n->error_heap_index + i;
502 STATIC_ASSERT_SIZEOF (vlib_node_runtime_t, 128);
503 ASSERT (vec_len (n->runtime_data) <= VLIB_NODE_RUNTIME_DATA_SIZE);
505 if (vec_len (n->runtime_data) > 0)
506 clib_memcpy (rt->runtime_data, n->runtime_data,
507 vec_len (n->runtime_data));
509 clib_memset (rt->runtime_data, 0, VLIB_NODE_RUNTIME_DATA_SIZE);
511 vec_free (n->runtime_data);
516 /* Register new packet processing node. */
518 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r)
520 register_node (vm, r);
525 null_node_fn (vlib_main_t * vm,
526 vlib_node_runtime_t * node, vlib_frame_t * frame)
528 u16 n_vectors = frame->n_vectors;
530 vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
531 vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_vectors);
532 vlib_frame_free (vm, node, frame);
538 vlib_register_all_node_march_variants (vlib_main_t *vm)
540 vlib_node_main_t *nm = &vm->node_main;
541 vlib_node_fn_variant_t *v;
544 nm->node_fn_default_march_variant = ~0;
545 ASSERT (nm->variants == 0);
546 vec_add2 (nm->variants, v, 1);
547 v->desc = v->suffix = "default";
548 v->index = CLIB_MARCH_VARIANT_TYPE;
551 vec_add2 (nm->variants, v, 1); \
553 v->index = CLIB_MARCH_VARIANT_TYPE_##s; \
554 v->priority = clib_cpu_march_priority_##s (); \
557 foreach_march_variant;
560 nm->node_fn_march_variant_by_suffix = hash_create_string (0, sizeof (u32));
562 vec_foreach (v, nm->variants)
564 ASSERT (v->index == v - nm->variants);
565 hash_set (nm->node_fn_march_variant_by_suffix, v->suffix, v->index);
566 if (v->priority > prio)
572 vlib_register_all_static_nodes (vlib_main_t * vm)
574 vlib_node_registration_t *r;
576 static char *null_node_error_strings[] = {
577 "blackholed packets",
580 static vlib_node_registration_t null_node_reg = {
581 .function = null_node_fn,
582 .vector_size = sizeof (u32),
585 .error_strings = null_node_error_strings,
588 /* make sure that node index 0 is not used by
590 register_node (vm, &null_node_reg);
592 r = vm->node_main.node_registrations;
595 register_node (vm, r);
596 r = r->next_registration;
601 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
602 int barrier_sync, vlib_node_t **** node_dupsp,
603 vlib_main_t *** stat_vmsp)
605 vlib_node_main_t *nm = &vm->node_main;
607 vlib_node_t ***node_dups = *node_dupsp;
609 vlib_main_t **stat_vms = *stat_vmsp;
610 vlib_main_t *stat_vm;
612 u32 threads_to_serialize;
614 if (vec_len (stat_vms) == 0)
616 for (i = 0; i < vec_len (vlib_mains); i++)
618 stat_vm = vlib_mains[i];
620 vec_add1 (stat_vms, stat_vm);
624 threads_to_serialize = clib_min (max_threads, vec_len (stat_vms));
626 vec_validate (node_dups, threads_to_serialize - 1);
629 * Barrier sync across stats scraping.
630 * Otherwise, the counts will be grossly inaccurate.
633 vlib_worker_thread_barrier_sync (vm);
635 for (j = 0; j < threads_to_serialize; j++)
637 stat_vm = stat_vms[j];
638 nm = &stat_vm->node_main;
642 for (i = 0; i < vec_len (nm->nodes); i++)
645 vlib_node_sync_stats (stat_vm, n);
649 nodes = node_dups[j];
650 vec_validate (nodes, vec_len (nm->nodes) - 1);
651 clib_memcpy (nodes, nm->nodes, vec_len (nm->nodes) * sizeof (nodes[0]));
652 node_dups[j] = nodes;
656 vlib_worker_thread_barrier_release (vm);
658 *node_dupsp = node_dups;
659 *stat_vmsp = stat_vms;
663 vlib_node_main_init (vlib_main_t * vm)
665 vlib_node_main_t *nm = &vm->node_main;
666 clib_error_t *error = 0;
670 nm->frame_sizes = vec_new (vlib_frame_size_t, 1);
671 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
672 nm->frame_size_hash = hash_create (0, sizeof (uword));
674 nm->flags |= VLIB_NODE_MAIN_RUNTIME_STARTED;
676 /* Generate sibling relationships */
678 vlib_node_t *n, *sib;
681 for (ni = 0; ni < vec_len (nm->nodes); ni++)
683 n = vec_elt (nm->nodes, ni);
688 sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
691 error = clib_error_create ("sibling `%s' not found for node `%v'",
692 n->sibling_of, n->name);
697 clib_bitmap_foreach (si, sib->sibling_bitmap) {
698 vlib_node_t * m = vec_elt (nm->nodes, si);
700 /* Connect all of sibling's siblings to us. */
701 m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
703 /* Connect us to all of sibling's siblings. */
704 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
708 /* Connect sibling to us. */
709 sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
711 /* Connect us to sibling. */
712 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
716 /* Resolve next names into next indices. */
717 for (ni = 0; ni < vec_len (nm->nodes); ni++)
721 n = vec_elt (nm->nodes, ni);
723 for (i = 0; i < vec_len (n->next_node_names); i++)
725 char *a = n->next_node_names[i];
730 if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
732 error = clib_error_create
733 ("node `%v' refers to unknown node `%s'", n->name, a);
738 vec_free (n->next_node_names);
741 /* Set previous node pointers. */
742 for (ni = 0; ni < vec_len (nm->nodes); ni++)
747 n = vec_elt (nm->nodes, ni);
749 for (i = 0; i < vec_len (n->next_nodes); i++)
751 if (n->next_nodes[i] >= vec_len (nm->nodes))
754 n_next = vec_elt (nm->nodes, n->next_nodes[i]);
755 n_next->prev_node_bitmap =
756 clib_bitmap_ori (n_next->prev_node_bitmap, n->index);
761 vlib_next_frame_t *nf;
762 vlib_node_runtime_t *r;
766 vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
768 if (r->n_next_nodes == 0)
771 n = vlib_get_node (vm, r->node_index);
772 nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
774 for (i = 0; i < vec_len (n->next_nodes); i++)
776 next = vlib_get_node (vm, n->next_nodes[i]);
778 /* Validate node runtime indices are correctly initialized. */
779 ASSERT (nf[i].node_runtime_index == next->runtime_index);
782 if (next->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH)
783 nf[i].flags |= VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
793 vlib_process_create (vlib_main_t * vm, char *name,
794 vlib_node_function_t * f, u32 log2_n_stack_bytes)
796 vlib_node_registration_t r;
799 memset (&r, 0, sizeof (r));
801 r.name = (char *) format (0, "%s", name, 0);
803 r.process_log2_n_stack_bytes = log2_n_stack_bytes;
804 r.type = VLIB_NODE_TYPE_PROCESS;
806 vlib_worker_thread_barrier_sync (vm);
808 vlib_register_node (vm, &r);
811 vlib_worker_thread_node_runtime_update ();
812 vlib_worker_thread_barrier_release (vm);
814 n = vlib_get_node (vm, r.index);
815 vlib_start_process (vm, n->runtime_index);
821 vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
822 clib_march_variant_type_t march_variant)
824 vlib_node_fn_registration_t *fnr;
825 vlib_node_fn_variant_t *v;
826 vlib_node_t *n = vlib_get_node (vm, node_index);
828 if (n->node_fn_registrations == 0)
831 fnr = n->node_fn_registrations;
832 v = vec_elt_at_index (vm->node_main.variants, march_variant);
836 if (fnr->march_variant == v->index)
838 n->function = fnr->function;
840 for (int i = 0; i < vec_len (vlib_mains); i++)
842 vlib_node_runtime_t *nrt;
843 nrt = vlib_node_get_runtime (vlib_mains[i], n->index);
844 nrt->function = fnr->function;
848 fnr = fnr->next_registration;
853 * fd.io coding-style-patch-verification: ON
856 * eval: (c-set-style "gnu")