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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * main.c: main vector processing loop
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
41 #include <vppinfra/format.h>
42 #include <vlib/vlib.h>
43 #include <vlib/threads.h>
44 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
46 #include <vlib/unix/unix.h>
47 #include <vlib/unix/cj.h>
49 CJ_GLOBAL_LOG_PROTOTYPE;
51 /* 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)
58 vlib_frame_bytes (u32 n_scalar_bytes, u32 n_vector_bytes)
62 /* Make room for vlib_frame_t plus scalar arguments. */
63 n_bytes = vlib_frame_vector_byte_offset (n_scalar_bytes);
65 /* Make room for vector arguments.
66 Allocate a few extra slots of vector data to support
67 speculative vector enqueues which overflow vector data in next frame. */
68 #define VLIB_FRAME_SIZE_EXTRA 4
69 n_bytes += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * n_vector_bytes;
71 /* Magic number is first 32bit number after vector data.
72 Used to make sure that vector data is never overrun. */
73 #define VLIB_FRAME_MAGIC (0xabadc0ed)
74 n_bytes += sizeof (u32);
76 /* Pad to cache line. */
77 n_bytes = round_pow2 (n_bytes, CLIB_CACHE_LINE_BYTES);
83 vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
87 p += vlib_frame_vector_byte_offset (node->scalar_size);
89 p += (VLIB_FRAME_SIZE + VLIB_FRAME_SIZE_EXTRA) * node->vector_size;
94 static vlib_frame_size_t *
95 get_frame_size_info (vlib_node_main_t * nm,
96 u32 n_scalar_bytes, u32 n_vector_bytes)
98 uword key = (n_scalar_bytes << 16) | n_vector_bytes;
101 p = hash_get (nm->frame_size_hash, key);
106 i = vec_len (nm->frame_sizes);
107 vec_validate (nm->frame_sizes, i);
108 hash_set (nm->frame_size_hash, key, i);
111 return vec_elt_at_index (nm->frame_sizes, i);
115 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
118 vlib_node_main_t *nm = &vm->node_main;
119 vlib_frame_size_t *fs;
120 vlib_node_t *to_node;
122 u32 fi, l, n, scalar_size, vector_size;
124 to_node = vlib_get_node (vm, to_node_index);
126 scalar_size = to_node->scalar_size;
127 vector_size = to_node->vector_size;
129 fs = get_frame_size_info (nm, scalar_size, vector_size);
130 n = vlib_frame_bytes (scalar_size, vector_size);
131 if ((l = vec_len (fs->free_frame_indices)) > 0)
133 /* Allocate from end of free list. */
134 fi = fs->free_frame_indices[l - 1];
135 f = vlib_get_frame_no_check (vm, fi);
136 _vec_len (fs->free_frame_indices) = l - 1;
140 f = clib_mem_alloc_aligned_no_fail (n, VLIB_FRAME_ALIGN);
141 fi = vlib_frame_index_no_check (vm, f);
144 /* Poison frame when debugging. */
146 clib_memset (f, 0xfe, n);
148 /* Insert magic number. */
152 magic = vlib_frame_find_magic (f, to_node);
153 *magic = VLIB_FRAME_MAGIC;
156 f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
158 f->scalar_size = scalar_size;
159 f->vector_size = vector_size;
161 fs->n_alloc_frames += 1;
166 /* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
167 Returns frame index. */
169 vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
172 vlib_node_t *from_node;
174 from_node = vlib_get_node (vm, from_node_runtime->node_index);
175 ASSERT (to_next_index < vec_len (from_node->next_nodes));
177 return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
178 /* frame_flags */ 0);
182 vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
184 u32 fi = vlib_frame_alloc_to_node (vm, to_node_index,
186 VLIB_FRAME_FREE_AFTER_DISPATCH);
187 return vlib_get_frame (vm, fi);
191 vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
193 vlib_pending_frame_t *p;
194 vlib_node_t *to_node;
196 if (f->n_vectors == 0)
199 to_node = vlib_get_node (vm, to_node_index);
201 vec_add2 (vm->node_main.pending_frames, p, 1);
203 f->frame_flags |= VLIB_FRAME_PENDING;
204 p->frame_index = vlib_frame_index (vm, f);
205 p->node_runtime_index = to_node->runtime_index;
206 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
209 /* Free given frame. */
211 vlib_frame_free (vlib_main_t * vm, vlib_node_runtime_t * r, vlib_frame_t * f)
213 vlib_node_main_t *nm = &vm->node_main;
215 vlib_frame_size_t *fs;
218 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
220 node = vlib_get_node (vm, r->node_index);
221 fs = get_frame_size_info (nm, node->scalar_size, node->vector_size);
223 frame_index = vlib_frame_index (vm, f);
225 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
227 /* No next frames may point to freed frame. */
230 vlib_next_frame_t *nf;
231 vec_foreach (nf, vm->node_main.next_frames)
232 ASSERT (nf->frame_index != frame_index);
235 f->frame_flags &= ~VLIB_FRAME_IS_ALLOCATED;
237 vec_add1 (fs->free_frame_indices, frame_index);
238 ASSERT (fs->n_alloc_frames > 0);
239 fs->n_alloc_frames -= 1;
242 static clib_error_t *
243 show_frame_stats (vlib_main_t * vm,
244 unformat_input_t * input, vlib_cli_command_t * cmd)
246 vlib_node_main_t *nm = &vm->node_main;
247 vlib_frame_size_t *fs;
249 vlib_cli_output (vm, "%=6s%=12s%=12s", "Size", "# Alloc", "# Free");
250 vec_foreach (fs, nm->frame_sizes)
252 u32 n_alloc = fs->n_alloc_frames;
253 u32 n_free = vec_len (fs->free_frame_indices);
255 if (n_alloc + n_free > 0)
256 vlib_cli_output (vm, "%=6d%=12d%=12d",
257 fs - nm->frame_sizes, n_alloc, n_free);
264 VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
265 .path = "show vlib frame-allocation",
266 .short_help = "Show node dispatch frame statistics",
267 .function = show_frame_stats,
271 /* Change ownership of enqueue rights to given next node. */
273 vlib_next_frame_change_ownership (vlib_main_t * vm,
274 vlib_node_runtime_t * node_runtime,
277 vlib_node_main_t *nm = &vm->node_main;
278 vlib_next_frame_t *next_frame;
279 vlib_node_t *node, *next_node;
281 node = vec_elt (nm->nodes, node_runtime->node_index);
283 /* Only internal & input nodes are allowed to call other nodes. */
284 ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
285 || node->type == VLIB_NODE_TYPE_INPUT
286 || node->type == VLIB_NODE_TYPE_PROCESS);
288 ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
291 vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
292 next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
294 if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
296 /* Get frame from previous owner. */
297 vlib_next_frame_t *owner_next_frame;
298 vlib_next_frame_t tmp;
301 vlib_node_get_next_frame (vm,
302 next_node->owner_node_index,
303 next_node->owner_next_index);
305 /* Swap target next frame with owner's. */
306 tmp = owner_next_frame[0];
307 owner_next_frame[0] = next_frame[0];
311 * If next_frame is already pending, we have to track down
312 * all pending frames and fix their next_frame_index fields.
314 if (next_frame->flags & VLIB_FRAME_PENDING)
316 vlib_pending_frame_t *p;
317 if (next_frame->frame_index != ~0)
319 vec_foreach (p, nm->pending_frames)
321 if (p->frame_index == next_frame->frame_index)
323 p->next_frame_index =
324 next_frame - vm->node_main.next_frames;
332 /* No previous owner. Take ownership. */
333 next_frame->flags |= VLIB_FRAME_OWNER;
336 /* Record new owner. */
337 next_node->owner_node_index = node->index;
338 next_node->owner_next_index = next_index;
340 /* Now we should be owner. */
341 ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
344 /* Make sure that magic number is still there.
345 Otherwise, it is likely that caller has overrun frame arguments. */
347 validate_frame_magic (vlib_main_t * vm,
348 vlib_frame_t * f, vlib_node_t * n, uword next_index)
350 vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
351 u32 *magic = vlib_frame_find_magic (f, next_node);
352 ASSERT (VLIB_FRAME_MAGIC == magic[0]);
356 vlib_get_next_frame_internal (vlib_main_t * vm,
357 vlib_node_runtime_t * node,
358 u32 next_index, u32 allocate_new_next_frame)
361 vlib_next_frame_t *nf;
364 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
366 /* Make sure this next frame owns right to enqueue to destination frame. */
367 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
368 vlib_next_frame_change_ownership (vm, node, next_index);
370 /* ??? Don't need valid flag: can use frame_index == ~0 */
371 if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
373 nf->frame_index = vlib_frame_alloc (vm, node, next_index);
374 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
377 f = vlib_get_frame (vm, nf->frame_index);
379 /* Has frame been removed from pending vector (e.g. finished dispatching)?
380 If so we can reuse frame. */
381 if ((nf->flags & VLIB_FRAME_PENDING)
382 && !(f->frame_flags & VLIB_FRAME_PENDING))
384 nf->flags &= ~VLIB_FRAME_PENDING;
388 /* Allocate new frame if current one is already full. */
389 n_used = f->n_vectors;
390 if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0))
392 /* Old frame may need to be freed after dispatch, since we'll have
393 two redundant frames from node -> next node. */
394 if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
396 vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame_index);
397 f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
400 /* Allocate new frame to replace full one. */
401 nf->frame_index = vlib_frame_alloc (vm, node, next_index);
402 f = vlib_get_frame (vm, nf->frame_index);
403 n_used = f->n_vectors;
406 /* Should have free vectors in frame now. */
407 ASSERT (n_used < VLIB_FRAME_SIZE);
411 validate_frame_magic (vm, f,
412 vlib_get_node (vm, node->node_index), next_index);
419 vlib_put_next_frame_validate (vlib_main_t * vm,
420 vlib_node_runtime_t * rt,
421 u32 next_index, u32 n_vectors_left)
423 vlib_node_main_t *nm = &vm->node_main;
424 vlib_next_frame_t *nf;
426 vlib_node_runtime_t *next_rt;
427 vlib_node_t *next_node;
428 u32 n_before, n_after;
430 nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
431 f = vlib_get_frame (vm, nf->frame_index);
433 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
434 n_after = VLIB_FRAME_SIZE - n_vectors_left;
435 n_before = f->n_vectors;
437 ASSERT (n_after >= n_before);
439 next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
440 nf->node_runtime_index);
441 next_node = vlib_get_node (vm, next_rt->node_index);
442 if (n_after > 0 && next_node->validate_frame)
444 u8 *msg = next_node->validate_frame (vm, rt, f);
447 clib_warning ("%v", msg);
455 vlib_put_next_frame (vlib_main_t * vm,
456 vlib_node_runtime_t * r,
457 u32 next_index, u32 n_vectors_left)
459 vlib_node_main_t *nm = &vm->node_main;
460 vlib_next_frame_t *nf;
462 u32 n_vectors_in_frame;
464 if (buffer_main.callbacks_registered == 0 && CLIB_DEBUG > 0)
465 vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
467 nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
468 f = vlib_get_frame (vm, nf->frame_index);
470 /* Make sure that magic number is still there. Otherwise, caller
471 has overrun frame meta data. */
474 vlib_node_t *node = vlib_get_node (vm, r->node_index);
475 validate_frame_magic (vm, f, node, next_index);
478 /* Convert # of vectors left -> number of vectors there. */
479 ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
480 n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
482 f->n_vectors = n_vectors_in_frame;
484 /* If vectors were added to frame, add to pending vector. */
485 if (PREDICT_TRUE (n_vectors_in_frame > 0))
487 vlib_pending_frame_t *p;
490 r->cached_next_index = next_index;
492 if (!(f->frame_flags & VLIB_FRAME_PENDING))
494 __attribute__ ((unused)) vlib_node_t *node;
495 vlib_node_t *next_node;
496 vlib_node_runtime_t *next_runtime;
498 node = vlib_get_node (vm, r->node_index);
499 next_node = vlib_get_next_node (vm, r->node_index, next_index);
500 next_runtime = vlib_node_get_runtime (vm, next_node->index);
502 vec_add2 (nm->pending_frames, p, 1);
504 p->frame_index = nf->frame_index;
505 p->node_runtime_index = nf->node_runtime_index;
506 p->next_frame_index = nf - nm->next_frames;
507 nf->flags |= VLIB_FRAME_PENDING;
508 f->frame_flags |= VLIB_FRAME_PENDING;
511 * If we're going to dispatch this frame on another thread,
512 * force allocation of a new frame. Otherwise, we create
513 * a dangling frame reference. Each thread has its own copy of
514 * the next_frames vector.
516 if (0 && r->thread_index != next_runtime->thread_index)
518 nf->frame_index = ~0;
519 nf->flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_IS_ALLOCATED);
523 /* Copy trace flag from next_frame and from runtime. */
525 (nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
526 flags & VLIB_NODE_FLAG_TRACE);
528 v0 = nf->vectors_since_last_overflow;
529 v1 = v0 + n_vectors_in_frame;
530 nf->vectors_since_last_overflow = v1;
531 if (PREDICT_FALSE (v1 < v0))
533 vlib_node_t *node = vlib_get_node (vm, r->node_index);
534 vec_elt (node->n_vectors_by_next_node, next_index) += v0;
539 /* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
541 vlib_node_runtime_sync_stats (vlib_main_t * vm,
542 vlib_node_runtime_t * r,
543 uword n_calls, uword n_vectors, uword n_clocks,
546 vlib_node_t *n = vlib_get_node (vm, r->node_index);
548 n->stats_total.calls += n_calls + r->calls_since_last_overflow;
549 n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
550 n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
551 n->stats_total.perf_counter_ticks += n_ticks +
552 r->perf_counter_ticks_since_last_overflow;
553 n->stats_total.perf_counter_vectors += n_vectors +
554 r->perf_counter_vectors_since_last_overflow;
555 n->stats_total.max_clock = r->max_clock;
556 n->stats_total.max_clock_n = r->max_clock_n;
558 r->calls_since_last_overflow = 0;
559 r->vectors_since_last_overflow = 0;
560 r->clocks_since_last_overflow = 0;
561 r->perf_counter_ticks_since_last_overflow = 0ULL;
562 r->perf_counter_vectors_since_last_overflow = 0ULL;
565 always_inline void __attribute__ ((unused))
566 vlib_process_sync_stats (vlib_main_t * vm,
568 uword n_calls, uword n_vectors, uword n_clocks,
571 vlib_node_runtime_t *rt = &p->node_runtime;
572 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
573 vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks,
575 n->stats_total.suspends += p->n_suspends;
580 vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
582 vlib_node_runtime_t *rt;
584 if (n->type == VLIB_NODE_TYPE_PROCESS)
586 /* Nothing to do for PROCESS nodes except in main thread */
587 if (vm != &vlib_global_main)
590 vlib_process_t *p = vlib_get_process_from_node (vm, n);
591 n->stats_total.suspends += p->n_suspends;
593 rt = &p->node_runtime;
597 vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
600 vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0, 0);
602 /* Sync up runtime next frame vector counters with main node structure. */
604 vlib_next_frame_t *nf;
606 for (i = 0; i < rt->n_next_nodes; i++)
608 nf = vlib_node_runtime_get_next_frame (vm, rt, i);
609 vec_elt (n->n_vectors_by_next_node, i) +=
610 nf->vectors_since_last_overflow;
611 nf->vectors_since_last_overflow = 0;
617 vlib_node_runtime_update_stats (vlib_main_t * vm,
618 vlib_node_runtime_t * node,
620 uword n_vectors, uword n_clocks,
623 u32 ca0, ca1, v0, v1, cl0, cl1, r;
624 u32 ptick0, ptick1, pvec0, pvec1;
626 cl0 = cl1 = node->clocks_since_last_overflow;
627 ca0 = ca1 = node->calls_since_last_overflow;
628 v0 = v1 = node->vectors_since_last_overflow;
629 ptick0 = ptick1 = node->perf_counter_ticks_since_last_overflow;
630 pvec0 = pvec1 = node->perf_counter_vectors_since_last_overflow;
634 cl1 = cl0 + n_clocks;
635 ptick1 = ptick0 + n_ticks;
636 pvec1 = pvec0 + n_vectors;
638 node->calls_since_last_overflow = ca1;
639 node->clocks_since_last_overflow = cl1;
640 node->vectors_since_last_overflow = v1;
641 node->perf_counter_ticks_since_last_overflow = ptick1;
642 node->perf_counter_vectors_since_last_overflow = pvec1;
644 node->max_clock_n = node->max_clock > n_clocks ?
645 node->max_clock_n : n_vectors;
646 node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
648 r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
650 if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0) || (ptick1 < ptick0)
653 node->calls_since_last_overflow = ca0;
654 node->clocks_since_last_overflow = cl0;
655 node->vectors_since_last_overflow = v0;
656 node->perf_counter_ticks_since_last_overflow = ptick0;
657 node->perf_counter_vectors_since_last_overflow = pvec0;
659 vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks,
667 vlib_node_runtime_perf_counter (vlib_main_t * vm)
669 if (PREDICT_FALSE (vm->vlib_node_runtime_perf_counter_cb != 0))
670 return ((*vm->vlib_node_runtime_perf_counter_cb) (vm));
675 vlib_process_update_stats (vlib_main_t * vm,
677 uword n_calls, uword n_vectors, uword n_clocks,
680 vlib_node_runtime_update_stats (vm, &p->node_runtime,
681 n_calls, n_vectors, n_clocks, n_ticks);
684 static clib_error_t *
685 vlib_cli_elog_clear (vlib_main_t * vm,
686 unformat_input_t * input, vlib_cli_command_t * cmd)
688 elog_reset_buffer (&vm->elog_main);
693 VLIB_CLI_COMMAND (elog_clear_cli, static) = {
694 .path = "event-logger clear",
695 .short_help = "Clear the event log",
696 .function = vlib_cli_elog_clear,
701 static clib_error_t *
702 elog_save_buffer (vlib_main_t * vm,
703 unformat_input_t * input, vlib_cli_command_t * cmd)
705 elog_main_t *em = &vm->elog_main;
706 char *file, *chroot_file;
707 clib_error_t *error = 0;
709 if (!unformat (input, "%s", &file))
711 vlib_cli_output (vm, "expected file name, got `%U'",
712 format_unformat_error, input);
716 /* It's fairly hard to get "../oopsie" through unformat; just in case */
717 if (strstr (file, "..") || index (file, '/'))
719 vlib_cli_output (vm, "illegal characters in filename '%s'", file);
723 chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
727 vlib_cli_output (vm, "Saving %wd of %wd events to %s",
728 elog_n_events_in_buffer (em),
729 elog_buffer_capacity (em), chroot_file);
731 vlib_worker_thread_barrier_sync (vm);
732 error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
733 vlib_worker_thread_barrier_release (vm);
734 vec_free (chroot_file);
739 elog_post_mortem_dump (void)
741 vlib_main_t *vm = &vlib_global_main;
742 elog_main_t *em = &vm->elog_main;
746 if (!vm->elog_post_mortem_dump)
749 filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
750 error = elog_write_file (em, (char *) filename, 1 /* flush ring */ );
752 clib_error_report (error);
757 VLIB_CLI_COMMAND (elog_save_cli, static) = {
758 .path = "event-logger save",
759 .short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
760 .function = elog_save_buffer,
764 static clib_error_t *
765 elog_stop (vlib_main_t * vm,
766 unformat_input_t * input, vlib_cli_command_t * cmd)
768 elog_main_t *em = &vm->elog_main;
770 em->n_total_events_disable_limit = em->n_total_events;
772 vlib_cli_output (vm, "Stopped the event logger...");
777 VLIB_CLI_COMMAND (elog_stop_cli, static) = {
778 .path = "event-logger stop",
779 .short_help = "Stop the event-logger",
780 .function = elog_stop,
784 static clib_error_t *
785 elog_restart (vlib_main_t * vm,
786 unformat_input_t * input, vlib_cli_command_t * cmd)
788 elog_main_t *em = &vm->elog_main;
790 em->n_total_events_disable_limit = ~0;
792 vlib_cli_output (vm, "Restarted the event logger...");
797 VLIB_CLI_COMMAND (elog_restart_cli, static) = {
798 .path = "event-logger restart",
799 .short_help = "Restart the event-logger",
800 .function = elog_restart,
804 static clib_error_t *
805 elog_resize (vlib_main_t * vm,
806 unformat_input_t * input, vlib_cli_command_t * cmd)
808 elog_main_t *em = &vm->elog_main;
811 /* Stop the parade */
812 elog_reset_buffer (&vm->elog_main);
814 if (unformat (input, "%d", &tmp))
816 elog_alloc (em, tmp);
817 em->n_total_events_disable_limit = ~0;
820 return clib_error_return (0, "Must specify how many events in the ring");
822 vlib_cli_output (vm, "Resized ring and restarted the event logger...");
827 VLIB_CLI_COMMAND (elog_resize_cli, static) = {
828 .path = "event-logger resize",
829 .short_help = "event-logger resize <nnn>",
830 .function = elog_resize,
834 #endif /* CLIB_UNIX */
837 elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
839 elog_main_t *em = &vm->elog_main;
840 elog_event_t *e, *es;
843 /* Show events in VLIB time since log clock starts after VLIB clock. */
844 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
845 * vm->clib_time.seconds_per_clock;
847 es = elog_peek_events (em);
848 vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
850 em->n_total_events < em->n_total_events_disable_limit ?
851 "running" : "stopped");
854 vlib_cli_output (vm, "%18.9f: %U",
855 e->time + dt, format_elog_event, em, e);
857 if (n_events_to_show == 0)
864 static clib_error_t *
865 elog_show_buffer (vlib_main_t * vm,
866 unformat_input_t * input, vlib_cli_command_t * cmd)
868 u32 n_events_to_show;
869 clib_error_t *error = 0;
871 n_events_to_show = 250;
872 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
874 if (unformat (input, "%d", &n_events_to_show))
876 else if (unformat (input, "all"))
877 n_events_to_show = ~0;
879 return unformat_parse_error (input);
881 elog_show_buffer_internal (vm, n_events_to_show);
886 VLIB_CLI_COMMAND (elog_show_cli, static) = {
887 .path = "show event-logger",
888 .short_help = "Show event logger info",
889 .function = elog_show_buffer,
894 vlib_gdb_show_event_log (void)
896 elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
900 vlib_elog_main_loop_event (vlib_main_t * vm,
902 u64 time, u32 n_vectors, u32 is_return)
904 vlib_main_t *evm = &vlib_global_main;
905 elog_main_t *em = &evm->elog_main;
907 if (VLIB_ELOG_MAIN_LOOP && n_vectors)
910 vec_elt_at_index (is_return
911 ? evm->node_return_elog_event_types
912 : evm->node_call_elog_event_types,
915 (vm->thread_index ? &vlib_worker_threads[vm->thread_index].
916 elog_track : &em->default_track),
917 /* data to log */ n_vectors);
920 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
921 void (*vlib_buffer_trace_trajectory_cb) (vlib_buffer_t * b, u32 node_index);
922 void (*vlib_buffer_trace_trajectory_init_cb) (vlib_buffer_t * b);
925 vlib_buffer_trace_trajectory_init (vlib_buffer_t * b)
927 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_init_cb != 0))
929 (*vlib_buffer_trace_trajectory_init_cb) (b);
936 add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
938 #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
939 if (PREDICT_TRUE (vlib_buffer_trace_trajectory_cb != 0))
941 (*vlib_buffer_trace_trajectory_cb) (b, node_index);
946 static_always_inline u64
947 dispatch_node (vlib_main_t * vm,
948 vlib_node_runtime_t * node,
949 vlib_node_type_t type,
950 vlib_node_state_t dispatch_state,
951 vlib_frame_t * frame, u64 last_time_stamp)
955 vlib_node_main_t *nm = &vm->node_main;
956 vlib_next_frame_t *nf;
960 vlib_node_t *n = vlib_get_node (vm, node->node_index);
961 ASSERT (n->type == type);
964 /* Only non-internal nodes may be disabled. */
965 if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
967 ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
968 return last_time_stamp;
971 if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
972 && dispatch_state != VLIB_NODE_STATE_INTERRUPT)
974 u32 c = node->input_main_loops_per_call;
975 /* Only call node when count reaches zero. */
978 node->input_main_loops_per_call = c - 1;
979 return last_time_stamp;
983 /* Speculatively prefetch next frames. */
984 if (node->n_next_nodes > 0)
986 nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
987 CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
990 vm->cpu_time_last_node_dispatch = last_time_stamp;
992 if (1 /* || vm->thread_index == node->thread_index */ )
994 u64 pmc_before, pmc_delta;
996 vlib_elog_main_loop_event (vm, node->node_index,
998 frame ? frame->n_vectors : 0,
1002 * To validate accounting: pmc_before = last_time_stamp
1003 * perf ticks should equal clocks/pkt...
1005 pmc_before = vlib_node_runtime_perf_counter (vm);
1008 * Turn this on if you run into
1009 * "bad monkey" contexts, and you want to know exactly
1010 * which nodes they've visited... See ixge.c...
1012 if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
1016 from = vlib_frame_vector_args (frame);
1017 for (i = 0; i < frame->n_vectors; i++)
1019 vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
1020 add_trajectory_trace (b, node->node_index);
1022 n = node->function (vm, node, frame);
1025 n = node->function (vm, node, frame);
1027 t = clib_cpu_time_now ();
1030 * To validate accounting: pmc_delta = t - pmc_before;
1031 * perf ticks should equal clocks/pkt...
1033 pmc_delta = vlib_node_runtime_perf_counter (vm) - pmc_before;
1035 vlib_elog_main_loop_event (vm, node->node_index, t, n, /* is_after */
1038 vm->main_loop_vectors_processed += n;
1039 vm->main_loop_nodes_processed += n > 0;
1041 v = vlib_node_runtime_update_stats (vm, node,
1044 /* n_clocks */ t - last_time_stamp,
1045 pmc_delta /* PMC ticks */ );
1047 /* When in interrupt mode and vector rate crosses threshold switch to
1049 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT)
1050 || (dispatch_state == VLIB_NODE_STATE_POLLING
1052 & VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE)))
1054 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1055 ELOG_TYPE_DECLARE (e) =
1057 .function = (char *) __FUNCTION__,.format =
1058 "%s vector length %d, switching to %s",.format_args =
1059 "T4i4t4",.n_enum_strings = 2,.enum_strings =
1061 "interrupt", "polling",},};
1064 u32 node_name, vector_length, is_polling;
1066 vlib_worker_thread_t *w = vlib_worker_threads + vm->thread_index;
1069 if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
1070 && v >= nm->polling_threshold_vector_length) &&
1072 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
1074 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1075 n->state = VLIB_NODE_STATE_POLLING;
1076 node->state = VLIB_NODE_STATE_POLLING;
1078 ~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1080 VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1081 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
1082 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
1084 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1085 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1087 ed->node_name = n->name_elog_string;
1088 ed->vector_length = v;
1092 else if (dispatch_state == VLIB_NODE_STATE_POLLING
1093 && v <= nm->interrupt_threshold_vector_length)
1095 vlib_node_t *n = vlib_get_node (vm, node->node_index);
1097 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
1099 /* Switch to interrupt mode after dispatch in polling one more time.
1100 This allows driver to re-enable interrupts. */
1101 n->state = VLIB_NODE_STATE_INTERRUPT;
1102 node->state = VLIB_NODE_STATE_INTERRUPT;
1104 ~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
1105 nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -=
1107 nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] +=
1114 VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
1115 #ifdef DISPATCH_NODE_ELOG_REQUIRED
1116 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
1118 ed->node_name = n->name_elog_string;
1119 ed->vector_length = v;
1131 dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
1132 u64 last_time_stamp)
1134 vlib_node_main_t *nm = &vm->node_main;
1136 vlib_next_frame_t *nf, nf_dummy;
1137 vlib_node_runtime_t *n;
1138 u32 restore_frame_index;
1139 vlib_pending_frame_t *p;
1141 /* See comment below about dangling references to nm->pending_frames */
1142 p = nm->pending_frames + pending_frame_index;
1144 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1145 p->node_runtime_index);
1147 f = vlib_get_frame (vm, p->frame_index);
1148 if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
1150 /* No next frame: so use dummy on stack. */
1152 nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
1153 nf->frame_index = ~p->frame_index;
1156 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1158 ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
1160 /* Force allocation of new frame while current frame is being
1162 restore_frame_index = ~0;
1163 if (nf->frame_index == p->frame_index)
1165 nf->frame_index = ~0;
1166 nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
1167 if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
1168 restore_frame_index = p->frame_index;
1171 /* Frame must be pending. */
1172 ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
1173 ASSERT (f->n_vectors > 0);
1175 /* Copy trace flag from next frame to node.
1176 Trace flag indicates that at least one vector in the dispatched
1178 n->flags &= ~VLIB_NODE_FLAG_TRACE;
1179 n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
1180 nf->flags &= ~VLIB_FRAME_TRACE;
1182 last_time_stamp = dispatch_node (vm, n,
1183 VLIB_NODE_TYPE_INTERNAL,
1184 VLIB_NODE_STATE_POLLING,
1185 f, last_time_stamp);
1187 f->frame_flags &= ~VLIB_FRAME_PENDING;
1189 /* Frame is ready to be used again, so restore it. */
1190 if (restore_frame_index != ~0)
1193 * We musn't restore a frame that is flagged to be freed. This
1194 * shouldn't happen since frames to be freed post dispatch are
1195 * those used when the to-node frame becomes full i.e. they form a
1196 * sort of queue of frames to a single node. If we get here then
1197 * the to-node frame and the pending frame *were* the same, and so
1198 * we removed the to-node frame. Therefore this frame is no
1199 * longer part of the queue for that node and hence it cannot be
1202 ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
1205 * NB: dispatching node n can result in the creation and scheduling
1206 * of new frames, and hence in the reallocation of nm->pending_frames.
1207 * Recompute p, or no supper. This was broken for more than 10 years.
1209 p = nm->pending_frames + pending_frame_index;
1212 * p->next_frame_index can change during node dispatch if node
1213 * function decides to change graph hook up.
1215 nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
1216 nf->flags |= VLIB_FRAME_IS_ALLOCATED;
1218 if (~0 == nf->frame_index)
1220 /* no new frame has been assigned to this node, use the saved one */
1221 nf->frame_index = restore_frame_index;
1226 /* The node has gained a frame, implying packets from the current frame
1227 were re-queued to this same node. we don't need the saved one
1229 vlib_frame_free (vm, n, f);
1234 if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
1236 ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
1237 vlib_frame_free (vm, n, f);
1241 return last_time_stamp;
1245 vlib_process_stack_is_valid (vlib_process_t * p)
1247 return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
1253 vlib_process_t *process;
1254 vlib_frame_t *frame;
1255 } vlib_process_bootstrap_args_t;
1257 /* Called in process stack. */
1259 vlib_process_bootstrap (uword _a)
1261 vlib_process_bootstrap_args_t *a;
1263 vlib_node_runtime_t *node;
1268 a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
1273 node = &p->node_runtime;
1275 n = node->function (vm, node, f);
1277 ASSERT (vlib_process_stack_is_valid (p));
1279 clib_longjmp (&p->return_longjmp, n);
1284 /* Called in main stack. */
1285 static_always_inline uword
1286 vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
1288 vlib_process_bootstrap_args_t a;
1295 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1296 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1297 r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
1298 (void *) p->stack + (1 << p->log2_n_stack_bytes));
1303 static_always_inline uword
1304 vlib_process_resume (vlib_process_t * p)
1307 p->flags &= ~(VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1308 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT
1309 | VLIB_PROCESS_RESUME_PENDING);
1310 r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1311 if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
1312 clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
1317 dispatch_process (vlib_main_t * vm,
1318 vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
1320 vlib_node_main_t *nm = &vm->node_main;
1321 vlib_node_runtime_t *node_runtime = &p->node_runtime;
1322 vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
1323 u32 old_process_index;
1325 uword n_vectors, is_suspend;
1327 if (node->state != VLIB_NODE_STATE_POLLING
1328 || (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1329 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT)))
1330 return last_time_stamp;
1332 p->flags |= VLIB_PROCESS_IS_RUNNING;
1334 t = last_time_stamp;
1335 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1336 f ? f->n_vectors : 0, /* is_after */ 0);
1338 /* Save away current process for suspend. */
1339 old_process_index = nm->current_process_index;
1340 nm->current_process_index = node->runtime_index;
1342 n_vectors = vlib_process_startup (vm, p, f);
1344 nm->current_process_index = old_process_index;
1346 ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
1347 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1350 vlib_pending_frame_t *pf;
1353 pool_get (nm->suspended_process_frames, pf);
1354 pf->node_runtime_index = node->runtime_index;
1355 pf->frame_index = f ? vlib_frame_index (vm, f) : ~0;
1356 pf->next_frame_index = ~0;
1359 p->suspended_process_frame_index = pf - nm->suspended_process_frames;
1361 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1363 TWT (tw_timer_wheel) * tw =
1364 (TWT (tw_timer_wheel) *) nm->timing_wheel;
1365 p->stop_timer_handle =
1366 TW (tw_timer_start) (tw,
1367 vlib_timing_wheel_data_set_suspended_process
1368 (node->runtime_index) /* [sic] pool idex */ ,
1370 p->resume_clock_interval);
1374 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1376 t = clib_cpu_time_now ();
1378 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
1381 vlib_process_update_stats (vm, p,
1382 /* n_calls */ !is_suspend,
1383 /* n_vectors */ n_vectors,
1384 /* n_clocks */ t - last_time_stamp,
1385 /* pmc_ticks */ 0ULL);
1391 vlib_start_process (vlib_main_t * vm, uword process_index)
1393 vlib_node_main_t *nm = &vm->node_main;
1394 vlib_process_t *p = vec_elt (nm->processes, process_index);
1395 dispatch_process (vm, p, /* frame */ 0, /* cpu_time_now */ 0);
1399 dispatch_suspended_process (vlib_main_t * vm,
1400 uword process_index, u64 last_time_stamp)
1402 vlib_node_main_t *nm = &vm->node_main;
1403 vlib_node_runtime_t *node_runtime;
1407 vlib_pending_frame_t *pf;
1408 u64 t, n_vectors, is_suspend;
1410 t = last_time_stamp;
1412 p = vec_elt (nm->processes, process_index);
1413 if (PREDICT_FALSE (!(p->flags & VLIB_PROCESS_IS_RUNNING)))
1414 return last_time_stamp;
1416 ASSERT (p->flags & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
1417 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT));
1420 pool_elt_at_index (nm->suspended_process_frames,
1421 p->suspended_process_frame_index);
1423 node_runtime = &p->node_runtime;
1424 node = vlib_get_node (vm, node_runtime->node_index);
1425 f = pf->frame_index != ~0 ? vlib_get_frame (vm, pf->frame_index) : 0;
1427 vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
1428 f ? f->n_vectors : 0, /* is_after */ 0);
1430 /* Save away current process for suspend. */
1431 nm->current_process_index = node->runtime_index;
1433 n_vectors = vlib_process_resume (p);
1434 t = clib_cpu_time_now ();
1436 nm->current_process_index = ~0;
1438 is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
1441 /* Suspend it again. */
1444 if (p->flags & VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK)
1446 p->stop_timer_handle =
1447 TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1448 vlib_timing_wheel_data_set_suspended_process
1449 (node->runtime_index) /* [sic] pool idex */ ,
1451 p->resume_clock_interval);
1456 p->flags &= ~VLIB_PROCESS_IS_RUNNING;
1457 p->suspended_process_frame_index = ~0;
1458 pool_put (nm->suspended_process_frames, pf);
1461 t = clib_cpu_time_now ();
1462 vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
1465 vlib_process_update_stats (vm, p,
1466 /* n_calls */ !is_suspend,
1467 /* n_vectors */ n_vectors,
1468 /* n_clocks */ t - last_time_stamp,
1469 /* pmc_ticks */ 0ULL);
1474 void vl_api_send_pending_rpc_requests (vlib_main_t *) __attribute__ ((weak));
1476 vl_api_send_pending_rpc_requests (vlib_main_t * vm)
1481 static_always_inline void
1482 vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
1484 vlib_node_main_t *nm = &vm->node_main;
1485 vlib_thread_main_t *tm = vlib_get_thread_main ();
1488 vlib_frame_queue_main_t *fqm;
1489 u32 *last_node_runtime_indices = 0;
1491 /* Initialize pending node vector. */
1494 vec_resize (nm->pending_frames, 32);
1495 _vec_len (nm->pending_frames) = 0;
1498 /* Mark time of main loop start. */
1501 cpu_time_now = vm->clib_time.last_cpu_time;
1502 vm->cpu_time_main_loop_start = cpu_time_now;
1505 cpu_time_now = clib_cpu_time_now ();
1507 /* Pre-allocate interupt runtime indices and lock. */
1508 vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1509 vec_alloc (last_node_runtime_indices, 32);
1511 clib_spinlock_init (&nm->pending_interrupt_lock);
1513 /* Pre-allocate expired nodes. */
1514 if (!nm->polling_threshold_vector_length)
1515 nm->polling_threshold_vector_length = 10;
1516 if (!nm->interrupt_threshold_vector_length)
1517 nm->interrupt_threshold_vector_length = 5;
1519 /* Make sure the performance monitor counter is disabled */
1520 vm->perf_counter_id = ~0;
1522 /* Start all processes. */
1526 nm->current_process_index = ~0;
1527 for (i = 0; i < vec_len (nm->processes); i++)
1528 cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
1534 vlib_node_runtime_t *n;
1536 if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
1537 vl_api_send_pending_rpc_requests (vm);
1541 vlib_worker_thread_barrier_check ();
1542 vec_foreach (fqm, tm->frame_queue_mains)
1543 vlib_frame_queue_dequeue (vm, fqm);
1544 if (PREDICT_FALSE (vm->worker_thread_main_loop_callback != 0))
1545 ((void (*)(vlib_main_t *)) vm->worker_thread_main_loop_callback)
1549 /* Process pre-input nodes. */
1550 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1551 cpu_time_now = dispatch_node (vm, n,
1552 VLIB_NODE_TYPE_PRE_INPUT,
1553 VLIB_NODE_STATE_POLLING,
1557 /* Next process input nodes. */
1558 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1559 cpu_time_now = dispatch_node (vm, n,
1560 VLIB_NODE_TYPE_INPUT,
1561 VLIB_NODE_STATE_POLLING,
1565 if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
1566 vm->queue_signal_callback (vm);
1568 /* Next handle interrupts. */
1570 /* unlocked read, for performance */
1571 uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1573 if (PREDICT_FALSE (l > 0))
1578 clib_spinlock_lock (&nm->pending_interrupt_lock);
1579 /* Re-read w/ lock held, in case another thread added an item */
1580 l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1583 tmp = nm->pending_interrupt_node_runtime_indices;
1584 nm->pending_interrupt_node_runtime_indices =
1585 last_node_runtime_indices;
1586 last_node_runtime_indices = tmp;
1587 _vec_len (last_node_runtime_indices) = 0;
1589 clib_spinlock_unlock (&nm->pending_interrupt_lock);
1590 for (i = 0; i < l; i++)
1592 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1593 last_node_runtime_indices[i]);
1595 dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1596 VLIB_NODE_STATE_INTERRUPT,
1602 /* Input nodes may have added work to the pending vector.
1603 Process pending vector until there is nothing left.
1604 All pending vectors will be processed from input -> output. */
1605 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1606 cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
1607 /* Reset pending vector for next iteration. */
1608 _vec_len (nm->pending_frames) = 0;
1612 /* Check if process nodes have expired from timing wheel. */
1613 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1615 nm->data_from_advancing_timing_wheel =
1616 TW (tw_timer_expire_timers_vec)
1617 ((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm),
1618 nm->data_from_advancing_timing_wheel);
1620 ASSERT (nm->data_from_advancing_timing_wheel != 0);
1623 (_vec_len (nm->data_from_advancing_timing_wheel) > 0))
1627 for (i = 0; i < _vec_len (nm->data_from_advancing_timing_wheel);
1630 u32 d = nm->data_from_advancing_timing_wheel[i];
1631 u32 di = vlib_timing_wheel_data_get_index (d);
1633 if (vlib_timing_wheel_data_is_timed_event (d))
1635 vlib_signal_timed_event_data_t *te =
1636 pool_elt_at_index (nm->signal_timed_event_data_pool,
1639 vlib_get_node (vm, te->process_node_index);
1641 vec_elt (nm->processes, n->runtime_index);
1644 vlib_process_signal_event_helper (nm, n, p,
1645 te->event_type_index,
1647 te->n_data_elt_bytes);
1648 if (te->n_data_bytes < sizeof (te->inline_event_data))
1649 clib_memcpy (data, te->inline_event_data,
1653 clib_memcpy (data, te->event_data_as_vector,
1655 vec_free (te->event_data_as_vector);
1657 pool_put (nm->signal_timed_event_data_pool, te);
1661 cpu_time_now = clib_cpu_time_now ();
1663 dispatch_suspended_process (vm, di, cpu_time_now);
1666 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1669 vlib_increment_main_loop_counter (vm);
1671 /* Record time stamp in case there are no enabled nodes and above
1672 calls do not update time stamp. */
1673 cpu_time_now = clib_cpu_time_now ();
1678 vlib_main_loop (vlib_main_t * vm)
1680 vlib_main_or_worker_loop (vm, /* is_main */ 1);
1684 vlib_worker_loop (vlib_main_t * vm)
1686 vlib_main_or_worker_loop (vm, /* is_main */ 0);
1689 vlib_main_t vlib_global_main;
1691 static clib_error_t *
1692 vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
1694 int turn_on_mem_trace = 0;
1696 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1698 if (unformat (input, "memory-trace"))
1699 turn_on_mem_trace = 1;
1701 else if (unformat (input, "elog-events %d",
1702 &vm->elog_main.event_ring_size))
1704 else if (unformat (input, "elog-post-mortem-dump"))
1705 vm->elog_post_mortem_dump = 1;
1707 return unformat_parse_error (input);
1710 unformat_free (input);
1712 /* Enable memory trace as early as possible. */
1713 if (turn_on_mem_trace)
1719 VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
1722 dummy_queue_signal_callback (vlib_main_t * vm)
1726 #define foreach_weak_reference_stub \
1727 _(vlib_map_stat_segment_init) \
1729 _(vlibmemory_init) \
1730 _(map_api_segment_init)
1733 clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
1734 clib_error_t *name (vlib_main_t *vm) { return 0; }
1735 foreach_weak_reference_stub;
1738 /* Main function. */
1740 vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
1742 clib_error_t *volatile error;
1743 vlib_node_main_t *nm = &vm->node_main;
1745 vm->queue_signal_callback = dummy_queue_signal_callback;
1747 clib_time_init (&vm->clib_time);
1749 /* Turn on event log. */
1750 if (!vm->elog_main.event_ring_size)
1751 vm->elog_main.event_ring_size = 128 << 10;
1752 elog_init (&vm->elog_main, vm->elog_main.event_ring_size);
1753 elog_enable_disable (&vm->elog_main, 1);
1759 if ((error = vlib_physmem_init (vm)))
1761 clib_error_report (error);
1765 if ((error = vlib_buffer_main_init (vm)))
1767 clib_error_report (error);
1771 if ((error = vlib_thread_init (vm)))
1773 clib_error_report (error);
1777 if ((error = vlib_map_stat_segment_init (vm)))
1779 clib_error_report (error);
1783 /* Register static nodes so that init functions may use them. */
1784 vlib_register_all_static_nodes (vm);
1786 /* Set seed for random number generator.
1787 Allow user to specify seed to make random sequence deterministic. */
1788 if (!unformat (input, "seed %wd", &vm->random_seed))
1789 vm->random_seed = clib_cpu_time_now ();
1790 clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
1792 /* Initialize node graph. */
1793 if ((error = vlib_node_main_init (vm)))
1795 /* Arrange for graph hook up error to not be fatal when debugging. */
1797 clib_error_report (error);
1802 /* Direct call / weak reference, for vlib standalone use-cases */
1803 if ((error = vpe_api_init (vm)))
1805 clib_error_report (error);
1809 if ((error = vlibmemory_init (vm)))
1811 clib_error_report (error);
1815 if ((error = map_api_segment_init (vm)))
1817 clib_error_report (error);
1821 /* See unix/main.c; most likely already set up */
1822 if (vm->init_functions_called == 0)
1823 vm->init_functions_called = hash_create (0, /* value bytes */ 0);
1824 if ((error = vlib_call_all_init_functions (vm)))
1827 /* Create default buffer free list. */
1828 vlib_buffer_create_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
1831 nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
1832 CLIB_CACHE_LINE_BYTES);
1834 vec_validate (nm->data_from_advancing_timing_wheel, 10);
1835 _vec_len (nm->data_from_advancing_timing_wheel) = 0;
1837 /* Create the process timing wheel */
1838 TW (tw_timer_wheel_init) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
1839 0 /* no callback */ ,
1840 10e-6 /* timer period 10us */ ,
1841 ~0 /* max expirations per call */ );
1843 vec_validate (vm->pending_rpc_requests, 0);
1844 _vec_len (vm->pending_rpc_requests) = 0;
1846 switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
1848 case VLIB_MAIN_LOOP_EXIT_NONE:
1849 vm->main_loop_exit_set = 1;
1852 case VLIB_MAIN_LOOP_EXIT_CLI:
1856 error = vm->main_loop_error;
1860 if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
1863 /* Call all main loop enter functions. */
1865 clib_error_t *sub_error;
1866 sub_error = vlib_call_all_main_loop_enter_functions (vm);
1868 clib_error_report (sub_error);
1871 vlib_main_loop (vm);
1874 /* Call all exit functions. */
1876 clib_error_t *sub_error;
1877 sub_error = vlib_call_all_main_loop_exit_functions (vm);
1879 clib_error_report (sub_error);
1883 clib_error_report (error);
1889 * fd.io coding-style-patch-verification: ON
1892 * eval: (c-set-style "gnu")