Cleanup: enable_events.c: fix erroneous comment
[lttng-tools.git] / src / bin / lttng / commands / save.c
index e7c3caeefb2e6dce8de041c7bf4e9c73e6888628..924ddcbcd6bef1f2c4faf43524e60c0a31ce8124 100644 (file)
@@ -15,7 +15,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-#define _GNU_SOURCE
+#define _LGPL_SOURCE
 #include <inttypes.h>
 #include <popt.h>
 #include <stdio.h>
 #include <string.h>
 #include <assert.h>
 
+#include <common/mi-lttng.h>
+
 #include "../command.h"
 #include <lttng/save.h>
 
 static char *opt_output_path;
-static int opt_force;
-static int opt_save_all;
+static bool opt_force;
+static bool opt_save_all;
+static struct mi_writer *writer;
+
+#ifdef LTTNG_EMBED_HELP
+static const char help_msg[] =
+#include <lttng-save.1.h>
+;
+#endif
 
 enum {
        OPT_HELP = 1,
        OPT_ALL,
        OPT_FORCE,
+       OPT_LIST_OPTIONS,
 };
 
 static struct poptOption save_opts[] = {
        /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
-       {"help",        'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
-       {"all",         'a', POPT_ARG_NONE, 0, OPT_ALL, 0, 0},
-       {"output-path", 'o', POPT_ARG_STRING, &opt_output_path, 0, 0, 0},
-       {"force",       'f', POPT_ARG_NONE, 0, OPT_FORCE, 0, 0},
+       {"help",        'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL},
+       {"all",         'a', POPT_ARG_NONE, NULL, OPT_ALL, NULL, NULL},
+       {"output-path", 'o', POPT_ARG_STRING, &opt_output_path, 0, NULL, NULL},
+       {"force",       'f', POPT_ARG_NONE, NULL, OPT_FORCE, NULL, NULL},
+       {"list-options",  0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
        {0, 0, 0, 0, 0, 0, 0}
 };
 
+static int mi_partial_session(const char *session_name)
+{
+       int ret;
+       assert(writer);
+       assert(session_name);
+
+       /* Open session element */
+       ret = mi_lttng_writer_open_element(writer, config_element_session);
+       if (ret) {
+               goto end;
+       }
+
+       ret = mi_lttng_writer_write_element_string(writer, config_element_name,
+                       session_name);
+       if (ret) {
+               goto end;
+       }
+
+       /* Closing session element */
+       ret = mi_lttng_writer_close_element(writer);
+end:
+       return ret;
+}
+
 /*
- * usage
+ * Mi print of save command
  */
-static void usage(FILE *ofp)
+static int mi_save_print(const char *session_name)
 {
-       fprintf(ofp, "usage: lttng save [OPTIONS] [SESSION]\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "Options:\n");
-       fprintf(ofp, "  -h, --help           Show this help\n");
-       fprintf(ofp, "  -a, --all            Save all sessions (default)\n");
-       fprintf(ofp, "  -o, --output-path    Output path of the session configuration(s)\n");
-       fprintf(ofp, "  -f, --force          Overwrite existing session configuration(s)\n");
+       int ret;
+       assert(writer);
+
+       if (opt_save_all) {
+               /* We use a wildcard to represent all sessions */
+               session_name = "*";
+       }
+
+       /* Print save element */
+       ret = mi_lttng_writer_open_element(writer, mi_lttng_element_save);
+       if (ret) {
+               goto end;
+       }
+
+       /* Print session element */
+       ret = mi_partial_session(session_name);
+       if (ret) {
+               goto end;
+       }
+
+       /* Path element */
+       if (opt_output_path) {
+               ret = mi_lttng_writer_write_element_string(writer, config_element_path,
+                               opt_output_path);
+               if (ret) {
+                       goto end;
+               }
+       }
+
+       /* Close save element */
+       ret = mi_lttng_writer_close_element(writer);
+end:
+       return ret;
 }
 
 /*
@@ -64,9 +125,9 @@ static void usage(FILE *ofp)
  */
 int cmd_save(int argc, const char **argv)
 {
-       int ret = CMD_SUCCESS;
+       int ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success;
        int opt;
-       const char *session_name = NULL;
+       const char *session_name = NULL, *leftover = NULL;
        poptContext pc;
        struct lttng_save_session_attr *attr;
 
@@ -76,16 +137,18 @@ int cmd_save(int argc, const char **argv)
        while ((opt = poptGetNextOpt(pc)) != -1) {
                switch (opt) {
                case OPT_HELP:
-                       usage(stdout);
+                       SHOW_HELP();
                        goto end;
                case OPT_ALL:
-                       opt_save_all = 1;
+                       opt_save_all = true;
                        break;
                case OPT_FORCE:
-                       opt_force = 1;
+                       opt_force = true;
                        break;
+               case OPT_LIST_OPTIONS:
+                       list_cmd_options(stdout, save_opts);
+                       goto end;
                default:
-                       usage(stderr);
                        ret = CMD_UNDEFINED;
                        goto end;
                }
@@ -93,12 +156,19 @@ int cmd_save(int argc, const char **argv)
 
        if (!opt_save_all) {
                session_name = poptGetArg(pc);
-               if (!session_name) {
-                       ERR("A session name must be provided if the \"all\" option is not used.");
-                       ret = CMD_ERROR;
-                       goto end;
+               if (session_name) {
+                       DBG2("Session name: %s", session_name);
+               } else {
+                       /* default to opt_save_all */
+                       opt_save_all = true;
                }
-               DBG2("Session name: %s", session_name);
+       }
+
+       leftover = poptGetArg(pc);
+       if (leftover) {
+               ERR("Unknown argument: %s", leftover);
+               ret = CMD_ERROR;
+               goto end;
        }
 
        attr = lttng_save_session_attr_create();
@@ -117,22 +187,99 @@ int cmd_save(int argc, const char **argv)
                goto end_destroy;
        }
 
-       if (lttng_save_session_attr_set_output_url(attr,
-               opt_output_path)) {
+       if (lttng_save_session_attr_set_output_url(attr, opt_output_path)) {
                ret = CMD_ERROR;
                goto end_destroy;
        }
 
-       ret = lttng_save_session(attr);
-       if (ret) {
-               if (ret == -LTTNG_ERR_SESS_NOT_FOUND) {
-                       ERR("Session '%s' not found", session_name);
+       /* Mi check */
+       if (lttng_opt_mi) {
+               writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
+               if (!writer) {
+                       ret = -LTTNG_ERR_NOMEM;
+                       goto end_destroy;
+               }
+
+               /* Open command element */
+               ret = mi_lttng_writer_command_open(writer,
+                               mi_lttng_element_command_save);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end_destroy;
+               }
+
+               /* Open output element */
+               ret = mi_lttng_writer_open_element(writer,
+                               mi_lttng_element_command_output);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end_destroy;
+               }
+       }
+
+       command_ret = lttng_save_session(attr);
+       if (command_ret < 0) {
+               ERR("%s", lttng_strerror(command_ret));
+               success = 0;
+       } else {
+               /* Inform the user of what just happened on success. */
+               if (session_name && opt_output_path) {
+                       MSG("Session %s saved successfully in %s.", session_name,
+                                       opt_output_path);
+               } else if (session_name && !opt_output_path) {
+                       MSG("Session %s saved successfully.", session_name);
+               } else if (!session_name && opt_output_path) {
+                       MSG("All sessions have been saved successfully in %s.",
+                                       opt_output_path);
+               } else {
+                       MSG("All sessions have been saved successfully.");
+               }
+               success = 1;
+       }
+
+       /* Mi Printing and closing */
+       if (lttng_opt_mi) {
+               /* Mi print */
+               ret = mi_save_print(session_name);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end_destroy;
+               }
+
+               /* Close  output element */
+               ret = mi_lttng_writer_close_element(writer);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end_destroy;
+               }
+
+               /* Success ? */
+               ret = mi_lttng_writer_write_element_bool(writer,
+                               mi_lttng_element_command_success, success);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end_destroy;
+               }
+
+               /* Command element close */
+               ret = mi_lttng_writer_command_close(writer);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end_destroy;
                }
-               ret = CMD_ERROR;
        }
 end_destroy:
        lttng_save_session_attr_destroy(attr);
 end:
+       /* Mi clean-up */
+       if (writer && mi_lttng_writer_destroy(writer)) {
+               /* Preserve original error code */
+               ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL;
+       }
+
+       /* Overwrite ret if command failed */
+       ret = command_ret ? -command_ret : ret;
+
        poptFreeContext(pc);
        return ret;
 }
This page took 0.026478 seconds and 4 git commands to generate.