aboutsummaryrefslogtreecommitdiffstats
path: root/src/vlib
diff options
context:
space:
mode:
authorDave Barach <dave@barachs.net>2018-11-27 16:52:59 -0500
committerFlorin Coras <florin.coras@gmail.com>2018-11-30 20:18:54 +0000
commit7fff3d205463d5e0a95d6bdd337100988ef323a3 (patch)
tree7743d004b00a2e674e95c4d1593ae94c09b8a8b5 /src/vlib
parent8861c1a1f229b4727fea48bfe5990808bb30f871 (diff)
Metadata / opaque formatting belongs in vpp
VPP graph dispatch trace record description: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Major Version | Minor Version | NStrings | ProtoHint | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Buffer index (big endian) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + VPP graph node name ... ... | NULL octet | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Buffer Metadata ... ... | NULL octet | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Buffer Opaque ... ... | NULL octet | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Buffer Opaque 2 ... ... | NULL octet | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | VPP ASCII packet trace (if NStrings > 4) | NULL octet | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Packet data (up to 16K) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Graph dispatch records comprise a version stamp, an indication of how many NULL-terminated strings will follow the record header, and a protocol hint. The buffer index allows downstream consumers of these data to easily filter/track single packets as they traverse the forwarding graph. FWIW, the 32-bit buffer index is stored in big endian format. As of this writing, major version = 1, minor version = 0. Nstrings will be either 4 or 5. Here is the current set of protocol hints: typedef enum { VLIB_NODE_PROTO_HINT_NONE = 0, VLIB_NODE_PROTO_HINT_ETHERNET, VLIB_NODE_PROTO_HINT_IP4, VLIB_NODE_PROTO_HINT_IP6, VLIB_NODE_PROTO_HINT_TCP, VLIB_NODE_PROTO_HINT_UDP, VLIB_NODE_N_PROTO_HINTS, } vlib_node_proto_hint_t; Example: VLIB_NODE_PROTO_HINT_IP6 means that the first octet of packet data SHOULD be 0x60, and should begin an ipv6 packet header. Change-Id: Idf310bad80cc0e4207394c80f18db5f77c378741 Signed-off-by: Dave Barach <dave@barachs.net>
Diffstat (limited to 'src/vlib')
-rw-r--r--src/vlib/main.c147
-rw-r--r--src/vlib/main.h1
-rw-r--r--src/vlib/node.c1
-rw-r--r--src/vlib/node.h17
4 files changed, 109 insertions, 57 deletions
diff --git a/src/vlib/main.c b/src/vlib/main.c
index d1babdb9da6..949a77d3d71 100644
--- a/src/vlib/main.c
+++ b/src/vlib/main.c
@@ -945,25 +945,69 @@ add_trajectory_trace (vlib_buffer_t * b, u32 node_index)
#endif
}
+u8 *format_vnet_buffer_flags (u8 * s, va_list * args) __attribute__ ((weak));
+u8 *
+format_vnet_buffer_flags (u8 * s, va_list * args)
+{
+ s = format (s, "BUG STUB %s", __FUNCTION__);
+ return s;
+}
+
+u8 *format_vnet_buffer_opaque (u8 * s, va_list * args) __attribute__ ((weak));
+u8 *
+format_vnet_buffer_opaque (u8 * s, va_list * args)
+{
+ s = format (s, "BUG STUB %s", __FUNCTION__);
+ return s;
+}
+
+u8 *format_vnet_buffer_opaque2 (u8 * s, va_list * args)
+ __attribute__ ((weak));
+u8 *
+format_vnet_buffer_opaque2 (u8 * s, va_list * args)
+{
+ s = format (s, "BUG STUB %s", __FUNCTION__);
+ return s;
+}
+
+static u8 *
+format_buffer_metadata (u8 * s, va_list * args)
+{
+ vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
+
+ s = format (s, "flags: %U\n", format_vnet_buffer_flags, b);
+ s = format (s, "current_data: %d, current_length: %d\n",
+ (i32) (b->current_data), (i32) (b->current_length));
+ s = format (s, "current_config_index: %d, flow_id: %x, next_buffer: %x\n",
+ b->current_config_index, b->flow_id, b->next_buffer);
+ s = format (s, "error: %d, n_add_refs: %d, buffer_pool_index: %d\n",
+ (u32) (b->error), (u32) (b->n_add_refs),
+ (u32) (b->buffer_pool_index));
+ s = format (s,
+ "trace_index: %d, recycle_count: %d, len_not_first_buf: %d\n",
+ b->trace_index, b->recycle_count,
+ b->total_length_not_including_first_buffer);
+ s = format (s, "free_list_index: %d\n", (u32) (b->free_list_index));
+ return s;
+}
+
+#define A(x) vec_add1(vm->pcap_buffer, (x))
+
static void
dispatch_pcap_trace (vlib_main_t * vm,
vlib_node_runtime_t * node, vlib_frame_t * frame)
{
int i;
vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **bufp, *b;
- u8 name_tlv[64];
pcap_main_t *pm = &vm->dispatch_pcap_main;
vlib_trace_main_t *tm = &vm->trace_main;
u32 capture_size;
vlib_node_t *n;
- u8 *packet_trace = 0;
i32 n_left;
f64 time_now = vlib_time_now (vm);
u32 *from;
- u32 name_length;
- u16 trace_length;
- u8 version[2];
u8 *d;
+ u8 string_count;
/* Input nodes don't have frames yet */
if (frame == 0 || frame->n_vectors == 0)
@@ -973,15 +1017,7 @@ dispatch_pcap_trace (vlib_main_t * vm,
vlib_get_buffers (vm, from, bufs, frame->n_vectors);
bufp = bufs;
- /* Create a node name TLV, since WS can't possibly guess */
n = vlib_get_node (vm, node->node_index);
- name_length = vec_len (n->name);
- name_length = name_length < ARRAY_LEN (name_tlv) - 2 ?
- name_length : ARRAY_LEN (name_tlv) - 2;
-
- name_tlv[0] = (u8) name_length;
- clib_memcpy_fast (name_tlv + 1, n->name, name_length);
- name_tlv[name_length + 1] = 0;
for (i = 0; i < frame->n_vectors; i++)
{
@@ -989,10 +1025,34 @@ dispatch_pcap_trace (vlib_main_t * vm,
{
b = bufp[i];
- version[0] = VLIB_PCAP_MAJOR_VERSION;
- version[1] = VLIB_PCAP_MINOR_VERSION;
-
- vec_reset_length (packet_trace);
+ vec_reset_length (vm->pcap_buffer);
+ string_count = 0;
+
+ /* Version, flags */
+ A ((u8) VLIB_PCAP_MAJOR_VERSION);
+ A ((u8) VLIB_PCAP_MINOR_VERSION);
+ A (0 /* string_count */ );
+ A (n->protocol_hint);
+
+ /* Buffer index (big endian) */
+ A ((from[i] >> 24) & 0xff);
+ A ((from[i] >> 16) & 0xff);
+ A ((from[i] >> 8) & 0xff);
+ A ((from[i] >> 0) & 0xff);
+
+ /* Node name, NULL-terminated ASCII */
+ vm->pcap_buffer = format (vm->pcap_buffer, "%v%c", n->name, 0);
+ string_count++;
+
+ vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
+ format_buffer_metadata, b, 0);
+ string_count++;
+ vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
+ format_vnet_buffer_opaque, b, 0);
+ string_count++;
+ vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
+ format_vnet_buffer_opaque2, b, 0);
+ string_count++;
/* Is this packet traced? */
if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
@@ -1000,55 +1060,29 @@ dispatch_pcap_trace (vlib_main_t * vm,
vlib_trace_header_t **h
= pool_elt_at_index (tm->trace_buffer_pool, b->trace_index);
- packet_trace = format (packet_trace, "%U%c",
- format_vlib_trace, vm, h[0], 0);
+ vm->pcap_buffer = format (vm->pcap_buffer, "%U%c",
+ format_vlib_trace, vm, h[0], 0);
+ string_count++;
}
- /* Figure out how many bytes we're capturing */
- /* *INDENT-OFF* */
- capture_size = (sizeof (vlib_buffer_t) - VLIB_BUFFER_PRE_DATA_SIZE)
- + sizeof (version)
- + vlib_buffer_length_in_chain (vm, b)
- + sizeof (u32) + (name_length + 2) /* +2: count plus NULL byte */
- + (vec_len (packet_trace) + 2); /* +2: trace count */
- /* *INDENT-ON* */
+ /* Save the string count */
+ vm->pcap_buffer[2] = string_count;
+
+ /* Figure out how many bytes in the pcap trace */
+ capture_size = vec_len (vm->pcap_buffer) +
+ +vlib_buffer_length_in_chain (vm, b);
clib_spinlock_lock_if_init (&pm->lock);
n_left = clib_min (capture_size, 16384);
d = pcap_add_packet (pm, time_now, n_left, capture_size);
- /* Copy the (major, minor) version numbers */
- clib_memcpy_fast (d, version, sizeof (version));
- d += sizeof (version);
-
- /* Copy the buffer index */
- clib_memcpy_fast (d, &from[i], sizeof (u32));
- d += 4;
-
- /* Copy the name TLV */
- clib_memcpy_fast (d, name_tlv, name_length + 2);
- d += name_length + 2;
-
- /* Copy the buffer metadata, but not the rewrite space */
- clib_memcpy_fast (d, b, sizeof (*b) - VLIB_BUFFER_PRE_DATA_SIZE);
- d += sizeof (*b) - VLIB_BUFFER_PRE_DATA_SIZE;
-
- trace_length = vec_len (packet_trace);
- /* Copy the trace data length (may be zero) */
- clib_memcpy_fast (d, &trace_length, sizeof (trace_length));
- d += 2;
-
- /* Copy packet trace data (if any) */
- if (vec_len (packet_trace))
- clib_memcpy_fast (d, packet_trace, vec_len (packet_trace));
-
- d += vec_len (packet_trace);
+ /* Copy the header */
+ clib_memcpy_fast (d, vm->pcap_buffer, vec_len (vm->pcap_buffer));
+ d += vec_len (vm->pcap_buffer);
n_left = clib_min
(vlib_buffer_length_in_chain (vm, b),
- 16384 -
- ((sizeof (*b) - VLIB_BUFFER_PRE_DATA_SIZE) +
- (trace_length + 2)));
+ (16384 - vec_len (vm->pcap_buffer)));
/* Copy the packet data */
while (1)
{
@@ -1064,7 +1098,6 @@ dispatch_pcap_trace (vlib_main_t * vm,
clib_spinlock_unlock_if_init (&pm->lock);
}
}
- vec_free (packet_trace);
}
static_always_inline u64
diff --git a/src/vlib/main.h b/src/vlib/main.h
index 9fa294e96f5..474756bebd6 100644
--- a/src/vlib/main.h
+++ b/src/vlib/main.h
@@ -134,6 +134,7 @@ typedef struct vlib_main_t
/* Pcap dispatch trace main */
pcap_main_t dispatch_pcap_main;
uword dispatch_pcap_enable;
+ u8 *pcap_buffer;
/* Error handling. */
vlib_error_main_t error_main;
diff --git a/src/vlib/node.c b/src/vlib/node.c
index 88185ce921f..69f505143b2 100644
--- a/src/vlib/node.c
+++ b/src/vlib/node.c
@@ -350,6 +350,7 @@ register_node (vlib_main_t * vm, vlib_node_registration_t * r)
clib_memset (n, 0, sizeof (n[0]));
n->index = vec_len (nm->nodes);
n->node_fn_registrations = r->node_fn_registrations;
+ n->protocol_hint = r->protocol_hint;
vec_add1 (nm->nodes, n);
diff --git a/src/vlib/node.h b/src/vlib/node.h
index fb2a83bc400..f41eb60aa2c 100644
--- a/src/vlib/node.h
+++ b/src/vlib/node.h
@@ -57,6 +57,17 @@ typedef uword (vlib_node_function_t) (struct vlib_main_t * vm,
typedef enum
{
+ VLIB_NODE_PROTO_HINT_NONE = 0,
+ VLIB_NODE_PROTO_HINT_ETHERNET,
+ VLIB_NODE_PROTO_HINT_IP4,
+ VLIB_NODE_PROTO_HINT_IP6,
+ VLIB_NODE_PROTO_HINT_TCP,
+ VLIB_NODE_PROTO_HINT_UDP,
+ VLIB_NODE_N_PROTO_HINTS,
+} vlib_node_proto_hint_t;
+
+typedef enum
+{
/* An internal node on the call graph (could be output). */
VLIB_NODE_TYPE_INTERNAL,
@@ -134,6 +145,9 @@ typedef struct _vlib_node_registration
/* Node flags. */
u16 flags;
+ /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
+ u8 protocol_hint;
+
/* Size of scalar and vector arguments in bytes. */
u16 scalar_size, vector_size;
@@ -320,6 +334,9 @@ typedef struct vlib_node_t
/* Number of bytes of run time data. */
u8 runtime_data_bytes;
+ /* protocol at b->data[b->current_data] upon entry to the dispatch fn */
+ u8 protocol_hint;
+
/* Number of error codes used by this node. */
u16 n_errors;