blob: a2f833711abf4a8fd917cd9d90846cc77c56ff06 [file] [log] [blame]
/*
* Copyright (c) 2015 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* main.c: main vector processing loop
*
* Copyright (c) 2008 Eliot Dresselhaus
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include <math.h>
#include <vppinfra/format.h>
#include <vlib/vlib.h>
#include <vlib/threads.h>
#include <vlib/stats/stats.h>
#include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
#include <vlib/unix/unix.h>
#define VLIB_FRAME_MAGIC (0xabadc0ed)
always_inline u32 *
vlib_frame_find_magic (vlib_frame_t * f, vlib_node_t * node)
{
return (void *) f + node->magic_offset;
}
static vlib_frame_t *
vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
u32 frame_flags)
{
vlib_node_main_t *nm = &vm->node_main;
vlib_frame_size_t *fs;
vlib_node_t *to_node;
vlib_frame_t *f;
u32 l, n;
ASSERT (vm == vlib_get_main ());
to_node = vlib_get_node (vm, to_node_index);
vec_validate (nm->frame_sizes, to_node->frame_size_index);
fs = vec_elt_at_index (nm->frame_sizes, to_node->frame_size_index);
if (fs->frame_size == 0)
fs->frame_size = to_node->frame_size;
else
ASSERT (fs->frame_size == to_node->frame_size);
n = fs->frame_size;
if ((l = vec_len (fs->free_frames)) > 0)
{
/* Allocate from end of free list. */
f = fs->free_frames[l - 1];
vec_set_len (fs->free_frames, l - 1);
}
else
{
f = clib_mem_alloc_aligned_no_fail (n, CLIB_CACHE_LINE_BYTES);
}
/* Poison frame when debugging. */
if (CLIB_DEBUG > 0)
clib_memset_u8 (f, 0xfe, n);
/* Insert magic number. */
{
u32 *magic;
magic = vlib_frame_find_magic (f, to_node);
*magic = VLIB_FRAME_MAGIC;
}
f->frame_flags = VLIB_FRAME_IS_ALLOCATED | frame_flags;
f->n_vectors = 0;
f->scalar_offset = to_node->scalar_offset;
f->vector_offset = to_node->vector_offset;
f->aux_offset = to_node->aux_offset;
f->flags = 0;
f->frame_size_index = to_node->frame_size_index;
fs->n_alloc_frames += 1;
return f;
}
/* Allocate a frame for from FROM_NODE to TO_NODE via TO_NEXT_INDEX.
Returns frame index. */
static vlib_frame_t *
vlib_frame_alloc (vlib_main_t * vm, vlib_node_runtime_t * from_node_runtime,
u32 to_next_index)
{
vlib_node_t *from_node;
from_node = vlib_get_node (vm, from_node_runtime->node_index);
ASSERT (to_next_index < vec_len (from_node->next_nodes));
return vlib_frame_alloc_to_node (vm, from_node->next_nodes[to_next_index],
/* frame_flags */ 0);
}
vlib_frame_t *
vlib_get_frame_to_node (vlib_main_t * vm, u32 to_node_index)
{
vlib_frame_t *f = vlib_frame_alloc_to_node (vm, to_node_index,
/* frame_flags */
VLIB_FRAME_FREE_AFTER_DISPATCH);
return vlib_get_frame (vm, f);
}
static inline void
vlib_validate_frame_indices (vlib_frame_t * f)
{
if (CLIB_DEBUG > 0)
{
int i;
u32 *from = vlib_frame_vector_args (f);
/* Check for bad buffer index values */
for (i = 0; i < f->n_vectors; i++)
{
if (from[i] == 0)
{
clib_warning ("BUG: buffer index 0 at index %d", i);
ASSERT (0);
}
else if (from[i] == 0xfefefefe)
{
clib_warning ("BUG: frame poison pattern at index %d", i);
ASSERT (0);
}
}
}
}
void
vlib_put_frame_to_node (vlib_main_t * vm, u32 to_node_index, vlib_frame_t * f)
{
vlib_pending_frame_t *p;
vlib_node_t *to_node;
if (f->n_vectors == 0)
return;
ASSERT (vm == vlib_get_main ());
vlib_validate_frame_indices (f);
to_node = vlib_get_node (vm, to_node_index);
vec_add2 (vm->node_main.pending_frames, p, 1);
f->frame_flags |= VLIB_FRAME_PENDING;
p->frame = vlib_get_frame (vm, f);
p->node_runtime_index = to_node->runtime_index;
p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
}
/* Free given frame. */
void
vlib_frame_free (vlib_main_t *vm, vlib_frame_t *f)
{
vlib_node_main_t *nm = &vm->node_main;
vlib_frame_size_t *fs;
ASSERT (vm == vlib_get_main ());
ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
fs = vec_elt_at_index (nm->frame_sizes, f->frame_size_index);
ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
/* No next frames may point to freed frame. */
if (CLIB_DEBUG > 0)
{
vlib_next_frame_t *nf;
vec_foreach (nf, vm->node_main.next_frames) ASSERT (nf->frame != f);
}
f->frame_flags &= ~(VLIB_FRAME_IS_ALLOCATED | VLIB_FRAME_NO_APPEND);
f->flags = 0;
vec_add1 (fs->free_frames, f);
ASSERT (fs->n_alloc_frames > 0);
fs->n_alloc_frames -= 1;
}
static clib_error_t *
show_frame_stats (vlib_main_t * vm,
unformat_input_t * input, vlib_cli_command_t * cmd)
{
vlib_frame_size_t *fs;
vlib_cli_output (vm, "%=8s%=6s%=12s%=12s", "Thread", "Size", "# Alloc",
"# Free");
foreach_vlib_main ()
{
vlib_node_main_t *nm = &this_vlib_main->node_main;
vec_foreach (fs, nm->frame_sizes)
{
u32 n_alloc = fs->n_alloc_frames;
u32 n_free = vec_len (fs->free_frames);
if (n_alloc + n_free > 0)
vlib_cli_output (vm, "%=8d%=6d%=12d%=12d",
this_vlib_main->thread_index, fs->frame_size,
n_alloc, n_free);
}
}
return 0;
}
VLIB_CLI_COMMAND (show_frame_stats_cli, static) = {
.path = "show vlib frame-allocation",
.short_help = "Show node dispatch frame statistics",
.function = show_frame_stats,
};
/* Change ownership of enqueue rights to given next node. */
static void
vlib_next_frame_change_ownership (vlib_main_t * vm,
vlib_node_runtime_t * node_runtime,
u32 next_index)
{
vlib_node_main_t *nm = &vm->node_main;
vlib_next_frame_t *next_frame;
vlib_node_t *node, *next_node;
node = vec_elt (nm->nodes, node_runtime->node_index);
/* Only internal & input nodes are allowed to call other nodes. */
ASSERT (node->type == VLIB_NODE_TYPE_INTERNAL
|| node->type == VLIB_NODE_TYPE_INPUT
|| node->type == VLIB_NODE_TYPE_PROCESS);
ASSERT (vec_len (node->next_nodes) == node_runtime->n_next_nodes);
next_frame =
vlib_node_runtime_get_next_frame (vm, node_runtime, next_index);
next_node = vec_elt (nm->nodes, node->next_nodes[next_index]);
if (next_node->owner_node_index != VLIB_INVALID_NODE_INDEX)
{
/* Get frame from previous owner. */
vlib_next_frame_t *owner_next_frame;
vlib_next_frame_t tmp;
owner_next_frame =
vlib_node_get_next_frame (vm,
next_node->owner_node_index,
next_node->owner_next_index);
/* Swap target next frame with owner's. */
tmp = owner_next_frame[0];
owner_next_frame[0] = next_frame[0];
next_frame[0] = tmp;
/*
* If next_frame is already pending, we have to track down
* all pending frames and fix their next_frame_index fields.
*/
if (next_frame->flags & VLIB_FRAME_PENDING)
{
vlib_pending_frame_t *p;
if (next_frame->frame != NULL)
{
vec_foreach (p, nm->pending_frames)
{
if (p->frame == next_frame->frame)
{
p->next_frame_index =
next_frame - vm->node_main.next_frames;
}
}
}
}
}
else
{
/* No previous owner. Take ownership. */
next_frame->flags |= VLIB_FRAME_OWNER;
}
/* Record new owner. */
next_node->owner_node_index = node->index;
next_node->owner_next_index = next_index;
/* Now we should be owner. */
ASSERT (next_frame->flags & VLIB_FRAME_OWNER);
}
/* Make sure that magic number is still there.
Otherwise, it is likely that caller has overrun frame arguments. */
always_inline void
validate_frame_magic (vlib_main_t * vm,
vlib_frame_t * f, vlib_node_t * n, uword next_index)
{
vlib_node_t *next_node = vlib_get_node (vm, n->next_nodes[next_index]);
u32 *magic = vlib_frame_find_magic (f, next_node);
ASSERT (VLIB_FRAME_MAGIC == magic[0]);
}
vlib_frame_t *
vlib_get_next_frame_internal (vlib_main_t * vm,
vlib_node_runtime_t * node,
u32 next_index, u32 allocate_new_next_frame)
{
vlib_frame_t *f;
vlib_next_frame_t *nf;
u32 n_used;
nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
/* Make sure this next frame owns right to enqueue to destination frame. */
if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_OWNER)))
vlib_next_frame_change_ownership (vm, node, next_index);
/* ??? Don't need valid flag: can use frame_index == ~0 */
if (PREDICT_FALSE (!(nf->flags & VLIB_FRAME_IS_ALLOCATED)))
{
nf->frame = vlib_frame_alloc (vm, node, next_index);
nf->flags |= VLIB_FRAME_IS_ALLOCATED;
}
f = nf->frame;
/* Has frame been removed from pending vector (e.g. finished dispatching)?
If so we can reuse frame. */
if ((nf->flags & VLIB_FRAME_PENDING)
&& !(f->frame_flags & VLIB_FRAME_PENDING))
{
nf->flags &= ~VLIB_FRAME_PENDING;
f->n_vectors = 0;
f->flags = 0;
}
/* Allocate new frame if current one is marked as no-append or
it is already full. */
n_used = f->n_vectors;
if (n_used >= VLIB_FRAME_SIZE || (allocate_new_next_frame && n_used > 0) ||
(f->frame_flags & VLIB_FRAME_NO_APPEND))
{
/* Old frame may need to be freed after dispatch, since we'll have
two redundant frames from node -> next node. */
if (!(nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH))
{
vlib_frame_t *f_old = vlib_get_frame (vm, nf->frame);
f_old->frame_flags |= VLIB_FRAME_FREE_AFTER_DISPATCH;
}
/* Allocate new frame to replace full one. */
f = nf->frame = vlib_frame_alloc (vm, node, next_index);
n_used = f->n_vectors;
}
/* Should have free vectors in frame now. */
ASSERT (n_used < VLIB_FRAME_SIZE);
if (CLIB_DEBUG > 0)
{
validate_frame_magic (vm, f,
vlib_get_node (vm, node->node_index), next_index);
}
return f;
}
static void
vlib_put_next_frame_validate (vlib_main_t * vm,
vlib_node_runtime_t * rt,
u32 next_index, u32 n_vectors_left)
{
vlib_node_main_t *nm = &vm->node_main;
vlib_next_frame_t *nf;
vlib_frame_t *f;
vlib_node_runtime_t *next_rt;
vlib_node_t *next_node;
u32 n_before, n_after;
nf = vlib_node_runtime_get_next_frame (vm, rt, next_index);
f = vlib_get_frame (vm, nf->frame);
ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
vlib_validate_frame_indices (f);
n_after = VLIB_FRAME_SIZE - n_vectors_left;
n_before = f->n_vectors;
ASSERT (n_after >= n_before);
next_rt = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
nf->node_runtime_index);
next_node = vlib_get_node (vm, next_rt->node_index);
if (n_after > 0 && next_node->validate_frame)
{
u8 *msg = next_node->validate_frame (vm, rt, f);
if (msg)
{
clib_warning ("%v", msg);
ASSERT (0);
}
vec_free (msg);
}
}
void
vlib_put_next_frame (vlib_main_t * vm,
vlib_node_runtime_t * r,
u32 next_index, u32 n_vectors_left)
{
vlib_node_main_t *nm = &vm->node_main;
vlib_next_frame_t *nf;
vlib_frame_t *f;
u32 n_vectors_in_frame;
if (CLIB_DEBUG > 0)
vlib_put_next_frame_validate (vm, r, next_index, n_vectors_left);
nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
f = vlib_get_frame (vm, nf->frame);
/* Make sure that magic number is still there. Otherwise, caller
has overrun frame meta data. */
if (CLIB_DEBUG > 0)
{
vlib_node_t *node = vlib_get_node (vm, r->node_index);
validate_frame_magic (vm, f, node, next_index);
}
/* Convert # of vectors left -> number of vectors there. */
ASSERT (n_vectors_left <= VLIB_FRAME_SIZE);
n_vectors_in_frame = VLIB_FRAME_SIZE - n_vectors_left;
f->n_vectors = n_vectors_in_frame;
/* If vectors were added to frame, add to pending vector. */
if (PREDICT_TRUE (n_vectors_in_frame > 0))
{
vlib_pending_frame_t *p;
u32 v0, v1;
r->cached_next_index = next_index;
if (!(f->frame_flags & VLIB_FRAME_PENDING))
{
__attribute__ ((unused)) vlib_node_t *node;
node = vlib_get_node (vm, r->node_index);
vec_add2 (nm->pending_frames, p, 1);
p->frame = nf->frame;
p->node_runtime_index = nf->node_runtime_index;
p->next_frame_index = nf - nm->next_frames;
nf->flags |= VLIB_FRAME_PENDING;
f->frame_flags |= VLIB_FRAME_PENDING;
}
/* Copy trace flag from next_frame and from runtime. */
nf->flags |=
(nf->flags & VLIB_NODE_FLAG_TRACE) | (r->
flags & VLIB_NODE_FLAG_TRACE);
v0 = nf->vectors_since_last_overflow;
v1 = v0 + n_vectors_in_frame;
nf->vectors_since_last_overflow = v1;
if (PREDICT_FALSE (v1 < v0))
{
vlib_node_t *node = vlib_get_node (vm, r->node_index);
vec_elt (node->n_vectors_by_next_node, next_index) += v0;
}
}
}
/* Sync up runtime (32 bit counters) and main node stats (64 bit counters). */
void
vlib_node_runtime_sync_stats_node (vlib_node_t *n, vlib_node_runtime_t *r,
uword n_calls, uword n_vectors,
uword n_clocks)
{
n->stats_total.calls += n_calls + r->calls_since_last_overflow;
n->stats_total.vectors += n_vectors + r->vectors_since_last_overflow;
n->stats_total.clocks += n_clocks + r->clocks_since_last_overflow;
n->stats_total.max_clock = r->max_clock;
n->stats_total.max_clock_n = r->max_clock_n;
r->calls_since_last_overflow = 0;
r->vectors_since_last_overflow = 0;
r->clocks_since_last_overflow = 0;
}
void
vlib_node_runtime_sync_stats (vlib_main_t *vm, vlib_node_runtime_t *r,
uword n_calls, uword n_vectors, uword n_clocks)
{
vlib_node_t *n = vlib_get_node (vm, r->node_index);
vlib_node_runtime_sync_stats_node (n, r, n_calls, n_vectors, n_clocks);
}
always_inline void __attribute__ ((unused))
vlib_process_sync_stats (vlib_main_t * vm,
vlib_process_t * p,
uword n_calls, uword n_vectors, uword n_clocks)
{
vlib_node_runtime_t *rt = &p->node_runtime;
vlib_node_t *n = vlib_get_node (vm, rt->node_index);
vlib_node_runtime_sync_stats (vm, rt, n_calls, n_vectors, n_clocks);
n->stats_total.suspends += p->n_suspends;
p->n_suspends = 0;
}
void
vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n)
{
vlib_node_runtime_t *rt;
if (n->type == VLIB_NODE_TYPE_PROCESS)
{
/* Nothing to do for PROCESS nodes except in main thread */
if (vm != vlib_get_first_main ())
return;
vlib_process_t *p = vlib_get_process_from_node (vm, n);
n->stats_total.suspends += p->n_suspends;
p->n_suspends = 0;
rt = &p->node_runtime;
}
else
rt =
vec_elt_at_index (vm->node_main.nodes_by_type[n->type],
n->runtime_index);
vlib_node_runtime_sync_stats (vm, rt, 0, 0, 0);
/* Sync up runtime next frame vector counters with main node structure. */
{
vlib_next_frame_t *nf;
uword i;
for (i = 0; i < rt->n_next_nodes; i++)
{
if (n->flags & VLIB_NODE_FLAG_ALLOW_LAZY_NEXT_NODES &&
n->next_nodes[i] == VLIB_INVALID_NODE_INDEX)
continue;
nf = vlib_node_runtime_get_next_frame (vm, rt, i);
vec_elt (n->n_vectors_by_next_node, i) +=
nf->vectors_since_last_overflow;
nf->vectors_since_last_overflow = 0;
}
}
}
always_inline u32
vlib_node_runtime_update_stats (vlib_main_t * vm,
vlib_node_runtime_t * node,
uword n_calls,
uword n_vectors, uword n_clocks)
{
u32 ca0, ca1, v0, v1, cl0, cl1, r;
cl0 = cl1 = node->clocks_since_last_overflow;
ca0 = ca1 = node->calls_since_last_overflow;
v0 = v1 = node->vectors_since_last_overflow;
ca1 = ca0 + n_calls;
v1 = v0 + n_vectors;
cl1 = cl0 + n_clocks;
node->calls_since_last_overflow = ca1;
node->clocks_since_last_overflow = cl1;
node->vectors_since_last_overflow = v1;
node->max_clock_n = node->max_clock > n_clocks ?
node->max_clock_n : n_vectors;
node->max_clock = node->max_clock > n_clocks ? node->max_clock : n_clocks;
r = vlib_node_runtime_update_main_loop_vector_stats (vm, node, n_vectors);
if (PREDICT_FALSE (ca1 < ca0 || v1 < v0 || cl1 < cl0))
{
node->calls_since_last_overflow = ca0;
node->clocks_since_last_overflow = cl0;
node->vectors_since_last_overflow = v0;
vlib_node_runtime_sync_stats (vm, node, n_calls, n_vectors, n_clocks);
}
return r;
}
always_inline void
vlib_process_update_stats (vlib_main_t * vm,
vlib_process_t * p,
uword n_calls, uword n_vectors, uword n_clocks)
{
vlib_node_runtime_update_stats (vm, &p->node_runtime,
n_calls, n_vectors, n_clocks);
}
static clib_error_t *
vlib_cli_elog_clear (vlib_main_t * vm,
unformat_input_t * input, vlib_cli_command_t * cmd)
{
elog_reset_buffer (&vlib_global_main.elog_main);
return 0;
}
VLIB_CLI_COMMAND (elog_clear_cli, static) = {
.path = "event-logger clear",
.short_help = "Clear the event log",
.function = vlib_cli_elog_clear,
};
#ifdef CLIB_UNIX
static clib_error_t *
elog_save_buffer (vlib_main_t * vm,
unformat_input_t * input, vlib_cli_command_t * cmd)
{
elog_main_t *em = &vlib_global_main.elog_main;
char *file, *chroot_file;
clib_error_t *error = 0;
if (!unformat (input, "%s", &file))
{
vlib_cli_output (vm, "expected file name, got `%U'",
format_unformat_error, input);
return 0;
}
/* It's fairly hard to get "../oopsie" through unformat; just in case */
if (strstr (file, "..") || strchr (file, '/'))
{
vlib_cli_output (vm, "illegal characters in filename '%s'", file);
return 0;
}
chroot_file = (char *) format (0, "/tmp/%s%c", file, 0);
vec_free (file);
vlib_cli_output (vm, "Saving %wd of %wd events to %s",
elog_n_events_in_buffer (em),
elog_buffer_capacity (em), chroot_file);
vlib_worker_thread_barrier_sync (vm);
error = elog_write_file (em, chroot_file, 1 /* flush ring */ );
vlib_worker_thread_barrier_release (vm);
vec_free (chroot_file);
return error;
}
void
vlib_post_mortem_dump (void)
{
vlib_global_main_t *vgm = vlib_get_global_main ();
for (int i = 0; i < vec_len (vgm->post_mortem_callbacks); i++)
(vgm->post_mortem_callbacks[i]) ();
}
VLIB_CLI_COMMAND (elog_save_cli, static) = {
.path = "event-logger save",
.short_help = "event-logger save <filename> (saves log in /tmp/<filename>)",
.function = elog_save_buffer,
};
static clib_error_t *
elog_stop (vlib_main_t * vm,
unformat_input_t * input, vlib_cli_command_t * cmd)
{
elog_main_t *em = &vlib_global_main.elog_main;
em->n_total_events_disable_limit = em->n_total_events;
vlib_cli_output (vm, "Stopped the event logger...");
return 0;
}
VLIB_CLI_COMMAND (elog_stop_cli, static) = {
.path = "event-logger stop",
.short_help = "Stop the event-logger",
.function = elog_stop,
};
static clib_error_t *
elog_restart (vlib_main_t * vm,
unformat_input_t * input, vlib_cli_command_t * cmd)
{
elog_main_t *em = &vlib_global_main.elog_main;
em->n_total_events_disable_limit = ~0;
vlib_cli_output (vm, "Restarted the event logger...");
return 0;
}
VLIB_CLI_COMMAND (elog_restart_cli, static) = {
.path = "event-logger restart",
.short_help = "Restart the event-logger",
.function = elog_restart,
};
static clib_error_t *
elog_resize_command_fn (vlib_main_t * vm,
unformat_input_t * input, vlib_cli_command_t * cmd)
{
elog_main_t *em = &vlib_global_main.elog_main;
u32 tmp;
/* Stop the parade */
elog_reset_buffer (em);
if (unformat (input, "%d", &tmp))
{
elog_alloc (em, tmp);
em->n_total_events_disable_limit = ~0;
}
else
return clib_error_return (0, "Must specify how many events in the ring");
vlib_cli_output (vm, "Resized ring and restarted the event logger...");
return 0;
}
VLIB_CLI_COMMAND (elog_resize_cli, static) = {
.path = "event-logger resize",
.short_help = "event-logger resize <nnn>",
.function = elog_resize_command_fn,
};
#endif /* CLIB_UNIX */
static void
elog_show_buffer_internal (vlib_main_t * vm, u32 n_events_to_show)
{
elog_main_t *em = &vlib_global_main.elog_main;
elog_event_t *e, *es;
f64 dt;
/* Show events in VLIB time since log clock starts after VLIB clock. */
dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
* vm->clib_time.seconds_per_clock;
es = elog_peek_events (em);
vlib_cli_output (vm, "%d of %d events in buffer, logger %s", vec_len (es),
em->event_ring_size,
em->n_total_events < em->n_total_events_disable_limit ?
"running" : "stopped");
vec_foreach (e, es)
{
vlib_cli_output (vm, "%18.9f: %U",
e->time + dt, format_elog_event, em, e);
n_events_to_show--;
if (n_events_to_show == 0)
break;
}
vec_free (es);
}
static clib_error_t *
elog_show_buffer (vlib_main_t * vm,
unformat_input_t * input, vlib_cli_command_t * cmd)
{
u32 n_events_to_show;
clib_error_t *error = 0;
n_events_to_show = 250;
while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
{
if (unformat (input, "%d", &n_events_to_show))
;
else if (unformat (input, "all"))
n_events_to_show = ~0;
else
return unformat_parse_error (input);
}
elog_show_buffer_internal (vm, n_events_to_show);
return error;
}
VLIB_CLI_COMMAND (elog_show_cli, static) = {
.path = "show event-logger",
.short_help = "Show event logger info",
.function = elog_show_buffer,
};
void
vlib_gdb_show_event_log (void)
{
elog_show_buffer_internal (vlib_get_main (), (u32) ~ 0);
}
static inline void
vlib_elog_main_loop_event (vlib_main_t * vm,
u32 node_index,
u64 time, u32 n_vectors, u32 is_return)
{
vlib_main_t *evm = vlib_get_first_main ();
elog_main_t *em = vlib_get_elog_main ();
int enabled = evm->elog_trace_graph_dispatch |
evm->elog_trace_graph_circuit;
if (PREDICT_FALSE (enabled && n_vectors))
{
if (PREDICT_FALSE (!elog_is_enabled (em)))
{
evm->elog_trace_graph_dispatch = 0;
evm->elog_trace_graph_circuit = 0;
return;
}
if (PREDICT_TRUE
(evm->elog_trace_graph_dispatch ||
(evm->elog_trace_graph_circuit &&
node_index == evm->elog_trace_graph_circuit_node_index)))
{
elog_track (em,
/* event type */
vec_elt_at_index (is_return
? evm->node_return_elog_event_types
: evm->node_call_elog_event_types,
node_index),
/* track */
(vm->thread_index ?
&vlib_worker_threads[vm->thread_index].elog_track
: &em->default_track),
/* data to log */ n_vectors);
}
}
}
static inline void
add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
{
#if VLIB_BUFFER_TRACE_TRAJECTORY > 0
if (PREDICT_FALSE (b->trajectory_nb >= VLIB_BUFFER_TRACE_TRAJECTORY_MAX))
return;
b->trajectory_trace[b->trajectory_nb] = node_index;
b->trajectory_nb++;
#endif
}
static_always_inline u64
dispatch_node (vlib_main_t * vm,
vlib_node_runtime_t * node,
vlib_node_type_t type,
vlib_node_state_t dispatch_state,
vlib_frame_t * frame, u64 last_time_stamp)
{
uword n, v;
u64 t;
vlib_node_main_t *nm = &vm->node_main;
vlib_next_frame_t *nf;
if (CLIB_DEBUG > 0)
{
vlib_node_t *n = vlib_get_node (vm, node->node_index);
ASSERT (n->type == type);
}
/* Only non-internal nodes may be disabled. */
if (type != VLIB_NODE_TYPE_INTERNAL && node->state != dispatch_state)
{
ASSERT (type != VLIB_NODE_TYPE_INTERNAL);
return last_time_stamp;
}
if ((type == VLIB_NODE_TYPE_PRE_INPUT || type == VLIB_NODE_TYPE_INPUT)
&& dispatch_state != VLIB_NODE_STATE_INTERRUPT)
{
u32 c = node->input_main_loops_per_call;
/* Only call node when count reaches zero. */
if (c)
{
node->input_main_loops_per_call = c - 1;
return last_time_stamp;
}
}
/* Speculatively prefetch next frames. */
if (node->n_next_nodes > 0)
{
nf = vec_elt_at_index (nm->next_frames, node->next_frame_index);
CLIB_PREFETCH (nf, 4 * sizeof (nf[0]), WRITE);
}
vm->cpu_time_last_node_dispatch = last_time_stamp;
vlib_elog_main_loop_event (vm, node->node_index,
last_time_stamp, frame ? frame->n_vectors : 0,
/* is_after */ 0);
vlib_node_runtime_perf_counter (vm, node, frame, 0, last_time_stamp,
VLIB_NODE_RUNTIME_PERF_BEFORE);
/*
* Turn this on if you run into
* "bad monkey" contexts, and you want to know exactly
* which nodes they've visited... See ixge.c...
*/
if (VLIB_BUFFER_TRACE_TRAJECTORY && frame)
{
int i;
u32 *from;
from = vlib_frame_vector_args (frame);
for (i = 0; i < frame->n_vectors; i++)
{
vlib_buffer_t *b = vlib_get_buffer (vm, from[i]);
add_trajectory_trace (b, node->node_index);
}
if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
n = node->function (vm, node, frame);
else
n = vm->dispatch_wrapper_fn (vm, node, frame);
}
else
{
if (PREDICT_TRUE (vm->dispatch_wrapper_fn == 0))
n = node->function (vm, node, frame);
else
n = vm->dispatch_wrapper_fn (vm, node, frame);
}
t = clib_cpu_time_now ();
vlib_node_runtime_perf_counter (vm, node, frame, n, t,
VLIB_NODE_RUNTIME_PERF_AFTER);
vlib_elog_main_loop_event (vm, node->node_index, t, n, 1 /* is_after */ );
vm->main_loop_vectors_processed += n;
vm->main_loop_nodes_processed += n > 0;
v = vlib_node_runtime_update_stats (vm, node,
/* n_calls */ 1,
/* n_vectors */ n,
/* n_clocks */ t - last_time_stamp);
/* When in adaptive mode and vector rate crosses threshold switch to
polling mode and vice versa. */
if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_ADAPTIVE_MODE))
{
ELOG_TYPE_DECLARE (e) =
{
.function = (char *) __FUNCTION__,
.format = "%s vector length %d, switching to %s",
.format_args = "T4i4t4",
.n_enum_strings = 2,
.enum_strings = {
"interrupt", "polling",
},
};
struct
{
u32 node_name, vector_length, is_polling;
} *ed;
if ((dispatch_state == VLIB_NODE_STATE_INTERRUPT
&& v >= nm->polling_threshold_vector_length) &&
!(node->flags &
VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE))
{
vlib_node_t *n = vlib_get_node (vm, node->node_index);
n->state = VLIB_NODE_STATE_POLLING;
node->state = VLIB_NODE_STATE_POLLING;
node->flags &=
~VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
node->flags |= VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] -= 1;
nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] += 1;
if (PREDICT_FALSE (
vlib_get_first_main ()->elog_trace_graph_dispatch))
{
vlib_worker_thread_t *w = vlib_worker_threads
+ vm->thread_index;
ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
w->elog_track);
ed->node_name = n->name_elog_string;
ed->vector_length = v;
ed->is_polling = 1;
}
}
else if (dispatch_state == VLIB_NODE_STATE_POLLING
&& v <= nm->interrupt_threshold_vector_length)
{
vlib_node_t *n = vlib_get_node (vm, node->node_index);
if (node->flags &
VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE)
{
/* Switch to interrupt mode after dispatch in polling one more time.
This allows driver to re-enable interrupts. */
n->state = VLIB_NODE_STATE_INTERRUPT;
node->state = VLIB_NODE_STATE_INTERRUPT;
node->flags &=
~VLIB_NODE_FLAG_SWITCH_FROM_INTERRUPT_TO_POLLING_MODE;
nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] -= 1;
nm->input_node_counts_by_state[VLIB_NODE_STATE_INTERRUPT] += 1;
}
else
{
vlib_worker_thread_t *w = vlib_worker_threads
+ vm->thread_index;
node->flags |=
VLIB_NODE_FLAG_SWITCH_FROM_POLLING_TO_INTERRUPT_MODE;
if (PREDICT_FALSE (
vlib_get_first_main ()->elog_trace_graph_dispatch))
{
ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
w->elog_track);
ed->node_name = n->name_elog_string;
ed->vector_length = v;
ed->is_polling = 0;
}
}
}
}
return t;
}
static u64
dispatch_pending_node (vlib_main_t * vm, uword pending_frame_index,
u64 last_time_stamp)
{
vlib_node_main_t *nm = &vm->node_main;
vlib_frame_t *f;
vlib_next_frame_t *nf, nf_placeholder;
vlib_node_runtime_t *n;
vlib_frame_t *restore_frame;
vlib_pending_frame_t *p;
/* See comment below about dangling references to nm->pending_frames */
p = nm->pending_frames + pending_frame_index;
n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
p->node_runtime_index);
f = vlib_get_frame (vm, p->frame);
if (p->next_frame_index == VLIB_PENDING_FRAME_NO_NEXT_FRAME)
{
/* No next frame: so use placeholder on stack. */
nf = &nf_placeholder;
nf->flags = f->frame_flags & VLIB_NODE_FLAG_TRACE;
nf->frame = NULL;
}
else
nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
ASSERT (f->frame_flags & VLIB_FRAME_IS_ALLOCATED);
/* Force allocation of new frame while current frame is being
dispatched. */
restore_frame = NULL;
if (nf->frame == p->frame)
{
nf->frame = NULL;
nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
restore_frame = p->frame;
}
/* Frame must be pending. */
ASSERT (f->frame_flags & VLIB_FRAME_PENDING);
ASSERT (f->n_vectors > 0);
/* Copy trace flag from next frame to node.
Trace flag indicates that at least one vector in the dispatched
frame is traced. */
n->flags &= ~VLIB_NODE_FLAG_TRACE;
n->flags |= (nf->flags & VLIB_FRAME_TRACE) ? VLIB_NODE_FLAG_TRACE : 0;
nf->flags &= ~VLIB_FRAME_TRACE;
last_time_stamp = dispatch_node (vm, n,
VLIB_NODE_TYPE_INTERNAL,
VLIB_NODE_STATE_POLLING,
f, last_time_stamp);
/* Internal node vector-rate accounting, for summary stats */
vm->internal_node_vectors += f->n_vectors;
vm->internal_node_calls++;
vm->internal_node_last_vectors_per_main_loop =
(f->n_vectors > vm->internal_node_last_vectors_per_main_loop) ?
f->n_vectors : vm->internal_node_last_vectors_per_main_loop;
f->frame_flags &= ~(VLIB_FRAME_PENDING | VLIB_FRAME_NO_APPEND);
/* Frame is ready to be used again, so restore it. */
if (restore_frame != NULL)
{
/*
* We musn't restore a frame that is flagged to be freed. This
* shouldn't happen since frames to be freed post dispatch are
* those used when the to-node frame becomes full i.e. they form a
* sort of queue of frames to a single node. If we get here then
* the to-node frame and the pending frame *were* the same, and so
* we removed the to-node frame. Therefore this frame is no
* longer part of the queue for that node and hence it cannot be
* it's overspill.
*/
ASSERT (!(f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH));
/*
* NB: dispatching node n can result in the creation and scheduling
* of new frames, and hence in the reallocation of nm->pending_frames.
* Recompute p, or no supper. This was broken for more than 10 years.
*/
p = nm->pending_frames + pending_frame_index;
/*
* p->next_frame_index can change during node dispatch if node
* function decides to change graph hook up.
*/
nf = vec_elt_at_index (nm->next_frames, p->next_frame_index);
nf->flags |= VLIB_FRAME_IS_ALLOCATED;
if (NULL == nf->frame)
{
/* no new frame has been assigned to this node, use the saved one */
nf->frame = restore_frame;
f->n_vectors = 0;
f->flags = 0;
}
else
{
/* The node has gained a frame, implying packets from the current frame
were re-queued to this same node. we don't need the saved one
anymore */
vlib_frame_free (vm, f);
}
}
else
{
if (f->frame_flags & VLIB_FRAME_FREE_AFTER_DISPATCH)
{
ASSERT (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH));
vlib_frame_free (vm, f);
}
}
return last_time_stamp;
}
always_inline uword
vlib_process_stack_is_valid (vlib_process_t * p)
{
return p->stack[0] == VLIB_PROCESS_STACK_MAGIC;
}
typedef struct
{
vlib_main_t *vm;
vlib_process_t *process;
vlib_frame_t *frame;
} vlib_process_bootstrap_args_t;
/* Called in process stack. */
static uword
vlib_process_bootstrap (uword _a)
{
vlib_process_bootstrap_args_t *a;
vlib_main_t *vm;
vlib_node_runtime_t *node;
vlib_frame_t *f;
vlib_process_t *p;
uword n;
a = uword_to_pointer (_a, vlib_process_bootstrap_args_t *);
vm = a->vm;
p = a->process;
vlib_process_finish_switch_stack (vm);
f = a->frame;
node = &p->node_runtime;
n = node->function (vm, node, f);
ASSERT (vlib_process_stack_is_valid (p));
vlib_process_start_switch_stack (vm, 0);
clib_longjmp (&p->return_longjmp, n);
return n;
}
/* Called in main stack. */
static_always_inline uword
vlib_process_startup (vlib_main_t * vm, vlib_process_t * p, vlib_frame_t * f)
{
vlib_process_bootstrap_args_t a;
uword r;
a.vm = vm;
a.process = p;
a.frame = f;
r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
{
vlib_process_start_switch_stack (vm, p);
r = clib_calljmp (vlib_process_bootstrap, pointer_to_uword (&a),
(void *) p->stack + (1 << p->log2_n_stack_bytes));
}
else
vlib_process_finish_switch_stack (vm);
return r;
}
static_always_inline uword
vlib_process_resume (vlib_main_t * vm, vlib_process_t * p)
{
uword r;
if (p->state == VLIB_PROCESS_STATE_WAIT_FOR_EVENT ||
p->state == VLIB_PROCESS_STATE_WAIT_FOR_EVENT_OR_CLOCK)
p->event_resume_pending = 0;
p->state = VLIB_PROCESS_STATE_RUNNING;
r = clib_setjmp (&p->return_longjmp, VLIB_PROCESS_RETURN_LONGJMP_RETURN);
if (r == VLIB_PROCESS_RETURN_LONGJMP_RETURN)
{
vlib_process_start_switch_stack (vm, p);
clib_longjmp (&p->resume_longjmp, VLIB_PROCESS_RESUME_LONGJMP_RESUME);
}
else
vlib_process_finish_switch_stack (vm);
return r;
}
static u64
dispatch_process (vlib_main_t * vm,
vlib_process_t * p, vlib_frame_t * f, u64 last_time_stamp)
{
vlib_node_main_t *nm = &vm->node_main;
vlib_node_runtime_t *node_runtime = &p->node_runtime;
vlib_node_t *node = vlib_get_node (vm, node_runtime->node_index);
u32 old_process_index;
u64 t;
uword n_vectors, is_suspend;
if (node->state != VLIB_NODE_STATE_POLLING)
return last_time_stamp;
if (p->state != VLIB_PROCESS_STATE_NOT_STARTED)
return last_time_stamp;
p->state = VLIB_PROCESS_STATE_RUNNING;
t = last_time_stamp;
vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
f ? f->n_vectors : 0, /* is_after */ 0);
/* Save away current process for suspend. */
old_process_index = nm->current_process_index;
nm->current_process_index = node->runtime_index;
vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
VLIB_NODE_RUNTIME_PERF_BEFORE);
n_vectors = vlib_process_startup (vm, p, f);
nm->current_process_index = old_process_index;
ASSERT (n_vectors != VLIB_PROCESS_RETURN_LONGJMP_RETURN);
is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
if (is_suspend)
{
vlib_pending_frame_t *pf;
n_vectors = 0;
pool_get (nm->suspended_process_frames, pf);
pf->node_runtime_index = node->runtime_index;
pf->frame = f;
pf->next_frame_index = ~0;
p->n_suspends += 1;
p->suspended_process_frame_index = pf - nm->suspended_process_frames;
if (p->resume_clock_interval)
{
TWT (tw_timer_wheel) *tw = (TWT (tw_timer_wheel) *) nm->timing_wheel;
p->stop_timer_handle =
TW (tw_timer_start) (tw,
vlib_timing_wheel_data_set_suspended_process (
node->runtime_index) /* [sic] pool idex */,
0 /* timer_id */, p->resume_clock_interval);
}
}
else
p->state = VLIB_PROCESS_STATE_NOT_STARTED;
t = clib_cpu_time_now ();
vlib_elog_main_loop_event (vm, node_runtime->node_index, t, is_suspend,
/* is_after */ 1);
vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
VLIB_NODE_RUNTIME_PERF_AFTER);
vlib_process_update_stats (vm, p,
/* n_calls */ !is_suspend,
/* n_vectors */ n_vectors,
/* n_clocks */ t - last_time_stamp);
return t;
}
void
vlib_start_process (vlib_main_t * vm, uword process_index)
{
vlib_node_main_t *nm = &vm->node_main;
vlib_process_t *p = vec_elt (nm->processes, process_index);
u64 cpu_time_now = clib_cpu_time_now ();
dispatch_process (vm, p, /* frame */ 0, cpu_time_now);
}
static u64
dispatch_suspended_process (vlib_main_t *vm, vlib_process_restore_t *r,
u64 last_time_stamp)
{
vlib_node_main_t *nm = &vm->node_main;
vlib_node_runtime_t *node_runtime;
vlib_node_t *node;
vlib_frame_t *f;
vlib_process_t *p;
vlib_pending_frame_t *pf;
u64 t, n_vectors, is_suspend;
uword process_index = r->runtime_index;
u8 resume_permissons[VLIB_PROCRSS_N_RESTORE_REASON][VLIB_PROCESS_N_STATES] = {
[VLIB_PROCESS_RESTORE_REASON_YIELD] = {
[VLIB_PROCESS_STATE_YIELD] = 1,
},
[VLIB_PROCESS_RESTORE_REASON_CLOCK] = {
[VLIB_PROCESS_STATE_WAIT_FOR_CLOCK] = 1,
[VLIB_PROCESS_STATE_WAIT_FOR_EVENT_OR_CLOCK] = 1,
[VLIB_PROCESS_STATE_SUSPENDED] = 1,
},
[VLIB_PROCESS_RESTORE_REASON_EVENT] = {
[VLIB_PROCESS_STATE_WAIT_FOR_EVENT] = 1,
[VLIB_PROCESS_STATE_WAIT_FOR_EVENT_OR_CLOCK] = 1,
},
[VLIB_PROCESS_RESTORE_REASON_TIMED_EVENT] = {
[VLIB_PROCESS_STATE_WAIT_FOR_EVENT] = 1,
[VLIB_PROCESS_STATE_WAIT_FOR_EVENT_OR_CLOCK] = 1,
},
};
t = last_time_stamp;
p = vec_elt (nm->processes, process_index);
if (PREDICT_FALSE (p->state == VLIB_PROCESS_STATE_NOT_STARTED))
return last_time_stamp;
if (resume_permissons[r->reason][p->state] == 0)
{
vec_add1 (nm->process_restore_next, *r);
return last_time_stamp;
}
pf = pool_elt_at_index (nm->suspended_process_frames,
p->suspended_process_frame_index);
node_runtime = &p->node_runtime;
node = vlib_get_node (vm, node_runtime->node_index);
f = pf->frame;
vlib_elog_main_loop_event (vm, node_runtime->node_index, t,
f ? f->n_vectors : 0, /* is_after */ 0);
/* Save away current process for suspend. */
nm->current_process_index = node->runtime_index;
vlib_node_runtime_perf_counter (vm, node_runtime, f, 0, last_time_stamp,
VLIB_NODE_RUNTIME_PERF_BEFORE);
n_vectors = vlib_process_resume (vm, p);
t = clib_cpu_time_now ();
nm->current_process_index = ~0;
is_suspend = n_vectors == VLIB_PROCESS_RETURN_LONGJMP_SUSPEND;
if (is_suspend)
{
/* Suspend it again. */
n_vectors = 0;
p->n_suspends += 1;
if (p->resume_clock_interval)
{
p->stop_timer_handle =
TW (tw_timer_start) ((TWT (tw_timer_wheel) *) nm->timing_wheel,
vlib_timing_wheel_data_set_suspended_process
(node->runtime_index) /* [sic] pool idex */ ,
0 /* timer_id */ ,
p->resume_clock_interval);
}
}
else
{
p->state = VLIB_PROCESS_STATE_NOT_STARTED;
pool_put_index (nm->suspended_process_frames,
p->suspended_process_frame_index);
p->suspended_process_frame_index = ~0;
}
t = clib_cpu_time_now ();
vlib_elog_main_loop_event (vm, node_runtime->node_index, t, !is_suspend,
/* is_after */ 1);
vlib_node_runtime_perf_counter (vm, node_runtime, f, n_vectors, t,
VLIB_NODE_RUNTIME_PERF_AFTER);
vlib_process_update_stats (vm, p,
/* n_calls */ !is_suspend,
/* n_vectors */ n_vectors,
/* n_clocks */ t - last_time_stamp);
return t;
}
static_always_inline void
vlib_main_or_worker_loop (vlib_main_t * vm, int is_main)
{
vlib_node_main_t *nm = &vm->node_main;
vlib_thread_main_t *tm = vlib_get_thread_main ();
uword i;
u64 cpu_time_now;
f64 now;
vlib_frame_queue_main_t *fqm;
u32 frame_queue_check_counter = 0;
/* Initialize pending node vector. */
if (is_main)
{
vec_resize (nm->pending_frames, 32);
vec_set_len (nm->pending_frames, 0);
}
/* Mark time of main loop start. */
if (is_main)
{
cpu_time_now = vm->clib_time.last_cpu_time;
vm->cpu_time_main_loop_start = cpu_time_now;
}
else
cpu_time_now = clib_cpu_time_now ();
/* Pre-allocate expired nodes. */
if (!nm->polling_threshold_vector_length)
nm->polling_threshold_vector_length = 10;
if (!nm->interrupt_threshold_vector_length)
nm->interrupt_threshold_vector_length = 5;
vm->cpu_id = clib_get_current_cpu_id ();
vm->numa_node = clib_get_current_numa_node ();
os_set_numa_index (vm->numa_node);
/* Start all processes. */
if (is_main)
{
uword i;
/*
* Perform an initial barrier sync. Pays no attention to
* the barrier sync hold-down timer scheme, which won't work
* at this point in time.
*/
vlib_worker_thread_initial_barrier_sync_and_release (vm);
nm->current_process_index = ~0;
for (i = 0; i < vec_len (nm->processes); i++)
cpu_time_now = dispatch_process (vm, nm->processes[i], /* frame */ 0,
cpu_time_now);
}
while (1)
{
vlib_node_runtime_t *n;
if (PREDICT_FALSE (_vec_len (vm->pending_rpc_requests) > 0))
{
if (!is_main)
vlib_worker_flush_pending_rpc_requests (vm);
}
if (!is_main)
vlib_worker_thread_barrier_check ();
if (PREDICT_FALSE (vm->check_frame_queues + frame_queue_check_counter))
{
u32 processed = 0;
vlib_frame_queue_dequeue_fn_t *fn;
if (vm->check_frame_queues)
{
frame_queue_check_counter = 100;
vm->check_frame_queues = 0;
}
vec_foreach (fqm, tm->frame_queue_mains)
{
fn = fqm->frame_queue_dequeue_fn;
processed += (fn) (vm, fqm);
}
/* No handoff queue work found? */
if (processed)
frame_queue_check_counter = 100;
else
frame_queue_check_counter--;
}
if (PREDICT_FALSE (vec_len (vm->worker_thread_main_loop_callbacks)))
clib_call_callbacks (vm->worker_thread_main_loop_callbacks, vm,
cpu_time_now);
/* Process pre-input nodes. */
cpu_time_now = clib_cpu_time_now ();
vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
cpu_time_now = dispatch_node (vm, n,
VLIB_NODE_TYPE_PRE_INPUT,
VLIB_NODE_STATE_POLLING,
/* frame */ 0,
cpu_time_now);
if (clib_interrupt_is_any_pending (nm->pre_input_node_interrupts))
{
int int_num = -1;
while ((int_num = clib_interrupt_get_next_and_clear (
nm->pre_input_node_interrupts, int_num)) != -1)
{
vlib_node_runtime_t *n;
n = vec_elt_at_index (
nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT], int_num);
cpu_time_now = dispatch_node (vm, n, VLIB_NODE_TYPE_PRE_INPUT,
VLIB_NODE_STATE_INTERRUPT,
/* frame */ 0, cpu_time_now);
}
}
/* Next process input nodes. */
vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
cpu_time_now = dispatch_node (vm, n,
VLIB_NODE_TYPE_INPUT,
VLIB_NODE_STATE_POLLING,
/* frame */ 0,
cpu_time_now);
if (PREDICT_TRUE (is_main && vm->queue_signal_pending == 0))
vm->queue_signal_callback (vm);
if (clib_interrupt_is_any_pending (nm->input_node_interrupts))
{
int int_num = -1;
while ((int_num = clib_interrupt_get_next_and_clear (
nm->input_node_interrupts, int_num)) != -1)
{
vlib_node_runtime_t *n;
n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
int_num);
cpu_time_now = dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
VLIB_NODE_STATE_INTERRUPT,
/* frame */ 0, cpu_time_now);
}
}
/* Input nodes may have added work to the pending vector.
Process pending vector until there is nothing left.
All pending vectors will be processed from input -> output. */
for (i = 0; i < _vec_len (nm->pending_frames); i++)
cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
/* Reset pending vector for next iteration. */
vec_set_len (nm->pending_frames, 0);
if (is_main)
{
ELOG_TYPE_DECLARE (es) =
{
.format = "process tw start",
.format_args = "",
};
ELOG_TYPE_DECLARE (ee) =
{
.format = "process tw end: %d",
.format_args = "i4",
};
struct
{
int nready_procs;
} *ed;
/* Check if process nodes have expired from timing wheel. */
ASSERT (nm->process_restore_current != 0);
if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
ed = ELOG_DATA (&vlib_global_main.elog_main, es);
TW (tw_timer_expire_timers)
((TWT (tw_timer_wheel) *) nm->timing_wheel, vlib_time_now (vm));
ASSERT (nm->process_restore_current != 0);
if (PREDICT_FALSE (vm->elog_trace_graph_dispatch))
{
ed = ELOG_DATA (&vlib_global_main.elog_main, ee);
ed->nready_procs = _vec_len (nm->process_restore_current);
}
if (PREDICT_FALSE (_vec_len (nm->process_restore_current) > 0))
{
uword i;
for (i = 0; i < _vec_len (nm->process_restore_current); i++)
{
vlib_process_restore_t *res =
nm->process_restore_current + i;
if (res->reason == VLIB_PROCESS_RESTORE_REASON_TIMED_EVENT)
{
u32 di = res->timed_event_data_pool_index;
vlib_signal_timed_event_data_t *te =
pool_elt_at_index (nm->signal_timed_event_data_pool, di);
vlib_node_t *n =
vlib_get_node (vm, te->process_node_index);
vlib_process_t *p =
vec_elt (nm->processes, n->runtime_index);
p->stop_timer_handle = ~0;
void *data;
data = vlib_process_signal_event_helper (
nm, n, p, te->event_type_index, te->n_data_elts,
te->n_data_elt_bytes);
if (te->n_data_bytes < sizeof (te->inline_event_data))
clib_memcpy_fast (data, te->inline_event_data,
te->n_data_bytes);
else
{
clib_memcpy_fast (data, te->event_data_as_vector,
te->n_data_bytes);
vec_free (te->event_data_as_vector);
}
pool_put (nm->signal_timed_event_data_pool, te);
}
else
{
cpu_time_now = clib_cpu_time_now ();
cpu_time_now =
dispatch_suspended_process (vm, res, cpu_time_now);
}
}
vec_set_len (nm->process_restore_current, 0);
CLIB_SWAP (nm->process_restore_current,
nm->process_restore_next);
}
}
vlib_increment_main_loop_counter (vm);
/* Record time stamp in case there are no enabled nodes and above
calls do not update time stamp. */
cpu_time_now = clib_cpu_time_now ();
vm->loops_this_reporting_interval++;
now = clib_time_now_internal (&vm->clib_time, cpu_time_now);
/* Time to update loops_per_second? */
if (PREDICT_FALSE (now >= vm->loop_interval_end))
{
/* Next sample ends in 20ms */
if (vm->loop_interval_start)
{
f64 this_loops_per_second;
this_loops_per_second =
((f64) vm->loops_this_reporting_interval) / (now -
vm->loop_interval_start);
vm->loops_per_second =
vm->loops_per_second * vm->damping_constant +
(1.0 - vm->damping_constant) * this_loops_per_second;
if (vm->loops_per_second != 0.0)
vm->seconds_per_loop = 1.0 / vm->loops_per_second;
else
vm->seconds_per_loop = 0.0;
}
/* New interval starts now, and ends in 20ms */
vm->loop_interval_start = now;
vm->loop_interval_end = now + 2e-4;
vm->loops_this_reporting_interval = 0;
}
}
}
static void
vlib_main_loop (vlib_main_t * vm)
{
vlib_main_or_worker_loop (vm, /* is_main */ 1);
}
void
vlib_worker_loop (vlib_main_t * vm)
{
vlib_main_or_worker_loop (vm, /* is_main */ 0);
}
vlib_global_main_t vlib_global_main;
void
vlib_add_del_post_mortem_callback (void *cb, int is_add)
{
vlib_global_main_t *vgm = vlib_get_global_main ();
int i;
if (is_add == 0)
{
for (i = vec_len (vgm->post_mortem_callbacks) - 1; i >= 0; i--)
if (vgm->post_mortem_callbacks[i] == cb)
vec_del1 (vgm->post_mortem_callbacks, i);
return;
}
for (i = 0; i < vec_len (vgm->post_mortem_callbacks); i++)
if (vgm->post_mortem_callbacks[i] == cb)
return;
vec_add1 (vgm->post_mortem_callbacks, cb);
}
static void
elog_post_mortem_dump (void)
{
elog_main_t *em = vlib_get_elog_main ();
u8 *filename;
clib_error_t *error;
filename = format (0, "/tmp/elog_post_mortem.%d%c", getpid (), 0);
error = elog_write_file (em, (char *) filename, 1 /* flush ring */);
if (error)
clib_error_report (error);
/*
* We're in the middle of crashing. Don't try to free the filename.
*/
}
static clib_error_t *
vlib_main_configure (vlib_main_t * vm, unformat_input_t * input)
{
vlib_global_main_t *vgm = vlib_get_global_main ();
int turn_on_mem_trace = 0;
while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
{
if (unformat (input, "memory-trace"))
turn_on_mem_trace = 1;
else if (unformat (input, "elog-events %d",
&vgm->configured_elog_ring_size))
vgm->configured_elog_ring_size =
1 << max_log2 (vgm->configured_elog_ring_size);
else if (unformat (input, "elog-post-mortem-dump"))
vlib_add_del_post_mortem_callback (elog_post_mortem_dump,
/* is_add */ 1);
else if (unformat (input, "buffer-alloc-success-rate %f",
&vm->buffer_alloc_success_rate))
{
if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
return clib_error_return
(0, "Buffer fault injection not configured");
}
else if (unformat (input, "buffer-alloc-success-seed %u",
&vm->buffer_alloc_success_seed))
{
if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR == 0)
return clib_error_return
(0, "Buffer fault injection not configured");
}
else
return unformat_parse_error (input);
}
unformat_free (input);
/* Enable memory trace as early as possible. */
if (turn_on_mem_trace)
clib_mem_trace (1);
return 0;
}
VLIB_EARLY_CONFIG_FUNCTION (vlib_main_configure, "vlib");
static void
placeholder_queue_signal_callback (vlib_main_t * vm)
{
}
#define foreach_weak_reference_stub \
_(vpe_api_init) \
_(vlibmemory_init) \
_(map_api_segment_init)
#define _(name) \
clib_error_t *name (vlib_main_t *vm) __attribute__((weak)); \
clib_error_t *name (vlib_main_t *vm) { return 0; }
foreach_weak_reference_stub;
#undef _
void vl_api_set_elog_main (elog_main_t * m) __attribute__ ((weak));
void
vl_api_set_elog_main (elog_main_t * m)
{
clib_warning ("STUB");
}
int vl_api_set_elog_trace_api_messages (int enable) __attribute__ ((weak));
int
vl_api_set_elog_trace_api_messages (int enable)
{
clib_warning ("STUB");
return 0;
}
int vl_api_get_elog_trace_api_messages (void) __attribute__ ((weak));
int
vl_api_get_elog_trace_api_messages (void)
{
clib_warning ("STUB");
return 0;
}
static void
process_expired_timer_cb (u32 *expired_timer_handles)
{
vlib_main_t *vm = vlib_get_main ();
vlib_node_main_t *nm = &vm->node_main;
u32 *handle;
vec_foreach (handle, expired_timer_handles)
{
u32 index = vlib_timing_wheel_data_get_index (*handle);
vlib_process_restore_t restore = {};
if (vlib_timing_wheel_data_is_timed_event (*handle))
{
restore.reason = VLIB_PROCESS_RESTORE_REASON_TIMED_EVENT;
restore.timed_event_data_pool_index = index;
}
else
{
vlib_process_t *p = vec_elt (nm->processes, index);
p->stop_timer_handle = ~0;
restore.reason = VLIB_PROCESS_RESTORE_REASON_CLOCK;
restore.runtime_index = index;
}
vec_add1 (nm->process_restore_current, restore);
}
}
/* Main function. */
int
vlib_main (vlib_main_t * volatile vm, unformat_input_t * input)
{
vlib_global_main_t *vgm = vlib_get_global_main ();
clib_error_t *volatile error;
vlib_node_main_t *nm = &vm->node_main;
vm->queue_signal_callback = placeholder_queue_signal_callback;
/* Reconfigure event log which is enabled very early */
if (vgm->configured_elog_ring_size &&
vgm->configured_elog_ring_size != vgm->elog_main.event_ring_size)
elog_resize (&vgm->elog_main, vgm->configured_elog_ring_size);
vl_api_set_elog_main (vlib_get_elog_main ());
(void) vl_api_set_elog_trace_api_messages (1);
/* Default name. */
if (!vgm->name)
vgm->name = "VLIB";
if ((error = vlib_physmem_init (vm)))
{
clib_error_report (error);
goto done;
}
if ((error = vlib_log_init (vm)))
{
clib_error_report (error);
goto done;
}
if ((error = vlib_stats_init (vm)))
{
clib_error_report (error);
goto done;
}
if ((error = vlib_buffer_main_init (vm)))
{
clib_error_report (error);
goto done;
}
if ((error = vlib_thread_init (vm)))
{
clib_error_report (error);
goto done;
}
/* Register node ifunction variants */
vlib_register_all_node_march_variants (vm);
/* Register static nodes so that init functions may use them. */
vlib_register_all_static_nodes (vm);
/* Set seed for random number generator.
Allow user to specify seed to make random sequence deterministic. */
if (!unformat (input, "seed %wd", &vm->random_seed))
vm->random_seed = clib_cpu_time_now ();
clib_random_buffer_init (&vm->random_buffer, vm->random_seed);
/* Initialize node graph. */
if ((error = vlib_node_main_init (vm)))
{
/* Arrange for graph hook up error to not be fatal when debugging. */
if (CLIB_DEBUG > 0)
clib_error_report (error);
else
goto done;
}
/* Direct call / weak reference, for vlib standalone use-cases */
if ((error = vpe_api_init (vm)))
{
clib_error_report (error);
goto done;
}
if ((error = vlibmemory_init (vm)))
{
clib_error_report (error);
goto done;
}
if ((error = map_api_segment_init (vm)))
{
clib_error_report (error);
goto done;
}
/* See unix/main.c; most likely already set up */
if (vgm->init_functions_called == 0)
vgm->init_functions_called = hash_create (0, /* value bytes */ 0);
if ((error = vlib_call_all_init_functions (vm)))
goto done;
nm->timing_wheel = clib_mem_alloc_aligned (sizeof (TWT (tw_timer_wheel)),
CLIB_CACHE_LINE_BYTES);
vec_validate (nm->process_restore_current, 10);
vec_validate (nm->process_restore_next, 10);
vec_set_len (nm->process_restore_current, 0);
vec_set_len (nm->process_restore_next, 0);
/* Create the process timing wheel */
TW (tw_timer_wheel_init)
((TWT (tw_timer_wheel) *) nm->timing_wheel,
process_expired_timer_cb /* callback */, 10e-6 /* timer period 10us */,
~0 /* max expirations per call */);
vec_validate (vm->pending_rpc_requests, 0);
vec_set_len (vm->pending_rpc_requests, 0);
vec_validate (vm->processing_rpc_requests, 0);
vec_set_len (vm->processing_rpc_requests, 0);
/* Default params for the buffer allocator fault injector, if configured */
if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0)
{
vm->buffer_alloc_success_seed = 0xdeaddabe;
vm->buffer_alloc_success_rate = 0.80;
}
if ((error = vlib_call_all_config_functions (vm, input, 0 /* is_early */ )))
goto done;
/*
* Use exponential smoothing, with a half-life of 1 second
* reported_rate(t) = reported_rate(t-1) * K + rate(t)*(1-K)
*
* Sample every 20ms, aka 50 samples per second
* K = exp (-1.0/20.0);
* K = 0.95
*/
vm->damping_constant = exp (-1.0 / 20.0);
/* Sort per-thread init functions before we start threads */
vlib_sort_init_exit_functions (&vgm->worker_init_function_registrations);
/* Call all main loop enter functions. */
{
clib_error_t *sub_error;
sub_error = vlib_call_all_main_loop_enter_functions (vm);
if (sub_error)
clib_error_report (sub_error);
}
switch (clib_setjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_NONE))
{
case VLIB_MAIN_LOOP_EXIT_NONE:
vm->main_loop_exit_set = 1;
break;
case VLIB_MAIN_LOOP_EXIT_CLI:
goto done;
default:
error = vm->main_loop_error;
goto done;
}
vlib_main_loop (vm);
done:
/* Stop worker threads, barrier will not be released */
vlib_worker_thread_barrier_sync (vm);
/* Call all exit functions. */
{
clib_error_t *sub_error;
sub_error = vlib_call_all_main_loop_exit_functions (vm);
if (sub_error)
clib_error_report (sub_error);
}
if (error)
clib_error_report (error);
return vm->main_loop_exit_status;
}
vlib_main_t *
vlib_get_main_not_inline (void)
{
return vlib_get_main ();
}
elog_main_t *
vlib_get_elog_main_not_inline ()
{
return &vlib_global_main.elog_main;
}
void
vlib_exit_with_status (vlib_main_t *vm, int status)
{
vm->main_loop_exit_status = status;
__atomic_store_n (&vm->main_loop_exit_now, 1, __ATOMIC_RELEASE);
}
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/