api: 'api trace' CLI consumes a line of input

[vpp.git] / src / vlibmemory / vlib_api_cli.c

diff --git a/src/vlibmemory/vlib_api_cli.c b/src/vlibmemory/vlib_api_cli.c
index 3f8e1c9..5a06c65 100755 (executable)
--- a/src/vlibmemory/vlib_api_cli.c
+++ b/src/vlibmemory/vlib_api_cli.c
@@ -430,7 +430,7 @@ vl_msg_api_process_file (vlib_main_t * vm, u8 * filename,
     }
 
   file_size = statb.st_size;
-  file_size = (file_size + 4095) & ~(4096);
+  file_size = (file_size + 4095) & ~(4095);
 
   hp = mmap (0, file_size, PROT_READ, MAP_PRIVATE, fd, 0);
 
@@ -442,6 +442,8 @@ vl_msg_api_process_file (vlib_main_t * vm, u8 * filename,
     }
   close (fd);
 
+  CLIB_MEM_UNPOISON (hp, file_size);
+
   nitems = ntohl (hp->nitems);
 
   if (last_index == (u32) ~ 0)
@@ -465,6 +467,7 @@ vl_msg_api_process_file (vlib_main_t * vm, u8 * filename,
       saved_print_handlers = (void **) vec_dup (am->msg_print_handlers);
       vl_msg_api_custom_dump_configure (am);
     }
+
   msg = (u8 *) (hp + 1);
 
   u16 *msgid_vec = 0;
@@ -663,10 +666,21 @@ vl_msg_api_process_file (vlib_main_t * vm, u8 * filename,
   am->replay_in_progress = 0;
 }
 
+/** api_trace_command_fn - control the binary API trace / replay feature
+
+    Note: this command MUST be marked thread-safe. Replay with
+    multiple worker threads depends in many cases on worker thread
+    graph replica maintenance. If we (implicitly) assert a worker
+    thread barrier at the debug CLI level, all graph replica changes
+    are deferred until the replay operation completes. If an interface
+    is deleted, the wheels fall off.
+ */
+
 static clib_error_t *
 api_trace_command_fn (vlib_main_t * vm,
                      unformat_input_t * input, vlib_cli_command_t * cmd)
 {
+  unformat_input_t _line_input, *line_input = &_line_input;
   u32 nitems = 256 << 10;
   api_main_t *am = vlibapi_get_main ();
   vl_api_trace_which_t which = VL_API_TRACE_RX;
@@ -677,20 +691,28 @@ api_trace_command_fn (vlib_main_t * vm,
   FILE *fp;
   int rv;
 
-  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
+  /* Get a line of input. */
+  if (!unformat_user (input, unformat_line_input, line_input))
+    return 0;
+
+  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
     {
-      if (unformat (input, "on") || unformat (input, "enable"))
+      if (unformat (line_input, "on") || unformat (line_input, "enable"))
        {
-         if (unformat (input, "nitems %d", &nitems))
+         if (unformat (line_input, "nitems %d", &nitems))
            ;
+         vlib_worker_thread_barrier_sync (vm);
          vl_msg_api_trace_configure (am, which, nitems);
          vl_msg_api_trace_onoff (am, which, 1 /* on */ );
+         vlib_worker_thread_barrier_release (vm);
        }
-      else if (unformat (input, "off"))
+      else if (unformat (line_input, "off"))
        {
+         vlib_worker_thread_barrier_sync (vm);
          vl_msg_api_trace_onoff (am, which, 0);
+         vlib_worker_thread_barrier_release (vm);
        }
-      else if (unformat (input, "save %s", &filename))
+      else if (unformat (line_input, "save %s", &filename))
        {
          if (strstr ((char *) filename, "..")
              || index ((char *) filename, '/'))
@@ -710,7 +732,9 @@ api_trace_command_fn (vlib_main_t * vm,
              vlib_cli_output (vm, "Couldn't create %s\n", chroot_filename);
              goto out;
            }
+         vlib_worker_thread_barrier_sync (vm);
          rv = vl_msg_api_trace_save (am, which, fp);
+         vlib_worker_thread_barrier_release (vm);
          fclose (fp);
          if (rv == -1)
            vlib_cli_output (vm, "API Trace data not present\n");
@@ -732,47 +756,49 @@ api_trace_command_fn (vlib_main_t * vm,
            vlib_cli_output (vm, "API trace saved to %s\n", chroot_filename);
          goto out;
        }
-      else if (unformat (input, "dump %s", &filename))
+      else if (unformat (line_input, "dump %s", &filename))
        {
          vl_msg_api_process_file (vm, filename, first, last, DUMP);
        }
-      else if (unformat (input, "custom-dump %s", &filename))
+      else if (unformat (line_input, "custom-dump %s", &filename))
        {
          vl_msg_api_process_file (vm, filename, first, last, CUSTOM_DUMP);
        }
-      else if (unformat (input, "replay %s", &filename))
+      else if (unformat (line_input, "replay %s", &filename))
        {
          vl_msg_api_process_file (vm, filename, first, last, REPLAY);
        }
-      else if (unformat (input, "initializers %s", &filename))
+      else if (unformat (line_input, "initializers %s", &filename))
        {
          vl_msg_api_process_file (vm, filename, first, last, INITIALIZERS);
        }
-      else if (unformat (input, "tx"))
+      else if (unformat (line_input, "tx"))
        {
          which = VL_API_TRACE_TX;
        }
-      else if (unformat (input, "first %d", &first))
+      else if (unformat (line_input, "first %d", &first))
        {
          ;
        }
-      else if (unformat (input, "last %d", &last))
+      else if (unformat (line_input, "last %d", &last))
        {
          ;
        }
-      else if (unformat (input, "status"))
+      else if (unformat (line_input, "status"))
        {
          vlib_cli_output (vm, "%U", format_vl_msg_api_trace_status,
                           am, which);
        }
-      else if (unformat (input, "free"))
+      else if (unformat (line_input, "free"))
        {
+         vlib_worker_thread_barrier_sync (vm);
          vl_msg_api_trace_onoff (am, which, 0);
          vl_msg_api_trace_free (am, which);
+         vlib_worker_thread_barrier_release (vm);
        }
-      else if (unformat (input, "post-mortem-on"))
+      else if (unformat (line_input, "post-mortem-on"))
        vl_msg_api_post_mortem_dump_enable_disable (1 /* enable */ );
-      else if (unformat (input, "post-mortem-off"))
+      else if (unformat (line_input, "post-mortem-off"))
        vl_msg_api_post_mortem_dump_enable_disable (0 /* enable */ );
       else
        return clib_error_return (0, "unknown input `%U'",
@@ -781,6 +807,7 @@ api_trace_command_fn (vlib_main_t * vm,
 out:
   vec_free (filename);
   vec_free (chroot_filename);
+  unformat_free (line_input);
   return 0;
 }
 
@@ -793,8 +820,9 @@ VLIB_CLI_COMMAND (api_trace_command, static) =
 {
   .path = "api trace",
   .short_help = "api trace [on|off][first <n>][last <n>][status][free]"
-      "[post-mortem-on][dump|custom-dump|save|replay <file>]",
+                "[post-mortem-on][dump|custom-dump|save|replay <file>]",
   .function = api_trace_command_fn,
+  .is_mp_safe = 1,
 };
 /* *INDENT-ON* */