tools/perf/util/probe-event.c

   1 /*
   2  * probe-event.c : perf-probe definition to kprobe_events format converter
   3  *
   4  * Written by Masami Hiramatsu <mhiramat@redhat.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  *
  20  */
  21
  22 #define _GNU_SOURCE
  23 #include <sys/utsname.h>
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <fcntl.h>
  27 #include <errno.h>
  28 #include <stdio.h>
  29 #include <unistd.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32 #include <stdarg.h>
  33 #include <limits.h>
  34
  35 #undef _GNU_SOURCE
  36 #include "event.h"
  37 #include "string.h"
  38 #include "strlist.h"
  39 #include "debug.h"
  40 #include "parse-events.h"  /* For debugfs_path */
  41 #include "probe-event.h"
  42
  43 #define MAX_CMDLEN 256
  44 #define MAX_PROBE_ARGS 128
  45 #define PERFPROBE_GROUP "probe"
  46
  47 #define semantic_error(msg ...) die("Semantic error :" msg)
  48
  49 /* If there is no space to write, returns -E2BIG. */
  50 static int e_snprintf(char *str, size_t size, const char *format, ...)
  51         __attribute__((format(printf, 3, 4)));
  52
  53 static int e_snprintf(char *str, size_t size, const char *format, ...)
  54 {
  55         int ret;
  56         va_list ap;
  57         va_start(ap, format);
  58         ret = vsnprintf(str, size, format, ap);
  59         va_end(ap);
  60         if (ret >= (int)size)
  61                 ret = -E2BIG;
  62         return ret;
  63 }
  64
  65 /* Parse probepoint definition. */
  66 static void parse_perf_probe_probepoint(char *arg, struct probe_point *pp)
  67 {
  68         char *ptr, *tmp;
  69         char c, nc = 0;
  70         /*
  71          * <Syntax>
  72          * perf probe SRC:LN
  73          * perf probe FUNC[+OFFS|%return][@SRC]
  74          */
  75
  76         ptr = strpbrk(arg, ":+@%");
  77         if (ptr) {
  78                 nc = *ptr;
  79                 *ptr++ = '\0';
  80         }
  81
  82         /* Check arg is function or file and copy it */
  83         if (strchr(arg, '.'))   /* File */
  84                 pp->file = strdup(arg);
  85         else                    /* Function */
  86                 pp->function = strdup(arg);
  87         DIE_IF(pp->file == NULL && pp->function == NULL);
  88
  89         /* Parse other options */
  90         while (ptr) {
  91                 arg = ptr;
  92                 c = nc;
  93                 ptr = strpbrk(arg, ":+@%");
  94                 if (ptr) {
  95                         nc = *ptr;
  96                         *ptr++ = '\0';
  97                 }
  98                 switch (c) {
  99                 case ':':       /* Line number */
 100                         pp->line = strtoul(arg, &tmp, 0);
 101                         if (*tmp != '\0')
 102                                 semantic_error("There is non-digit charactor"
 103                                                 " in line number.");
 104                         break;
 105                 case '+':       /* Byte offset from a symbol */
 106                         pp->offset = strtoul(arg, &tmp, 0);
 107                         if (*tmp != '\0')
 108                                 semantic_error("There is non-digit charactor"
 109                                                 " in offset.");
 110                         break;
 111                 case '@':       /* File name */
 112                         if (pp->file)
 113                                 semantic_error("SRC@SRC is not allowed.");
 114                         pp->file = strdup(arg);
 115                         DIE_IF(pp->file == NULL);
 116                         if (ptr)
 117                                 semantic_error("@SRC must be the last "
 118                                                "option.");
 119                         break;
 120                 case '%':       /* Probe places */
 121                         if (strcmp(arg, "return") == 0) {
 122                                 pp->retprobe = 1;
 123                         } else  /* Others not supported yet */
 124                                 semantic_error("%%%s is not supported.", arg);
 125                         break;
 126                 default:
 127                         DIE_IF("Program has a bug.");
 128                         break;
 129                 }
 130         }
 131
 132         /* Exclusion check */
 133         if (pp->line && pp->offset)
 134                 semantic_error("Offset can't be used with line number.");
 135
 136         if (!pp->line && pp->file && !pp->function)
 137                 semantic_error("File always requires line number.");
 138
 139         if (pp->offset && !pp->function)
 140                 semantic_error("Offset requires an entry function.");
 141
 142         if (pp->retprobe && !pp->function)
 143                 semantic_error("Return probe requires an entry function.");
 144
 145         if ((pp->offset || pp->line) && pp->retprobe)
 146                 semantic_error("Offset/Line can't be used with return probe.");
 147
 148         pr_debug("symbol:%s file:%s line:%d offset:%d, return:%d\n",
 149                  pp->function, pp->file, pp->line, pp->offset, pp->retprobe);
 150 }
 151
 152 /* Parse perf-probe event definition */
 153 void parse_perf_probe_event(const char *str, struct probe_point *pp,
 154                             bool *need_dwarf)
 155 {
 156         char **argv;
 157         int argc, i;
 158
 159         *need_dwarf = false;
 160
 161         argv = argv_split(str, &argc);
 162         if (!argv)
 163                 die("argv_split failed.");
 164         if (argc > MAX_PROBE_ARGS + 1)
 165                 semantic_error("Too many arguments");
 166
 167         /* Parse probe point */
 168         parse_perf_probe_probepoint(argv[0], pp);
 169         if (pp->file || pp->line)
 170                 *need_dwarf = true;
 171
 172         /* Copy arguments and ensure return probe has no C argument */
 173         pp->nr_args = argc - 1;
 174         pp->args = zalloc(sizeof(char *) * pp->nr_args);
 175         for (i = 0; i < pp->nr_args; i++) {
 176                 pp->args[i] = strdup(argv[i + 1]);
 177                 if (!pp->args[i])
 178                         die("Failed to copy argument.");
 179                 if (is_c_varname(pp->args[i])) {
 180                         if (pp->retprobe)
 181                                 semantic_error("You can't specify local"
 182                                                 " variable for kretprobe");
 183                         *need_dwarf = true;
 184                 }
 185         }
 186
 187         argv_free(argv);
 188 }
 189
 190 /* Parse kprobe_events event into struct probe_point */
 191 void parse_trace_kprobe_event(const char *str, char **group, char **event,
 192                               struct probe_point *pp)
 193 {
 194         char pr;
 195         char *p;
 196         int ret, i, argc;
 197         char **argv;
 198
 199         pr_debug("Parsing kprobe_events: %s\n", str);
 200         argv = argv_split(str, &argc);
 201         if (!argv)
 202                 die("argv_split failed.");
 203         if (argc < 2)
 204                 semantic_error("Too less arguments.");
 205
 206         /* Scan event and group name. */
 207         ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
 208                      &pr, (float *)(void *)group, (float *)(void *)event);
 209         if (ret != 3)
 210                 semantic_error("Failed to parse event name: %s", argv[0]);
 211         pr_debug("Group:%s Event:%s probe:%c\n", *group, *event, pr);
 212
 213         if (!pp)
 214                 goto end;
 215
 216         pp->retprobe = (pr == 'r');
 217
 218         /* Scan function name and offset */
 219         ret = sscanf(argv[1], "%a[^+]+%d", (float *)(void *)&pp->function, &pp->offset);
 220         if (ret == 1)
 221                 pp->offset = 0;
 222
 223         /* kprobe_events doesn't have this information */
 224         pp->line = 0;
 225         pp->file = NULL;
 226
 227         pp->nr_args = argc - 2;
 228         pp->args = zalloc(sizeof(char *) * pp->nr_args);
 229         for (i = 0; i < pp->nr_args; i++) {
 230                 p = strchr(argv[i + 2], '=');
 231                 if (p)  /* We don't need which register is assigned. */
 232                         *p = '\0';
 233                 pp->args[i] = strdup(argv[i + 2]);
 234                 if (!pp->args[i])
 235                         die("Failed to copy argument.");
 236         }
 237
 238 end:
 239         argv_free(argv);
 240 }
 241
 242 int synthesize_perf_probe_event(struct probe_point *pp)
 243 {
 244         char *buf;
 245         char offs[64] = "", line[64] = "";
 246         int i, len, ret;
 247
 248         pp->probes[0] = buf = zalloc(MAX_CMDLEN);
 249         if (!buf)
 250                 die("Failed to allocate memory by zalloc.");
 251         if (pp->offset) {
 252                 ret = e_snprintf(offs, 64, "+%d", pp->offset);
 253                 if (ret <= 0)
 254                         goto error;
 255         }
 256         if (pp->line) {
 257                 ret = e_snprintf(line, 64, ":%d", pp->line);
 258                 if (ret <= 0)
 259                         goto error;
 260         }
 261
 262         if (pp->function)
 263                 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s", pp->function,
 264                                  offs, pp->retprobe ? "%return" : "", line);
 265         else
 266                 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", pp->file, line);
 267         if (ret <= 0)
 268                 goto error;
 269         len = ret;
 270
 271         for (i = 0; i < pp->nr_args; i++) {
 272                 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
 273                                  pp->args[i]);
 274                 if (ret <= 0)
 275                         goto error;
 276                 len += ret;
 277         }
 278         pp->found = 1;
 279
 280         return pp->found;
 281 error:
 282         free(pp->probes[0]);
 283
 284         return ret;
 285 }
 286
 287 int synthesize_trace_kprobe_event(struct probe_point *pp)
 288 {
 289         char *buf;
 290         int i, len, ret;
 291
 292         pp->probes[0] = buf = zalloc(MAX_CMDLEN);
 293         if (!buf)
 294                 die("Failed to allocate memory by zalloc.");
 295         ret = e_snprintf(buf, MAX_CMDLEN, "%s+%d", pp->function, pp->offset);
 296         if (ret <= 0)
 297                 goto error;
 298         len = ret;
 299
 300         for (i = 0; i < pp->nr_args; i++) {
 301                 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
 302                                  pp->args[i]);
 303                 if (ret <= 0)
 304                         goto error;
 305                 len += ret;
 306         }
 307         pp->found = 1;
 308
 309         return pp->found;
 310 error:
 311         free(pp->probes[0]);
 312
 313         return ret;
 314 }
 315
 316 static int open_kprobe_events(int flags, int mode)
 317 {
 318         char buf[PATH_MAX];
 319         int ret;
 320
 321         ret = e_snprintf(buf, PATH_MAX, "%s/../kprobe_events", debugfs_path);
 322         if (ret < 0)
 323                 die("Failed to make kprobe_events path.");
 324
 325         ret = open(buf, flags, mode);
 326         if (ret < 0) {
 327                 if (errno == ENOENT)
 328                         die("kprobe_events file does not exist -"
 329                             " please rebuild with CONFIG_KPROBE_TRACER.");
 330                 else
 331                         die("Could not open kprobe_events file: %s",
 332                             strerror(errno));
 333         }
 334         return ret;
 335 }
 336
 337 /* Get raw string list of current kprobe_events */
 338 static struct strlist *get_trace_kprobe_event_rawlist(int fd)
 339 {
 340         int ret, idx;
 341         FILE *fp;
 342         char buf[MAX_CMDLEN];
 343         char *p;
 344         struct strlist *sl;
 345
 346         sl = strlist__new(true, NULL);
 347
 348         fp = fdopen(dup(fd), "r");
 349         while (!feof(fp)) {
 350                 p = fgets(buf, MAX_CMDLEN, fp);
 351                 if (!p)
 352                         break;
 353
 354                 idx = strlen(p) - 1;
 355                 if (p[idx] == '\n')
 356                         p[idx] = '\0';
 357                 ret = strlist__add(sl, buf);
 358                 if (ret < 0)
 359                         die("strlist__add failed: %s", strerror(-ret));
 360         }
 361         fclose(fp);
 362
 363         return sl;
 364 }
 365
 366 /* Free and zero clear probe_point */
 367 static void clear_probe_point(struct probe_point *pp)
 368 {
 369         int i;
 370
 371         if (pp->function)
 372                 free(pp->function);
 373         if (pp->file)
 374                 free(pp->file);
 375         for (i = 0; i < pp->nr_args; i++)
 376                 free(pp->args[i]);
 377         if (pp->args)
 378                 free(pp->args);
 379         for (i = 0; i < pp->found; i++)
 380                 free(pp->probes[i]);
 381         memset(pp, 0, sizeof(*pp));
 382 }
 383
 384 /* Show an event */
 385 static void show_perf_probe_event(const char *group, const char *event,
 386                                   const char *place, struct probe_point *pp)
 387 {
 388         int i, ret;
 389         char buf[128];
 390
 391         ret = e_snprintf(buf, 128, "%s:%s", group, event);
 392         if (ret < 0)
 393                 die("Failed to copy event: %s", strerror(-ret));
 394         printf("  %-40s (on %s", buf, place);
 395
 396         if (pp->nr_args > 0) {
 397                 printf(" with");
 398                 for (i = 0; i < pp->nr_args; i++)
 399                         printf(" %s", pp->args[i]);
 400         }
 401         printf(")\n");
 402 }
 403
 404 /* List up current perf-probe events */
 405 void show_perf_probe_events(void)
 406 {
 407         unsigned int i;
 408         int fd, nr;
 409         char *group, *event;
 410         struct probe_point pp;
 411         struct strlist *rawlist;
 412         struct str_node *ent;
 413
 414         fd = open_kprobe_events(O_RDONLY, 0);
 415         rawlist = get_trace_kprobe_event_rawlist(fd);
 416         close(fd);
 417
 418         for (i = 0; i < strlist__nr_entries(rawlist); i++) {
 419                 ent = strlist__entry(rawlist, i);
 420                 parse_trace_kprobe_event(ent->s, &group, &event, &pp);
 421                 /* Synthesize only event probe point */
 422                 nr = pp.nr_args;
 423                 pp.nr_args = 0;
 424                 synthesize_perf_probe_event(&pp);
 425                 pp.nr_args = nr;
 426                 /* Show an event */
 427                 show_perf_probe_event(group, event, pp.probes[0], &pp);
 428                 free(group);
 429                 free(event);
 430                 clear_probe_point(&pp);
 431         }
 432
 433         strlist__delete(rawlist);
 434 }
 435
 436 /* Get current perf-probe event names */
 437 static struct strlist *get_perf_event_names(int fd, bool include_group)
 438 {
 439         unsigned int i;
 440         char *group, *event;
 441         char buf[128];
 442         struct strlist *sl, *rawlist;
 443         struct str_node *ent;
 444
 445         rawlist = get_trace_kprobe_event_rawlist(fd);
 446
 447         sl = strlist__new(true, NULL);
 448         for (i = 0; i < strlist__nr_entries(rawlist); i++) {
 449                 ent = strlist__entry(rawlist, i);
 450                 parse_trace_kprobe_event(ent->s, &group, &event, NULL);
 451                 if (include_group) {
 452                         if (e_snprintf(buf, 128, "%s:%s", group, event) < 0)
 453                                 die("Failed to copy group:event name.");
 454                         strlist__add(sl, buf);
 455                 } else
 456                         strlist__add(sl, event);
 457                 free(group);
 458                 free(event);
 459         }
 460
 461         strlist__delete(rawlist);
 462
 463         return sl;
 464 }
 465
 466 static void write_trace_kprobe_event(int fd, const char *buf)
 467 {
 468         int ret;
 469
 470         pr_debug("Writing event: %s\n", buf);
 471         ret = write(fd, buf, strlen(buf));
 472         if (ret <= 0)
 473                 die("Failed to write event: %s", strerror(errno));
 474 }
 475
 476 static void get_new_event_name(char *buf, size_t len, const char *base,
 477                                struct strlist *namelist)
 478 {
 479         int i, ret;
 480
 481         /* Try no suffix */
 482         ret = e_snprintf(buf, len, "%s", base);
 483         if (ret < 0)
 484                 die("snprintf() failed: %s", strerror(-ret));
 485         if (!strlist__has_entry(namelist, buf))
 486                 return;
 487
 488         /* Try to add suffix */
 489         for (i = 1; i < MAX_EVENT_INDEX; i++) {
 490                 ret = e_snprintf(buf, len, "%s_%d", base, i);
 491                 if (ret < 0)
 492                         die("snprintf() failed: %s", strerror(-ret));
 493                 if (!strlist__has_entry(namelist, buf))
 494                         break;
 495         }
 496         if (i == MAX_EVENT_INDEX)
 497                 die("Too many events are on the same function.");
 498 }
 499
 500 void add_trace_kprobe_events(struct probe_point *probes, int nr_probes)
 501 {
 502         int i, j, fd;
 503         struct probe_point *pp;
 504         char buf[MAX_CMDLEN];
 505         char event[64];
 506         struct strlist *namelist;
 507
 508         fd = open_kprobe_events(O_RDWR, O_APPEND);
 509         /* Get current event names */
 510         namelist = get_perf_event_names(fd, false);
 511
 512         for (j = 0; j < nr_probes; j++) {
 513                 pp = probes + j;
 514                 for (i = 0; i < pp->found; i++) {
 515                         /* Get an unused new event name */
 516                         get_new_event_name(event, 64, pp->function, namelist);
 517                         snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s\n",
 518                                  pp->retprobe ? 'r' : 'p',
 519                                  PERFPROBE_GROUP, event,
 520                                  pp->probes[i]);
 521                         write_trace_kprobe_event(fd, buf);
 522                         printf("Added new event:\n");
 523                         /* Get the first parameter (probe-point) */
 524                         sscanf(pp->probes[i], "%s", buf);
 525                         show_perf_probe_event(PERFPROBE_GROUP, event,
 526                                               buf, pp);
 527                         /* Add added event name to namelist */
 528                         strlist__add(namelist, event);
 529                 }
 530         }
 531         /* Show how to use the event. */
 532         printf("\nYou can now use it on all perf tools, such as:\n\n");
 533         printf("\tperf record -e %s:%s -a sleep 1\n\n", PERFPROBE_GROUP, event);
 534
 535         strlist__delete(namelist);
 536         close(fd);
 537 }
 538
 539 static void del_trace_kprobe_event(int fd, const char *group,
 540                                    const char *event, struct strlist *namelist)
 541 {
 542         char buf[128];
 543
 544         if (e_snprintf(buf, 128, "%s:%s", group, event) < 0)
 545                 die("Failed to copy event.");
 546         if (!strlist__has_entry(namelist, buf)) {
 547                 pr_warning("Warning: event \"%s\" is not found.\n", buf);
 548                 return;
 549         }
 550         /* Convert from perf-probe event to trace-kprobe event */
 551         if (e_snprintf(buf, 128, "-:%s/%s", group, event) < 0)
 552                 die("Failed to copy event.");
 553
 554         write_trace_kprobe_event(fd, buf);
 555         printf("Remove event: %s:%s\n", group, event);
 556 }
 557
 558 void del_trace_kprobe_events(struct strlist *dellist)
 559 {
 560         int fd;
 561         unsigned int i;
 562         const char *group, *event;
 563         char *p, *str;
 564         struct str_node *ent;
 565         struct strlist *namelist;
 566
 567         fd = open_kprobe_events(O_RDWR, O_APPEND);
 568         /* Get current event names */
 569         namelist = get_perf_event_names(fd, true);
 570
 571         for (i = 0; i < strlist__nr_entries(dellist); i++) {
 572                 ent = strlist__entry(dellist, i);
 573                 str = strdup(ent->s);
 574                 if (!str)
 575                         die("Failed to copy event.");
 576                 p = strchr(str, ':');
 577                 if (p) {
 578                         group = str;
 579                         *p = '\0';
 580                         event = p + 1;
 581                 } else {
 582                         group = PERFPROBE_GROUP;
 583                         event = str;
 584                 }
 585                 del_trace_kprobe_event(fd, group, event, namelist);
 586                 free(str);
 587         }
 588         strlist__delete(namelist);
 589         close(fd);
 590 }
 591