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
294 register_node (vlib_main_t * vm, vlib_node_registration_t * r)
296 vlib_node_main_t *nm = &vm->node_main;
302 /* Default (0) type should match INTERNAL. */
303 vlib_node_t zero = { 0 };
304 ASSERT (VLIB_NODE_TYPE_INTERNAL == zero.type);
307 if (r->node_fn_registrations)
309 vlib_node_fn_registration_t *fnr = r->node_fn_registrations;
312 /* to avoid confusion, please remove ".function " statiement from
313 CLIB_NODE_REGISTRATION() if using function function candidates */
314 ASSERT (r->function == 0);
318 if (fnr->priority > priority)
320 priority = fnr->priority;
321 r->function = fnr->function;
323 fnr = fnr->next_registration;
327 ASSERT (r->function != 0);
329 n = clib_mem_alloc_no_fail (sizeof (n[0]));
330 clib_memset (n, 0, sizeof (n[0]));
331 n->index = vec_len (nm->nodes);
332 n->node_fn_registrations = r->node_fn_registrations;
333 n->protocol_hint = r->protocol_hint;
335 vec_add1 (nm->nodes, n);
337 /* Name is always a vector so it can be formatted with %v. */
338 if (clib_mem_is_heap_object (vec_header (r->name, 0)))
339 n->name = vec_dup ((u8 *) r->name);
341 n->name = format (0, "%s", r->name);
343 if (!nm->node_by_name)
344 nm->node_by_name = hash_create_vec ( /* size */ 32,
345 sizeof (n->name[0]), sizeof (uword));
347 /* Node names must be unique. */
349 /* vlib_get_node_by_name() expects NULL-terminated strings */
350 u8 *name = format (0, "%v%c", n->name, 0);
351 vlib_node_t *o = vlib_get_node_by_name (vm, name);
354 clib_error ("more than one node named `%v'", n->name);
357 hash_set (nm->node_by_name, n->name, n->index);
359 r->index = n->index; /* save index in registration */
360 n->function = r->function;
362 /* Node index of next sibling will be filled in by vlib_node_main_init. */
363 n->sibling_of = r->sibling_of;
364 if (r->sibling_of && r->n_next_nodes > 0)
365 clib_error ("sibling node should not have any next nodes `%v'", n->name);
367 if (r->type == VLIB_NODE_TYPE_INTERNAL)
368 ASSERT (r->vector_size > 0);
370 #define _(f) n->f = r->f
382 /* Register error counters. */
383 vlib_register_errors (vm, n->index, r->n_errors, r->error_strings,
385 node_elog_init (vm, n->index);
387 _(runtime_data_bytes);
388 if (r->runtime_data_bytes > 0)
390 vec_resize (n->runtime_data, r->runtime_data_bytes);
392 clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
395 vec_resize (n->next_node_names, r->n_next_nodes);
396 for (i = 0; i < r->n_next_nodes; i++)
397 n->next_node_names[i] = r->next_nodes[i];
399 vec_validate_init_empty (n->next_nodes, r->n_next_nodes - 1, ~0);
400 vec_validate (n->n_vectors_by_next_node, r->n_next_nodes - 1);
402 n->owner_node_index = n->owner_next_index = ~0;
404 /* Initialize node runtime. */
406 vlib_node_runtime_t *rt;
409 if (n->type == VLIB_NODE_TYPE_PROCESS)
412 uword log2_n_stack_bytes;
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 clib_mem_get_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 p->stack = clib_mem_vm_map_stack (1ULL << log2_n_stack_bytes,
424 CLIB_MEM_PAGE_SZ_DEFAULT,
426 format_vlib_node_name, vm,
429 if (p->stack == CLIB_MEM_VM_MAP_FAILED)
430 clib_panic ("failed to allocate process stack (%d bytes)",
431 1ULL << log2_n_stack_bytes);
433 /* Process node's runtime index is really index into process
435 n->runtime_index = vec_len (nm->processes);
437 vec_add1 (nm->processes, p);
439 /* Paint first stack word with magic number so we can at least
440 detect process stack overruns. */
441 p->stack[0] = VLIB_PROCESS_STACK_MAGIC;
443 /* Node runtime is stored inside of process. */
444 rt = &p->node_runtime;
448 vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
449 /* align */ CLIB_CACHE_LINE_BYTES);
450 n->runtime_index = rt - nm->nodes_by_type[n->type];
453 if (n->type == VLIB_NODE_TYPE_INPUT)
454 nm->input_node_counts_by_state[n->state] += 1;
456 rt->function = n->function;
457 rt->flags = n->flags;
458 rt->state = n->state;
459 rt->node_index = n->index;
461 rt->n_next_nodes = r->n_next_nodes;
462 rt->next_frame_index = vec_len (nm->next_frames);
464 vec_resize (nm->next_frames, rt->n_next_nodes);
465 for (i = 0; i < rt->n_next_nodes; i++)
466 vlib_next_frame_init (nm->next_frames + rt->next_frame_index + i);
468 vec_resize (rt->errors, r->n_errors);
469 for (i = 0; i < vec_len (rt->errors); i++)
470 rt->errors[i] = n->error_heap_index + i;
472 STATIC_ASSERT_SIZEOF (vlib_node_runtime_t, 128);
473 ASSERT (vec_len (n->runtime_data) <= VLIB_NODE_RUNTIME_DATA_SIZE);
475 if (vec_len (n->runtime_data) > 0)
476 clib_memcpy (rt->runtime_data, n->runtime_data,
477 vec_len (n->runtime_data));
479 vec_free (n->runtime_data);
483 /* Register new packet processing node. */
485 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r)
487 register_node (vm, r);
492 null_node_fn (vlib_main_t * vm,
493 vlib_node_runtime_t * node, vlib_frame_t * frame)
495 u16 n_vectors = frame->n_vectors;
497 vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
498 vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_vectors);
499 vlib_frame_free (vm, node, frame);
505 vlib_register_all_static_nodes (vlib_main_t * vm)
507 vlib_node_registration_t *r;
509 static char *null_node_error_strings[] = {
510 "blackholed packets",
513 static vlib_node_registration_t null_node_reg = {
514 .function = null_node_fn,
515 .vector_size = sizeof (u32),
518 .error_strings = null_node_error_strings,
521 /* make sure that node index 0 is not used by
523 register_node (vm, &null_node_reg);
525 r = vm->node_main.node_registrations;
528 register_node (vm, r);
529 r = r->next_registration;
534 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
535 int barrier_sync, vlib_node_t **** node_dupsp,
536 vlib_main_t *** stat_vmsp)
538 vlib_node_main_t *nm = &vm->node_main;
540 vlib_node_t ***node_dups = *node_dupsp;
542 vlib_main_t **stat_vms = *stat_vmsp;
543 vlib_main_t *stat_vm;
545 u32 threads_to_serialize;
547 if (vec_len (stat_vms) == 0)
549 for (i = 0; i < vec_len (vlib_mains); i++)
551 stat_vm = vlib_mains[i];
553 vec_add1 (stat_vms, stat_vm);
557 threads_to_serialize = clib_min (max_threads, vec_len (stat_vms));
559 vec_validate (node_dups, threads_to_serialize - 1);
562 * Barrier sync across stats scraping.
563 * Otherwise, the counts will be grossly inaccurate.
566 vlib_worker_thread_barrier_sync (vm);
568 for (j = 0; j < threads_to_serialize; j++)
570 stat_vm = stat_vms[j];
571 nm = &stat_vm->node_main;
575 for (i = 0; i < vec_len (nm->nodes); i++)
578 vlib_node_sync_stats (stat_vm, n);
582 nodes = node_dups[j];
583 vec_validate (nodes, vec_len (nm->nodes) - 1);
584 clib_memcpy (nodes, nm->nodes, vec_len (nm->nodes) * sizeof (nodes[0]));
585 node_dups[j] = nodes;
589 vlib_worker_thread_barrier_release (vm);
591 *node_dupsp = node_dups;
592 *stat_vmsp = stat_vms;
596 vlib_node_main_init (vlib_main_t * vm)
598 vlib_node_main_t *nm = &vm->node_main;
599 clib_error_t *error = 0;
603 nm->frame_sizes = vec_new (vlib_frame_size_t, 1);
604 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
605 nm->frame_size_hash = hash_create (0, sizeof (uword));
607 nm->flags |= VLIB_NODE_MAIN_RUNTIME_STARTED;
609 /* Generate sibling relationships */
611 vlib_node_t *n, *sib;
614 for (ni = 0; ni < vec_len (nm->nodes); ni++)
616 n = vec_elt (nm->nodes, ni);
621 sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
624 error = clib_error_create ("sibling `%s' not found for node `%v'",
625 n->sibling_of, n->name);
630 clib_bitmap_foreach (si, sib->sibling_bitmap, ({
631 vlib_node_t * m = vec_elt (nm->nodes, si);
633 /* Connect all of sibling's siblings to us. */
634 m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
636 /* Connect us to all of sibling's siblings. */
637 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
641 /* Connect sibling to us. */
642 sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
644 /* Connect us to sibling. */
645 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
649 /* Resolve next names into next indices. */
650 for (ni = 0; ni < vec_len (nm->nodes); ni++)
654 n = vec_elt (nm->nodes, ni);
656 for (i = 0; i < vec_len (n->next_node_names); i++)
658 char *a = n->next_node_names[i];
663 if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
665 error = clib_error_create
666 ("node `%v' refers to unknown node `%s'", n->name, a);
671 vec_free (n->next_node_names);
674 /* Set previous node pointers. */
675 for (ni = 0; ni < vec_len (nm->nodes); ni++)
680 n = vec_elt (nm->nodes, ni);
682 for (i = 0; i < vec_len (n->next_nodes); i++)
684 if (n->next_nodes[i] >= vec_len (nm->nodes))
687 n_next = vec_elt (nm->nodes, n->next_nodes[i]);
688 n_next->prev_node_bitmap =
689 clib_bitmap_ori (n_next->prev_node_bitmap, n->index);
694 vlib_next_frame_t *nf;
695 vlib_node_runtime_t *r;
699 vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
701 if (r->n_next_nodes == 0)
704 n = vlib_get_node (vm, r->node_index);
705 nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
707 for (i = 0; i < vec_len (n->next_nodes); i++)
709 next = vlib_get_node (vm, n->next_nodes[i]);
711 /* Validate node runtime indices are correctly initialized. */
712 ASSERT (nf[i].node_runtime_index == next->runtime_index);
715 if (next->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH)
716 nf[i].flags |= VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
726 vlib_process_create (vlib_main_t * vm, char *name,
727 vlib_node_function_t * f, u32 log2_n_stack_bytes)
729 vlib_node_registration_t r;
732 memset (&r, 0, sizeof (r));
734 r.name = (char *) format (0, "%s", name, 0);
736 r.process_log2_n_stack_bytes = log2_n_stack_bytes;
737 r.type = VLIB_NODE_TYPE_PROCESS;
739 vlib_worker_thread_barrier_sync (vm);
741 vlib_register_node (vm, &r);
744 vlib_worker_thread_node_runtime_update ();
745 vlib_worker_thread_barrier_release (vm);
747 n = vlib_get_node (vm, r.index);
748 vlib_start_process (vm, n->runtime_index);
754 * fd.io coding-style-patch-verification: ON
757 * eval: (c-set-style "gnu")