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