blob: 2bb5bceadbcb26ca6b4b380dcb466e62fc7f698f [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;
Kingwel Xie7ced7722019-03-11 03:53:48 -040050 if (!clib_mem_is_heap_object (vec_header (key, 0)))
Ed Warnickecb9cada2015-12-08 15:45:58 -070051 key = format (0, "%s", key);
52 p = hash_get (nm->node_by_name, key);
53 if (key != name)
54 vec_free (key);
55 return p ? vec_elt (nm->nodes, p[0]) : 0;
56}
57
Dave Barach9b8ffd92016-07-08 08:13:45 -040058static void
59node_set_elog_name (vlib_main_t * vm, uword node_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -070060{
Dave Barach9b8ffd92016-07-08 08:13:45 -040061 vlib_node_t *n = vlib_get_node (vm, node_index);
62 elog_event_type_t *t;
Ed Warnickecb9cada2015-12-08 15:45:58 -070063
64 t = vec_elt_at_index (vm->node_call_elog_event_types, node_index);
65 vec_free (t->format);
Dave Barachfb6e59d2016-03-26 18:45:42 -040066 t->format = (char *) format (0, "%v-call: %%d%c", n->name, 0);
Ed Warnickecb9cada2015-12-08 15:45:58 -070067
68 t = vec_elt_at_index (vm->node_return_elog_event_types, node_index);
69 vec_free (t->format);
Dave Barachfb6e59d2016-03-26 18:45:42 -040070 t->format = (char *) format (0, "%v-return: %%d%c", n->name, 0);
Ed Warnickecb9cada2015-12-08 15:45:58 -070071
Dave Barach9b8ffd92016-07-08 08:13:45 -040072 n->name_elog_string = elog_string (&vm->elog_main, "%v%c", n->name, 0);
Ed Warnickecb9cada2015-12-08 15:45:58 -070073}
74
Igor Mikhailov (imichail)19e9d952017-07-03 17:01:50 -070075static void
76vlib_worker_thread_node_rename (u32 node_index)
77{
78 int i;
79 vlib_main_t *vm;
80 vlib_node_t *n;
81
82 if (vec_len (vlib_mains) == 1)
83 return;
84
85 vm = vlib_mains[0];
86 n = vlib_get_node (vm, node_index);
87
88 ASSERT (vlib_get_thread_index () == 0);
89 ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
90
91 for (i = 1; i < vec_len (vlib_mains); i++)
92 {
93 vlib_main_t *vm_worker = vlib_mains[i];
94 vlib_node_t *n_worker = vlib_get_node (vm_worker, node_index);
95
96 n_worker->name = n->name;
97 n_worker->name_elog_string = n->name_elog_string;
98 }
99}
100
Dave Barach9b8ffd92016-07-08 08:13:45 -0400101void
102vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700103{
104 va_list va;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400105 vlib_node_main_t *nm = &vm->node_main;
106 vlib_node_t *n = vlib_get_node (vm, node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700107
108 va_start (va, fmt);
109 hash_unset (nm->node_by_name, n->name);
110 vec_free (n->name);
111 n->name = va_format (0, fmt, &va);
112 va_end (va);
113 hash_set (nm->node_by_name, n->name, n->index);
114
115 node_set_elog_name (vm, node_index);
Igor Mikhailov (imichail)19e9d952017-07-03 17:01:50 -0700116
117 /* Propagate the change to all worker threads */
118 vlib_worker_thread_node_rename (node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700119}
120
121static void
Dave Barach9b8ffd92016-07-08 08:13:45 -0400122vlib_node_runtime_update (vlib_main_t * vm, u32 node_index, u32 next_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700123{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400124 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;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700129 i32 i, j, n_insert;
130
Ed Warnickecb9cada2015-12-08 15:45:58 -0700131 node = vec_elt (nm->nodes, node_index);
132 r = vlib_node_get_runtime (vm, node_index);
133
134 n_insert = vec_len (node->next_nodes) - r->n_next_nodes;
135 if (n_insert > 0)
136 {
137 i = r->next_frame_index + r->n_next_nodes;
138 vec_insert (nm->next_frames, n_insert, i);
139
140 /* Initialize newly inserted next frames. */
141 for (j = 0; j < n_insert; j++)
142 vlib_next_frame_init (nm->next_frames + i + j);
143
144 /* Relocate other next frames at higher indices. */
145 for (j = 0; j < vec_len (nm->nodes); j++)
146 {
147 s = vlib_node_get_runtime (vm, j);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400148 if (j != node_index && s->next_frame_index >= i)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700149 s->next_frame_index += n_insert;
150 }
151
152 /* Pending frames may need to be relocated also. */
153 vec_foreach (pf, nm->pending_frames)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400154 {
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;
158 }
159 /* *INDENT-OFF* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700160 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;
163 }));
Dave Barach9b8ffd92016-07-08 08:13:45 -0400164 /* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700165
166 r->n_next_nodes = vec_len (node->next_nodes);
167 }
168
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;
173
Dave Barach9b8ffd92016-07-08 08:13:45 -0400174 vlib_worker_thread_node_runtime_update ();
Ed Warnickecb9cada2015-12-08 15:45:58 -0700175}
176
Neale Rannsbb620d72017-06-29 00:19:08 -0700177uword
178vlib_node_get_next (vlib_main_t * vm, uword node_index, uword next_node_index)
179{
180 vlib_node_main_t *nm = &vm->node_main;
181 vlib_node_t *node;
182 uword *p;
183
184 node = vec_elt (nm->nodes, node_index);
185
186 /* Runtime has to be initialized. */
187 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
188
189 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
190 {
191 return p[0];
192 }
193
194 return (~0);
195}
196
Ed Warnickecb9cada2015-12-08 15:45:58 -0700197/* Add next node to given node in given slot. */
198uword
199vlib_node_add_next_with_slot (vlib_main_t * vm,
200 uword node_index,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400201 uword next_node_index, uword slot)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700202{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400203 vlib_node_main_t *nm = &vm->node_main;
Christian Hopps2e8b0612019-11-03 00:59:49 -0400204 vlib_node_t *node, *next, *old_next;
205 u32 old_next_index;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400206 uword *p;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700207
Christian E. Hoppsd3122ef2019-09-28 21:36:36 -0400208 ASSERT (vlib_get_thread_index () == 0);
209
Ed Warnickecb9cada2015-12-08 15:45:58 -0700210 node = vec_elt (nm->nodes, node_index);
211 next = vec_elt (nm->nodes, next_node_index);
212
Ole Troan964f93e2016-06-10 13:22:36 +0200213 /* Runtime has to be initialized. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400214 ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700215
216 if ((p = hash_get (node->next_slot_by_node, next_node_index)))
217 {
John Lo405e41b2016-04-23 15:14:12 -0400218 /* Next already exists: slot must match. */
219 if (slot != ~0)
220 ASSERT (slot == p[0]);
221 return p[0];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700222 }
223
Christian E. Hoppsd3122ef2019-09-28 21:36:36 -0400224 vlib_worker_thread_barrier_sync (vm);
225
Ed Warnickecb9cada2015-12-08 15:45:58 -0700226 if (slot == ~0)
227 slot = vec_len (node->next_nodes);
228
229 vec_validate_init_empty (node->next_nodes, slot, ~0);
230 vec_validate (node->n_vectors_by_next_node, slot);
231
Christian Hopps2e8b0612019-11-03 00:59:49 -0400232 if ((old_next_index = node->next_nodes[slot]) != ~0u)
233 {
234 hash_unset (node->next_slot_by_node, old_next_index);
235 old_next = vlib_get_node (vm, old_next_index);
236 old_next->prev_node_bitmap =
237 clib_bitmap_andnoti (old_next->prev_node_bitmap, node_index);
238 }
239
Ed Warnickecb9cada2015-12-08 15:45:58 -0700240 node->next_nodes[slot] = next_node_index;
John Lo405e41b2016-04-23 15:14:12 -0400241 hash_set (node->next_slot_by_node, next_node_index, slot);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700242
243 vlib_node_runtime_update (vm, node_index, slot);
244
245 next->prev_node_bitmap = clib_bitmap_ori (next->prev_node_bitmap,
246 node_index);
247
248 /* Siblings all get same node structure. */
249 {
250 uword sib_node_index, sib_slot;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400251 vlib_node_t *sib_node;
252 /* *INDENT-OFF* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700253 clib_bitmap_foreach (sib_node_index, node->sibling_bitmap, ({
254 sib_node = vec_elt (nm->nodes, sib_node_index);
255 if (sib_node != node)
256 {
257 sib_slot = vlib_node_add_next_with_slot (vm, sib_node_index, next_node_index, slot);
258 ASSERT (sib_slot == slot);
259 }
260 }));
Dave Barach9b8ffd92016-07-08 08:13:45 -0400261 /* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700262 }
263
Christian E. Hoppsd3122ef2019-09-28 21:36:36 -0400264 vlib_worker_thread_barrier_release (vm);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700265 return slot;
266}
267
268/* Add named next node to given node in given slot. */
269uword
270vlib_node_add_named_next_with_slot (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400271 uword node, char *name, uword slot)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700272{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400273 vlib_node_main_t *nm;
274 vlib_node_t *n, *n_next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700275
276 nm = &vm->node_main;
277 n = vlib_get_node (vm, node);
278
279 n_next = vlib_get_node_by_name (vm, (u8 *) name);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400280 if (!n_next)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700281 {
282 if (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED)
283 return ~0;
284
285 if (slot == ~0)
286 slot = clib_max (vec_len (n->next_node_names),
287 vec_len (n->next_nodes));
288 vec_validate (n->next_node_names, slot);
289 n->next_node_names[slot] = name;
290 return slot;
291 }
292
293 return vlib_node_add_next_with_slot (vm, node, n_next->index, slot);
294}
295
Dave Barach9b8ffd92016-07-08 08:13:45 -0400296static void
297node_elog_init (vlib_main_t * vm, uword ni)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700298{
299 elog_event_type_t t;
300
Dave Barachb7b92992018-10-17 10:38:51 -0400301 clib_memset (&t, 0, sizeof (t));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700302
303 /* 2 event types for this node: one when node function is called.
304 One when it returns. */
305 vec_validate (vm->node_call_elog_event_types, ni);
306 vm->node_call_elog_event_types[ni] = t;
307
308 vec_validate (vm->node_return_elog_event_types, ni);
309 vm->node_return_elog_event_types[ni] = t;
310
311 node_set_elog_name (vm, ni);
312}
313
314#ifdef CLIB_UNIX
Dave Barachbfdedbd2016-01-20 09:11:55 -0500315#define STACK_ALIGN (clib_mem_get_page_size())
Ed Warnickecb9cada2015-12-08 15:45:58 -0700316#else
317#define STACK_ALIGN CLIB_CACHE_LINE_BYTES
318#endif
319
Dave Barach9b8ffd92016-07-08 08:13:45 -0400320static void
321register_node (vlib_main_t * vm, vlib_node_registration_t * r)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700322{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400323 vlib_node_main_t *nm = &vm->node_main;
324 vlib_node_t *n;
325 u32 page_size = clib_mem_get_page_size ();
Ed Warnickecb9cada2015-12-08 15:45:58 -0700326 int i;
327
328 if (CLIB_DEBUG > 0)
329 {
330 /* Default (0) type should match INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400331 vlib_node_t zero = { 0 };
Ed Warnickecb9cada2015-12-08 15:45:58 -0700332 ASSERT (VLIB_NODE_TYPE_INTERNAL == zero.type);
333 }
334
Damjan Marion812b32d2018-05-28 21:26:47 +0200335 if (r->node_fn_registrations)
336 {
337 vlib_node_fn_registration_t *fnr = r->node_fn_registrations;
338 int priority = -1;
339
340 /* to avoid confusion, please remove ".function " statiement from
341 CLIB_NODE_REGISTRATION() if using function function candidates */
342 ASSERT (r->function == 0);
343
344 while (fnr)
345 {
346 if (fnr->priority > priority)
347 {
348 priority = fnr->priority;
349 r->function = fnr->function;
350 }
351 fnr = fnr->next_registration;
352 }
353 }
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 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400377 vlib_node_t *o = vlib_get_node_by_name (vm, n->name);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700378 if (o)
379 clib_error ("more than one node named `%v'", n->name);
380 }
381
382 hash_set (nm->node_by_name, n->name, n->index);
383
384 r->index = n->index; /* save index in registration */
385 n->function = r->function;
386
387 /* Node index of next sibling will be filled in by vlib_node_main_init. */
388 n->sibling_of = r->sibling_of;
Ole Troan964f93e2016-06-10 13:22:36 +0200389 if (r->sibling_of && r->n_next_nodes > 0)
390 clib_error ("sibling node should not have any next nodes `%v'", n->name);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700391
392 if (r->type == VLIB_NODE_TYPE_INTERNAL)
393 ASSERT (r->vector_size > 0);
394
395#define _(f) n->f = r->f
396
Dave Barach9b8ffd92016-07-08 08:13:45 -0400397 _(type);
398 _(flags);
399 _(state);
400 _(scalar_size);
401 _(vector_size);
402 _(format_buffer);
403 _(unformat_buffer);
404 _(format_trace);
405 _(validate_frame);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700406
407 /* Register error counters. */
408 vlib_register_errors (vm, n->index, r->n_errors, r->error_strings);
409 node_elog_init (vm, n->index);
410
Dave Barach9b8ffd92016-07-08 08:13:45 -0400411 _(runtime_data_bytes);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700412 if (r->runtime_data_bytes > 0)
413 {
414 vec_resize (n->runtime_data, r->runtime_data_bytes);
415 if (r->runtime_data)
Damjan Marionf1213b82016-03-13 02:22:06 +0100416 clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700417 }
418
419 vec_resize (n->next_node_names, r->n_next_nodes);
420 for (i = 0; i < r->n_next_nodes; i++)
421 n->next_node_names[i] = r->next_nodes[i];
422
423 vec_validate_init_empty (n->next_nodes, r->n_next_nodes - 1, ~0);
424 vec_validate (n->n_vectors_by_next_node, r->n_next_nodes - 1);
425
426 n->owner_node_index = n->owner_next_index = ~0;
427
428 /* Initialize node runtime. */
429 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400430 vlib_node_runtime_t *rt;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700431 u32 i;
432
433 if (n->type == VLIB_NODE_TYPE_PROCESS)
434 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400435 vlib_process_t *p;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700436 uword log2_n_stack_bytes;
437
438 log2_n_stack_bytes = clib_max (r->process_log2_n_stack_bytes, 15);
439
Dave Barachbfdedbd2016-01-20 09:11:55 -0500440#ifdef CLIB_UNIX
Dave Barach9b8ffd92016-07-08 08:13:45 -0400441 /*
442 * Bump the stack size if running over a kernel with a large page size,
443 * and the stack isn't any too big to begin with. Otherwise, we'll
444 * trip over the stack guard page for sure.
445 */
446 if ((page_size > (4 << 10)) && log2_n_stack_bytes < 19)
447 {
448 if ((1 << log2_n_stack_bytes) <= page_size)
449 log2_n_stack_bytes = min_log2 (page_size) + 1;
450 else
451 log2_n_stack_bytes++;
452 }
Dave Barachbfdedbd2016-01-20 09:11:55 -0500453#endif
454
Dave Barach9b8ffd92016-07-08 08:13:45 -0400455 p = clib_mem_alloc_aligned_at_offset
456 (sizeof (p[0]) + (1 << log2_n_stack_bytes),
Dave Barach241e5222016-10-13 10:53:26 -0400457 STACK_ALIGN, STRUCT_OFFSET_OF (vlib_process_t, stack),
458 0 /* no, don't call os_out_of_memory */ );
Dave Barach9b8ffd92016-07-08 08:13:45 -0400459 if (p == 0)
460 clib_panic ("failed to allocate process stack (%d bytes)",
461 1 << log2_n_stack_bytes);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700462
Dave Barachb7b92992018-10-17 10:38:51 -0400463 clib_memset (p, 0, sizeof (p[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700464 p->log2_n_stack_bytes = log2_n_stack_bytes;
465
466 /* Process node's runtime index is really index into process
467 pointer vector. */
468 n->runtime_index = vec_len (nm->processes);
469
470 vec_add1 (nm->processes, p);
471
472 /* Paint first stack word with magic number so we can at least
473 detect process stack overruns. */
474 p->stack[0] = VLIB_PROCESS_STACK_MAGIC;
475
476 /* Node runtime is stored inside of process. */
477 rt = &p->node_runtime;
478
479#ifdef CLIB_UNIX
Dave Barach9b8ffd92016-07-08 08:13:45 -0400480 /*
481 * Disallow writes to the bottom page of the stack, to
482 * catch stack overflows.
483 */
484 if (mprotect (p->stack, page_size, PROT_READ) < 0)
485 clib_unix_warning ("process stack");
Ed Warnickecb9cada2015-12-08 15:45:58 -0700486#endif
487
488 }
489 else
490 {
491 vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
492 /* align */ CLIB_CACHE_LINE_BYTES);
493 n->runtime_index = rt - nm->nodes_by_type[n->type];
494 }
495
496 if (n->type == VLIB_NODE_TYPE_INPUT)
497 nm->input_node_counts_by_state[n->state] += 1;
498
499 rt->function = n->function;
500 rt->flags = n->flags;
501 rt->state = n->state;
502 rt->node_index = n->index;
503
504 rt->n_next_nodes = r->n_next_nodes;
505 rt->next_frame_index = vec_len (nm->next_frames);
506
507 vec_resize (nm->next_frames, rt->n_next_nodes);
508 for (i = 0; i < rt->n_next_nodes; i++)
509 vlib_next_frame_init (nm->next_frames + rt->next_frame_index + i);
510
511 vec_resize (rt->errors, r->n_errors);
512 for (i = 0; i < vec_len (rt->errors); i++)
Dave Barach687c9022019-07-23 10:22:31 -0400513 rt->errors[i] = n->error_heap_index + i;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700514
Christophe Fontaine33e81952016-12-19 14:41:52 +0100515 STATIC_ASSERT_SIZEOF (vlib_node_runtime_t, 128);
Damjan Marione9f929b2017-03-16 11:32:09 +0100516 ASSERT (vec_len (n->runtime_data) <= VLIB_NODE_RUNTIME_DATA_SIZE);
Damjan Marioneb90b7f2016-11-01 01:26:01 +0100517
Ed Warnickecb9cada2015-12-08 15:45:58 -0700518 if (vec_len (n->runtime_data) > 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400519 clib_memcpy (rt->runtime_data, n->runtime_data,
520 vec_len (n->runtime_data));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700521
522 vec_free (n->runtime_data);
523 }
524}
525
526/* Register new packet processing node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400527u32
528vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700529{
530 register_node (vm, r);
531 return r->index;
532}
533
Damjan Mariond4798a32016-09-06 22:26:03 +0200534static uword
535null_node_fn (vlib_main_t * vm,
536 vlib_node_runtime_t * node, vlib_frame_t * frame)
537{
538 u16 n_vectors = frame->n_vectors;
539
540 vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
Damjan Mariona3d59862018-11-10 10:23:00 +0100541 vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_vectors);
Damjan Mariond4798a32016-09-06 22:26:03 +0200542 vlib_frame_free (vm, node, frame);
543
544 return n_vectors;
545}
546
Dave Barach9b8ffd92016-07-08 08:13:45 -0400547void
548vlib_register_all_static_nodes (vlib_main_t * vm)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700549{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400550 vlib_node_registration_t *r;
551
Damjan Mariond4798a32016-09-06 22:26:03 +0200552 static char *null_node_error_strings[] = {
553 "blackholed packets",
554 };
555
556 static vlib_node_registration_t null_node_reg = {
557 .function = null_node_fn,
558 .vector_size = sizeof (u32),
559 .name = "null-node",
560 .n_errors = 1,
561 .error_strings = null_node_error_strings,
562 };
563
564 /* make sure that node index 0 is not used by
565 real node */
566 register_node (vm, &null_node_reg);
567
Ed Warnickecb9cada2015-12-08 15:45:58 -0700568 r = vm->node_main.node_registrations;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400569 while (r)
570 {
571 register_node (vm, r);
572 r = r->next_registration;
573 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700574}
575
Dave Barach1ddbc012018-06-13 09:26:05 -0400576void
577vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
578 int barrier_sync, vlib_node_t **** node_dupsp,
579 vlib_main_t *** stat_vmsp)
Florin Corase86a8ed2018-01-05 03:20:25 -0800580{
581 vlib_node_main_t *nm = &vm->node_main;
582 vlib_node_t *n;
Dave Barach1ddbc012018-06-13 09:26:05 -0400583 vlib_node_t ***node_dups = *node_dupsp;
Florin Corase86a8ed2018-01-05 03:20:25 -0800584 vlib_node_t **nodes;
Dave Barach1ddbc012018-06-13 09:26:05 -0400585 vlib_main_t **stat_vms = *stat_vmsp;
Florin Corase86a8ed2018-01-05 03:20:25 -0800586 vlib_main_t *stat_vm;
587 uword i, j;
588 u32 threads_to_serialize;
589
Florin Corase86a8ed2018-01-05 03:20:25 -0800590 if (vec_len (stat_vms) == 0)
591 {
592 for (i = 0; i < vec_len (vlib_mains); i++)
593 {
594 stat_vm = vlib_mains[i];
595 if (stat_vm)
596 vec_add1 (stat_vms, stat_vm);
597 }
598 }
599
600 threads_to_serialize = clib_min (max_threads, vec_len (stat_vms));
601
Dave Barach1ddbc012018-06-13 09:26:05 -0400602 vec_validate (node_dups, threads_to_serialize - 1);
603
Florin Corase86a8ed2018-01-05 03:20:25 -0800604 /*
605 * Barrier sync across stats scraping.
606 * Otherwise, the counts will be grossly inaccurate.
607 */
Dave Barach1ddbc012018-06-13 09:26:05 -0400608 if (barrier_sync)
609 vlib_worker_thread_barrier_sync (vm);
Florin Corase86a8ed2018-01-05 03:20:25 -0800610
611 for (j = 0; j < threads_to_serialize; j++)
612 {
613 stat_vm = stat_vms[j];
614 nm = &stat_vm->node_main;
615
616 if (include_stats)
617 {
618 for (i = 0; i < vec_len (nm->nodes); i++)
619 {
620 n = nm->nodes[i];
621 vlib_node_sync_stats (stat_vm, n);
622 }
623 }
624
Dave Barach1ddbc012018-06-13 09:26:05 -0400625 nodes = node_dups[j];
626 vec_validate (nodes, vec_len (nm->nodes) - 1);
627 clib_memcpy (nodes, nm->nodes, vec_len (nm->nodes) * sizeof (nodes[0]));
628 node_dups[j] = nodes;
Florin Corase86a8ed2018-01-05 03:20:25 -0800629 }
Florin Corase86a8ed2018-01-05 03:20:25 -0800630
Dave Barach1ddbc012018-06-13 09:26:05 -0400631 if (barrier_sync)
632 vlib_worker_thread_barrier_release (vm);
633
634 *node_dupsp = node_dups;
635 *stat_vmsp = stat_vms;
Florin Corase86a8ed2018-01-05 03:20:25 -0800636}
637
Ed Warnickecb9cada2015-12-08 15:45:58 -0700638clib_error_t *
639vlib_node_main_init (vlib_main_t * vm)
640{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400641 vlib_node_main_t *nm = &vm->node_main;
642 clib_error_t *error = 0;
643 vlib_node_t *n;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700644 uword ni;
645
Dave Barach593eedf2019-03-10 09:44:51 -0400646 nm->frame_sizes = vec_new (vlib_frame_size_t, 1);
647#ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
Florin Coras93992a92017-05-24 18:03:56 -0700648 nm->frame_size_hash = hash_create (0, sizeof (uword));
Dave Barach593eedf2019-03-10 09:44:51 -0400649#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700650 nm->flags |= VLIB_NODE_MAIN_RUNTIME_STARTED;
651
Ole Troan964f93e2016-06-10 13:22:36 +0200652 /* Generate sibling relationships */
653 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400654 vlib_node_t *n, *sib;
Ole Troan964f93e2016-06-10 13:22:36 +0200655 uword si;
656
657 for (ni = 0; ni < vec_len (nm->nodes); ni++)
658 {
659 n = vec_elt (nm->nodes, ni);
660
Dave Barach9b8ffd92016-07-08 08:13:45 -0400661 if (!n->sibling_of)
Ole Troan964f93e2016-06-10 13:22:36 +0200662 continue;
663
664 sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400665 if (!sib)
Ed Warnicke853e7202016-08-12 11:42:26 -0700666 {
667 error = clib_error_create ("sibling `%s' not found for node `%v'",
668 n->sibling_of, n->name);
669 goto done;
670 }
Ole Troan964f93e2016-06-10 13:22:36 +0200671
Dave Barach9b8ffd92016-07-08 08:13:45 -0400672 /* *INDENT-OFF* */
Ole Troan964f93e2016-06-10 13:22:36 +0200673 clib_bitmap_foreach (si, sib->sibling_bitmap, ({
674 vlib_node_t * m = vec_elt (nm->nodes, si);
675
676 /* Connect all of sibling's siblings to us. */
677 m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
678
679 /* Connect us to all of sibling's siblings. */
680 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
681 }));
Dave Barach9b8ffd92016-07-08 08:13:45 -0400682 /* *INDENT-ON* */
Ole Troan964f93e2016-06-10 13:22:36 +0200683
684 /* Connect sibling to us. */
685 sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
686
687 /* Connect us to sibling. */
688 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
689 }
690 }
691
Ed Warnickecb9cada2015-12-08 15:45:58 -0700692 /* Resolve next names into next indices. */
693 for (ni = 0; ni < vec_len (nm->nodes); ni++)
694 {
695 uword i;
696
697 n = vec_elt (nm->nodes, ni);
698
699 for (i = 0; i < vec_len (n->next_node_names); i++)
700 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400701 char *a = n->next_node_names[i];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700702
Dave Barach9b8ffd92016-07-08 08:13:45 -0400703 if (!a)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700704 continue;
705
706 if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
707 {
708 error = clib_error_create
709 ("node `%v' refers to unknown node `%s'", n->name, a);
710 goto done;
711 }
712 }
713
714 vec_free (n->next_node_names);
715 }
716
717 /* Set previous node pointers. */
718 for (ni = 0; ni < vec_len (nm->nodes); ni++)
719 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400720 vlib_node_t *n_next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700721 uword i;
722
723 n = vec_elt (nm->nodes, ni);
724
725 for (i = 0; i < vec_len (n->next_nodes); i++)
726 {
727 if (n->next_nodes[i] >= vec_len (nm->nodes))
728 continue;
729
730 n_next = vec_elt (nm->nodes, n->next_nodes[i]);
731 n_next->prev_node_bitmap =
732 clib_bitmap_ori (n_next->prev_node_bitmap, n->index);
733 }
734 }
735
736 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400737 vlib_next_frame_t *nf;
738 vlib_node_runtime_t *r;
739 vlib_node_t *next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700740 uword i;
741
742 vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
Dave Barach9b8ffd92016-07-08 08:13:45 -0400743 {
744 if (r->n_next_nodes == 0)
745 continue;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700746
Dave Barach9b8ffd92016-07-08 08:13:45 -0400747 n = vlib_get_node (vm, r->node_index);
748 nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700749
Dave Barach9b8ffd92016-07-08 08:13:45 -0400750 for (i = 0; i < vec_len (n->next_nodes); i++)
751 {
752 next = vlib_get_node (vm, n->next_nodes[i]);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700753
Dave Barach9b8ffd92016-07-08 08:13:45 -0400754 /* Validate node runtime indices are correctly initialized. */
755 ASSERT (nf[i].node_runtime_index == next->runtime_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700756
Dave Barach9b8ffd92016-07-08 08:13:45 -0400757 nf[i].flags = 0;
758 if (next->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH)
759 nf[i].flags |= VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
760 }
761 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700762 }
763
Dave Barach9b8ffd92016-07-08 08:13:45 -0400764done:
Ed Warnickecb9cada2015-12-08 15:45:58 -0700765 return error;
766}
Dave Barach9b8ffd92016-07-08 08:13:45 -0400767
Dave Barach11965c72019-05-28 16:31:05 -0400768u32
769vlib_process_create (vlib_main_t * vm, char *name,
770 vlib_node_function_t * f, u32 log2_n_stack_bytes)
771{
772 vlib_node_registration_t r;
773 vlib_node_t *n;
774
775 memset (&r, 0, sizeof (r));
776
777 r.name = (char *) format (0, "%s", name, 0);
778 r.function = f;
779 r.process_log2_n_stack_bytes = log2_n_stack_bytes;
780 r.type = VLIB_NODE_TYPE_PROCESS;
781
782 vlib_worker_thread_barrier_sync (vm);
783
784 vlib_register_node (vm, &r);
785 vec_free (r.name);
786
787 vlib_worker_thread_node_runtime_update ();
788 vlib_worker_thread_barrier_release (vm);
789
790 n = vlib_get_node (vm, r.index);
791 vlib_start_process (vm, n->runtime_index);
792
793 return (r.index);
794}
795
Dave Barach9b8ffd92016-07-08 08:13:45 -0400796/*
797 * fd.io coding-style-patch-verification: ON
798 *
799 * Local Variables:
800 * eval: (c-set-style "gnu")
801 * End:
802 */