blob: 3c96d9d2a047b47e9d1e2eda6ca4a1b890f3a335 [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15/*
16 * node.c: VLIB processing nodes
17 *
18 * Copyright (c) 2008 Eliot Dresselhaus
19 *
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:
27 *
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
30 *
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.
38 */
39
40#include <vlib/vlib.h>
41#include <vlib/threads.h>
42
43/* Query node given name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -040044vlib_node_t *
45vlib_get_node_by_name (vlib_main_t * vm, u8 * name)
Ed Warnickecb9cada2015-12-08 15:45:58 -070046{
Dave Barach9b8ffd92016-07-08 08:13:45 -040047 vlib_node_main_t *nm = &vm->node_main;
48 uword *p;
49 u8 *key = name;
Nathan Skrzypczak4b2946a2020-09-03 11:37:56 +020050 key = format (0, "%s", key);
Ed Warnickecb9cada2015-12-08 15:45:58 -070051 p = hash_get (nm->node_by_name, key);
52 if (key != name)
53 vec_free (key);
54 return p ? vec_elt (nm->nodes, p[0]) : 0;
55}
56
Dave Barach9b8ffd92016-07-08 08:13:45 -040057static void
58node_set_elog_name (vlib_main_t * vm, uword node_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -070059{
Dave Barach9b8ffd92016-07-08 08:13:45 -040060 vlib_node_t *n = vlib_get_node (vm, node_index);
61 elog_event_type_t *t;
Ed Warnickecb9cada2015-12-08 15:45:58 -070062
63 t = vec_elt_at_index (vm->node_call_elog_event_types, node_index);
64 vec_free (t->format);
Dave Barachfb6e59d2016-03-26 18:45:42 -040065 t->format = (char *) format (0, "%v-call: %%d%c", n->name, 0);
Ed Warnickecb9cada2015-12-08 15:45:58 -070066
67 t = vec_elt_at_index (vm->node_return_elog_event_types, node_index);
68 vec_free (t->format);
Dave Barachfb6e59d2016-03-26 18:45:42 -040069 t->format = (char *) format (0, "%v-return: %%d%c", n->name, 0);
Ed Warnickecb9cada2015-12-08 15:45:58 -070070
Dave Barach9b8ffd92016-07-08 08:13:45 -040071 n->name_elog_string = elog_string (&vm->elog_main, "%v%c", n->name, 0);
Ed Warnickecb9cada2015-12-08 15:45:58 -070072}
73
Dave Barach9b8ffd92016-07-08 08:13:45 -040074void
75vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...)
Ed Warnickecb9cada2015-12-08 15:45:58 -070076{
77 va_list va;
Dave Barach9b8ffd92016-07-08 08:13:45 -040078 vlib_node_main_t *nm = &vm->node_main;
79 vlib_node_t *n = vlib_get_node (vm, node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -070080
81 va_start (va, fmt);
82 hash_unset (nm->node_by_name, n->name);
83 vec_free (n->name);
84 n->name = va_format (0, fmt, &va);
85 va_end (va);
86 hash_set (nm->node_by_name, n->name, n->index);
87
88 node_set_elog_name (vm, node_index);
Igor Mikhailov (imichail)19e9d952017-07-03 17:01:50 -070089
90 /* Propagate the change to all worker threads */
Steven Luong1eae8ec2020-06-10 23:38:41 -070091 vlib_worker_thread_node_runtime_update ();
Ed Warnickecb9cada2015-12-08 15:45:58 -070092}
93
94static void
Dave Barach9b8ffd92016-07-08 08:13:45 -040095vlib_node_runtime_update (vlib_main_t * vm, u32 node_index, u32 next_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -070096{
Dave Barach9b8ffd92016-07-08 08:13:45 -040097 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;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700102 i32 i, j, n_insert;
103
Ed Warnickecb9cada2015-12-08 15:45:58 -0700104 node = vec_elt (nm->nodes, node_index);
105 r = vlib_node_get_runtime (vm, node_index);
106
107 n_insert = vec_len (node->next_nodes) - r->n_next_nodes;
108 if (n_insert > 0)
109 {
110 i = r->next_frame_index + r->n_next_nodes;
111 vec_insert (nm->next_frames, n_insert, i);
112
113 /* Initialize newly inserted next frames. */
114 for (j = 0; j < n_insert; j++)
115 vlib_next_frame_init (nm->next_frames + i + j);
116
117 /* Relocate other next frames at higher indices. */
118 for (j = 0; j < vec_len (nm->nodes); j++)
119 {
120 s = vlib_node_get_runtime (vm, j);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400121 if (j != node_index && s->next_frame_index >= i)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700122 s->next_frame_index += n_insert;
123 }
124
125 /* Pending frames may need to be relocated also. */
126 vec_foreach (pf, nm->pending_frames)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400127 {
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;
131 }
132 /* *INDENT-OFF* */
Damjan Marionb2c31b62020-12-13 21:47:40 +0100133 pool_foreach (pf, nm->suspended_process_frames) {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700134 if (pf->next_frame_index != ~0 && pf->next_frame_index >= i)
135 pf->next_frame_index += n_insert;
Damjan Marionb2c31b62020-12-13 21:47:40 +0100136 }
Dave Barach9b8ffd92016-07-08 08:13:45 -0400137 /* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700138
139 r->n_next_nodes = vec_len (node->next_nodes);
140 }
141
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;
146
Dave Barach9b8ffd92016-07-08 08:13:45 -0400147 vlib_worker_thread_node_runtime_update ();
Ed Warnickecb9cada2015-12-08 15:45:58 -0700148}
149
Neale Rannsbb620d72017-06-29 00:19:08 -0700150uword
151vlib_node_get_next (vlib_main_t * vm, uword node_index, uword next_node_index)
152{
153 vlib_node_main_t *nm = &vm->node_main;
154 vlib_node_t *node;
155 uword *p;
156
157 node = vec_elt (nm->nodes, node_index);
158
159 /* Runtime has to be initialized. */
160 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
161
162 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
163 {
164 return p[0];
165 }
166
167 return (~0);
168}
169
Ed Warnickecb9cada2015-12-08 15:45:58 -0700170/* Add next node to given node in given slot. */
171uword
172vlib_node_add_next_with_slot (vlib_main_t * vm,
173 uword node_index,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400174 uword next_node_index, uword slot)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700175{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400176 vlib_node_main_t *nm = &vm->node_main;
Christian Hopps2e8b0612019-11-03 00:59:49 -0400177 vlib_node_t *node, *next, *old_next;
178 u32 old_next_index;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400179 uword *p;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700180
Christian E. Hoppsd3122ef2019-09-28 21:36:36 -0400181 ASSERT (vlib_get_thread_index () == 0);
182
Ed Warnickecb9cada2015-12-08 15:45:58 -0700183 node = vec_elt (nm->nodes, node_index);
184 next = vec_elt (nm->nodes, next_node_index);
185
Ole Troan964f93e2016-06-10 13:22:36 +0200186 /* Runtime has to be initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400187 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700188
189 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
190 {
John Lo405e41b2016-04-23 15:14:12 -0400191 /* Next already exists: slot must match. */
192 if (slot != ~0)
193 ASSERT (slot == p[0]);
194 return p[0];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700195 }
196
Christian E. Hoppsd3122ef2019-09-28 21:36:36 -0400197 vlib_worker_thread_barrier_sync (vm);
198
Ed Warnickecb9cada2015-12-08 15:45:58 -0700199 if (slot == ~0)
200 slot = vec_len (node->next_nodes);
201
202 vec_validate_init_empty (node->next_nodes, slot, ~0);
203 vec_validate (node->n_vectors_by_next_node, slot);
204
Christian Hopps2e8b0612019-11-03 00:59:49 -0400205 if ((old_next_index = node->next_nodes[slot]) != ~0u)
206 {
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);
211 }
212
Ed Warnickecb9cada2015-12-08 15:45:58 -0700213 node->next_nodes[slot] = next_node_index;
John Lo405e41b2016-04-23 15:14:12 -0400214 hash_set (node->next_slot_by_node, next_node_index, slot);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700215
216 vlib_node_runtime_update (vm, node_index, slot);
217
218 next->prev_node_bitmap = clib_bitmap_ori (next->prev_node_bitmap,
219 node_index);
220
221 /* Siblings all get same node structure. */
222 {
223 uword sib_node_index, sib_slot;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400224 vlib_node_t *sib_node;
225 /* *INDENT-OFF* */
Damjan Marionf0ca1e82020-12-13 23:26:56 +0100226 clib_bitmap_foreach (sib_node_index, node->sibling_bitmap) {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700227 sib_node = vec_elt (nm->nodes, sib_node_index);
228 if (sib_node != node)
229 {
230 sib_slot = vlib_node_add_next_with_slot (vm, sib_node_index, next_node_index, slot);
231 ASSERT (sib_slot == slot);
232 }
Damjan Marionf0ca1e82020-12-13 23:26:56 +0100233 }
Dave Barach9b8ffd92016-07-08 08:13:45 -0400234 /* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700235 }
236
Christian E. Hoppsd3122ef2019-09-28 21:36:36 -0400237 vlib_worker_thread_barrier_release (vm);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700238 return slot;
239}
240
241/* Add named next node to given node in given slot. */
242uword
243vlib_node_add_named_next_with_slot (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400244 uword node, char *name, uword slot)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700245{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400246 vlib_node_main_t *nm;
247 vlib_node_t *n, *n_next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700248
249 nm = &vm->node_main;
250 n = vlib_get_node (vm, node);
251
252 n_next = vlib_get_node_by_name (vm, (u8 *) name);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400253 if (!n_next)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700254 {
255 if (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED)
256 return ~0;
257
258 if (slot == ~0)
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;
263 return slot;
264 }
265
266 return vlib_node_add_next_with_slot (vm, node, n_next->index, slot);
267}
268
Dave Barach9b8ffd92016-07-08 08:13:45 -0400269static void
270node_elog_init (vlib_main_t * vm, uword ni)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700271{
272 elog_event_type_t t;
273
Dave Barachb7b92992018-10-17 10:38:51 -0400274 clib_memset (&t, 0, sizeof (t));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700275
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;
280
281 vec_validate (vm->node_return_elog_event_types, ni);
282 vm->node_return_elog_event_types[ni] = t;
283
284 node_set_elog_name (vm, ni);
285}
286
287#ifdef CLIB_UNIX
Dave Barachbfdedbd2016-01-20 09:11:55 -0500288#define STACK_ALIGN (clib_mem_get_page_size())
Ed Warnickecb9cada2015-12-08 15:45:58 -0700289#else
290#define STACK_ALIGN CLIB_CACHE_LINE_BYTES
291#endif
292
Damjan Mariona31698b2021-03-10 14:35:28 +0100293vlib_node_function_t *
294vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
295 vlib_node_fn_registration_t *regs)
296{
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;
301 int priority = -1;
302
303 if (nm->node_fn_default_march_variant != ~0)
304 {
305 r = regs;
306 while (r)
307 {
308 if (r->march_variant == nm->node_fn_default_march_variant)
309 return r->function;
310 r = r->next_registration;
311 }
312 }
313
314 r = regs;
315 while (r)
316 {
317 v = vec_elt_at_index (nm->variants, r->march_variant);
318 if (v->priority > priority)
319 {
320 priority = v->priority;
321 fn = r->function;
322 }
323 r = r->next_registration;
324 }
325
326 ASSERT (fn);
327 return fn;
328}
329
Dave Barach9b8ffd92016-07-08 08:13:45 -0400330static void
331register_node (vlib_main_t * vm, vlib_node_registration_t * r)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700332{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400333 vlib_node_main_t *nm = &vm->node_main;
334 vlib_node_t *n;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700335 int i;
336
337 if (CLIB_DEBUG > 0)
338 {
339 /* Default (0) type should match INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400340 vlib_node_t zero = { 0 };
Ed Warnickecb9cada2015-12-08 15:45:58 -0700341 ASSERT (VLIB_NODE_TYPE_INTERNAL == zero.type);
342 }
343
Damjan Marion812b32d2018-05-28 21:26:47 +0200344 if (r->node_fn_registrations)
345 {
Damjan Marion812b32d2018-05-28 21:26:47 +0200346 /* to avoid confusion, please remove ".function " statiement from
347 CLIB_NODE_REGISTRATION() if using function function candidates */
348 ASSERT (r->function == 0);
349
Damjan Mariona31698b2021-03-10 14:35:28 +0100350 r->function =
351 vlib_node_get_preferred_node_fn_variant (vm, r->node_fn_registrations);
Damjan Marion812b32d2018-05-28 21:26:47 +0200352 }
353
Ed Warnickecb9cada2015-12-08 15:45:58 -0700354 ASSERT (r->function != 0);
355
356 n = clib_mem_alloc_no_fail (sizeof (n[0]));
Dave Barachb7b92992018-10-17 10:38:51 -0400357 clib_memset (n, 0, sizeof (n[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700358 n->index = vec_len (nm->nodes);
Damjan Marion69abe442018-08-27 22:43:23 +0200359 n->node_fn_registrations = r->node_fn_registrations;
Dave Barach7fff3d22018-11-27 16:52:59 -0500360 n->protocol_hint = r->protocol_hint;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700361
362 vec_add1 (nm->nodes, n);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400363
Ed Warnickecb9cada2015-12-08 15:45:58 -0700364 /* 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);
367 else
368 n->name = format (0, "%s", r->name);
369
Dave Barach9b8ffd92016-07-08 08:13:45 -0400370 if (!nm->node_by_name)
371 nm->node_by_name = hash_create_vec ( /* size */ 32,
372 sizeof (n->name[0]), sizeof (uword));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700373
374 /* Node names must be unique. */
375 {
Benoît Ganne268e3b62020-09-10 14:12:06 +0200376 /* 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);
379 vec_free (name);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700380 if (o)
381 clib_error ("more than one node named `%v'", n->name);
382 }
383
384 hash_set (nm->node_by_name, n->name, n->index);
385
386 r->index = n->index; /* save index in registration */
387 n->function = r->function;
388
389 /* Node index of next sibling will be filled in by vlib_node_main_init. */
390 n->sibling_of = r->sibling_of;
Ole Troan964f93e2016-06-10 13:22:36 +0200391 if (r->sibling_of && r->n_next_nodes > 0)
392 clib_error ("sibling node should not have any next nodes `%v'", n->name);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700393
394 if (r->type == VLIB_NODE_TYPE_INTERNAL)
395 ASSERT (r->vector_size > 0);
396
397#define _(f) n->f = r->f
398
Dave Barach9b8ffd92016-07-08 08:13:45 -0400399 _(type);
400 _(flags);
401 _(state);
402 _(scalar_size);
403 _(vector_size);
404 _(format_buffer);
405 _(unformat_buffer);
406 _(format_trace);
407 _(validate_frame);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700408
409 /* Register error counters. */
Ole Troan148c7b72020-10-07 18:05:37 +0200410 vlib_register_errors (vm, n->index, r->n_errors, r->error_strings,
411 r->error_counters);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700412 node_elog_init (vm, n->index);
413
Dave Barach9b8ffd92016-07-08 08:13:45 -0400414 _(runtime_data_bytes);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700415 if (r->runtime_data_bytes > 0)
416 {
417 vec_resize (n->runtime_data, r->runtime_data_bytes);
418 if (r->runtime_data)
Damjan Marionf1213b82016-03-13 02:22:06 +0100419 clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700420 }
421
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];
425
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);
428
429 n->owner_node_index = n->owner_next_index = ~0;
430
431 /* Initialize node runtime. */
432 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400433 vlib_node_runtime_t *rt;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700434 u32 i;
435
436 if (n->type == VLIB_NODE_TYPE_PROCESS)
437 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400438 vlib_process_t *p;
Damjan Marionfc639ff2020-09-11 22:25:34 +0200439 uword log2_n_stack_bytes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700440
Damjan Marionef587582020-05-20 22:01:44 +0200441 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,
Damjan Marionfc639ff2020-09-11 22:25:34 +0200444 clib_mem_get_log2_page_size ());
Ed Warnickecb9cada2015-12-08 15:45:58 -0700445
Damjan Marionef587582020-05-20 22:01:44 +0200446 p = clib_mem_alloc_aligned (sizeof (p[0]), CLIB_CACHE_LINE_BYTES);
Dave Barachb7b92992018-10-17 10:38:51 -0400447 clib_memset (p, 0, sizeof (p[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700448 p->log2_n_stack_bytes = log2_n_stack_bytes;
449
Damjan Marionfc639ff2020-09-11 22:25:34 +0200450 p->stack = clib_mem_vm_map_stack (1ULL << log2_n_stack_bytes,
451 CLIB_MEM_PAGE_SZ_DEFAULT,
452 "process stack: %U",
453 format_vlib_node_name, vm,
454 n->index);
Damjan Marionef587582020-05-20 22:01:44 +0200455
Damjan Marionfc639ff2020-09-11 22:25:34 +0200456 if (p->stack == CLIB_MEM_VM_MAP_FAILED)
Damjan Marionef587582020-05-20 22:01:44 +0200457 clib_panic ("failed to allocate process stack (%d bytes)",
Damjan Marionfc639ff2020-09-11 22:25:34 +0200458 1ULL << log2_n_stack_bytes);
Damjan Marionef587582020-05-20 22:01:44 +0200459
Ed Warnickecb9cada2015-12-08 15:45:58 -0700460 /* Process node's runtime index is really index into process
461 pointer vector. */
462 n->runtime_index = vec_len (nm->processes);
463
464 vec_add1 (nm->processes, p);
465
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;
469
470 /* Node runtime is stored inside of process. */
471 rt = &p->node_runtime;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700472 }
473 else
474 {
475 vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
476 /* align */ CLIB_CACHE_LINE_BYTES);
Damjan Marion94100532020-11-06 23:25:57 +0100477 if (n->type == VLIB_NODE_TYPE_INPUT)
478 clib_interrupt_resize (&nm->interrupts,
479 vec_len (nm->nodes_by_type[n->type]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700480 n->runtime_index = rt - nm->nodes_by_type[n->type];
481 }
482
483 if (n->type == VLIB_NODE_TYPE_INPUT)
484 nm->input_node_counts_by_state[n->state] += 1;
485
486 rt->function = n->function;
487 rt->flags = n->flags;
488 rt->state = n->state;
489 rt->node_index = n->index;
490
491 rt->n_next_nodes = r->n_next_nodes;
492 rt->next_frame_index = vec_len (nm->next_frames);
493
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);
497
498 vec_resize (rt->errors, r->n_errors);
499 for (i = 0; i < vec_len (rt->errors); i++)
Dave Barach687c9022019-07-23 10:22:31 -0400500 rt->errors[i] = n->error_heap_index + i;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700501
Christophe Fontaine33e81952016-12-19 14:41:52 +0100502 STATIC_ASSERT_SIZEOF (vlib_node_runtime_t, 128);
Damjan Marione9f929b2017-03-16 11:32:09 +0100503 ASSERT (vec_len (n->runtime_data) <= VLIB_NODE_RUNTIME_DATA_SIZE);
Damjan Marioneb90b7f2016-11-01 01:26:01 +0100504
Ed Warnickecb9cada2015-12-08 15:45:58 -0700505 if (vec_len (n->runtime_data) > 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400506 clib_memcpy (rt->runtime_data, n->runtime_data,
507 vec_len (n->runtime_data));
Mohammed Hawarie848c8f2020-12-21 18:19:46 +0100508 else
509 clib_memset (rt->runtime_data, 0, VLIB_NODE_RUNTIME_DATA_SIZE);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700510
511 vec_free (n->runtime_data);
512 }
Damjan Mariona31698b2021-03-10 14:35:28 +0100513#undef _
Ed Warnickecb9cada2015-12-08 15:45:58 -0700514}
515
516/* Register new packet processing node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400517u32
518vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700519{
520 register_node (vm, r);
521 return r->index;
522}
523
Damjan Mariond4798a32016-09-06 22:26:03 +0200524static uword
525null_node_fn (vlib_main_t * vm,
526 vlib_node_runtime_t * node, vlib_frame_t * frame)
527{
528 u16 n_vectors = frame->n_vectors;
529
530 vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
Damjan Mariona3d59862018-11-10 10:23:00 +0100531 vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_vectors);
Damjan Mariond4798a32016-09-06 22:26:03 +0200532 vlib_frame_free (vm, node, frame);
533
534 return n_vectors;
535}
536
Dave Barach9b8ffd92016-07-08 08:13:45 -0400537void
Damjan Mariona31698b2021-03-10 14:35:28 +0100538vlib_register_all_node_march_variants (vlib_main_t *vm)
539{
540 vlib_node_main_t *nm = &vm->node_main;
541 vlib_node_fn_variant_t *v;
542 int prio = -1;
543
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;
549
550#define _(s, n) \
551 vec_add2 (nm->variants, v, 1); \
552 v->suffix = #s; \
553 v->index = CLIB_MARCH_VARIANT_TYPE_##s; \
554 v->priority = clib_cpu_march_priority_##s (); \
555 v->desc = n;
556
557 foreach_march_variant;
558#undef _
559
560 nm->node_fn_march_variant_by_suffix = hash_create_string (0, sizeof (u32));
561
562 vec_foreach (v, nm->variants)
563 {
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)
567 prio = v->priority;
568 }
569}
570
571void
Dave Barach9b8ffd92016-07-08 08:13:45 -0400572vlib_register_all_static_nodes (vlib_main_t * vm)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700573{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400574 vlib_node_registration_t *r;
575
Damjan Mariond4798a32016-09-06 22:26:03 +0200576 static char *null_node_error_strings[] = {
577 "blackholed packets",
578 };
579
580 static vlib_node_registration_t null_node_reg = {
581 .function = null_node_fn,
582 .vector_size = sizeof (u32),
583 .name = "null-node",
584 .n_errors = 1,
585 .error_strings = null_node_error_strings,
586 };
587
588 /* make sure that node index 0 is not used by
589 real node */
590 register_node (vm, &null_node_reg);
591
Ed Warnickecb9cada2015-12-08 15:45:58 -0700592 r = vm->node_main.node_registrations;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400593 while (r)
594 {
595 register_node (vm, r);
596 r = r->next_registration;
597 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700598}
599
Dave Barach1ddbc012018-06-13 09:26:05 -0400600void
601vlib_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)
Florin Corase86a8ed2018-01-05 03:20:25 -0800604{
605 vlib_node_main_t *nm = &vm->node_main;
606 vlib_node_t *n;
Dave Barach1ddbc012018-06-13 09:26:05 -0400607 vlib_node_t ***node_dups = *node_dupsp;
Florin Corase86a8ed2018-01-05 03:20:25 -0800608 vlib_node_t **nodes;
Dave Barach1ddbc012018-06-13 09:26:05 -0400609 vlib_main_t **stat_vms = *stat_vmsp;
Florin Corase86a8ed2018-01-05 03:20:25 -0800610 vlib_main_t *stat_vm;
611 uword i, j;
612 u32 threads_to_serialize;
613
Florin Corase86a8ed2018-01-05 03:20:25 -0800614 if (vec_len (stat_vms) == 0)
615 {
Damjan Marion6ffb7c62021-03-26 13:06:13 +0100616 for (i = 0; i < vlib_get_n_threads (); i++)
Florin Corase86a8ed2018-01-05 03:20:25 -0800617 {
Damjan Marion6ffb7c62021-03-26 13:06:13 +0100618 stat_vm = vlib_get_main_by_index (i);
Florin Corase86a8ed2018-01-05 03:20:25 -0800619 if (stat_vm)
620 vec_add1 (stat_vms, stat_vm);
621 }
622 }
623
624 threads_to_serialize = clib_min (max_threads, vec_len (stat_vms));
625
Dave Barach1ddbc012018-06-13 09:26:05 -0400626 vec_validate (node_dups, threads_to_serialize - 1);
627
Florin Corase86a8ed2018-01-05 03:20:25 -0800628 /*
629 * Barrier sync across stats scraping.
630 * Otherwise, the counts will be grossly inaccurate.
631 */
Dave Barach1ddbc012018-06-13 09:26:05 -0400632 if (barrier_sync)
633 vlib_worker_thread_barrier_sync (vm);
Florin Corase86a8ed2018-01-05 03:20:25 -0800634
635 for (j = 0; j < threads_to_serialize; j++)
636 {
637 stat_vm = stat_vms[j];
638 nm = &stat_vm->node_main;
639
640 if (include_stats)
641 {
642 for (i = 0; i < vec_len (nm->nodes); i++)
643 {
644 n = nm->nodes[i];
645 vlib_node_sync_stats (stat_vm, n);
646 }
647 }
648
Dave Barach1ddbc012018-06-13 09:26:05 -0400649 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;
Florin Corase86a8ed2018-01-05 03:20:25 -0800653 }
Florin Corase86a8ed2018-01-05 03:20:25 -0800654
Dave Barach1ddbc012018-06-13 09:26:05 -0400655 if (barrier_sync)
656 vlib_worker_thread_barrier_release (vm);
657
658 *node_dupsp = node_dups;
659 *stat_vmsp = stat_vms;
Florin Corase86a8ed2018-01-05 03:20:25 -0800660}
661
Ed Warnickecb9cada2015-12-08 15:45:58 -0700662clib_error_t *
663vlib_node_main_init (vlib_main_t * vm)
664{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400665 vlib_node_main_t *nm = &vm->node_main;
666 clib_error_t *error = 0;
667 vlib_node_t *n;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700668 uword ni;
669
Dave Barach593eedf2019-03-10 09:44:51 -0400670 nm->frame_sizes = vec_new (vlib_frame_size_t, 1);
671#ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
Florin Coras93992a92017-05-24 18:03:56 -0700672 nm->frame_size_hash = hash_create (0, sizeof (uword));
Dave Barach593eedf2019-03-10 09:44:51 -0400673#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700674 nm->flags |= VLIB_NODE_MAIN_RUNTIME_STARTED;
675
Ole Troan964f93e2016-06-10 13:22:36 +0200676 /* Generate sibling relationships */
677 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400678 vlib_node_t *n, *sib;
Ole Troan964f93e2016-06-10 13:22:36 +0200679 uword si;
680
681 for (ni = 0; ni < vec_len (nm->nodes); ni++)
682 {
683 n = vec_elt (nm->nodes, ni);
684
Dave Barach9b8ffd92016-07-08 08:13:45 -0400685 if (!n->sibling_of)
Ole Troan964f93e2016-06-10 13:22:36 +0200686 continue;
687
688 sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400689 if (!sib)
Ed Warnicke853e7202016-08-12 11:42:26 -0700690 {
691 error = clib_error_create ("sibling `%s' not found for node `%v'",
692 n->sibling_of, n->name);
693 goto done;
694 }
Ole Troan964f93e2016-06-10 13:22:36 +0200695
Dave Barach9b8ffd92016-07-08 08:13:45 -0400696 /* *INDENT-OFF* */
Damjan Marionf0ca1e82020-12-13 23:26:56 +0100697 clib_bitmap_foreach (si, sib->sibling_bitmap) {
Ole Troan964f93e2016-06-10 13:22:36 +0200698 vlib_node_t * m = vec_elt (nm->nodes, si);
699
700 /* Connect all of sibling's siblings to us. */
701 m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
702
703 /* Connect us to all of sibling's siblings. */
704 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
Damjan Marionf0ca1e82020-12-13 23:26:56 +0100705 }
Dave Barach9b8ffd92016-07-08 08:13:45 -0400706 /* *INDENT-ON* */
Ole Troan964f93e2016-06-10 13:22:36 +0200707
708 /* Connect sibling to us. */
709 sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
710
711 /* Connect us to sibling. */
712 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
713 }
714 }
715
Ed Warnickecb9cada2015-12-08 15:45:58 -0700716 /* Resolve next names into next indices. */
717 for (ni = 0; ni < vec_len (nm->nodes); ni++)
718 {
719 uword i;
720
721 n = vec_elt (nm->nodes, ni);
722
723 for (i = 0; i < vec_len (n->next_node_names); i++)
724 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400725 char *a = n->next_node_names[i];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700726
Dave Barach9b8ffd92016-07-08 08:13:45 -0400727 if (!a)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700728 continue;
729
730 if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
731 {
732 error = clib_error_create
733 ("node `%v' refers to unknown node `%s'", n->name, a);
734 goto done;
735 }
736 }
737
738 vec_free (n->next_node_names);
739 }
740
741 /* Set previous node pointers. */
742 for (ni = 0; ni < vec_len (nm->nodes); ni++)
743 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400744 vlib_node_t *n_next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700745 uword i;
746
747 n = vec_elt (nm->nodes, ni);
748
749 for (i = 0; i < vec_len (n->next_nodes); i++)
750 {
751 if (n->next_nodes[i] >= vec_len (nm->nodes))
752 continue;
753
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);
757 }
758 }
759
760 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400761 vlib_next_frame_t *nf;
762 vlib_node_runtime_t *r;
763 vlib_node_t *next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700764 uword i;
765
766 vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
Dave Barach9b8ffd92016-07-08 08:13:45 -0400767 {
768 if (r->n_next_nodes == 0)
769 continue;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700770
Dave Barach9b8ffd92016-07-08 08:13:45 -0400771 n = vlib_get_node (vm, r->node_index);
772 nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700773
Dave Barach9b8ffd92016-07-08 08:13:45 -0400774 for (i = 0; i < vec_len (n->next_nodes); i++)
775 {
776 next = vlib_get_node (vm, n->next_nodes[i]);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700777
Dave Barach9b8ffd92016-07-08 08:13:45 -0400778 /* Validate node runtime indices are correctly initialized. */
779 ASSERT (nf[i].node_runtime_index == next->runtime_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700780
Dave Barach9b8ffd92016-07-08 08:13:45 -0400781 nf[i].flags = 0;
782 if (next->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH)
783 nf[i].flags |= VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
784 }
785 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700786 }
787
Dave Barach9b8ffd92016-07-08 08:13:45 -0400788done:
Ed Warnickecb9cada2015-12-08 15:45:58 -0700789 return error;
790}
Dave Barach9b8ffd92016-07-08 08:13:45 -0400791
Dave Barach11965c72019-05-28 16:31:05 -0400792u32
793vlib_process_create (vlib_main_t * vm, char *name,
794 vlib_node_function_t * f, u32 log2_n_stack_bytes)
795{
796 vlib_node_registration_t r;
797 vlib_node_t *n;
798
799 memset (&r, 0, sizeof (r));
800
801 r.name = (char *) format (0, "%s", name, 0);
802 r.function = f;
803 r.process_log2_n_stack_bytes = log2_n_stack_bytes;
804 r.type = VLIB_NODE_TYPE_PROCESS;
805
806 vlib_worker_thread_barrier_sync (vm);
807
808 vlib_register_node (vm, &r);
809 vec_free (r.name);
810
811 vlib_worker_thread_node_runtime_update ();
812 vlib_worker_thread_barrier_release (vm);
813
814 n = vlib_get_node (vm, r.index);
815 vlib_start_process (vm, n->runtime_index);
816
817 return (r.index);
818}
819
Damjan Mariona31698b2021-03-10 14:35:28 +0100820int
821vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
822 clib_march_variant_type_t march_variant)
823{
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);
827
828 if (n->node_fn_registrations == 0)
829 return -1;
830
831 fnr = n->node_fn_registrations;
832 v = vec_elt_at_index (vm->node_main.variants, march_variant);
833
834 while (fnr)
835 {
836 if (fnr->march_variant == v->index)
837 {
838 n->function = fnr->function;
839
Damjan Marion6ffb7c62021-03-26 13:06:13 +0100840 for (int i = 0; i < vlib_get_n_threads (); i++)
Damjan Mariona31698b2021-03-10 14:35:28 +0100841 {
842 vlib_node_runtime_t *nrt;
Damjan Marion6ffb7c62021-03-26 13:06:13 +0100843 nrt =
844 vlib_node_get_runtime (vlib_get_main_by_index (i), n->index);
Damjan Mariona31698b2021-03-10 14:35:28 +0100845 nrt->function = fnr->function;
846 }
847 return 0;
848 }
849 fnr = fnr->next_registration;
850 }
851 return -1;
852}
Dave Barach9b8ffd92016-07-08 08:13:45 -0400853/*
854 * fd.io coding-style-patch-verification: ON
855 *
856 * Local Variables:
857 * eval: (c-set-style "gnu")
858 * End:
859 */