blob: 94218d3d9d892792b05f9382159a79938bfdb5fa [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 * main.c: main vector processing loop
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 <math.h>
41#include <vppinfra/format.h>
42#include <vlib/vlib.h>
43#include <vlib/threads.h>
Dave Barach5c20a012017-06-13 08:48:31 -040044#include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070045
Damjan Marion04a7f052017-07-10 15:06:17 +020046#include <vlib/unix/unix.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070047#include <vlib/unix/cj.h>
48
49CJ_GLOBAL_LOG_PROTOTYPE;
50
Ed Warnickecb9cada2015-12-08 15:45:58 -070051/* Actually allocate a few extra slots of vector data to support
52 speculative vector enqueues which overflow vector data in next frame. */
53#define VLIB_FRAME_SIZE_ALLOC (VLIB_FRAME_SIZE + 4)
54
55always_inline u32
56vlib_frame_bytes (u32 n_scalar_bytes, u32 n_vector_bytes)
57{
58 u32 n_bytes;
59
60 /* Make room for vlib_frame_t plus scalar arguments. */
61 n_bytes = vlib_frame_vector_byte_offset (n_scalar_bytes);
62
63 /* Make room for vector arguments.
64 Allocate a few extra slots of vector data to support
65 speculative vector enqueues which overflow vector data in next frame. */
66#define VLIB_FRAME_SIZE_EXTRA 4
67 n_bytes += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * n_vector_bytes;
68
69 /* Magic number is first 32bit number after vector data.
70 Used to make sure that vector data is never overrun. */
71#define VLIB_FRAME_MAGIC (0xabadc0ed)
72 n_bytes += sizeof (u32);
73
74 /* Pad to cache line. */
75 n_bytes = round_pow2 (n_bytes, CLIB_CACHE_LINE_BYTES);
76
77 return n_bytes;
78}
79
80always_inline u32 *
81vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
82{
Dave Barach9b8ffd92016-07-08 08:13:45 -040083 void *p = f;
Ed Warnickecb9cada2015-12-08 15:45:58 -070084
85 p += vlib_frame_vector_byte_offset (node->scalar_size);
86
87 p += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * node->vector_size;
88
89 return p;
90}
91
Dave Barach593eedf2019-03-10 09:44:51 -040092static inline vlib_frame_size_t *
Ed Warnickecb9cada2015-12-08 15:45:58 -070093get_frame_size_info (vlib_node_main_t * nm,
94 u32 n_scalar_bytes, u32 n_vector_bytes)
95{
Dave Barach593eedf2019-03-10 09:44:51 -040096#ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
Ed Warnickecb9cada2015-12-08 15:45:58 -070097 uword key = (n_scalar_bytes << 16) | n_vector_bytes;
Dave Barach9b8ffd92016-07-08 08:13:45 -040098 uword *p, i;
Ed Warnickecb9cada2015-12-08 15:45:58 -070099
100 p = hash_get (nm->frame_size_hash, key);
101 if (p)
102 i = p[0];
103 else
104 {
105 i = vec_len (nm->frame_sizes);
106 vec_validate (nm->frame_sizes, i);
107 hash_set (nm->frame_size_hash, key, i);
108 }
109
110 return vec_elt_at_index (nm->frame_sizes, i);
Dave Barach593eedf2019-03-10 09:44:51 -0400111#else
112 ASSERT (vlib_frame_bytes (n_scalar_bytes, n_vector_bytes)
113 == (vlib_frame_bytes (0, 4)));
114 return vec_elt_at_index (nm->frame_sizes, 0);
115#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700116}
117
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200118static vlib_frame_t *
Dave Barach9b8ffd92016-07-08 08:13:45 -0400119vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
120 u32 frame_flags)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700121{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400122 vlib_node_main_t *nm = &vm->node_main;
123 vlib_frame_size_t *fs;
124 vlib_node_t *to_node;
125 vlib_frame_t *f;
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200126 u32 l, n, scalar_size, vector_size;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700127
128 to_node = vlib_get_node (vm, to_node_index);
129
130 scalar_size = to_node->scalar_size;
131 vector_size = to_node->vector_size;
132
133 fs = get_frame_size_info (nm, scalar_size, vector_size);
134 n = vlib_frame_bytes (scalar_size, vector_size);
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200135 if ((l = vec_len (fs->free_frames)) > 0)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700136 {
137 /* Allocate from end of free list. */
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200138 f = fs->free_frames[l - 1];
139 _vec_len (fs->free_frames) = l - 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700140 }
141 else
142 {
Damjan Marion3f46baf2016-02-06 19:16:21 +0100143 f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700144 }
145
146 /* Poison frame when debugging. */
147 if (CLIB_DEBUG > 0)
Dave Barachb7b92992018-10-17 10:38:51 -0400148 clib_memset (f, 0xfe, n);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700149
150 /* Insert magic number. */
151 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400152 u32 *magic;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700153
154 magic = vlib_frame_find_magic (f, to_node);
155 *magic = VLIB_FRAME_MAGIC;
156 }
157
Damjan Marion633b6fd2018-09-14 14:38:53 +0200158 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700159 f->n_vectors = 0;
160 f->scalar_size = scalar_size;
161 f->vector_size = vector_size;
Damjan Mariona3d59862018-11-10 10:23:00 +0100162 f->flags = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700163
164 fs->n_alloc_frames += 1;
165
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200166 return f;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700167}
168
169/* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
170 Returns frame index. */
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200171static vlib_frame_t *
Dave Barach9b8ffd92016-07-08 08:13:45 -0400172vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
173 u32 to_next_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700174{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400175 vlib_node_t *from_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700176
177 from_node = vlib_get_node (vm, from_node_runtime->node_index);
178 ASSERT (to_next_index < vec_len (from_node->next_nodes));
179
Dave Barach9b8ffd92016-07-08 08:13:45 -0400180 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
Ed Warnickecb9cada2015-12-08 15:45:58 -0700181 /* frame_flags */ 0);
182}
183
184vlib_frame_t *
185vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
186{
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200187 vlib_frame_t *f = vlib_frame_alloc_to_node (vm, to_node_index,
188 /* frame_flags */
189 VLIB_FRAME_FREE_AFTER_DISPATCH);
190 return vlib_get_frame (vm, f);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700191}
192
Dave Barach9b8ffd92016-07-08 08:13:45 -0400193void
194vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700195{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400196 vlib_pending_frame_t *p;
197 vlib_node_t *to_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700198
199 if (f->n_vectors == 0)
200 return;
201
202 to_node = vlib_get_node (vm, to_node_index);
203
204 vec_add2 (vm->node_main.pending_frames, p, 1);
205
Damjan Marion633b6fd2018-09-14 14:38:53 +0200206 f->frame_flags |= VLIB_FRAME_PENDING;
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200207 p->frame = vlib_get_frame (vm, f);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700208 p->node_runtime_index = to_node->runtime_index;
209 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
210}
211
212/* Free given frame. */
213void
Dave Barach9b8ffd92016-07-08 08:13:45 -0400214vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700215{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400216 vlib_node_main_t *nm = &vm->node_main;
217 vlib_node_t *node;
218 vlib_frame_size_t *fs;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400219
Damjan Marion633b6fd2018-09-14 14:38:53 +0200220 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700221
222 node = vlib_get_node (vm, r->node_index);
223 fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
224
Damjan Marion633b6fd2018-09-14 14:38:53 +0200225 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700226
227 /* No next frames may point to freed frame. */
228 if (CLIB_DEBUG > 0)
229 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400230 vlib_next_frame_t *nf;
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200231 vec_foreach (nf, vm->node_main.next_frames) ASSERT (nf->frame != f);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700232 }
233
Damjan Marion296988d2019-02-21 20:24:54 +0100234 f->frame_flags &= ~(VLIB_FRAME_IS_ALLOCATED | VLIB_FRAME_NO_APPEND);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700235
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200236 vec_add1 (fs->free_frames, f);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700237 ASSERT (fs->n_alloc_frames > 0);
238 fs->n_alloc_frames -= 1;
239}
240
241static clib_error_t *
242show_frame_stats (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400243 unformat_input_t * input, vlib_cli_command_t * cmd)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700244{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400245 vlib_node_main_t *nm = &vm->node_main;
246 vlib_frame_size_t *fs;
247
Ed Warnickecb9cada2015-12-08 15:45:58 -0700248 vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
249 vec_foreach (fs, nm->frame_sizes)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400250 {
251 u32 n_alloc = fs->n_alloc_frames;
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200252 u32 n_free = vec_len (fs->free_frames);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700253
Dave Barach9b8ffd92016-07-08 08:13:45 -0400254 if (n_alloc + n_free > 0)
255 vlib_cli_output (vm, "%=6d%=12d%=12d",
256 fs - nm->frame_sizes, n_alloc, n_free);
257 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700258
259 return 0;
260}
261
Dave Barach9b8ffd92016-07-08 08:13:45 -0400262/* *INDENT-OFF* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700263VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
264 .path = "show vlib frame-allocation",
265 .short_help = "Show node dispatch frame statistics",
266 .function = show_frame_stats,
267};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400268/* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700269
270/* Change ownership of enqueue rights to given next node. */
271static void
272vlib_next_frame_change_ownership (vlib_main_t * vm,
273 vlib_node_runtime_t * node_runtime,
274 u32 next_index)
275{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400276 vlib_node_main_t *nm = &vm->node_main;
277 vlib_next_frame_t *next_frame;
278 vlib_node_t *node, *next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700279
280 node = vec_elt (nm->nodes, node_runtime->node_index);
281
282 /* Only internal & input nodes are allowed to call other nodes. */
283 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
284 || node->type == VLIB_NODE_TYPE_INPUT
285 || node->type == VLIB_NODE_TYPE_PROCESS);
286
287 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
288
Dave Barach9b8ffd92016-07-08 08:13:45 -0400289 next_frame =
290 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700291 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
292
293 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
294 {
295 /* Get frame from previous owner. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400296 vlib_next_frame_t *owner_next_frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700297 vlib_next_frame_t tmp;
298
299 owner_next_frame =
300 vlib_node_get_next_frame (vm,
301 next_node->owner_node_index,
302 next_node->owner_next_index);
303
304 /* Swap target next frame with owner's. */
305 tmp = owner_next_frame[0];
306 owner_next_frame[0] = next_frame[0];
307 next_frame[0] = tmp;
308
309 /*
310 * If next_frame is already pending, we have to track down
311 * all pending frames and fix their next_frame_index fields.
312 */
313 if (next_frame->flags & VLIB_FRAME_PENDING)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400314 {
315 vlib_pending_frame_t *p;
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200316 if (next_frame->frame != NULL)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400317 {
318 vec_foreach (p, nm->pending_frames)
319 {
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200320 if (p->frame == next_frame->frame)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400321 {
322 p->next_frame_index =
323 next_frame - vm->node_main.next_frames;
324 }
325 }
326 }
327 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700328 }
329 else
330 {
331 /* No previous owner. Take ownership. */
332 next_frame->flags |= VLIB_FRAME_OWNER;
333 }
Dave Barach9b8ffd92016-07-08 08:13:45 -0400334
Ed Warnickecb9cada2015-12-08 15:45:58 -0700335 /* Record new owner. */
336 next_node->owner_node_index = node->index;
337 next_node->owner_next_index = next_index;
338
339 /* Now we should be owner. */
340 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400341}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700342
343/* Make sure that magic number is still there.
344 Otherwise, it is likely that caller has overrun frame arguments. */
345always_inline void
346validate_frame_magic (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400347 vlib_frame_t * f, vlib_node_t * n, uword next_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700348{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400349 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
350 u32 *magic = vlib_frame_find_magic (f, next_node);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700351 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
352}
353
354vlib_frame_t *
355vlib_get_next_frame_internal (vlib_main_t * vm,
356 vlib_node_runtime_t * node,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400357 u32 next_index, u32 allocate_new_next_frame)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700358{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400359 vlib_frame_t *f;
360 vlib_next_frame_t *nf;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700361 u32 n_used;
362
363 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
364
365 /* Make sure this next frame owns right to enqueue to destination frame. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400366 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700367 vlib_next_frame_change_ownership (vm, node, next_index);
368
369 /* ??? Don't need valid flag: can use frame_index == ~0 */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400370 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700371 {
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200372 nf->frame = vlib_frame_alloc (vm, node, next_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700373 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
374 }
375
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200376 f = nf->frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700377
378 /* Has frame been removed from pending vector (e.g. finished dispatching)?
379 If so we can reuse frame. */
Damjan Marion633b6fd2018-09-14 14:38:53 +0200380 if ((nf->flags & VLIB_FRAME_PENDING)
381 && !(f->frame_flags & VLIB_FRAME_PENDING))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700382 {
383 nf->flags &= ~VLIB_FRAME_PENDING;
384 f->n_vectors = 0;
Damjan Marion9162c2d2018-11-20 09:55:10 +0100385 f->flags = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700386 }
387
Damjan Marion296988d2019-02-21 20:24:54 +0100388 /* Allocate new frame if current one is marked as no-append or
389 it is already full. */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700390 n_used = f->n_vectors;
Damjan Marion296988d2019-02-21 20:24:54 +0100391 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0) ||
392 (f->frame_flags & VLIB_FRAME_NO_APPEND))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700393 {
394 /* Old frame may need to be freed after dispatch, since we'll have
Dave Barach9b8ffd92016-07-08 08:13:45 -0400395 two redundant frames from node -> next node. */
396 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700397 {
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200398 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame);
Damjan Marion633b6fd2018-09-14 14:38:53 +0200399 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700400 }
401
402 /* Allocate new frame to replace full one. */
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200403 f = nf->frame = vlib_frame_alloc (vm, node, next_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700404 n_used = f->n_vectors;
405 }
406
407 /* Should have free vectors in frame now. */
408 ASSERT (n_used < VLIB_FRAME_SIZE);
409
410 if (CLIB_DEBUG > 0)
411 {
412 validate_frame_magic (vm, f,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400413 vlib_get_node (vm, node->node_index), next_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700414 }
415
416 return f;
417}
418
419static void
420vlib_put_next_frame_validate (vlib_main_t * vm,
421 vlib_node_runtime_t * rt,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400422 u32 next_index, u32 n_vectors_left)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700423{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400424 vlib_node_main_t *nm = &vm->node_main;
425 vlib_next_frame_t *nf;
426 vlib_frame_t *f;
427 vlib_node_runtime_t *next_rt;
428 vlib_node_t *next_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700429 u32 n_before, n_after;
430
431 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200432 f = vlib_get_frame (vm, nf->frame);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700433
434 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
435 n_after = VLIB_FRAME_SIZE - n_vectors_left;
436 n_before = f->n_vectors;
437
438 ASSERT (n_after >= n_before);
439
440 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
441 nf->node_runtime_index);
442 next_node = vlib_get_node (vm, next_rt->node_index);
443 if (n_after > 0 && next_node->validate_frame)
444 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400445 u8 *msg = next_node->validate_frame (vm, rt, f);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700446 if (msg)
447 {
448 clib_warning ("%v", msg);
449 ASSERT (0);
450 }
451 vec_free (msg);
452 }
453}
454
455void
456vlib_put_next_frame (vlib_main_t * vm,
457 vlib_node_runtime_t * r,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400458 u32 next_index, u32 n_vectors_left)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700459{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400460 vlib_node_main_t *nm = &vm->node_main;
461 vlib_next_frame_t *nf;
462 vlib_frame_t *f;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700463 u32 n_vectors_in_frame;
464
Damjan Marion910d3692019-01-21 11:48:34 +0100465 if (CLIB_DEBUG > 0)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700466 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
467
468 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200469 f = vlib_get_frame (vm, nf->frame);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700470
471 /* Make sure that magic number is still there. Otherwise, caller
472 has overrun frame meta data. */
473 if (CLIB_DEBUG > 0)
474 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400475 vlib_node_t *node = vlib_get_node (vm, r->node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700476 validate_frame_magic (vm, f, node, next_index);
477 }
478
479 /* Convert # of vectors left -> number of vectors there. */
480 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
481 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
482
483 f->n_vectors = n_vectors_in_frame;
484
485 /* If vectors were added to frame, add to pending vector. */
486 if (PREDICT_TRUE (n_vectors_in_frame > 0))
487 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400488 vlib_pending_frame_t *p;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700489 u32 v0, v1;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400490
Ed Warnickecb9cada2015-12-08 15:45:58 -0700491 r->cached_next_index = next_index;
492
Damjan Marion633b6fd2018-09-14 14:38:53 +0200493 if (!(f->frame_flags & VLIB_FRAME_PENDING))
Dave Barach9b8ffd92016-07-08 08:13:45 -0400494 {
495 __attribute__ ((unused)) vlib_node_t *node;
496 vlib_node_t *next_node;
497 vlib_node_runtime_t *next_runtime;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700498
Dave Barach9b8ffd92016-07-08 08:13:45 -0400499 node = vlib_get_node (vm, r->node_index);
500 next_node = vlib_get_next_node (vm, r->node_index, next_index);
501 next_runtime = vlib_node_get_runtime (vm, next_node->index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700502
Dave Barach9b8ffd92016-07-08 08:13:45 -0400503 vec_add2 (nm->pending_frames, p, 1);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700504
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200505 p->frame = nf->frame;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400506 p->node_runtime_index = nf->node_runtime_index;
507 p->next_frame_index = nf - nm->next_frames;
508 nf->flags |= VLIB_FRAME_PENDING;
Damjan Marion633b6fd2018-09-14 14:38:53 +0200509 f->frame_flags |= VLIB_FRAME_PENDING;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700510
Dave Barach9b8ffd92016-07-08 08:13:45 -0400511 /*
512 * If we're going to dispatch this frame on another thread,
513 * force allocation of a new frame. Otherwise, we create
514 * a dangling frame reference. Each thread has its own copy of
515 * the next_frames vector.
516 */
Damjan Marion586afd72017-04-05 19:18:20 +0200517 if (0 && r->thread_index != next_runtime->thread_index)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400518 {
Andreas Schultz58b2eb12019-07-15 15:40:56 +0200519 nf->frame = NULL;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400520 nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
521 }
522 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700523
524 /* Copy trace flag from next_frame and from runtime. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400525 nf->flags |=
526 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
527 flags & VLIB_NODE_FLAG_TRACE);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700528
529 v0 = nf->vectors_since_last_overflow;
530 v1 = v0 + n_vectors_in_frame;
531 nf->vectors_since_last_overflow = v1;
532 if (PREDICT_FALSE (v1 < v0))
533 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400534 vlib_node_t *node = vlib_get_node (vm, r->node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700535 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
536 }
537 }
538}
539
540/* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
541never_inline void
542vlib_node_runtime_sync_stats (vlib_main_t * vm,
543 vlib_node_runtime_t * r,
Dave Barach4d1a8662018-09-10 12:31:15 -0400544 uword n_calls, uword n_vectors, uword n_clocks,
Dave Barachec595ef2019-01-24 10:34:24 -0500545 uword n_ticks0, uword n_ticks1)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700546{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400547 vlib_node_t *n = vlib_get_node (vm, r->node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700548
549 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
550 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
551 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
Dave Barachec595ef2019-01-24 10:34:24 -0500552 n->stats_total.perf_counter0_ticks += n_ticks0 +
553 r->perf_counter0_ticks_since_last_overflow;
554 n->stats_total.perf_counter1_ticks += n_ticks1 +
555 r->perf_counter1_ticks_since_last_overflow;
Dave Barach4d1a8662018-09-10 12:31:15 -0400556 n->stats_total.perf_counter_vectors += n_vectors +
557 r->perf_counter_vectors_since_last_overflow;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700558 n->stats_total.max_clock = r->max_clock;
559 n->stats_total.max_clock_n = r->max_clock_n;
560
561 r->calls_since_last_overflow = 0;
562 r->vectors_since_last_overflow = 0;
563 r->clocks_since_last_overflow = 0;
Dave Barachec595ef2019-01-24 10:34:24 -0500564 r->perf_counter0_ticks_since_last_overflow = 0ULL;
565 r->perf_counter1_ticks_since_last_overflow = 0ULL;
Dave Barach4d1a8662018-09-10 12:31:15 -0400566 r->perf_counter_vectors_since_last_overflow = 0ULL;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700567}
568
Dave Barach9b8ffd92016-07-08 08:13:45 -0400569always_inline void __attribute__ ((unused))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700570vlib_process_sync_stats (vlib_main_t * vm,
571 vlib_process_t * p,
Dave Barach4d1a8662018-09-10 12:31:15 -0400572 uword n_calls, uword n_vectors, uword n_clocks,
Dave Barachec595ef2019-01-24 10:34:24 -0500573 uword n_ticks0, uword n_ticks1)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700574{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400575 vlib_node_runtime_t *rt = &p->node_runtime;
576 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
Dave Barach4d1a8662018-09-10 12:31:15 -0400577 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks,
Dave Barachec595ef2019-01-24 10:34:24 -0500578 n_ticks0, n_ticks1);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700579 n->stats_total.suspends += p->n_suspends;
580 p->n_suspends = 0;
581}
582
Dave Barach9b8ffd92016-07-08 08:13:45 -0400583void
584vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700585{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400586 vlib_node_runtime_t *rt;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700587
588 if (n->type == VLIB_NODE_TYPE_PROCESS)
589 {
590 /* Nothing to do for PROCESS nodes except in main thread */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400591 if (vm != &vlib_global_main)
592 return;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700593
Dave Barach9b8ffd92016-07-08 08:13:45 -0400594 vlib_process_t *p = vlib_get_process_from_node (vm, n);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700595 n->stats_total.suspends += p->n_suspends;
596 p->n_suspends = 0;
597 rt = &p->node_runtime;
598 }
599 else
Dave Barach9b8ffd92016-07-08 08:13:45 -0400600 rt =
601 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
602 n->runtime_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700603
Dave Barachec595ef2019-01-24 10:34:24 -0500604 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0, 0, 0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700605
606 /* Sync up runtime next frame vector counters with main node structure. */
607 {
Dave Barach9b8ffd92016-07-08 08:13:45 -0400608 vlib_next_frame_t *nf;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700609 uword i;
610 for (i = 0; i < rt->n_next_nodes; i++)
611 {
612 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400613 vec_elt (n->n_vectors_by_next_node, i) +=
614 nf->vectors_since_last_overflow;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700615 nf->vectors_since_last_overflow = 0;
616 }
617 }
618}
619
620always_inline u32
621vlib_node_runtime_update_stats (vlib_main_t * vm,
622 vlib_node_runtime_t * node,
623 uword n_calls,
Dave Barach4d1a8662018-09-10 12:31:15 -0400624 uword n_vectors, uword n_clocks,
Dave Barachec595ef2019-01-24 10:34:24 -0500625 uword n_ticks0, uword n_ticks1)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700626{
627 u32 ca0, ca1, v0, v1, cl0, cl1, r;
Dave Barachec595ef2019-01-24 10:34:24 -0500628 u32 ptick00, ptick01, ptick10, ptick11, pvec0, pvec1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700629
630 cl0 = cl1 = node->clocks_since_last_overflow;
631 ca0 = ca1 = node->calls_since_last_overflow;
632 v0 = v1 = node->vectors_since_last_overflow;
Dave Barachec595ef2019-01-24 10:34:24 -0500633 ptick00 = ptick01 = node->perf_counter0_ticks_since_last_overflow;
634 ptick10 = ptick11 = node->perf_counter1_ticks_since_last_overflow;
Dave Barach4d1a8662018-09-10 12:31:15 -0400635 pvec0 = pvec1 = node->perf_counter_vectors_since_last_overflow;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700636
637 ca1 = ca0 + n_calls;
638 v1 = v0 + n_vectors;
639 cl1 = cl0 + n_clocks;
Dave Barachec595ef2019-01-24 10:34:24 -0500640 ptick01 = ptick00 + n_ticks0;
641 ptick11 = ptick10 + n_ticks1;
Dave Barach4d1a8662018-09-10 12:31:15 -0400642 pvec1 = pvec0 + n_vectors;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700643
644 node->calls_since_last_overflow = ca1;
645 node->clocks_since_last_overflow = cl1;
646 node->vectors_since_last_overflow = v1;
Dave Barachec595ef2019-01-24 10:34:24 -0500647 node->perf_counter0_ticks_since_last_overflow = ptick01;
648 node->perf_counter1_ticks_since_last_overflow = ptick11;
Dave Barach4d1a8662018-09-10 12:31:15 -0400649 node->perf_counter_vectors_since_last_overflow = pvec1;
650
Ed Warnickecb9cada2015-12-08 15:45:58 -0700651 node->max_clock_n = node->max_clock > n_clocks ?
Dave Barach9b8ffd92016-07-08 08:13:45 -0400652 node->max_clock_n : n_vectors;
653 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700654
655 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
656
Dave Barachec595ef2019-01-24 10:34:24 -0500657 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0) || (ptick01 < ptick00)
658 || (ptick11 < ptick10) || (pvec1 < pvec0))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700659 {
660 node->calls_since_last_overflow = ca0;
661 node->clocks_since_last_overflow = cl0;
662 node->vectors_since_last_overflow = v0;
Dave Barachec595ef2019-01-24 10:34:24 -0500663 node->perf_counter0_ticks_since_last_overflow = ptick00;
664 node->perf_counter1_ticks_since_last_overflow = ptick10;
Dave Barach4d1a8662018-09-10 12:31:15 -0400665 node->perf_counter_vectors_since_last_overflow = pvec0;
666
667 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks,
Dave Barachec595ef2019-01-24 10:34:24 -0500668 n_ticks0, n_ticks1);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700669 }
670
671 return r;
672}
673
Dave Barach17e5d802019-05-01 11:30:13 -0400674always_inline void
675vlib_node_runtime_perf_counter (vlib_main_t * vm, u64 * pmc0, u64 * pmc1,
676 vlib_node_runtime_t * node,
677 vlib_frame_t * frame, int before_or_after)
Dave Barach4d1a8662018-09-10 12:31:15 -0400678{
Dave Barachec595ef2019-01-24 10:34:24 -0500679 *pmc0 = 0;
680 *pmc1 = 0;
Dave Barach5f2cfb22019-05-20 10:28:57 -0400681 if (PREDICT_FALSE (vec_len (vm->vlib_node_runtime_perf_counter_cbs) != 0))
682 clib_call_callbacks (vm->vlib_node_runtime_perf_counter_cbs, vm, pmc0,
683 pmc1, node, frame, before_or_after);
Dave Barach4d1a8662018-09-10 12:31:15 -0400684}
685
Ed Warnickecb9cada2015-12-08 15:45:58 -0700686always_inline void
687vlib_process_update_stats (vlib_main_t * vm,
688 vlib_process_t * p,
Dave Barachec595ef2019-01-24 10:34:24 -0500689 uword n_calls, uword n_vectors, uword n_clocks)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700690{
691 vlib_node_runtime_update_stats (vm, &p->node_runtime,
Dave Barachec595ef2019-01-24 10:34:24 -0500692 n_calls, n_vectors, n_clocks, 0ULL, 0ULL);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700693}
694
695static clib_error_t *
696vlib_cli_elog_clear (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400697 unformat_input_t * input, vlib_cli_command_t * cmd)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700698{
699 elog_reset_buffer (&vm->elog_main);
700 return 0;
701}
702
Dave Barach9b8ffd92016-07-08 08:13:45 -0400703/* *INDENT-OFF* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700704VLIB_CLI_COMMAND (elog_clear_cli, static) = {
Dave Barache5389bb2016-03-28 17:12:19 -0400705 .path = "event-logger clear",
706 .short_help = "Clear the event log",
Ed Warnickecb9cada2015-12-08 15:45:58 -0700707 .function = vlib_cli_elog_clear,
708};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400709/* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700710
711#ifdef CLIB_UNIX
712static clib_error_t *
713elog_save_buffer (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400714 unformat_input_t * input, vlib_cli_command_t * cmd)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700715{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400716 elog_main_t *em = &vm->elog_main;
717 char *file, *chroot_file;
718 clib_error_t *error = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700719
Dave Barach9b8ffd92016-07-08 08:13:45 -0400720 if (!unformat (input, "%s", &file))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700721 {
722 vlib_cli_output (vm, "expected file name, got `%U'",
723 format_unformat_error, input);
724 return 0;
725 }
726
727 /* It's fairly hard to get "../oopsie" through unformat; just in case */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400728 if (strstr (file, "..") || index (file, '/'))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700729 {
730 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
731 return 0;
732 }
733
734 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
735
Dave Barach9b8ffd92016-07-08 08:13:45 -0400736 vec_free (file);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700737
738 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
Dave Barach9b8ffd92016-07-08 08:13:45 -0400739 elog_n_events_in_buffer (em),
740 elog_buffer_capacity (em), chroot_file);
741
Ed Warnickecb9cada2015-12-08 15:45:58 -0700742 vlib_worker_thread_barrier_sync (vm);
Dave Barach903fd512017-04-01 11:07:40 -0400743 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
Dave Barach9b8ffd92016-07-08 08:13:45 -0400744 vlib_worker_thread_barrier_release (vm);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700745 vec_free (chroot_file);
746 return error;
747}
748
Dave Barach81481312017-05-16 09:08:14 -0400749void
750elog_post_mortem_dump (void)
751{
752 vlib_main_t *vm = &vlib_global_main;
753 elog_main_t *em = &vm->elog_main;
754 u8 *filename;
755 clib_error_t *error;
756
757 if (!vm->elog_post_mortem_dump)
758 return;
759
760 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
761 error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
762 if (error)
763 clib_error_report (error);
764 vec_free (filename);
765}
766
Dave Barach9b8ffd92016-07-08 08:13:45 -0400767/* *INDENT-OFF* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700768VLIB_CLI_COMMAND (elog_save_cli, static) = {
Dave Barache5389bb2016-03-28 17:12:19 -0400769 .path = "event-logger save",
770 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
Ed Warnickecb9cada2015-12-08 15:45:58 -0700771 .function = elog_save_buffer,
772};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400773/* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700774
Dave Barache5389bb2016-03-28 17:12:19 -0400775static clib_error_t *
776elog_stop (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400777 unformat_input_t * input, vlib_cli_command_t * cmd)
Dave Barache5389bb2016-03-28 17:12:19 -0400778{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400779 elog_main_t *em = &vm->elog_main;
Dave Barache5389bb2016-03-28 17:12:19 -0400780
781 em->n_total_events_disable_limit = em->n_total_events;
782
783 vlib_cli_output (vm, "Stopped the event logger...");
784 return 0;
785}
786
Dave Barach9b8ffd92016-07-08 08:13:45 -0400787/* *INDENT-OFF* */
Dave Barache5389bb2016-03-28 17:12:19 -0400788VLIB_CLI_COMMAND (elog_stop_cli, static) = {
789 .path = "event-logger stop",
790 .short_help = "Stop the event-logger",
791 .function = elog_stop,
792};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400793/* *INDENT-ON* */
Dave Barache5389bb2016-03-28 17:12:19 -0400794
795static clib_error_t *
796elog_restart (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400797 unformat_input_t * input, vlib_cli_command_t * cmd)
Dave Barache5389bb2016-03-28 17:12:19 -0400798{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400799 elog_main_t *em = &vm->elog_main;
Dave Barache5389bb2016-03-28 17:12:19 -0400800
801 em->n_total_events_disable_limit = ~0;
802
803 vlib_cli_output (vm, "Restarted the event logger...");
804 return 0;
805}
806
Dave Barach9b8ffd92016-07-08 08:13:45 -0400807/* *INDENT-OFF* */
Dave Barache5389bb2016-03-28 17:12:19 -0400808VLIB_CLI_COMMAND (elog_restart_cli, static) = {
809 .path = "event-logger restart",
810 .short_help = "Restart the event-logger",
811 .function = elog_restart,
812};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400813/* *INDENT-ON* */
Dave Barache5389bb2016-03-28 17:12:19 -0400814
815static clib_error_t *
816elog_resize (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400817 unformat_input_t * input, vlib_cli_command_t * cmd)
Dave Barache5389bb2016-03-28 17:12:19 -0400818{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400819 elog_main_t *em = &vm->elog_main;
Dave Barache5389bb2016-03-28 17:12:19 -0400820 u32 tmp;
821
822 /* Stop the parade */
823 elog_reset_buffer (&vm->elog_main);
824
825 if (unformat (input, "%d", &tmp))
826 {
827 elog_alloc (em, tmp);
828 em->n_total_events_disable_limit = ~0;
829 }
Dave Barach9b8ffd92016-07-08 08:13:45 -0400830 else
Dave Barache5389bb2016-03-28 17:12:19 -0400831 return clib_error_return (0, "Must specify how many events in the ring");
832
833 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
834 return 0;
835}
836
Dave Barach9b8ffd92016-07-08 08:13:45 -0400837/* *INDENT-OFF* */
Dave Barache5389bb2016-03-28 17:12:19 -0400838VLIB_CLI_COMMAND (elog_resize_cli, static) = {
839 .path = "event-logger resize",
840 .short_help = "event-logger resize <nnn>",
841 .function = elog_resize,
842};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400843/* *INDENT-ON* */
Dave Barache5389bb2016-03-28 17:12:19 -0400844
Ed Warnickecb9cada2015-12-08 15:45:58 -0700845#endif /* CLIB_UNIX */
846
Dave Barach9b8ffd92016-07-08 08:13:45 -0400847static void
848elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700849{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400850 elog_main_t *em = &vm->elog_main;
851 elog_event_t *e, *es;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700852 f64 dt;
853
854 /* Show events in VLIB time since log clock starts after VLIB clock. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400855 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700856 * vm->clib_time.seconds_per_clock;
857
858 es = elog_peek_events (em);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400859 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
860 em->event_ring_size,
861 em->n_total_events < em->n_total_events_disable_limit ?
862 "running" : "stopped");
Ed Warnickecb9cada2015-12-08 15:45:58 -0700863 vec_foreach (e, es)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400864 {
865 vlib_cli_output (vm, "%18.9f: %U",
866 e->time + dt, format_elog_event, em, e);
867 n_events_to_show--;
868 if (n_events_to_show == 0)
869 break;
870 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700871 vec_free (es);
Dave Barach9b8ffd92016-07-08 08:13:45 -0400872
Ed Warnickecb9cada2015-12-08 15:45:58 -0700873}
874
875static clib_error_t *
876elog_show_buffer (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400877 unformat_input_t * input, vlib_cli_command_t * cmd)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700878{
879 u32 n_events_to_show;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400880 clib_error_t *error = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700881
882 n_events_to_show = 250;
883 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
884 {
885 if (unformat (input, "%d", &n_events_to_show))
886 ;
887 else if (unformat (input, "all"))
888 n_events_to_show = ~0;
889 else
890 return unformat_parse_error (input);
891 }
892 elog_show_buffer_internal (vm, n_events_to_show);
893 return error;
894}
895
Dave Barach9b8ffd92016-07-08 08:13:45 -0400896/* *INDENT-OFF* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700897VLIB_CLI_COMMAND (elog_show_cli, static) = {
898 .path = "show event-logger",
899 .short_help = "Show event logger info",
900 .function = elog_show_buffer,
901};
Dave Barach9b8ffd92016-07-08 08:13:45 -0400902/* *INDENT-ON* */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700903
Dave Barach9b8ffd92016-07-08 08:13:45 -0400904void
905vlib_gdb_show_event_log (void)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700906{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400907 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700908}
909
Dave Barachfb6e59d2016-03-26 18:45:42 -0400910static inline void
Ed Warnickecb9cada2015-12-08 15:45:58 -0700911vlib_elog_main_loop_event (vlib_main_t * vm,
912 u32 node_index,
Dave Barach9b8ffd92016-07-08 08:13:45 -0400913 u64 time, u32 n_vectors, u32 is_return)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700914{
Dave Barach9b8ffd92016-07-08 08:13:45 -0400915 vlib_main_t *evm = &vlib_global_main;
916 elog_main_t *em = &evm->elog_main;
Dave Barach900cbad2019-01-31 19:12:51 -0500917 int enabled = evm->elog_trace_graph_dispatch |
918 evm->elog_trace_graph_circuit;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700919
Dave Barach900cbad2019-01-31 19:12:51 -0500920 if (PREDICT_FALSE (enabled && n_vectors))
921 {
922 if (PREDICT_FALSE (!elog_is_enabled (em)))
923 {
924 evm->elog_trace_graph_dispatch = 0;
925 evm->elog_trace_graph_circuit = 0;
926 return;
927 }
928 if (PREDICT_TRUE
929 (evm->elog_trace_graph_dispatch ||
930 (evm->elog_trace_graph_circuit &&
931 node_index == evm->elog_trace_graph_circuit_node_index)))
932 {
933 elog_track (em,
934 /* event type */
935 vec_elt_at_index (is_return
936 ? evm->node_return_elog_event_types
937 : evm->node_call_elog_event_types,
938 node_index),
939 /* track */
940 (vm->thread_index ?
941 &vlib_worker_threads[vm->thread_index].elog_track
942 : &em->default_track),
943 /* data to log */ n_vectors);
944 }
945 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700946}
947
Dave Barach7bee7732017-10-18 18:48:11 -0400948#if VLIB_BUFFER_TRACE_TRAJECTORY > 0
949void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
950void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
951
Dave Barach9b8ffd92016-07-08 08:13:45 -0400952void
Dave Barach7bee7732017-10-18 18:48:11 -0400953vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700954{
Dave Barach7bee7732017-10-18 18:48:11 -0400955 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700956 {
Dave Barach7bee7732017-10-18 18:48:11 -0400957 (*vlib_buffer_trace_trajectory_init_cb) (b);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700958 }
959}
960
Dave Barach7bee7732017-10-18 18:48:11 -0400961#endif
962
963static inline void
964add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
965{
966#if VLIB_BUFFER_TRACE_TRAJECTORY > 0
967 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
968 {
969 (*vlib_buffer_trace_trajectory_cb) (b, node_index);
970 }
971#endif
972}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700973
Dave Barach7fff3d22018-11-27 16:52:59 -0500974u8 *format_vnet_buffer_flags (u8 * s, va_list * args) __attribute__ ((weak));
975u8 *
976format_vnet_buffer_flags (u8 * s, va_list * args)
977{
978 s = format (s, "BUG STUB %s", __FUNCTION__);
979 return s;
980}
981
982u8 *format_vnet_buffer_opaque (u8 * s, va_list * args) __attribute__ ((weak));
983u8 *
984format_vnet_buffer_opaque (u8 * s, va_list * args)
985{
986 s = format (s, "BUG STUB %s", __FUNCTION__);
987 return s;
988}
989
990u8 *format_vnet_buffer_opaque2 (u8 * s, va_list * args)
991 __attribute__ ((weak));
992u8 *
993format_vnet_buffer_opaque2 (u8 * s, va_list * args)
994{
995 s = format (s, "BUG STUB %s", __FUNCTION__);
996 return s;
997}
998
999static u8 *
1000format_buffer_metadata (u8 * s, va_list * args)
1001{
1002 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
1003
1004 s = format (s, "flags: %U\n", format_vnet_buffer_flags, b);
1005 s = format (s, "current_data: %d, current_length: %d\n",
1006 (i32) (b->current_data), (i32) (b->current_length));
Dave Barachd7b30662019-10-24 18:10:10 -04001007 s = format
1008 (s,
1009 "current_config_index/punt_reason: %d, flow_id: %x, next_buffer: %x\n",
1010 b->current_config_index, b->flow_id, b->next_buffer);
1011 s =
1012 format (s, "error: %d, ref_count: %d, buffer_pool_index: %d\n",
1013 (u32) (b->error), (u32) (b->ref_count),
1014 (u32) (b->buffer_pool_index));
1015 s =
1016 format (s, "trace_handle: 0x%x, len_not_first_buf: %d\n", b->trace_handle,
1017 b->total_length_not_including_first_buffer);
Dave Barach7fff3d22018-11-27 16:52:59 -05001018 return s;
1019}
1020
1021#define A(x) vec_add1(vm->pcap_buffer, (x))
1022
Dave Barach3ae28732018-11-16 17:19:00 -05001023static void
1024dispatch_pcap_trace (vlib_main_t * vm,
1025 vlib_node_runtime_t * node, vlib_frame_t * frame)
1026{
1027 int i;
1028 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **bufp, *b;
Dave Barach349cd1a2019-10-18 14:44:05 -04001029 pcap_main_t *pm = &vlib_global_main.dispatch_pcap_main;
Dave Barach1201a802018-11-20 12:08:39 -05001030 vlib_trace_main_t *tm = &vm->trace_main;
Dave Barach3ae28732018-11-16 17:19:00 -05001031 u32 capture_size;
1032 vlib_node_t *n;
1033 i32 n_left;
1034 f64 time_now = vlib_time_now (vm);
1035 u32 *from;
Dave Barach3ae28732018-11-16 17:19:00 -05001036 u8 *d;
Dave Barach7fff3d22018-11-27 16:52:59 -05001037 u8 string_count;
Dave Barach3ae28732018-11-16 17:19:00 -05001038
1039 /* Input nodes don't have frames yet */
1040 if (frame == 0 || frame->n_vectors == 0)
1041 return;
1042
1043 from = vlib_frame_vector_args (frame);
1044 vlib_get_buffers (vm, from, bufs, frame->n_vectors);
1045 bufp = bufs;
1046
Dave Barach3ae28732018-11-16 17:19:00 -05001047 n = vlib_get_node (vm, node->node_index);
Dave Barach3ae28732018-11-16 17:19:00 -05001048
1049 for (i = 0; i < frame->n_vectors; i++)
1050 {
1051 if (PREDICT_TRUE (pm->n_packets_captured < pm->n_packets_to_capture))
1052 {
1053 b = bufp[i];
1054
Dave Barach7fff3d22018-11-27 16:52:59 -05001055 vec_reset_length (vm->pcap_buffer);
1056 string_count = 0;
Dave Barach1201a802018-11-20 12:08:39 -05001057
Dave Barach7fff3d22018-11-27 16:52:59 -05001058 /* Version, flags */
1059 A ((u8) VLIB_PCAP_MAJOR_VERSION);
1060 A ((u8) VLIB_PCAP_MINOR_VERSION);
1061 A (0 /* string_count */ );
1062 A (n->protocol_hint);
1063
1064 /* Buffer index (big endian) */
1065 A ((from[i] >> 24) & 0xff);
1066 A ((from[i] >> 16) & 0xff);
1067 A ((from[i] >> 8) & 0xff);
1068 A ((from[i] >> 0) & 0xff);
1069
1070 /* Node name, NULL-terminated ASCII */
1071 vm->pcap_buffer = format (vm->pcap_buffer, "%v%c", n->name, 0);
1072 string_count++;
1073
1074 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1075 format_buffer_metadata, b, 0);
1076 string_count++;
1077 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1078 format_vnet_buffer_opaque, b, 0);
1079 string_count++;
1080 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1081 format_vnet_buffer_opaque2, b, 0);
1082 string_count++;
Dave Barach1201a802018-11-20 12:08:39 -05001083
1084 /* Is this packet traced? */
1085 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
1086 {
1087 vlib_trace_header_t **h
Dave Baracha638c182019-06-21 18:24:07 -04001088 = pool_elt_at_index (tm->trace_buffer_pool,
1089 vlib_buffer_get_trace_index (b));
Dave Barach1201a802018-11-20 12:08:39 -05001090
Dave Barach7fff3d22018-11-27 16:52:59 -05001091 vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
1092 format_vlib_trace, vm, h[0], 0);
1093 string_count++;
Dave Barach1201a802018-11-20 12:08:39 -05001094 }
1095
Dave Barach7fff3d22018-11-27 16:52:59 -05001096 /* Save the string count */
1097 vm->pcap_buffer[2] = string_count;
1098
1099 /* Figure out how many bytes in the pcap trace */
1100 capture_size = vec_len (vm->pcap_buffer) +
1101 +vlib_buffer_length_in_chain (vm, b);
Dave Barach3ae28732018-11-16 17:19:00 -05001102
1103 clib_spinlock_lock_if_init (&pm->lock);
Dave Barach1201a802018-11-20 12:08:39 -05001104 n_left = clib_min (capture_size, 16384);
Dave Barach3ae28732018-11-16 17:19:00 -05001105 d = pcap_add_packet (pm, time_now, n_left, capture_size);
1106
Dave Barach7fff3d22018-11-27 16:52:59 -05001107 /* Copy the header */
1108 clib_memcpy_fast (d, vm->pcap_buffer, vec_len (vm->pcap_buffer));
1109 d += vec_len (vm->pcap_buffer);
Dave Barach1201a802018-11-20 12:08:39 -05001110
1111 n_left = clib_min
1112 (vlib_buffer_length_in_chain (vm, b),
Dave Barach7fff3d22018-11-27 16:52:59 -05001113 (16384 - vec_len (vm->pcap_buffer)));
Dave Barach3ae28732018-11-16 17:19:00 -05001114 /* Copy the packet data */
1115 while (1)
1116 {
1117 u32 copy_length = clib_min ((u32) n_left, b->current_length);
1118 clib_memcpy_fast (d, b->data + b->current_data, copy_length);
1119 n_left -= b->current_length;
1120 if (n_left <= 0)
1121 break;
1122 d += b->current_length;
1123 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
1124 b = vlib_get_buffer (vm, b->next_buffer);
1125 }
1126 clib_spinlock_unlock_if_init (&pm->lock);
1127 }
1128 }
1129}
1130
Damjan Marion9a332e12017-03-28 15:11:20 +02001131static_always_inline u64
Ed Warnickecb9cada2015-12-08 15:45:58 -07001132dispatch_node (vlib_main_t * vm,
1133 vlib_node_runtime_t * node,
1134 vlib_node_type_t type,
1135 vlib_node_state_t dispatch_state,
Dave Barach9b8ffd92016-07-08 08:13:45 -04001136 vlib_frame_t * frame, u64 last_time_stamp)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001137{
1138 uword n, v;
1139 u64 t;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001140 vlib_node_main_t *nm = &vm->node_main;
1141 vlib_next_frame_t *nf;
Dave Barach900cbad2019-01-31 19:12:51 -05001142 u64 pmc_before[2], pmc_after[2], pmc_delta[2];
Ed Warnickecb9cada2015-12-08 15:45:58 -07001143
1144 if (CLIB_DEBUG > 0)
1145 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04001146 vlib_node_t *n = vlib_get_node (vm, node->node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001147 ASSERT (n->type == type);
1148 }
1149
1150 /* Only non-internal nodes may be disabled. */
1151 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
1152 {
1153 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
1154 return last_time_stamp;
1155 }
1156
1157 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
1158 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
1159 {
1160 u32 c = node->input_main_loops_per_call;
1161 /* Only call node when count reaches zero. */
1162 if (c)
1163 {
1164 node->input_main_loops_per_call = c - 1;
1165 return last_time_stamp;
1166 }
1167 }
1168
1169 /* Speculatively prefetch next frames. */
1170 if (node->n_next_nodes > 0)
1171 {
1172 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
1173 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
1174 }
1175
1176 vm->cpu_time_last_node_dispatch = last_time_stamp;
1177
Dave Barach900cbad2019-01-31 19:12:51 -05001178 vlib_elog_main_loop_event (vm, node->node_index,
1179 last_time_stamp, frame ? frame->n_vectors : 0,
1180 /* is_after */ 0);
1181
Dave Barach17e5d802019-05-01 11:30:13 -04001182 vlib_node_runtime_perf_counter (vm, &pmc_before[0], &pmc_before[1],
1183 node, frame, 0 /* before */ );
Dave Barach900cbad2019-01-31 19:12:51 -05001184
1185 /*
1186 * Turn this on if you run into
1187 * "bad monkey" contexts, and you want to know exactly
1188 * which nodes they've visited... See ixge.c...
1189 */
1190 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001191 {
Dave Barach900cbad2019-01-31 19:12:51 -05001192 int i;
1193 u32 *from;
1194 from = vlib_frame_vector_args (frame);
1195 for (i = 0; i < frame->n_vectors; i++)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001196 {
Dave Barach900cbad2019-01-31 19:12:51 -05001197 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1198 add_trajectory_trace (b, node->node_index);
Dave Barach9b8ffd92016-07-08 08:13:45 -04001199 }
Dave Barach900cbad2019-01-31 19:12:51 -05001200 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1201 dispatch_pcap_trace (vm, node, frame);
1202 n = node->function (vm, node, frame);
1203 }
1204 else
1205 {
1206 if (PREDICT_FALSE (vm->dispatch_pcap_enable))
1207 dispatch_pcap_trace (vm, node, frame);
1208 n = node->function (vm, node, frame);
1209 }
1210
1211 t = clib_cpu_time_now ();
1212
1213 /*
1214 * To validate accounting: pmc_delta = t - pmc_before;
1215 * perf ticks should equal clocks/pkt...
1216 */
Dave Barach17e5d802019-05-01 11:30:13 -04001217 vlib_node_runtime_perf_counter (vm, &pmc_after[0], &pmc_after[1], node,
1218 frame, 1 /* after */ );
Dave Barach900cbad2019-01-31 19:12:51 -05001219
1220 pmc_delta[0] = pmc_after[0] - pmc_before[0];
1221 pmc_delta[1] = pmc_after[1] - pmc_before[1];
1222
1223 vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
1224
1225 vm->main_loop_vectors_processed += n;
1226 vm->main_loop_nodes_processed += n > 0;
1227
1228 v = vlib_node_runtime_update_stats (vm, node,
1229 /* n_calls */ 1,
1230 /* n_vectors */ n,
1231 /* n_clocks */ t - last_time_stamp,
1232 pmc_delta[0] /* PMC0 */ ,
1233 pmc_delta[1] /* PMC1 */ );
1234
1235 /* When in interrupt mode and vector rate crosses threshold switch to
1236 polling mode. */
1237 if (PREDICT_FALSE ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1238 || (dispatch_state == VLIB_NODE_STATE_POLLING
1239 && (node->flags
1240 &
1241 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))))
1242 {
1243 /* *INDENT-OFF* */
1244 ELOG_TYPE_DECLARE (e) =
1245 {
1246 .function = (char *) __FUNCTION__,
1247 .format = "%s vector length %d, switching to %s",
1248 .format_args = "T4i4t4",
1249 .n_enum_strings = 2,
1250 .enum_strings = {
1251 "interrupt", "polling",
1252 },
1253 };
1254 /* *INDENT-ON* */
1255 struct
1256 {
1257 u32 node_name, vector_length, is_polling;
1258 } *ed;
1259
1260 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1261 && v >= nm->polling_threshold_vector_length) &&
1262 !(node->flags &
1263 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
Dave Barach3ae28732018-11-16 17:19:00 -05001264 {
Dave Barach900cbad2019-01-31 19:12:51 -05001265 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1266 n->state = VLIB_NODE_STATE_POLLING;
1267 node->state = VLIB_NODE_STATE_POLLING;
1268 node->flags &=
1269 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1270 node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1271 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1272 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001273
Dave Barach900cbad2019-01-31 19:12:51 -05001274 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001275 {
Dave Barach900cbad2019-01-31 19:12:51 -05001276 vlib_worker_thread_t *w = vlib_worker_threads
1277 + vm->thread_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001278
Steven6aa75af2017-02-24 10:03:22 -08001279 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1280 w->elog_track);
Dave Barach9b8ffd92016-07-08 08:13:45 -04001281 ed->node_name = n->name_elog_string;
1282 ed->vector_length = v;
1283 ed->is_polling = 1;
1284 }
Dave Barach900cbad2019-01-31 19:12:51 -05001285 }
1286 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1287 && v <= nm->interrupt_threshold_vector_length)
1288 {
1289 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1290 if (node->flags &
1291 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001292 {
Dave Barach900cbad2019-01-31 19:12:51 -05001293 /* Switch to interrupt mode after dispatch in polling one more time.
1294 This allows driver to re-enable interrupts. */
1295 n->state = VLIB_NODE_STATE_INTERRUPT;
1296 node->state = VLIB_NODE_STATE_INTERRUPT;
1297 node->flags &=
1298 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1299 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
1300 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001301
Dave Barach900cbad2019-01-31 19:12:51 -05001302 }
1303 else
1304 {
1305 vlib_worker_thread_t *w = vlib_worker_threads
1306 + vm->thread_index;
1307 node->flags |=
1308 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1309 if (PREDICT_FALSE (vlib_global_main.elog_trace_graph_dispatch))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001310 {
Steven6aa75af2017-02-24 10:03:22 -08001311 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1312 w->elog_track);
Dave Barach9b8ffd92016-07-08 08:13:45 -04001313 ed->node_name = n->name_elog_string;
1314 ed->vector_length = v;
1315 ed->is_polling = 0;
1316 }
1317 }
1318 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001319 }
1320
1321 return t;
1322}
1323
Damjan Marion9a332e12017-03-28 15:11:20 +02001324static u64
Dave Baracha6269992017-06-07 08:18:49 -04001325dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1326 u64 last_time_stamp)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001327{
Dave Barach9b8ffd92016-07-08 08:13:45 -04001328 vlib_node_main_t *nm = &vm->node_main;
1329 vlib_frame_t *f;
1330 vlib_next_frame_t *nf, nf_dummy;
1331 vlib_node_runtime_t *n;
Andreas Schultz58b2eb12019-07-15 15:40:56 +02001332 vlib_frame_t *restore_frame;
Dave Baracha6269992017-06-07 08:18:49 -04001333 vlib_pending_frame_t *p;
1334
1335 /* See comment below about dangling references to nm->pending_frames */
1336 p = nm->pending_frames + pending_frame_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001337
1338 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1339 p->node_runtime_index);
1340
Andreas Schultz58b2eb12019-07-15 15:40:56 +02001341 f = vlib_get_frame (vm, p->frame);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001342 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1343 {
1344 /* No next frame: so use dummy on stack. */
1345 nf = &nf_dummy;
Damjan Marion633b6fd2018-09-14 14:38:53 +02001346 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
Andreas Schultz58b2eb12019-07-15 15:40:56 +02001347 nf->frame = NULL;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001348 }
1349 else
1350 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1351
Damjan Marion633b6fd2018-09-14 14:38:53 +02001352 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001353
1354 /* Force allocation of new frame while current frame is being
1355 dispatched. */
Andreas Schultz58b2eb12019-07-15 15:40:56 +02001356 restore_frame = NULL;
1357 if (nf->frame == p->frame)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001358 {
Andreas Schultz58b2eb12019-07-15 15:40:56 +02001359 nf->frame = NULL;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001360 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001361 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
Andreas Schultz58b2eb12019-07-15 15:40:56 +02001362 restore_frame = p->frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001363 }
1364
1365 /* Frame must be pending. */
Damjan Marion633b6fd2018-09-14 14:38:53 +02001366 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001367 ASSERT (f->n_vectors > 0);
1368
1369 /* Copy trace flag from next frame to node.
1370 Trace flag indicates that at least one vector in the dispatched
1371 frame is traced. */
1372 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1373 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1374 nf->flags &= ~VLIB_FRAME_TRACE;
1375
1376 last_time_stamp = dispatch_node (vm, n,
1377 VLIB_NODE_TYPE_INTERNAL,
1378 VLIB_NODE_STATE_POLLING,
1379 f, last_time_stamp);
Dave Baracha8df85c2019-10-01 13:34:23 -04001380 /* Internal node vector-rate accounting, for summary stats */
1381 vm->internal_node_vectors += f->n_vectors;
1382 vm->internal_node_calls++;
1383 vm->internal_node_last_vectors_per_main_loop =
1384 (f->n_vectors > vm->internal_node_last_vectors_per_main_loop) ?
1385 f->n_vectors : vm->internal_node_last_vectors_per_main_loop;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001386
Damjan Marion296988d2019-02-21 20:24:54 +01001387 f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001388
1389 /* Frame is ready to be used again, so restore it. */
Andreas Schultz58b2eb12019-07-15 15:40:56 +02001390 if (restore_frame != NULL)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001391 {
Dave Baracha6269992017-06-07 08:18:49 -04001392 /*
1393 * We musn't restore a frame that is flagged to be freed. This
1394 * shouldn't happen since frames to be freed post dispatch are
1395 * those used when the to-node frame becomes full i.e. they form a
1396 * sort of queue of frames to a single node. If we get here then
1397 * the to-node frame and the pending frame *were* the same, and so
1398 * we removed the to-node frame. Therefore this frame is no
1399 * longer part of the queue for that node and hence it cannot be
1400 * it's overspill.
Neale Ranns88170612016-11-22 08:29:51 +00001401 */
Damjan Marion633b6fd2018-09-14 14:38:53 +02001402 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
Neale Ranns88170612016-11-22 08:29:51 +00001403
Dave Baracha6269992017-06-07 08:18:49 -04001404 /*
1405 * NB: dispatching node n can result in the creation and scheduling
1406 * of new frames, and hence in the reallocation of nm->pending_frames.
1407 * Recompute p, or no supper. This was broken for more than 10 years.
1408 */
1409 p = nm->pending_frames + pending_frame_index;
1410
1411 /*
1412 * p->next_frame_index can change during node dispatch if node
1413 * function decides to change graph hook up.
1414 */
Ed Warnickecb9cada2015-12-08 15:45:58 -07001415 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001416 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001417
Andreas Schultz58b2eb12019-07-15 15:40:56 +02001418 if (NULL == nf->frame)
Neale Ranns88170612016-11-22 08:29:51 +00001419 {
1420 /* no new frame has been assigned to this node, use the saved one */
Andreas Schultz58b2eb12019-07-15 15:40:56 +02001421 nf->frame = restore_frame;
Neale Ranns88170612016-11-22 08:29:51 +00001422 f->n_vectors = 0;
1423 }
1424 else
1425 {
1426 /* The node has gained a frame, implying packets from the current frame
1427 were re-queued to this same node. we don't need the saved one
1428 anymore */
1429 vlib_frame_free (vm, n, f);
1430 }
1431 }
1432 else
Ed Warnickecb9cada2015-12-08 15:45:58 -07001433 {
Damjan Marion633b6fd2018-09-14 14:38:53 +02001434 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
Neale Ranns88170612016-11-22 08:29:51 +00001435 {
1436 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1437 vlib_frame_free (vm, n, f);
1438 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001439 }
1440
1441 return last_time_stamp;
1442}
1443
1444always_inline uword
1445vlib_process_stack_is_valid (vlib_process_t * p)
Dave Barach9b8ffd92016-07-08 08:13:45 -04001446{
1447 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1448}
Ed Warnickecb9cada2015-12-08 15:45:58 -07001449
Dave Barach9b8ffd92016-07-08 08:13:45 -04001450typedef struct
1451{
1452 vlib_main_t *vm;
1453 vlib_process_t *process;
1454 vlib_frame_t *frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001455} vlib_process_bootstrap_args_t;
1456
1457/* Called in process stack. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04001458static uword
1459vlib_process_bootstrap (uword _a)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001460{
Dave Barach9b8ffd92016-07-08 08:13:45 -04001461 vlib_process_bootstrap_args_t *a;
1462 vlib_main_t *vm;
1463 vlib_node_runtime_t *node;
1464 vlib_frame_t *f;
1465 vlib_process_t *p;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001466 uword n;
1467
1468 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1469
1470 vm = a->vm;
1471 p = a->process;
1472 f = a->frame;
1473 node = &p->node_runtime;
1474
1475 n = node->function (vm, node, f);
1476
1477 ASSERT (vlib_process_stack_is_valid (p));
1478
1479 clib_longjmp (&p->return_longjmp, n);
1480
1481 return n;
1482}
1483
1484/* Called in main stack. */
1485static_always_inline uword
Dave Barach9b8ffd92016-07-08 08:13:45 -04001486vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001487{
1488 vlib_process_bootstrap_args_t a;
1489 uword r;
1490
1491 a.vm = vm;
1492 a.process = p;
1493 a.frame = f;
1494
1495 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1496 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1497 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1498 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1499
1500 return r;
1501}
1502
1503static_always_inline uword
1504vlib_process_resume (vlib_process_t * p)
1505{
1506 uword r;
1507 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1508 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1509 | VLIB_PROCESS_RESUME_PENDING);
1510 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1511 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1512 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1513 return r;
1514}
1515
1516static u64
1517dispatch_process (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -04001518 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001519{
Dave Barach9b8ffd92016-07-08 08:13:45 -04001520 vlib_node_main_t *nm = &vm->node_main;
1521 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1522 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
Florin Corasfd542f12018-05-16 19:28:24 -07001523 u32 old_process_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001524 u64 t;
1525 uword n_vectors, is_suspend;
1526
1527 if (node->state != VLIB_NODE_STATE_POLLING
1528 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1529 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1530 return last_time_stamp;
1531
1532 p->flags |= VLIB_PROCESS_IS_RUNNING;
1533
1534 t = last_time_stamp;
1535 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1536 f ? f->n_vectors : 0, /* is_after */ 0);
1537
1538 /* Save away current process for suspend. */
Florin Corasfd542f12018-05-16 19:28:24 -07001539 old_process_index = nm->current_process_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001540 nm->current_process_index = node->runtime_index;
1541
1542 n_vectors = vlib_process_startup (vm, p, f);
1543
Florin Corasfd542f12018-05-16 19:28:24 -07001544 nm->current_process_index = old_process_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001545
1546 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1547 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1548 if (is_suspend)
1549 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04001550 vlib_pending_frame_t *pf;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001551
1552 n_vectors = 0;
1553 pool_get (nm->suspended_process_frames, pf);
1554 pf->node_runtime_index = node->runtime_index;
Andreas Schultz58b2eb12019-07-15 15:40:56 +02001555 pf->frame = f;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001556 pf->next_frame_index = ~0;
1557
1558 p->n_suspends += 1;
1559 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1560
1561 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
Dave Barach5c20a012017-06-13 08:48:31 -04001562 {
1563 TWT (tw_timer_wheel) * tw =
1564 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1565 p->stop_timer_handle =
1566 TW (tw_timer_start) (tw,
1567 vlib_timing_wheel_data_set_suspended_process
1568 (node->runtime_index) /* [sic] pool idex */ ,
1569 0 /* timer_id */ ,
1570 p->resume_clock_interval);
1571 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001572 }
1573 else
1574 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1575
1576 t = clib_cpu_time_now ();
1577
Dave Barach9b8ffd92016-07-08 08:13:45 -04001578 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1579 /* is_after */ 1);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001580
1581 vlib_process_update_stats (vm, p,
Dave Barach9b8ffd92016-07-08 08:13:45 -04001582 /* n_calls */ !is_suspend,
Ed Warnickecb9cada2015-12-08 15:45:58 -07001583 /* n_vectors */ n_vectors,
Dave Barachec595ef2019-01-24 10:34:24 -05001584 /* n_clocks */ t - last_time_stamp);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001585
1586 return t;
1587}
1588
Dave Barach9b8ffd92016-07-08 08:13:45 -04001589void
1590vlib_start_process (vlib_main_t * vm, uword process_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001591{
Dave Barach9b8ffd92016-07-08 08:13:45 -04001592 vlib_node_main_t *nm = &vm->node_main;
1593 vlib_process_t *p = vec_elt (nm->processes, process_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001594 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1595}
1596
1597static u64
1598dispatch_suspended_process (vlib_main_t * vm,
Dave Barach9b8ffd92016-07-08 08:13:45 -04001599 uword process_index, u64 last_time_stamp)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001600{
Dave Barach9b8ffd92016-07-08 08:13:45 -04001601 vlib_node_main_t *nm = &vm->node_main;
1602 vlib_node_runtime_t *node_runtime;
1603 vlib_node_t *node;
1604 vlib_frame_t *f;
1605 vlib_process_t *p;
1606 vlib_pending_frame_t *pf;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001607 u64 t, n_vectors, is_suspend;
Dave Barach9b8ffd92016-07-08 08:13:45 -04001608
Ed Warnickecb9cada2015-12-08 15:45:58 -07001609 t = last_time_stamp;
1610
1611 p = vec_elt (nm->processes, process_index);
Dave Barach9b8ffd92016-07-08 08:13:45 -04001612 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
Ed Warnickecb9cada2015-12-08 15:45:58 -07001613 return last_time_stamp;
1614
1615 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1616 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1617
Florin Coras221d6f12018-11-07 20:46:38 -08001618 pf = pool_elt_at_index (nm->suspended_process_frames,
1619 p->suspended_process_frame_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001620
1621 node_runtime = &p->node_runtime;
1622 node = vlib_get_node (vm, node_runtime->node_index);
Andreas Schultz58b2eb12019-07-15 15:40:56 +02001623 f = pf->frame;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001624
Dave Barach9b8ffd92016-07-08 08:13:45 -04001625 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1626 f ? f->n_vectors : 0, /* is_after */ 0);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001627
1628 /* Save away current process for suspend. */
1629 nm->current_process_index = node->runtime_index;
1630
1631 n_vectors = vlib_process_resume (p);
1632 t = clib_cpu_time_now ();
1633
1634 nm->current_process_index = ~0;
1635
1636 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1637 if (is_suspend)
1638 {
1639 /* Suspend it again. */
1640 n_vectors = 0;
1641 p->n_suspends += 1;
1642 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
Dave Barach5c20a012017-06-13 08:48:31 -04001643 {
1644 p->stop_timer_handle =
1645 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1646 vlib_timing_wheel_data_set_suspended_process
1647 (node->runtime_index) /* [sic] pool idex */ ,
1648 0 /* timer_id */ ,
1649 p->resume_clock_interval);
1650 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001651 }
1652 else
1653 {
1654 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
Florin Coras221d6f12018-11-07 20:46:38 -08001655 pool_put_index (nm->suspended_process_frames,
1656 p->suspended_process_frame_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001657 p->suspended_process_frame_index = ~0;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001658 }
1659
1660 t = clib_cpu_time_now ();
Dave Barach9b8ffd92016-07-08 08:13:45 -04001661 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1662 /* is_after */ 1);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001663
1664 vlib_process_update_stats (vm, p,
Dave Barach9b8ffd92016-07-08 08:13:45 -04001665 /* n_calls */ !is_suspend,
Ed Warnickecb9cada2015-12-08 15:45:58 -07001666 /* n_vectors */ n_vectors,
Dave Barachec595ef2019-01-24 10:34:24 -05001667 /* n_clocks */ t - last_time_stamp);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001668
1669 return t;
1670}
1671
Dave Barach2877eee2017-12-15 12:22:57 -05001672void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1673void
1674vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1675{
1676}
1677
1678
Damjan Marione9d52d52017-03-09 15:42:26 +01001679static_always_inline void
1680vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001681{
Dave Barach9b8ffd92016-07-08 08:13:45 -04001682 vlib_node_main_t *nm = &vm->node_main;
Damjan Marione9d52d52017-03-09 15:42:26 +01001683 vlib_thread_main_t *tm = vlib_get_thread_main ();
Ed Warnickecb9cada2015-12-08 15:45:58 -07001684 uword i;
1685 u64 cpu_time_now;
Damjan Marione9d52d52017-03-09 15:42:26 +01001686 vlib_frame_queue_main_t *fqm;
Damjan Marion2c2b6402017-03-28 14:16:15 +02001687 u32 *last_node_runtime_indices = 0;
Dave Barach80965f52019-03-11 09:57:38 -04001688 u32 frame_queue_check_counter = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001689
1690 /* Initialize pending node vector. */
Damjan Marione9d52d52017-03-09 15:42:26 +01001691 if (is_main)
1692 {
1693 vec_resize (nm->pending_frames, 32);
1694 _vec_len (nm->pending_frames) = 0;
1695 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001696
1697 /* Mark time of main loop start. */
Damjan Marione9d52d52017-03-09 15:42:26 +01001698 if (is_main)
1699 {
1700 cpu_time_now = vm->clib_time.last_cpu_time;
1701 vm->cpu_time_main_loop_start = cpu_time_now;
1702 }
1703 else
1704 cpu_time_now = clib_cpu_time_now ();
Ed Warnickecb9cada2015-12-08 15:45:58 -07001705
Damjan Marion2c2b6402017-03-28 14:16:15 +02001706 /* Pre-allocate interupt runtime indices and lock. */
Ed Warnickecb9cada2015-12-08 15:45:58 -07001707 vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
Damjan Marion2c2b6402017-03-28 14:16:15 +02001708 vec_alloc (last_node_runtime_indices, 32);
1709 if (!is_main)
1710 clib_spinlock_init (&nm->pending_interrupt_lock);
1711
1712 /* Pre-allocate expired nodes. */
Steven7312cc72017-03-15 21:18:55 -07001713 if (!nm->polling_threshold_vector_length)
1714 nm->polling_threshold_vector_length = 10;
1715 if (!nm->interrupt_threshold_vector_length)
1716 nm->interrupt_threshold_vector_length = 5;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001717
Damjan Marion29c0b332019-01-28 13:41:27 +01001718 vm->cpu_id = clib_get_current_cpu_id ();
1719 vm->numa_node = clib_get_current_numa_node ();
Florin Coras4c959952020-02-09 18:09:31 +00001720 os_set_numa_index (vm->numa_node);
Damjan Marion29c0b332019-01-28 13:41:27 +01001721
Ed Warnickecb9cada2015-12-08 15:45:58 -07001722 /* Start all processes. */
Damjan Marione9d52d52017-03-09 15:42:26 +01001723 if (is_main)
1724 {
1725 uword i;
Dave Barachc602b382019-06-03 19:48:22 -04001726
1727 /*
1728 * Perform an initial barrier sync. Pays no attention to
1729 * the barrier sync hold-down timer scheme, which won't work
1730 * at this point in time.
1731 */
1732 vlib_worker_thread_initial_barrier_sync_and_release (vm);
1733
Stevenf3b53642017-05-01 14:03:02 -07001734 nm->current_process_index = ~0;
Damjan Marione9d52d52017-03-09 15:42:26 +01001735 for (i = 0; i < vec_len (nm->processes); i++)
1736 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1737 cpu_time_now);
1738 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001739
1740 while (1)
1741 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04001742 vlib_node_runtime_t *n;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001743
Dave Barach2877eee2017-12-15 12:22:57 -05001744 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
Dave Barachf6c68d72018-11-01 08:12:52 -04001745 {
1746 if (!is_main)
1747 vl_api_send_pending_rpc_requests (vm);
1748 }
Dave Barach2877eee2017-12-15 12:22:57 -05001749
Damjan Marione9d52d52017-03-09 15:42:26 +01001750 if (!is_main)
1751 {
1752 vlib_worker_thread_barrier_check ();
Dave Barach80965f52019-03-11 09:57:38 -04001753 if (PREDICT_FALSE (vm->check_frame_queues +
1754 frame_queue_check_counter))
1755 {
1756 u32 processed = 0;
1757
1758 if (vm->check_frame_queues)
1759 {
1760 frame_queue_check_counter = 100;
1761 vm->check_frame_queues = 0;
1762 }
1763
1764 vec_foreach (fqm, tm->frame_queue_mains)
1765 processed += vlib_frame_queue_dequeue (vm, fqm);
1766
1767 /* No handoff queue work found? */
1768 if (processed)
1769 frame_queue_check_counter = 100;
1770 else
1771 frame_queue_check_counter--;
1772 }
Dave Barach5f2cfb22019-05-20 10:28:57 -04001773 if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
1774 clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm);
Damjan Marione9d52d52017-03-09 15:42:26 +01001775 }
1776
Ed Warnickecb9cada2015-12-08 15:45:58 -07001777 /* Process pre-input nodes. */
Damjan Marionceab7882018-01-19 20:56:12 +01001778 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1779 cpu_time_now = dispatch_node (vm, n,
1780 VLIB_NODE_TYPE_PRE_INPUT,
1781 VLIB_NODE_STATE_POLLING,
1782 /* frame */ 0,
1783 cpu_time_now);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001784
1785 /* Next process input nodes. */
1786 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1787 cpu_time_now = dispatch_node (vm, n,
1788 VLIB_NODE_TYPE_INPUT,
1789 VLIB_NODE_STATE_POLLING,
1790 /* frame */ 0,
1791 cpu_time_now);
1792
Damjan Marione9d52d52017-03-09 15:42:26 +01001793 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
Dave Barach9b8ffd92016-07-08 08:13:45 -04001794 vm->queue_signal_callback (vm);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001795
1796 /* Next handle interrupts. */
1797 {
Dave Barachd47c5092018-01-19 13:09:20 -05001798 /* unlocked read, for performance */
Ed Warnickecb9cada2015-12-08 15:45:58 -07001799 uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1800 uword i;
Dave Barachd47c5092018-01-19 13:09:20 -05001801 if (PREDICT_FALSE (l > 0))
Ed Warnickecb9cada2015-12-08 15:45:58 -07001802 {
Damjan Marion2c2b6402017-03-28 14:16:15 +02001803 u32 *tmp;
1804 if (!is_main)
Dave Barachd47c5092018-01-19 13:09:20 -05001805 {
1806 clib_spinlock_lock (&nm->pending_interrupt_lock);
1807 /* Re-read w/ lock held, in case another thread added an item */
1808 l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1809 }
1810
Damjan Marion2c2b6402017-03-28 14:16:15 +02001811 tmp = nm->pending_interrupt_node_runtime_indices;
1812 nm->pending_interrupt_node_runtime_indices =
1813 last_node_runtime_indices;
1814 last_node_runtime_indices = tmp;
1815 _vec_len (last_node_runtime_indices) = 0;
1816 if (!is_main)
1817 clib_spinlock_unlock (&nm->pending_interrupt_lock);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001818 for (i = 0; i < l; i++)
1819 {
1820 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
Damjan Marion2c2b6402017-03-28 14:16:15 +02001821 last_node_runtime_indices[i]);
Dave Barach9b8ffd92016-07-08 08:13:45 -04001822 cpu_time_now =
1823 dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1824 VLIB_NODE_STATE_INTERRUPT,
1825 /* frame */ 0,
1826 cpu_time_now);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001827 }
1828 }
1829 }
Dave Barache3248982018-08-14 13:47:58 -04001830 /* Input nodes may have added work to the pending vector.
1831 Process pending vector until there is nothing left.
1832 All pending vectors will be processed from input -> output. */
1833 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1834 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1835 /* Reset pending vector for next iteration. */
1836 _vec_len (nm->pending_frames) = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001837
Damjan Marione9d52d52017-03-09 15:42:26 +01001838 if (is_main)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001839 {
Dave Barach900cbad2019-01-31 19:12:51 -05001840 /* *INDENT-OFF* */
1841 ELOG_TYPE_DECLARE (es) =
1842 {
1843 .format = "process tw start",
1844 .format_args = "",
1845 };
1846 ELOG_TYPE_DECLARE (ee) =
1847 {
1848 .format = "process tw end: %d",
1849 .format_args = "i4",
1850 };
1851 /* *INDENT-ON* */
1852
1853 struct
1854 {
1855 int nready_procs;
1856 } *ed;
1857
Damjan Marione9d52d52017-03-09 15:42:26 +01001858 /* Check if process nodes have expired from timing wheel. */
Dave Barach5c20a012017-06-13 08:48:31 -04001859 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1860
Dave Barach900cbad2019-01-31 19:12:51 -05001861 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1862 ed = ELOG_DATA (&vlib_global_main.elog_main, es);
1863
Dave Barach5c20a012017-06-13 08:48:31 -04001864 nm->data_from_advancing_timing_wheel =
1865 TW (tw_timer_expire_timers_vec)
1866 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1867 nm->data_from_advancing_timing_wheel);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001868
Damjan Marione9d52d52017-03-09 15:42:26 +01001869 ASSERT (nm->data_from_advancing_timing_wheel != 0);
Dave Barach5c20a012017-06-13 08:48:31 -04001870
Dave Barach900cbad2019-01-31 19:12:51 -05001871 if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
1872 {
1873 ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
1874 ed->nready_procs =
1875 _vec_len (nm->data_from_advancing_timing_wheel);
1876 }
1877
Damjan Marione9d52d52017-03-09 15:42:26 +01001878 if (PREDICT_FALSE
1879 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
Ed Warnickecb9cada2015-12-08 15:45:58 -07001880 {
Damjan Marione9d52d52017-03-09 15:42:26 +01001881 uword i;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001882
Damjan Marione9d52d52017-03-09 15:42:26 +01001883 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1884 i++)
Ed Warnickecb9cada2015-12-08 15:45:58 -07001885 {
Damjan Marione9d52d52017-03-09 15:42:26 +01001886 u32 d = nm->data_from_advancing_timing_wheel[i];
1887 u32 di = vlib_timing_wheel_data_get_index (d);
1888
1889 if (vlib_timing_wheel_data_is_timed_event (d))
1890 {
1891 vlib_signal_timed_event_data_t *te =
1892 pool_elt_at_index (nm->signal_timed_event_data_pool,
1893 di);
1894 vlib_node_t *n =
1895 vlib_get_node (vm, te->process_node_index);
1896 vlib_process_t *p =
1897 vec_elt (nm->processes, n->runtime_index);
1898 void *data;
1899 data =
1900 vlib_process_signal_event_helper (nm, n, p,
1901 te->event_type_index,
1902 te->n_data_elts,
1903 te->n_data_elt_bytes);
1904 if (te->n_data_bytes < sizeof (te->inline_event_data))
Dave Barach178cf492018-11-13 16:34:13 -05001905 clib_memcpy_fast (data, te->inline_event_data,
1906 te->n_data_bytes);
Damjan Marione9d52d52017-03-09 15:42:26 +01001907 else
1908 {
Dave Barach178cf492018-11-13 16:34:13 -05001909 clib_memcpy_fast (data, te->event_data_as_vector,
1910 te->n_data_bytes);
Damjan Marione9d52d52017-03-09 15:42:26 +01001911 vec_free (te->event_data_as_vector);
1912 }
1913 pool_put (nm->signal_timed_event_data_pool, te);
1914 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001915 else
1916 {
Damjan Marione9d52d52017-03-09 15:42:26 +01001917 cpu_time_now = clib_cpu_time_now ();
1918 cpu_time_now =
1919 dispatch_suspended_process (vm, di, cpu_time_now);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001920 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001921 }
Damjan Marione9d52d52017-03-09 15:42:26 +01001922 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1923 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001924 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07001925 vlib_increment_main_loop_counter (vm);
Ed Warnickecb9cada2015-12-08 15:45:58 -07001926 /* Record time stamp in case there are no enabled nodes and above
Dave Barach9b8ffd92016-07-08 08:13:45 -04001927 calls do not update time stamp. */
Ed Warnickecb9cada2015-12-08 15:45:58 -07001928 cpu_time_now = clib_cpu_time_now ();
1929 }
1930}
Dave Barach9b8ffd92016-07-08 08:13:45 -04001931
Damjan Marione9d52d52017-03-09 15:42:26 +01001932static void
1933vlib_main_loop (vlib_main_t * vm)
1934{
1935 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1936}
1937
1938void
1939vlib_worker_loop (vlib_main_t * vm)
1940{
1941 vlib_main_or_worker_loop (vm, /* is_main */ 0);
1942}
1943
Ed Warnickecb9cada2015-12-08 15:45:58 -07001944vlib_main_t vlib_global_main;
1945
1946static clib_error_t *
1947vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1948{
1949 int turn_on_mem_trace = 0;
1950
1951 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1952 {
1953 if (unformat (input, "memory-trace"))
1954 turn_on_mem_trace = 1;
1955
1956 else if (unformat (input, "elog-events %d",
1957 &vm->elog_main.event_ring_size))
1958 ;
Dave Barach81481312017-05-16 09:08:14 -04001959 else if (unformat (input, "elog-post-mortem-dump"))
1960 vm->elog_post_mortem_dump = 1;
Ed Warnickecb9cada2015-12-08 15:45:58 -07001961 else
1962 return unformat_parse_error (input);
1963 }
1964
1965 unformat_free (input);
1966
1967 /* Enable memory trace as early as possible. */
1968 if (turn_on_mem_trace)
1969 clib_mem_trace (1);
1970
1971 return 0;
1972}
1973
1974VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1975
Dave Barach9b8ffd92016-07-08 08:13:45 -04001976static void
1977dummy_queue_signal_callback (vlib_main_t * vm)
1978{
1979}
Dave Barach16c75df2016-05-31 14:05:46 -04001980
Dave Barach1f806582018-06-14 09:18:21 -04001981#define foreach_weak_reference_stub \
1982_(vlib_map_stat_segment_init) \
1983_(vpe_api_init) \
1984_(vlibmemory_init) \
1985_(map_api_segment_init)
1986
1987#define _(name) \
1988clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
1989clib_error_t *name (vlib_main_t *vm) { return 0; }
1990foreach_weak_reference_stub;
1991#undef _
1992
Dave Barachb09f4d02019-07-15 16:00:03 -04001993void vl_api_set_elog_main (elog_main_t * m) __attribute__ ((weak));
1994void
1995vl_api_set_elog_main (elog_main_t * m)
1996{
1997 clib_warning ("STUB");
1998}
1999
2000int vl_api_set_elog_trace_api_messages (int enable) __attribute__ ((weak));
2001int
2002vl_api_set_elog_trace_api_messages (int enable)
2003{
2004 clib_warning ("STUB");
2005 return 0;
2006}
2007
2008int vl_api_get_elog_trace_api_messages (void) __attribute__ ((weak));
2009int
2010vl_api_get_elog_trace_api_messages (void)
2011{
2012 clib_warning ("STUB");
2013 return 0;
2014}
2015
Ed Warnickecb9cada2015-12-08 15:45:58 -07002016/* Main function. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002017int
Eyal Barid334a6b2016-09-19 10:23:39 +03002018vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002019{
Eyal Barid334a6b2016-09-19 10:23:39 +03002020 clib_error_t *volatile error;
Dave Barach5c20a012017-06-13 08:48:31 -04002021 vlib_node_main_t *nm = &vm->node_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002022
Dave Barach16c75df2016-05-31 14:05:46 -04002023 vm->queue_signal_callback = dummy_queue_signal_callback;
2024
Ed Warnickecb9cada2015-12-08 15:45:58 -07002025 /* Turn on event log. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002026 if (!vm->elog_main.event_ring_size)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002027 vm->elog_main.event_ring_size = 128 << 10;
2028 elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
2029 elog_enable_disable (&vm->elog_main, 1);
Dave Barachb09f4d02019-07-15 16:00:03 -04002030 vl_api_set_elog_main (&vm->elog_main);
2031 (void) vl_api_set_elog_trace_api_messages (1);
Ed Warnickecb9cada2015-12-08 15:45:58 -07002032
2033 /* Default name. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002034 if (!vm->name)
Ed Warnickecb9cada2015-12-08 15:45:58 -07002035 vm->name = "VLIB";
2036
Damjan Marion68b4da62018-09-30 18:26:20 +02002037 if ((error = vlib_physmem_init (vm)))
Damjan Marion04a7f052017-07-10 15:06:17 +02002038 {
Damjan Marion49d66f12017-07-20 18:10:35 +02002039 clib_error_report (error);
2040 goto done;
Damjan Marion04a7f052017-07-10 15:06:17 +02002041 }
Damjan Marion49d66f12017-07-20 18:10:35 +02002042
Filip Tehlard2bbdef2019-02-22 05:05:53 -08002043 if ((error = vlib_map_stat_segment_init (vm)))
2044 {
2045 clib_error_report (error);
2046 goto done;
2047 }
2048
Damjan Marion49d66f12017-07-20 18:10:35 +02002049 if ((error = vlib_buffer_main_init (vm)))
Damjan Marion04a7f052017-07-10 15:06:17 +02002050 {
Damjan Marion49d66f12017-07-20 18:10:35 +02002051 clib_error_report (error);
2052 goto done;
Damjan Marion04a7f052017-07-10 15:06:17 +02002053 }
Ed Warnickecb9cada2015-12-08 15:45:58 -07002054
2055 if ((error = vlib_thread_init (vm)))
2056 {
2057 clib_error_report (error);
2058 goto done;
2059 }
2060
2061 /* Register static nodes so that init functions may use them. */
2062 vlib_register_all_static_nodes (vm);
2063
2064 /* Set seed for random number generator.
2065 Allow user to specify seed to make random sequence deterministic. */
Dave Barach9b8ffd92016-07-08 08:13:45 -04002066 if (!unformat (input, "seed %wd", &vm->random_seed))
Ed Warnickecb9cada2015-12-08 15:45:58 -07002067 vm->random_seed = clib_cpu_time_now ();
2068 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
2069
Ed Warnickecb9cada2015-12-08 15:45:58 -07002070 /* Initialize node graph. */
2071 if ((error = vlib_node_main_init (vm)))
2072 {
2073 /* Arrange for graph hook up error to not be fatal when debugging. */
2074 if (CLIB_DEBUG > 0)
2075 clib_error_report (error);
2076 else
2077 goto done;
2078 }
2079
Dave Barach1f806582018-06-14 09:18:21 -04002080 /* Direct call / weak reference, for vlib standalone use-cases */
2081 if ((error = vpe_api_init (vm)))
Dave Barach048a4e52018-06-01 18:52:25 -04002082 {
2083 clib_error_report (error);
2084 goto done;
2085 }
2086
Dave Barach1f806582018-06-14 09:18:21 -04002087 if ((error = vlibmemory_init (vm)))
Dave Barach048a4e52018-06-01 18:52:25 -04002088 {
2089 clib_error_report (error);
2090 goto done;
2091 }
2092
Dave Barach1f806582018-06-14 09:18:21 -04002093 if ((error = map_api_segment_init (vm)))
Dave Barach048a4e52018-06-01 18:52:25 -04002094 {
2095 clib_error_report (error);
2096 goto done;
2097 }
2098
Ole Troan964f93e2016-06-10 13:22:36 +02002099 /* See unix/main.c; most likely already set up */
2100 if (vm->init_functions_called == 0)
Dave Barach9b8ffd92016-07-08 08:13:45 -04002101 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
Ole Troan964f93e2016-06-10 13:22:36 +02002102 if ((error = vlib_call_all_init_functions (vm)))
2103 goto done;
2104
Dave Barach5c20a012017-06-13 08:48:31 -04002105 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
2106 CLIB_CACHE_LINE_BYTES);
2107
2108 vec_validate (nm->data_from_advancing_timing_wheel, 10);
2109 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
2110
2111 /* Create the process timing wheel */
2112 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
2113 0 /* no callback */ ,
2114 10e-6 /* timer period 10us */ ,
2115 ~0 /* max expirations per call */ );
2116
Dave Barach2877eee2017-12-15 12:22:57 -05002117 vec_validate (vm->pending_rpc_requests, 0);
2118 _vec_len (vm->pending_rpc_requests) = 0;
Dave Barachf6c68d72018-11-01 08:12:52 -04002119 vec_validate (vm->processing_rpc_requests, 0);
2120 _vec_len (vm->processing_rpc_requests) = 0;
Dave Barach2877eee2017-12-15 12:22:57 -05002121
Dave Barachd1e17d02019-03-21 18:01:48 -04002122 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
2123 goto done;
2124
Dave Barachc602b382019-06-03 19:48:22 -04002125 /* Sort per-thread init functions before we start threads */
2126 vlib_sort_init_exit_functions (&vm->worker_init_function_registrations);
2127
Dave Barachd1e17d02019-03-21 18:01:48 -04002128 /* Call all main loop enter functions. */
2129 {
2130 clib_error_t *sub_error;
2131 sub_error = vlib_call_all_main_loop_enter_functions (vm);
2132 if (sub_error)
2133 clib_error_report (sub_error);
2134 }
2135
Ed Warnickecb9cada2015-12-08 15:45:58 -07002136 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
2137 {
2138 case VLIB_MAIN_LOOP_EXIT_NONE:
2139 vm->main_loop_exit_set = 1;
2140 break;
2141
2142 case VLIB_MAIN_LOOP_EXIT_CLI:
2143 goto done;
2144
2145 default:
2146 error = vm->main_loop_error;
2147 goto done;
2148 }
2149
Ed Warnickecb9cada2015-12-08 15:45:58 -07002150 vlib_main_loop (vm);
2151
Dave Barach9b8ffd92016-07-08 08:13:45 -04002152done:
Ed Warnickecb9cada2015-12-08 15:45:58 -07002153 /* Call all exit functions. */
2154 {
Dave Barach9b8ffd92016-07-08 08:13:45 -04002155 clib_error_t *sub_error;
Ed Warnickecb9cada2015-12-08 15:45:58 -07002156 sub_error = vlib_call_all_main_loop_exit_functions (vm);
2157 if (sub_error)
2158 clib_error_report (sub_error);
2159 }
2160
2161 if (error)
2162 clib_error_report (error);
2163
2164 return 0;
2165}
Dave Barach9b8ffd92016-07-08 08:13:45 -04002166
Dave Barache5948fb2019-08-29 18:01:30 -04002167int
2168vlib_pcap_dispatch_trace_configure (vlib_pcap_dispatch_trace_args_t * a)
Dave Barach3ae28732018-11-16 17:19:00 -05002169{
Dave Barache5948fb2019-08-29 18:01:30 -04002170 vlib_main_t *vm = vlib_get_main ();
Dave Barach3ae28732018-11-16 17:19:00 -05002171 pcap_main_t *pm = &vm->dispatch_pcap_main;
Dave Barach1201a802018-11-20 12:08:39 -05002172 vlib_trace_main_t *tm;
2173 vlib_trace_node_t *tn;
Dave Barach3ae28732018-11-16 17:19:00 -05002174
Dave Barache5948fb2019-08-29 18:01:30 -04002175 if (a->status)
2176 {
2177 if (vm->dispatch_pcap_enable)
2178 {
2179 int i;
2180 vlib_cli_output
2181 (vm, "pcap dispatch capture enabled: %d of %d pkts...",
2182 pm->n_packets_captured, pm->n_packets_to_capture);
2183 vlib_cli_output (vm, "capture to file %s", pm->file_name);
2184
2185 for (i = 0; i < vec_len (vm->dispatch_buffer_trace_nodes); i++)
2186 {
2187 vlib_cli_output (vm,
2188 "Buffer trace of %d pkts from %U enabled...",
2189 a->buffer_traces_to_capture,
2190 format_vlib_node_name, vm,
2191 vm->dispatch_buffer_trace_nodes[i]);
2192 }
2193 }
2194 else
2195 vlib_cli_output (vm, "pcap dispatch capture disabled");
2196 return 0;
2197 }
2198
2199 /* Consistency checks */
2200
2201 /* Enable w/ capture already enabled not allowed */
2202 if (vm->dispatch_pcap_enable && a->enable)
2203 return -7; /* VNET_API_ERROR_INVALID_VALUE */
2204
2205 /* Disable capture with capture already disabled, not interesting */
2206 if (vm->dispatch_pcap_enable == 0 && a->enable == 0)
2207 return -81; /* VNET_API_ERROR_VALUE_EXIST */
2208
2209 /* Change number of packets to capture while capturing */
Dave Barachb97641c2019-09-09 16:38:17 -04002210 if (vm->dispatch_pcap_enable && a->enable
Dave Barache5948fb2019-08-29 18:01:30 -04002211 && (pm->n_packets_to_capture != a->packets_to_capture))
2212 return -8; /* VNET_API_ERROR_INVALID_VALUE_2 */
2213
2214 /* Independent of enable/disable, to allow buffer trace multi nodes */
2215 if (a->buffer_trace_node_index != ~0)
2216 {
2217 /* *INDENT-OFF* */
2218 foreach_vlib_main ((
2219 {
2220 tm = &this_vlib_main->trace_main;
2221 tm->verbose = 0; /* not sure this ever did anything... */
2222 vec_validate (tm->nodes, a->buffer_trace_node_index);
2223 tn = tm->nodes + a->buffer_trace_node_index;
2224 tn->limit += a->buffer_traces_to_capture;
2225 tm->trace_enable = 1;
2226 }));
2227 /* *INDENT-ON* */
2228 vec_add1 (vm->dispatch_buffer_trace_nodes, a->buffer_trace_node_index);
2229 }
2230
2231 if (a->enable)
2232 {
2233 /* Clean up from previous run, if any */
2234 vec_free (pm->file_name);
2235 vec_free (pm->pcap_data);
2236 memset (pm, 0, sizeof (*pm));
2237
2238 vec_validate_aligned (vnet_trace_dummy, 2048, CLIB_CACHE_LINE_BYTES);
2239 if (pm->lock == 0)
2240 clib_spinlock_init (&(pm->lock));
2241
2242 if (a->filename == 0)
2243 a->filename = format (0, "/tmp/dispatch.pcap%c", 0);
2244
2245 pm->file_name = (char *) a->filename;
2246 pm->n_packets_captured = 0;
2247 pm->packet_type = PCAP_PACKET_TYPE_vpp;
Dave Barache5948fb2019-08-29 18:01:30 -04002248 pm->n_packets_to_capture = a->packets_to_capture;
Dave Barach349cd1a2019-10-18 14:44:05 -04002249 /* *INDENT-OFF* */
2250 foreach_vlib_main (({this_vlib_main->dispatch_pcap_enable = 1;}));
2251 /* *INDENT-ON* */
Dave Barache5948fb2019-08-29 18:01:30 -04002252 }
2253 else
2254 {
Dave Barach349cd1a2019-10-18 14:44:05 -04002255 /* *INDENT-OFF* */
2256 foreach_vlib_main (({this_vlib_main->dispatch_pcap_enable = 0;}));
2257 /* *INDENT-ON* */
Dave Barache5948fb2019-08-29 18:01:30 -04002258 vec_reset_length (vm->dispatch_buffer_trace_nodes);
2259 if (pm->n_packets_captured)
2260 {
2261 clib_error_t *error;
2262 pm->n_packets_to_capture = pm->n_packets_captured;
2263 vlib_cli_output (vm, "Write %d packets to %s, and stop capture...",
2264 pm->n_packets_captured, pm->file_name);
2265 error = pcap_write (pm);
Andrew Yourtchenko4da15062019-09-11 14:14:43 +00002266 if (pm->flags & PCAP_MAIN_INIT_DONE)
Dave Barache5948fb2019-08-29 18:01:30 -04002267 pcap_close (pm);
2268 /* Report I/O errors... */
2269 if (error)
2270 {
2271 clib_error_report (error);
2272 return -11; /* VNET_API_ERROR_SYSCALL_ERROR_1 */
2273 }
2274 return 0;
2275 }
2276 else
2277 return -6; /* VNET_API_ERROR_NO_SUCH_ENTRY */
2278 }
2279
2280 return 0;
2281}
2282
2283static clib_error_t *
2284dispatch_trace_command_fn (vlib_main_t * vm,
2285 unformat_input_t * input, vlib_cli_command_t * cmd)
2286{
2287 unformat_input_t _line_input, *line_input = &_line_input;
2288 vlib_pcap_dispatch_trace_args_t _a, *a = &_a;
2289 u8 *filename = 0;
2290 u32 max = 1000;
2291 int rv;
2292 int enable = 0;
2293 int status = 0;
2294 u32 node_index = ~0, buffer_traces_to_capture = 100;
2295
Dave Barach3ae28732018-11-16 17:19:00 -05002296 /* Get a line of input. */
2297 if (!unformat_user (input, unformat_line_input, line_input))
2298 return 0;
2299
2300 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2301 {
Dave Barache5948fb2019-08-29 18:01:30 -04002302 if (unformat (line_input, "on %=", &enable, 1))
2303 ;
2304 else if (unformat (line_input, "enable %=", &enable, 1))
2305 ;
2306 else if (unformat (line_input, "off %=", &enable, 0))
2307 ;
2308 else if (unformat (line_input, "disable %=", &enable, 0))
2309 ;
Dave Barach3ae28732018-11-16 17:19:00 -05002310 else if (unformat (line_input, "max %d", &max))
Dave Barache5948fb2019-08-29 18:01:30 -04002311 ;
2312 else if (unformat (line_input, "packets-to-capture %d", &max))
2313 ;
2314 else if (unformat (line_input, "file %U", unformat_vlib_tmpfile,
2315 &filename))
2316 ;
2317 else if (unformat (line_input, "status %=", &status, 1))
2318 ;
Dave Barach1201a802018-11-20 12:08:39 -05002319 else if (unformat (line_input, "buffer-trace %U %d",
Dave Barache5948fb2019-08-29 18:01:30 -04002320 unformat_vlib_node, vm, &node_index,
2321 &buffer_traces_to_capture))
2322 ;
Dave Barach3ae28732018-11-16 17:19:00 -05002323 else
2324 {
Dave Barache5948fb2019-08-29 18:01:30 -04002325 return clib_error_return (0, "unknown input `%U'",
2326 format_unformat_error, line_input);
Dave Barach3ae28732018-11-16 17:19:00 -05002327 }
2328 }
Dave Barache5948fb2019-08-29 18:01:30 -04002329
Dave Barach3ae28732018-11-16 17:19:00 -05002330 unformat_free (line_input);
2331
Dave Barache5948fb2019-08-29 18:01:30 -04002332 /* no need for memset (a, 0, sizeof (*a)), set all fields here. */
2333 a->filename = filename;
2334 a->enable = enable;
2335 a->status = status;
2336 a->packets_to_capture = max;
2337 a->buffer_trace_node_index = node_index;
2338 a->buffer_traces_to_capture = buffer_traces_to_capture;
2339
2340 rv = vlib_pcap_dispatch_trace_configure (a);
2341
2342 switch (rv)
Dave Barach3ae28732018-11-16 17:19:00 -05002343 {
Dave Barache5948fb2019-08-29 18:01:30 -04002344 case 0:
2345 break;
Dave Barach3ae28732018-11-16 17:19:00 -05002346
Dave Barache5948fb2019-08-29 18:01:30 -04002347 case -7:
2348 return clib_error_return (0, "dispatch trace already enabled...");
Dave Barach3ae28732018-11-16 17:19:00 -05002349
Dave Barache5948fb2019-08-29 18:01:30 -04002350 case -81:
2351 return clib_error_return (0, "dispatch trace already disabled...");
Dave Barach3ae28732018-11-16 17:19:00 -05002352
Dave Barache5948fb2019-08-29 18:01:30 -04002353 case -8:
2354 return clib_error_return
2355 (0, "can't change number of records to capture while tracing...");
2356
2357 case -11:
2358 return clib_error_return (0, "I/O writing trace capture...");
2359
2360 case -6:
2361 return clib_error_return (0, "No packets captured...");
2362
2363 default:
2364 vlib_cli_output (vm, "WARNING: trace configure returned %d", rv);
2365 break;
Dave Barach3ae28732018-11-16 17:19:00 -05002366 }
Dave Barache5948fb2019-08-29 18:01:30 -04002367 return 0;
Dave Barach3ae28732018-11-16 17:19:00 -05002368}
2369
2370/*?
2371 * This command is used to start or stop pcap dispatch trace capture, or show
2372 * the capture status.
2373 *
2374 * This command has the following optional parameters:
2375 *
2376 * - <b>on|off</b> - Used to start or stop capture.
2377 *
2378 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
2379 * of packets have been received, buffer is flushed to file. Once another
2380 * '<em>nn</em>' number of packets have been received, buffer is flushed
2381 * to file, overwriting previous write. If not entered, value defaults
2382 * to 100. Can only be updated if packet capture is off.
2383 *
2384 * - <b>file <name></b> - Used to specify the output filename. The file will
2385 * be placed in the '<em>/tmp</em>' directory, so only the filename is
2386 * supported. Directory should not be entered. If file already exists, file
2387 * will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
2388 * will be used. Can only be updated if packet capture is off.
2389 *
2390 * - <b>status</b> - Displays the current status and configured attributes
2391 * associated with a packet capture. If packet capture is in progress,
2392 * '<em>status</em>' also will return the number of packets currently in
2393 * the local buffer. All additional attributes entered on command line
2394 * with '<em>status</em>' will be ignored and not applied.
2395 *
2396 * @cliexpar
2397 * Example of how to display the status of capture when off:
2398 * @cliexstart{pcap dispatch trace status}
2399 * max is 100, for any interface to file /tmp/vpe.pcap
2400 * pcap dispatch capture is off...
2401 * @cliexend
2402 * Example of how to start a dispatch trace capture:
2403 * @cliexstart{pcap dispatch trace on max 35 file dispatchTrace.pcap}
Dave Barach1201a802018-11-20 12:08:39 -05002404 * pcap dispatch capture on...
2405 * @cliexend
2406 * Example of how to start a dispatch trace capture with buffer tracing
2407 * @cliexstart{pcap dispatch trace on max 10000 file dispatchTrace.pcap buffer-trace dpdk-input 1000}
2408 * pcap dispatch capture on...
Dave Barach3ae28732018-11-16 17:19:00 -05002409 * @cliexend
2410 * Example of how to display the status of a tx packet capture in progress:
2411 * @cliexstart{pcap tx trace status}
2412 * max is 35, dispatch trace to file /tmp/vppTest.pcap
2413 * pcap tx capture is on: 20 of 35 pkts...
2414 * @cliexend
2415 * Example of how to stop a tx packet capture:
2416 * @cliexstart{vppctl pcap dispatch trace off}
2417 * captured 21 pkts...
2418 * saved to /tmp/dispatchTrace.pcap...
2419 * @cliexend
2420?*/
2421/* *INDENT-OFF* */
2422VLIB_CLI_COMMAND (pcap_dispatch_trace_command, static) = {
2423 .path = "pcap dispatch trace",
2424 .short_help =
Dave Barach1201a802018-11-20 12:08:39 -05002425 "pcap dispatch trace [on|off] [max <nn>] [file <name>] [status]\n"
2426 " [buffer-trace <input-node-name> <nn>]",
Dave Barache5948fb2019-08-29 18:01:30 -04002427 .function = dispatch_trace_command_fn,
Dave Barach3ae28732018-11-16 17:19:00 -05002428};
2429/* *INDENT-ON* */
2430
Dave Barach9b8ffd92016-07-08 08:13:45 -04002431/*
2432 * fd.io coding-style-patch-verification: ON
2433 *
2434 * Local Variables:
2435 * eval: (c-set-style "gnu")
2436 * End:
2437 */