src/bin/lttng/commands/regenerate.c

   1 /*
   2  * Copyright (C) 2015 - Julien Desfossez <jdesfossez@efficios.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License, version 2 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #define _LGPL_SOURCE
  19 #include <assert.h>
  20 #include <ctype.h>
  21 #include <popt.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <unistd.h>
  26
  27 #include <common/mi-lttng.h>
  28
  29 #include "../command.h"
  30
  31 static char *opt_session_name;
  32 static char *session_name = NULL;
  33
  34 static int regenerate_metadata(int argc, const char **argv);
  35 static int regenerate_statedump(int argc, const char **argv);
  36
  37 #ifdef LTTNG_EMBED_HELP
  38 static const char help_msg[] =
  39 #include <lttng-regenerate.1.h>
  40 ;
  41 #endif
  42
  43 enum {
  44         OPT_HELP = 1,
  45         OPT_LIST_OPTIONS,
  46         OPT_LIST_COMMANDS,
  47 };
  48
  49 static struct mi_writer *writer;
  50
  51 static struct poptOption long_options[] = {
  52         /* { longName, shortName, argInfo, argPtr, value, descrip, argDesc, } */
  53         { "help",               'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0, },
  54         { "session",            's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
  55         { "list-options",       0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, 0, 0, },
  56         { "list-commands",      0, POPT_ARG_NONE, NULL, OPT_LIST_COMMANDS},
  57         { 0, 0, 0, 0, 0, 0, 0, },
  58 };
  59
  60 static struct cmd_struct actions[] = {
  61         { "metadata", regenerate_metadata },
  62         { "statedump", regenerate_statedump },
  63         { NULL, NULL }  /* Array closure */
  64 };
  65
  66 /*
  67  * Count and return the number of arguments in argv.
  68  */
  69 static int count_arguments(const char **argv)
  70 {
  71         int i = 0;
  72
  73         assert(argv);
  74
  75         while (argv[i] != NULL) {
  76                 i++;
  77         }
  78
  79         return i;
  80 }
  81
  82 static int regenerate_metadata(int argc, const char **argv)
  83 {
  84         int ret;
  85
  86         if (argc > 1) {
  87                 ret = CMD_UNDEFINED;
  88                 goto end;
  89         }
  90         ret = lttng_regenerate_metadata(session_name);
  91         if (ret == 0) {
  92                 MSG("Metadata successfully regenerated for session %s", session_name);
  93         } else {
  94                 ERR("%s", lttng_strerror(ret));
  95         }
  96
  97 end:
  98         return ret;
  99 }
 100
 101 static int regenerate_statedump(int argc, const char **argv)
 102 {
 103         int ret;
 104
 105         if (argc > 1) {
 106                 ret = -LTTNG_ERR_INVALID;
 107                 goto end;
 108         }
 109         ret = lttng_regenerate_statedump(session_name);
 110         if (ret == 0) {
 111                 MSG("State dump successfully regenerated for session %s", session_name);
 112         }
 113
 114 end:
 115         return ret;
 116 }
 117
 118 static int handle_command(const char **argv)
 119 {
 120         struct cmd_struct *cmd;
 121         int ret = CMD_SUCCESS, i = 0, argc, command_ret = CMD_SUCCESS;
 122
 123         if (argv == NULL) {
 124                 ERR("No object specified for regenerate command.");
 125                 command_ret = CMD_ERROR;
 126                 goto end;
 127         }
 128
 129         argc = count_arguments(argv);
 130         assert(argc >= 1);
 131
 132         cmd = &actions[i];
 133         while (cmd->func != NULL) {
 134                 /* Find command */
 135                 if (strcmp(argv[0], cmd->name) == 0) {
 136                         if (lttng_opt_mi) {
 137                                 /* Action element */
 138                                 ret = mi_lttng_writer_open_element(writer,
 139                                                 mi_lttng_element_command_regenerate_action);
 140                                 if (ret) {
 141                                         ret = CMD_ERROR;
 142                                         goto end;
 143                                 }
 144
 145                                 /* Name of the action */
 146                                 ret = mi_lttng_writer_write_element_string(writer,
 147                                                 config_element_name, argv[0]);
 148                                 if (ret) {
 149                                         ret = CMD_ERROR;
 150                                         goto end;
 151                                 }
 152                         }
 153                         command_ret = cmd->func(argc, argv);
 154                         if (lttng_opt_mi) {
 155                                 /* Close output and action element */
 156                                 ret = mi_lttng_writer_close_element(writer);
 157                                 if (ret) {
 158                                         ret = CMD_ERROR;
 159                                         goto end;
 160                                 }
 161                         }
 162                         goto end;
 163                 }
 164
 165                 cmd = &actions[i++];
 166         }
 167
 168         ret = CMD_UNDEFINED;
 169
 170 end:
 171         /* Overwrite ret if an error occurred in cmd->func() */
 172         ret = command_ret ? command_ret : ret;
 173         return ret;
 174 }
 175
 176 /*
 177  * regenerate command handling.
 178  */
 179 int cmd_regenerate(int argc, const char **argv)
 180 {
 181         int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1;
 182         static poptContext pc;
 183
 184         if (argc < 1) {
 185                 SHOW_HELP();
 186                 ret = CMD_ERROR;
 187                 goto end;
 188         }
 189
 190         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 191         poptReadDefaultConfig(pc, 0);
 192
 193         if (lttng_opt_mi) {
 194                 writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
 195                 if (!writer) {
 196                         ret = -LTTNG_ERR_NOMEM;
 197                         goto end;
 198                 }
 199                 /* Open command element */
 200                 ret = mi_lttng_writer_command_open(writer,
 201                                 mi_lttng_element_command_regenerate);
 202                 if (ret) {
 203                         ret = CMD_ERROR;
 204                         goto end;
 205                 }
 206
 207                 /* Open output element */
 208                 ret = mi_lttng_writer_open_element(writer,
 209                                 mi_lttng_element_command_output);
 210                 if (ret) {
 211                         ret = CMD_ERROR;
 212                         goto end;
 213                 }
 214         }
 215
 216         while ((opt = poptGetNextOpt(pc)) != -1) {
 217                 switch (opt) {
 218                 case OPT_HELP:
 219                         SHOW_HELP();
 220                         goto end;
 221                 case OPT_LIST_OPTIONS:
 222                         list_cmd_options(stdout, long_options);
 223                         goto end;
 224                 case OPT_LIST_COMMANDS:
 225                         list_commands(actions, stdout);
 226                         goto end;
 227                 default:
 228                         SHOW_HELP();
 229                         ret = CMD_UNDEFINED;
 230                         goto end;
 231                 }
 232         }
 233
 234         if (!opt_session_name) {
 235                 session_name = get_session_name();
 236                 if (session_name == NULL) {
 237                         ret = CMD_ERROR;
 238                         goto end;
 239                 }
 240         } else {
 241                 session_name = opt_session_name;
 242         }
 243
 244         command_ret = handle_command(poptGetArgs(pc));
 245         if (command_ret) {
 246                 success = 0;
 247         }
 248
 249         if (lttng_opt_mi) {
 250                 /* Close output element */
 251                 ret = mi_lttng_writer_close_element(writer);
 252                 if (ret) {
 253                         ret = CMD_ERROR;
 254                         goto end;
 255                 }
 256
 257                 /* Success ? */
 258                 ret = mi_lttng_writer_write_element_bool(writer,
 259                                 mi_lttng_element_command_success, success);
 260                 if (ret) {
 261                         ret = CMD_ERROR;
 262                         goto end;
 263                 }
 264
 265                 /* Command element close */
 266                 ret = mi_lttng_writer_command_close(writer);
 267                 if (ret) {
 268                         ret = CMD_ERROR;
 269                         goto end;
 270                 }
 271         }
 272
 273 end:
 274         /* Mi clean-up */
 275         if (writer && mi_lttng_writer_destroy(writer)) {
 276                 /* Preserve original error code */
 277                 ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL;
 278         }
 279
 280         if (!opt_session_name) {
 281                 free(session_name);
 282         }
 283
 284         /* Overwrite ret if an error occurred during handle_command() */
 285         ret = command_ret ? command_ret : ret;
 286
 287         poptFreeContext(pc);
 288         return ret;
 289 }