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_worker_thread_node_rename (u32 node_index)
82 if (vec_len (vlib_mains) == 1)
86 n = vlib_get_node (vm, node_index);
88 ASSERT (vlib_get_thread_index () == 0);
89 ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
91 for (i = 1; i < vec_len (vlib_mains); i++)
93 vlib_main_t *vm_worker = vlib_mains[i];
94 vlib_node_t *n_worker = vlib_get_node (vm_worker, node_index);
96 n_worker->name = n->name;
97 n_worker->name_elog_string = n->name_elog_string;
102 vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...)
105 vlib_node_main_t *nm = &vm->node_main;
106 vlib_node_t *n = vlib_get_node (vm, node_index);
109 hash_unset (nm->node_by_name, n->name);
111 n->name = va_format (0, fmt, &va);
113 hash_set (nm->node_by_name, n->name, n->index);
115 node_set_elog_name (vm, node_index);
117 /* Propagate the change to all worker threads */
118 vlib_worker_thread_node_rename (node_index);
122 vlib_node_runtime_update (vlib_main_t * vm, u32 node_index, u32 next_index)
124 vlib_node_main_t *nm = &vm->node_main;
125 vlib_node_runtime_t *r, *s;
126 vlib_node_t *node, *next_node;
127 vlib_next_frame_t *nf;
128 vlib_pending_frame_t *pf;
131 node = vec_elt (nm->nodes, node_index);
132 r = vlib_node_get_runtime (vm, node_index);
134 n_insert = vec_len (node->next_nodes) - r->n_next_nodes;
137 i = r->next_frame_index + r->n_next_nodes;
138 vec_insert (nm->next_frames, n_insert, i);
140 /* Initialize newly inserted next frames. */
141 for (j = 0; j < n_insert; j++)
142 vlib_next_frame_init (nm->next_frames + i + j);
144 /* Relocate other next frames at higher indices. */
145 for (j = 0; j < vec_len (nm->nodes); j++)
147 s = vlib_node_get_runtime (vm, j);
148 if (j != node_index && s->next_frame_index >= i)
149 s->next_frame_index += n_insert;
152 /* Pending frames may need to be relocated also. */
153 vec_foreach (pf, nm->pending_frames)
155 if (pf->next_frame_index != VLIB_PENDING_FRAME_NO_NEXT_FRAME
156 && pf->next_frame_index >= i)
157 pf->next_frame_index += n_insert;
160 pool_foreach (pf, nm->suspended_process_frames, ({
161 if (pf->next_frame_index != ~0 && pf->next_frame_index >= i)
162 pf->next_frame_index += n_insert;
166 r->n_next_nodes = vec_len (node->next_nodes);
169 /* Set frame's node runtime index. */
170 next_node = vlib_get_node (vm, node->next_nodes[next_index]);
171 nf = nm->next_frames + r->next_frame_index + next_index;
172 nf->node_runtime_index = next_node->runtime_index;
174 vlib_worker_thread_node_runtime_update ();
178 vlib_node_get_next (vlib_main_t * vm, uword node_index, uword next_node_index)
180 vlib_node_main_t *nm = &vm->node_main;
184 node = vec_elt (nm->nodes, 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)))
197 /* Add next node to given node in given slot. */
199 vlib_node_add_next_with_slot (vlib_main_t * vm,
201 uword next_node_index, uword slot)
203 vlib_node_main_t *nm = &vm->node_main;
204 vlib_node_t *node, *next;
207 ASSERT (vlib_get_thread_index () == 0);
209 node = vec_elt (nm->nodes, node_index);
210 next = vec_elt (nm->nodes, next_node_index);
212 /* Runtime has to be initialized. */
213 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
215 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
217 /* Next already exists: slot must match. */
219 ASSERT (slot == p[0]);
223 vlib_worker_thread_barrier_sync (vm);
226 slot = vec_len (node->next_nodes);
228 vec_validate_init_empty (node->next_nodes, slot, ~0);
229 vec_validate (node->n_vectors_by_next_node, slot);
231 node->next_nodes[slot] = next_node_index;
232 hash_set (node->next_slot_by_node, next_node_index, slot);
234 vlib_node_runtime_update (vm, node_index, slot);
236 next->prev_node_bitmap = clib_bitmap_ori (next->prev_node_bitmap,
239 /* Siblings all get same node structure. */
241 uword sib_node_index, sib_slot;
242 vlib_node_t *sib_node;
244 clib_bitmap_foreach (sib_node_index, node->sibling_bitmap, ({
245 sib_node = vec_elt (nm->nodes, sib_node_index);
246 if (sib_node != node)
248 sib_slot = vlib_node_add_next_with_slot (vm, sib_node_index, next_node_index, slot);
249 ASSERT (sib_slot == slot);
255 vlib_worker_thread_barrier_release (vm);
259 /* Add named next node to given node in given slot. */
261 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
262 uword node, char *name, uword slot)
264 vlib_node_main_t *nm;
265 vlib_node_t *n, *n_next;
268 n = vlib_get_node (vm, node);
270 n_next = vlib_get_node_by_name (vm, (u8 *) name);
273 if (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED)
277 slot = clib_max (vec_len (n->next_node_names),
278 vec_len (n->next_nodes));
279 vec_validate (n->next_node_names, slot);
280 n->next_node_names[slot] = name;
284 return vlib_node_add_next_with_slot (vm, node, n_next->index, slot);
288 node_elog_init (vlib_main_t * vm, uword ni)
292 clib_memset (&t, 0, sizeof (t));
294 /* 2 event types for this node: one when node function is called.
295 One when it returns. */
296 vec_validate (vm->node_call_elog_event_types, ni);
297 vm->node_call_elog_event_types[ni] = t;
299 vec_validate (vm->node_return_elog_event_types, ni);
300 vm->node_return_elog_event_types[ni] = t;
302 node_set_elog_name (vm, ni);
306 #define STACK_ALIGN (clib_mem_get_page_size())
308 #define STACK_ALIGN CLIB_CACHE_LINE_BYTES
312 register_node (vlib_main_t * vm, vlib_node_registration_t * r)
314 vlib_node_main_t *nm = &vm->node_main;
316 u32 page_size = clib_mem_get_page_size ();
321 /* Default (0) type should match INTERNAL. */
322 vlib_node_t zero = { 0 };
323 ASSERT (VLIB_NODE_TYPE_INTERNAL == zero.type);
326 if (r->node_fn_registrations)
328 vlib_node_fn_registration_t *fnr = r->node_fn_registrations;
331 /* to avoid confusion, please remove ".function " statiement from
332 CLIB_NODE_REGISTRATION() if using function function candidates */
333 ASSERT (r->function == 0);
337 if (fnr->priority > priority)
339 priority = fnr->priority;
340 r->function = fnr->function;
342 fnr = fnr->next_registration;
346 ASSERT (r->function != 0);
348 n = clib_mem_alloc_no_fail (sizeof (n[0]));
349 clib_memset (n, 0, sizeof (n[0]));
350 n->index = vec_len (nm->nodes);
351 n->node_fn_registrations = r->node_fn_registrations;
352 n->protocol_hint = r->protocol_hint;
354 vec_add1 (nm->nodes, n);
356 /* Name is always a vector so it can be formatted with %v. */
357 if (clib_mem_is_heap_object (vec_header (r->name, 0)))
358 n->name = vec_dup ((u8 *) r->name);
360 n->name = format (0, "%s", r->name);
362 if (!nm->node_by_name)
363 nm->node_by_name = hash_create_vec ( /* size */ 32,
364 sizeof (n->name[0]), sizeof (uword));
366 /* Node names must be unique. */
368 vlib_node_t *o = vlib_get_node_by_name (vm, n->name);
370 clib_error ("more than one node named `%v'", n->name);
373 hash_set (nm->node_by_name, n->name, n->index);
375 r->index = n->index; /* save index in registration */
376 n->function = r->function;
378 /* Node index of next sibling will be filled in by vlib_node_main_init. */
379 n->sibling_of = r->sibling_of;
380 if (r->sibling_of && r->n_next_nodes > 0)
381 clib_error ("sibling node should not have any next nodes `%v'", n->name);
383 if (r->type == VLIB_NODE_TYPE_INTERNAL)
384 ASSERT (r->vector_size > 0);
386 #define _(f) n->f = r->f
398 /* Register error counters. */
399 vlib_register_errors (vm, n->index, r->n_errors, r->error_strings);
400 node_elog_init (vm, n->index);
402 _(runtime_data_bytes);
403 if (r->runtime_data_bytes > 0)
405 vec_resize (n->runtime_data, r->runtime_data_bytes);
407 clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
410 vec_resize (n->next_node_names, r->n_next_nodes);
411 for (i = 0; i < r->n_next_nodes; i++)
412 n->next_node_names[i] = r->next_nodes[i];
414 vec_validate_init_empty (n->next_nodes, r->n_next_nodes - 1, ~0);
415 vec_validate (n->n_vectors_by_next_node, r->n_next_nodes - 1);
417 n->owner_node_index = n->owner_next_index = ~0;
419 /* Initialize node runtime. */
421 vlib_node_runtime_t *rt;
424 if (n->type == VLIB_NODE_TYPE_PROCESS)
427 uword log2_n_stack_bytes;
429 log2_n_stack_bytes = clib_max (r->process_log2_n_stack_bytes, 15);
433 * Bump the stack size if running over a kernel with a large page size,
434 * and the stack isn't any too big to begin with. Otherwise, we'll
435 * trip over the stack guard page for sure.
437 if ((page_size > (4 << 10)) && log2_n_stack_bytes < 19)
439 if ((1 << log2_n_stack_bytes) <= page_size)
440 log2_n_stack_bytes = min_log2 (page_size) + 1;
442 log2_n_stack_bytes++;
446 p = clib_mem_alloc_aligned_at_offset
447 (sizeof (p[0]) + (1 << log2_n_stack_bytes),
448 STACK_ALIGN, STRUCT_OFFSET_OF (vlib_process_t, stack),
449 0 /* no, don't call os_out_of_memory */ );
451 clib_panic ("failed to allocate process stack (%d bytes)",
452 1 << log2_n_stack_bytes);
454 clib_memset (p, 0, sizeof (p[0]));
455 p->log2_n_stack_bytes = log2_n_stack_bytes;
457 /* Process node's runtime index is really index into process
459 n->runtime_index = vec_len (nm->processes);
461 vec_add1 (nm->processes, p);
463 /* Paint first stack word with magic number so we can at least
464 detect process stack overruns. */
465 p->stack[0] = VLIB_PROCESS_STACK_MAGIC;
467 /* Node runtime is stored inside of process. */
468 rt = &p->node_runtime;
472 * Disallow writes to the bottom page of the stack, to
473 * catch stack overflows.
475 if (mprotect (p->stack, page_size, PROT_READ) < 0)
476 clib_unix_warning ("process stack");
482 vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
483 /* align */ CLIB_CACHE_LINE_BYTES);
484 n->runtime_index = rt - nm->nodes_by_type[n->type];
487 if (n->type == VLIB_NODE_TYPE_INPUT)
488 nm->input_node_counts_by_state[n->state] += 1;
490 rt->function = n->function;
491 rt->flags = n->flags;
492 rt->state = n->state;
493 rt->node_index = n->index;
495 rt->n_next_nodes = r->n_next_nodes;
496 rt->next_frame_index = vec_len (nm->next_frames);
498 vec_resize (nm->next_frames, rt->n_next_nodes);
499 for (i = 0; i < rt->n_next_nodes; i++)
500 vlib_next_frame_init (nm->next_frames + rt->next_frame_index + i);
502 vec_resize (rt->errors, r->n_errors);
503 for (i = 0; i < vec_len (rt->errors); i++)
504 rt->errors[i] = n->error_heap_index + i;
506 STATIC_ASSERT_SIZEOF (vlib_node_runtime_t, 128);
507 ASSERT (vec_len (n->runtime_data) <= VLIB_NODE_RUNTIME_DATA_SIZE);
509 if (vec_len (n->runtime_data) > 0)
510 clib_memcpy (rt->runtime_data, n->runtime_data,
511 vec_len (n->runtime_data));
513 vec_free (n->runtime_data);
517 /* Register new packet processing node. */
519 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r)
521 register_node (vm, r);
526 null_node_fn (vlib_main_t * vm,
527 vlib_node_runtime_t * node, vlib_frame_t * frame)
529 u16 n_vectors = frame->n_vectors;
531 vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
532 vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_vectors);
533 vlib_frame_free (vm, node, frame);
539 vlib_register_all_static_nodes (vlib_main_t * vm)
541 vlib_node_registration_t *r;
543 static char *null_node_error_strings[] = {
544 "blackholed packets",
547 static vlib_node_registration_t null_node_reg = {
548 .function = null_node_fn,
549 .vector_size = sizeof (u32),
552 .error_strings = null_node_error_strings,
555 /* make sure that node index 0 is not used by
557 register_node (vm, &null_node_reg);
559 r = vm->node_main.node_registrations;
562 register_node (vm, r);
563 r = r->next_registration;
568 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
569 int barrier_sync, vlib_node_t **** node_dupsp,
570 vlib_main_t *** stat_vmsp)
572 vlib_node_main_t *nm = &vm->node_main;
574 vlib_node_t ***node_dups = *node_dupsp;
576 vlib_main_t **stat_vms = *stat_vmsp;
577 vlib_main_t *stat_vm;
579 u32 threads_to_serialize;
581 if (vec_len (stat_vms) == 0)
583 for (i = 0; i < vec_len (vlib_mains); i++)
585 stat_vm = vlib_mains[i];
587 vec_add1 (stat_vms, stat_vm);
591 threads_to_serialize = clib_min (max_threads, vec_len (stat_vms));
593 vec_validate (node_dups, threads_to_serialize - 1);
596 * Barrier sync across stats scraping.
597 * Otherwise, the counts will be grossly inaccurate.
600 vlib_worker_thread_barrier_sync (vm);
602 for (j = 0; j < threads_to_serialize; j++)
604 stat_vm = stat_vms[j];
605 nm = &stat_vm->node_main;
609 for (i = 0; i < vec_len (nm->nodes); i++)
612 vlib_node_sync_stats (stat_vm, n);
616 nodes = node_dups[j];
617 vec_validate (nodes, vec_len (nm->nodes) - 1);
618 clib_memcpy (nodes, nm->nodes, vec_len (nm->nodes) * sizeof (nodes[0]));
619 node_dups[j] = nodes;
623 vlib_worker_thread_barrier_release (vm);
625 *node_dupsp = node_dups;
626 *stat_vmsp = stat_vms;
630 vlib_node_main_init (vlib_main_t * vm)
632 vlib_node_main_t *nm = &vm->node_main;
633 clib_error_t *error = 0;
637 nm->frame_sizes = vec_new (vlib_frame_size_t, 1);
638 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
639 nm->frame_size_hash = hash_create (0, sizeof (uword));
641 nm->flags |= VLIB_NODE_MAIN_RUNTIME_STARTED;
643 /* Generate sibling relationships */
645 vlib_node_t *n, *sib;
648 for (ni = 0; ni < vec_len (nm->nodes); ni++)
650 n = vec_elt (nm->nodes, ni);
655 sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
658 error = clib_error_create ("sibling `%s' not found for node `%v'",
659 n->sibling_of, n->name);
664 clib_bitmap_foreach (si, sib->sibling_bitmap, ({
665 vlib_node_t * m = vec_elt (nm->nodes, si);
667 /* Connect all of sibling's siblings to us. */
668 m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
670 /* Connect us to all of sibling's siblings. */
671 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
675 /* Connect sibling to us. */
676 sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
678 /* Connect us to sibling. */
679 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
683 /* Resolve next names into next indices. */
684 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_node_names); i++)
692 char *a = n->next_node_names[i];
697 if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
699 error = clib_error_create
700 ("node `%v' refers to unknown node `%s'", n->name, a);
705 vec_free (n->next_node_names);
708 /* Set previous node pointers. */
709 for (ni = 0; ni < vec_len (nm->nodes); ni++)
714 n = vec_elt (nm->nodes, ni);
716 for (i = 0; i < vec_len (n->next_nodes); i++)
718 if (n->next_nodes[i] >= vec_len (nm->nodes))
721 n_next = vec_elt (nm->nodes, n->next_nodes[i]);
722 n_next->prev_node_bitmap =
723 clib_bitmap_ori (n_next->prev_node_bitmap, n->index);
728 vlib_next_frame_t *nf;
729 vlib_node_runtime_t *r;
733 vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
735 if (r->n_next_nodes == 0)
738 n = vlib_get_node (vm, r->node_index);
739 nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
741 for (i = 0; i < vec_len (n->next_nodes); i++)
743 next = vlib_get_node (vm, n->next_nodes[i]);
745 /* Validate node runtime indices are correctly initialized. */
746 ASSERT (nf[i].node_runtime_index == next->runtime_index);
749 if (next->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH)
750 nf[i].flags |= VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
760 vlib_process_create (vlib_main_t * vm, char *name,
761 vlib_node_function_t * f, u32 log2_n_stack_bytes)
763 vlib_node_registration_t r;
766 memset (&r, 0, sizeof (r));
768 r.name = (char *) format (0, "%s", name, 0);
770 r.process_log2_n_stack_bytes = log2_n_stack_bytes;
771 r.type = VLIB_NODE_TYPE_PROCESS;
773 vlib_worker_thread_barrier_sync (vm);
775 vlib_register_node (vm, &r);
778 vlib_worker_thread_node_runtime_update ();
779 vlib_worker_thread_barrier_release (vm);
781 n = vlib_get_node (vm, r.index);
782 vlib_start_process (vm, n->runtime_index);
788 * fd.io coding-style-patch-verification: ON
791 * eval: (c-set-style "gnu")