1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Kprobes-based tracing events 4 * 5 * Created by Masami Hiramatsu <mhiramat@redhat.com> 6 * 7 */ 8 #define pr_fmt(fmt) "trace_kprobe: " fmt 9 10 #include <linux/bpf-cgroup.h> 11 #include <linux/security.h> 12 #include <linux/module.h> 13 #include <linux/uaccess.h> 14 #include <linux/rculist.h> 15 #include <linux/error-injection.h> 16 17 #include <asm/setup.h> /* for COMMAND_LINE_SIZE */ 18 19 #include "trace_dynevent.h" 20 #include "trace_kprobe_selftest.h" 21 #include "trace_probe.h" 22 #include "trace_probe_tmpl.h" 23 #include "trace_probe_kernel.h" 24 25 #define KPROBE_EVENT_SYSTEM "kprobes" 26 #define KRETPROBE_MAXACTIVE_MAX 4096 27 28 /* Kprobe early definition from command line */ 29 static char kprobe_boot_events_buf[COMMAND_LINE_SIZE] __initdata; 30 31 static int __init set_kprobe_boot_events(char *str) 32 { 33 strlcpy(kprobe_boot_events_buf, str, COMMAND_LINE_SIZE); 34 disable_tracing_selftest("running kprobe events"); 35 36 return 1; 37 } 38 __setup("kprobe_event=", set_kprobe_boot_events); 39 40 static int trace_kprobe_create(const char *raw_command); 41 static int trace_kprobe_show(struct seq_file *m, struct dyn_event *ev); 42 static int trace_kprobe_release(struct dyn_event *ev); 43 static bool trace_kprobe_is_busy(struct dyn_event *ev); 44 static bool trace_kprobe_match(const char *system, const char *event, 45 int argc, const char **argv, struct dyn_event *ev); 46 47 static struct dyn_event_operations trace_kprobe_ops = { 48 .create = trace_kprobe_create, 49 .show = trace_kprobe_show, 50 .is_busy = trace_kprobe_is_busy, 51 .free = trace_kprobe_release, 52 .match = trace_kprobe_match, 53 }; 54 55 /* 56 * Kprobe event core functions 57 */ 58 struct trace_kprobe { 59 struct dyn_event devent; 60 struct kretprobe rp; /* Use rp.kp for kprobe use */ 61 unsigned long __percpu *nhit; 62 const char *symbol; /* symbol name */ 63 struct trace_probe tp; 64 }; 65 66 static bool is_trace_kprobe(struct dyn_event *ev) 67 { 68 return ev->ops == &trace_kprobe_ops; 69 } 70 71 static struct trace_kprobe *to_trace_kprobe(struct dyn_event *ev) 72 { 73 return container_of(ev, struct trace_kprobe, devent); 74 } 75 76 /** 77 * for_each_trace_kprobe - iterate over the trace_kprobe list 78 * @pos: the struct trace_kprobe * for each entry 79 * @dpos: the struct dyn_event * to use as a loop cursor 80 */ 81 #define for_each_trace_kprobe(pos, dpos) \ 82 for_each_dyn_event(dpos) \ 83 if (is_trace_kprobe(dpos) && (pos = to_trace_kprobe(dpos))) 84 85 static nokprobe_inline bool trace_kprobe_is_return(struct trace_kprobe *tk) 86 { 87 return tk->rp.handler != NULL; 88 } 89 90 static nokprobe_inline const char *trace_kprobe_symbol(struct trace_kprobe *tk) 91 { 92 return tk->symbol ? tk->symbol : "unknown"; 93 } 94 95 static nokprobe_inline unsigned long trace_kprobe_offset(struct trace_kprobe *tk) 96 { 97 return tk->rp.kp.offset; 98 } 99 100 static nokprobe_inline bool trace_kprobe_has_gone(struct trace_kprobe *tk) 101 { 102 return kprobe_gone(&tk->rp.kp); 103 } 104 105 static nokprobe_inline bool trace_kprobe_within_module(struct trace_kprobe *tk, 106 struct module *mod) 107 { 108 int len = strlen(module_name(mod)); 109 const char *name = trace_kprobe_symbol(tk); 110 111 return strncmp(module_name(mod), name, len) == 0 && name[len] == ':'; 112 } 113 114 static nokprobe_inline bool trace_kprobe_module_exist(struct trace_kprobe *tk) 115 { 116 char *p; 117 bool ret; 118 119 if (!tk->symbol) 120 return false; 121 p = strchr(tk->symbol, ':'); 122 if (!p) 123 return true; 124 *p = '\0'; 125 rcu_read_lock_sched(); 126 ret = !!find_module(tk->symbol); 127 rcu_read_unlock_sched(); 128 *p = ':'; 129 130 return ret; 131 } 132 133 static bool trace_kprobe_is_busy(struct dyn_event *ev) 134 { 135 struct trace_kprobe *tk = to_trace_kprobe(ev); 136 137 return trace_probe_is_enabled(&tk->tp); 138 } 139 140 static bool trace_kprobe_match_command_head(struct trace_kprobe *tk, 141 int argc, const char **argv) 142 { 143 char buf[MAX_ARGSTR_LEN + 1]; 144 145 if (!argc) 146 return true; 147 148 if (!tk->symbol) 149 snprintf(buf, sizeof(buf), "0x%p", tk->rp.kp.addr); 150 else if (tk->rp.kp.offset) 151 snprintf(buf, sizeof(buf), "%s+%u", 152 trace_kprobe_symbol(tk), tk->rp.kp.offset); 153 else 154 snprintf(buf, sizeof(buf), "%s", trace_kprobe_symbol(tk)); 155 if (strcmp(buf, argv[0])) 156 return false; 157 argc--; argv++; 158 159 return trace_probe_match_command_args(&tk->tp, argc, argv); 160 } 161 162 static bool trace_kprobe_match(const char *system, const char *event, 163 int argc, const char **argv, struct dyn_event *ev) 164 { 165 struct trace_kprobe *tk = to_trace_kprobe(ev); 166 167 return (event[0] == '\0' || 168 strcmp(trace_probe_name(&tk->tp), event) == 0) && 169 (!system || strcmp(trace_probe_group_name(&tk->tp), system) == 0) && 170 trace_kprobe_match_command_head(tk, argc, argv); 171 } 172 173 static nokprobe_inline unsigned long trace_kprobe_nhit(struct trace_kprobe *tk) 174 { 175 unsigned long nhit = 0; 176 int cpu; 177 178 for_each_possible_cpu(cpu) 179 nhit += *per_cpu_ptr(tk->nhit, cpu); 180 181 return nhit; 182 } 183 184 static nokprobe_inline bool trace_kprobe_is_registered(struct trace_kprobe *tk) 185 { 186 return !(list_empty(&tk->rp.kp.list) && 187 hlist_unhashed(&tk->rp.kp.hlist)); 188 } 189 190 /* Return 0 if it fails to find the symbol address */ 191 static nokprobe_inline 192 unsigned long trace_kprobe_address(struct trace_kprobe *tk) 193 { 194 unsigned long addr; 195 196 if (tk->symbol) { 197 addr = (unsigned long) 198 kallsyms_lookup_name(trace_kprobe_symbol(tk)); 199 if (addr) 200 addr += tk->rp.kp.offset; 201 } else { 202 addr = (unsigned long)tk->rp.kp.addr; 203 } 204 return addr; 205 } 206 207 static nokprobe_inline struct trace_kprobe * 208 trace_kprobe_primary_from_call(struct trace_event_call *call) 209 { 210 struct trace_probe *tp; 211 212 tp = trace_probe_primary_from_call(call); 213 if (WARN_ON_ONCE(!tp)) 214 return NULL; 215 216 return container_of(tp, struct trace_kprobe, tp); 217 } 218 219 bool trace_kprobe_on_func_entry(struct trace_event_call *call) 220 { 221 struct trace_kprobe *tk = trace_kprobe_primary_from_call(call); 222 223 return tk ? (kprobe_on_func_entry(tk->rp.kp.addr, 224 tk->rp.kp.addr ? NULL : tk->rp.kp.symbol_name, 225 tk->rp.kp.addr ? 0 : tk->rp.kp.offset) == 0) : false; 226 } 227 228 bool trace_kprobe_error_injectable(struct trace_event_call *call) 229 { 230 struct trace_kprobe *tk = trace_kprobe_primary_from_call(call); 231 232 return tk ? within_error_injection_list(trace_kprobe_address(tk)) : 233 false; 234 } 235 236 static int register_kprobe_event(struct trace_kprobe *tk); 237 static int unregister_kprobe_event(struct trace_kprobe *tk); 238 239 static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs); 240 static int kretprobe_dispatcher(struct kretprobe_instance *ri, 241 struct pt_regs *regs); 242 243 static void free_trace_kprobe(struct trace_kprobe *tk) 244 { 245 if (tk) { 246 trace_probe_cleanup(&tk->tp); 247 kfree(tk->symbol); 248 free_percpu(tk->nhit); 249 kfree(tk); 250 } 251 } 252 253 /* 254 * Allocate new trace_probe and initialize it (including kprobes). 255 */ 256 static struct trace_kprobe *alloc_trace_kprobe(const char *group, 257 const char *event, 258 void *addr, 259 const char *symbol, 260 unsigned long offs, 261 int maxactive, 262 int nargs, bool is_return) 263 { 264 struct trace_kprobe *tk; 265 int ret = -ENOMEM; 266 267 tk = kzalloc(struct_size(tk, tp.args, nargs), GFP_KERNEL); 268 if (!tk) 269 return ERR_PTR(ret); 270 271 tk->nhit = alloc_percpu(unsigned long); 272 if (!tk->nhit) 273 goto error; 274 275 if (symbol) { 276 tk->symbol = kstrdup(symbol, GFP_KERNEL); 277 if (!tk->symbol) 278 goto error; 279 tk->rp.kp.symbol_name = tk->symbol; 280 tk->rp.kp.offset = offs; 281 } else 282 tk->rp.kp.addr = addr; 283 284 if (is_return) 285 tk->rp.handler = kretprobe_dispatcher; 286 else 287 tk->rp.kp.pre_handler = kprobe_dispatcher; 288 289 tk->rp.maxactive = maxactive; 290 INIT_HLIST_NODE(&tk->rp.kp.hlist); 291 INIT_LIST_HEAD(&tk->rp.kp.list); 292 293 ret = trace_probe_init(&tk->tp, event, group, false); 294 if (ret < 0) 295 goto error; 296 297 dyn_event_init(&tk->devent, &trace_kprobe_ops); 298 return tk; 299 error: 300 free_trace_kprobe(tk); 301 return ERR_PTR(ret); 302 } 303 304 static struct trace_kprobe *find_trace_kprobe(const char *event, 305 const char *group) 306 { 307 struct dyn_event *pos; 308 struct trace_kprobe *tk; 309 310 for_each_trace_kprobe(tk, pos) 311 if (strcmp(trace_probe_name(&tk->tp), event) == 0 && 312 strcmp(trace_probe_group_name(&tk->tp), group) == 0) 313 return tk; 314 return NULL; 315 } 316 317 static inline int __enable_trace_kprobe(struct trace_kprobe *tk) 318 { 319 int ret = 0; 320 321 if (trace_kprobe_is_registered(tk) && !trace_kprobe_has_gone(tk)) { 322 if (trace_kprobe_is_return(tk)) 323 ret = enable_kretprobe(&tk->rp); 324 else 325 ret = enable_kprobe(&tk->rp.kp); 326 } 327 328 return ret; 329 } 330 331 static void __disable_trace_kprobe(struct trace_probe *tp) 332 { 333 struct trace_kprobe *tk; 334 335 list_for_each_entry(tk, trace_probe_probe_list(tp), tp.list) { 336 if (!trace_kprobe_is_registered(tk)) 337 continue; 338 if (trace_kprobe_is_return(tk)) 339 disable_kretprobe(&tk->rp); 340 else 341 disable_kprobe(&tk->rp.kp); 342 } 343 } 344 345 /* 346 * Enable trace_probe 347 * if the file is NULL, enable "perf" handler, or enable "trace" handler. 348 */ 349 static int enable_trace_kprobe(struct trace_event_call *call, 350 struct trace_event_file *file) 351 { 352 struct trace_probe *tp; 353 struct trace_kprobe *tk; 354 bool enabled; 355 int ret = 0; 356 357 tp = trace_probe_primary_from_call(call); 358 if (WARN_ON_ONCE(!tp)) 359 return -ENODEV; 360 enabled = trace_probe_is_enabled(tp); 361 362 /* This also changes "enabled" state */ 363 if (file) { 364 ret = trace_probe_add_file(tp, file); 365 if (ret) 366 return ret; 367 } else 368 trace_probe_set_flag(tp, TP_FLAG_PROFILE); 369 370 if (enabled) 371 return 0; 372 373 list_for_each_entry(tk, trace_probe_probe_list(tp), tp.list) { 374 if (trace_kprobe_has_gone(tk)) 375 continue; 376 ret = __enable_trace_kprobe(tk); 377 if (ret) 378 break; 379 enabled = true; 380 } 381 382 if (ret) { 383 /* Failed to enable one of them. Roll back all */ 384 if (enabled) 385 __disable_trace_kprobe(tp); 386 if (file) 387 trace_probe_remove_file(tp, file); 388 else 389 trace_probe_clear_flag(tp, TP_FLAG_PROFILE); 390 } 391 392 return ret; 393 } 394 395 /* 396 * Disable trace_probe 397 * if the file is NULL, disable "perf" handler, or disable "trace" handler. 398 */ 399 static int disable_trace_kprobe(struct trace_event_call *call, 400 struct trace_event_file *file) 401 { 402 struct trace_probe *tp; 403 404 tp = trace_probe_primary_from_call(call); 405 if (WARN_ON_ONCE(!tp)) 406 return -ENODEV; 407 408 if (file) { 409 if (!trace_probe_get_file_link(tp, file)) 410 return -ENOENT; 411 if (!trace_probe_has_single_file(tp)) 412 goto out; 413 trace_probe_clear_flag(tp, TP_FLAG_TRACE); 414 } else 415 trace_probe_clear_flag(tp, TP_FLAG_PROFILE); 416 417 if (!trace_probe_is_enabled(tp)) 418 __disable_trace_kprobe(tp); 419 420 out: 421 if (file) 422 /* 423 * Synchronization is done in below function. For perf event, 424 * file == NULL and perf_trace_event_unreg() calls 425 * tracepoint_synchronize_unregister() to ensure synchronize 426 * event. We don't need to care about it. 427 */ 428 trace_probe_remove_file(tp, file); 429 430 return 0; 431 } 432 433 #if defined(CONFIG_DYNAMIC_FTRACE) && \ 434 !defined(CONFIG_KPROBE_EVENTS_ON_NOTRACE) 435 static bool __within_notrace_func(unsigned long addr) 436 { 437 unsigned long offset, size; 438 439 if (!addr || !kallsyms_lookup_size_offset(addr, &size, &offset)) 440 return false; 441 442 /* Get the entry address of the target function */ 443 addr -= offset; 444 445 /* 446 * Since ftrace_location_range() does inclusive range check, we need 447 * to subtract 1 byte from the end address. 448 */ 449 return !ftrace_location_range(addr, addr + size - 1); 450 } 451 452 static bool within_notrace_func(struct trace_kprobe *tk) 453 { 454 unsigned long addr = trace_kprobe_address(tk); 455 char symname[KSYM_NAME_LEN], *p; 456 457 if (!__within_notrace_func(addr)) 458 return false; 459 460 /* Check if the address is on a suffixed-symbol */ 461 if (!lookup_symbol_name(addr, symname)) { 462 p = strchr(symname, '.'); 463 if (!p) 464 return true; 465 *p = '\0'; 466 addr = (unsigned long)kprobe_lookup_name(symname, 0); 467 if (addr) 468 return __within_notrace_func(addr); 469 } 470 471 return true; 472 } 473 #else 474 #define within_notrace_func(tk) (false) 475 #endif 476 477 /* Internal register function - just handle k*probes and flags */ 478 static int __register_trace_kprobe(struct trace_kprobe *tk) 479 { 480 int i, ret; 481 482 ret = security_locked_down(LOCKDOWN_KPROBES); 483 if (ret) 484 return ret; 485 486 if (trace_kprobe_is_registered(tk)) 487 return -EINVAL; 488 489 if (within_notrace_func(tk)) { 490 pr_warn("Could not probe notrace function %s\n", 491 trace_kprobe_symbol(tk)); 492 return -EINVAL; 493 } 494 495 for (i = 0; i < tk->tp.nr_args; i++) { 496 ret = traceprobe_update_arg(&tk->tp.args[i]); 497 if (ret) 498 return ret; 499 } 500 501 /* Set/clear disabled flag according to tp->flag */ 502 if (trace_probe_is_enabled(&tk->tp)) 503 tk->rp.kp.flags &= ~KPROBE_FLAG_DISABLED; 504 else 505 tk->rp.kp.flags |= KPROBE_FLAG_DISABLED; 506 507 if (trace_kprobe_is_return(tk)) 508 ret = register_kretprobe(&tk->rp); 509 else 510 ret = register_kprobe(&tk->rp.kp); 511 512 return ret; 513 } 514 515 /* Internal unregister function - just handle k*probes and flags */ 516 static void __unregister_trace_kprobe(struct trace_kprobe *tk) 517 { 518 if (trace_kprobe_is_registered(tk)) { 519 if (trace_kprobe_is_return(tk)) 520 unregister_kretprobe(&tk->rp); 521 else 522 unregister_kprobe(&tk->rp.kp); 523 /* Cleanup kprobe for reuse and mark it unregistered */ 524 INIT_HLIST_NODE(&tk->rp.kp.hlist); 525 INIT_LIST_HEAD(&tk->rp.kp.list); 526 if (tk->rp.kp.symbol_name) 527 tk->rp.kp.addr = NULL; 528 } 529 } 530 531 /* Unregister a trace_probe and probe_event */ 532 static int unregister_trace_kprobe(struct trace_kprobe *tk) 533 { 534 /* If other probes are on the event, just unregister kprobe */ 535 if (trace_probe_has_sibling(&tk->tp)) 536 goto unreg; 537 538 /* Enabled event can not be unregistered */ 539 if (trace_probe_is_enabled(&tk->tp)) 540 return -EBUSY; 541 542 /* If there's a reference to the dynamic event */ 543 if (trace_event_dyn_busy(trace_probe_event_call(&tk->tp))) 544 return -EBUSY; 545 546 /* Will fail if probe is being used by ftrace or perf */ 547 if (unregister_kprobe_event(tk)) 548 return -EBUSY; 549 550 unreg: 551 __unregister_trace_kprobe(tk); 552 dyn_event_remove(&tk->devent); 553 trace_probe_unlink(&tk->tp); 554 555 return 0; 556 } 557 558 static bool trace_kprobe_has_same_kprobe(struct trace_kprobe *orig, 559 struct trace_kprobe *comp) 560 { 561 struct trace_probe_event *tpe = orig->tp.event; 562 int i; 563 564 list_for_each_entry(orig, &tpe->probes, tp.list) { 565 if (strcmp(trace_kprobe_symbol(orig), 566 trace_kprobe_symbol(comp)) || 567 trace_kprobe_offset(orig) != trace_kprobe_offset(comp)) 568 continue; 569 570 /* 571 * trace_probe_compare_arg_type() ensured that nr_args and 572 * each argument name and type are same. Let's compare comm. 573 */ 574 for (i = 0; i < orig->tp.nr_args; i++) { 575 if (strcmp(orig->tp.args[i].comm, 576 comp->tp.args[i].comm)) 577 break; 578 } 579 580 if (i == orig->tp.nr_args) 581 return true; 582 } 583 584 return false; 585 } 586 587 static int append_trace_kprobe(struct trace_kprobe *tk, struct trace_kprobe *to) 588 { 589 int ret; 590 591 ret = trace_probe_compare_arg_type(&tk->tp, &to->tp); 592 if (ret) { 593 /* Note that argument starts index = 2 */ 594 trace_probe_log_set_index(ret + 1); 595 trace_probe_log_err(0, DIFF_ARG_TYPE); 596 return -EEXIST; 597 } 598 if (trace_kprobe_has_same_kprobe(to, tk)) { 599 trace_probe_log_set_index(0); 600 trace_probe_log_err(0, SAME_PROBE); 601 return -EEXIST; 602 } 603 604 /* Append to existing event */ 605 ret = trace_probe_append(&tk->tp, &to->tp); 606 if (ret) 607 return ret; 608 609 /* Register k*probe */ 610 ret = __register_trace_kprobe(tk); 611 if (ret == -ENOENT && !trace_kprobe_module_exist(tk)) { 612 pr_warn("This probe might be able to register after target module is loaded. Continue.\n"); 613 ret = 0; 614 } 615 616 if (ret) 617 trace_probe_unlink(&tk->tp); 618 else 619 dyn_event_add(&tk->devent, trace_probe_event_call(&tk->tp)); 620 621 return ret; 622 } 623 624 /* Register a trace_probe and probe_event */ 625 static int register_trace_kprobe(struct trace_kprobe *tk) 626 { 627 struct trace_kprobe *old_tk; 628 int ret; 629 630 mutex_lock(&event_mutex); 631 632 old_tk = find_trace_kprobe(trace_probe_name(&tk->tp), 633 trace_probe_group_name(&tk->tp)); 634 if (old_tk) { 635 if (trace_kprobe_is_return(tk) != trace_kprobe_is_return(old_tk)) { 636 trace_probe_log_set_index(0); 637 trace_probe_log_err(0, DIFF_PROBE_TYPE); 638 ret = -EEXIST; 639 } else { 640 ret = append_trace_kprobe(tk, old_tk); 641 } 642 goto end; 643 } 644 645 /* Register new event */ 646 ret = register_kprobe_event(tk); 647 if (ret) { 648 if (ret == -EEXIST) { 649 trace_probe_log_set_index(0); 650 trace_probe_log_err(0, EVENT_EXIST); 651 } else 652 pr_warn("Failed to register probe event(%d)\n", ret); 653 goto end; 654 } 655 656 /* Register k*probe */ 657 ret = __register_trace_kprobe(tk); 658 if (ret == -ENOENT && !trace_kprobe_module_exist(tk)) { 659 pr_warn("This probe might be able to register after target module is loaded. Continue.\n"); 660 ret = 0; 661 } 662 663 if (ret < 0) 664 unregister_kprobe_event(tk); 665 else 666 dyn_event_add(&tk->devent, trace_probe_event_call(&tk->tp)); 667 668 end: 669 mutex_unlock(&event_mutex); 670 return ret; 671 } 672 673 /* Module notifier call back, checking event on the module */ 674 static int trace_kprobe_module_callback(struct notifier_block *nb, 675 unsigned long val, void *data) 676 { 677 struct module *mod = data; 678 struct dyn_event *pos; 679 struct trace_kprobe *tk; 680 int ret; 681 682 if (val != MODULE_STATE_COMING) 683 return NOTIFY_DONE; 684 685 /* Update probes on coming module */ 686 mutex_lock(&event_mutex); 687 for_each_trace_kprobe(tk, pos) { 688 if (trace_kprobe_within_module(tk, mod)) { 689 /* Don't need to check busy - this should have gone. */ 690 __unregister_trace_kprobe(tk); 691 ret = __register_trace_kprobe(tk); 692 if (ret) 693 pr_warn("Failed to re-register probe %s on %s: %d\n", 694 trace_probe_name(&tk->tp), 695 module_name(mod), ret); 696 } 697 } 698 mutex_unlock(&event_mutex); 699 700 return NOTIFY_DONE; 701 } 702 703 static struct notifier_block trace_kprobe_module_nb = { 704 .notifier_call = trace_kprobe_module_callback, 705 .priority = 1 /* Invoked after kprobe module callback */ 706 }; 707 708 static int __trace_kprobe_create(int argc, const char *argv[]) 709 { 710 /* 711 * Argument syntax: 712 * - Add kprobe: 713 * p[:[GRP/][EVENT]] [MOD:]KSYM[+OFFS]|KADDR [FETCHARGS] 714 * - Add kretprobe: 715 * r[MAXACTIVE][:[GRP/][EVENT]] [MOD:]KSYM[+0] [FETCHARGS] 716 * Or 717 * p[:[GRP/][EVENT]] [MOD:]KSYM[+0]%return [FETCHARGS] 718 * 719 * Fetch args: 720 * $retval : fetch return value 721 * $stack : fetch stack address 722 * $stackN : fetch Nth of stack (N:0-) 723 * $comm : fetch current task comm 724 * @ADDR : fetch memory at ADDR (ADDR should be in kernel) 725 * @SYM[+|-offs] : fetch memory at SYM +|- offs (SYM is a data symbol) 726 * %REG : fetch register REG 727 * Dereferencing memory fetch: 728 * +|-offs(ARG) : fetch memory at ARG +|- offs address. 729 * Alias name of args: 730 * NAME=FETCHARG : set NAME as alias of FETCHARG. 731 * Type of args: 732 * FETCHARG:TYPE : use TYPE instead of unsigned long. 733 */ 734 struct trace_kprobe *tk = NULL; 735 int i, len, ret = 0; 736 bool is_return = false; 737 char *symbol = NULL, *tmp = NULL; 738 const char *event = NULL, *group = KPROBE_EVENT_SYSTEM; 739 enum probe_print_type ptype; 740 int maxactive = 0; 741 long offset = 0; 742 void *addr = NULL; 743 char buf[MAX_EVENT_NAME_LEN]; 744 char gbuf[MAX_EVENT_NAME_LEN]; 745 unsigned int flags = TPARG_FL_KERNEL; 746 747 switch (argv[0][0]) { 748 case 'r': 749 is_return = true; 750 break; 751 case 'p': 752 break; 753 default: 754 return -ECANCELED; 755 } 756 if (argc < 2) 757 return -ECANCELED; 758 759 trace_probe_log_init("trace_kprobe", argc, argv); 760 761 event = strchr(&argv[0][1], ':'); 762 if (event) 763 event++; 764 765 if (isdigit(argv[0][1])) { 766 if (!is_return) { 767 trace_probe_log_err(1, MAXACT_NO_KPROBE); 768 goto parse_error; 769 } 770 if (event) 771 len = event - &argv[0][1] - 1; 772 else 773 len = strlen(&argv[0][1]); 774 if (len > MAX_EVENT_NAME_LEN - 1) { 775 trace_probe_log_err(1, BAD_MAXACT); 776 goto parse_error; 777 } 778 memcpy(buf, &argv[0][1], len); 779 buf[len] = '\0'; 780 ret = kstrtouint(buf, 0, &maxactive); 781 if (ret || !maxactive) { 782 trace_probe_log_err(1, BAD_MAXACT); 783 goto parse_error; 784 } 785 /* kretprobes instances are iterated over via a list. The 786 * maximum should stay reasonable. 787 */ 788 if (maxactive > KRETPROBE_MAXACTIVE_MAX) { 789 trace_probe_log_err(1, MAXACT_TOO_BIG); 790 goto parse_error; 791 } 792 } 793 794 /* try to parse an address. if that fails, try to read the 795 * input as a symbol. */ 796 if (kstrtoul(argv[1], 0, (unsigned long *)&addr)) { 797 trace_probe_log_set_index(1); 798 /* Check whether uprobe event specified */ 799 if (strchr(argv[1], '/') && strchr(argv[1], ':')) { 800 ret = -ECANCELED; 801 goto error; 802 } 803 /* a symbol specified */ 804 symbol = kstrdup(argv[1], GFP_KERNEL); 805 if (!symbol) 806 return -ENOMEM; 807 808 tmp = strchr(symbol, '%'); 809 if (tmp) { 810 if (!strcmp(tmp, "%return")) { 811 *tmp = '\0'; 812 is_return = true; 813 } else { 814 trace_probe_log_err(tmp - symbol, BAD_ADDR_SUFFIX); 815 goto parse_error; 816 } 817 } 818 819 /* TODO: support .init module functions */ 820 ret = traceprobe_split_symbol_offset(symbol, &offset); 821 if (ret || offset < 0 || offset > UINT_MAX) { 822 trace_probe_log_err(0, BAD_PROBE_ADDR); 823 goto parse_error; 824 } 825 if (is_return) 826 flags |= TPARG_FL_RETURN; 827 ret = kprobe_on_func_entry(NULL, symbol, offset); 828 if (ret == 0) 829 flags |= TPARG_FL_FENTRY; 830 /* Defer the ENOENT case until register kprobe */ 831 if (ret == -EINVAL && is_return) { 832 trace_probe_log_err(0, BAD_RETPROBE); 833 goto parse_error; 834 } 835 } 836 837 trace_probe_log_set_index(0); 838 if (event) { 839 ret = traceprobe_parse_event_name(&event, &group, gbuf, 840 event - argv[0]); 841 if (ret) 842 goto parse_error; 843 } 844 845 if (!event) { 846 /* Make a new event name */ 847 if (symbol) 848 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_%s_%ld", 849 is_return ? 'r' : 'p', symbol, offset); 850 else 851 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_0x%p", 852 is_return ? 'r' : 'p', addr); 853 sanitize_event_name(buf); 854 event = buf; 855 } 856 857 /* setup a probe */ 858 tk = alloc_trace_kprobe(group, event, addr, symbol, offset, maxactive, 859 argc - 2, is_return); 860 if (IS_ERR(tk)) { 861 ret = PTR_ERR(tk); 862 /* This must return -ENOMEM, else there is a bug */ 863 WARN_ON_ONCE(ret != -ENOMEM); 864 goto out; /* We know tk is not allocated */ 865 } 866 argc -= 2; argv += 2; 867 868 /* parse arguments */ 869 for (i = 0; i < argc && i < MAX_TRACE_ARGS; i++) { 870 trace_probe_log_set_index(i + 2); 871 ret = traceprobe_parse_probe_arg(&tk->tp, i, argv[i], flags); 872 if (ret) 873 goto error; /* This can be -ENOMEM */ 874 } 875 876 ptype = is_return ? PROBE_PRINT_RETURN : PROBE_PRINT_NORMAL; 877 ret = traceprobe_set_print_fmt(&tk->tp, ptype); 878 if (ret < 0) 879 goto error; 880 881 ret = register_trace_kprobe(tk); 882 if (ret) { 883 trace_probe_log_set_index(1); 884 if (ret == -EILSEQ) 885 trace_probe_log_err(0, BAD_INSN_BNDRY); 886 else if (ret == -ENOENT) 887 trace_probe_log_err(0, BAD_PROBE_ADDR); 888 else if (ret != -ENOMEM && ret != -EEXIST) 889 trace_probe_log_err(0, FAIL_REG_PROBE); 890 goto error; 891 } 892 893 out: 894 trace_probe_log_clear(); 895 kfree(symbol); 896 return ret; 897 898 parse_error: 899 ret = -EINVAL; 900 error: 901 free_trace_kprobe(tk); 902 goto out; 903 } 904 905 static int trace_kprobe_create(const char *raw_command) 906 { 907 return trace_probe_create(raw_command, __trace_kprobe_create); 908 } 909 910 static int create_or_delete_trace_kprobe(const char *raw_command) 911 { 912 int ret; 913 914 if (raw_command[0] == '-') 915 return dyn_event_release(raw_command, &trace_kprobe_ops); 916 917 ret = trace_kprobe_create(raw_command); 918 return ret == -ECANCELED ? -EINVAL : ret; 919 } 920 921 static int trace_kprobe_run_command(struct dynevent_cmd *cmd) 922 { 923 return create_or_delete_trace_kprobe(cmd->seq.buffer); 924 } 925 926 /** 927 * kprobe_event_cmd_init - Initialize a kprobe event command object 928 * @cmd: A pointer to the dynevent_cmd struct representing the new event 929 * @buf: A pointer to the buffer used to build the command 930 * @maxlen: The length of the buffer passed in @buf 931 * 932 * Initialize a synthetic event command object. Use this before 933 * calling any of the other kprobe_event functions. 934 */ 935 void kprobe_event_cmd_init(struct dynevent_cmd *cmd, char *buf, int maxlen) 936 { 937 dynevent_cmd_init(cmd, buf, maxlen, DYNEVENT_TYPE_KPROBE, 938 trace_kprobe_run_command); 939 } 940 EXPORT_SYMBOL_GPL(kprobe_event_cmd_init); 941 942 /** 943 * __kprobe_event_gen_cmd_start - Generate a kprobe event command from arg list 944 * @cmd: A pointer to the dynevent_cmd struct representing the new event 945 * @name: The name of the kprobe event 946 * @loc: The location of the kprobe event 947 * @kretprobe: Is this a return probe? 948 * @args: Variable number of arg (pairs), one pair for each field 949 * 950 * NOTE: Users normally won't want to call this function directly, but 951 * rather use the kprobe_event_gen_cmd_start() wrapper, which automatically 952 * adds a NULL to the end of the arg list. If this function is used 953 * directly, make sure the last arg in the variable arg list is NULL. 954 * 955 * Generate a kprobe event command to be executed by 956 * kprobe_event_gen_cmd_end(). This function can be used to generate the 957 * complete command or only the first part of it; in the latter case, 958 * kprobe_event_add_fields() can be used to add more fields following this. 959 * 960 * Unlikely the synth_event_gen_cmd_start(), @loc must be specified. This 961 * returns -EINVAL if @loc == NULL. 962 * 963 * Return: 0 if successful, error otherwise. 964 */ 965 int __kprobe_event_gen_cmd_start(struct dynevent_cmd *cmd, bool kretprobe, 966 const char *name, const char *loc, ...) 967 { 968 char buf[MAX_EVENT_NAME_LEN]; 969 struct dynevent_arg arg; 970 va_list args; 971 int ret; 972 973 if (cmd->type != DYNEVENT_TYPE_KPROBE) 974 return -EINVAL; 975 976 if (!loc) 977 return -EINVAL; 978 979 if (kretprobe) 980 snprintf(buf, MAX_EVENT_NAME_LEN, "r:kprobes/%s", name); 981 else 982 snprintf(buf, MAX_EVENT_NAME_LEN, "p:kprobes/%s", name); 983 984 ret = dynevent_str_add(cmd, buf); 985 if (ret) 986 return ret; 987 988 dynevent_arg_init(&arg, 0); 989 arg.str = loc; 990 ret = dynevent_arg_add(cmd, &arg, NULL); 991 if (ret) 992 return ret; 993 994 va_start(args, loc); 995 for (;;) { 996 const char *field; 997 998 field = va_arg(args, const char *); 999 if (!field) 1000 break; 1001 1002 if (++cmd->n_fields > MAX_TRACE_ARGS) { 1003 ret = -EINVAL; 1004 break; 1005 } 1006 1007 arg.str = field; 1008 ret = dynevent_arg_add(cmd, &arg, NULL); 1009 if (ret) 1010 break; 1011 } 1012 va_end(args); 1013 1014 return ret; 1015 } 1016 EXPORT_SYMBOL_GPL(__kprobe_event_gen_cmd_start); 1017 1018 /** 1019 * __kprobe_event_add_fields - Add probe fields to a kprobe command from arg list 1020 * @cmd: A pointer to the dynevent_cmd struct representing the new event 1021 * @args: Variable number of arg (pairs), one pair for each field 1022 * 1023 * NOTE: Users normally won't want to call this function directly, but 1024 * rather use the kprobe_event_add_fields() wrapper, which 1025 * automatically adds a NULL to the end of the arg list. If this 1026 * function is used directly, make sure the last arg in the variable 1027 * arg list is NULL. 1028 * 1029 * Add probe fields to an existing kprobe command using a variable 1030 * list of args. Fields are added in the same order they're listed. 1031 * 1032 * Return: 0 if successful, error otherwise. 1033 */ 1034 int __kprobe_event_add_fields(struct dynevent_cmd *cmd, ...) 1035 { 1036 struct dynevent_arg arg; 1037 va_list args; 1038 int ret = 0; 1039 1040 if (cmd->type != DYNEVENT_TYPE_KPROBE) 1041 return -EINVAL; 1042 1043 dynevent_arg_init(&arg, 0); 1044 1045 va_start(args, cmd); 1046 for (;;) { 1047 const char *field; 1048 1049 field = va_arg(args, const char *); 1050 if (!field) 1051 break; 1052 1053 if (++cmd->n_fields > MAX_TRACE_ARGS) { 1054 ret = -EINVAL; 1055 break; 1056 } 1057 1058 arg.str = field; 1059 ret = dynevent_arg_add(cmd, &arg, NULL); 1060 if (ret) 1061 break; 1062 } 1063 va_end(args); 1064 1065 return ret; 1066 } 1067 EXPORT_SYMBOL_GPL(__kprobe_event_add_fields); 1068 1069 /** 1070 * kprobe_event_delete - Delete a kprobe event 1071 * @name: The name of the kprobe event to delete 1072 * 1073 * Delete a kprobe event with the give @name from kernel code rather 1074 * than directly from the command line. 1075 * 1076 * Return: 0 if successful, error otherwise. 1077 */ 1078 int kprobe_event_delete(const char *name) 1079 { 1080 char buf[MAX_EVENT_NAME_LEN]; 1081 1082 snprintf(buf, MAX_EVENT_NAME_LEN, "-:%s", name); 1083 1084 return create_or_delete_trace_kprobe(buf); 1085 } 1086 EXPORT_SYMBOL_GPL(kprobe_event_delete); 1087 1088 static int trace_kprobe_release(struct dyn_event *ev) 1089 { 1090 struct trace_kprobe *tk = to_trace_kprobe(ev); 1091 int ret = unregister_trace_kprobe(tk); 1092 1093 if (!ret) 1094 free_trace_kprobe(tk); 1095 return ret; 1096 } 1097 1098 static int trace_kprobe_show(struct seq_file *m, struct dyn_event *ev) 1099 { 1100 struct trace_kprobe *tk = to_trace_kprobe(ev); 1101 int i; 1102 1103 seq_putc(m, trace_kprobe_is_return(tk) ? 'r' : 'p'); 1104 if (trace_kprobe_is_return(tk) && tk->rp.maxactive) 1105 seq_printf(m, "%d", tk->rp.maxactive); 1106 seq_printf(m, ":%s/%s", trace_probe_group_name(&tk->tp), 1107 trace_probe_name(&tk->tp)); 1108 1109 if (!tk->symbol) 1110 seq_printf(m, " 0x%p", tk->rp.kp.addr); 1111 else if (tk->rp.kp.offset) 1112 seq_printf(m, " %s+%u", trace_kprobe_symbol(tk), 1113 tk->rp.kp.offset); 1114 else 1115 seq_printf(m, " %s", trace_kprobe_symbol(tk)); 1116 1117 for (i = 0; i < tk->tp.nr_args; i++) 1118 seq_printf(m, " %s=%s", tk->tp.args[i].name, tk->tp.args[i].comm); 1119 seq_putc(m, '\n'); 1120 1121 return 0; 1122 } 1123 1124 static int probes_seq_show(struct seq_file *m, void *v) 1125 { 1126 struct dyn_event *ev = v; 1127 1128 if (!is_trace_kprobe(ev)) 1129 return 0; 1130 1131 return trace_kprobe_show(m, ev); 1132 } 1133 1134 static const struct seq_operations probes_seq_op = { 1135 .start = dyn_event_seq_start, 1136 .next = dyn_event_seq_next, 1137 .stop = dyn_event_seq_stop, 1138 .show = probes_seq_show 1139 }; 1140 1141 static int probes_open(struct inode *inode, struct file *file) 1142 { 1143 int ret; 1144 1145 ret = security_locked_down(LOCKDOWN_TRACEFS); 1146 if (ret) 1147 return ret; 1148 1149 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) { 1150 ret = dyn_events_release_all(&trace_kprobe_ops); 1151 if (ret < 0) 1152 return ret; 1153 } 1154 1155 return seq_open(file, &probes_seq_op); 1156 } 1157 1158 static ssize_t probes_write(struct file *file, const char __user *buffer, 1159 size_t count, loff_t *ppos) 1160 { 1161 return trace_parse_run_command(file, buffer, count, ppos, 1162 create_or_delete_trace_kprobe); 1163 } 1164 1165 static const struct file_operations kprobe_events_ops = { 1166 .owner = THIS_MODULE, 1167 .open = probes_open, 1168 .read = seq_read, 1169 .llseek = seq_lseek, 1170 .release = seq_release, 1171 .write = probes_write, 1172 }; 1173 1174 /* Probes profiling interfaces */ 1175 static int probes_profile_seq_show(struct seq_file *m, void *v) 1176 { 1177 struct dyn_event *ev = v; 1178 struct trace_kprobe *tk; 1179 unsigned long nmissed; 1180 1181 if (!is_trace_kprobe(ev)) 1182 return 0; 1183 1184 tk = to_trace_kprobe(ev); 1185 nmissed = trace_kprobe_is_return(tk) ? 1186 tk->rp.kp.nmissed + tk->rp.nmissed : tk->rp.kp.nmissed; 1187 seq_printf(m, " %-44s %15lu %15lu\n", 1188 trace_probe_name(&tk->tp), 1189 trace_kprobe_nhit(tk), 1190 nmissed); 1191 1192 return 0; 1193 } 1194 1195 static const struct seq_operations profile_seq_op = { 1196 .start = dyn_event_seq_start, 1197 .next = dyn_event_seq_next, 1198 .stop = dyn_event_seq_stop, 1199 .show = probes_profile_seq_show 1200 }; 1201 1202 static int profile_open(struct inode *inode, struct file *file) 1203 { 1204 int ret; 1205 1206 ret = security_locked_down(LOCKDOWN_TRACEFS); 1207 if (ret) 1208 return ret; 1209 1210 return seq_open(file, &profile_seq_op); 1211 } 1212 1213 static const struct file_operations kprobe_profile_ops = { 1214 .owner = THIS_MODULE, 1215 .open = profile_open, 1216 .read = seq_read, 1217 .llseek = seq_lseek, 1218 .release = seq_release, 1219 }; 1220 1221 /* Note that we don't verify it, since the code does not come from user space */ 1222 static int 1223 process_fetch_insn(struct fetch_insn *code, void *rec, void *dest, 1224 void *base) 1225 { 1226 struct pt_regs *regs = rec; 1227 unsigned long val; 1228 int ret; 1229 1230 retry: 1231 /* 1st stage: get value from context */ 1232 switch (code->op) { 1233 case FETCH_OP_REG: 1234 val = regs_get_register(regs, code->param); 1235 break; 1236 case FETCH_OP_STACK: 1237 val = regs_get_kernel_stack_nth(regs, code->param); 1238 break; 1239 case FETCH_OP_STACKP: 1240 val = kernel_stack_pointer(regs); 1241 break; 1242 case FETCH_OP_RETVAL: 1243 val = regs_return_value(regs); 1244 break; 1245 #ifdef CONFIG_HAVE_FUNCTION_ARG_ACCESS_API 1246 case FETCH_OP_ARG: 1247 val = regs_get_kernel_argument(regs, code->param); 1248 break; 1249 #endif 1250 case FETCH_NOP_SYMBOL: /* Ignore a place holder */ 1251 code++; 1252 goto retry; 1253 default: 1254 ret = process_common_fetch_insn(code, &val); 1255 if (ret < 0) 1256 return ret; 1257 } 1258 code++; 1259 1260 return process_fetch_insn_bottom(code, val, dest, base); 1261 } 1262 NOKPROBE_SYMBOL(process_fetch_insn) 1263 1264 /* Kprobe handler */ 1265 static nokprobe_inline void 1266 __kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs, 1267 struct trace_event_file *trace_file) 1268 { 1269 struct kprobe_trace_entry_head *entry; 1270 struct trace_event_call *call = trace_probe_event_call(&tk->tp); 1271 struct trace_event_buffer fbuffer; 1272 int dsize; 1273 1274 WARN_ON(call != trace_file->event_call); 1275 1276 if (trace_trigger_soft_disabled(trace_file)) 1277 return; 1278 1279 dsize = __get_data_size(&tk->tp, regs); 1280 1281 entry = trace_event_buffer_reserve(&fbuffer, trace_file, 1282 sizeof(*entry) + tk->tp.size + dsize); 1283 if (!entry) 1284 return; 1285 1286 fbuffer.regs = regs; 1287 entry->ip = (unsigned long)tk->rp.kp.addr; 1288 store_trace_args(&entry[1], &tk->tp, regs, sizeof(*entry), dsize); 1289 1290 trace_event_buffer_commit(&fbuffer); 1291 } 1292 1293 static void 1294 kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs) 1295 { 1296 struct event_file_link *link; 1297 1298 trace_probe_for_each_link_rcu(link, &tk->tp) 1299 __kprobe_trace_func(tk, regs, link->file); 1300 } 1301 NOKPROBE_SYMBOL(kprobe_trace_func); 1302 1303 /* Kretprobe handler */ 1304 static nokprobe_inline void 1305 __kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri, 1306 struct pt_regs *regs, 1307 struct trace_event_file *trace_file) 1308 { 1309 struct kretprobe_trace_entry_head *entry; 1310 struct trace_event_buffer fbuffer; 1311 struct trace_event_call *call = trace_probe_event_call(&tk->tp); 1312 int dsize; 1313 1314 WARN_ON(call != trace_file->event_call); 1315 1316 if (trace_trigger_soft_disabled(trace_file)) 1317 return; 1318 1319 dsize = __get_data_size(&tk->tp, regs); 1320 1321 entry = trace_event_buffer_reserve(&fbuffer, trace_file, 1322 sizeof(*entry) + tk->tp.size + dsize); 1323 if (!entry) 1324 return; 1325 1326 fbuffer.regs = regs; 1327 entry->func = (unsigned long)tk->rp.kp.addr; 1328 entry->ret_ip = get_kretprobe_retaddr(ri); 1329 store_trace_args(&entry[1], &tk->tp, regs, sizeof(*entry), dsize); 1330 1331 trace_event_buffer_commit(&fbuffer); 1332 } 1333 1334 static void 1335 kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri, 1336 struct pt_regs *regs) 1337 { 1338 struct event_file_link *link; 1339 1340 trace_probe_for_each_link_rcu(link, &tk->tp) 1341 __kretprobe_trace_func(tk, ri, regs, link->file); 1342 } 1343 NOKPROBE_SYMBOL(kretprobe_trace_func); 1344 1345 /* Event entry printers */ 1346 static enum print_line_t 1347 print_kprobe_event(struct trace_iterator *iter, int flags, 1348 struct trace_event *event) 1349 { 1350 struct kprobe_trace_entry_head *field; 1351 struct trace_seq *s = &iter->seq; 1352 struct trace_probe *tp; 1353 1354 field = (struct kprobe_trace_entry_head *)iter->ent; 1355 tp = trace_probe_primary_from_call( 1356 container_of(event, struct trace_event_call, event)); 1357 if (WARN_ON_ONCE(!tp)) 1358 goto out; 1359 1360 trace_seq_printf(s, "%s: (", trace_probe_name(tp)); 1361 1362 if (!seq_print_ip_sym(s, field->ip, flags | TRACE_ITER_SYM_OFFSET)) 1363 goto out; 1364 1365 trace_seq_putc(s, ')'); 1366 1367 if (trace_probe_print_args(s, tp->args, tp->nr_args, 1368 (u8 *)&field[1], field) < 0) 1369 goto out; 1370 1371 trace_seq_putc(s, '\n'); 1372 out: 1373 return trace_handle_return(s); 1374 } 1375 1376 static enum print_line_t 1377 print_kretprobe_event(struct trace_iterator *iter, int flags, 1378 struct trace_event *event) 1379 { 1380 struct kretprobe_trace_entry_head *field; 1381 struct trace_seq *s = &iter->seq; 1382 struct trace_probe *tp; 1383 1384 field = (struct kretprobe_trace_entry_head *)iter->ent; 1385 tp = trace_probe_primary_from_call( 1386 container_of(event, struct trace_event_call, event)); 1387 if (WARN_ON_ONCE(!tp)) 1388 goto out; 1389 1390 trace_seq_printf(s, "%s: (", trace_probe_name(tp)); 1391 1392 if (!seq_print_ip_sym(s, field->ret_ip, flags | TRACE_ITER_SYM_OFFSET)) 1393 goto out; 1394 1395 trace_seq_puts(s, " <- "); 1396 1397 if (!seq_print_ip_sym(s, field->func, flags & ~TRACE_ITER_SYM_OFFSET)) 1398 goto out; 1399 1400 trace_seq_putc(s, ')'); 1401 1402 if (trace_probe_print_args(s, tp->args, tp->nr_args, 1403 (u8 *)&field[1], field) < 0) 1404 goto out; 1405 1406 trace_seq_putc(s, '\n'); 1407 1408 out: 1409 return trace_handle_return(s); 1410 } 1411 1412 1413 static int kprobe_event_define_fields(struct trace_event_call *event_call) 1414 { 1415 int ret; 1416 struct kprobe_trace_entry_head field; 1417 struct trace_probe *tp; 1418 1419 tp = trace_probe_primary_from_call(event_call); 1420 if (WARN_ON_ONCE(!tp)) 1421 return -ENOENT; 1422 1423 DEFINE_FIELD(unsigned long, ip, FIELD_STRING_IP, 0); 1424 1425 return traceprobe_define_arg_fields(event_call, sizeof(field), tp); 1426 } 1427 1428 static int kretprobe_event_define_fields(struct trace_event_call *event_call) 1429 { 1430 int ret; 1431 struct kretprobe_trace_entry_head field; 1432 struct trace_probe *tp; 1433 1434 tp = trace_probe_primary_from_call(event_call); 1435 if (WARN_ON_ONCE(!tp)) 1436 return -ENOENT; 1437 1438 DEFINE_FIELD(unsigned long, func, FIELD_STRING_FUNC, 0); 1439 DEFINE_FIELD(unsigned long, ret_ip, FIELD_STRING_RETIP, 0); 1440 1441 return traceprobe_define_arg_fields(event_call, sizeof(field), tp); 1442 } 1443 1444 #ifdef CONFIG_PERF_EVENTS 1445 1446 /* Kprobe profile handler */ 1447 static int 1448 kprobe_perf_func(struct trace_kprobe *tk, struct pt_regs *regs) 1449 { 1450 struct trace_event_call *call = trace_probe_event_call(&tk->tp); 1451 struct kprobe_trace_entry_head *entry; 1452 struct hlist_head *head; 1453 int size, __size, dsize; 1454 int rctx; 1455 1456 if (bpf_prog_array_valid(call)) { 1457 unsigned long orig_ip = instruction_pointer(regs); 1458 int ret; 1459 1460 ret = trace_call_bpf(call, regs); 1461 1462 /* 1463 * We need to check and see if we modified the pc of the 1464 * pt_regs, and if so return 1 so that we don't do the 1465 * single stepping. 1466 */ 1467 if (orig_ip != instruction_pointer(regs)) 1468 return 1; 1469 if (!ret) 1470 return 0; 1471 } 1472 1473 head = this_cpu_ptr(call->perf_events); 1474 if (hlist_empty(head)) 1475 return 0; 1476 1477 dsize = __get_data_size(&tk->tp, regs); 1478 __size = sizeof(*entry) + tk->tp.size + dsize; 1479 size = ALIGN(__size + sizeof(u32), sizeof(u64)); 1480 size -= sizeof(u32); 1481 1482 entry = perf_trace_buf_alloc(size, NULL, &rctx); 1483 if (!entry) 1484 return 0; 1485 1486 entry->ip = (unsigned long)tk->rp.kp.addr; 1487 memset(&entry[1], 0, dsize); 1488 store_trace_args(&entry[1], &tk->tp, regs, sizeof(*entry), dsize); 1489 perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs, 1490 head, NULL); 1491 return 0; 1492 } 1493 NOKPROBE_SYMBOL(kprobe_perf_func); 1494 1495 /* Kretprobe profile handler */ 1496 static void 1497 kretprobe_perf_func(struct trace_kprobe *tk, struct kretprobe_instance *ri, 1498 struct pt_regs *regs) 1499 { 1500 struct trace_event_call *call = trace_probe_event_call(&tk->tp); 1501 struct kretprobe_trace_entry_head *entry; 1502 struct hlist_head *head; 1503 int size, __size, dsize; 1504 int rctx; 1505 1506 if (bpf_prog_array_valid(call) && !trace_call_bpf(call, regs)) 1507 return; 1508 1509 head = this_cpu_ptr(call->perf_events); 1510 if (hlist_empty(head)) 1511 return; 1512 1513 dsize = __get_data_size(&tk->tp, regs); 1514 __size = sizeof(*entry) + tk->tp.size + dsize; 1515 size = ALIGN(__size + sizeof(u32), sizeof(u64)); 1516 size -= sizeof(u32); 1517 1518 entry = perf_trace_buf_alloc(size, NULL, &rctx); 1519 if (!entry) 1520 return; 1521 1522 entry->func = (unsigned long)tk->rp.kp.addr; 1523 entry->ret_ip = get_kretprobe_retaddr(ri); 1524 store_trace_args(&entry[1], &tk->tp, regs, sizeof(*entry), dsize); 1525 perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs, 1526 head, NULL); 1527 } 1528 NOKPROBE_SYMBOL(kretprobe_perf_func); 1529 1530 int bpf_get_kprobe_info(const struct perf_event *event, u32 *fd_type, 1531 const char **symbol, u64 *probe_offset, 1532 u64 *probe_addr, bool perf_type_tracepoint) 1533 { 1534 const char *pevent = trace_event_name(event->tp_event); 1535 const char *group = event->tp_event->class->system; 1536 struct trace_kprobe *tk; 1537 1538 if (perf_type_tracepoint) 1539 tk = find_trace_kprobe(pevent, group); 1540 else 1541 tk = trace_kprobe_primary_from_call(event->tp_event); 1542 if (!tk) 1543 return -EINVAL; 1544 1545 *fd_type = trace_kprobe_is_return(tk) ? BPF_FD_TYPE_KRETPROBE 1546 : BPF_FD_TYPE_KPROBE; 1547 if (tk->symbol) { 1548 *symbol = tk->symbol; 1549 *probe_offset = tk->rp.kp.offset; 1550 *probe_addr = 0; 1551 } else { 1552 *symbol = NULL; 1553 *probe_offset = 0; 1554 *probe_addr = (unsigned long)tk->rp.kp.addr; 1555 } 1556 return 0; 1557 } 1558 #endif /* CONFIG_PERF_EVENTS */ 1559 1560 /* 1561 * called by perf_trace_init() or __ftrace_set_clr_event() under event_mutex. 1562 * 1563 * kprobe_trace_self_tests_init() does enable_trace_probe/disable_trace_probe 1564 * lockless, but we can't race with this __init function. 1565 */ 1566 static int kprobe_register(struct trace_event_call *event, 1567 enum trace_reg type, void *data) 1568 { 1569 struct trace_event_file *file = data; 1570 1571 switch (type) { 1572 case TRACE_REG_REGISTER: 1573 return enable_trace_kprobe(event, file); 1574 case TRACE_REG_UNREGISTER: 1575 return disable_trace_kprobe(event, file); 1576 1577 #ifdef CONFIG_PERF_EVENTS 1578 case TRACE_REG_PERF_REGISTER: 1579 return enable_trace_kprobe(event, NULL); 1580 case TRACE_REG_PERF_UNREGISTER: 1581 return disable_trace_kprobe(event, NULL); 1582 case TRACE_REG_PERF_OPEN: 1583 case TRACE_REG_PERF_CLOSE: 1584 case TRACE_REG_PERF_ADD: 1585 case TRACE_REG_PERF_DEL: 1586 return 0; 1587 #endif 1588 } 1589 return 0; 1590 } 1591 1592 static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs) 1593 { 1594 struct trace_kprobe *tk = container_of(kp, struct trace_kprobe, rp.kp); 1595 int ret = 0; 1596 1597 raw_cpu_inc(*tk->nhit); 1598 1599 if (trace_probe_test_flag(&tk->tp, TP_FLAG_TRACE)) 1600 kprobe_trace_func(tk, regs); 1601 #ifdef CONFIG_PERF_EVENTS 1602 if (trace_probe_test_flag(&tk->tp, TP_FLAG_PROFILE)) 1603 ret = kprobe_perf_func(tk, regs); 1604 #endif 1605 return ret; 1606 } 1607 NOKPROBE_SYMBOL(kprobe_dispatcher); 1608 1609 static int 1610 kretprobe_dispatcher(struct kretprobe_instance *ri, struct pt_regs *regs) 1611 { 1612 struct kretprobe *rp = get_kretprobe(ri); 1613 struct trace_kprobe *tk; 1614 1615 /* 1616 * There is a small chance that get_kretprobe(ri) returns NULL when 1617 * the kretprobe is unregister on another CPU between kretprobe's 1618 * trampoline_handler and this function. 1619 */ 1620 if (unlikely(!rp)) 1621 return 0; 1622 1623 tk = container_of(rp, struct trace_kprobe, rp); 1624 raw_cpu_inc(*tk->nhit); 1625 1626 if (trace_probe_test_flag(&tk->tp, TP_FLAG_TRACE)) 1627 kretprobe_trace_func(tk, ri, regs); 1628 #ifdef CONFIG_PERF_EVENTS 1629 if (trace_probe_test_flag(&tk->tp, TP_FLAG_PROFILE)) 1630 kretprobe_perf_func(tk, ri, regs); 1631 #endif 1632 return 0; /* We don't tweak kernel, so just return 0 */ 1633 } 1634 NOKPROBE_SYMBOL(kretprobe_dispatcher); 1635 1636 static struct trace_event_functions kretprobe_funcs = { 1637 .trace = print_kretprobe_event 1638 }; 1639 1640 static struct trace_event_functions kprobe_funcs = { 1641 .trace = print_kprobe_event 1642 }; 1643 1644 static struct trace_event_fields kretprobe_fields_array[] = { 1645 { .type = TRACE_FUNCTION_TYPE, 1646 .define_fields = kretprobe_event_define_fields }, 1647 {} 1648 }; 1649 1650 static struct trace_event_fields kprobe_fields_array[] = { 1651 { .type = TRACE_FUNCTION_TYPE, 1652 .define_fields = kprobe_event_define_fields }, 1653 {} 1654 }; 1655 1656 static inline void init_trace_event_call(struct trace_kprobe *tk) 1657 { 1658 struct trace_event_call *call = trace_probe_event_call(&tk->tp); 1659 1660 if (trace_kprobe_is_return(tk)) { 1661 call->event.funcs = &kretprobe_funcs; 1662 call->class->fields_array = kretprobe_fields_array; 1663 } else { 1664 call->event.funcs = &kprobe_funcs; 1665 call->class->fields_array = kprobe_fields_array; 1666 } 1667 1668 call->flags = TRACE_EVENT_FL_KPROBE; 1669 call->class->reg = kprobe_register; 1670 } 1671 1672 static int register_kprobe_event(struct trace_kprobe *tk) 1673 { 1674 init_trace_event_call(tk); 1675 1676 return trace_probe_register_event_call(&tk->tp); 1677 } 1678 1679 static int unregister_kprobe_event(struct trace_kprobe *tk) 1680 { 1681 return trace_probe_unregister_event_call(&tk->tp); 1682 } 1683 1684 #ifdef CONFIG_PERF_EVENTS 1685 /* create a trace_kprobe, but don't add it to global lists */ 1686 struct trace_event_call * 1687 create_local_trace_kprobe(char *func, void *addr, unsigned long offs, 1688 bool is_return) 1689 { 1690 enum probe_print_type ptype; 1691 struct trace_kprobe *tk; 1692 int ret; 1693 char *event; 1694 1695 /* 1696 * local trace_kprobes are not added to dyn_event, so they are never 1697 * searched in find_trace_kprobe(). Therefore, there is no concern of 1698 * duplicated name here. 1699 */ 1700 event = func ? func : "DUMMY_EVENT"; 1701 1702 tk = alloc_trace_kprobe(KPROBE_EVENT_SYSTEM, event, (void *)addr, func, 1703 offs, 0 /* maxactive */, 0 /* nargs */, 1704 is_return); 1705 1706 if (IS_ERR(tk)) { 1707 pr_info("Failed to allocate trace_probe.(%d)\n", 1708 (int)PTR_ERR(tk)); 1709 return ERR_CAST(tk); 1710 } 1711 1712 init_trace_event_call(tk); 1713 1714 ptype = trace_kprobe_is_return(tk) ? 1715 PROBE_PRINT_RETURN : PROBE_PRINT_NORMAL; 1716 if (traceprobe_set_print_fmt(&tk->tp, ptype) < 0) { 1717 ret = -ENOMEM; 1718 goto error; 1719 } 1720 1721 ret = __register_trace_kprobe(tk); 1722 if (ret < 0) 1723 goto error; 1724 1725 return trace_probe_event_call(&tk->tp); 1726 error: 1727 free_trace_kprobe(tk); 1728 return ERR_PTR(ret); 1729 } 1730 1731 void destroy_local_trace_kprobe(struct trace_event_call *event_call) 1732 { 1733 struct trace_kprobe *tk; 1734 1735 tk = trace_kprobe_primary_from_call(event_call); 1736 if (unlikely(!tk)) 1737 return; 1738 1739 if (trace_probe_is_enabled(&tk->tp)) { 1740 WARN_ON(1); 1741 return; 1742 } 1743 1744 __unregister_trace_kprobe(tk); 1745 1746 free_trace_kprobe(tk); 1747 } 1748 #endif /* CONFIG_PERF_EVENTS */ 1749 1750 static __init void enable_boot_kprobe_events(void) 1751 { 1752 struct trace_array *tr = top_trace_array(); 1753 struct trace_event_file *file; 1754 struct trace_kprobe *tk; 1755 struct dyn_event *pos; 1756 1757 mutex_lock(&event_mutex); 1758 for_each_trace_kprobe(tk, pos) { 1759 list_for_each_entry(file, &tr->events, list) 1760 if (file->event_call == trace_probe_event_call(&tk->tp)) 1761 trace_event_enable_disable(file, 1, 0); 1762 } 1763 mutex_unlock(&event_mutex); 1764 } 1765 1766 static __init void setup_boot_kprobe_events(void) 1767 { 1768 char *p, *cmd = kprobe_boot_events_buf; 1769 int ret; 1770 1771 strreplace(kprobe_boot_events_buf, ',', ' '); 1772 1773 while (cmd && *cmd != '\0') { 1774 p = strchr(cmd, ';'); 1775 if (p) 1776 *p++ = '\0'; 1777 1778 ret = create_or_delete_trace_kprobe(cmd); 1779 if (ret) 1780 pr_warn("Failed to add event(%d): %s\n", ret, cmd); 1781 1782 cmd = p; 1783 } 1784 1785 enable_boot_kprobe_events(); 1786 } 1787 1788 /* 1789 * Register dynevent at core_initcall. This allows kernel to setup kprobe 1790 * events in postcore_initcall without tracefs. 1791 */ 1792 static __init int init_kprobe_trace_early(void) 1793 { 1794 int ret; 1795 1796 ret = dyn_event_register(&trace_kprobe_ops); 1797 if (ret) 1798 return ret; 1799 1800 if (register_module_notifier(&trace_kprobe_module_nb)) 1801 return -EINVAL; 1802 1803 return 0; 1804 } 1805 core_initcall(init_kprobe_trace_early); 1806 1807 /* Make a tracefs interface for controlling probe points */ 1808 static __init int init_kprobe_trace(void) 1809 { 1810 int ret; 1811 1812 ret = tracing_init_dentry(); 1813 if (ret) 1814 return 0; 1815 1816 /* Event list interface */ 1817 trace_create_file("kprobe_events", TRACE_MODE_WRITE, 1818 NULL, NULL, &kprobe_events_ops); 1819 1820 /* Profile interface */ 1821 trace_create_file("kprobe_profile", TRACE_MODE_READ, 1822 NULL, NULL, &kprobe_profile_ops); 1823 1824 setup_boot_kprobe_events(); 1825 1826 return 0; 1827 } 1828 fs_initcall(init_kprobe_trace); 1829 1830 1831 #ifdef CONFIG_FTRACE_STARTUP_TEST 1832 static __init struct trace_event_file * 1833 find_trace_probe_file(struct trace_kprobe *tk, struct trace_array *tr) 1834 { 1835 struct trace_event_file *file; 1836 1837 list_for_each_entry(file, &tr->events, list) 1838 if (file->event_call == trace_probe_event_call(&tk->tp)) 1839 return file; 1840 1841 return NULL; 1842 } 1843 1844 /* 1845 * Nobody but us can call enable_trace_kprobe/disable_trace_kprobe at this 1846 * stage, we can do this lockless. 1847 */ 1848 static __init int kprobe_trace_self_tests_init(void) 1849 { 1850 int ret, warn = 0; 1851 int (*target)(int, int, int, int, int, int); 1852 struct trace_kprobe *tk; 1853 struct trace_event_file *file; 1854 1855 if (tracing_is_disabled()) 1856 return -ENODEV; 1857 1858 if (tracing_selftest_disabled) 1859 return 0; 1860 1861 target = kprobe_trace_selftest_target; 1862 1863 pr_info("Testing kprobe tracing: "); 1864 1865 ret = create_or_delete_trace_kprobe("p:testprobe kprobe_trace_selftest_target $stack $stack0 +0($stack)"); 1866 if (WARN_ON_ONCE(ret)) { 1867 pr_warn("error on probing function entry.\n"); 1868 warn++; 1869 } else { 1870 /* Enable trace point */ 1871 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM); 1872 if (WARN_ON_ONCE(tk == NULL)) { 1873 pr_warn("error on getting new probe.\n"); 1874 warn++; 1875 } else { 1876 file = find_trace_probe_file(tk, top_trace_array()); 1877 if (WARN_ON_ONCE(file == NULL)) { 1878 pr_warn("error on getting probe file.\n"); 1879 warn++; 1880 } else 1881 enable_trace_kprobe( 1882 trace_probe_event_call(&tk->tp), file); 1883 } 1884 } 1885 1886 ret = create_or_delete_trace_kprobe("r:testprobe2 kprobe_trace_selftest_target $retval"); 1887 if (WARN_ON_ONCE(ret)) { 1888 pr_warn("error on probing function return.\n"); 1889 warn++; 1890 } else { 1891 /* Enable trace point */ 1892 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM); 1893 if (WARN_ON_ONCE(tk == NULL)) { 1894 pr_warn("error on getting 2nd new probe.\n"); 1895 warn++; 1896 } else { 1897 file = find_trace_probe_file(tk, top_trace_array()); 1898 if (WARN_ON_ONCE(file == NULL)) { 1899 pr_warn("error on getting probe file.\n"); 1900 warn++; 1901 } else 1902 enable_trace_kprobe( 1903 trace_probe_event_call(&tk->tp), file); 1904 } 1905 } 1906 1907 if (warn) 1908 goto end; 1909 1910 ret = target(1, 2, 3, 4, 5, 6); 1911 1912 /* 1913 * Not expecting an error here, the check is only to prevent the 1914 * optimizer from removing the call to target() as otherwise there 1915 * are no side-effects and the call is never performed. 1916 */ 1917 if (ret != 21) 1918 warn++; 1919 1920 /* Disable trace points before removing it */ 1921 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM); 1922 if (WARN_ON_ONCE(tk == NULL)) { 1923 pr_warn("error on getting test probe.\n"); 1924 warn++; 1925 } else { 1926 if (trace_kprobe_nhit(tk) != 1) { 1927 pr_warn("incorrect number of testprobe hits\n"); 1928 warn++; 1929 } 1930 1931 file = find_trace_probe_file(tk, top_trace_array()); 1932 if (WARN_ON_ONCE(file == NULL)) { 1933 pr_warn("error on getting probe file.\n"); 1934 warn++; 1935 } else 1936 disable_trace_kprobe( 1937 trace_probe_event_call(&tk->tp), file); 1938 } 1939 1940 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM); 1941 if (WARN_ON_ONCE(tk == NULL)) { 1942 pr_warn("error on getting 2nd test probe.\n"); 1943 warn++; 1944 } else { 1945 if (trace_kprobe_nhit(tk) != 1) { 1946 pr_warn("incorrect number of testprobe2 hits\n"); 1947 warn++; 1948 } 1949 1950 file = find_trace_probe_file(tk, top_trace_array()); 1951 if (WARN_ON_ONCE(file == NULL)) { 1952 pr_warn("error on getting probe file.\n"); 1953 warn++; 1954 } else 1955 disable_trace_kprobe( 1956 trace_probe_event_call(&tk->tp), file); 1957 } 1958 1959 ret = create_or_delete_trace_kprobe("-:testprobe"); 1960 if (WARN_ON_ONCE(ret)) { 1961 pr_warn("error on deleting a probe.\n"); 1962 warn++; 1963 } 1964 1965 ret = create_or_delete_trace_kprobe("-:testprobe2"); 1966 if (WARN_ON_ONCE(ret)) { 1967 pr_warn("error on deleting a probe.\n"); 1968 warn++; 1969 } 1970 1971 end: 1972 ret = dyn_events_release_all(&trace_kprobe_ops); 1973 if (WARN_ON_ONCE(ret)) { 1974 pr_warn("error on cleaning up probes.\n"); 1975 warn++; 1976 } 1977 /* 1978 * Wait for the optimizer work to finish. Otherwise it might fiddle 1979 * with probes in already freed __init text. 1980 */ 1981 wait_for_kprobe_optimizer(); 1982 if (warn) 1983 pr_cont("NG: Some tests are failed. Please check them.\n"); 1984 else 1985 pr_cont("OK\n"); 1986 return 0; 1987 } 1988 1989 late_initcall(kprobe_trace_self_tests_init); 1990 1991 #endif 1992