blob: ab3574bd9a3227c43542047a2b49211f0693e57d [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
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* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700134 pool_foreach (pf, nm->suspended_process_frames, ({
135 if (pf->next_frame_index != ~0 && pf->next_frame_index >= i)
136 pf->next_frame_index += n_insert;
137 }));
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* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700227 clib_bitmap_foreach (sib_node_index, node->sibling_bitmap, ({
228 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 }
234 }));
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
Dave Barach9b8ffd92016-07-08 08:13:45 -0400294static void
295register_node (vlib_main_t * vm, vlib_node_registration_t * r)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700296{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400297 vlib_node_main_t *nm = &vm->node_main;
298 vlib_node_t *n;
299 u32 page_size = clib_mem_get_page_size ();
Ed Warnickecb9cada2015-12-08 15:45:58 -0700300 int i;
301
302 if (CLIB_DEBUG > 0)
303 {
304 /* Default (0) type should match INTERNAL. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400305 vlib_node_t zero = { 0 };
Ed Warnickecb9cada2015-12-08 15:45:58 -0700306 ASSERT (VLIB_NODE_TYPE_INTERNAL == zero.type);
307 }
308
Damjan Marion812b32d2018-05-28 21:26:47 +0200309 if (r->node_fn_registrations)
310 {
311 vlib_node_fn_registration_t *fnr = r->node_fn_registrations;
312 int priority = -1;
313
314 /* to avoid confusion, please remove ".function " statiement from
315 CLIB_NODE_REGISTRATION() if using function function candidates */
316 ASSERT (r->function == 0);
317
318 while (fnr)
319 {
320 if (fnr->priority > priority)
321 {
322 priority = fnr->priority;
323 r->function = fnr->function;
324 }
325 fnr = fnr->next_registration;
326 }
327 }
328
Ed Warnickecb9cada2015-12-08 15:45:58 -0700329 ASSERT (r->function != 0);
330
331 n = clib_mem_alloc_no_fail (sizeof (n[0]));
Dave Barachb7b92992018-10-17 10:38:51 -0400332 clib_memset (n, 0, sizeof (n[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700333 n->index = vec_len (nm->nodes);
Damjan Marion69abe442018-08-27 22:43:23 +0200334 n->node_fn_registrations = r->node_fn_registrations;
Dave Barach7fff3d22018-11-27 16:52:59 -0500335 n->protocol_hint = r->protocol_hint;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700336
337 vec_add1 (nm->nodes, n);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400338
Ed Warnickecb9cada2015-12-08 15:45:58 -0700339 /* Name is always a vector so it can be formatted with %v. */
340 if (clib_mem_is_heap_object (vec_header (r->name, 0)))
341 n->name = vec_dup ((u8 *) r->name);
342 else
343 n->name = format (0, "%s", r->name);
344
Dave Barach9b8ffd92016-07-08 08:13:45 -0400345 if (!nm->node_by_name)
346 nm->node_by_name = hash_create_vec ( /* size */ 32,
347 sizeof (n->name[0]), sizeof (uword));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700348
349 /* Node names must be unique. */
350 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400351 vlib_node_t *o = vlib_get_node_by_name (vm, n->name);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700352 if (o)
353 clib_error ("more than one node named `%v'", n->name);
354 }
355
356 hash_set (nm->node_by_name, n->name, n->index);
357
358 r->index = n->index; /* save index in registration */
359 n->function = r->function;
360
361 /* Node index of next sibling will be filled in by vlib_node_main_init. */
362 n->sibling_of = r->sibling_of;
Ole Troan964f93e2016-06-10 13:22:36 +0200363 if (r->sibling_of && r->n_next_nodes > 0)
364 clib_error ("sibling node should not have any next nodes `%v'", n->name);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700365
366 if (r->type == VLIB_NODE_TYPE_INTERNAL)
367 ASSERT (r->vector_size > 0);
368
369#define _(f) n->f = r->f
370
Dave Barach9b8ffd92016-07-08 08:13:45 -0400371 _(type);
372 _(flags);
373 _(state);
374 _(scalar_size);
375 _(vector_size);
376 _(format_buffer);
377 _(unformat_buffer);
378 _(format_trace);
379 _(validate_frame);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700380
381 /* Register error counters. */
382 vlib_register_errors (vm, n->index, r->n_errors, r->error_strings);
383 node_elog_init (vm, n->index);
384
Dave Barach9b8ffd92016-07-08 08:13:45 -0400385 _(runtime_data_bytes);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700386 if (r->runtime_data_bytes > 0)
387 {
388 vec_resize (n->runtime_data, r->runtime_data_bytes);
389 if (r->runtime_data)
Damjan Marionf1213b82016-03-13 02:22:06 +0100390 clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700391 }
392
393 vec_resize (n->next_node_names, r->n_next_nodes);
394 for (i = 0; i < r->n_next_nodes; i++)
395 n->next_node_names[i] = r->next_nodes[i];
396
397 vec_validate_init_empty (n->next_nodes, r->n_next_nodes - 1, ~0);
398 vec_validate (n->n_vectors_by_next_node, r->n_next_nodes - 1);
399
400 n->owner_node_index = n->owner_next_index = ~0;
401
402 /* Initialize node runtime. */
403 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400404 vlib_node_runtime_t *rt;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700405 u32 i;
406
407 if (n->type == VLIB_NODE_TYPE_PROCESS)
408 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400409 vlib_process_t *p;
Damjan Marionef587582020-05-20 22:01:44 +0200410 void *map;
411 uword log2_n_stack_bytes, stack_bytes;
412 int mmap_flags = MAP_PRIVATE | MAP_ANONYMOUS;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700413
Damjan Marionef587582020-05-20 22:01:44 +0200414 log2_n_stack_bytes = clib_max (r->process_log2_n_stack_bytes,
415 VLIB_PROCESS_LOG2_STACK_SIZE);
416 log2_n_stack_bytes = clib_max (log2_n_stack_bytes,
417 min_log2 (page_size));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700418
Damjan Marionef587582020-05-20 22:01:44 +0200419 p = clib_mem_alloc_aligned (sizeof (p[0]), CLIB_CACHE_LINE_BYTES);
Dave Barachb7b92992018-10-17 10:38:51 -0400420 clib_memset (p, 0, sizeof (p[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700421 p->log2_n_stack_bytes = log2_n_stack_bytes;
422
Dave Barach6a3195f2020-06-08 09:40:36 -0400423 stack_bytes = 1ULL << log2_n_stack_bytes;
Damjan Marionef587582020-05-20 22:01:44 +0200424 /* map stack size + 2 extra guard pages */
425 map = mmap (0, stack_bytes + page_size, PROT_READ | PROT_WRITE,
426 mmap_flags, -1, 0);
427
428 if (map == MAP_FAILED)
429 clib_panic ("failed to allocate process stack (%d bytes)",
430 stack_bytes);
431
432 /* skip the guard page */
433 p->stack = map + page_size;
434
435 mmap_flags |= MAP_FIXED;
436 map = mmap (map, page_size, PROT_NONE, mmap_flags, -1, 0);
437
438 if (map == MAP_FAILED)
439 clib_unix_warning ("failed to create stack guard page");
440
Ed Warnickecb9cada2015-12-08 15:45:58 -0700441 /* Process node's runtime index is really index into process
442 pointer vector. */
443 n->runtime_index = vec_len (nm->processes);
444
445 vec_add1 (nm->processes, p);
446
447 /* Paint first stack word with magic number so we can at least
448 detect process stack overruns. */
449 p->stack[0] = VLIB_PROCESS_STACK_MAGIC;
450
451 /* Node runtime is stored inside of process. */
452 rt = &p->node_runtime;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700453 }
454 else
455 {
456 vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
457 /* align */ CLIB_CACHE_LINE_BYTES);
458 n->runtime_index = rt - nm->nodes_by_type[n->type];
459 }
460
461 if (n->type == VLIB_NODE_TYPE_INPUT)
462 nm->input_node_counts_by_state[n->state] += 1;
463
464 rt->function = n->function;
465 rt->flags = n->flags;
466 rt->state = n->state;
467 rt->node_index = n->index;
468
469 rt->n_next_nodes = r->n_next_nodes;
470 rt->next_frame_index = vec_len (nm->next_frames);
471
472 vec_resize (nm->next_frames, rt->n_next_nodes);
473 for (i = 0; i < rt->n_next_nodes; i++)
474 vlib_next_frame_init (nm->next_frames + rt->next_frame_index + i);
475
476 vec_resize (rt->errors, r->n_errors);
477 for (i = 0; i < vec_len (rt->errors); i++)
Dave Barach687c9022019-07-23 10:22:31 -0400478 rt->errors[i] = n->error_heap_index + i;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700479
Christophe Fontaine33e81952016-12-19 14:41:52 +0100480 STATIC_ASSERT_SIZEOF (vlib_node_runtime_t, 128);
Damjan Marione9f929b2017-03-16 11:32:09 +0100481 ASSERT (vec_len (n->runtime_data) <= VLIB_NODE_RUNTIME_DATA_SIZE);
Damjan Marioneb90b7f2016-11-01 01:26:01 +0100482
Ed Warnickecb9cada2015-12-08 15:45:58 -0700483 if (vec_len (n->runtime_data) > 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400484 clib_memcpy (rt->runtime_data, n->runtime_data,
485 vec_len (n->runtime_data));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700486
487 vec_free (n->runtime_data);
488 }
489}
490
491/* Register new packet processing node. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400492u32
493vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700494{
495 register_node (vm, r);
496 return r->index;
497}
498
Damjan Mariond4798a32016-09-06 22:26:03 +0200499static uword
500null_node_fn (vlib_main_t * vm,
501 vlib_node_runtime_t * node, vlib_frame_t * frame)
502{
503 u16 n_vectors = frame->n_vectors;
504
505 vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
Damjan Mariona3d59862018-11-10 10:23:00 +0100506 vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_vectors);
Damjan Mariond4798a32016-09-06 22:26:03 +0200507 vlib_frame_free (vm, node, frame);
508
509 return n_vectors;
510}
511
Dave Barach9b8ffd92016-07-08 08:13:45 -0400512void
513vlib_register_all_static_nodes (vlib_main_t * vm)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700514{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400515 vlib_node_registration_t *r;
516
Damjan Mariond4798a32016-09-06 22:26:03 +0200517 static char *null_node_error_strings[] = {
518 "blackholed packets",
519 };
520
521 static vlib_node_registration_t null_node_reg = {
522 .function = null_node_fn,
523 .vector_size = sizeof (u32),
524 .name = "null-node",
525 .n_errors = 1,
526 .error_strings = null_node_error_strings,
527 };
528
529 /* make sure that node index 0 is not used by
530 real node */
531 register_node (vm, &null_node_reg);
532
Ed Warnickecb9cada2015-12-08 15:45:58 -0700533 r = vm->node_main.node_registrations;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400534 while (r)
535 {
536 register_node (vm, r);
537 r = r->next_registration;
538 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700539}
540
Dave Barach1ddbc012018-06-13 09:26:05 -0400541void
542vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
543 int barrier_sync, vlib_node_t **** node_dupsp,
544 vlib_main_t *** stat_vmsp)
Florin Corase86a8ed2018-01-05 03:20:25 -0800545{
546 vlib_node_main_t *nm = &vm->node_main;
547 vlib_node_t *n;
Dave Barach1ddbc012018-06-13 09:26:05 -0400548 vlib_node_t ***node_dups = *node_dupsp;
Florin Corase86a8ed2018-01-05 03:20:25 -0800549 vlib_node_t **nodes;
Dave Barach1ddbc012018-06-13 09:26:05 -0400550 vlib_main_t **stat_vms = *stat_vmsp;
Florin Corase86a8ed2018-01-05 03:20:25 -0800551 vlib_main_t *stat_vm;
552 uword i, j;
553 u32 threads_to_serialize;
554
Florin Corase86a8ed2018-01-05 03:20:25 -0800555 if (vec_len (stat_vms) == 0)
556 {
557 for (i = 0; i < vec_len (vlib_mains); i++)
558 {
559 stat_vm = vlib_mains[i];
560 if (stat_vm)
561 vec_add1 (stat_vms, stat_vm);
562 }
563 }
564
565 threads_to_serialize = clib_min (max_threads, vec_len (stat_vms));
566
Dave Barach1ddbc012018-06-13 09:26:05 -0400567 vec_validate (node_dups, threads_to_serialize - 1);
568
Florin Corase86a8ed2018-01-05 03:20:25 -0800569 /*
570 * Barrier sync across stats scraping.
571 * Otherwise, the counts will be grossly inaccurate.
572 */
Dave Barach1ddbc012018-06-13 09:26:05 -0400573 if (barrier_sync)
574 vlib_worker_thread_barrier_sync (vm);
Florin Corase86a8ed2018-01-05 03:20:25 -0800575
576 for (j = 0; j < threads_to_serialize; j++)
577 {
578 stat_vm = stat_vms[j];
579 nm = &stat_vm->node_main;
580
581 if (include_stats)
582 {
583 for (i = 0; i < vec_len (nm->nodes); i++)
584 {
585 n = nm->nodes[i];
586 vlib_node_sync_stats (stat_vm, n);
587 }
588 }
589
Dave Barach1ddbc012018-06-13 09:26:05 -0400590 nodes = node_dups[j];
591 vec_validate (nodes, vec_len (nm->nodes) - 1);
592 clib_memcpy (nodes, nm->nodes, vec_len (nm->nodes) * sizeof (nodes[0]));
593 node_dups[j] = nodes;
Florin Corase86a8ed2018-01-05 03:20:25 -0800594 }
Florin Corase86a8ed2018-01-05 03:20:25 -0800595
Dave Barach1ddbc012018-06-13 09:26:05 -0400596 if (barrier_sync)
597 vlib_worker_thread_barrier_release (vm);
598
599 *node_dupsp = node_dups;
600 *stat_vmsp = stat_vms;
Florin Corase86a8ed2018-01-05 03:20:25 -0800601}
602
Ed Warnickecb9cada2015-12-08 15:45:58 -0700603clib_error_t *
604vlib_node_main_init (vlib_main_t * vm)
605{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400606 vlib_node_main_t *nm = &vm->node_main;
607 clib_error_t *error = 0;
608 vlib_node_t *n;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700609 uword ni;
610
Dave Barach593eedf2019-03-10 09:44:51 -0400611 nm->frame_sizes = vec_new (vlib_frame_size_t, 1);
612#ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
Florin Coras93992a92017-05-24 18:03:56 -0700613 nm->frame_size_hash = hash_create (0, sizeof (uword));
Dave Barach593eedf2019-03-10 09:44:51 -0400614#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700615 nm->flags |= VLIB_NODE_MAIN_RUNTIME_STARTED;
616
Ole Troan964f93e2016-06-10 13:22:36 +0200617 /* Generate sibling relationships */
618 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400619 vlib_node_t *n, *sib;
Ole Troan964f93e2016-06-10 13:22:36 +0200620 uword si;
621
622 for (ni = 0; ni < vec_len (nm->nodes); ni++)
623 {
624 n = vec_elt (nm->nodes, ni);
625
Dave Barach9b8ffd92016-07-08 08:13:45 -0400626 if (!n->sibling_of)
Ole Troan964f93e2016-06-10 13:22:36 +0200627 continue;
628
629 sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400630 if (!sib)
Ed Warnicke853e7202016-08-12 11:42:26 -0700631 {
632 error = clib_error_create ("sibling `%s' not found for node `%v'",
633 n->sibling_of, n->name);
634 goto done;
635 }
Ole Troan964f93e2016-06-10 13:22:36 +0200636
Dave Barach9b8ffd92016-07-08 08:13:45 -0400637 /* *INDENT-OFF* */
Ole Troan964f93e2016-06-10 13:22:36 +0200638 clib_bitmap_foreach (si, sib->sibling_bitmap, ({
639 vlib_node_t * m = vec_elt (nm->nodes, si);
640
641 /* Connect all of sibling's siblings to us. */
642 m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
643
644 /* Connect us to all of sibling's siblings. */
645 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
646 }));
Dave Barach9b8ffd92016-07-08 08:13:45 -0400647 /* *INDENT-ON* */
Ole Troan964f93e2016-06-10 13:22:36 +0200648
649 /* Connect sibling to us. */
650 sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
651
652 /* Connect us to sibling. */
653 n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
654 }
655 }
656
Ed Warnickecb9cada2015-12-08 15:45:58 -0700657 /* Resolve next names into next indices. */
658 for (ni = 0; ni < vec_len (nm->nodes); ni++)
659 {
660 uword i;
661
662 n = vec_elt (nm->nodes, ni);
663
664 for (i = 0; i < vec_len (n->next_node_names); i++)
665 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400666 char *a = n->next_node_names[i];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700667
Dave Barach9b8ffd92016-07-08 08:13:45 -0400668 if (!a)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700669 continue;
670
671 if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
672 {
673 error = clib_error_create
674 ("node `%v' refers to unknown node `%s'", n->name, a);
675 goto done;
676 }
677 }
678
679 vec_free (n->next_node_names);
680 }
681
682 /* Set previous node pointers. */
683 for (ni = 0; ni < vec_len (nm->nodes); ni++)
684 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400685 vlib_node_t *n_next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700686 uword i;
687
688 n = vec_elt (nm->nodes, ni);
689
690 for (i = 0; i < vec_len (n->next_nodes); i++)
691 {
692 if (n->next_nodes[i] >= vec_len (nm->nodes))
693 continue;
694
695 n_next = vec_elt (nm->nodes, n->next_nodes[i]);
696 n_next->prev_node_bitmap =
697 clib_bitmap_ori (n_next->prev_node_bitmap, n->index);
698 }
699 }
700
701 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400702 vlib_next_frame_t *nf;
703 vlib_node_runtime_t *r;
704 vlib_node_t *next;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700705 uword i;
706
707 vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
Dave Barach9b8ffd92016-07-08 08:13:45 -0400708 {
709 if (r->n_next_nodes == 0)
710 continue;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700711
Dave Barach9b8ffd92016-07-08 08:13:45 -0400712 n = vlib_get_node (vm, r->node_index);
713 nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700714
Dave Barach9b8ffd92016-07-08 08:13:45 -0400715 for (i = 0; i < vec_len (n->next_nodes); i++)
716 {
717 next = vlib_get_node (vm, n->next_nodes[i]);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700718
Dave Barach9b8ffd92016-07-08 08:13:45 -0400719 /* Validate node runtime indices are correctly initialized. */
720 ASSERT (nf[i].node_runtime_index == next->runtime_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700721
Dave Barach9b8ffd92016-07-08 08:13:45 -0400722 nf[i].flags = 0;
723 if (next->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH)
724 nf[i].flags |= VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
725 }
726 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700727 }
728
Dave Barach9b8ffd92016-07-08 08:13:45 -0400729done:
Ed Warnickecb9cada2015-12-08 15:45:58 -0700730 return error;
731}
Dave Barach9b8ffd92016-07-08 08:13:45 -0400732
Dave Barach11965c72019-05-28 16:31:05 -0400733u32
734vlib_process_create (vlib_main_t * vm, char *name,
735 vlib_node_function_t * f, u32 log2_n_stack_bytes)
736{
737 vlib_node_registration_t r;
738 vlib_node_t *n;
739
740 memset (&r, 0, sizeof (r));
741
742 r.name = (char *) format (0, "%s", name, 0);
743 r.function = f;
744 r.process_log2_n_stack_bytes = log2_n_stack_bytes;
745 r.type = VLIB_NODE_TYPE_PROCESS;
746
747 vlib_worker_thread_barrier_sync (vm);
748
749 vlib_register_node (vm, &r);
750 vec_free (r.name);
751
752 vlib_worker_thread_node_runtime_update ();
753 vlib_worker_thread_barrier_release (vm);
754
755 n = vlib_get_node (vm, r.index);
756 vlib_start_process (vm, n->runtime_index);
757
758 return (r.index);
759}
760
Dave Barach9b8ffd92016-07-08 08:13:45 -0400761/*
762 * fd.io coding-style-patch-verification: ON
763 *
764 * Local Variables:
765 * eval: (c-set-style "gnu")
766 * End:
767 */