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 (key))
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);
93 vlib_node_runtime_update (vlib_main_t * vm, u32 node_index, u32 next_index)
95 vlib_node_main_t *nm = &vm->node_main;
96 vlib_node_runtime_t *r, *s;
97 vlib_node_t *node, *next_node;
98 vlib_next_frame_t *nf;
99 vlib_pending_frame_t *pf;
102 ASSERT (os_get_cpu_number () == 0);
104 vlib_worker_thread_barrier_sync (vm);
106 node = vec_elt (nm->nodes, node_index);
107 r = vlib_node_get_runtime (vm, node_index);
109 n_insert = vec_len (node->next_nodes) - r->n_next_nodes;
112 i = r->next_frame_index + r->n_next_nodes;
113 vec_insert (nm->next_frames, n_insert, i);
115 /* Initialize newly inserted next frames. */
116 for (j = 0; j < n_insert; j++)
117 vlib_next_frame_init (nm->next_frames + i + j);
119 /* Relocate other next frames at higher indices. */
120 for (j = 0; j < vec_len (nm->nodes); j++)
122 s = vlib_node_get_runtime (vm, j);
123 if (j != node_index && s->next_frame_index >= i)
124 s->next_frame_index += n_insert;
127 /* Pending frames may need to be relocated also. */
128 vec_foreach (pf, nm->pending_frames)
130 if (pf->next_frame_index != VLIB_PENDING_FRAME_NO_NEXT_FRAME
131 && pf->next_frame_index >= i)
132 pf->next_frame_index += n_insert;
135 pool_foreach (pf, nm->suspended_process_frames, ({
136 if (pf->next_frame_index != ~0 && pf->next_frame_index >= i)
137 pf->next_frame_index += n_insert;
141 r->n_next_nodes = vec_len (node->next_nodes);
144 /* Set frame's node runtime index. */
145 next_node = vlib_get_node (vm, node->next_nodes[next_index]);
146 nf = nm->next_frames + r->next_frame_index + next_index;
147 nf->node_runtime_index = next_node->runtime_index;
149 vlib_worker_thread_node_runtime_update ();
151 vlib_worker_thread_barrier_release (vm);
154 /* Add next node to given node in given slot. */
156 vlib_node_add_next_with_slot (vlib_main_t * vm,
158 uword next_node_index, uword slot)
160 vlib_node_main_t *nm = &vm->node_main;
161 vlib_node_t *node, *next;
164 node = vec_elt (nm->nodes, node_index);
165 next = vec_elt (nm->nodes, next_node_index);
167 /* Runtime has to be initialized. */
168 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
170 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
172 /* Next already exists: slot must match. */
174 ASSERT (slot == p[0]);
179 slot = vec_len (node->next_nodes);
181 vec_validate_init_empty (node->next_nodes, slot, ~0);
182 vec_validate (node->n_vectors_by_next_node, slot);
184 node->next_nodes[slot] = next_node_index;
185 hash_set (node->next_slot_by_node, next_node_index, slot);
187 vlib_node_runtime_update (vm, node_index, slot);
189 next->prev_node_bitmap = clib_bitmap_ori (next->prev_node_bitmap,
192 /* Siblings all get same node structure. */
194 uword sib_node_index, sib_slot;
195 vlib_node_t *sib_node;
197 clib_bitmap_foreach (sib_node_index, node->sibling_bitmap, ({
198 sib_node = vec_elt (nm->nodes, sib_node_index);
199 if (sib_node != node)
201 sib_slot = vlib_node_add_next_with_slot (vm, sib_node_index, next_node_index, slot);
202 ASSERT (sib_slot == slot);
211 /* Add named next node to given node in given slot. */
213 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
214 uword node, char *name, uword slot)
216 vlib_node_main_t *nm;
217 vlib_node_t *n, *n_next;
220 n = vlib_get_node (vm, node);
222 n_next = vlib_get_node_by_name (vm, (u8 *) name);
225 if (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED)
229 slot = clib_max (vec_len (n->next_node_names),
230 vec_len (n->next_nodes));
231 vec_validate (n->next_node_names, slot);
232 n->next_node_names[slot] = name;
236 return vlib_node_add_next_with_slot (vm, node, n_next->index, slot);
240 node_elog_init (vlib_main_t * vm, uword ni)
244 memset (&t, 0, sizeof (t));
246 /* 2 event types for this node: one when node function is called.
247 One when it returns. */
248 vec_validate (vm->node_call_elog_event_types, ni);
249 vm->node_call_elog_event_types[ni] = t;
251 vec_validate (vm->node_return_elog_event_types, ni);
252 vm->node_return_elog_event_types[ni] = t;
254 node_set_elog_name (vm, ni);
258 #define STACK_ALIGN (clib_mem_get_page_size())
260 #define STACK_ALIGN CLIB_CACHE_LINE_BYTES
264 register_node (vlib_main_t * vm, vlib_node_registration_t * r)
266 vlib_node_main_t *nm = &vm->node_main;
268 u32 page_size = clib_mem_get_page_size ();
273 /* Default (0) type should match INTERNAL. */
274 vlib_node_t zero = { 0 };
275 ASSERT (VLIB_NODE_TYPE_INTERNAL == zero.type);
278 ASSERT (r->function != 0);
280 n = clib_mem_alloc_no_fail (sizeof (n[0]));
281 memset (n, 0, sizeof (n[0]));
282 n->index = vec_len (nm->nodes);
284 vec_add1 (nm->nodes, n);
286 /* Name is always a vector so it can be formatted with %v. */
287 if (clib_mem_is_heap_object (vec_header (r->name, 0)))
288 n->name = vec_dup ((u8 *) r->name);
290 n->name = format (0, "%s", r->name);
292 if (!nm->node_by_name)
293 nm->node_by_name = hash_create_vec ( /* size */ 32,
294 sizeof (n->name[0]), sizeof (uword));
296 /* Node names must be unique. */
298 vlib_node_t *o = vlib_get_node_by_name (vm, n->name);
300 clib_error ("more than one node named `%v'", n->name);
303 hash_set (nm->node_by_name, n->name, n->index);
305 r->index = n->index; /* save index in registration */
306 n->function = r->function;
308 /* Node index of next sibling will be filled in by vlib_node_main_init. */
309 n->sibling_of = r->sibling_of;
310 if (r->sibling_of && r->n_next_nodes > 0)
311 clib_error ("sibling node should not have any next nodes `%v'", n->name);
313 if (r->type == VLIB_NODE_TYPE_INTERNAL)
314 ASSERT (r->vector_size > 0);
316 #define _(f) n->f = r->f
328 /* Register error counters. */
329 vlib_register_errors (vm, n->index, r->n_errors, r->error_strings);
330 node_elog_init (vm, n->index);
332 _(runtime_data_bytes);
333 if (r->runtime_data_bytes > 0)
335 vec_resize (n->runtime_data, r->runtime_data_bytes);
337 clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
340 vec_resize (n->next_node_names, r->n_next_nodes);
341 for (i = 0; i < r->n_next_nodes; i++)
342 n->next_node_names[i] = r->next_nodes[i];
344 vec_validate_init_empty (n->next_nodes, r->n_next_nodes - 1, ~0);
345 vec_validate (n->n_vectors_by_next_node, r->n_next_nodes - 1);
347 n->owner_node_index = n->owner_next_index = ~0;
349 /* Initialize node runtime. */
351 vlib_node_runtime_t *rt;
354 if (n->type == VLIB_NODE_TYPE_PROCESS)
357 uword log2_n_stack_bytes;
359 log2_n_stack_bytes = clib_max (r->process_log2_n_stack_bytes, 15);
363 * Bump the stack size if running over a kernel with a large page size,
364 * and the stack isn't any too big to begin with. Otherwise, we'll
365 * trip over the stack guard page for sure.
367 if ((page_size > (4 << 10)) && log2_n_stack_bytes < 19)
369 if ((1 << log2_n_stack_bytes) <= page_size)
370 log2_n_stack_bytes = min_log2 (page_size) + 1;
372 log2_n_stack_bytes++;
376 p = clib_mem_alloc_aligned_at_offset
377 (sizeof (p[0]) + (1 << log2_n_stack_bytes),
378 STACK_ALIGN, STRUCT_OFFSET_OF (vlib_process_t, stack),
379 0 /* no, don't call os_out_of_memory */ );
381 clib_panic ("failed to allocate process stack (%d bytes)",
382 1 << log2_n_stack_bytes);
384 memset (p, 0, sizeof (p[0]));
385 p->log2_n_stack_bytes = log2_n_stack_bytes;
387 /* Process node's runtime index is really index into process
389 n->runtime_index = vec_len (nm->processes);
391 vec_add1 (nm->processes, p);
393 /* Paint first stack word with magic number so we can at least
394 detect process stack overruns. */
395 p->stack[0] = VLIB_PROCESS_STACK_MAGIC;
397 /* Node runtime is stored inside of process. */
398 rt = &p->node_runtime;
402 * Disallow writes to the bottom page of the stack, to
403 * catch stack overflows.
405 if (mprotect (p->stack, page_size, PROT_READ) < 0)
406 clib_unix_warning ("process stack");
412 vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
413 /* align */ CLIB_CACHE_LINE_BYTES);
414 n->runtime_index = rt - nm->nodes_by_type[n->type];
417 if (n->type == VLIB_NODE_TYPE_INPUT)
418 nm->input_node_counts_by_state[n->state] += 1;
420 rt->function = n->function;
421 rt->flags = n->flags;
422 rt->state = n->state;
423 rt->node_index = n->index;
425 rt->n_next_nodes = r->n_next_nodes;
426 rt->next_frame_index = vec_len (nm->next_frames);
428 vec_resize (nm->next_frames, rt->n_next_nodes);
429 for (i = 0; i < rt->n_next_nodes; i++)
430 vlib_next_frame_init (nm->next_frames + rt->next_frame_index + i);
432 vec_resize (rt->errors, r->n_errors);
433 for (i = 0; i < vec_len (rt->errors); i++)
434 rt->errors[i] = vlib_error_set (n->index, i);
436 STATIC_ASSERT_SIZEOF (vlib_node_runtime_t, 128);
437 ASSERT (vec_len (n->runtime_data) <=
438 sizeof (vlib_node_runtime_t) -
439 STRUCT_OFFSET_OF (vlib_node_runtime_t, runtime_data));
441 if (vec_len (n->runtime_data) > 0)
442 clib_memcpy (rt->runtime_data, n->runtime_data,
443 vec_len (n->runtime_data));
445 vec_free (n->runtime_data);
449 /* Register new packet processing node. */
451 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r)
453 register_node (vm, r);
458 null_node_fn (vlib_main_t * vm,
459 vlib_node_runtime_t * node, vlib_frame_t * frame)
461 u16 n_vectors = frame->n_vectors;
463 vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
464 vlib_buffer_free (vm, vlib_frame_args (frame), n_vectors);
465 vlib_frame_free (vm, node, frame);
471 vlib_register_all_static_nodes (vlib_main_t * vm)
473 vlib_node_registration_t *r;
475 static char *null_node_error_strings[] = {
476 "blackholed packets",
479 static vlib_node_registration_t null_node_reg = {
480 .function = null_node_fn,
481 .vector_size = sizeof (u32),
484 .error_strings = null_node_error_strings,
487 /* make sure that node index 0 is not used by
489 register_node (vm, &null_node_reg);
491 r = vm->node_main.node_registrations;
494 register_node (vm, r);
495 r = r->next_registration;
500 vlib_node_main_init (vlib_main_t * vm)
502 vlib_node_main_t *nm = &vm->node_main;
503 clib_error_t *error = 0;
507 nm->flags |= VLIB_NODE_MAIN_RUNTIME_STARTED;
509 /* Generate sibling relationships */
511 vlib_node_t *n, *sib;
514 for (ni = 0; ni < vec_len (nm->nodes); ni++)
516 n = vec_elt (nm->nodes, ni);
521 sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
524 error = clib_error_create ("sibling `%s' not found for node `%v'",
525 n->sibling_of, n->name);
530 clib_bitmap_foreach (si, sib->sibling_bitmap, ({
531 vlib_node_t * m = vec_elt (nm->nodes, si);
533 /* Connect all of sibling's siblings to us. */
534 m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
536 /* Connect us to all of sibling's siblings. */
537 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
541 /* Connect sibling to us. */
542 sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
544 /* Connect us to sibling. */
545 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
549 /* Resolve next names into next indices. */
550 for (ni = 0; ni < vec_len (nm->nodes); ni++)
554 n = vec_elt (nm->nodes, ni);
556 for (i = 0; i < vec_len (n->next_node_names); i++)
558 char *a = n->next_node_names[i];
563 if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
565 error = clib_error_create
566 ("node `%v' refers to unknown node `%s'", n->name, a);
571 vec_free (n->next_node_names);
574 /* Set previous node pointers. */
575 for (ni = 0; ni < vec_len (nm->nodes); ni++)
580 n = vec_elt (nm->nodes, ni);
582 for (i = 0; i < vec_len (n->next_nodes); i++)
584 if (n->next_nodes[i] >= vec_len (nm->nodes))
587 n_next = vec_elt (nm->nodes, n->next_nodes[i]);
588 n_next->prev_node_bitmap =
589 clib_bitmap_ori (n_next->prev_node_bitmap, n->index);
594 vlib_next_frame_t *nf;
595 vlib_node_runtime_t *r;
599 vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
601 if (r->n_next_nodes == 0)
604 n = vlib_get_node (vm, r->node_index);
605 nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
607 for (i = 0; i < vec_len (n->next_nodes); i++)
609 next = vlib_get_node (vm, n->next_nodes[i]);
611 /* Validate node runtime indices are correctly initialized. */
612 ASSERT (nf[i].node_runtime_index == next->runtime_index);
615 if (next->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH)
616 nf[i].flags |= VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
626 * fd.io coding-style-patch-verification: ON
629 * eval: (c-set-style "gnu")