blob: f4329e7c5035107977d971f6b94f5325e2e3c003 [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
Damjan Marionf553a2c2021-03-26 13:45:37 +010071 n->name_elog_string =
72 elog_string (&vlib_global_main.elog_main, "%v%c", n->name, 0);
Ed Warnickecb9cada2015-12-08 15:45:58 -070073}
74
Dave Barach9b8ffd92016-07-08 08:13:45 -040075void
76vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...)
Ed Warnickecb9cada2015-12-08 15:45:58 -070077{
78 va_list va;
Dave Barach9b8ffd92016-07-08 08:13:45 -040079 vlib_node_main_t *nm = &vm->node_main;
80 vlib_node_t *n = vlib_get_node (vm, node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -070081
82 va_start (va, fmt);
83 hash_unset (nm->node_by_name, n->name);
84 vec_free (n->name);
85 n->name = va_format (0, fmt, &va);
86 va_end (va);
87 hash_set (nm->node_by_name, n->name, n->index);
88
89 node_set_elog_name (vm, node_index);
Igor Mikhailov (imichail)19e9d952017-07-03 17:01:50 -070090
91 /* Propagate the change to all worker threads */
Steven Luong1eae8ec2020-06-10 23:38:41 -070092 vlib_worker_thread_node_runtime_update ();
Ed Warnickecb9cada2015-12-08 15:45:58 -070093}
94
95static void
Dave Barach9b8ffd92016-07-08 08:13:45 -040096vlib_node_runtime_update (vlib_main_t * vm, u32 node_index, u32 next_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -070097{
Dave Barach9b8ffd92016-07-08 08:13:45 -040098 vlib_node_main_t *nm = &vm->node_main;
99 vlib_node_runtime_t *r, *s;
100 vlib_node_t *node, *next_node;
101 vlib_next_frame_t *nf;
102 vlib_pending_frame_t *pf;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700103 i32 i, j, n_insert;
104
Ed Warnickecb9cada2015-12-08 15:45:58 -0700105 node = vec_elt (nm->nodes, node_index);
106 r = vlib_node_get_runtime (vm, node_index);
107
108 n_insert = vec_len (node->next_nodes) - r->n_next_nodes;
109 if (n_insert > 0)
110 {
111 i = r->next_frame_index + r->n_next_nodes;
112 vec_insert (nm->next_frames, n_insert, i);
113
114 /* Initialize newly inserted next frames. */
115 for (j = 0; j < n_insert; j++)
116 vlib_next_frame_init (nm->next_frames + i + j);
117
118 /* Relocate other next frames at higher indices. */
119 for (j = 0; j < vec_len (nm->nodes); j++)
120 {
121 s = vlib_node_get_runtime (vm, j);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400122 if (j != node_index && s->next_frame_index >= i)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700123 s->next_frame_index += n_insert;
124 }
125
126 /* Pending frames may need to be relocated also. */
127 vec_foreach (pf, nm->pending_frames)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400128 {
129 if (pf->next_frame_index != VLIB_PENDING_FRAME_NO_NEXT_FRAME
130 && pf->next_frame_index >= i)
131 pf->next_frame_index += n_insert;
132 }
133 /* *INDENT-OFF* */
Damjan Marionb2c31b62020-12-13 21:47:40 +0100134 pool_foreach (pf, nm->suspended_process_frames) {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700135 if (pf->next_frame_index != ~0 && pf->next_frame_index >= i)
136 pf->next_frame_index += n_insert;
Damjan Marionb2c31b62020-12-13 21:47:40 +0100137 }
Dave Barach9b8ffd92016-07-08 08:13:45 -0400138 /* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700139
140 r->n_next_nodes = vec_len (node->next_nodes);
141 }
142
143 /* Set frame's node runtime index. */
144 next_node = vlib_get_node (vm, node->next_nodes[next_index]);
145 nf = nm->next_frames + r->next_frame_index + next_index;
146 nf->node_runtime_index = next_node->runtime_index;
147
Dave Barach9b8ffd92016-07-08 08:13:45 -0400148 vlib_worker_thread_node_runtime_update ();
Ed Warnickecb9cada2015-12-08 15:45:58 -0700149}
150
Neale Rannsbb620d72017-06-29 00:19:08 -0700151uword
152vlib_node_get_next (vlib_main_t * vm, uword node_index, uword next_node_index)
153{
154 vlib_node_main_t *nm = &vm->node_main;
155 vlib_node_t *node;
156 uword *p;
157
158 node = vec_elt (nm->nodes, node_index);
159
160 /* Runtime has to be initialized. */
161 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
162
163 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
164 {
165 return p[0];
166 }
167
168 return (~0);
169}
170
Ed Warnickecb9cada2015-12-08 15:45:58 -0700171/* Add next node to given node in given slot. */
172uword
173vlib_node_add_next_with_slot (vlib_main_t * vm,
174 uword node_index,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400175 uword next_node_index, uword slot)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700176{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400177 vlib_node_main_t *nm = &vm->node_main;
Christian Hopps2e8b0612019-11-03 00:59:49 -0400178 vlib_node_t *node, *next, *old_next;
179 u32 old_next_index;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400180 uword *p;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700181
Christian E. Hoppsd3122ef2019-09-28 21:36:36 -0400182 ASSERT (vlib_get_thread_index () == 0);
183
Ed Warnickecb9cada2015-12-08 15:45:58 -0700184 node = vec_elt (nm->nodes, node_index);
185 next = vec_elt (nm->nodes, next_node_index);
186
Ole Troan964f93e2016-06-10 13:22:36 +0200187 /* Runtime has to be initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400188 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700189
190 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
191 {
John Lo405e41b2016-04-23 15:14:12 -0400192 /* Next already exists: slot must match. */
193 if (slot != ~0)
194 ASSERT (slot == p[0]);
195 return p[0];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700196 }
197
Christian E. Hoppsd3122ef2019-09-28 21:36:36 -0400198 vlib_worker_thread_barrier_sync (vm);
199
Ed Warnickecb9cada2015-12-08 15:45:58 -0700200 if (slot == ~0)
201 slot = vec_len (node->next_nodes);
202
203 vec_validate_init_empty (node->next_nodes, slot, ~0);
204 vec_validate (node->n_vectors_by_next_node, slot);
205
Christian Hopps2e8b0612019-11-03 00:59:49 -0400206 if ((old_next_index = node->next_nodes[slot]) != ~0u)
207 {
208 hash_unset (node->next_slot_by_node, old_next_index);
209 old_next = vlib_get_node (vm, old_next_index);
210 old_next->prev_node_bitmap =
211 clib_bitmap_andnoti (old_next->prev_node_bitmap, node_index);
212 }
213
Ed Warnickecb9cada2015-12-08 15:45:58 -0700214 node->next_nodes[slot] = next_node_index;
John Lo405e41b2016-04-23 15:14:12 -0400215 hash_set (node->next_slot_by_node, next_node_index, slot);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700216
217 vlib_node_runtime_update (vm, node_index, slot);
218
219 next->prev_node_bitmap = clib_bitmap_ori (next->prev_node_bitmap,
220 node_index);
221
222 /* Siblings all get same node structure. */
223 {
224 uword sib_node_index, sib_slot;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400225 vlib_node_t *sib_node;
226 /* *INDENT-OFF* */
Damjan Marionf0ca1e82020-12-13 23:26:56 +0100227 clib_bitmap_foreach (sib_node_index, node->sibling_bitmap) {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700228 sib_node = vec_elt (nm->nodes, sib_node_index);
229 if (sib_node != node)
230 {
231 sib_slot = vlib_node_add_next_with_slot (vm, sib_node_index, next_node_index, slot);
232 ASSERT (sib_slot == slot);
233 }
Damjan Marionf0ca1e82020-12-13 23:26:56 +0100234 }
Dave Barach9b8ffd92016-07-08 08:13:45 -0400235 /* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700236 }
237
Christian E. Hoppsd3122ef2019-09-28 21:36:36 -0400238 vlib_worker_thread_barrier_release (vm);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700239 return slot;
240}
241
242/* Add named next node to given node in given slot. */
243uword
244vlib_node_add_named_next_with_slot (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400245 uword node, char *name, uword slot)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700246{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400247 vlib_node_main_t *nm;
248 vlib_node_t *n, *n_next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700249
250 nm = &vm->node_main;
251 n = vlib_get_node (vm, node);
252
253 n_next = vlib_get_node_by_name (vm, (u8 *) name);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400254 if (!n_next)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700255 {
256 if (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED)
257 return ~0;
258
259 if (slot == ~0)
260 slot = clib_max (vec_len (n->next_node_names),
261 vec_len (n->next_nodes));
262 vec_validate (n->next_node_names, slot);
263 n->next_node_names[slot] = name;
264 return slot;
265 }
266
267 return vlib_node_add_next_with_slot (vm, node, n_next->index, slot);
268}
269
Dave Barach9b8ffd92016-07-08 08:13:45 -0400270static void
271node_elog_init (vlib_main_t * vm, uword ni)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700272{
273 elog_event_type_t t;
274
Dave Barachb7b92992018-10-17 10:38:51 -0400275 clib_memset (&t, 0, sizeof (t));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700276
277 /* 2 event types for this node: one when node function is called.
278 One when it returns. */
279 vec_validate (vm->node_call_elog_event_types, ni);
280 vm->node_call_elog_event_types[ni] = t;
281
282 vec_validate (vm->node_return_elog_event_types, ni);
283 vm->node_return_elog_event_types[ni] = t;
284
285 node_set_elog_name (vm, ni);
286}
287
288#ifdef CLIB_UNIX
Dave Barachbfdedbd2016-01-20 09:11:55 -0500289#define STACK_ALIGN (clib_mem_get_page_size())
Ed Warnickecb9cada2015-12-08 15:45:58 -0700290#else
291#define STACK_ALIGN CLIB_CACHE_LINE_BYTES
292#endif
293
Damjan Mariona31698b2021-03-10 14:35:28 +0100294vlib_node_function_t *
295vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
296 vlib_node_fn_registration_t *regs)
297{
298 vlib_node_main_t *nm = &vm->node_main;
299 vlib_node_fn_registration_t *r;
300 vlib_node_fn_variant_t *v;
301 vlib_node_function_t *fn = 0;
302 int priority = -1;
303
304 if (nm->node_fn_default_march_variant != ~0)
305 {
306 r = regs;
307 while (r)
308 {
309 if (r->march_variant == nm->node_fn_default_march_variant)
310 return r->function;
311 r = r->next_registration;
312 }
313 }
314
315 r = regs;
316 while (r)
317 {
318 v = vec_elt_at_index (nm->variants, r->march_variant);
319 if (v->priority > priority)
320 {
321 priority = v->priority;
322 fn = r->function;
323 }
324 r = r->next_registration;
325 }
326
327 ASSERT (fn);
328 return fn;
329}
330
Dave Barach9b8ffd92016-07-08 08:13:45 -0400331static void
332register_node (vlib_main_t * vm, vlib_node_registration_t * r)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700333{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400334 vlib_node_main_t *nm = &vm->node_main;
335 vlib_node_t *n;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700336 int i;
337
338 if (CLIB_DEBUG > 0)
339 {
340 /* Default (0) type should match INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400341 vlib_node_t zero = { 0 };
Ed Warnickecb9cada2015-12-08 15:45:58 -0700342 ASSERT (VLIB_NODE_TYPE_INTERNAL == zero.type);
343 }
344
Damjan Marion812b32d2018-05-28 21:26:47 +0200345 if (r->node_fn_registrations)
346 {
Damjan Marion812b32d2018-05-28 21:26:47 +0200347 /* to avoid confusion, please remove ".function " statiement from
348 CLIB_NODE_REGISTRATION() if using function function candidates */
349 ASSERT (r->function == 0);
350
Damjan Mariona31698b2021-03-10 14:35:28 +0100351 r->function =
352 vlib_node_get_preferred_node_fn_variant (vm, r->node_fn_registrations);
Damjan Marion812b32d2018-05-28 21:26:47 +0200353 }
354
Ed Warnickecb9cada2015-12-08 15:45:58 -0700355 ASSERT (r->function != 0);
356
357 n = clib_mem_alloc_no_fail (sizeof (n[0]));
Dave Barachb7b92992018-10-17 10:38:51 -0400358 clib_memset (n, 0, sizeof (n[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700359 n->index = vec_len (nm->nodes);
Damjan Marion69abe442018-08-27 22:43:23 +0200360 n->node_fn_registrations = r->node_fn_registrations;
Dave Barach7fff3d22018-11-27 16:52:59 -0500361 n->protocol_hint = r->protocol_hint;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700362
363 vec_add1 (nm->nodes, n);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400364
Ed Warnickecb9cada2015-12-08 15:45:58 -0700365 /* Name is always a vector so it can be formatted with %v. */
366 if (clib_mem_is_heap_object (vec_header (r->name, 0)))
367 n->name = vec_dup ((u8 *) r->name);
368 else
369 n->name = format (0, "%s", r->name);
370
Dave Barach9b8ffd92016-07-08 08:13:45 -0400371 if (!nm->node_by_name)
372 nm->node_by_name = hash_create_vec ( /* size */ 32,
373 sizeof (n->name[0]), sizeof (uword));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700374
375 /* Node names must be unique. */
376 {
Benoît Ganne268e3b62020-09-10 14:12:06 +0200377 /* vlib_get_node_by_name() expects NULL-terminated strings */
378 u8 *name = format (0, "%v%c", n->name, 0);
379 vlib_node_t *o = vlib_get_node_by_name (vm, name);
380 vec_free (name);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700381 if (o)
382 clib_error ("more than one node named `%v'", n->name);
383 }
384
385 hash_set (nm->node_by_name, n->name, n->index);
386
387 r->index = n->index; /* save index in registration */
388 n->function = r->function;
389
390 /* Node index of next sibling will be filled in by vlib_node_main_init. */
391 n->sibling_of = r->sibling_of;
Ole Troan964f93e2016-06-10 13:22:36 +0200392 if (r->sibling_of && r->n_next_nodes > 0)
393 clib_error ("sibling node should not have any next nodes `%v'", n->name);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700394
395 if (r->type == VLIB_NODE_TYPE_INTERNAL)
396 ASSERT (r->vector_size > 0);
397
398#define _(f) n->f = r->f
399
Dave Barach9b8ffd92016-07-08 08:13:45 -0400400 _(type);
401 _(flags);
402 _(state);
403 _(scalar_size);
404 _(vector_size);
405 _(format_buffer);
406 _(unformat_buffer);
407 _(format_trace);
408 _(validate_frame);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700409
410 /* Register error counters. */
Ole Troan148c7b72020-10-07 18:05:37 +0200411 vlib_register_errors (vm, n->index, r->n_errors, r->error_strings,
412 r->error_counters);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700413 node_elog_init (vm, n->index);
414
Dave Barach9b8ffd92016-07-08 08:13:45 -0400415 _(runtime_data_bytes);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700416 if (r->runtime_data_bytes > 0)
417 {
418 vec_resize (n->runtime_data, r->runtime_data_bytes);
419 if (r->runtime_data)
Damjan Marionf1213b82016-03-13 02:22:06 +0100420 clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700421 }
422
423 vec_resize (n->next_node_names, r->n_next_nodes);
424 for (i = 0; i < r->n_next_nodes; i++)
425 n->next_node_names[i] = r->next_nodes[i];
426
427 vec_validate_init_empty (n->next_nodes, r->n_next_nodes - 1, ~0);
428 vec_validate (n->n_vectors_by_next_node, r->n_next_nodes - 1);
429
430 n->owner_node_index = n->owner_next_index = ~0;
431
432 /* Initialize node runtime. */
433 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400434 vlib_node_runtime_t *rt;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700435 u32 i;
436
437 if (n->type == VLIB_NODE_TYPE_PROCESS)
438 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400439 vlib_process_t *p;
Damjan Marionfc639ff2020-09-11 22:25:34 +0200440 uword log2_n_stack_bytes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700441
Damjan Marionef587582020-05-20 22:01:44 +0200442 log2_n_stack_bytes = clib_max (r->process_log2_n_stack_bytes,
443 VLIB_PROCESS_LOG2_STACK_SIZE);
444 log2_n_stack_bytes = clib_max (log2_n_stack_bytes,
Damjan Marionfc639ff2020-09-11 22:25:34 +0200445 clib_mem_get_log2_page_size ());
Ed Warnickecb9cada2015-12-08 15:45:58 -0700446
Damjan Marionef587582020-05-20 22:01:44 +0200447 p = clib_mem_alloc_aligned (sizeof (p[0]), CLIB_CACHE_LINE_BYTES);
Dave Barachb7b92992018-10-17 10:38:51 -0400448 clib_memset (p, 0, sizeof (p[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700449 p->log2_n_stack_bytes = log2_n_stack_bytes;
450
Damjan Marionfc639ff2020-09-11 22:25:34 +0200451 p->stack = clib_mem_vm_map_stack (1ULL << log2_n_stack_bytes,
452 CLIB_MEM_PAGE_SZ_DEFAULT,
453 "process stack: %U",
454 format_vlib_node_name, vm,
455 n->index);
Damjan Marionef587582020-05-20 22:01:44 +0200456
Damjan Marionfc639ff2020-09-11 22:25:34 +0200457 if (p->stack == CLIB_MEM_VM_MAP_FAILED)
Damjan Marionef587582020-05-20 22:01:44 +0200458 clib_panic ("failed to allocate process stack (%d bytes)",
Damjan Marionfc639ff2020-09-11 22:25:34 +0200459 1ULL << log2_n_stack_bytes);
Damjan Marionef587582020-05-20 22:01:44 +0200460
Ed Warnickecb9cada2015-12-08 15:45:58 -0700461 /* Process node's runtime index is really index into process
462 pointer vector. */
463 n->runtime_index = vec_len (nm->processes);
464
465 vec_add1 (nm->processes, p);
466
467 /* Paint first stack word with magic number so we can at least
468 detect process stack overruns. */
469 p->stack[0] = VLIB_PROCESS_STACK_MAGIC;
470
471 /* Node runtime is stored inside of process. */
472 rt = &p->node_runtime;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700473 }
474 else
475 {
476 vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
477 /* align */ CLIB_CACHE_LINE_BYTES);
Damjan Marion94100532020-11-06 23:25:57 +0100478 if (n->type == VLIB_NODE_TYPE_INPUT)
479 clib_interrupt_resize (&nm->interrupts,
480 vec_len (nm->nodes_by_type[n->type]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700481 n->runtime_index = rt - nm->nodes_by_type[n->type];
482 }
483
484 if (n->type == VLIB_NODE_TYPE_INPUT)
485 nm->input_node_counts_by_state[n->state] += 1;
486
487 rt->function = n->function;
488 rt->flags = n->flags;
489 rt->state = n->state;
490 rt->node_index = n->index;
491
492 rt->n_next_nodes = r->n_next_nodes;
493 rt->next_frame_index = vec_len (nm->next_frames);
494
495 vec_resize (nm->next_frames, rt->n_next_nodes);
496 for (i = 0; i < rt->n_next_nodes; i++)
497 vlib_next_frame_init (nm->next_frames + rt->next_frame_index + i);
498
499 vec_resize (rt->errors, r->n_errors);
500 for (i = 0; i < vec_len (rt->errors); i++)
Dave Barach687c9022019-07-23 10:22:31 -0400501 rt->errors[i] = n->error_heap_index + i;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700502
Christophe Fontaine33e81952016-12-19 14:41:52 +0100503 STATIC_ASSERT_SIZEOF (vlib_node_runtime_t, 128);
Damjan Marione9f929b2017-03-16 11:32:09 +0100504 ASSERT (vec_len (n->runtime_data) <= VLIB_NODE_RUNTIME_DATA_SIZE);
Damjan Marioneb90b7f2016-11-01 01:26:01 +0100505
Ed Warnickecb9cada2015-12-08 15:45:58 -0700506 if (vec_len (n->runtime_data) > 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400507 clib_memcpy (rt->runtime_data, n->runtime_data,
508 vec_len (n->runtime_data));
Mohammed Hawarie848c8f2020-12-21 18:19:46 +0100509 else
510 clib_memset (rt->runtime_data, 0, VLIB_NODE_RUNTIME_DATA_SIZE);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700511
512 vec_free (n->runtime_data);
513 }
Damjan Mariona31698b2021-03-10 14:35:28 +0100514#undef _
Ed Warnickecb9cada2015-12-08 15:45:58 -0700515}
516
517/* Register new packet processing node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400518u32
519vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700520{
521 register_node (vm, r);
522 return r->index;
523}
524
Damjan Mariond4798a32016-09-06 22:26:03 +0200525static uword
526null_node_fn (vlib_main_t * vm,
527 vlib_node_runtime_t * node, vlib_frame_t * frame)
528{
529 u16 n_vectors = frame->n_vectors;
530
531 vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
Damjan Mariona3d59862018-11-10 10:23:00 +0100532 vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_vectors);
Damjan Mariond4798a32016-09-06 22:26:03 +0200533 vlib_frame_free (vm, node, frame);
534
535 return n_vectors;
536}
537
Dave Barach9b8ffd92016-07-08 08:13:45 -0400538void
Damjan Mariona31698b2021-03-10 14:35:28 +0100539vlib_register_all_node_march_variants (vlib_main_t *vm)
540{
541 vlib_node_main_t *nm = &vm->node_main;
542 vlib_node_fn_variant_t *v;
543 int prio = -1;
544
545 nm->node_fn_default_march_variant = ~0;
546 ASSERT (nm->variants == 0);
547 vec_add2 (nm->variants, v, 1);
548 v->desc = v->suffix = "default";
549 v->index = CLIB_MARCH_VARIANT_TYPE;
550
551#define _(s, n) \
552 vec_add2 (nm->variants, v, 1); \
553 v->suffix = #s; \
554 v->index = CLIB_MARCH_VARIANT_TYPE_##s; \
555 v->priority = clib_cpu_march_priority_##s (); \
556 v->desc = n;
557
558 foreach_march_variant;
559#undef _
560
561 nm->node_fn_march_variant_by_suffix = hash_create_string (0, sizeof (u32));
562
563 vec_foreach (v, nm->variants)
564 {
565 ASSERT (v->index == v - nm->variants);
566 hash_set (nm->node_fn_march_variant_by_suffix, v->suffix, v->index);
567 if (v->priority > prio)
568 prio = v->priority;
569 }
570}
571
572void
Dave Barach9b8ffd92016-07-08 08:13:45 -0400573vlib_register_all_static_nodes (vlib_main_t * vm)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700574{
Damjan Marionfd8deb42021-03-06 12:26:28 +0100575 vlib_global_main_t *vgm = vlib_get_global_main ();
Dave Barach9b8ffd92016-07-08 08:13:45 -0400576 vlib_node_registration_t *r;
577
Damjan Mariond4798a32016-09-06 22:26:03 +0200578 static char *null_node_error_strings[] = {
579 "blackholed packets",
580 };
581
582 static vlib_node_registration_t null_node_reg = {
583 .function = null_node_fn,
584 .vector_size = sizeof (u32),
585 .name = "null-node",
586 .n_errors = 1,
587 .error_strings = null_node_error_strings,
588 };
589
590 /* make sure that node index 0 is not used by
591 real node */
592 register_node (vm, &null_node_reg);
593
Damjan Marionfd8deb42021-03-06 12:26:28 +0100594 r = vgm->node_registrations;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400595 while (r)
596 {
597 register_node (vm, r);
598 r = r->next_registration;
599 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700600}
601
Dave Barach1ddbc012018-06-13 09:26:05 -0400602void
603vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
604 int barrier_sync, vlib_node_t **** node_dupsp,
605 vlib_main_t *** stat_vmsp)
Florin Corase86a8ed2018-01-05 03:20:25 -0800606{
607 vlib_node_main_t *nm = &vm->node_main;
608 vlib_node_t *n;
Dave Barach1ddbc012018-06-13 09:26:05 -0400609 vlib_node_t ***node_dups = *node_dupsp;
Florin Corase86a8ed2018-01-05 03:20:25 -0800610 vlib_node_t **nodes;
Dave Barach1ddbc012018-06-13 09:26:05 -0400611 vlib_main_t **stat_vms = *stat_vmsp;
Florin Corase86a8ed2018-01-05 03:20:25 -0800612 vlib_main_t *stat_vm;
613 uword i, j;
614 u32 threads_to_serialize;
615
Florin Corase86a8ed2018-01-05 03:20:25 -0800616 if (vec_len (stat_vms) == 0)
617 {
Damjan Marion6ffb7c62021-03-26 13:06:13 +0100618 for (i = 0; i < vlib_get_n_threads (); i++)
Florin Corase86a8ed2018-01-05 03:20:25 -0800619 {
Damjan Marion6ffb7c62021-03-26 13:06:13 +0100620 stat_vm = vlib_get_main_by_index (i);
Florin Corase86a8ed2018-01-05 03:20:25 -0800621 if (stat_vm)
622 vec_add1 (stat_vms, stat_vm);
623 }
624 }
625
626 threads_to_serialize = clib_min (max_threads, vec_len (stat_vms));
627
Dave Barach1ddbc012018-06-13 09:26:05 -0400628 vec_validate (node_dups, threads_to_serialize - 1);
629
Florin Corase86a8ed2018-01-05 03:20:25 -0800630 /*
631 * Barrier sync across stats scraping.
632 * Otherwise, the counts will be grossly inaccurate.
633 */
Dave Barach1ddbc012018-06-13 09:26:05 -0400634 if (barrier_sync)
635 vlib_worker_thread_barrier_sync (vm);
Florin Corase86a8ed2018-01-05 03:20:25 -0800636
637 for (j = 0; j < threads_to_serialize; j++)
638 {
639 stat_vm = stat_vms[j];
640 nm = &stat_vm->node_main;
641
642 if (include_stats)
643 {
644 for (i = 0; i < vec_len (nm->nodes); i++)
645 {
646 n = nm->nodes[i];
647 vlib_node_sync_stats (stat_vm, n);
648 }
649 }
650
Dave Barach1ddbc012018-06-13 09:26:05 -0400651 nodes = node_dups[j];
652 vec_validate (nodes, vec_len (nm->nodes) - 1);
653 clib_memcpy (nodes, nm->nodes, vec_len (nm->nodes) * sizeof (nodes[0]));
654 node_dups[j] = nodes;
Florin Corase86a8ed2018-01-05 03:20:25 -0800655 }
Florin Corase86a8ed2018-01-05 03:20:25 -0800656
Dave Barach1ddbc012018-06-13 09:26:05 -0400657 if (barrier_sync)
658 vlib_worker_thread_barrier_release (vm);
659
660 *node_dupsp = node_dups;
661 *stat_vmsp = stat_vms;
Florin Corase86a8ed2018-01-05 03:20:25 -0800662}
663
Ed Warnickecb9cada2015-12-08 15:45:58 -0700664clib_error_t *
665vlib_node_main_init (vlib_main_t * vm)
666{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400667 vlib_node_main_t *nm = &vm->node_main;
668 clib_error_t *error = 0;
669 vlib_node_t *n;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700670 uword ni;
671
Dave Barach593eedf2019-03-10 09:44:51 -0400672 nm->frame_sizes = vec_new (vlib_frame_size_t, 1);
673#ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
Florin Coras93992a92017-05-24 18:03:56 -0700674 nm->frame_size_hash = hash_create (0, sizeof (uword));
Dave Barach593eedf2019-03-10 09:44:51 -0400675#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700676 nm->flags |= VLIB_NODE_MAIN_RUNTIME_STARTED;
677
Ole Troan964f93e2016-06-10 13:22:36 +0200678 /* Generate sibling relationships */
679 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400680 vlib_node_t *n, *sib;
Ole Troan964f93e2016-06-10 13:22:36 +0200681 uword si;
682
683 for (ni = 0; ni < vec_len (nm->nodes); ni++)
684 {
685 n = vec_elt (nm->nodes, ni);
686
Dave Barach9b8ffd92016-07-08 08:13:45 -0400687 if (!n->sibling_of)
Ole Troan964f93e2016-06-10 13:22:36 +0200688 continue;
689
690 sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400691 if (!sib)
Ed Warnicke853e7202016-08-12 11:42:26 -0700692 {
693 error = clib_error_create ("sibling `%s' not found for node `%v'",
694 n->sibling_of, n->name);
695 goto done;
696 }
Ole Troan964f93e2016-06-10 13:22:36 +0200697
Dave Barach9b8ffd92016-07-08 08:13:45 -0400698 /* *INDENT-OFF* */
Damjan Marionf0ca1e82020-12-13 23:26:56 +0100699 clib_bitmap_foreach (si, sib->sibling_bitmap) {
Ole Troan964f93e2016-06-10 13:22:36 +0200700 vlib_node_t * m = vec_elt (nm->nodes, si);
701
702 /* Connect all of sibling's siblings to us. */
703 m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
704
705 /* Connect us to all of sibling's siblings. */
706 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
Damjan Marionf0ca1e82020-12-13 23:26:56 +0100707 }
Dave Barach9b8ffd92016-07-08 08:13:45 -0400708 /* *INDENT-ON* */
Ole Troan964f93e2016-06-10 13:22:36 +0200709
710 /* Connect sibling to us. */
711 sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
712
713 /* Connect us to sibling. */
714 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
715 }
716 }
717
Ed Warnickecb9cada2015-12-08 15:45:58 -0700718 /* Resolve next names into next indices. */
719 for (ni = 0; ni < vec_len (nm->nodes); ni++)
720 {
721 uword i;
722
723 n = vec_elt (nm->nodes, ni);
724
725 for (i = 0; i < vec_len (n->next_node_names); i++)
726 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400727 char *a = n->next_node_names[i];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700728
Dave Barach9b8ffd92016-07-08 08:13:45 -0400729 if (!a)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700730 continue;
731
732 if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
733 {
734 error = clib_error_create
735 ("node `%v' refers to unknown node `%s'", n->name, a);
736 goto done;
737 }
738 }
739
740 vec_free (n->next_node_names);
741 }
742
743 /* Set previous node pointers. */
744 for (ni = 0; ni < vec_len (nm->nodes); ni++)
745 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400746 vlib_node_t *n_next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700747 uword i;
748
749 n = vec_elt (nm->nodes, ni);
750
751 for (i = 0; i < vec_len (n->next_nodes); i++)
752 {
753 if (n->next_nodes[i] >= vec_len (nm->nodes))
754 continue;
755
756 n_next = vec_elt (nm->nodes, n->next_nodes[i]);
757 n_next->prev_node_bitmap =
758 clib_bitmap_ori (n_next->prev_node_bitmap, n->index);
759 }
760 }
761
762 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400763 vlib_next_frame_t *nf;
764 vlib_node_runtime_t *r;
765 vlib_node_t *next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700766 uword i;
767
768 vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
Dave Barach9b8ffd92016-07-08 08:13:45 -0400769 {
770 if (r->n_next_nodes == 0)
771 continue;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700772
Dave Barach9b8ffd92016-07-08 08:13:45 -0400773 n = vlib_get_node (vm, r->node_index);
774 nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700775
Dave Barach9b8ffd92016-07-08 08:13:45 -0400776 for (i = 0; i < vec_len (n->next_nodes); i++)
777 {
778 next = vlib_get_node (vm, n->next_nodes[i]);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700779
Dave Barach9b8ffd92016-07-08 08:13:45 -0400780 /* Validate node runtime indices are correctly initialized. */
781 ASSERT (nf[i].node_runtime_index == next->runtime_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700782
Dave Barach9b8ffd92016-07-08 08:13:45 -0400783 nf[i].flags = 0;
784 if (next->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH)
785 nf[i].flags |= VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
786 }
787 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700788 }
789
Dave Barach9b8ffd92016-07-08 08:13:45 -0400790done:
Ed Warnickecb9cada2015-12-08 15:45:58 -0700791 return error;
792}
Dave Barach9b8ffd92016-07-08 08:13:45 -0400793
Dave Barach11965c72019-05-28 16:31:05 -0400794u32
795vlib_process_create (vlib_main_t * vm, char *name,
796 vlib_node_function_t * f, u32 log2_n_stack_bytes)
797{
798 vlib_node_registration_t r;
799 vlib_node_t *n;
800
801 memset (&r, 0, sizeof (r));
802
803 r.name = (char *) format (0, "%s", name, 0);
804 r.function = f;
805 r.process_log2_n_stack_bytes = log2_n_stack_bytes;
806 r.type = VLIB_NODE_TYPE_PROCESS;
807
808 vlib_worker_thread_barrier_sync (vm);
809
810 vlib_register_node (vm, &r);
811 vec_free (r.name);
812
813 vlib_worker_thread_node_runtime_update ();
814 vlib_worker_thread_barrier_release (vm);
815
816 n = vlib_get_node (vm, r.index);
817 vlib_start_process (vm, n->runtime_index);
818
819 return (r.index);
820}
821
Damjan Mariona31698b2021-03-10 14:35:28 +0100822int
823vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
824 clib_march_variant_type_t march_variant)
825{
826 vlib_node_fn_registration_t *fnr;
827 vlib_node_fn_variant_t *v;
828 vlib_node_t *n = vlib_get_node (vm, node_index);
829
830 if (n->node_fn_registrations == 0)
831 return -1;
832
833 fnr = n->node_fn_registrations;
834 v = vec_elt_at_index (vm->node_main.variants, march_variant);
835
836 while (fnr)
837 {
838 if (fnr->march_variant == v->index)
839 {
840 n->function = fnr->function;
841
Damjan Marion6ffb7c62021-03-26 13:06:13 +0100842 for (int i = 0; i < vlib_get_n_threads (); i++)
Damjan Mariona31698b2021-03-10 14:35:28 +0100843 {
844 vlib_node_runtime_t *nrt;
Damjan Marion6ffb7c62021-03-26 13:06:13 +0100845 nrt =
846 vlib_node_get_runtime (vlib_get_main_by_index (i), n->index);
Damjan Mariona31698b2021-03-10 14:35:28 +0100847 nrt->function = fnr->function;
848 }
849 return 0;
850 }
851 fnr = fnr->next_registration;
852 }
853 return -1;
854}
Dave Barach9b8ffd92016-07-08 08:13:45 -0400855/*
856 * fd.io coding-style-patch-verification: ON
857 *
858 * Local Variables:
859 * eval: (c-set-style "gnu")
860 * End:
861 */