1 /* 2 * probe-event.c : perf-probe definition to probe_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 #include <inttypes.h> 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 #include <elf.h> 35 36 #include "util.h" 37 #include "event.h" 38 #include "strlist.h" 39 #include "strfilter.h" 40 #include "debug.h" 41 #include "cache.h" 42 #include "color.h" 43 #include "symbol.h" 44 #include "thread.h" 45 #include <api/fs/fs.h> 46 #include "trace-event.h" /* For __maybe_unused */ 47 #include "probe-event.h" 48 #include "probe-finder.h" 49 #include "probe-file.h" 50 #include "session.h" 51 #include "string2.h" 52 53 #include "sane_ctype.h" 54 55 #define PERFPROBE_GROUP "probe" 56 57 bool probe_event_dry_run; /* Dry run flag */ 58 struct probe_conf probe_conf; 59 60 #define semantic_error(msg ...) pr_err("Semantic error :" msg) 61 62 int e_snprintf(char *str, size_t size, const char *format, ...) 63 { 64 int ret; 65 va_list ap; 66 va_start(ap, format); 67 ret = vsnprintf(str, size, format, ap); 68 va_end(ap); 69 if (ret >= (int)size) 70 ret = -E2BIG; 71 return ret; 72 } 73 74 static struct machine *host_machine; 75 76 /* Initialize symbol maps and path of vmlinux/modules */ 77 int init_probe_symbol_maps(bool user_only) 78 { 79 int ret; 80 81 symbol_conf.sort_by_name = true; 82 symbol_conf.allow_aliases = true; 83 ret = symbol__init(NULL); 84 if (ret < 0) { 85 pr_debug("Failed to init symbol map.\n"); 86 goto out; 87 } 88 89 if (host_machine || user_only) /* already initialized */ 90 return 0; 91 92 if (symbol_conf.vmlinux_name) 93 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name); 94 95 host_machine = machine__new_host(); 96 if (!host_machine) { 97 pr_debug("machine__new_host() failed.\n"); 98 symbol__exit(); 99 ret = -1; 100 } 101 out: 102 if (ret < 0) 103 pr_warning("Failed to init vmlinux path.\n"); 104 return ret; 105 } 106 107 void exit_probe_symbol_maps(void) 108 { 109 machine__delete(host_machine); 110 host_machine = NULL; 111 symbol__exit(); 112 } 113 114 static struct symbol *__find_kernel_function_by_name(const char *name, 115 struct map **mapp) 116 { 117 return machine__find_kernel_function_by_name(host_machine, name, mapp); 118 } 119 120 static struct symbol *__find_kernel_function(u64 addr, struct map **mapp) 121 { 122 return machine__find_kernel_function(host_machine, addr, mapp); 123 } 124 125 static struct ref_reloc_sym *kernel_get_ref_reloc_sym(void) 126 { 127 /* kmap->ref_reloc_sym should be set if host_machine is initialized */ 128 struct kmap *kmap; 129 struct map *map = machine__kernel_map(host_machine); 130 131 if (map__load(map) < 0) 132 return NULL; 133 134 kmap = map__kmap(map); 135 if (!kmap) 136 return NULL; 137 return kmap->ref_reloc_sym; 138 } 139 140 static int kernel_get_symbol_address_by_name(const char *name, u64 *addr, 141 bool reloc, bool reladdr) 142 { 143 struct ref_reloc_sym *reloc_sym; 144 struct symbol *sym; 145 struct map *map; 146 147 /* ref_reloc_sym is just a label. Need a special fix*/ 148 reloc_sym = kernel_get_ref_reloc_sym(); 149 if (reloc_sym && strcmp(name, reloc_sym->name) == 0) 150 *addr = (reloc) ? reloc_sym->addr : reloc_sym->unrelocated_addr; 151 else { 152 sym = __find_kernel_function_by_name(name, &map); 153 if (!sym) 154 return -ENOENT; 155 *addr = map->unmap_ip(map, sym->start) - 156 ((reloc) ? 0 : map->reloc) - 157 ((reladdr) ? map->start : 0); 158 } 159 return 0; 160 } 161 162 static struct map *kernel_get_module_map(const char *module) 163 { 164 struct map_groups *grp = &host_machine->kmaps; 165 struct maps *maps = &grp->maps[MAP__FUNCTION]; 166 struct map *pos; 167 168 /* A file path -- this is an offline module */ 169 if (module && strchr(module, '/')) 170 return dso__new_map(module); 171 172 if (!module) 173 module = "kernel"; 174 175 for (pos = maps__first(maps); pos; pos = map__next(pos)) { 176 /* short_name is "[module]" */ 177 if (strncmp(pos->dso->short_name + 1, module, 178 pos->dso->short_name_len - 2) == 0 && 179 module[pos->dso->short_name_len - 2] == '\0') { 180 map__get(pos); 181 return pos; 182 } 183 } 184 return NULL; 185 } 186 187 struct map *get_target_map(const char *target, struct nsinfo *nsi, bool user) 188 { 189 /* Init maps of given executable or kernel */ 190 if (user) { 191 struct map *map; 192 193 map = dso__new_map(target); 194 if (map && map->dso) 195 map->dso->nsinfo = nsinfo__get(nsi); 196 return map; 197 } else { 198 return kernel_get_module_map(target); 199 } 200 } 201 202 static int convert_exec_to_group(const char *exec, char **result) 203 { 204 char *ptr1, *ptr2, *exec_copy; 205 char buf[64]; 206 int ret; 207 208 exec_copy = strdup(exec); 209 if (!exec_copy) 210 return -ENOMEM; 211 212 ptr1 = basename(exec_copy); 213 if (!ptr1) { 214 ret = -EINVAL; 215 goto out; 216 } 217 218 for (ptr2 = ptr1; *ptr2 != '\0'; ptr2++) { 219 if (!isalnum(*ptr2) && *ptr2 != '_') { 220 *ptr2 = '\0'; 221 break; 222 } 223 } 224 225 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1); 226 if (ret < 0) 227 goto out; 228 229 *result = strdup(buf); 230 ret = *result ? 0 : -ENOMEM; 231 232 out: 233 free(exec_copy); 234 return ret; 235 } 236 237 static void clear_perf_probe_point(struct perf_probe_point *pp) 238 { 239 free(pp->file); 240 free(pp->function); 241 free(pp->lazy_line); 242 } 243 244 static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs) 245 { 246 int i; 247 248 for (i = 0; i < ntevs; i++) 249 clear_probe_trace_event(tevs + i); 250 } 251 252 static bool kprobe_blacklist__listed(unsigned long address); 253 static bool kprobe_warn_out_range(const char *symbol, unsigned long address) 254 { 255 u64 etext_addr = 0; 256 int ret; 257 258 /* Get the address of _etext for checking non-probable text symbol */ 259 ret = kernel_get_symbol_address_by_name("_etext", &etext_addr, 260 false, false); 261 262 if (ret == 0 && etext_addr < address) 263 pr_warning("%s is out of .text, skip it.\n", symbol); 264 else if (kprobe_blacklist__listed(address)) 265 pr_warning("%s is blacklisted function, skip it.\n", symbol); 266 else 267 return false; 268 269 return true; 270 } 271 272 /* 273 * @module can be module name of module file path. In case of path, 274 * inspect elf and find out what is actual module name. 275 * Caller has to free mod_name after using it. 276 */ 277 static char *find_module_name(const char *module) 278 { 279 int fd; 280 Elf *elf; 281 GElf_Ehdr ehdr; 282 GElf_Shdr shdr; 283 Elf_Data *data; 284 Elf_Scn *sec; 285 char *mod_name = NULL; 286 int name_offset; 287 288 fd = open(module, O_RDONLY); 289 if (fd < 0) 290 return NULL; 291 292 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL); 293 if (elf == NULL) 294 goto elf_err; 295 296 if (gelf_getehdr(elf, &ehdr) == NULL) 297 goto ret_err; 298 299 sec = elf_section_by_name(elf, &ehdr, &shdr, 300 ".gnu.linkonce.this_module", NULL); 301 if (!sec) 302 goto ret_err; 303 304 data = elf_getdata(sec, NULL); 305 if (!data || !data->d_buf) 306 goto ret_err; 307 308 /* 309 * NOTE: 310 * '.gnu.linkonce.this_module' section of kernel module elf directly 311 * maps to 'struct module' from linux/module.h. This section contains 312 * actual module name which will be used by kernel after loading it. 313 * But, we cannot use 'struct module' here since linux/module.h is not 314 * exposed to user-space. Offset of 'name' has remained same from long 315 * time, so hardcoding it here. 316 */ 317 if (ehdr.e_ident[EI_CLASS] == ELFCLASS32) 318 name_offset = 12; 319 else /* expect ELFCLASS64 by default */ 320 name_offset = 24; 321 322 mod_name = strdup((char *)data->d_buf + name_offset); 323 324 ret_err: 325 elf_end(elf); 326 elf_err: 327 close(fd); 328 return mod_name; 329 } 330 331 #ifdef HAVE_DWARF_SUPPORT 332 333 static int kernel_get_module_dso(const char *module, struct dso **pdso) 334 { 335 struct dso *dso; 336 struct map *map; 337 const char *vmlinux_name; 338 int ret = 0; 339 340 if (module) { 341 char module_name[128]; 342 343 snprintf(module_name, sizeof(module_name), "[%s]", module); 344 map = map_groups__find_by_name(&host_machine->kmaps, MAP__FUNCTION, module_name); 345 if (map) { 346 dso = map->dso; 347 goto found; 348 } 349 pr_debug("Failed to find module %s.\n", module); 350 return -ENOENT; 351 } 352 353 map = machine__kernel_map(host_machine); 354 dso = map->dso; 355 356 vmlinux_name = symbol_conf.vmlinux_name; 357 dso->load_errno = 0; 358 if (vmlinux_name) 359 ret = dso__load_vmlinux(dso, map, vmlinux_name, false); 360 else 361 ret = dso__load_vmlinux_path(dso, map); 362 found: 363 *pdso = dso; 364 return ret; 365 } 366 367 /* 368 * Some binaries like glibc have special symbols which are on the symbol 369 * table, but not in the debuginfo. If we can find the address of the 370 * symbol from map, we can translate the address back to the probe point. 371 */ 372 static int find_alternative_probe_point(struct debuginfo *dinfo, 373 struct perf_probe_point *pp, 374 struct perf_probe_point *result, 375 const char *target, struct nsinfo *nsi, 376 bool uprobes) 377 { 378 struct map *map = NULL; 379 struct symbol *sym; 380 u64 address = 0; 381 int ret = -ENOENT; 382 383 /* This can work only for function-name based one */ 384 if (!pp->function || pp->file) 385 return -ENOTSUP; 386 387 map = get_target_map(target, nsi, uprobes); 388 if (!map) 389 return -EINVAL; 390 391 /* Find the address of given function */ 392 map__for_each_symbol_by_name(map, pp->function, sym) { 393 if (uprobes) 394 address = sym->start; 395 else 396 address = map->unmap_ip(map, sym->start) - map->reloc; 397 break; 398 } 399 if (!address) { 400 ret = -ENOENT; 401 goto out; 402 } 403 pr_debug("Symbol %s address found : %" PRIx64 "\n", 404 pp->function, address); 405 406 ret = debuginfo__find_probe_point(dinfo, (unsigned long)address, 407 result); 408 if (ret <= 0) 409 ret = (!ret) ? -ENOENT : ret; 410 else { 411 result->offset += pp->offset; 412 result->line += pp->line; 413 result->retprobe = pp->retprobe; 414 ret = 0; 415 } 416 417 out: 418 map__put(map); 419 return ret; 420 421 } 422 423 static int get_alternative_probe_event(struct debuginfo *dinfo, 424 struct perf_probe_event *pev, 425 struct perf_probe_point *tmp) 426 { 427 int ret; 428 429 memcpy(tmp, &pev->point, sizeof(*tmp)); 430 memset(&pev->point, 0, sizeof(pev->point)); 431 ret = find_alternative_probe_point(dinfo, tmp, &pev->point, pev->target, 432 pev->nsi, pev->uprobes); 433 if (ret < 0) 434 memcpy(&pev->point, tmp, sizeof(*tmp)); 435 436 return ret; 437 } 438 439 static int get_alternative_line_range(struct debuginfo *dinfo, 440 struct line_range *lr, 441 const char *target, bool user) 442 { 443 struct perf_probe_point pp = { .function = lr->function, 444 .file = lr->file, 445 .line = lr->start }; 446 struct perf_probe_point result; 447 int ret, len = 0; 448 449 memset(&result, 0, sizeof(result)); 450 451 if (lr->end != INT_MAX) 452 len = lr->end - lr->start; 453 ret = find_alternative_probe_point(dinfo, &pp, &result, 454 target, NULL, user); 455 if (!ret) { 456 lr->function = result.function; 457 lr->file = result.file; 458 lr->start = result.line; 459 if (lr->end != INT_MAX) 460 lr->end = lr->start + len; 461 clear_perf_probe_point(&pp); 462 } 463 return ret; 464 } 465 466 /* Open new debuginfo of given module */ 467 static struct debuginfo *open_debuginfo(const char *module, struct nsinfo *nsi, 468 bool silent) 469 { 470 const char *path = module; 471 char reason[STRERR_BUFSIZE]; 472 struct debuginfo *ret = NULL; 473 struct dso *dso = NULL; 474 struct nscookie nsc; 475 int err; 476 477 if (!module || !strchr(module, '/')) { 478 err = kernel_get_module_dso(module, &dso); 479 if (err < 0) { 480 if (!dso || dso->load_errno == 0) { 481 if (!str_error_r(-err, reason, STRERR_BUFSIZE)) 482 strcpy(reason, "(unknown)"); 483 } else 484 dso__strerror_load(dso, reason, STRERR_BUFSIZE); 485 if (!silent) 486 pr_err("Failed to find the path for %s: %s\n", 487 module ?: "kernel", reason); 488 return NULL; 489 } 490 path = dso->long_name; 491 } 492 nsinfo__mountns_enter(nsi, &nsc); 493 ret = debuginfo__new(path); 494 if (!ret && !silent) { 495 pr_warning("The %s file has no debug information.\n", path); 496 if (!module || !strtailcmp(path, ".ko")) 497 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, "); 498 else 499 pr_warning("Rebuild with -g, "); 500 pr_warning("or install an appropriate debuginfo package.\n"); 501 } 502 nsinfo__mountns_exit(&nsc); 503 return ret; 504 } 505 506 /* For caching the last debuginfo */ 507 static struct debuginfo *debuginfo_cache; 508 static char *debuginfo_cache_path; 509 510 static struct debuginfo *debuginfo_cache__open(const char *module, bool silent) 511 { 512 const char *path = module; 513 514 /* If the module is NULL, it should be the kernel. */ 515 if (!module) 516 path = "kernel"; 517 518 if (debuginfo_cache_path && !strcmp(debuginfo_cache_path, path)) 519 goto out; 520 521 /* Copy module path */ 522 free(debuginfo_cache_path); 523 debuginfo_cache_path = strdup(path); 524 if (!debuginfo_cache_path) { 525 debuginfo__delete(debuginfo_cache); 526 debuginfo_cache = NULL; 527 goto out; 528 } 529 530 debuginfo_cache = open_debuginfo(module, NULL, silent); 531 if (!debuginfo_cache) 532 zfree(&debuginfo_cache_path); 533 out: 534 return debuginfo_cache; 535 } 536 537 static void debuginfo_cache__exit(void) 538 { 539 debuginfo__delete(debuginfo_cache); 540 debuginfo_cache = NULL; 541 zfree(&debuginfo_cache_path); 542 } 543 544 545 static int get_text_start_address(const char *exec, unsigned long *address, 546 struct nsinfo *nsi) 547 { 548 Elf *elf; 549 GElf_Ehdr ehdr; 550 GElf_Shdr shdr; 551 int fd, ret = -ENOENT; 552 struct nscookie nsc; 553 554 nsinfo__mountns_enter(nsi, &nsc); 555 fd = open(exec, O_RDONLY); 556 nsinfo__mountns_exit(&nsc); 557 if (fd < 0) 558 return -errno; 559 560 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL); 561 if (elf == NULL) { 562 ret = -EINVAL; 563 goto out_close; 564 } 565 566 if (gelf_getehdr(elf, &ehdr) == NULL) 567 goto out; 568 569 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL)) 570 goto out; 571 572 *address = shdr.sh_addr - shdr.sh_offset; 573 ret = 0; 574 out: 575 elf_end(elf); 576 out_close: 577 close(fd); 578 579 return ret; 580 } 581 582 /* 583 * Convert trace point to probe point with debuginfo 584 */ 585 static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp, 586 struct perf_probe_point *pp, 587 bool is_kprobe) 588 { 589 struct debuginfo *dinfo = NULL; 590 unsigned long stext = 0; 591 u64 addr = tp->address; 592 int ret = -ENOENT; 593 594 /* convert the address to dwarf address */ 595 if (!is_kprobe) { 596 if (!addr) { 597 ret = -EINVAL; 598 goto error; 599 } 600 ret = get_text_start_address(tp->module, &stext, NULL); 601 if (ret < 0) 602 goto error; 603 addr += stext; 604 } else if (tp->symbol) { 605 /* If the module is given, this returns relative address */ 606 ret = kernel_get_symbol_address_by_name(tp->symbol, &addr, 607 false, !!tp->module); 608 if (ret != 0) 609 goto error; 610 addr += tp->offset; 611 } 612 613 pr_debug("try to find information at %" PRIx64 " in %s\n", addr, 614 tp->module ? : "kernel"); 615 616 dinfo = debuginfo_cache__open(tp->module, verbose <= 0); 617 if (dinfo) 618 ret = debuginfo__find_probe_point(dinfo, 619 (unsigned long)addr, pp); 620 else 621 ret = -ENOENT; 622 623 if (ret > 0) { 624 pp->retprobe = tp->retprobe; 625 return 0; 626 } 627 error: 628 pr_debug("Failed to find corresponding probes from debuginfo.\n"); 629 return ret ? : -ENOENT; 630 } 631 632 /* Adjust symbol name and address */ 633 static int post_process_probe_trace_point(struct probe_trace_point *tp, 634 struct map *map, unsigned long offs) 635 { 636 struct symbol *sym; 637 u64 addr = tp->address - offs; 638 639 sym = map__find_symbol(map, addr); 640 if (!sym) 641 return -ENOENT; 642 643 if (strcmp(sym->name, tp->symbol)) { 644 /* If we have no realname, use symbol for it */ 645 if (!tp->realname) 646 tp->realname = tp->symbol; 647 else 648 free(tp->symbol); 649 tp->symbol = strdup(sym->name); 650 if (!tp->symbol) 651 return -ENOMEM; 652 } 653 tp->offset = addr - sym->start; 654 tp->address -= offs; 655 656 return 0; 657 } 658 659 /* 660 * Rename DWARF symbols to ELF symbols -- gcc sometimes optimizes functions 661 * and generate new symbols with suffixes such as .constprop.N or .isra.N 662 * etc. Since those symbols are not recorded in DWARF, we have to find 663 * correct generated symbols from offline ELF binary. 664 * For online kernel or uprobes we don't need this because those are 665 * rebased on _text, or already a section relative address. 666 */ 667 static int 668 post_process_offline_probe_trace_events(struct probe_trace_event *tevs, 669 int ntevs, const char *pathname) 670 { 671 struct map *map; 672 unsigned long stext = 0; 673 int i, ret = 0; 674 675 /* Prepare a map for offline binary */ 676 map = dso__new_map(pathname); 677 if (!map || get_text_start_address(pathname, &stext, NULL) < 0) { 678 pr_warning("Failed to get ELF symbols for %s\n", pathname); 679 return -EINVAL; 680 } 681 682 for (i = 0; i < ntevs; i++) { 683 ret = post_process_probe_trace_point(&tevs[i].point, 684 map, stext); 685 if (ret < 0) 686 break; 687 } 688 map__put(map); 689 690 return ret; 691 } 692 693 static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs, 694 int ntevs, const char *exec, 695 struct nsinfo *nsi) 696 { 697 int i, ret = 0; 698 unsigned long stext = 0; 699 700 if (!exec) 701 return 0; 702 703 ret = get_text_start_address(exec, &stext, nsi); 704 if (ret < 0) 705 return ret; 706 707 for (i = 0; i < ntevs && ret >= 0; i++) { 708 /* point.address is the addres of point.symbol + point.offset */ 709 tevs[i].point.address -= stext; 710 tevs[i].point.module = strdup(exec); 711 if (!tevs[i].point.module) { 712 ret = -ENOMEM; 713 break; 714 } 715 tevs[i].uprobes = true; 716 } 717 718 return ret; 719 } 720 721 static int 722 post_process_module_probe_trace_events(struct probe_trace_event *tevs, 723 int ntevs, const char *module, 724 struct debuginfo *dinfo) 725 { 726 Dwarf_Addr text_offs = 0; 727 int i, ret = 0; 728 char *mod_name = NULL; 729 struct map *map; 730 731 if (!module) 732 return 0; 733 734 map = get_target_map(module, NULL, false); 735 if (!map || debuginfo__get_text_offset(dinfo, &text_offs, true) < 0) { 736 pr_warning("Failed to get ELF symbols for %s\n", module); 737 return -EINVAL; 738 } 739 740 mod_name = find_module_name(module); 741 for (i = 0; i < ntevs; i++) { 742 ret = post_process_probe_trace_point(&tevs[i].point, 743 map, (unsigned long)text_offs); 744 if (ret < 0) 745 break; 746 tevs[i].point.module = 747 strdup(mod_name ? mod_name : module); 748 if (!tevs[i].point.module) { 749 ret = -ENOMEM; 750 break; 751 } 752 } 753 754 free(mod_name); 755 map__put(map); 756 757 return ret; 758 } 759 760 static int 761 post_process_kernel_probe_trace_events(struct probe_trace_event *tevs, 762 int ntevs) 763 { 764 struct ref_reloc_sym *reloc_sym; 765 char *tmp; 766 int i, skipped = 0; 767 768 /* Skip post process if the target is an offline kernel */ 769 if (symbol_conf.ignore_vmlinux_buildid) 770 return post_process_offline_probe_trace_events(tevs, ntevs, 771 symbol_conf.vmlinux_name); 772 773 reloc_sym = kernel_get_ref_reloc_sym(); 774 if (!reloc_sym) { 775 pr_warning("Relocated base symbol is not found!\n"); 776 return -EINVAL; 777 } 778 779 for (i = 0; i < ntevs; i++) { 780 if (!tevs[i].point.address) 781 continue; 782 if (tevs[i].point.retprobe && !kretprobe_offset_is_supported()) 783 continue; 784 /* If we found a wrong one, mark it by NULL symbol */ 785 if (kprobe_warn_out_range(tevs[i].point.symbol, 786 tevs[i].point.address)) { 787 tmp = NULL; 788 skipped++; 789 } else { 790 tmp = strdup(reloc_sym->name); 791 if (!tmp) 792 return -ENOMEM; 793 } 794 /* If we have no realname, use symbol for it */ 795 if (!tevs[i].point.realname) 796 tevs[i].point.realname = tevs[i].point.symbol; 797 else 798 free(tevs[i].point.symbol); 799 tevs[i].point.symbol = tmp; 800 tevs[i].point.offset = tevs[i].point.address - 801 reloc_sym->unrelocated_addr; 802 } 803 return skipped; 804 } 805 806 void __weak 807 arch__post_process_probe_trace_events(struct perf_probe_event *pev __maybe_unused, 808 int ntevs __maybe_unused) 809 { 810 } 811 812 /* Post processing the probe events */ 813 static int post_process_probe_trace_events(struct perf_probe_event *pev, 814 struct probe_trace_event *tevs, 815 int ntevs, const char *module, 816 bool uprobe, struct debuginfo *dinfo) 817 { 818 int ret; 819 820 if (uprobe) 821 ret = add_exec_to_probe_trace_events(tevs, ntevs, module, 822 pev->nsi); 823 else if (module) 824 /* Currently ref_reloc_sym based probe is not for drivers */ 825 ret = post_process_module_probe_trace_events(tevs, ntevs, 826 module, dinfo); 827 else 828 ret = post_process_kernel_probe_trace_events(tevs, ntevs); 829 830 if (ret >= 0) 831 arch__post_process_probe_trace_events(pev, ntevs); 832 833 return ret; 834 } 835 836 /* Try to find perf_probe_event with debuginfo */ 837 static int try_to_find_probe_trace_events(struct perf_probe_event *pev, 838 struct probe_trace_event **tevs) 839 { 840 bool need_dwarf = perf_probe_event_need_dwarf(pev); 841 struct perf_probe_point tmp; 842 struct debuginfo *dinfo; 843 int ntevs, ret = 0; 844 845 dinfo = open_debuginfo(pev->target, pev->nsi, !need_dwarf); 846 if (!dinfo) { 847 if (need_dwarf) 848 return -ENOENT; 849 pr_debug("Could not open debuginfo. Try to use symbols.\n"); 850 return 0; 851 } 852 853 pr_debug("Try to find probe point from debuginfo.\n"); 854 /* Searching trace events corresponding to a probe event */ 855 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs); 856 857 if (ntevs == 0) { /* Not found, retry with an alternative */ 858 ret = get_alternative_probe_event(dinfo, pev, &tmp); 859 if (!ret) { 860 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs); 861 /* 862 * Write back to the original probe_event for 863 * setting appropriate (user given) event name 864 */ 865 clear_perf_probe_point(&pev->point); 866 memcpy(&pev->point, &tmp, sizeof(tmp)); 867 } 868 } 869 870 if (ntevs > 0) { /* Succeeded to find trace events */ 871 pr_debug("Found %d probe_trace_events.\n", ntevs); 872 ret = post_process_probe_trace_events(pev, *tevs, ntevs, 873 pev->target, pev->uprobes, dinfo); 874 if (ret < 0 || ret == ntevs) { 875 pr_debug("Post processing failed or all events are skipped. (%d)\n", ret); 876 clear_probe_trace_events(*tevs, ntevs); 877 zfree(tevs); 878 ntevs = 0; 879 } 880 } 881 882 debuginfo__delete(dinfo); 883 884 if (ntevs == 0) { /* No error but failed to find probe point. */ 885 pr_warning("Probe point '%s' not found.\n", 886 synthesize_perf_probe_point(&pev->point)); 887 return -ENOENT; 888 } else if (ntevs < 0) { 889 /* Error path : ntevs < 0 */ 890 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs); 891 if (ntevs == -EBADF) 892 pr_warning("Warning: No dwarf info found in the vmlinux - " 893 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n"); 894 if (!need_dwarf) { 895 pr_debug("Trying to use symbols.\n"); 896 return 0; 897 } 898 } 899 return ntevs; 900 } 901 902 #define LINEBUF_SIZE 256 903 #define NR_ADDITIONAL_LINES 2 904 905 static int __show_one_line(FILE *fp, int l, bool skip, bool show_num) 906 { 907 char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE]; 908 const char *color = show_num ? "" : PERF_COLOR_BLUE; 909 const char *prefix = NULL; 910 911 do { 912 if (fgets(buf, LINEBUF_SIZE, fp) == NULL) 913 goto error; 914 if (skip) 915 continue; 916 if (!prefix) { 917 prefix = show_num ? "%7d " : " "; 918 color_fprintf(stdout, color, prefix, l); 919 } 920 color_fprintf(stdout, color, "%s", buf); 921 922 } while (strchr(buf, '\n') == NULL); 923 924 return 1; 925 error: 926 if (ferror(fp)) { 927 pr_warning("File read error: %s\n", 928 str_error_r(errno, sbuf, sizeof(sbuf))); 929 return -1; 930 } 931 return 0; 932 } 933 934 static int _show_one_line(FILE *fp, int l, bool skip, bool show_num) 935 { 936 int rv = __show_one_line(fp, l, skip, show_num); 937 if (rv == 0) { 938 pr_warning("Source file is shorter than expected.\n"); 939 rv = -1; 940 } 941 return rv; 942 } 943 944 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true) 945 #define show_one_line(f,l) _show_one_line(f,l,false,false) 946 #define skip_one_line(f,l) _show_one_line(f,l,true,false) 947 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false) 948 949 /* 950 * Show line-range always requires debuginfo to find source file and 951 * line number. 952 */ 953 static int __show_line_range(struct line_range *lr, const char *module, 954 bool user) 955 { 956 int l = 1; 957 struct int_node *ln; 958 struct debuginfo *dinfo; 959 FILE *fp; 960 int ret; 961 char *tmp; 962 char sbuf[STRERR_BUFSIZE]; 963 964 /* Search a line range */ 965 dinfo = open_debuginfo(module, NULL, false); 966 if (!dinfo) 967 return -ENOENT; 968 969 ret = debuginfo__find_line_range(dinfo, lr); 970 if (!ret) { /* Not found, retry with an alternative */ 971 ret = get_alternative_line_range(dinfo, lr, module, user); 972 if (!ret) 973 ret = debuginfo__find_line_range(dinfo, lr); 974 } 975 debuginfo__delete(dinfo); 976 if (ret == 0 || ret == -ENOENT) { 977 pr_warning("Specified source line is not found.\n"); 978 return -ENOENT; 979 } else if (ret < 0) { 980 pr_warning("Debuginfo analysis failed.\n"); 981 return ret; 982 } 983 984 /* Convert source file path */ 985 tmp = lr->path; 986 ret = get_real_path(tmp, lr->comp_dir, &lr->path); 987 988 /* Free old path when new path is assigned */ 989 if (tmp != lr->path) 990 free(tmp); 991 992 if (ret < 0) { 993 pr_warning("Failed to find source file path.\n"); 994 return ret; 995 } 996 997 setup_pager(); 998 999 if (lr->function) 1000 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path, 1001 lr->start - lr->offset); 1002 else 1003 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start); 1004 1005 fp = fopen(lr->path, "r"); 1006 if (fp == NULL) { 1007 pr_warning("Failed to open %s: %s\n", lr->path, 1008 str_error_r(errno, sbuf, sizeof(sbuf))); 1009 return -errno; 1010 } 1011 /* Skip to starting line number */ 1012 while (l < lr->start) { 1013 ret = skip_one_line(fp, l++); 1014 if (ret < 0) 1015 goto end; 1016 } 1017 1018 intlist__for_each_entry(ln, lr->line_list) { 1019 for (; ln->i > l; l++) { 1020 ret = show_one_line(fp, l - lr->offset); 1021 if (ret < 0) 1022 goto end; 1023 } 1024 ret = show_one_line_with_num(fp, l++ - lr->offset); 1025 if (ret < 0) 1026 goto end; 1027 } 1028 1029 if (lr->end == INT_MAX) 1030 lr->end = l + NR_ADDITIONAL_LINES; 1031 while (l <= lr->end) { 1032 ret = show_one_line_or_eof(fp, l++ - lr->offset); 1033 if (ret <= 0) 1034 break; 1035 } 1036 end: 1037 fclose(fp); 1038 return ret; 1039 } 1040 1041 int show_line_range(struct line_range *lr, const char *module, 1042 struct nsinfo *nsi, bool user) 1043 { 1044 int ret; 1045 struct nscookie nsc; 1046 1047 ret = init_probe_symbol_maps(user); 1048 if (ret < 0) 1049 return ret; 1050 nsinfo__mountns_enter(nsi, &nsc); 1051 ret = __show_line_range(lr, module, user); 1052 nsinfo__mountns_exit(&nsc); 1053 exit_probe_symbol_maps(); 1054 1055 return ret; 1056 } 1057 1058 static int show_available_vars_at(struct debuginfo *dinfo, 1059 struct perf_probe_event *pev, 1060 struct strfilter *_filter) 1061 { 1062 char *buf; 1063 int ret, i, nvars; 1064 struct str_node *node; 1065 struct variable_list *vls = NULL, *vl; 1066 struct perf_probe_point tmp; 1067 const char *var; 1068 1069 buf = synthesize_perf_probe_point(&pev->point); 1070 if (!buf) 1071 return -EINVAL; 1072 pr_debug("Searching variables at %s\n", buf); 1073 1074 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls); 1075 if (!ret) { /* Not found, retry with an alternative */ 1076 ret = get_alternative_probe_event(dinfo, pev, &tmp); 1077 if (!ret) { 1078 ret = debuginfo__find_available_vars_at(dinfo, pev, 1079 &vls); 1080 /* Release the old probe_point */ 1081 clear_perf_probe_point(&tmp); 1082 } 1083 } 1084 if (ret <= 0) { 1085 if (ret == 0 || ret == -ENOENT) { 1086 pr_err("Failed to find the address of %s\n", buf); 1087 ret = -ENOENT; 1088 } else 1089 pr_warning("Debuginfo analysis failed.\n"); 1090 goto end; 1091 } 1092 1093 /* Some variables are found */ 1094 fprintf(stdout, "Available variables at %s\n", buf); 1095 for (i = 0; i < ret; i++) { 1096 vl = &vls[i]; 1097 /* 1098 * A probe point might be converted to 1099 * several trace points. 1100 */ 1101 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol, 1102 vl->point.offset); 1103 zfree(&vl->point.symbol); 1104 nvars = 0; 1105 if (vl->vars) { 1106 strlist__for_each_entry(node, vl->vars) { 1107 var = strchr(node->s, '\t') + 1; 1108 if (strfilter__compare(_filter, var)) { 1109 fprintf(stdout, "\t\t%s\n", node->s); 1110 nvars++; 1111 } 1112 } 1113 strlist__delete(vl->vars); 1114 } 1115 if (nvars == 0) 1116 fprintf(stdout, "\t\t(No matched variables)\n"); 1117 } 1118 free(vls); 1119 end: 1120 free(buf); 1121 return ret; 1122 } 1123 1124 /* Show available variables on given probe point */ 1125 int show_available_vars(struct perf_probe_event *pevs, int npevs, 1126 struct strfilter *_filter) 1127 { 1128 int i, ret = 0; 1129 struct debuginfo *dinfo; 1130 1131 ret = init_probe_symbol_maps(pevs->uprobes); 1132 if (ret < 0) 1133 return ret; 1134 1135 dinfo = open_debuginfo(pevs->target, pevs->nsi, false); 1136 if (!dinfo) { 1137 ret = -ENOENT; 1138 goto out; 1139 } 1140 1141 setup_pager(); 1142 1143 for (i = 0; i < npevs && ret >= 0; i++) 1144 ret = show_available_vars_at(dinfo, &pevs[i], _filter); 1145 1146 debuginfo__delete(dinfo); 1147 out: 1148 exit_probe_symbol_maps(); 1149 return ret; 1150 } 1151 1152 #else /* !HAVE_DWARF_SUPPORT */ 1153 1154 static void debuginfo_cache__exit(void) 1155 { 1156 } 1157 1158 static int 1159 find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused, 1160 struct perf_probe_point *pp __maybe_unused, 1161 bool is_kprobe __maybe_unused) 1162 { 1163 return -ENOSYS; 1164 } 1165 1166 static int try_to_find_probe_trace_events(struct perf_probe_event *pev, 1167 struct probe_trace_event **tevs __maybe_unused) 1168 { 1169 if (perf_probe_event_need_dwarf(pev)) { 1170 pr_warning("Debuginfo-analysis is not supported.\n"); 1171 return -ENOSYS; 1172 } 1173 1174 return 0; 1175 } 1176 1177 int show_line_range(struct line_range *lr __maybe_unused, 1178 const char *module __maybe_unused, 1179 struct nsinfo *nsi __maybe_unused, 1180 bool user __maybe_unused) 1181 { 1182 pr_warning("Debuginfo-analysis is not supported.\n"); 1183 return -ENOSYS; 1184 } 1185 1186 int show_available_vars(struct perf_probe_event *pevs __maybe_unused, 1187 int npevs __maybe_unused, 1188 struct strfilter *filter __maybe_unused) 1189 { 1190 pr_warning("Debuginfo-analysis is not supported.\n"); 1191 return -ENOSYS; 1192 } 1193 #endif 1194 1195 void line_range__clear(struct line_range *lr) 1196 { 1197 free(lr->function); 1198 free(lr->file); 1199 free(lr->path); 1200 free(lr->comp_dir); 1201 intlist__delete(lr->line_list); 1202 memset(lr, 0, sizeof(*lr)); 1203 } 1204 1205 int line_range__init(struct line_range *lr) 1206 { 1207 memset(lr, 0, sizeof(*lr)); 1208 lr->line_list = intlist__new(NULL); 1209 if (!lr->line_list) 1210 return -ENOMEM; 1211 else 1212 return 0; 1213 } 1214 1215 static int parse_line_num(char **ptr, int *val, const char *what) 1216 { 1217 const char *start = *ptr; 1218 1219 errno = 0; 1220 *val = strtol(*ptr, ptr, 0); 1221 if (errno || *ptr == start) { 1222 semantic_error("'%s' is not a valid number.\n", what); 1223 return -EINVAL; 1224 } 1225 return 0; 1226 } 1227 1228 /* Check the name is good for event, group or function */ 1229 static bool is_c_func_name(const char *name) 1230 { 1231 if (!isalpha(*name) && *name != '_') 1232 return false; 1233 while (*++name != '\0') { 1234 if (!isalpha(*name) && !isdigit(*name) && *name != '_') 1235 return false; 1236 } 1237 return true; 1238 } 1239 1240 /* 1241 * Stuff 'lr' according to the line range described by 'arg'. 1242 * The line range syntax is described by: 1243 * 1244 * SRC[:SLN[+NUM|-ELN]] 1245 * FNC[@SRC][:SLN[+NUM|-ELN]] 1246 */ 1247 int parse_line_range_desc(const char *arg, struct line_range *lr) 1248 { 1249 char *range, *file, *name = strdup(arg); 1250 int err; 1251 1252 if (!name) 1253 return -ENOMEM; 1254 1255 lr->start = 0; 1256 lr->end = INT_MAX; 1257 1258 range = strchr(name, ':'); 1259 if (range) { 1260 *range++ = '\0'; 1261 1262 err = parse_line_num(&range, &lr->start, "start line"); 1263 if (err) 1264 goto err; 1265 1266 if (*range == '+' || *range == '-') { 1267 const char c = *range++; 1268 1269 err = parse_line_num(&range, &lr->end, "end line"); 1270 if (err) 1271 goto err; 1272 1273 if (c == '+') { 1274 lr->end += lr->start; 1275 /* 1276 * Adjust the number of lines here. 1277 * If the number of lines == 1, the 1278 * the end of line should be equal to 1279 * the start of line. 1280 */ 1281 lr->end--; 1282 } 1283 } 1284 1285 pr_debug("Line range is %d to %d\n", lr->start, lr->end); 1286 1287 err = -EINVAL; 1288 if (lr->start > lr->end) { 1289 semantic_error("Start line must be smaller" 1290 " than end line.\n"); 1291 goto err; 1292 } 1293 if (*range != '\0') { 1294 semantic_error("Tailing with invalid str '%s'.\n", range); 1295 goto err; 1296 } 1297 } 1298 1299 file = strchr(name, '@'); 1300 if (file) { 1301 *file = '\0'; 1302 lr->file = strdup(++file); 1303 if (lr->file == NULL) { 1304 err = -ENOMEM; 1305 goto err; 1306 } 1307 lr->function = name; 1308 } else if (strchr(name, '/') || strchr(name, '.')) 1309 lr->file = name; 1310 else if (is_c_func_name(name))/* We reuse it for checking funcname */ 1311 lr->function = name; 1312 else { /* Invalid name */ 1313 semantic_error("'%s' is not a valid function name.\n", name); 1314 err = -EINVAL; 1315 goto err; 1316 } 1317 1318 return 0; 1319 err: 1320 free(name); 1321 return err; 1322 } 1323 1324 static int parse_perf_probe_event_name(char **arg, struct perf_probe_event *pev) 1325 { 1326 char *ptr; 1327 1328 ptr = strchr(*arg, ':'); 1329 if (ptr) { 1330 *ptr = '\0'; 1331 if (!pev->sdt && !is_c_func_name(*arg)) 1332 goto ng_name; 1333 pev->group = strdup(*arg); 1334 if (!pev->group) 1335 return -ENOMEM; 1336 *arg = ptr + 1; 1337 } else 1338 pev->group = NULL; 1339 if (!pev->sdt && !is_c_func_name(*arg)) { 1340 ng_name: 1341 semantic_error("%s is bad for event name -it must " 1342 "follow C symbol-naming rule.\n", *arg); 1343 return -EINVAL; 1344 } 1345 pev->event = strdup(*arg); 1346 if (pev->event == NULL) 1347 return -ENOMEM; 1348 1349 return 0; 1350 } 1351 1352 /* Parse probepoint definition. */ 1353 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev) 1354 { 1355 struct perf_probe_point *pp = &pev->point; 1356 char *ptr, *tmp; 1357 char c, nc = 0; 1358 bool file_spec = false; 1359 int ret; 1360 1361 /* 1362 * <Syntax> 1363 * perf probe [GRP:][EVENT=]SRC[:LN|;PTN] 1364 * perf probe [GRP:][EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT] 1365 * perf probe %[GRP:]SDT_EVENT 1366 */ 1367 if (!arg) 1368 return -EINVAL; 1369 1370 if (is_sdt_event(arg)) { 1371 pev->sdt = true; 1372 if (arg[0] == '%') 1373 arg++; 1374 } 1375 1376 ptr = strpbrk(arg, ";=@+%"); 1377 if (pev->sdt) { 1378 if (ptr) { 1379 if (*ptr != '@') { 1380 semantic_error("%s must be an SDT name.\n", 1381 arg); 1382 return -EINVAL; 1383 } 1384 /* This must be a target file name or build id */ 1385 tmp = build_id_cache__complement(ptr + 1); 1386 if (tmp) { 1387 pev->target = build_id_cache__origname(tmp); 1388 free(tmp); 1389 } else 1390 pev->target = strdup(ptr + 1); 1391 if (!pev->target) 1392 return -ENOMEM; 1393 *ptr = '\0'; 1394 } 1395 ret = parse_perf_probe_event_name(&arg, pev); 1396 if (ret == 0) { 1397 if (asprintf(&pev->point.function, "%%%s", pev->event) < 0) 1398 ret = -errno; 1399 } 1400 return ret; 1401 } 1402 1403 if (ptr && *ptr == '=') { /* Event name */ 1404 *ptr = '\0'; 1405 tmp = ptr + 1; 1406 ret = parse_perf_probe_event_name(&arg, pev); 1407 if (ret < 0) 1408 return ret; 1409 1410 arg = tmp; 1411 } 1412 1413 /* 1414 * Check arg is function or file name and copy it. 1415 * 1416 * We consider arg to be a file spec if and only if it satisfies 1417 * all of the below criteria:: 1418 * - it does not include any of "+@%", 1419 * - it includes one of ":;", and 1420 * - it has a period '.' in the name. 1421 * 1422 * Otherwise, we consider arg to be a function specification. 1423 */ 1424 if (!strpbrk(arg, "+@%") && (ptr = strpbrk(arg, ";:")) != NULL) { 1425 /* This is a file spec if it includes a '.' before ; or : */ 1426 if (memchr(arg, '.', ptr - arg)) 1427 file_spec = true; 1428 } 1429 1430 ptr = strpbrk(arg, ";:+@%"); 1431 if (ptr) { 1432 nc = *ptr; 1433 *ptr++ = '\0'; 1434 } 1435 1436 if (arg[0] == '\0') 1437 tmp = NULL; 1438 else { 1439 tmp = strdup(arg); 1440 if (tmp == NULL) 1441 return -ENOMEM; 1442 } 1443 1444 if (file_spec) 1445 pp->file = tmp; 1446 else { 1447 pp->function = tmp; 1448 1449 /* 1450 * Keep pp->function even if this is absolute address, 1451 * so it can mark whether abs_address is valid. 1452 * Which make 'perf probe lib.bin 0x0' possible. 1453 * 1454 * Note that checking length of tmp is not needed 1455 * because when we access tmp[1] we know tmp[0] is '0', 1456 * so tmp[1] should always valid (but could be '\0'). 1457 */ 1458 if (tmp && !strncmp(tmp, "0x", 2)) { 1459 pp->abs_address = strtoul(pp->function, &tmp, 0); 1460 if (*tmp != '\0') { 1461 semantic_error("Invalid absolute address.\n"); 1462 return -EINVAL; 1463 } 1464 } 1465 } 1466 1467 /* Parse other options */ 1468 while (ptr) { 1469 arg = ptr; 1470 c = nc; 1471 if (c == ';') { /* Lazy pattern must be the last part */ 1472 pp->lazy_line = strdup(arg); 1473 if (pp->lazy_line == NULL) 1474 return -ENOMEM; 1475 break; 1476 } 1477 ptr = strpbrk(arg, ";:+@%"); 1478 if (ptr) { 1479 nc = *ptr; 1480 *ptr++ = '\0'; 1481 } 1482 switch (c) { 1483 case ':': /* Line number */ 1484 pp->line = strtoul(arg, &tmp, 0); 1485 if (*tmp != '\0') { 1486 semantic_error("There is non-digit char" 1487 " in line number.\n"); 1488 return -EINVAL; 1489 } 1490 break; 1491 case '+': /* Byte offset from a symbol */ 1492 pp->offset = strtoul(arg, &tmp, 0); 1493 if (*tmp != '\0') { 1494 semantic_error("There is non-digit character" 1495 " in offset.\n"); 1496 return -EINVAL; 1497 } 1498 break; 1499 case '@': /* File name */ 1500 if (pp->file) { 1501 semantic_error("SRC@SRC is not allowed.\n"); 1502 return -EINVAL; 1503 } 1504 pp->file = strdup(arg); 1505 if (pp->file == NULL) 1506 return -ENOMEM; 1507 break; 1508 case '%': /* Probe places */ 1509 if (strcmp(arg, "return") == 0) { 1510 pp->retprobe = 1; 1511 } else { /* Others not supported yet */ 1512 semantic_error("%%%s is not supported.\n", arg); 1513 return -ENOTSUP; 1514 } 1515 break; 1516 default: /* Buggy case */ 1517 pr_err("This program has a bug at %s:%d.\n", 1518 __FILE__, __LINE__); 1519 return -ENOTSUP; 1520 break; 1521 } 1522 } 1523 1524 /* Exclusion check */ 1525 if (pp->lazy_line && pp->line) { 1526 semantic_error("Lazy pattern can't be used with" 1527 " line number.\n"); 1528 return -EINVAL; 1529 } 1530 1531 if (pp->lazy_line && pp->offset) { 1532 semantic_error("Lazy pattern can't be used with offset.\n"); 1533 return -EINVAL; 1534 } 1535 1536 if (pp->line && pp->offset) { 1537 semantic_error("Offset can't be used with line number.\n"); 1538 return -EINVAL; 1539 } 1540 1541 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) { 1542 semantic_error("File always requires line number or " 1543 "lazy pattern.\n"); 1544 return -EINVAL; 1545 } 1546 1547 if (pp->offset && !pp->function) { 1548 semantic_error("Offset requires an entry function.\n"); 1549 return -EINVAL; 1550 } 1551 1552 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) { 1553 semantic_error("Offset/Line/Lazy pattern can't be used with " 1554 "return probe.\n"); 1555 return -EINVAL; 1556 } 1557 1558 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n", 1559 pp->function, pp->file, pp->line, pp->offset, pp->retprobe, 1560 pp->lazy_line); 1561 return 0; 1562 } 1563 1564 /* Parse perf-probe event argument */ 1565 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg) 1566 { 1567 char *tmp, *goodname; 1568 struct perf_probe_arg_field **fieldp; 1569 1570 pr_debug("parsing arg: %s into ", str); 1571 1572 tmp = strchr(str, '='); 1573 if (tmp) { 1574 arg->name = strndup(str, tmp - str); 1575 if (arg->name == NULL) 1576 return -ENOMEM; 1577 pr_debug("name:%s ", arg->name); 1578 str = tmp + 1; 1579 } 1580 1581 tmp = strchr(str, ':'); 1582 if (tmp) { /* Type setting */ 1583 *tmp = '\0'; 1584 arg->type = strdup(tmp + 1); 1585 if (arg->type == NULL) 1586 return -ENOMEM; 1587 pr_debug("type:%s ", arg->type); 1588 } 1589 1590 tmp = strpbrk(str, "-.["); 1591 if (!is_c_varname(str) || !tmp) { 1592 /* A variable, register, symbol or special value */ 1593 arg->var = strdup(str); 1594 if (arg->var == NULL) 1595 return -ENOMEM; 1596 pr_debug("%s\n", arg->var); 1597 return 0; 1598 } 1599 1600 /* Structure fields or array element */ 1601 arg->var = strndup(str, tmp - str); 1602 if (arg->var == NULL) 1603 return -ENOMEM; 1604 goodname = arg->var; 1605 pr_debug("%s, ", arg->var); 1606 fieldp = &arg->field; 1607 1608 do { 1609 *fieldp = zalloc(sizeof(struct perf_probe_arg_field)); 1610 if (*fieldp == NULL) 1611 return -ENOMEM; 1612 if (*tmp == '[') { /* Array */ 1613 str = tmp; 1614 (*fieldp)->index = strtol(str + 1, &tmp, 0); 1615 (*fieldp)->ref = true; 1616 if (*tmp != ']' || tmp == str + 1) { 1617 semantic_error("Array index must be a" 1618 " number.\n"); 1619 return -EINVAL; 1620 } 1621 tmp++; 1622 if (*tmp == '\0') 1623 tmp = NULL; 1624 } else { /* Structure */ 1625 if (*tmp == '.') { 1626 str = tmp + 1; 1627 (*fieldp)->ref = false; 1628 } else if (tmp[1] == '>') { 1629 str = tmp + 2; 1630 (*fieldp)->ref = true; 1631 } else { 1632 semantic_error("Argument parse error: %s\n", 1633 str); 1634 return -EINVAL; 1635 } 1636 tmp = strpbrk(str, "-.["); 1637 } 1638 if (tmp) { 1639 (*fieldp)->name = strndup(str, tmp - str); 1640 if ((*fieldp)->name == NULL) 1641 return -ENOMEM; 1642 if (*str != '[') 1643 goodname = (*fieldp)->name; 1644 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref); 1645 fieldp = &(*fieldp)->next; 1646 } 1647 } while (tmp); 1648 (*fieldp)->name = strdup(str); 1649 if ((*fieldp)->name == NULL) 1650 return -ENOMEM; 1651 if (*str != '[') 1652 goodname = (*fieldp)->name; 1653 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref); 1654 1655 /* If no name is specified, set the last field name (not array index)*/ 1656 if (!arg->name) { 1657 arg->name = strdup(goodname); 1658 if (arg->name == NULL) 1659 return -ENOMEM; 1660 } 1661 return 0; 1662 } 1663 1664 /* Parse perf-probe event command */ 1665 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev) 1666 { 1667 char **argv; 1668 int argc, i, ret = 0; 1669 1670 argv = argv_split(cmd, &argc); 1671 if (!argv) { 1672 pr_debug("Failed to split arguments.\n"); 1673 return -ENOMEM; 1674 } 1675 if (argc - 1 > MAX_PROBE_ARGS) { 1676 semantic_error("Too many probe arguments (%d).\n", argc - 1); 1677 ret = -ERANGE; 1678 goto out; 1679 } 1680 /* Parse probe point */ 1681 ret = parse_perf_probe_point(argv[0], pev); 1682 if (ret < 0) 1683 goto out; 1684 1685 /* Copy arguments and ensure return probe has no C argument */ 1686 pev->nargs = argc - 1; 1687 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs); 1688 if (pev->args == NULL) { 1689 ret = -ENOMEM; 1690 goto out; 1691 } 1692 for (i = 0; i < pev->nargs && ret >= 0; i++) { 1693 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]); 1694 if (ret >= 0 && 1695 is_c_varname(pev->args[i].var) && pev->point.retprobe) { 1696 semantic_error("You can't specify local variable for" 1697 " kretprobe.\n"); 1698 ret = -EINVAL; 1699 } 1700 } 1701 out: 1702 argv_free(argv); 1703 1704 return ret; 1705 } 1706 1707 /* Returns true if *any* ARG is either C variable, $params or $vars. */ 1708 bool perf_probe_with_var(struct perf_probe_event *pev) 1709 { 1710 int i = 0; 1711 1712 for (i = 0; i < pev->nargs; i++) 1713 if (is_c_varname(pev->args[i].var) || 1714 !strcmp(pev->args[i].var, PROBE_ARG_PARAMS) || 1715 !strcmp(pev->args[i].var, PROBE_ARG_VARS)) 1716 return true; 1717 return false; 1718 } 1719 1720 /* Return true if this perf_probe_event requires debuginfo */ 1721 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev) 1722 { 1723 if (pev->point.file || pev->point.line || pev->point.lazy_line) 1724 return true; 1725 1726 if (perf_probe_with_var(pev)) 1727 return true; 1728 1729 return false; 1730 } 1731 1732 /* Parse probe_events event into struct probe_point */ 1733 int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev) 1734 { 1735 struct probe_trace_point *tp = &tev->point; 1736 char pr; 1737 char *p; 1738 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str; 1739 int ret, i, argc; 1740 char **argv; 1741 1742 pr_debug("Parsing probe_events: %s\n", cmd); 1743 argv = argv_split(cmd, &argc); 1744 if (!argv) { 1745 pr_debug("Failed to split arguments.\n"); 1746 return -ENOMEM; 1747 } 1748 if (argc < 2) { 1749 semantic_error("Too few probe arguments.\n"); 1750 ret = -ERANGE; 1751 goto out; 1752 } 1753 1754 /* Scan event and group name. */ 1755 argv0_str = strdup(argv[0]); 1756 if (argv0_str == NULL) { 1757 ret = -ENOMEM; 1758 goto out; 1759 } 1760 fmt1_str = strtok_r(argv0_str, ":", &fmt); 1761 fmt2_str = strtok_r(NULL, "/", &fmt); 1762 fmt3_str = strtok_r(NULL, " \t", &fmt); 1763 if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL 1764 || fmt3_str == NULL) { 1765 semantic_error("Failed to parse event name: %s\n", argv[0]); 1766 ret = -EINVAL; 1767 goto out; 1768 } 1769 pr = fmt1_str[0]; 1770 tev->group = strdup(fmt2_str); 1771 tev->event = strdup(fmt3_str); 1772 if (tev->group == NULL || tev->event == NULL) { 1773 ret = -ENOMEM; 1774 goto out; 1775 } 1776 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr); 1777 1778 tp->retprobe = (pr == 'r'); 1779 1780 /* Scan module name(if there), function name and offset */ 1781 p = strchr(argv[1], ':'); 1782 if (p) { 1783 tp->module = strndup(argv[1], p - argv[1]); 1784 if (!tp->module) { 1785 ret = -ENOMEM; 1786 goto out; 1787 } 1788 tev->uprobes = (tp->module[0] == '/'); 1789 p++; 1790 } else 1791 p = argv[1]; 1792 fmt1_str = strtok_r(p, "+", &fmt); 1793 /* only the address started with 0x */ 1794 if (fmt1_str[0] == '0') { 1795 /* 1796 * Fix a special case: 1797 * if address == 0, kernel reports something like: 1798 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax 1799 * Newer kernel may fix that, but we want to 1800 * support old kernel also. 1801 */ 1802 if (strcmp(fmt1_str, "0x") == 0) { 1803 if (!argv[2] || strcmp(argv[2], "(null)")) { 1804 ret = -EINVAL; 1805 goto out; 1806 } 1807 tp->address = 0; 1808 1809 free(argv[2]); 1810 for (i = 2; argv[i + 1] != NULL; i++) 1811 argv[i] = argv[i + 1]; 1812 1813 argv[i] = NULL; 1814 argc -= 1; 1815 } else 1816 tp->address = strtoul(fmt1_str, NULL, 0); 1817 } else { 1818 /* Only the symbol-based probe has offset */ 1819 tp->symbol = strdup(fmt1_str); 1820 if (tp->symbol == NULL) { 1821 ret = -ENOMEM; 1822 goto out; 1823 } 1824 fmt2_str = strtok_r(NULL, "", &fmt); 1825 if (fmt2_str == NULL) 1826 tp->offset = 0; 1827 else 1828 tp->offset = strtoul(fmt2_str, NULL, 10); 1829 } 1830 1831 tev->nargs = argc - 2; 1832 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs); 1833 if (tev->args == NULL) { 1834 ret = -ENOMEM; 1835 goto out; 1836 } 1837 for (i = 0; i < tev->nargs; i++) { 1838 p = strchr(argv[i + 2], '='); 1839 if (p) /* We don't need which register is assigned. */ 1840 *p++ = '\0'; 1841 else 1842 p = argv[i + 2]; 1843 tev->args[i].name = strdup(argv[i + 2]); 1844 /* TODO: parse regs and offset */ 1845 tev->args[i].value = strdup(p); 1846 if (tev->args[i].name == NULL || tev->args[i].value == NULL) { 1847 ret = -ENOMEM; 1848 goto out; 1849 } 1850 } 1851 ret = 0; 1852 out: 1853 free(argv0_str); 1854 argv_free(argv); 1855 return ret; 1856 } 1857 1858 /* Compose only probe arg */ 1859 char *synthesize_perf_probe_arg(struct perf_probe_arg *pa) 1860 { 1861 struct perf_probe_arg_field *field = pa->field; 1862 struct strbuf buf; 1863 char *ret = NULL; 1864 int err; 1865 1866 if (strbuf_init(&buf, 64) < 0) 1867 return NULL; 1868 1869 if (pa->name && pa->var) 1870 err = strbuf_addf(&buf, "%s=%s", pa->name, pa->var); 1871 else 1872 err = strbuf_addstr(&buf, pa->name ?: pa->var); 1873 if (err) 1874 goto out; 1875 1876 while (field) { 1877 if (field->name[0] == '[') 1878 err = strbuf_addstr(&buf, field->name); 1879 else 1880 err = strbuf_addf(&buf, "%s%s", field->ref ? "->" : ".", 1881 field->name); 1882 field = field->next; 1883 if (err) 1884 goto out; 1885 } 1886 1887 if (pa->type) 1888 if (strbuf_addf(&buf, ":%s", pa->type) < 0) 1889 goto out; 1890 1891 ret = strbuf_detach(&buf, NULL); 1892 out: 1893 strbuf_release(&buf); 1894 return ret; 1895 } 1896 1897 /* Compose only probe point (not argument) */ 1898 char *synthesize_perf_probe_point(struct perf_probe_point *pp) 1899 { 1900 struct strbuf buf; 1901 char *tmp, *ret = NULL; 1902 int len, err = 0; 1903 1904 if (strbuf_init(&buf, 64) < 0) 1905 return NULL; 1906 1907 if (pp->function) { 1908 if (strbuf_addstr(&buf, pp->function) < 0) 1909 goto out; 1910 if (pp->offset) 1911 err = strbuf_addf(&buf, "+%lu", pp->offset); 1912 else if (pp->line) 1913 err = strbuf_addf(&buf, ":%d", pp->line); 1914 else if (pp->retprobe) 1915 err = strbuf_addstr(&buf, "%return"); 1916 if (err) 1917 goto out; 1918 } 1919 if (pp->file) { 1920 tmp = pp->file; 1921 len = strlen(tmp); 1922 if (len > 30) { 1923 tmp = strchr(pp->file + len - 30, '/'); 1924 tmp = tmp ? tmp + 1 : pp->file + len - 30; 1925 } 1926 err = strbuf_addf(&buf, "@%s", tmp); 1927 if (!err && !pp->function && pp->line) 1928 err = strbuf_addf(&buf, ":%d", pp->line); 1929 } 1930 if (!err) 1931 ret = strbuf_detach(&buf, NULL); 1932 out: 1933 strbuf_release(&buf); 1934 return ret; 1935 } 1936 1937 char *synthesize_perf_probe_command(struct perf_probe_event *pev) 1938 { 1939 struct strbuf buf; 1940 char *tmp, *ret = NULL; 1941 int i; 1942 1943 if (strbuf_init(&buf, 64)) 1944 return NULL; 1945 if (pev->event) 1946 if (strbuf_addf(&buf, "%s:%s=", pev->group ?: PERFPROBE_GROUP, 1947 pev->event) < 0) 1948 goto out; 1949 1950 tmp = synthesize_perf_probe_point(&pev->point); 1951 if (!tmp || strbuf_addstr(&buf, tmp) < 0) 1952 goto out; 1953 free(tmp); 1954 1955 for (i = 0; i < pev->nargs; i++) { 1956 tmp = synthesize_perf_probe_arg(pev->args + i); 1957 if (!tmp || strbuf_addf(&buf, " %s", tmp) < 0) 1958 goto out; 1959 free(tmp); 1960 } 1961 1962 ret = strbuf_detach(&buf, NULL); 1963 out: 1964 strbuf_release(&buf); 1965 return ret; 1966 } 1967 1968 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref, 1969 struct strbuf *buf, int depth) 1970 { 1971 int err; 1972 if (ref->next) { 1973 depth = __synthesize_probe_trace_arg_ref(ref->next, buf, 1974 depth + 1); 1975 if (depth < 0) 1976 return depth; 1977 } 1978 err = strbuf_addf(buf, "%+ld(", ref->offset); 1979 return (err < 0) ? err : depth; 1980 } 1981 1982 static int synthesize_probe_trace_arg(struct probe_trace_arg *arg, 1983 struct strbuf *buf) 1984 { 1985 struct probe_trace_arg_ref *ref = arg->ref; 1986 int depth = 0, err; 1987 1988 /* Argument name or separator */ 1989 if (arg->name) 1990 err = strbuf_addf(buf, " %s=", arg->name); 1991 else 1992 err = strbuf_addch(buf, ' '); 1993 if (err) 1994 return err; 1995 1996 /* Special case: @XXX */ 1997 if (arg->value[0] == '@' && arg->ref) 1998 ref = ref->next; 1999 2000 /* Dereferencing arguments */ 2001 if (ref) { 2002 depth = __synthesize_probe_trace_arg_ref(ref, buf, 1); 2003 if (depth < 0) 2004 return depth; 2005 } 2006 2007 /* Print argument value */ 2008 if (arg->value[0] == '@' && arg->ref) 2009 err = strbuf_addf(buf, "%s%+ld", arg->value, arg->ref->offset); 2010 else 2011 err = strbuf_addstr(buf, arg->value); 2012 2013 /* Closing */ 2014 while (!err && depth--) 2015 err = strbuf_addch(buf, ')'); 2016 2017 /* Print argument type */ 2018 if (!err && arg->type) 2019 err = strbuf_addf(buf, ":%s", arg->type); 2020 2021 return err; 2022 } 2023 2024 char *synthesize_probe_trace_command(struct probe_trace_event *tev) 2025 { 2026 struct probe_trace_point *tp = &tev->point; 2027 struct strbuf buf; 2028 char *ret = NULL; 2029 int i, err; 2030 2031 /* Uprobes must have tp->module */ 2032 if (tev->uprobes && !tp->module) 2033 return NULL; 2034 2035 if (strbuf_init(&buf, 32) < 0) 2036 return NULL; 2037 2038 if (strbuf_addf(&buf, "%c:%s/%s ", tp->retprobe ? 'r' : 'p', 2039 tev->group, tev->event) < 0) 2040 goto error; 2041 /* 2042 * If tp->address == 0, then this point must be a 2043 * absolute address uprobe. 2044 * try_to_find_absolute_address() should have made 2045 * tp->symbol to "0x0". 2046 */ 2047 if (tev->uprobes && !tp->address) { 2048 if (!tp->symbol || strcmp(tp->symbol, "0x0")) 2049 goto error; 2050 } 2051 2052 /* Use the tp->address for uprobes */ 2053 if (tev->uprobes) 2054 err = strbuf_addf(&buf, "%s:0x%lx", tp->module, tp->address); 2055 else if (!strncmp(tp->symbol, "0x", 2)) 2056 /* Absolute address. See try_to_find_absolute_address() */ 2057 err = strbuf_addf(&buf, "%s%s0x%lx", tp->module ?: "", 2058 tp->module ? ":" : "", tp->address); 2059 else 2060 err = strbuf_addf(&buf, "%s%s%s+%lu", tp->module ?: "", 2061 tp->module ? ":" : "", tp->symbol, tp->offset); 2062 if (err) 2063 goto error; 2064 2065 for (i = 0; i < tev->nargs; i++) 2066 if (synthesize_probe_trace_arg(&tev->args[i], &buf) < 0) 2067 goto error; 2068 2069 ret = strbuf_detach(&buf, NULL); 2070 error: 2071 strbuf_release(&buf); 2072 return ret; 2073 } 2074 2075 static int find_perf_probe_point_from_map(struct probe_trace_point *tp, 2076 struct perf_probe_point *pp, 2077 bool is_kprobe) 2078 { 2079 struct symbol *sym = NULL; 2080 struct map *map = NULL; 2081 u64 addr = tp->address; 2082 int ret = -ENOENT; 2083 2084 if (!is_kprobe) { 2085 map = dso__new_map(tp->module); 2086 if (!map) 2087 goto out; 2088 sym = map__find_symbol(map, addr); 2089 } else { 2090 if (tp->symbol && !addr) { 2091 if (kernel_get_symbol_address_by_name(tp->symbol, 2092 &addr, true, false) < 0) 2093 goto out; 2094 } 2095 if (addr) { 2096 addr += tp->offset; 2097 sym = __find_kernel_function(addr, &map); 2098 } 2099 } 2100 2101 if (!sym) 2102 goto out; 2103 2104 pp->retprobe = tp->retprobe; 2105 pp->offset = addr - map->unmap_ip(map, sym->start); 2106 pp->function = strdup(sym->name); 2107 ret = pp->function ? 0 : -ENOMEM; 2108 2109 out: 2110 if (map && !is_kprobe) { 2111 map__put(map); 2112 } 2113 2114 return ret; 2115 } 2116 2117 static int convert_to_perf_probe_point(struct probe_trace_point *tp, 2118 struct perf_probe_point *pp, 2119 bool is_kprobe) 2120 { 2121 char buf[128]; 2122 int ret; 2123 2124 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe); 2125 if (!ret) 2126 return 0; 2127 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe); 2128 if (!ret) 2129 return 0; 2130 2131 pr_debug("Failed to find probe point from both of dwarf and map.\n"); 2132 2133 if (tp->symbol) { 2134 pp->function = strdup(tp->symbol); 2135 pp->offset = tp->offset; 2136 } else { 2137 ret = e_snprintf(buf, 128, "0x%" PRIx64, (u64)tp->address); 2138 if (ret < 0) 2139 return ret; 2140 pp->function = strdup(buf); 2141 pp->offset = 0; 2142 } 2143 if (pp->function == NULL) 2144 return -ENOMEM; 2145 2146 pp->retprobe = tp->retprobe; 2147 2148 return 0; 2149 } 2150 2151 static int convert_to_perf_probe_event(struct probe_trace_event *tev, 2152 struct perf_probe_event *pev, bool is_kprobe) 2153 { 2154 struct strbuf buf = STRBUF_INIT; 2155 int i, ret; 2156 2157 /* Convert event/group name */ 2158 pev->event = strdup(tev->event); 2159 pev->group = strdup(tev->group); 2160 if (pev->event == NULL || pev->group == NULL) 2161 return -ENOMEM; 2162 2163 /* Convert trace_point to probe_point */ 2164 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe); 2165 if (ret < 0) 2166 return ret; 2167 2168 /* Convert trace_arg to probe_arg */ 2169 pev->nargs = tev->nargs; 2170 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs); 2171 if (pev->args == NULL) 2172 return -ENOMEM; 2173 for (i = 0; i < tev->nargs && ret >= 0; i++) { 2174 if (tev->args[i].name) 2175 pev->args[i].name = strdup(tev->args[i].name); 2176 else { 2177 if ((ret = strbuf_init(&buf, 32)) < 0) 2178 goto error; 2179 ret = synthesize_probe_trace_arg(&tev->args[i], &buf); 2180 pev->args[i].name = strbuf_detach(&buf, NULL); 2181 } 2182 if (pev->args[i].name == NULL && ret >= 0) 2183 ret = -ENOMEM; 2184 } 2185 error: 2186 if (ret < 0) 2187 clear_perf_probe_event(pev); 2188 2189 return ret; 2190 } 2191 2192 void clear_perf_probe_event(struct perf_probe_event *pev) 2193 { 2194 struct perf_probe_arg_field *field, *next; 2195 int i; 2196 2197 free(pev->event); 2198 free(pev->group); 2199 free(pev->target); 2200 clear_perf_probe_point(&pev->point); 2201 2202 for (i = 0; i < pev->nargs; i++) { 2203 free(pev->args[i].name); 2204 free(pev->args[i].var); 2205 free(pev->args[i].type); 2206 field = pev->args[i].field; 2207 while (field) { 2208 next = field->next; 2209 zfree(&field->name); 2210 free(field); 2211 field = next; 2212 } 2213 } 2214 free(pev->args); 2215 memset(pev, 0, sizeof(*pev)); 2216 } 2217 2218 #define strdup_or_goto(str, label) \ 2219 ({ char *__p = NULL; if (str && !(__p = strdup(str))) goto label; __p; }) 2220 2221 static int perf_probe_point__copy(struct perf_probe_point *dst, 2222 struct perf_probe_point *src) 2223 { 2224 dst->file = strdup_or_goto(src->file, out_err); 2225 dst->function = strdup_or_goto(src->function, out_err); 2226 dst->lazy_line = strdup_or_goto(src->lazy_line, out_err); 2227 dst->line = src->line; 2228 dst->retprobe = src->retprobe; 2229 dst->offset = src->offset; 2230 return 0; 2231 2232 out_err: 2233 clear_perf_probe_point(dst); 2234 return -ENOMEM; 2235 } 2236 2237 static int perf_probe_arg__copy(struct perf_probe_arg *dst, 2238 struct perf_probe_arg *src) 2239 { 2240 struct perf_probe_arg_field *field, **ppfield; 2241 2242 dst->name = strdup_or_goto(src->name, out_err); 2243 dst->var = strdup_or_goto(src->var, out_err); 2244 dst->type = strdup_or_goto(src->type, out_err); 2245 2246 field = src->field; 2247 ppfield = &(dst->field); 2248 while (field) { 2249 *ppfield = zalloc(sizeof(*field)); 2250 if (!*ppfield) 2251 goto out_err; 2252 (*ppfield)->name = strdup_or_goto(field->name, out_err); 2253 (*ppfield)->index = field->index; 2254 (*ppfield)->ref = field->ref; 2255 field = field->next; 2256 ppfield = &((*ppfield)->next); 2257 } 2258 return 0; 2259 out_err: 2260 return -ENOMEM; 2261 } 2262 2263 int perf_probe_event__copy(struct perf_probe_event *dst, 2264 struct perf_probe_event *src) 2265 { 2266 int i; 2267 2268 dst->event = strdup_or_goto(src->event, out_err); 2269 dst->group = strdup_or_goto(src->group, out_err); 2270 dst->target = strdup_or_goto(src->target, out_err); 2271 dst->uprobes = src->uprobes; 2272 2273 if (perf_probe_point__copy(&dst->point, &src->point) < 0) 2274 goto out_err; 2275 2276 dst->args = zalloc(sizeof(struct perf_probe_arg) * src->nargs); 2277 if (!dst->args) 2278 goto out_err; 2279 dst->nargs = src->nargs; 2280 2281 for (i = 0; i < src->nargs; i++) 2282 if (perf_probe_arg__copy(&dst->args[i], &src->args[i]) < 0) 2283 goto out_err; 2284 return 0; 2285 2286 out_err: 2287 clear_perf_probe_event(dst); 2288 return -ENOMEM; 2289 } 2290 2291 void clear_probe_trace_event(struct probe_trace_event *tev) 2292 { 2293 struct probe_trace_arg_ref *ref, *next; 2294 int i; 2295 2296 free(tev->event); 2297 free(tev->group); 2298 free(tev->point.symbol); 2299 free(tev->point.realname); 2300 free(tev->point.module); 2301 for (i = 0; i < tev->nargs; i++) { 2302 free(tev->args[i].name); 2303 free(tev->args[i].value); 2304 free(tev->args[i].type); 2305 ref = tev->args[i].ref; 2306 while (ref) { 2307 next = ref->next; 2308 free(ref); 2309 ref = next; 2310 } 2311 } 2312 free(tev->args); 2313 memset(tev, 0, sizeof(*tev)); 2314 } 2315 2316 struct kprobe_blacklist_node { 2317 struct list_head list; 2318 unsigned long start; 2319 unsigned long end; 2320 char *symbol; 2321 }; 2322 2323 static void kprobe_blacklist__delete(struct list_head *blacklist) 2324 { 2325 struct kprobe_blacklist_node *node; 2326 2327 while (!list_empty(blacklist)) { 2328 node = list_first_entry(blacklist, 2329 struct kprobe_blacklist_node, list); 2330 list_del(&node->list); 2331 free(node->symbol); 2332 free(node); 2333 } 2334 } 2335 2336 static int kprobe_blacklist__load(struct list_head *blacklist) 2337 { 2338 struct kprobe_blacklist_node *node; 2339 const char *__debugfs = debugfs__mountpoint(); 2340 char buf[PATH_MAX], *p; 2341 FILE *fp; 2342 int ret; 2343 2344 if (__debugfs == NULL) 2345 return -ENOTSUP; 2346 2347 ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs); 2348 if (ret < 0) 2349 return ret; 2350 2351 fp = fopen(buf, "r"); 2352 if (!fp) 2353 return -errno; 2354 2355 ret = 0; 2356 while (fgets(buf, PATH_MAX, fp)) { 2357 node = zalloc(sizeof(*node)); 2358 if (!node) { 2359 ret = -ENOMEM; 2360 break; 2361 } 2362 INIT_LIST_HEAD(&node->list); 2363 list_add_tail(&node->list, blacklist); 2364 if (sscanf(buf, "0x%lx-0x%lx", &node->start, &node->end) != 2) { 2365 ret = -EINVAL; 2366 break; 2367 } 2368 p = strchr(buf, '\t'); 2369 if (p) { 2370 p++; 2371 if (p[strlen(p) - 1] == '\n') 2372 p[strlen(p) - 1] = '\0'; 2373 } else 2374 p = (char *)"unknown"; 2375 node->symbol = strdup(p); 2376 if (!node->symbol) { 2377 ret = -ENOMEM; 2378 break; 2379 } 2380 pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n", 2381 node->start, node->end, node->symbol); 2382 ret++; 2383 } 2384 if (ret < 0) 2385 kprobe_blacklist__delete(blacklist); 2386 fclose(fp); 2387 2388 return ret; 2389 } 2390 2391 static struct kprobe_blacklist_node * 2392 kprobe_blacklist__find_by_address(struct list_head *blacklist, 2393 unsigned long address) 2394 { 2395 struct kprobe_blacklist_node *node; 2396 2397 list_for_each_entry(node, blacklist, list) { 2398 if (node->start <= address && address < node->end) 2399 return node; 2400 } 2401 2402 return NULL; 2403 } 2404 2405 static LIST_HEAD(kprobe_blacklist); 2406 2407 static void kprobe_blacklist__init(void) 2408 { 2409 if (!list_empty(&kprobe_blacklist)) 2410 return; 2411 2412 if (kprobe_blacklist__load(&kprobe_blacklist) < 0) 2413 pr_debug("No kprobe blacklist support, ignored\n"); 2414 } 2415 2416 static void kprobe_blacklist__release(void) 2417 { 2418 kprobe_blacklist__delete(&kprobe_blacklist); 2419 } 2420 2421 static bool kprobe_blacklist__listed(unsigned long address) 2422 { 2423 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address); 2424 } 2425 2426 static int perf_probe_event__sprintf(const char *group, const char *event, 2427 struct perf_probe_event *pev, 2428 const char *module, 2429 struct strbuf *result) 2430 { 2431 int i, ret; 2432 char *buf; 2433 2434 if (asprintf(&buf, "%s:%s", group, event) < 0) 2435 return -errno; 2436 ret = strbuf_addf(result, " %-20s (on ", buf); 2437 free(buf); 2438 if (ret) 2439 return ret; 2440 2441 /* Synthesize only event probe point */ 2442 buf = synthesize_perf_probe_point(&pev->point); 2443 if (!buf) 2444 return -ENOMEM; 2445 ret = strbuf_addstr(result, buf); 2446 free(buf); 2447 2448 if (!ret && module) 2449 ret = strbuf_addf(result, " in %s", module); 2450 2451 if (!ret && pev->nargs > 0) { 2452 ret = strbuf_add(result, " with", 5); 2453 for (i = 0; !ret && i < pev->nargs; i++) { 2454 buf = synthesize_perf_probe_arg(&pev->args[i]); 2455 if (!buf) 2456 return -ENOMEM; 2457 ret = strbuf_addf(result, " %s", buf); 2458 free(buf); 2459 } 2460 } 2461 if (!ret) 2462 ret = strbuf_addch(result, ')'); 2463 2464 return ret; 2465 } 2466 2467 /* Show an event */ 2468 int show_perf_probe_event(const char *group, const char *event, 2469 struct perf_probe_event *pev, 2470 const char *module, bool use_stdout) 2471 { 2472 struct strbuf buf = STRBUF_INIT; 2473 int ret; 2474 2475 ret = perf_probe_event__sprintf(group, event, pev, module, &buf); 2476 if (ret >= 0) { 2477 if (use_stdout) 2478 printf("%s\n", buf.buf); 2479 else 2480 pr_info("%s\n", buf.buf); 2481 } 2482 strbuf_release(&buf); 2483 2484 return ret; 2485 } 2486 2487 static bool filter_probe_trace_event(struct probe_trace_event *tev, 2488 struct strfilter *filter) 2489 { 2490 char tmp[128]; 2491 2492 /* At first, check the event name itself */ 2493 if (strfilter__compare(filter, tev->event)) 2494 return true; 2495 2496 /* Next, check the combination of name and group */ 2497 if (e_snprintf(tmp, 128, "%s:%s", tev->group, tev->event) < 0) 2498 return false; 2499 return strfilter__compare(filter, tmp); 2500 } 2501 2502 static int __show_perf_probe_events(int fd, bool is_kprobe, 2503 struct strfilter *filter) 2504 { 2505 int ret = 0; 2506 struct probe_trace_event tev; 2507 struct perf_probe_event pev; 2508 struct strlist *rawlist; 2509 struct str_node *ent; 2510 2511 memset(&tev, 0, sizeof(tev)); 2512 memset(&pev, 0, sizeof(pev)); 2513 2514 rawlist = probe_file__get_rawlist(fd); 2515 if (!rawlist) 2516 return -ENOMEM; 2517 2518 strlist__for_each_entry(ent, rawlist) { 2519 ret = parse_probe_trace_command(ent->s, &tev); 2520 if (ret >= 0) { 2521 if (!filter_probe_trace_event(&tev, filter)) 2522 goto next; 2523 ret = convert_to_perf_probe_event(&tev, &pev, 2524 is_kprobe); 2525 if (ret < 0) 2526 goto next; 2527 ret = show_perf_probe_event(pev.group, pev.event, 2528 &pev, tev.point.module, 2529 true); 2530 } 2531 next: 2532 clear_perf_probe_event(&pev); 2533 clear_probe_trace_event(&tev); 2534 if (ret < 0) 2535 break; 2536 } 2537 strlist__delete(rawlist); 2538 /* Cleanup cached debuginfo if needed */ 2539 debuginfo_cache__exit(); 2540 2541 return ret; 2542 } 2543 2544 /* List up current perf-probe events */ 2545 int show_perf_probe_events(struct strfilter *filter) 2546 { 2547 int kp_fd, up_fd, ret; 2548 2549 setup_pager(); 2550 2551 if (probe_conf.cache) 2552 return probe_cache__show_all_caches(filter); 2553 2554 ret = init_probe_symbol_maps(false); 2555 if (ret < 0) 2556 return ret; 2557 2558 ret = probe_file__open_both(&kp_fd, &up_fd, 0); 2559 if (ret < 0) 2560 return ret; 2561 2562 if (kp_fd >= 0) 2563 ret = __show_perf_probe_events(kp_fd, true, filter); 2564 if (up_fd >= 0 && ret >= 0) 2565 ret = __show_perf_probe_events(up_fd, false, filter); 2566 if (kp_fd > 0) 2567 close(kp_fd); 2568 if (up_fd > 0) 2569 close(up_fd); 2570 exit_probe_symbol_maps(); 2571 2572 return ret; 2573 } 2574 2575 static int get_new_event_name(char *buf, size_t len, const char *base, 2576 struct strlist *namelist, bool ret_event, 2577 bool allow_suffix) 2578 { 2579 int i, ret; 2580 char *p, *nbase; 2581 2582 if (*base == '.') 2583 base++; 2584 nbase = strdup(base); 2585 if (!nbase) 2586 return -ENOMEM; 2587 2588 /* Cut off the dot suffixes (e.g. .const, .isra) and version suffixes */ 2589 p = strpbrk(nbase, ".@"); 2590 if (p && p != nbase) 2591 *p = '\0'; 2592 2593 /* Try no suffix number */ 2594 ret = e_snprintf(buf, len, "%s%s", nbase, ret_event ? "__return" : ""); 2595 if (ret < 0) { 2596 pr_debug("snprintf() failed: %d\n", ret); 2597 goto out; 2598 } 2599 if (!strlist__has_entry(namelist, buf)) 2600 goto out; 2601 2602 if (!allow_suffix) { 2603 pr_warning("Error: event \"%s\" already exists.\n" 2604 " Hint: Remove existing event by 'perf probe -d'\n" 2605 " or force duplicates by 'perf probe -f'\n" 2606 " or set 'force=yes' in BPF source.\n", 2607 buf); 2608 ret = -EEXIST; 2609 goto out; 2610 } 2611 2612 /* Try to add suffix */ 2613 for (i = 1; i < MAX_EVENT_INDEX; i++) { 2614 ret = e_snprintf(buf, len, "%s_%d", nbase, i); 2615 if (ret < 0) { 2616 pr_debug("snprintf() failed: %d\n", ret); 2617 goto out; 2618 } 2619 if (!strlist__has_entry(namelist, buf)) 2620 break; 2621 } 2622 if (i == MAX_EVENT_INDEX) { 2623 pr_warning("Too many events are on the same function.\n"); 2624 ret = -ERANGE; 2625 } 2626 2627 out: 2628 free(nbase); 2629 2630 /* Final validation */ 2631 if (ret >= 0 && !is_c_func_name(buf)) { 2632 pr_warning("Internal error: \"%s\" is an invalid event name.\n", 2633 buf); 2634 ret = -EINVAL; 2635 } 2636 2637 return ret; 2638 } 2639 2640 /* Warn if the current kernel's uprobe implementation is old */ 2641 static void warn_uprobe_event_compat(struct probe_trace_event *tev) 2642 { 2643 int i; 2644 char *buf = synthesize_probe_trace_command(tev); 2645 2646 /* Old uprobe event doesn't support memory dereference */ 2647 if (!tev->uprobes || tev->nargs == 0 || !buf) 2648 goto out; 2649 2650 for (i = 0; i < tev->nargs; i++) 2651 if (strglobmatch(tev->args[i].value, "[$@+-]*")) { 2652 pr_warning("Please upgrade your kernel to at least " 2653 "3.14 to have access to feature %s\n", 2654 tev->args[i].value); 2655 break; 2656 } 2657 out: 2658 free(buf); 2659 } 2660 2661 /* Set new name from original perf_probe_event and namelist */ 2662 static int probe_trace_event__set_name(struct probe_trace_event *tev, 2663 struct perf_probe_event *pev, 2664 struct strlist *namelist, 2665 bool allow_suffix) 2666 { 2667 const char *event, *group; 2668 char buf[64]; 2669 int ret; 2670 2671 /* If probe_event or trace_event already have the name, reuse it */ 2672 if (pev->event && !pev->sdt) 2673 event = pev->event; 2674 else if (tev->event) 2675 event = tev->event; 2676 else { 2677 /* Or generate new one from probe point */ 2678 if (pev->point.function && 2679 (strncmp(pev->point.function, "0x", 2) != 0) && 2680 !strisglob(pev->point.function)) 2681 event = pev->point.function; 2682 else 2683 event = tev->point.realname; 2684 } 2685 if (pev->group && !pev->sdt) 2686 group = pev->group; 2687 else if (tev->group) 2688 group = tev->group; 2689 else 2690 group = PERFPROBE_GROUP; 2691 2692 /* Get an unused new event name */ 2693 ret = get_new_event_name(buf, 64, event, namelist, 2694 tev->point.retprobe, allow_suffix); 2695 if (ret < 0) 2696 return ret; 2697 2698 event = buf; 2699 2700 tev->event = strdup(event); 2701 tev->group = strdup(group); 2702 if (tev->event == NULL || tev->group == NULL) 2703 return -ENOMEM; 2704 2705 /* Add added event name to namelist */ 2706 strlist__add(namelist, event); 2707 return 0; 2708 } 2709 2710 static int __open_probe_file_and_namelist(bool uprobe, 2711 struct strlist **namelist) 2712 { 2713 int fd; 2714 2715 fd = probe_file__open(PF_FL_RW | (uprobe ? PF_FL_UPROBE : 0)); 2716 if (fd < 0) 2717 return fd; 2718 2719 /* Get current event names */ 2720 *namelist = probe_file__get_namelist(fd); 2721 if (!(*namelist)) { 2722 pr_debug("Failed to get current event list.\n"); 2723 close(fd); 2724 return -ENOMEM; 2725 } 2726 return fd; 2727 } 2728 2729 static int __add_probe_trace_events(struct perf_probe_event *pev, 2730 struct probe_trace_event *tevs, 2731 int ntevs, bool allow_suffix) 2732 { 2733 int i, fd[2] = {-1, -1}, up, ret; 2734 struct probe_trace_event *tev = NULL; 2735 struct probe_cache *cache = NULL; 2736 struct strlist *namelist[2] = {NULL, NULL}; 2737 struct nscookie nsc; 2738 2739 up = pev->uprobes ? 1 : 0; 2740 fd[up] = __open_probe_file_and_namelist(up, &namelist[up]); 2741 if (fd[up] < 0) 2742 return fd[up]; 2743 2744 ret = 0; 2745 for (i = 0; i < ntevs; i++) { 2746 tev = &tevs[i]; 2747 up = tev->uprobes ? 1 : 0; 2748 if (fd[up] == -1) { /* Open the kprobe/uprobe_events */ 2749 fd[up] = __open_probe_file_and_namelist(up, 2750 &namelist[up]); 2751 if (fd[up] < 0) 2752 goto close_out; 2753 } 2754 /* Skip if the symbol is out of .text or blacklisted */ 2755 if (!tev->point.symbol && !pev->uprobes) 2756 continue; 2757 2758 /* Set new name for tev (and update namelist) */ 2759 ret = probe_trace_event__set_name(tev, pev, namelist[up], 2760 allow_suffix); 2761 if (ret < 0) 2762 break; 2763 2764 nsinfo__mountns_enter(pev->nsi, &nsc); 2765 ret = probe_file__add_event(fd[up], tev); 2766 nsinfo__mountns_exit(&nsc); 2767 if (ret < 0) 2768 break; 2769 2770 /* 2771 * Probes after the first probe which comes from same 2772 * user input are always allowed to add suffix, because 2773 * there might be several addresses corresponding to 2774 * one code line. 2775 */ 2776 allow_suffix = true; 2777 } 2778 if (ret == -EINVAL && pev->uprobes) 2779 warn_uprobe_event_compat(tev); 2780 if (ret == 0 && probe_conf.cache) { 2781 cache = probe_cache__new(pev->target, pev->nsi); 2782 if (!cache || 2783 probe_cache__add_entry(cache, pev, tevs, ntevs) < 0 || 2784 probe_cache__commit(cache) < 0) 2785 pr_warning("Failed to add event to probe cache\n"); 2786 probe_cache__delete(cache); 2787 } 2788 2789 close_out: 2790 for (up = 0; up < 2; up++) { 2791 strlist__delete(namelist[up]); 2792 if (fd[up] >= 0) 2793 close(fd[up]); 2794 } 2795 return ret; 2796 } 2797 2798 static int find_probe_functions(struct map *map, char *name, 2799 struct symbol **syms) 2800 { 2801 int found = 0; 2802 struct symbol *sym; 2803 struct rb_node *tmp; 2804 const char *norm, *ver; 2805 char *buf = NULL; 2806 2807 if (map__load(map) < 0) 2808 return 0; 2809 2810 map__for_each_symbol(map, sym, tmp) { 2811 norm = arch__normalize_symbol_name(sym->name); 2812 if (!norm) 2813 continue; 2814 2815 /* We don't care about default symbol or not */ 2816 ver = strchr(norm, '@'); 2817 if (ver) { 2818 buf = strndup(norm, ver - norm); 2819 if (!buf) 2820 return -ENOMEM; 2821 norm = buf; 2822 } 2823 if (strglobmatch(norm, name)) { 2824 found++; 2825 if (syms && found < probe_conf.max_probes) 2826 syms[found - 1] = sym; 2827 } 2828 if (buf) 2829 zfree(&buf); 2830 } 2831 2832 return found; 2833 } 2834 2835 void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused, 2836 struct probe_trace_event *tev __maybe_unused, 2837 struct map *map __maybe_unused, 2838 struct symbol *sym __maybe_unused) { } 2839 2840 /* 2841 * Find probe function addresses from map. 2842 * Return an error or the number of found probe_trace_event 2843 */ 2844 static int find_probe_trace_events_from_map(struct perf_probe_event *pev, 2845 struct probe_trace_event **tevs) 2846 { 2847 struct map *map = NULL; 2848 struct ref_reloc_sym *reloc_sym = NULL; 2849 struct symbol *sym; 2850 struct symbol **syms = NULL; 2851 struct probe_trace_event *tev; 2852 struct perf_probe_point *pp = &pev->point; 2853 struct probe_trace_point *tp; 2854 int num_matched_functions; 2855 int ret, i, j, skipped = 0; 2856 char *mod_name; 2857 2858 map = get_target_map(pev->target, pev->nsi, pev->uprobes); 2859 if (!map) { 2860 ret = -EINVAL; 2861 goto out; 2862 } 2863 2864 syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes); 2865 if (!syms) { 2866 ret = -ENOMEM; 2867 goto out; 2868 } 2869 2870 /* 2871 * Load matched symbols: Since the different local symbols may have 2872 * same name but different addresses, this lists all the symbols. 2873 */ 2874 num_matched_functions = find_probe_functions(map, pp->function, syms); 2875 if (num_matched_functions <= 0) { 2876 pr_err("Failed to find symbol %s in %s\n", pp->function, 2877 pev->target ? : "kernel"); 2878 ret = -ENOENT; 2879 goto out; 2880 } else if (num_matched_functions > probe_conf.max_probes) { 2881 pr_err("Too many functions matched in %s\n", 2882 pev->target ? : "kernel"); 2883 ret = -E2BIG; 2884 goto out; 2885 } 2886 2887 /* Note that the symbols in the kmodule are not relocated */ 2888 if (!pev->uprobes && !pev->target && 2889 (!pp->retprobe || kretprobe_offset_is_supported())) { 2890 reloc_sym = kernel_get_ref_reloc_sym(); 2891 if (!reloc_sym) { 2892 pr_warning("Relocated base symbol is not found!\n"); 2893 ret = -EINVAL; 2894 goto out; 2895 } 2896 } 2897 2898 /* Setup result trace-probe-events */ 2899 *tevs = zalloc(sizeof(*tev) * num_matched_functions); 2900 if (!*tevs) { 2901 ret = -ENOMEM; 2902 goto out; 2903 } 2904 2905 ret = 0; 2906 2907 for (j = 0; j < num_matched_functions; j++) { 2908 sym = syms[j]; 2909 2910 tev = (*tevs) + ret; 2911 tp = &tev->point; 2912 if (ret == num_matched_functions) { 2913 pr_warning("Too many symbols are listed. Skip it.\n"); 2914 break; 2915 } 2916 ret++; 2917 2918 if (pp->offset > sym->end - sym->start) { 2919 pr_warning("Offset %ld is bigger than the size of %s\n", 2920 pp->offset, sym->name); 2921 ret = -ENOENT; 2922 goto err_out; 2923 } 2924 /* Add one probe point */ 2925 tp->address = map->unmap_ip(map, sym->start) + pp->offset; 2926 2927 /* Check the kprobe (not in module) is within .text */ 2928 if (!pev->uprobes && !pev->target && 2929 kprobe_warn_out_range(sym->name, tp->address)) { 2930 tp->symbol = NULL; /* Skip it */ 2931 skipped++; 2932 } else if (reloc_sym) { 2933 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out); 2934 tp->offset = tp->address - reloc_sym->addr; 2935 } else { 2936 tp->symbol = strdup_or_goto(sym->name, nomem_out); 2937 tp->offset = pp->offset; 2938 } 2939 tp->realname = strdup_or_goto(sym->name, nomem_out); 2940 2941 tp->retprobe = pp->retprobe; 2942 if (pev->target) { 2943 if (pev->uprobes) { 2944 tev->point.module = strdup_or_goto(pev->target, 2945 nomem_out); 2946 } else { 2947 mod_name = find_module_name(pev->target); 2948 tev->point.module = 2949 strdup(mod_name ? mod_name : pev->target); 2950 free(mod_name); 2951 if (!tev->point.module) 2952 goto nomem_out; 2953 } 2954 } 2955 tev->uprobes = pev->uprobes; 2956 tev->nargs = pev->nargs; 2957 if (tev->nargs) { 2958 tev->args = zalloc(sizeof(struct probe_trace_arg) * 2959 tev->nargs); 2960 if (tev->args == NULL) 2961 goto nomem_out; 2962 } 2963 for (i = 0; i < tev->nargs; i++) { 2964 if (pev->args[i].name) 2965 tev->args[i].name = 2966 strdup_or_goto(pev->args[i].name, 2967 nomem_out); 2968 2969 tev->args[i].value = strdup_or_goto(pev->args[i].var, 2970 nomem_out); 2971 if (pev->args[i].type) 2972 tev->args[i].type = 2973 strdup_or_goto(pev->args[i].type, 2974 nomem_out); 2975 } 2976 arch__fix_tev_from_maps(pev, tev, map, sym); 2977 } 2978 if (ret == skipped) { 2979 ret = -ENOENT; 2980 goto err_out; 2981 } 2982 2983 out: 2984 map__put(map); 2985 free(syms); 2986 return ret; 2987 2988 nomem_out: 2989 ret = -ENOMEM; 2990 err_out: 2991 clear_probe_trace_events(*tevs, num_matched_functions); 2992 zfree(tevs); 2993 goto out; 2994 } 2995 2996 static int try_to_find_absolute_address(struct perf_probe_event *pev, 2997 struct probe_trace_event **tevs) 2998 { 2999 struct perf_probe_point *pp = &pev->point; 3000 struct probe_trace_event *tev; 3001 struct probe_trace_point *tp; 3002 int i, err; 3003 3004 if (!(pev->point.function && !strncmp(pev->point.function, "0x", 2))) 3005 return -EINVAL; 3006 if (perf_probe_event_need_dwarf(pev)) 3007 return -EINVAL; 3008 3009 /* 3010 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at 3011 * absolute address. 3012 * 3013 * Only one tev can be generated by this. 3014 */ 3015 *tevs = zalloc(sizeof(*tev)); 3016 if (!*tevs) 3017 return -ENOMEM; 3018 3019 tev = *tevs; 3020 tp = &tev->point; 3021 3022 /* 3023 * Don't use tp->offset, use address directly, because 3024 * in synthesize_probe_trace_command() address cannot be 3025 * zero. 3026 */ 3027 tp->address = pev->point.abs_address; 3028 tp->retprobe = pp->retprobe; 3029 tev->uprobes = pev->uprobes; 3030 3031 err = -ENOMEM; 3032 /* 3033 * Give it a '0x' leading symbol name. 3034 * In __add_probe_trace_events, a NULL symbol is interpreted as 3035 * invalud. 3036 */ 3037 if (asprintf(&tp->symbol, "0x%lx", tp->address) < 0) 3038 goto errout; 3039 3040 /* For kprobe, check range */ 3041 if ((!tev->uprobes) && 3042 (kprobe_warn_out_range(tev->point.symbol, 3043 tev->point.address))) { 3044 err = -EACCES; 3045 goto errout; 3046 } 3047 3048 if (asprintf(&tp->realname, "abs_%lx", tp->address) < 0) 3049 goto errout; 3050 3051 if (pev->target) { 3052 tp->module = strdup(pev->target); 3053 if (!tp->module) 3054 goto errout; 3055 } 3056 3057 if (tev->group) { 3058 tev->group = strdup(pev->group); 3059 if (!tev->group) 3060 goto errout; 3061 } 3062 3063 if (pev->event) { 3064 tev->event = strdup(pev->event); 3065 if (!tev->event) 3066 goto errout; 3067 } 3068 3069 tev->nargs = pev->nargs; 3070 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs); 3071 if (!tev->args) 3072 goto errout; 3073 3074 for (i = 0; i < tev->nargs; i++) 3075 copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]); 3076 3077 return 1; 3078 3079 errout: 3080 clear_probe_trace_events(*tevs, 1); 3081 *tevs = NULL; 3082 return err; 3083 } 3084 3085 /* Concatinate two arrays */ 3086 static void *memcat(void *a, size_t sz_a, void *b, size_t sz_b) 3087 { 3088 void *ret; 3089 3090 ret = malloc(sz_a + sz_b); 3091 if (ret) { 3092 memcpy(ret, a, sz_a); 3093 memcpy(ret + sz_a, b, sz_b); 3094 } 3095 return ret; 3096 } 3097 3098 static int 3099 concat_probe_trace_events(struct probe_trace_event **tevs, int *ntevs, 3100 struct probe_trace_event **tevs2, int ntevs2) 3101 { 3102 struct probe_trace_event *new_tevs; 3103 int ret = 0; 3104 3105 if (*ntevs == 0) { 3106 *tevs = *tevs2; 3107 *ntevs = ntevs2; 3108 *tevs2 = NULL; 3109 return 0; 3110 } 3111 3112 if (*ntevs + ntevs2 > probe_conf.max_probes) 3113 ret = -E2BIG; 3114 else { 3115 /* Concatinate the array of probe_trace_event */ 3116 new_tevs = memcat(*tevs, (*ntevs) * sizeof(**tevs), 3117 *tevs2, ntevs2 * sizeof(**tevs2)); 3118 if (!new_tevs) 3119 ret = -ENOMEM; 3120 else { 3121 free(*tevs); 3122 *tevs = new_tevs; 3123 *ntevs += ntevs2; 3124 } 3125 } 3126 if (ret < 0) 3127 clear_probe_trace_events(*tevs2, ntevs2); 3128 zfree(tevs2); 3129 3130 return ret; 3131 } 3132 3133 /* 3134 * Try to find probe_trace_event from given probe caches. Return the number 3135 * of cached events found, if an error occurs return the error. 3136 */ 3137 static int find_cached_events(struct perf_probe_event *pev, 3138 struct probe_trace_event **tevs, 3139 const char *target) 3140 { 3141 struct probe_cache *cache; 3142 struct probe_cache_entry *entry; 3143 struct probe_trace_event *tmp_tevs = NULL; 3144 int ntevs = 0; 3145 int ret = 0; 3146 3147 cache = probe_cache__new(target, pev->nsi); 3148 /* Return 0 ("not found") if the target has no probe cache. */ 3149 if (!cache) 3150 return 0; 3151 3152 for_each_probe_cache_entry(entry, cache) { 3153 /* Skip the cache entry which has no name */ 3154 if (!entry->pev.event || !entry->pev.group) 3155 continue; 3156 if ((!pev->group || strglobmatch(entry->pev.group, pev->group)) && 3157 strglobmatch(entry->pev.event, pev->event)) { 3158 ret = probe_cache_entry__get_event(entry, &tmp_tevs); 3159 if (ret > 0) 3160 ret = concat_probe_trace_events(tevs, &ntevs, 3161 &tmp_tevs, ret); 3162 if (ret < 0) 3163 break; 3164 } 3165 } 3166 probe_cache__delete(cache); 3167 if (ret < 0) { 3168 clear_probe_trace_events(*tevs, ntevs); 3169 zfree(tevs); 3170 } else { 3171 ret = ntevs; 3172 if (ntevs > 0 && target && target[0] == '/') 3173 pev->uprobes = true; 3174 } 3175 3176 return ret; 3177 } 3178 3179 /* Try to find probe_trace_event from all probe caches */ 3180 static int find_cached_events_all(struct perf_probe_event *pev, 3181 struct probe_trace_event **tevs) 3182 { 3183 struct probe_trace_event *tmp_tevs = NULL; 3184 struct strlist *bidlist; 3185 struct str_node *nd; 3186 char *pathname; 3187 int ntevs = 0; 3188 int ret; 3189 3190 /* Get the buildid list of all valid caches */ 3191 bidlist = build_id_cache__list_all(true); 3192 if (!bidlist) { 3193 ret = -errno; 3194 pr_debug("Failed to get buildids: %d\n", ret); 3195 return ret; 3196 } 3197 3198 ret = 0; 3199 strlist__for_each_entry(nd, bidlist) { 3200 pathname = build_id_cache__origname(nd->s); 3201 ret = find_cached_events(pev, &tmp_tevs, pathname); 3202 /* In the case of cnt == 0, we just skip it */ 3203 if (ret > 0) 3204 ret = concat_probe_trace_events(tevs, &ntevs, 3205 &tmp_tevs, ret); 3206 free(pathname); 3207 if (ret < 0) 3208 break; 3209 } 3210 strlist__delete(bidlist); 3211 3212 if (ret < 0) { 3213 clear_probe_trace_events(*tevs, ntevs); 3214 zfree(tevs); 3215 } else 3216 ret = ntevs; 3217 3218 return ret; 3219 } 3220 3221 static int find_probe_trace_events_from_cache(struct perf_probe_event *pev, 3222 struct probe_trace_event **tevs) 3223 { 3224 struct probe_cache *cache; 3225 struct probe_cache_entry *entry; 3226 struct probe_trace_event *tev; 3227 struct str_node *node; 3228 int ret, i; 3229 3230 if (pev->sdt) { 3231 /* For SDT/cached events, we use special search functions */ 3232 if (!pev->target) 3233 return find_cached_events_all(pev, tevs); 3234 else 3235 return find_cached_events(pev, tevs, pev->target); 3236 } 3237 cache = probe_cache__new(pev->target, pev->nsi); 3238 if (!cache) 3239 return 0; 3240 3241 entry = probe_cache__find(cache, pev); 3242 if (!entry) { 3243 /* SDT must be in the cache */ 3244 ret = pev->sdt ? -ENOENT : 0; 3245 goto out; 3246 } 3247 3248 ret = strlist__nr_entries(entry->tevlist); 3249 if (ret > probe_conf.max_probes) { 3250 pr_debug("Too many entries matched in the cache of %s\n", 3251 pev->target ? : "kernel"); 3252 ret = -E2BIG; 3253 goto out; 3254 } 3255 3256 *tevs = zalloc(ret * sizeof(*tev)); 3257 if (!*tevs) { 3258 ret = -ENOMEM; 3259 goto out; 3260 } 3261 3262 i = 0; 3263 strlist__for_each_entry(node, entry->tevlist) { 3264 tev = &(*tevs)[i++]; 3265 ret = parse_probe_trace_command(node->s, tev); 3266 if (ret < 0) 3267 goto out; 3268 /* Set the uprobes attribute as same as original */ 3269 tev->uprobes = pev->uprobes; 3270 } 3271 ret = i; 3272 3273 out: 3274 probe_cache__delete(cache); 3275 return ret; 3276 } 3277 3278 static int convert_to_probe_trace_events(struct perf_probe_event *pev, 3279 struct probe_trace_event **tevs) 3280 { 3281 int ret; 3282 3283 if (!pev->group && !pev->sdt) { 3284 /* Set group name if not given */ 3285 if (!pev->uprobes) { 3286 pev->group = strdup(PERFPROBE_GROUP); 3287 ret = pev->group ? 0 : -ENOMEM; 3288 } else 3289 ret = convert_exec_to_group(pev->target, &pev->group); 3290 if (ret != 0) { 3291 pr_warning("Failed to make a group name.\n"); 3292 return ret; 3293 } 3294 } 3295 3296 ret = try_to_find_absolute_address(pev, tevs); 3297 if (ret > 0) 3298 return ret; 3299 3300 /* At first, we need to lookup cache entry */ 3301 ret = find_probe_trace_events_from_cache(pev, tevs); 3302 if (ret > 0 || pev->sdt) /* SDT can be found only in the cache */ 3303 return ret == 0 ? -ENOENT : ret; /* Found in probe cache */ 3304 3305 /* Convert perf_probe_event with debuginfo */ 3306 ret = try_to_find_probe_trace_events(pev, tevs); 3307 if (ret != 0) 3308 return ret; /* Found in debuginfo or got an error */ 3309 3310 return find_probe_trace_events_from_map(pev, tevs); 3311 } 3312 3313 int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs) 3314 { 3315 int i, ret; 3316 3317 /* Loop 1: convert all events */ 3318 for (i = 0; i < npevs; i++) { 3319 /* Init kprobe blacklist if needed */ 3320 if (!pevs[i].uprobes) 3321 kprobe_blacklist__init(); 3322 /* Convert with or without debuginfo */ 3323 ret = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs); 3324 if (ret < 0) 3325 return ret; 3326 pevs[i].ntevs = ret; 3327 } 3328 /* This just release blacklist only if allocated */ 3329 kprobe_blacklist__release(); 3330 3331 return 0; 3332 } 3333 3334 static int show_probe_trace_event(struct probe_trace_event *tev) 3335 { 3336 char *buf = synthesize_probe_trace_command(tev); 3337 3338 if (!buf) { 3339 pr_debug("Failed to synthesize probe trace event.\n"); 3340 return -EINVAL; 3341 } 3342 3343 /* Showing definition always go stdout */ 3344 printf("%s\n", buf); 3345 free(buf); 3346 3347 return 0; 3348 } 3349 3350 int show_probe_trace_events(struct perf_probe_event *pevs, int npevs) 3351 { 3352 struct strlist *namelist = strlist__new(NULL, NULL); 3353 struct probe_trace_event *tev; 3354 struct perf_probe_event *pev; 3355 int i, j, ret = 0; 3356 3357 if (!namelist) 3358 return -ENOMEM; 3359 3360 for (j = 0; j < npevs && !ret; j++) { 3361 pev = &pevs[j]; 3362 for (i = 0; i < pev->ntevs && !ret; i++) { 3363 tev = &pev->tevs[i]; 3364 /* Skip if the symbol is out of .text or blacklisted */ 3365 if (!tev->point.symbol && !pev->uprobes) 3366 continue; 3367 3368 /* Set new name for tev (and update namelist) */ 3369 ret = probe_trace_event__set_name(tev, pev, 3370 namelist, true); 3371 if (!ret) 3372 ret = show_probe_trace_event(tev); 3373 } 3374 } 3375 strlist__delete(namelist); 3376 3377 return ret; 3378 } 3379 3380 int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs) 3381 { 3382 int i, ret = 0; 3383 3384 /* Loop 2: add all events */ 3385 for (i = 0; i < npevs; i++) { 3386 ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs, 3387 pevs[i].ntevs, 3388 probe_conf.force_add); 3389 if (ret < 0) 3390 break; 3391 } 3392 return ret; 3393 } 3394 3395 void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs) 3396 { 3397 int i, j; 3398 struct perf_probe_event *pev; 3399 3400 /* Loop 3: cleanup and free trace events */ 3401 for (i = 0; i < npevs; i++) { 3402 pev = &pevs[i]; 3403 for (j = 0; j < pevs[i].ntevs; j++) 3404 clear_probe_trace_event(&pevs[i].tevs[j]); 3405 zfree(&pevs[i].tevs); 3406 pevs[i].ntevs = 0; 3407 nsinfo__zput(pev->nsi); 3408 clear_perf_probe_event(&pevs[i]); 3409 } 3410 } 3411 3412 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs) 3413 { 3414 int ret; 3415 3416 ret = init_probe_symbol_maps(pevs->uprobes); 3417 if (ret < 0) 3418 return ret; 3419 3420 ret = convert_perf_probe_events(pevs, npevs); 3421 if (ret == 0) 3422 ret = apply_perf_probe_events(pevs, npevs); 3423 3424 cleanup_perf_probe_events(pevs, npevs); 3425 3426 exit_probe_symbol_maps(); 3427 return ret; 3428 } 3429 3430 int del_perf_probe_events(struct strfilter *filter) 3431 { 3432 int ret, ret2, ufd = -1, kfd = -1; 3433 char *str = strfilter__string(filter); 3434 3435 if (!str) 3436 return -EINVAL; 3437 3438 /* Get current event names */ 3439 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW); 3440 if (ret < 0) 3441 goto out; 3442 3443 ret = probe_file__del_events(kfd, filter); 3444 if (ret < 0 && ret != -ENOENT) 3445 goto error; 3446 3447 ret2 = probe_file__del_events(ufd, filter); 3448 if (ret2 < 0 && ret2 != -ENOENT) { 3449 ret = ret2; 3450 goto error; 3451 } 3452 ret = 0; 3453 3454 error: 3455 if (kfd >= 0) 3456 close(kfd); 3457 if (ufd >= 0) 3458 close(ufd); 3459 out: 3460 free(str); 3461 3462 return ret; 3463 } 3464 3465 int show_available_funcs(const char *target, struct nsinfo *nsi, 3466 struct strfilter *_filter, bool user) 3467 { 3468 struct rb_node *nd; 3469 struct map *map; 3470 int ret; 3471 3472 ret = init_probe_symbol_maps(user); 3473 if (ret < 0) 3474 return ret; 3475 3476 /* Get a symbol map */ 3477 map = get_target_map(target, nsi, user); 3478 if (!map) { 3479 pr_err("Failed to get a map for %s\n", (target) ? : "kernel"); 3480 return -EINVAL; 3481 } 3482 3483 ret = map__load(map); 3484 if (ret) { 3485 if (ret == -2) { 3486 char *str = strfilter__string(_filter); 3487 pr_err("Failed to find symbols matched to \"%s\"\n", 3488 str); 3489 free(str); 3490 } else 3491 pr_err("Failed to load symbols in %s\n", 3492 (target) ? : "kernel"); 3493 goto end; 3494 } 3495 if (!dso__sorted_by_name(map->dso, map->type)) 3496 dso__sort_by_name(map->dso, map->type); 3497 3498 /* Show all (filtered) symbols */ 3499 setup_pager(); 3500 3501 for (nd = rb_first(&map->dso->symbol_names[map->type]); nd; nd = rb_next(nd)) { 3502 struct symbol_name_rb_node *pos = rb_entry(nd, struct symbol_name_rb_node, rb_node); 3503 3504 if (strfilter__compare(_filter, pos->sym.name)) 3505 printf("%s\n", pos->sym.name); 3506 } 3507 3508 end: 3509 map__put(map); 3510 exit_probe_symbol_maps(); 3511 3512 return ret; 3513 } 3514 3515 int copy_to_probe_trace_arg(struct probe_trace_arg *tvar, 3516 struct perf_probe_arg *pvar) 3517 { 3518 tvar->value = strdup(pvar->var); 3519 if (tvar->value == NULL) 3520 return -ENOMEM; 3521 if (pvar->type) { 3522 tvar->type = strdup(pvar->type); 3523 if (tvar->type == NULL) 3524 return -ENOMEM; 3525 } 3526 if (pvar->name) { 3527 tvar->name = strdup(pvar->name); 3528 if (tvar->name == NULL) 3529 return -ENOMEM; 3530 } else 3531 tvar->name = NULL; 3532 return 0; 3533 } 3534