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
  29 #include "../cmd.h"
  30 #include "../conf.h"
  31 #include "../utils.h"
  32
  33 static char *opt_event_list;
  34 static int opt_event_type;
  35 static char *opt_kernel;
  36 static char *opt_cmd_name;
  37 static char *opt_session_name;
  38 static int opt_pid_all;
  39 static int opt_userspace;
  40 static int opt_enable_all;
  41 static pid_t opt_pid;
  42 static char *opt_probe;
  43 static char *opt_function_symbol;
  44 static char *opt_channel_name;
  45
  46 enum {
  47         OPT_HELP = 1,
  48         OPT_USERSPACE,
  49         OPT_TRACEPOINT,
  50         OPT_MARKER,
  51         OPT_PROBE,
  52         OPT_FUNCTION,
  53 };
  54
  55 static struct poptOption long_options[] = {
  56         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  57         {"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
  58         {"session",        's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
  59         {"all-events",     'a', POPT_ARG_VAL, &opt_enable_all, 1, 0, 0},
  60         {"channel",        'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
  61         {"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
  62         {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_USERSPACE, 0, 0},
  63         {"all",            0,   POPT_ARG_VAL, &opt_pid_all, 1, 0, 0},
  64         {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
  65         {"tracepoint",     0,   POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
  66         {"marker",         0,   POPT_ARG_NONE, 0, OPT_MARKER, 0, 0},
  67         {"probe",         0,   POPT_ARG_STRING, 0, OPT_PROBE, 0, 0},
  68         {"function",       0,   POPT_ARG_STRING, 0, OPT_FUNCTION, 0, 0},
  69         {0, 0, 0, 0, 0, 0, 0}
  70 };
  71
  72 /*
  73  * usage
  74  */
  75 static void usage(FILE *ofp)
  76 {
  77         fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\n");
  78         fprintf(ofp, "\n");
  79         fprintf(ofp, "  -h, --help               Show this help\n");
  80         fprintf(ofp, "  -s, --session            Apply on session name\n");
  81         fprintf(ofp, "  -c, --channel            Apply on this channel\n");
  82         fprintf(ofp, "  -a, --all-events         Enable all tracepoints\n");
  83         fprintf(ofp, "  -k, --kernel             Apply for the kernel tracer\n");
  84         fprintf(ofp, "  -u, --userspace [CMD]    Apply for the user-space tracer\n");
  85         fprintf(ofp, "      --all                If -u, apply on all traceable apps\n");
  86         fprintf(ofp, "  -p, --pid PID            If -u, apply on a specific PID\n");
  87         fprintf(ofp, "\n");
  88         fprintf(ofp, "Event options:\n");
  89         fprintf(ofp, "    --tracepoint           Tracepoint event (default)\n");
  90         fprintf(ofp, "    --probe [addr | symbol+offset]\n");
  91         fprintf(ofp, "                           Dynamic probe.\n");
  92         fprintf(ofp, "                           Addr and offset can be octal (0NNN...),\n");
  93         fprintf(ofp, "                           decimal (NNN...) or hexadecimal (0xNNN...)\n");
  94         fprintf(ofp, "    --function SYMBOL      Function tracer event\n");
  95         fprintf(ofp, "    --marker               User-space marker (deprecated)\n");
  96         fprintf(ofp, "\n");
  97 }
  98
  99 /*
 100  *  parse_probe_addr
 101  *
 102  *  Parse probe options.
 103  */
 104 static int parse_probe_opts(struct lttng_event *ev, char *opt)
 105 {
 106         int ret;
 107         uint64_t hex;
 108         char name[LTTNG_SYMBOL_NAME_LEN];
 109
 110         if (opt == NULL) {
 111                 ret = -1;
 112                 goto error;
 113         }
 114
 115         /* Check for symbol+offset */
 116         ret = sscanf(opt, "%[^'+']+%" SCNu64, name, &hex);
 117         if (ret == 2) {
 118                 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
 119                 DBG("probe symbol %s", ev->attr.probe.symbol_name);
 120                 if (hex == 0) {
 121                         ERR("Invalid probe offset %" PRIu64, hex);
 122                         ret = -1;
 123                         goto error;
 124                 }
 125                 ev->attr.probe.offset = hex;
 126                 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
 127                 goto error;
 128         }
 129
 130         /* Check for address */
 131         ret = sscanf(opt, "%" SCNu64, &hex);
 132         if (ret > 0) {
 133                 if (hex == 0) {
 134                         ERR("Invalid probe address %" PRIu64, hex);
 135                         ret = -1;
 136                         goto error;
 137                 }
 138                 ev->attr.probe.addr = hex;
 139                 DBG("probe addr %" PRIu64, ev->attr.probe.addr);
 140                 goto error;
 141         }
 142
 143         /* No match */
 144         ret = -1;
 145
 146 error:
 147         return ret;
 148 }
 149
 150 /*
 151  *  enable_events
 152  *
 153  *  Enabling event using the lttng API.
 154  */
 155 static int enable_events(void)
 156 {
 157         int err, ret = CMD_SUCCESS;
 158         char *event_name, *channel_name = NULL;
 159         struct lttng_event ev;
 160         struct lttng_domain dom;
 161
 162         if (set_session_name(opt_session_name) < 0) {
 163                 ret = CMD_ERROR;
 164                 goto error;
 165         }
 166
 167         if (opt_channel_name == NULL) {
 168                 err = asprintf(&channel_name, DEFAULT_CHANNEL_NAME);
 169                 if (err < 0) {
 170                         ret = CMD_FATAL;
 171                         goto error;
 172                 }
 173         } else {
 174                 channel_name = opt_channel_name;
 175         }
 176
 177         /* Create lttng domain */
 178         if (opt_kernel) {
 179                 dom.type = LTTNG_DOMAIN_KERNEL;
 180         }
 181
 182         if (opt_enable_all) {
 183                 if (opt_kernel) {
 184                         ret = lttng_enable_event(&dom, NULL, channel_name);
 185                         if (ret == 0) {
 186                                 MSG("All kernel events are enabled in channel %s", channel_name);
 187                         }
 188                         goto error;
 189                 }
 190
 191                 /* TODO: User-space tracer */
 192         }
 193
 194         /* Strip event list */
 195         event_name = strtok(opt_event_list, ",");
 196         while (event_name != NULL) {
 197                 /* Kernel tracer action */
 198                 if (opt_kernel) {
 199                         DBG("Enabling kernel event %s for channel %s",
 200                                         event_name, channel_name);
 201                         /* Copy name and type of the event */
 202                         strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
 203                         ev.type = opt_event_type;
 204
 205                         switch (opt_event_type) {
 206                         case LTTNG_EVENT_TRACEPOINT:
 207                                 break;
 208                         case LTTNG_EVENT_PROBE:
 209                                 ret = parse_probe_opts(&ev, opt_probe);
 210                                 if (ret < 0) {
 211                                         ERR("Unable to parse probe options");
 212                                         ret = 0;
 213                                         goto error;
 214                                 }
 215                                 break;
 216                         case LTTNG_EVENT_FUNCTION:
 217                                 strncpy(ev.attr.ftrace.symbol_name, opt_function_symbol, LTTNG_SYMBOL_NAME_LEN);
 218                                 break;
 219                         default:
 220                                 ret = CMD_NOT_IMPLEMENTED;
 221                                 goto error;
 222                         }
 223
 224                         ret = lttng_enable_event(&dom, &ev, channel_name);
 225                         if (ret == 0) {
 226                                 MSG("Kernel event %s created in channel %s", event_name, channel_name);
 227                         } else if (ret < 0) {
 228                                 ERR("Unable to find event %s", ev.name);
 229                         }
 230                 } else if (opt_userspace) {             /* User-space tracer action */
 231                         /*
 232                          * TODO: Waiting on lttng UST 2.0
 233                          */
 234                         if (opt_pid_all) {
 235                         } else if (opt_pid != 0) {
 236                         }
 237                         ret = CMD_NOT_IMPLEMENTED;
 238                         goto error;
 239                 } else {
 240                         ERR("Please specify a tracer (kernel or user-space)");
 241                         goto error;
 242                 }
 243
 244                 /* Next event */
 245                 event_name = strtok(NULL, ",");
 246         }
 247
 248 error:
 249         if (opt_channel_name == NULL) {
 250                 free(channel_name);
 251         }
 252         return ret;
 253 }
 254
 255 /*
 256  *  cmd_enable_events
 257  *
 258  *  Add event to trace session
 259  */
 260 int cmd_enable_events(int argc, const char **argv)
 261 {
 262         int opt, ret;
 263         static poptContext pc;
 264
 265         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 266         poptReadDefaultConfig(pc, 0);
 267
 268         /* Default event type */
 269         opt_event_type = LTTNG_EVENT_TRACEPOINT;
 270
 271         while ((opt = poptGetNextOpt(pc)) != -1) {
 272                 switch (opt) {
 273                 case OPT_HELP:
 274                         usage(stderr);
 275                         ret = CMD_SUCCESS;
 276                         goto end;
 277                 case OPT_USERSPACE:
 278                         opt_userspace = 1;
 279                         opt_cmd_name = poptGetOptArg(pc);
 280                         break;
 281                 case OPT_TRACEPOINT:
 282                         opt_event_type = LTTNG_EVENT_TRACEPOINT;
 283                         break;
 284                 case OPT_MARKER:
 285                         ret = CMD_NOT_IMPLEMENTED;
 286                         goto end;
 287                 case OPT_PROBE:
 288                         opt_event_type = LTTNG_EVENT_PROBE;
 289                         opt_probe = poptGetOptArg(pc);
 290                         break;
 291                 case OPT_FUNCTION:
 292                         opt_event_type = LTTNG_EVENT_FUNCTION;
 293                         opt_function_symbol = poptGetOptArg(pc);
 294                         break;
 295                 default:
 296                         usage(stderr);
 297                         ret = CMD_UNDEFINED;
 298                         goto end;
 299                 }
 300         }
 301
 302         opt_event_list = (char*) poptGetArg(pc);
 303         if (opt_event_list == NULL && opt_enable_all == 0) {
 304                 ERR("Missing event name(s).\n");
 305                 usage(stderr);
 306                 ret = CMD_SUCCESS;
 307                 goto end;
 308         }
 309
 310         ret = enable_events();
 311
 312 end:
 313         return ret;
 314 }