src/bin/lttng/commands/stop.c

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   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 <popt.h>
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <sys/stat.h>
  24 #include <sys/types.h>
  25 #include <unistd.h>
  26 #include <assert.h>
  27
  28 #include <common/sessiond-comm/sessiond-comm.h>
  29 #include <common/mi-lttng.h>
  30
  31 #include "../command.h"
  32
  33 static char *opt_session_name;
  34 static int opt_no_wait;
  35 static struct mi_writer *writer;
  36
  37 enum {
  38         OPT_HELP = 1,
  39         OPT_LIST_OPTIONS,
  40 };
  41
  42 static struct poptOption long_options[] = {
  43         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  44         {"help",      'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
  45         {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
  46         {"no-wait",   'n', POPT_ARG_VAL, &opt_no_wait, 1, 0, 0},
  47         {0, 0, 0, 0, 0, 0, 0}
  48 };
  49
  50 /*
  51  * usage
  52  */
  53 static void usage(FILE *ofp)
  54 {
  55         fprintf(ofp, "usage: lttng stop [NAME] [OPTIONS]\n");
  56         fprintf(ofp, "\n");
  57         fprintf(ofp, "Where NAME is an optional session name. If not specified, lttng will\n");
  58         fprintf(ofp, "get it from the configuration directory (.lttng).\n");
  59         fprintf(ofp, "\n");
  60         fprintf(ofp, "Options:\n");
  61         fprintf(ofp, "  -h, --help               Show this help\n");
  62         fprintf(ofp, "      --list-options       Simple listing of options\n");
  63         fprintf(ofp, "  -n, --no-wait            Don't wait for data availability\n");
  64         fprintf(ofp, "\n");
  65 }
  66 /*
  67  * Mi print of partial session
  68  */
  69 static int mi_print_session(char *session_name, int enabled)
  70 {
  71         int ret;
  72         assert(writer);
  73         assert(session_name);
  74
  75         /* Open session element */
  76         ret = mi_lttng_writer_open_element(writer, config_element_session);
  77         if (ret) {
  78                 goto end;
  79         }
  80
  81         /* Print session name element */
  82         ret = mi_lttng_writer_write_element_string(writer, config_element_name,
  83                         session_name);
  84         if (ret) {
  85                 goto end;
  86         }
  87
  88         /* Is enabled ? */
  89         ret = mi_lttng_writer_write_element_bool(writer, config_element_enabled,
  90                         enabled);
  91         if (ret) {
  92                 goto end;
  93         }
  94
  95         /* Close session element */
  96         ret = mi_lttng_writer_close_element(writer);
  97
  98 end:
  99         return ret;
 100 }
 101
 102 /*
 103  * Start tracing for all trace of the session.
 104  */
 105 static int stop_tracing(void)
 106 {
 107         int ret;
 108         char *session_name;
 109
 110         if (opt_session_name == NULL) {
 111                 session_name = get_session_name();
 112                 if (session_name == NULL) {
 113                         ret = CMD_ERROR;
 114                         goto error;
 115                 }
 116         } else {
 117                 session_name = opt_session_name;
 118         }
 119
 120         ret = lttng_stop_tracing_no_wait(session_name);
 121         if (ret < 0) {
 122                 switch (-ret) {
 123                 case LTTNG_ERR_TRACE_ALREADY_STOPPED:
 124                         WARN("Tracing already stopped for session %s", session_name);
 125                         break;
 126                 default:
 127                         ERR("%s", lttng_strerror(ret));
 128                         break;
 129                 }
 130                 goto free_name;
 131         }
 132
 133         if (!opt_no_wait) {
 134                 _MSG("Waiting for data availability");
 135                 fflush(stdout);
 136                 do {
 137                         ret = lttng_data_pending(session_name);
 138                         if (ret < 0) {
 139                                 /* Return the data available call error. */
 140                                 goto free_name;
 141                         }
 142
 143                         /*
 144                          * Data sleep time before retrying (in usec). Don't sleep if the call
 145                          * returned value indicates availability.
 146                          */
 147                         if (ret) {
 148                                 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME);
 149                                 _MSG(".");
 150                                 fflush(stdout);
 151                         }
 152                 } while (ret != 0);
 153                 MSG("");
 154         }
 155
 156         ret = CMD_SUCCESS;
 157
 158         print_session_stats(session_name);
 159         MSG("Tracing stopped for session %s", session_name);
 160         if (lttng_opt_mi) {
 161                 ret = mi_print_session(session_name, 0);
 162                 if (ret) {
 163                         goto free_name;
 164                 }
 165         }
 166
 167 free_name:
 168         if (opt_session_name == NULL) {
 169                 free(session_name);
 170         }
 171
 172 error:
 173         return ret;
 174 }
 175
 176 /*
 177  *  cmd_stop
 178  *
 179  *  The 'stop <options>' first level command
 180  */
 181 int cmd_stop(int argc, const char **argv)
 182 {
 183         int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1;
 184         static poptContext pc;
 185
 186         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 187         poptReadDefaultConfig(pc, 0);
 188
 189         while ((opt = poptGetNextOpt(pc)) != -1) {
 190                 switch (opt) {
 191                 case OPT_HELP:
 192                         SHOW_HELP();
 193                         goto end;
 194                 case OPT_LIST_OPTIONS:
 195                         list_cmd_options(stdout, long_options);
 196                         goto end;
 197                 default:
 198                         usage(stderr);
 199                         ret = CMD_UNDEFINED;
 200                         goto end;
 201                 }
 202         }
 203
 204         /* Mi check */
 205         if (lttng_opt_mi) {
 206                 writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
 207                 if (!writer) {
 208                         ret = -LTTNG_ERR_NOMEM;
 209                         goto end;
 210                 }
 211
 212                 /* Open command element */
 213                 ret = mi_lttng_writer_command_open(writer,
 214                                 mi_lttng_element_command_stop);
 215                 if (ret) {
 216                         ret = CMD_ERROR;
 217                         goto end;
 218                 }
 219
 220                 /* Open output element */
 221                 ret = mi_lttng_writer_open_element(writer,
 222                                 mi_lttng_element_command_output);
 223                 if (ret) {
 224                         ret = CMD_ERROR;
 225                         goto end;
 226                 }
 227
 228                 /*
 229                  * Open sessions element
 230                  * For validation
 231                  */
 232                 ret = mi_lttng_writer_open_element(writer,
 233                                 config_element_sessions);
 234                 if (ret) {
 235                         ret = CMD_ERROR;
 236                         goto end;
 237                 }
 238         }
 239
 240         opt_session_name = (char*) poptGetArg(pc);
 241
 242         command_ret = stop_tracing();
 243         if (command_ret) {
 244                 success = 0;
 245         }
 246
 247         /* Mi closing */
 248         if (lttng_opt_mi) {
 249                 /* Close sessions and  output element */
 250                 ret = mi_lttng_close_multi_element(writer, 2);
 251                 if (ret) {
 252                         ret = CMD_ERROR;
 253                         goto end;
 254                 }
 255
 256                 /* Success ? */
 257                 ret = mi_lttng_writer_write_element_bool(writer,
 258                                 mi_lttng_element_command_success, success);
 259                 if (ret) {
 260                         ret = CMD_ERROR;
 261                         goto end;
 262                 }
 263
 264                 /* Command element close */
 265                 ret = mi_lttng_writer_command_close(writer);
 266                 if (ret) {
 267                         ret = CMD_ERROR;
 268                         goto end;
 269                 }
 270         }
 271
 272 end:
 273         /* Mi clean-up */
 274         if (writer && mi_lttng_writer_destroy(writer)) {
 275                 /* Preserve original error code */
 276                 ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL;
 277         }
 278
 279         /* Overwrite ret if an error occurred in stop_tracing() */
 280         ret = command_ret ? command_ret : ret;
 281
 282         poptFreeContext(pc);
 283         return ret;
 284 }