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