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 "cache.h"
  41 #include "parse-events.h"  /* For debugfs_path */
  42 #include "probe-event.h"
  43
  44 #define MAX_CMDLEN 256
  45 #define MAX_PROBE_ARGS 128
  46 #define PERFPROBE_GROUP "probe"
  47
  48 #define semantic_error(msg ...) die("Semantic error :" msg)
  49
  50 /* If there is no space to write, returns -E2BIG. */
  51 static int e_snprintf(char *str, size_t size, const char *format, ...)
  52         __attribute__((format(printf, 3, 4)));
  53
  54 static int e_snprintf(char *str, size_t size, const char *format, ...)
  55 {
  56         int ret;
  57         va_list ap;
  58         va_start(ap, format);
  59         ret = vsnprintf(str, size, format, ap);
  60         va_end(ap);
  61         if (ret >= (int)size)
  62                 ret = -E2BIG;
  63         return ret;
  64 }
  65
  66 /* Check the name is good for event/group */
  67 static bool check_event_name(const char *name)
  68 {
  69         if (!isalpha(*name) && *name != '_')
  70                 return false;
  71         while (*++name != '\0') {
  72                 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
  73                         return false;
  74         }
  75         return true;
  76 }
  77
  78 /* Parse probepoint definition. */
  79 static void parse_perf_probe_probepoint(char *arg, struct probe_point *pp)
  80 {
  81         char *ptr, *tmp;
  82         char c, nc = 0;
  83         /*
  84          * <Syntax>
  85          * perf probe [EVENT=]SRC:LN
  86          * perf probe [EVENT=]FUNC[+OFFS|%return][@SRC]
  87          *
  88          * TODO:Group name support
  89          */
  90
  91         ptr = strchr(arg, '=');
  92         if (ptr) {      /* Event name */
  93                 *ptr = '\0';
  94                 tmp = ptr + 1;
  95                 ptr = strchr(arg, ':');
  96                 if (ptr)        /* Group name is not supported yet. */
  97                         semantic_error("Group name is not supported yet.");
  98                 if (!check_event_name(arg))
  99                         semantic_error("%s is bad for event name -it must "
 100                                        "follow C symbol-naming rule.", arg);
 101                 pp->event = strdup(arg);
 102                 arg = tmp;
 103         }
 104
 105         ptr = strpbrk(arg, ":+@%");
 106         if (ptr) {
 107                 nc = *ptr;
 108                 *ptr++ = '\0';
 109         }
 110
 111         /* Check arg is function or file and copy it */
 112         if (strchr(arg, '.'))   /* File */
 113                 pp->file = strdup(arg);
 114         else                    /* Function */
 115                 pp->function = strdup(arg);
 116         DIE_IF(pp->file == NULL && pp->function == NULL);
 117
 118         /* Parse other options */
 119         while (ptr) {
 120                 arg = ptr;
 121                 c = nc;
 122                 ptr = strpbrk(arg, ":+@%");
 123                 if (ptr) {
 124                         nc = *ptr;
 125                         *ptr++ = '\0';
 126                 }
 127                 switch (c) {
 128                 case ':':       /* Line number */
 129                         pp->line = strtoul(arg, &tmp, 0);
 130                         if (*tmp != '\0')
 131                                 semantic_error("There is non-digit charactor"
 132                                                 " in line number.");
 133                         break;
 134                 case '+':       /* Byte offset from a symbol */
 135                         pp->offset = strtoul(arg, &tmp, 0);
 136                         if (*tmp != '\0')
 137                                 semantic_error("There is non-digit charactor"
 138                                                 " in offset.");
 139                         break;
 140                 case '@':       /* File name */
 141                         if (pp->file)
 142                                 semantic_error("SRC@SRC is not allowed.");
 143                         pp->file = strdup(arg);
 144                         DIE_IF(pp->file == NULL);
 145                         if (ptr)
 146                                 semantic_error("@SRC must be the last "
 147                                                "option.");
 148                         break;
 149                 case '%':       /* Probe places */
 150                         if (strcmp(arg, "return") == 0) {
 151                                 pp->retprobe = 1;
 152                         } else  /* Others not supported yet */
 153                                 semantic_error("%%%s is not supported.", arg);
 154                         break;
 155                 default:
 156                         DIE_IF("Program has a bug.");
 157                         break;
 158                 }
 159         }
 160
 161         /* Exclusion check */
 162         if (pp->line && pp->offset)
 163                 semantic_error("Offset can't be used with line number.");
 164
 165         if (!pp->line && pp->file && !pp->function)
 166                 semantic_error("File always requires line number.");
 167
 168         if (pp->offset && !pp->function)
 169                 semantic_error("Offset requires an entry function.");
 170
 171         if (pp->retprobe && !pp->function)
 172                 semantic_error("Return probe requires an entry function.");
 173
 174         if ((pp->offset || pp->line) && pp->retprobe)
 175                 semantic_error("Offset/Line can't be used with return probe.");
 176
 177         pr_debug("symbol:%s file:%s line:%d offset:%d, return:%d\n",
 178                  pp->function, pp->file, pp->line, pp->offset, pp->retprobe);
 179 }
 180
 181 /* Parse perf-probe event definition */
 182 void parse_perf_probe_event(const char *str, struct probe_point *pp,
 183                             bool *need_dwarf)
 184 {
 185         char **argv;
 186         int argc, i;
 187
 188         *need_dwarf = false;
 189
 190         argv = argv_split(str, &argc);
 191         if (!argv)
 192                 die("argv_split failed.");
 193         if (argc > MAX_PROBE_ARGS + 1)
 194                 semantic_error("Too many arguments");
 195
 196         /* Parse probe point */
 197         parse_perf_probe_probepoint(argv[0], pp);
 198         if (pp->file || pp->line)
 199                 *need_dwarf = true;
 200
 201         /* Copy arguments and ensure return probe has no C argument */
 202         pp->nr_args = argc - 1;
 203         pp->args = zalloc(sizeof(char *) * pp->nr_args);
 204         for (i = 0; i < pp->nr_args; i++) {
 205                 pp->args[i] = strdup(argv[i + 1]);
 206                 if (!pp->args[i])
 207                         die("Failed to copy argument.");
 208                 if (is_c_varname(pp->args[i])) {
 209                         if (pp->retprobe)
 210                                 semantic_error("You can't specify local"
 211                                                 " variable for kretprobe");
 212                         *need_dwarf = true;
 213                 }
 214         }
 215
 216         argv_free(argv);
 217 }
 218
 219 /* Parse kprobe_events event into struct probe_point */
 220 void parse_trace_kprobe_event(const char *str, struct probe_point *pp)
 221 {
 222         char pr;
 223         char *p;
 224         int ret, i, argc;
 225         char **argv;
 226
 227         pr_debug("Parsing kprobe_events: %s\n", str);
 228         argv = argv_split(str, &argc);
 229         if (!argv)
 230                 die("argv_split failed.");
 231         if (argc < 2)
 232                 semantic_error("Too less arguments.");
 233
 234         /* Scan event and group name. */
 235         ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
 236                      &pr, (float *)(void *)&pp->group,
 237                      (float *)(void *)&pp->event);
 238         if (ret != 3)
 239                 semantic_error("Failed to parse event name: %s", argv[0]);
 240         pr_debug("Group:%s Event:%s probe:%c\n", pp->group, pp->event, pr);
 241
 242         pp->retprobe = (pr == 'r');
 243
 244         /* Scan function name and offset */
 245         ret = sscanf(argv[1], "%a[^+]+%d", (float *)(void *)&pp->function,
 246                      &pp->offset);
 247         if (ret == 1)
 248                 pp->offset = 0;
 249
 250         /* kprobe_events doesn't have this information */
 251         pp->line = 0;
 252         pp->file = NULL;
 253
 254         pp->nr_args = argc - 2;
 255         pp->args = zalloc(sizeof(char *) * pp->nr_args);
 256         for (i = 0; i < pp->nr_args; i++) {
 257                 p = strchr(argv[i + 2], '=');
 258                 if (p)  /* We don't need which register is assigned. */
 259                         *p = '\0';
 260                 pp->args[i] = strdup(argv[i + 2]);
 261                 if (!pp->args[i])
 262                         die("Failed to copy argument.");
 263         }
 264
 265         argv_free(argv);
 266 }
 267
 268 /* Synthesize only probe point (not argument) */
 269 int synthesize_perf_probe_point(struct probe_point *pp)
 270 {
 271         char *buf;
 272         char offs[64] = "", line[64] = "";
 273         int ret;
 274
 275         pp->probes[0] = buf = zalloc(MAX_CMDLEN);
 276         if (!buf)
 277                 die("Failed to allocate memory by zalloc.");
 278         if (pp->offset) {
 279                 ret = e_snprintf(offs, 64, "+%d", pp->offset);
 280                 if (ret <= 0)
 281                         goto error;
 282         }
 283         if (pp->line) {
 284                 ret = e_snprintf(line, 64, ":%d", pp->line);
 285                 if (ret <= 0)
 286                         goto error;
 287         }
 288
 289         if (pp->function)
 290                 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s", pp->function,
 291                                  offs, pp->retprobe ? "%return" : "", line);
 292         else
 293                 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", pp->file, line);
 294         if (ret <= 0) {
 295 error:
 296                 free(pp->probes[0]);
 297                 pp->probes[0] = NULL;
 298         }
 299         return ret;
 300 }
 301
 302 int synthesize_perf_probe_event(struct probe_point *pp)
 303 {
 304         char *buf;
 305         int i, len, ret;
 306
 307         len = synthesize_perf_probe_point(pp);
 308         if (len < 0)
 309                 return 0;
 310
 311         buf = pp->probes[0];
 312         for (i = 0; i < pp->nr_args; i++) {
 313                 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
 314                                  pp->args[i]);
 315                 if (ret <= 0)
 316                         goto error;
 317                 len += ret;
 318         }
 319         pp->found = 1;
 320
 321         return pp->found;
 322 error:
 323         free(pp->probes[0]);
 324         pp->probes[0] = NULL;
 325
 326         return ret;
 327 }
 328
 329 int synthesize_trace_kprobe_event(struct probe_point *pp)
 330 {
 331         char *buf;
 332         int i, len, ret;
 333
 334         pp->probes[0] = buf = zalloc(MAX_CMDLEN);
 335         if (!buf)
 336                 die("Failed to allocate memory by zalloc.");
 337         ret = e_snprintf(buf, MAX_CMDLEN, "%s+%d", pp->function, pp->offset);
 338         if (ret <= 0)
 339                 goto error;
 340         len = ret;
 341
 342         for (i = 0; i < pp->nr_args; i++) {
 343                 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
 344                                  pp->args[i]);
 345                 if (ret <= 0)
 346                         goto error;
 347                 len += ret;
 348         }
 349         pp->found = 1;
 350
 351         return pp->found;
 352 error:
 353         free(pp->probes[0]);
 354         pp->probes[0] = NULL;
 355
 356         return ret;
 357 }
 358
 359 static int open_kprobe_events(int flags, int mode)
 360 {
 361         char buf[PATH_MAX];
 362         int ret;
 363
 364         ret = e_snprintf(buf, PATH_MAX, "%s/../kprobe_events", debugfs_path);
 365         if (ret < 0)
 366                 die("Failed to make kprobe_events path.");
 367
 368         ret = open(buf, flags, mode);
 369         if (ret < 0) {
 370                 if (errno == ENOENT)
 371                         die("kprobe_events file does not exist -"
 372                             " please rebuild with CONFIG_KPROBE_EVENT.");
 373                 else
 374                         die("Could not open kprobe_events file: %s",
 375                             strerror(errno));
 376         }
 377         return ret;
 378 }
 379
 380 /* Get raw string list of current kprobe_events */
 381 static struct strlist *get_trace_kprobe_event_rawlist(int fd)
 382 {
 383         int ret, idx;
 384         FILE *fp;
 385         char buf[MAX_CMDLEN];
 386         char *p;
 387         struct strlist *sl;
 388
 389         sl = strlist__new(true, NULL);
 390
 391         fp = fdopen(dup(fd), "r");
 392         while (!feof(fp)) {
 393                 p = fgets(buf, MAX_CMDLEN, fp);
 394                 if (!p)
 395                         break;
 396
 397                 idx = strlen(p) - 1;
 398                 if (p[idx] == '\n')
 399                         p[idx] = '\0';
 400                 ret = strlist__add(sl, buf);
 401                 if (ret < 0)
 402                         die("strlist__add failed: %s", strerror(-ret));
 403         }
 404         fclose(fp);
 405
 406         return sl;
 407 }
 408
 409 /* Free and zero clear probe_point */
 410 static void clear_probe_point(struct probe_point *pp)
 411 {
 412         int i;
 413
 414         if (pp->event)
 415                 free(pp->event);
 416         if (pp->group)
 417                 free(pp->group);
 418         if (pp->function)
 419                 free(pp->function);
 420         if (pp->file)
 421                 free(pp->file);
 422         for (i = 0; i < pp->nr_args; i++)
 423                 free(pp->args[i]);
 424         if (pp->args)
 425                 free(pp->args);
 426         for (i = 0; i < pp->found; i++)
 427                 free(pp->probes[i]);
 428         memset(pp, 0, sizeof(*pp));
 429 }
 430
 431 /* Show an event */
 432 static void show_perf_probe_event(const char *event, const char *place,
 433                                   struct probe_point *pp)
 434 {
 435         int i, ret;
 436         char buf[128];
 437
 438         ret = e_snprintf(buf, 128, "%s:%s", pp->group, event);
 439         if (ret < 0)
 440                 die("Failed to copy event: %s", strerror(-ret));
 441         printf("  %-40s (on %s", buf, place);
 442
 443         if (pp->nr_args > 0) {
 444                 printf(" with");
 445                 for (i = 0; i < pp->nr_args; i++)
 446                         printf(" %s", pp->args[i]);
 447         }
 448         printf(")\n");
 449 }
 450
 451 /* List up current perf-probe events */
 452 void show_perf_probe_events(void)
 453 {
 454         int fd;
 455         struct probe_point pp;
 456         struct strlist *rawlist;
 457         struct str_node *ent;
 458
 459         setup_pager();
 460
 461         fd = open_kprobe_events(O_RDONLY, 0);
 462         rawlist = get_trace_kprobe_event_rawlist(fd);
 463         close(fd);
 464
 465         strlist__for_each(ent, rawlist) {
 466                 parse_trace_kprobe_event(ent->s, &pp);
 467                 /* Synthesize only event probe point */
 468                 synthesize_perf_probe_point(&pp);
 469                 /* Show an event */
 470                 show_perf_probe_event(pp.event, pp.probes[0], &pp);
 471                 clear_probe_point(&pp);
 472         }
 473
 474         strlist__delete(rawlist);
 475 }
 476
 477 /* Get current perf-probe event names */
 478 static struct strlist *get_perf_event_names(int fd, bool include_group)
 479 {
 480         char buf[128];
 481         struct strlist *sl, *rawlist;
 482         struct str_node *ent;
 483         struct probe_point pp;
 484
 485         memset(&pp, 0, sizeof(pp));
 486         rawlist = get_trace_kprobe_event_rawlist(fd);
 487
 488         sl = strlist__new(true, NULL);
 489         strlist__for_each(ent, rawlist) {
 490                 parse_trace_kprobe_event(ent->s, &pp);
 491                 if (include_group) {
 492                         if (e_snprintf(buf, 128, "%s:%s", pp.group,
 493                                        pp.event) < 0)
 494                                 die("Failed to copy group:event name.");
 495                         strlist__add(sl, buf);
 496                 } else
 497                         strlist__add(sl, pp.event);
 498                 clear_probe_point(&pp);
 499         }
 500
 501         strlist__delete(rawlist);
 502
 503         return sl;
 504 }
 505
 506 static void write_trace_kprobe_event(int fd, const char *buf)
 507 {
 508         int ret;
 509
 510         pr_debug("Writing event: %s\n", buf);
 511         ret = write(fd, buf, strlen(buf));
 512         if (ret <= 0)
 513                 die("Failed to write event: %s", strerror(errno));
 514 }
 515
 516 static void get_new_event_name(char *buf, size_t len, const char *base,
 517                                struct strlist *namelist, bool allow_suffix)
 518 {
 519         int i, ret;
 520
 521         /* Try no suffix */
 522         ret = e_snprintf(buf, len, "%s", base);
 523         if (ret < 0)
 524                 die("snprintf() failed: %s", strerror(-ret));
 525         if (!strlist__has_entry(namelist, buf))
 526                 return;
 527
 528         if (!allow_suffix) {
 529                 pr_warning("Error: event \"%s\" already exists. "
 530                            "(Use -f to force duplicates.)\n", base);
 531                 die("Can't add new event.");
 532         }
 533
 534         /* Try to add suffix */
 535         for (i = 1; i < MAX_EVENT_INDEX; i++) {
 536                 ret = e_snprintf(buf, len, "%s_%d", base, i);
 537                 if (ret < 0)
 538                         die("snprintf() failed: %s", strerror(-ret));
 539                 if (!strlist__has_entry(namelist, buf))
 540                         break;
 541         }
 542         if (i == MAX_EVENT_INDEX)
 543                 die("Too many events are on the same function.");
 544 }
 545
 546 void add_trace_kprobe_events(struct probe_point *probes, int nr_probes,
 547                              bool force_add)
 548 {
 549         int i, j, fd;
 550         struct probe_point *pp;
 551         char buf[MAX_CMDLEN];
 552         char event[64];
 553         struct strlist *namelist;
 554         bool allow_suffix;
 555
 556         fd = open_kprobe_events(O_RDWR, O_APPEND);
 557         /* Get current event names */
 558         namelist = get_perf_event_names(fd, false);
 559
 560         for (j = 0; j < nr_probes; j++) {
 561                 pp = probes + j;
 562                 if (!pp->event)
 563                         pp->event = strdup(pp->function);
 564                 if (!pp->group)
 565                         pp->group = strdup(PERFPROBE_GROUP);
 566                 DIE_IF(!pp->event || !pp->group);
 567                 /* If force_add is true, suffix search is allowed */
 568                 allow_suffix = force_add;
 569                 for (i = 0; i < pp->found; i++) {
 570                         /* Get an unused new event name */
 571                         get_new_event_name(event, 64, pp->event, namelist,
 572                                            allow_suffix);
 573                         snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s\n",
 574                                  pp->retprobe ? 'r' : 'p',
 575                                  pp->group, event,
 576                                  pp->probes[i]);
 577                         write_trace_kprobe_event(fd, buf);
 578                         printf("Added new event:\n");
 579                         /* Get the first parameter (probe-point) */
 580                         sscanf(pp->probes[i], "%s", buf);
 581                         show_perf_probe_event(event, buf, pp);
 582                         /* Add added event name to namelist */
 583                         strlist__add(namelist, event);
 584                         /*
 585                          * Probes after the first probe which comes from same
 586                          * user input are always allowed to add suffix, because
 587                          * there might be several addresses corresponding to
 588                          * one code line.
 589                          */
 590                         allow_suffix = true;
 591                 }
 592         }
 593         /* Show how to use the event. */
 594         printf("\nYou can now use it on all perf tools, such as:\n\n");
 595         printf("\tperf record -e %s:%s -a sleep 1\n\n", PERFPROBE_GROUP, event);
 596
 597         strlist__delete(namelist);
 598         close(fd);
 599 }
 600
 601 static void __del_trace_kprobe_event(int fd, struct str_node *ent)
 602 {
 603         char *p;
 604         char buf[128];
 605
 606         /* Convert from perf-probe event to trace-kprobe event */
 607         if (e_snprintf(buf, 128, "-:%s", ent->s) < 0)
 608                 die("Failed to copy event.");
 609         p = strchr(buf + 2, ':');
 610         if (!p)
 611                 die("Internal error: %s should have ':' but not.", ent->s);
 612         *p = '/';
 613
 614         write_trace_kprobe_event(fd, buf);
 615         printf("Remove event: %s\n", ent->s);
 616 }
 617
 618 static void del_trace_kprobe_event(int fd, const char *group,
 619                                    const char *event, struct strlist *namelist)
 620 {
 621         char buf[128];
 622         struct str_node *ent, *n;
 623         int found = 0;
 624
 625         if (e_snprintf(buf, 128, "%s:%s", group, event) < 0)
 626                 die("Failed to copy event.");
 627
 628         if (strpbrk(buf, "*?")) { /* Glob-exp */
 629                 strlist__for_each_safe(ent, n, namelist)
 630                         if (strglobmatch(ent->s, buf)) {
 631                                 found++;
 632                                 __del_trace_kprobe_event(fd, ent);
 633                                 strlist__remove(namelist, ent);
 634                         }
 635         } else {
 636                 ent = strlist__find(namelist, buf);
 637                 if (ent) {
 638                         found++;
 639                         __del_trace_kprobe_event(fd, ent);
 640                         strlist__remove(namelist, ent);
 641                 }
 642         }
 643         if (found == 0)
 644                 pr_info("Info: event \"%s\" does not exist, could not remove it.\n", buf);
 645 }
 646
 647 void del_trace_kprobe_events(struct strlist *dellist)
 648 {
 649         int fd;
 650         const char *group, *event;
 651         char *p, *str;
 652         struct str_node *ent;
 653         struct strlist *namelist;
 654
 655         fd = open_kprobe_events(O_RDWR, O_APPEND);
 656         /* Get current event names */
 657         namelist = get_perf_event_names(fd, true);
 658
 659         strlist__for_each(ent, dellist) {
 660                 str = strdup(ent->s);
 661                 if (!str)
 662                         die("Failed to copy event.");
 663                 pr_debug("Parsing: %s\n", str);
 664                 p = strchr(str, ':');
 665                 if (p) {
 666                         group = str;
 667                         *p = '\0';
 668                         event = p + 1;
 669                 } else {
 670                         group = "*";
 671                         event = str;
 672                 }
 673                 pr_debug("Group: %s, Event: %s\n", group, event);
 674                 del_trace_kprobe_event(fd, group, event, namelist);
 675                 free(str);
 676         }
 677         strlist__delete(namelist);
 678         close(fd);
 679 }
 680