lttng/commands/enable_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
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; only version 2
   7  * of the License.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  17  */
  18
  19 #define _GNU_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 <inttypes.h>
  28 #include <ctype.h>
  29
  30 #include "../cmd.h"
  31 #include "../conf.h"
  32 #include "../utils.h"
  33
  34 static char *opt_event_list;
  35 static int opt_event_type;
  36 static int opt_kernel;
  37 static char *opt_session_name;
  38 static int opt_userspace;
  39 static char *opt_cmd_name;
  40 static int opt_enable_all;
  41 static pid_t opt_pid;
  42 static char *opt_probe;
  43 static char *opt_function;
  44 static char *opt_function_entry_symbol;
  45 static char *opt_channel_name;
  46
  47 enum {
  48         OPT_HELP = 1,
  49         OPT_TRACEPOINT,
  50         OPT_PROBE,
  51         OPT_FUNCTION,
  52         OPT_FUNCTION_ENTRY,
  53         OPT_SYSCALL,
  54         OPT_USERSPACE,
  55         OPT_TRACEPOINT_LOGLEVEL,
  56 };
  57
  58 static struct lttng_handle *handle;
  59
  60 static struct poptOption long_options[] = {
  61         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  62         {"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
  63         {"session",        's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
  64         {"all",            'a', POPT_ARG_VAL, &opt_enable_all, 1, 0, 0},
  65         {"channel",        'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
  66         {"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
  67         {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
  68         {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
  69         {"tracepoint",     0,   POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
  70         {"probe",          0,   POPT_ARG_STRING, &opt_probe, OPT_PROBE, 0, 0},
  71         {"function",       0,   POPT_ARG_STRING, &opt_function, OPT_FUNCTION, 0, 0},
  72 #if 0
  73         /*
  74          * Currently removed from lttng kernel tracer. Removed from
  75          * lttng UI to discourage its use.
  76          */
  77         {"function:entry", 0,   POPT_ARG_STRING, &opt_function_entry_symbol, OPT_FUNCTION_ENTRY, 0, 0},
  78 #endif
  79         {"syscall",        0,   POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
  80         {"loglevel",     0,     POPT_ARG_NONE, 0, OPT_TRACEPOINT_LOGLEVEL, 0, 0},
  81         {0, 0, 0, 0, 0, 0, 0}
  82 };
  83
  84 /*
  85  * usage
  86  */
  87 static void usage(FILE *ofp)
  88 {
  89         fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\n");
  90         fprintf(ofp, "\n");
  91         fprintf(ofp, "  -h, --help               Show this help\n");
  92         fprintf(ofp, "  -s, --session            Apply on session name\n");
  93         fprintf(ofp, "  -c, --channel            Apply on this channel\n");
  94         fprintf(ofp, "  -a, --all                Enable all tracepoints\n");
  95         fprintf(ofp, "  -k, --kernel             Apply for the kernel tracer\n");
  96         fprintf(ofp, "  -u, --userspace [CMD]    Apply for the user-space tracer\n");
  97         fprintf(ofp, "                           If no CMD, the domain used is UST global\n");
  98         fprintf(ofp, "                           or else the domain is UST EXEC_NAME\n");
  99         fprintf(ofp, "  -p, --pid PID            If -u, apply to specific PID (domain: UST PID)\n");
 100         fprintf(ofp, "\n");
 101         fprintf(ofp, "Event options:\n");
 102         fprintf(ofp, "    --tracepoint           Tracepoint event (default)\n");
 103         fprintf(ofp, "                           - userspace tracer supports wildcards at end of string.\n");
 104         fprintf(ofp, "                             Don't forget to quote to deal with bash expansion.\n");
 105         fprintf(ofp, "                             e.g.:\n");
 106         fprintf(ofp, "                               \"*\"\n");
 107         fprintf(ofp, "                               \"app_component:na*\"\n");
 108         fprintf(ofp, "    --loglevel             Tracepoint loglevel\n");
 109         fprintf(ofp, "    --probe [addr | symbol | symbol+offset]\n");
 110         fprintf(ofp, "                           Dynamic probe.\n");
 111         fprintf(ofp, "                           Addr and offset can be octal (0NNN...),\n");
 112         fprintf(ofp, "                           decimal (NNN...) or hexadecimal (0xNNN...)\n");
 113         fprintf(ofp, "    --function [addr | symbol | symbol+offset]\n");
 114         fprintf(ofp, "                           Dynamic function entry/return probe.\n");
 115         fprintf(ofp, "                           Addr and offset can be octal (0NNN...),\n");
 116         fprintf(ofp, "                           decimal (NNN...) or hexadecimal (0xNNN...)\n");
 117 #if 0
 118         fprintf(ofp, "    --function:entry symbol\n");
 119         fprintf(ofp, "                           Function tracer event\n");
 120 #endif
 121         fprintf(ofp, "    --syscall              System call event\n");
 122         fprintf(ofp, "\n");
 123 }
 124
 125 /*
 126  * Parse probe options.
 127  */
 128 static int parse_probe_opts(struct lttng_event *ev, char *opt)
 129 {
 130         int ret;
 131         char s_hex[19];
 132         char name[LTTNG_SYMBOL_NAME_LEN];
 133
 134         if (opt == NULL) {
 135                 ret = -1;
 136                 goto end;
 137         }
 138
 139         /* Check for symbol+offset */
 140         ret = sscanf(opt, "%[^'+']+%s", name, s_hex);
 141         if (ret == 2) {
 142                 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
 143                 ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
 144                 DBG("probe symbol %s", ev->attr.probe.symbol_name);
 145                 if (strlen(s_hex) == 0) {
 146                         ERR("Invalid probe offset %s", s_hex);
 147                         ret = -1;
 148                         goto end;
 149                 }
 150                 ev->attr.probe.offset = strtoul(s_hex, NULL, 0);
 151                 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
 152                 ev->attr.probe.addr = 0;
 153                 goto end;
 154         }
 155
 156         /* Check for symbol */
 157         if (isalpha(name[0])) {
 158                 ret = sscanf(opt, "%s", name);
 159                 if (ret == 1) {
 160                         strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
 161                         ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
 162                         DBG("probe symbol %s", ev->attr.probe.symbol_name);
 163                         ev->attr.probe.offset = 0;
 164                         DBG("probe offset %" PRIu64, ev->attr.probe.offset);
 165                         ev->attr.probe.addr = 0;
 166                         goto end;
 167                 }
 168         }
 169
 170         /* Check for address */
 171         ret = sscanf(opt, "%s", s_hex);
 172         if (ret > 0) {
 173                 if (strlen(s_hex) == 0) {
 174                         ERR("Invalid probe address %s", s_hex);
 175                         ret = -1;
 176                         goto end;
 177                 }
 178                 ev->attr.probe.addr = strtoul(s_hex, NULL, 0);
 179                 DBG("probe addr %" PRIu64, ev->attr.probe.addr);
 180                 ev->attr.probe.offset = 0;
 181                 memset(ev->attr.probe.symbol_name, 0, LTTNG_SYMBOL_NAME_LEN);
 182                 goto end;
 183         }
 184
 185         /* No match */
 186         ret = -1;
 187
 188 end:
 189         return ret;
 190 }
 191
 192 /*
 193  * Enabling event using the lttng API.
 194  */
 195 static int enable_events(char *session_name)
 196 {
 197         int err, ret = CMD_SUCCESS;
 198         char *event_name, *channel_name = NULL;
 199         struct lttng_event ev;
 200         struct lttng_domain dom;
 201
 202         if (opt_channel_name == NULL) {
 203                 err = asprintf(&channel_name, DEFAULT_CHANNEL_NAME);
 204                 if (err < 0) {
 205                         ret = CMD_FATAL;
 206                         goto error;
 207                 }
 208         } else {
 209                 channel_name = opt_channel_name;
 210         }
 211
 212         if (opt_kernel && opt_userspace) {
 213                 ERR("Can't use -k/--kernel and -u/--userspace together");
 214                 ret = CMD_FATAL;
 215                 goto error;
 216         }
 217
 218         /* Create lttng domain */
 219         if (opt_kernel) {
 220                 dom.type = LTTNG_DOMAIN_KERNEL;
 221         } else if (opt_pid != 0) {
 222                 dom.type = LTTNG_DOMAIN_UST_PID;
 223                 dom.attr.pid = opt_pid;
 224                 DBG("PID %d set to lttng handle", opt_pid);
 225         } else if (opt_userspace && opt_cmd_name == NULL) {
 226                 dom.type = LTTNG_DOMAIN_UST;
 227         } else if (opt_userspace && opt_cmd_name != NULL) {
 228                 dom.type = LTTNG_DOMAIN_UST_EXEC_NAME;
 229                 strncpy(dom.attr.exec_name, opt_cmd_name, NAME_MAX);
 230         } else {
 231                 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
 232                 ret = CMD_NOT_IMPLEMENTED;
 233                 goto error;
 234         }
 235
 236         handle = lttng_create_handle(session_name, &dom);
 237         if (handle == NULL) {
 238                 ret = -1;
 239                 goto error;
 240         }
 241
 242         if (opt_enable_all) {
 243                 /* Default setup for enable all */
 244                 ev.name[0] = '\0';
 245                 ev.type = opt_event_type;
 246
 247                 ret = lttng_enable_event(handle, &ev, channel_name);
 248                 if (ret < 0) {
 249                         goto error;
 250                 }
 251
 252                 switch (opt_event_type) {
 253                 case LTTNG_EVENT_TRACEPOINT:
 254                         MSG("All %s tracepoints are enabled in channel %s",
 255                                 opt_kernel ? "kernel" : "UST", channel_name);
 256                         break;
 257                 case LTTNG_EVENT_SYSCALL:
 258                         if (opt_kernel) {
 259                                 MSG("All kernel system calls are enabled in channel %s",
 260                                                 channel_name);
 261                         }
 262                         break;
 263                 case LTTNG_EVENT_ALL:
 264                         MSG("All %s events are enabled in channel %s",
 265                                 opt_kernel ? "kernel" : "UST", channel_name);
 266                         break;
 267                 default:
 268                         /*
 269                          * We should not be here since lttng_enable_event should have
 270                          * failed on the event type.
 271                          */
 272                         goto error;
 273                 }
 274                 goto end;
 275         }
 276
 277         /* Strip event list */
 278         event_name = strtok(opt_event_list, ",");
 279         while (event_name != NULL) {
 280                 /* Copy name and type of the event */
 281                 strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
 282                 ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
 283                 ev.type = opt_event_type;
 284
 285                 /* Kernel tracer action */
 286                 if (opt_kernel) {
 287                         DBG("Enabling kernel event %s for channel %s",
 288                                         event_name, channel_name);
 289
 290                         switch (opt_event_type) {
 291                         case LTTNG_EVENT_ALL:   /* Default behavior is tracepoint */
 292                                 ev.type = LTTNG_EVENT_TRACEPOINT;
 293                                 /* Fall-through */
 294                         case LTTNG_EVENT_TRACEPOINT:
 295                                 break;
 296                         case LTTNG_EVENT_PROBE:
 297                                 ret = parse_probe_opts(&ev, opt_probe);
 298                                 if (ret < 0) {
 299                                         ERR("Unable to parse probe options");
 300                                         ret = 0;
 301                                         goto error;
 302                                 }
 303                                 break;
 304                         case LTTNG_EVENT_FUNCTION:
 305                                 ret = parse_probe_opts(&ev, opt_function);
 306                                 if (ret < 0) {
 307                                         ERR("Unable to parse function probe options");
 308                                         ret = 0;
 309                                         goto error;
 310                                 }
 311                                 break;
 312                         case LTTNG_EVENT_FUNCTION_ENTRY:
 313                                 strncpy(ev.attr.ftrace.symbol_name, opt_function_entry_symbol,
 314                                                 LTTNG_SYMBOL_NAME_LEN);
 315                                 ev.attr.ftrace.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
 316                                 break;
 317                         case LTTNG_EVENT_SYSCALL:
 318                                 MSG("per-syscall selection not supported yet. Use \"-a\" "
 319                                                 "for all syscalls.");
 320                         default:
 321                                 ret = CMD_NOT_IMPLEMENTED;
 322                                 goto error;
 323                         }
 324                 } else if (opt_userspace) {             /* User-space tracer action */
 325                         if (opt_cmd_name != NULL || opt_pid) {
 326                                 MSG("Only supporting tracing all UST processes (-u) for now.");
 327                                 ret = CMD_NOT_IMPLEMENTED;
 328                                 goto error;
 329                         }
 330
 331                         DBG("Enabling UST event %s for channel %s", event_name,
 332                                         channel_name);
 333
 334                         switch (opt_event_type) {
 335                         case LTTNG_EVENT_ALL:   /* Default behavior is tracepoint */
 336                                 /* Fall-through */
 337                         case LTTNG_EVENT_TRACEPOINT:
 338                                 /* Copy name and type of the event */
 339                                 ev.type = LTTNG_EVENT_TRACEPOINT;
 340                                 strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
 341                                 ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
 342                                 break;
 343                         case LTTNG_EVENT_TRACEPOINT_LOGLEVEL:
 344                                 /* Copy name and type of the event */
 345                                 ev.type = LTTNG_EVENT_TRACEPOINT_LOGLEVEL;
 346                                 strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
 347                                 ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
 348                                 break;
 349                         case LTTNG_EVENT_PROBE:
 350                         case LTTNG_EVENT_FUNCTION:
 351                         case LTTNG_EVENT_FUNCTION_ENTRY:
 352                         case LTTNG_EVENT_SYSCALL:
 353                         default:
 354                                 ret = CMD_NOT_IMPLEMENTED;
 355                                 goto error;
 356                         }
 357                 } else {
 358                         ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
 359                         goto error;
 360                 }
 361
 362                 ret = lttng_enable_event(handle, &ev, channel_name);
 363                 if (ret == 0) {
 364                         MSG("%s event %s created in channel %s",
 365                                         opt_kernel ? "kernel": "UST", event_name, channel_name);
 366                 }
 367
 368                 /* Next event */
 369                 event_name = strtok(NULL, ",");
 370         }
 371
 372 end:
 373 error:
 374         if (opt_channel_name == NULL) {
 375                 free(channel_name);
 376         }
 377         lttng_destroy_handle(handle);
 378
 379         return ret;
 380 }
 381
 382 /*
 383  * Add event to trace session
 384  */
 385 int cmd_enable_events(int argc, const char **argv)
 386 {
 387         int opt, ret;
 388         static poptContext pc;
 389         char *session_name = NULL;
 390
 391         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 392         poptReadDefaultConfig(pc, 0);
 393
 394         /* Default event type */
 395         opt_event_type = LTTNG_EVENT_ALL;
 396
 397         while ((opt = poptGetNextOpt(pc)) != -1) {
 398                 switch (opt) {
 399                 case OPT_HELP:
 400                         usage(stderr);
 401                         ret = CMD_SUCCESS;
 402                         goto end;
 403                 case OPT_TRACEPOINT:
 404                         opt_event_type = LTTNG_EVENT_TRACEPOINT;
 405                         break;
 406                 case OPT_PROBE:
 407                         opt_event_type = LTTNG_EVENT_PROBE;
 408                         break;
 409                 case OPT_FUNCTION:
 410                         opt_event_type = LTTNG_EVENT_FUNCTION;
 411                         break;
 412                 case OPT_FUNCTION_ENTRY:
 413                         opt_event_type = LTTNG_EVENT_FUNCTION_ENTRY;
 414                         break;
 415                 case OPT_SYSCALL:
 416                         opt_event_type = LTTNG_EVENT_SYSCALL;
 417                         break;
 418                 case OPT_USERSPACE:
 419                         opt_userspace = 1;
 420                         break;
 421                 case OPT_TRACEPOINT_LOGLEVEL:
 422                         opt_event_type = LTTNG_EVENT_TRACEPOINT_LOGLEVEL;
 423                         break;
 424                 default:
 425                         usage(stderr);
 426                         ret = CMD_UNDEFINED;
 427                         goto end;
 428                 }
 429         }
 430
 431         opt_event_list = (char*) poptGetArg(pc);
 432         if (opt_event_list == NULL && opt_enable_all == 0) {
 433                 ERR("Missing event name(s).\n");
 434                 usage(stderr);
 435                 ret = CMD_SUCCESS;
 436                 goto end;
 437         }
 438
 439         if (!opt_session_name) {
 440                 session_name = get_session_name();
 441                 if (session_name == NULL) {
 442                         ret = -1;
 443                         goto end;
 444                 }
 445         } else {
 446                 session_name = opt_session_name;
 447         }
 448
 449         ret = enable_events(session_name);
 450
 451 end:
 452         if (opt_session_name == NULL) {
 453                 free(session_name);
 454         }
 455
 456         return ret;
 457 }