src/bin/lttng/commands/disable_events.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 _GNU_SOURCE
  19 #define _LGPL_SOURCE
  20 #include <popt.h>
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <sys/stat.h>
  25 #include <sys/types.h>
  26 #include <unistd.h>
  27 #include <assert.h>
  28
  29 #include <common/mi-lttng.h>
  30
  31 #include "../command.h"
  32
  33 static char *opt_event_list;
  34 static int opt_kernel;
  35 static char *opt_channel_name;
  36 static char *opt_session_name;
  37 static int opt_userspace;
  38 static int opt_disable_all;
  39 static int opt_jul;
  40 static int opt_log4j;
  41 static int opt_python;
  42 static int opt_event_type;
  43 #if 0
  44 /* Not implemented yet */
  45 static char *opt_cmd_name;
  46 static pid_t opt_pid;
  47 #endif
  48
  49 enum {
  50         OPT_HELP = 1,
  51         OPT_USERSPACE,
  52         OPT_SYSCALL,
  53         OPT_LIST_OPTIONS,
  54 };
  55
  56 static struct lttng_handle *handle;
  57 static struct mi_writer *writer;
  58
  59 static struct poptOption long_options[] = {
  60         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  61         {"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
  62         {"session",        's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
  63         {"all-events",     'a', POPT_ARG_VAL, &opt_disable_all, 1, 0, 0},
  64         {"channel",        'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
  65         {"jul",            'j', POPT_ARG_VAL, &opt_jul, 1, 0, 0},
  66         {"log4j",          'l', POPT_ARG_VAL, &opt_log4j, 1, 0, 0},
  67         {"python",         'p', POPT_ARG_VAL, &opt_python, 1, 0, 0},
  68         {"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
  69         {"syscall",        0,   POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
  70 #if 0
  71         /* Not implemented yet */
  72         {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
  73         {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
  74 #else
  75         {"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
  76 #endif
  77         {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
  78         {0, 0, 0, 0, 0, 0, 0}
  79 };
  80
  81 /*
  82  * usage
  83  */
  84 static void usage(FILE *ofp)
  85 {
  86         fprintf(ofp, "usage: lttng disable-event NAME[,NAME2,...] (-k | -u) [OPTIONS]\n");
  87         fprintf(ofp, "\n");
  88         fprintf(ofp, "Options:\n");
  89         fprintf(ofp, "  -h, --help               Show this help\n");
  90         fprintf(ofp, "      --list-options       Simple listing of options\n");
  91         fprintf(ofp, "  -s, --session NAME       Apply to session name\n");
  92         fprintf(ofp, "  -c, --channel NAME       Apply to this channel\n");
  93         fprintf(ofp, "  -a, --all-events         Disable all tracepoints\n");
  94         fprintf(ofp, "  -k, --kernel             Apply for the kernel tracer\n");
  95         fprintf(ofp, "  -u, --userspace          Apply to the user-space tracer\n");
  96         fprintf(ofp, "  -j, --jul                Apply for Java application using JUL\n");
  97         fprintf(ofp, "  -l, --log4j              Apply to Java application using LOG4j\n");
  98         fprintf(ofp, "  -p, --python             Apply to Python application using logging\n");
  99         fprintf(ofp, "\n");
 100         fprintf(ofp, "Event options:\n");
 101         fprintf(ofp, "      --syscall            System call event\n");
 102         fprintf(ofp, "\n");
 103 }
 104
 105 static
 106 const char *print_channel_name(const char *name)
 107 {
 108         return name ? : DEFAULT_CHANNEL_NAME;
 109 }
 110
 111 static
 112 const char *print_raw_channel_name(const char *name)
 113 {
 114         return name ? : "<default>";
 115 }
 116
 117 /* Mi print a partial event.
 118  * enabled is 0 or 1
 119  * success is 0 or 1
 120  */
 121 static int mi_print_event(char *event_name, int enabled, int success)
 122 {
 123         int ret;
 124
 125         assert(writer);
 126         assert(event_name);
 127
 128         /* Open event element */
 129         ret = mi_lttng_writer_open_element(writer, config_element_event);
 130         if (ret) {
 131                 goto end;
 132         }
 133
 134         /* Print the name of event */
 135         ret = mi_lttng_writer_write_element_string(writer,
 136                         config_element_name, event_name);
 137         if (ret) {
 138                 goto end;
 139         }
 140
 141         /* Print enabled ? */
 142         ret = mi_lttng_writer_write_element_bool(writer,
 143                         config_element_enabled, enabled);
 144         if (ret) {
 145                 goto end;
 146         }
 147
 148         /* Success ? */
 149         ret = mi_lttng_writer_write_element_bool(writer,
 150                         mi_lttng_element_command_success, success);
 151         if (ret) {
 152                 goto end;
 153         }
 154
 155         /* Close event element */
 156         ret = mi_lttng_writer_close_element(writer);
 157 end:
 158         return ret;
 159 }
 160
 161 /*
 162  *  disable_events
 163  *
 164  *  Disabling event using the lttng API.
 165  */
 166 static int disable_events(char *session_name)
 167 {
 168         int ret = CMD_SUCCESS, warn = 0, command_ret = CMD_SUCCESS;
 169         int enabled = 1, success = 1;
 170         char *event_name, *channel_name = NULL;
 171         struct lttng_domain dom;
 172         struct lttng_event event;
 173
 174         memset(&dom, 0, sizeof(dom));
 175
 176         /* Create lttng domain */
 177         if (opt_kernel) {
 178                 dom.type = LTTNG_DOMAIN_KERNEL;
 179         } else if (opt_userspace) {
 180                 dom.type = LTTNG_DOMAIN_UST;
 181         } else if (opt_jul) {
 182                 dom.type = LTTNG_DOMAIN_JUL;
 183         } else if (opt_log4j) {
 184                 dom.type = LTTNG_DOMAIN_LOG4J;
 185         } else if (opt_python) {
 186                 dom.type = LTTNG_DOMAIN_PYTHON;
 187         } else {
 188                 /* Checked by the caller. */
 189                 assert(0);
 190         }
 191
 192         channel_name = opt_channel_name;
 193
 194         handle = lttng_create_handle(session_name, &dom);
 195         if (handle == NULL) {
 196                 ret = -1;
 197                 goto error;
 198         }
 199
 200         /* Mi print the channel and open the events element */
 201         if (lttng_opt_mi) {
 202                 ret = mi_lttng_writer_open_element(writer, config_element_channel);
 203                 if (ret) {
 204                         ret = CMD_ERROR;
 205                         goto end;
 206                 }
 207
 208                 ret = mi_lttng_writer_write_element_string(writer,
 209                                 config_element_name, print_channel_name(channel_name));
 210                 if (ret) {
 211                         ret = CMD_ERROR;
 212                         goto end;
 213                 }
 214
 215                 /* Open events element */
 216                 ret = mi_lttng_writer_open_element(writer, config_element_events);
 217                 if (ret) {
 218                         ret = CMD_ERROR;
 219                         goto end;
 220                 }
 221         }
 222
 223         memset(&event, 0, sizeof(event));
 224         /* Set default loglevel to any/unknown */
 225         event.loglevel = -1;
 226
 227         switch (opt_event_type) {
 228         case LTTNG_EVENT_SYSCALL:
 229                 event.type = LTTNG_EVENT_SYSCALL;
 230                 break;
 231         default:
 232                 event.type = LTTNG_EVENT_ALL;
 233                 break;
 234         }
 235
 236         if (opt_disable_all) {
 237                 command_ret = lttng_disable_event_ext(handle, &event, channel_name, NULL);
 238                 if (command_ret < 0) {
 239                         ERR("%s", lttng_strerror(command_ret));
 240                         enabled = 1;
 241                         success = 0;
 242
 243                 } else {
 244                         enabled = 0;
 245                         success = 1;
 246                         MSG("All %s %s are disabled in channel %s",
 247                                         get_domain_str(dom.type),
 248                                         opt_event_type == LTTNG_EVENT_SYSCALL ? "system calls" : "events",
 249                                         print_channel_name(channel_name));
 250                 }
 251
 252                 if (lttng_opt_mi) {
 253                         ret = mi_print_event("*", enabled, success);
 254                         if (ret) {
 255                                 ret = CMD_ERROR;
 256                                 goto error;
 257                         }
 258                 }
 259         } else {
 260                 /* Strip event list */
 261                 event_name = strtok(opt_event_list, ",");
 262                 while (event_name != NULL) {
 263                         DBG("Disabling event %s", event_name);
 264
 265                         strncpy(event.name, event_name, sizeof(event.name));
 266                         event.name[sizeof(event.name) - 1] = '\0';
 267                         command_ret = lttng_disable_event_ext(handle, &event, channel_name, NULL);
 268                         if (command_ret < 0) {
 269                                 ERR("%s %s: %s (channel %s, session %s)",
 270                                                 opt_event_type == LTTNG_EVENT_SYSCALL ? "System call" : "Event",
 271                                                 event_name,
 272                                                 lttng_strerror(command_ret),
 273                                                 command_ret == -LTTNG_ERR_NEED_CHANNEL_NAME
 274                                                         ? print_raw_channel_name(channel_name)
 275                                                         : print_channel_name(channel_name),
 276                                                 session_name);
 277                                 warn = 1;
 278                                 success = 0;
 279                                 /*
 280                                  * If an error occurred we assume that the event is still
 281                                  * enabled.
 282                                  */
 283                                 enabled = 1;
 284                         } else {
 285                                 MSG("%s %s %s disabled in channel %s for session %s",
 286                                                 get_domain_str(dom.type),
 287                                                 opt_event_type == LTTNG_EVENT_SYSCALL ? "system call" : "event",
 288                                                 event_name,
 289                                                 print_channel_name(channel_name),
 290                                                 session_name);
 291                                 success = 1;
 292                                 enabled = 0;
 293                         }
 294
 295                         if (lttng_opt_mi) {
 296                                 ret = mi_print_event(event_name, enabled, success);
 297                                 if (ret) {
 298                                         ret = CMD_ERROR;
 299                                         goto error;
 300                                 }
 301                         }
 302
 303                         /* Next event */
 304                         event_name = strtok(NULL, ",");
 305                 }
 306         }
 307
 308 end:
 309         if (lttng_opt_mi) {
 310                 /* Close events element and channel element */
 311                 ret = mi_lttng_close_multi_element(writer, 2);
 312                 if (ret) {
 313                         ret = CMD_ERROR;
 314                 }
 315         }
 316 error:
 317         /* if there is already an error preserve it */
 318         if (warn && !ret) {
 319                 ret = CMD_WARNING;
 320         }
 321
 322         /* Overwrite ret if an error occurred */
 323         ret = command_ret ? command_ret : ret;
 324
 325         lttng_destroy_handle(handle);
 326         return ret;
 327 }
 328
 329 /*
 330  *  cmd_disable_events
 331  *
 332  *  Disable event to trace session
 333  */
 334 int cmd_disable_events(int argc, const char **argv)
 335 {
 336         int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1;
 337         static poptContext pc;
 338         char *session_name = NULL;
 339         int event_type = -1;
 340
 341         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 342         poptReadDefaultConfig(pc, 0);
 343
 344         /* Default event type */
 345         opt_event_type = LTTNG_EVENT_ALL;
 346
 347         while ((opt = poptGetNextOpt(pc)) != -1) {
 348                 switch (opt) {
 349                 case OPT_HELP:
 350                         usage(stdout);
 351                         goto end;
 352                 case OPT_USERSPACE:
 353                         opt_userspace = 1;
 354                         break;
 355                 case OPT_SYSCALL:
 356                         opt_event_type = LTTNG_EVENT_SYSCALL;
 357                         break;
 358                 case OPT_LIST_OPTIONS:
 359                         list_cmd_options(stdout, long_options);
 360                         goto end;
 361                 default:
 362                         usage(stderr);
 363                         ret = CMD_UNDEFINED;
 364                         goto end;
 365                 }
 366
 367                 /* Validate event type. Multiple event type are not supported. */
 368                 if (event_type == -1) {
 369                         event_type = opt_event_type;
 370                 } else {
 371                         if (event_type != opt_event_type) {
 372                                 ERR("Multiple event type not supported.");
 373                                 ret = CMD_ERROR;
 374                                 goto end;
 375                         }
 376                 }
 377         }
 378
 379         ret = print_missing_or_multiple_domains(
 380                 opt_kernel + opt_userspace + opt_jul + opt_log4j + opt_python);
 381         if (ret) {
 382                 ret = CMD_ERROR;
 383                 goto end;
 384         }
 385
 386         opt_event_list = (char*) poptGetArg(pc);
 387         if (opt_event_list == NULL && opt_disable_all == 0) {
 388                 ERR("Missing event name(s).\n");
 389                 usage(stderr);
 390                 ret = CMD_ERROR;
 391                 goto end;
 392         }
 393
 394         if (!opt_session_name) {
 395                 session_name = get_session_name();
 396                 if (session_name == NULL) {
 397                         ret = CMD_ERROR;
 398                         goto end;
 399                 }
 400         } else {
 401                 session_name = opt_session_name;
 402         }
 403
 404         /* Mi check */
 405         if (lttng_opt_mi) {
 406                 writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
 407                 if (!writer) {
 408                         ret = -LTTNG_ERR_NOMEM;
 409                         goto end;
 410                 }
 411
 412                 /* Open command element */
 413                 ret = mi_lttng_writer_command_open(writer,
 414                                 mi_lttng_element_command_disable_event);
 415                 if (ret) {
 416                         ret = CMD_ERROR;
 417                         goto end;
 418                 }
 419
 420                 /* Open output element */
 421                 ret = mi_lttng_writer_open_element(writer,
 422                                 mi_lttng_element_command_output);
 423                 if (ret) {
 424                         ret = CMD_ERROR;
 425                         goto end;
 426                 }
 427         }
 428
 429         command_ret = disable_events(session_name);
 430         if (command_ret) {
 431                 success = 0;
 432         }
 433
 434         /* Mi closing */
 435         if (lttng_opt_mi) {
 436                 /* Close  output element */
 437                 ret = mi_lttng_writer_close_element(writer);
 438                 if (ret) {
 439                         ret = CMD_ERROR;
 440                         goto end;
 441                 }
 442
 443                 ret = mi_lttng_writer_write_element_bool(writer,
 444                                 mi_lttng_element_command_success, success);
 445                 if (ret) {
 446                         ret = CMD_ERROR;
 447                         goto end;
 448                 }
 449
 450                 /* Command element close */
 451                 ret = mi_lttng_writer_command_close(writer);
 452                 if (ret) {
 453                         ret = CMD_ERROR;
 454                         goto end;
 455                 }
 456         }
 457
 458 end:
 459         if (!opt_session_name && session_name) {
 460                 free(session_name);
 461         }
 462
 463         /* Mi clean-up */
 464         if (writer && mi_lttng_writer_destroy(writer)) {
 465                 /* Preserve original error code */
 466                 ret = ret ? ret : LTTNG_ERR_MI_IO_FAIL;
 467         }
 468
 469         /* Overwrite ret if an error occured in disable_events */
 470         ret = command_ret ? command_ret : ret;
 471
 472         poptFreeContext(pc);
 473         return ret;
 474 }