feature: Add packet trace API

Also spiffed up the vpp_api_test plugin loader so it executes
VLIB_INIT_FUNCTIONs and VLIB_API_INIT_FUNCTIONs.

Type: feature

Change-Id: Id9a4f455d73738c41bcfea220df2112bb9679681
Signed-off-by: Jon Loeliger <jdl@netgate.com>
Signed-off-by: Ole Troan <ot@cisco.com>
Signed-off-by: Dave Barach <dave@barachs.net>

2 files changed, 90 insertions, 37 deletions

diff --git a/src/vlib/trace.c b/src/vlib/trace.c
index 384885a1a53..abd116622c7 100644
--- a/src/vlib/trace.c
+++ b/src/vlib/trace.c
@@ -122,6 +122,12 @@ clear_trace_buffer (void)
     tm = &this_vlib_main->trace_main;
 
     tm->trace_enable = 0;
+    vec_free (tm->nodes);
+  }));
+
+  foreach_vlib_main (
+  ({
+    tm = &this_vlib_main->trace_main;
 
     for (i = 0; i < vec_len (tm->trace_buffer_pool); i++)
       if (! pool_is_free_index (tm->trace_buffer_pool, i))
@@ -175,8 +181,8 @@ VLIB_CLI_COMMAND (trace_cli_command,static) = {
 };
 /* *INDENT-ON* */
 
-static int
-trace_cmp (void *a1, void *a2)
+int
+trace_time_cmp (void *a1, void *a2)
 {
   vlib_trace_header_t **t1 = a1;
   vlib_trace_header_t **t2 = a2;
@@ -316,7 +322,7 @@ cli_show_trace_buffer (vlib_main_t * vm,
       }
 
     /* Sort them by increasing time. */
-    vec_sort_with_function (traces, trace_cmp);
+    vec_sort_with_function (traces, trace_time_cmp);
 
     for (i = 0; i < vec_len (traces); i++)
       {
@@ -352,20 +358,63 @@ VLIB_CLI_COMMAND (show_trace_cli,static) = {
 /* *INDENT-ON* */
 
 int vlib_enable_disable_pkt_trace_filter (int enable) __attribute__ ((weak));
+
 int
 vlib_enable_disable_pkt_trace_filter (int enable)
 {
   return 0;
 }
 
+void
+vlib_trace_stop_and_clear (void)
+{
+  vlib_enable_disable_pkt_trace_filter (0);	/* disble tracing */
+  clear_trace_buffer ();
+}
+
+
+void
+trace_update_capture_options (u32 add, u32 node_index, u32 filter, u8 verbose)
+{
+  vlib_trace_main_t *tm;
+  vlib_trace_node_t *tn;
+
+  if (add == ~0)
+    add = 50;
+
+  /* *INDENT-OFF* */
+  foreach_vlib_main ((
+    {
+      tm = &this_vlib_main->trace_main;
+      tm->verbose = verbose;
+      vec_validate (tm->nodes, node_index);
+      tn = tm->nodes + node_index;
+
+      /*
+       * Adding 0 makes no real sense, and there wa no other way
+       * to explicilty zero-out the limits and count, so make
+       * an "add 0" request really be "set to 0".
+       */
+      if (add == 0)
+	  tn->limit = tn->count = 0;
+      else
+	  tn->limit += add;
+    }));
+
+  foreach_vlib_main ((
+    {
+      tm = &this_vlib_main->trace_main;
+      tm->trace_enable = 1;
+    }));
+  /* *INDENT-ON* */
+}
+
 static clib_error_t *
 cli_add_trace_buffer (vlib_main_t * vm,
 		      unformat_input_t * input, vlib_cli_command_t * cmd)
 {
   unformat_input_t _line_input, *line_input = &_line_input;
-  vlib_trace_main_t *tm;
   vlib_node_t *node;
-  vlib_trace_node_t *tn;
   u32 node_index, add;
   u8 verbose = 0;
   int filter = 0;
@@ -415,17 +464,7 @@ cli_add_trace_buffer (vlib_main_t * vm,
 	}
     }
 
-  /* *INDENT-OFF* */
-  foreach_vlib_main ((
-    {
-      tm = &this_vlib_main->trace_main;
-      tm->verbose = verbose;
-      vec_validate (tm->nodes, node_index);
-      tn = tm->nodes + node_index;
-      tn->limit += add;
-      tm->trace_enable = 1;
-    }));
-  /* *INDENT-ON* */
+  trace_update_capture_options (add, node_index, filter, verbose);
 
 done:
   unformat_free (line_input);
@@ -436,7 +475,7 @@ done:
 /* *INDENT-OFF* */
 VLIB_CLI_COMMAND (add_trace_cli,static) = {
   .path = "trace add",
-  .short_help = "Trace given number of packets",
+  .short_help = "trace add <input-graph-node> <add'l-pkts-for-node-> [filter] [verbose]",
   .function = cli_add_trace_buffer,
 };
 /* *INDENT-ON* */
@@ -478,11 +517,35 @@ VLIB_CLI_COMMAND (add_trace_cli,static) = {
  * criteria (e.g. input sw_if_index, mac address) but for now just checks if
  * a specified node is in the trace or not in the trace.
  */
+
+void
+trace_filter_set (u32 node_index, u32 flag, u32 count)
+{
+  /* *INDENT-OFF* */
+  foreach_vlib_main (
+  ({
+    vlib_trace_main_t *tm;
+
+    tm = &this_vlib_main->trace_main;
+    tm->filter_node_index = node_index;
+    tm->filter_flag = flag;
+    tm->filter_count = count;
+
+    /*
+     * Clear the trace limits to stop any in-progress tracing
+     * Prevents runaway trace allocations when the filter changes
+     * (or is removed)
+     */
+    vec_free (tm->nodes);
+  }));
+  /* *INDENT-ON* */
+}
+
+
 static clib_error_t *
 cli_filter_trace (vlib_main_t * vm,
 		  unformat_input_t * input, vlib_cli_command_t * cmd)
 {
-  vlib_trace_main_t *tm = &vm->trace_main;
   u32 filter_node_index;
   u32 filter_flag;
   u32 filter_count;
@@ -510,22 +573,7 @@ cli_filter_trace (vlib_main_t * vm,
       ("expected 'include NODE COUNT' or 'exclude NODE COUNT' or 'none', got `%U'",
        format_unformat_error, input);
 
-  /* *INDENT-OFF* */
-  foreach_vlib_main (
-    ({
-    tm = &this_vlib_main->trace_main;
-    tm->filter_node_index = filter_node_index;
-    tm->filter_flag = filter_flag;
-    tm->filter_count = filter_count;
-
-    /*
-     * Clear the trace limits to stop any in-progress tracing
-     * Prevents runaway trace allocations when the filter changes
-     * (or is removed)
-     */
-    vec_free (tm->nodes);
-  }));
-  /* *INDENT-ON* */
+  trace_filter_set (filter_node_index, filter_flag, filter_count);
 
   return 0;
 }
@@ -533,7 +581,7 @@ cli_filter_trace (vlib_main_t * vm,
 /* *INDENT-OFF* */
 VLIB_CLI_COMMAND (filter_trace_cli,static) = {
   .path = "trace filter",
-  .short_help = "filter trace output - include NODE COUNT | exclude NODE COUNT | none",
+  .short_help = "trace filter none | [include|exclude] NODE COUNT",
   .function = cli_filter_trace,
 };
 /* *INDENT-ON* */
@@ -542,8 +590,7 @@ static clib_error_t *
 cli_clear_trace_buffer (vlib_main_t * vm,
 			unformat_input_t * input, vlib_cli_command_t * cmd)
 {
-  vlib_enable_disable_pkt_trace_filter (0 /* enable */ );
-  clear_trace_buffer ();
+  vlib_trace_stop_and_clear ();
   return 0;
 }
 
diff --git a/src/vlib/trace.h b/src/vlib/trace.h
index 233c0ea0b56..54b7c294569 100644
--- a/src/vlib/trace.h
+++ b/src/vlib/trace.h
@@ -113,6 +113,12 @@ typedef struct
 format_function_t format_vlib_trace;
 
 void trace_apply_filter (struct vlib_main_t *vm);
+int trace_time_cmp (void *a1, void *a2);
+void vlib_trace_stop_and_clear (void);
+int vlib_enable_disable_pkt_trace_filter (int enable) __attribute__ ((weak));
+void trace_update_capture_options (u32 add, u32 node_index,
+				   u32 filter, u8 verbose);
+void trace_filter_set (u32 node_index, u32 flag, u32 count);
 
 #endif /* included_vlib_trace_h */