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