1 /* 2 * Kprobes-based tracing events 3 * 4 * Created by Masami Hiramatsu <mhiramat@redhat.com> 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License version 2 as 8 * published by the Free Software Foundation. 9 * 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program; if not, write to the Free Software 17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 18 */ 19 #define pr_fmt(fmt) "trace_kprobe: " fmt 20 21 #include <linux/module.h> 22 #include <linux/uaccess.h> 23 #include <linux/rculist.h> 24 #include <linux/error-injection.h> 25 26 #include "trace_probe.h" 27 28 #define KPROBE_EVENT_SYSTEM "kprobes" 29 #define KRETPROBE_MAXACTIVE_MAX 4096 30 31 /** 32 * Kprobe event core functions 33 */ 34 struct trace_kprobe { 35 struct list_head list; 36 struct kretprobe rp; /* Use rp.kp for kprobe use */ 37 unsigned long __percpu *nhit; 38 const char *symbol; /* symbol name */ 39 struct trace_probe tp; 40 }; 41 42 #define SIZEOF_TRACE_KPROBE(n) \ 43 (offsetof(struct trace_kprobe, tp.args) + \ 44 (sizeof(struct probe_arg) * (n))) 45 46 static nokprobe_inline bool trace_kprobe_is_return(struct trace_kprobe *tk) 47 { 48 return tk->rp.handler != NULL; 49 } 50 51 static nokprobe_inline const char *trace_kprobe_symbol(struct trace_kprobe *tk) 52 { 53 return tk->symbol ? tk->symbol : "unknown"; 54 } 55 56 static nokprobe_inline unsigned long trace_kprobe_offset(struct trace_kprobe *tk) 57 { 58 return tk->rp.kp.offset; 59 } 60 61 static nokprobe_inline bool trace_kprobe_has_gone(struct trace_kprobe *tk) 62 { 63 return !!(kprobe_gone(&tk->rp.kp)); 64 } 65 66 static nokprobe_inline bool trace_kprobe_within_module(struct trace_kprobe *tk, 67 struct module *mod) 68 { 69 int len = strlen(mod->name); 70 const char *name = trace_kprobe_symbol(tk); 71 return strncmp(mod->name, name, len) == 0 && name[len] == ':'; 72 } 73 74 static nokprobe_inline bool trace_kprobe_is_on_module(struct trace_kprobe *tk) 75 { 76 return !!strchr(trace_kprobe_symbol(tk), ':'); 77 } 78 79 static nokprobe_inline unsigned long trace_kprobe_nhit(struct trace_kprobe *tk) 80 { 81 unsigned long nhit = 0; 82 int cpu; 83 84 for_each_possible_cpu(cpu) 85 nhit += *per_cpu_ptr(tk->nhit, cpu); 86 87 return nhit; 88 } 89 90 bool trace_kprobe_on_func_entry(struct trace_event_call *call) 91 { 92 struct trace_kprobe *tk = (struct trace_kprobe *)call->data; 93 94 return kprobe_on_func_entry(tk->rp.kp.addr, 95 tk->rp.kp.addr ? NULL : tk->rp.kp.symbol_name, 96 tk->rp.kp.addr ? 0 : tk->rp.kp.offset); 97 } 98 99 bool trace_kprobe_error_injectable(struct trace_event_call *call) 100 { 101 struct trace_kprobe *tk = (struct trace_kprobe *)call->data; 102 unsigned long addr; 103 104 if (tk->symbol) { 105 addr = (unsigned long) 106 kallsyms_lookup_name(trace_kprobe_symbol(tk)); 107 addr += tk->rp.kp.offset; 108 } else { 109 addr = (unsigned long)tk->rp.kp.addr; 110 } 111 return within_error_injection_list(addr); 112 } 113 114 static int register_kprobe_event(struct trace_kprobe *tk); 115 static int unregister_kprobe_event(struct trace_kprobe *tk); 116 117 static DEFINE_MUTEX(probe_lock); 118 static LIST_HEAD(probe_list); 119 120 static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs); 121 static int kretprobe_dispatcher(struct kretprobe_instance *ri, 122 struct pt_regs *regs); 123 124 /* Memory fetching by symbol */ 125 struct symbol_cache { 126 char *symbol; 127 long offset; 128 unsigned long addr; 129 }; 130 131 unsigned long update_symbol_cache(struct symbol_cache *sc) 132 { 133 sc->addr = (unsigned long)kallsyms_lookup_name(sc->symbol); 134 135 if (sc->addr) 136 sc->addr += sc->offset; 137 138 return sc->addr; 139 } 140 141 void free_symbol_cache(struct symbol_cache *sc) 142 { 143 kfree(sc->symbol); 144 kfree(sc); 145 } 146 147 struct symbol_cache *alloc_symbol_cache(const char *sym, long offset) 148 { 149 struct symbol_cache *sc; 150 151 if (!sym || strlen(sym) == 0) 152 return NULL; 153 154 sc = kzalloc(sizeof(struct symbol_cache), GFP_KERNEL); 155 if (!sc) 156 return NULL; 157 158 sc->symbol = kstrdup(sym, GFP_KERNEL); 159 if (!sc->symbol) { 160 kfree(sc); 161 return NULL; 162 } 163 sc->offset = offset; 164 update_symbol_cache(sc); 165 166 return sc; 167 } 168 169 /* 170 * Kprobes-specific fetch functions 171 */ 172 #define DEFINE_FETCH_stack(type) \ 173 static void FETCH_FUNC_NAME(stack, type)(struct pt_regs *regs, \ 174 void *offset, void *dest) \ 175 { \ 176 *(type *)dest = (type)regs_get_kernel_stack_nth(regs, \ 177 (unsigned int)((unsigned long)offset)); \ 178 } \ 179 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(stack, type)); 180 181 DEFINE_BASIC_FETCH_FUNCS(stack) 182 /* No string on the stack entry */ 183 #define fetch_stack_string NULL 184 #define fetch_stack_string_size NULL 185 186 #define DEFINE_FETCH_memory(type) \ 187 static void FETCH_FUNC_NAME(memory, type)(struct pt_regs *regs, \ 188 void *addr, void *dest) \ 189 { \ 190 type retval; \ 191 if (probe_kernel_address(addr, retval)) \ 192 *(type *)dest = 0; \ 193 else \ 194 *(type *)dest = retval; \ 195 } \ 196 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(memory, type)); 197 198 DEFINE_BASIC_FETCH_FUNCS(memory) 199 /* 200 * Fetch a null-terminated string. Caller MUST set *(u32 *)dest with max 201 * length and relative data location. 202 */ 203 static void FETCH_FUNC_NAME(memory, string)(struct pt_regs *regs, 204 void *addr, void *dest) 205 { 206 int maxlen = get_rloc_len(*(u32 *)dest); 207 u8 *dst = get_rloc_data(dest); 208 long ret; 209 210 if (!maxlen) 211 return; 212 213 /* 214 * Try to get string again, since the string can be changed while 215 * probing. 216 */ 217 ret = strncpy_from_unsafe(dst, addr, maxlen); 218 219 if (ret < 0) { /* Failed to fetch string */ 220 dst[0] = '\0'; 221 *(u32 *)dest = make_data_rloc(0, get_rloc_offs(*(u32 *)dest)); 222 } else { 223 *(u32 *)dest = make_data_rloc(ret, get_rloc_offs(*(u32 *)dest)); 224 } 225 } 226 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(memory, string)); 227 228 /* Return the length of string -- including null terminal byte */ 229 static void FETCH_FUNC_NAME(memory, string_size)(struct pt_regs *regs, 230 void *addr, void *dest) 231 { 232 mm_segment_t old_fs; 233 int ret, len = 0; 234 u8 c; 235 236 old_fs = get_fs(); 237 set_fs(KERNEL_DS); 238 pagefault_disable(); 239 240 do { 241 ret = __copy_from_user_inatomic(&c, (u8 *)addr + len, 1); 242 len++; 243 } while (c && ret == 0 && len < MAX_STRING_SIZE); 244 245 pagefault_enable(); 246 set_fs(old_fs); 247 248 if (ret < 0) /* Failed to check the length */ 249 *(u32 *)dest = 0; 250 else 251 *(u32 *)dest = len; 252 } 253 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(memory, string_size)); 254 255 #define DEFINE_FETCH_symbol(type) \ 256 void FETCH_FUNC_NAME(symbol, type)(struct pt_regs *regs, void *data, void *dest)\ 257 { \ 258 struct symbol_cache *sc = data; \ 259 if (sc->addr) \ 260 fetch_memory_##type(regs, (void *)sc->addr, dest); \ 261 else \ 262 *(type *)dest = 0; \ 263 } \ 264 NOKPROBE_SYMBOL(FETCH_FUNC_NAME(symbol, type)); 265 266 DEFINE_BASIC_FETCH_FUNCS(symbol) 267 DEFINE_FETCH_symbol(string) 268 DEFINE_FETCH_symbol(string_size) 269 270 /* kprobes don't support file_offset fetch methods */ 271 #define fetch_file_offset_u8 NULL 272 #define fetch_file_offset_u16 NULL 273 #define fetch_file_offset_u32 NULL 274 #define fetch_file_offset_u64 NULL 275 #define fetch_file_offset_string NULL 276 #define fetch_file_offset_string_size NULL 277 278 /* Fetch type information table */ 279 static const struct fetch_type kprobes_fetch_type_table[] = { 280 /* Special types */ 281 [FETCH_TYPE_STRING] = __ASSIGN_FETCH_TYPE("string", string, string, 282 sizeof(u32), 1, "__data_loc char[]"), 283 [FETCH_TYPE_STRSIZE] = __ASSIGN_FETCH_TYPE("string_size", u32, 284 string_size, sizeof(u32), 0, "u32"), 285 /* Basic types */ 286 ASSIGN_FETCH_TYPE(u8, u8, 0), 287 ASSIGN_FETCH_TYPE(u16, u16, 0), 288 ASSIGN_FETCH_TYPE(u32, u32, 0), 289 ASSIGN_FETCH_TYPE(u64, u64, 0), 290 ASSIGN_FETCH_TYPE(s8, u8, 1), 291 ASSIGN_FETCH_TYPE(s16, u16, 1), 292 ASSIGN_FETCH_TYPE(s32, u32, 1), 293 ASSIGN_FETCH_TYPE(s64, u64, 1), 294 ASSIGN_FETCH_TYPE_ALIAS(x8, u8, u8, 0), 295 ASSIGN_FETCH_TYPE_ALIAS(x16, u16, u16, 0), 296 ASSIGN_FETCH_TYPE_ALIAS(x32, u32, u32, 0), 297 ASSIGN_FETCH_TYPE_ALIAS(x64, u64, u64, 0), 298 299 ASSIGN_FETCH_TYPE_END 300 }; 301 302 /* 303 * Allocate new trace_probe and initialize it (including kprobes). 304 */ 305 static struct trace_kprobe *alloc_trace_kprobe(const char *group, 306 const char *event, 307 void *addr, 308 const char *symbol, 309 unsigned long offs, 310 int maxactive, 311 int nargs, bool is_return) 312 { 313 struct trace_kprobe *tk; 314 int ret = -ENOMEM; 315 316 tk = kzalloc(SIZEOF_TRACE_KPROBE(nargs), GFP_KERNEL); 317 if (!tk) 318 return ERR_PTR(ret); 319 320 tk->nhit = alloc_percpu(unsigned long); 321 if (!tk->nhit) 322 goto error; 323 324 if (symbol) { 325 tk->symbol = kstrdup(symbol, GFP_KERNEL); 326 if (!tk->symbol) 327 goto error; 328 tk->rp.kp.symbol_name = tk->symbol; 329 tk->rp.kp.offset = offs; 330 } else 331 tk->rp.kp.addr = addr; 332 333 if (is_return) 334 tk->rp.handler = kretprobe_dispatcher; 335 else 336 tk->rp.kp.pre_handler = kprobe_dispatcher; 337 338 tk->rp.maxactive = maxactive; 339 340 if (!event || !is_good_name(event)) { 341 ret = -EINVAL; 342 goto error; 343 } 344 345 tk->tp.call.class = &tk->tp.class; 346 tk->tp.call.name = kstrdup(event, GFP_KERNEL); 347 if (!tk->tp.call.name) 348 goto error; 349 350 if (!group || !is_good_name(group)) { 351 ret = -EINVAL; 352 goto error; 353 } 354 355 tk->tp.class.system = kstrdup(group, GFP_KERNEL); 356 if (!tk->tp.class.system) 357 goto error; 358 359 INIT_LIST_HEAD(&tk->list); 360 INIT_LIST_HEAD(&tk->tp.files); 361 return tk; 362 error: 363 kfree(tk->tp.call.name); 364 kfree(tk->symbol); 365 free_percpu(tk->nhit); 366 kfree(tk); 367 return ERR_PTR(ret); 368 } 369 370 static void free_trace_kprobe(struct trace_kprobe *tk) 371 { 372 int i; 373 374 for (i = 0; i < tk->tp.nr_args; i++) 375 traceprobe_free_probe_arg(&tk->tp.args[i]); 376 377 kfree(tk->tp.call.class->system); 378 kfree(tk->tp.call.name); 379 kfree(tk->symbol); 380 free_percpu(tk->nhit); 381 kfree(tk); 382 } 383 384 static struct trace_kprobe *find_trace_kprobe(const char *event, 385 const char *group) 386 { 387 struct trace_kprobe *tk; 388 389 list_for_each_entry(tk, &probe_list, list) 390 if (strcmp(trace_event_name(&tk->tp.call), event) == 0 && 391 strcmp(tk->tp.call.class->system, group) == 0) 392 return tk; 393 return NULL; 394 } 395 396 /* 397 * Enable trace_probe 398 * if the file is NULL, enable "perf" handler, or enable "trace" handler. 399 */ 400 static int 401 enable_trace_kprobe(struct trace_kprobe *tk, struct trace_event_file *file) 402 { 403 struct event_file_link *link = NULL; 404 int ret = 0; 405 406 if (file) { 407 link = kmalloc(sizeof(*link), GFP_KERNEL); 408 if (!link) { 409 ret = -ENOMEM; 410 goto out; 411 } 412 413 link->file = file; 414 list_add_tail_rcu(&link->list, &tk->tp.files); 415 416 tk->tp.flags |= TP_FLAG_TRACE; 417 } else 418 tk->tp.flags |= TP_FLAG_PROFILE; 419 420 if (trace_probe_is_registered(&tk->tp) && !trace_kprobe_has_gone(tk)) { 421 if (trace_kprobe_is_return(tk)) 422 ret = enable_kretprobe(&tk->rp); 423 else 424 ret = enable_kprobe(&tk->rp.kp); 425 } 426 427 if (ret) { 428 if (file) { 429 /* Notice the if is true on not WARN() */ 430 if (!WARN_ON_ONCE(!link)) 431 list_del_rcu(&link->list); 432 kfree(link); 433 tk->tp.flags &= ~TP_FLAG_TRACE; 434 } else { 435 tk->tp.flags &= ~TP_FLAG_PROFILE; 436 } 437 } 438 out: 439 return ret; 440 } 441 442 /* 443 * Disable trace_probe 444 * if the file is NULL, disable "perf" handler, or disable "trace" handler. 445 */ 446 static int 447 disable_trace_kprobe(struct trace_kprobe *tk, struct trace_event_file *file) 448 { 449 struct event_file_link *link = NULL; 450 int wait = 0; 451 int ret = 0; 452 453 if (file) { 454 link = find_event_file_link(&tk->tp, file); 455 if (!link) { 456 ret = -EINVAL; 457 goto out; 458 } 459 460 list_del_rcu(&link->list); 461 wait = 1; 462 if (!list_empty(&tk->tp.files)) 463 goto out; 464 465 tk->tp.flags &= ~TP_FLAG_TRACE; 466 } else 467 tk->tp.flags &= ~TP_FLAG_PROFILE; 468 469 if (!trace_probe_is_enabled(&tk->tp) && trace_probe_is_registered(&tk->tp)) { 470 if (trace_kprobe_is_return(tk)) 471 disable_kretprobe(&tk->rp); 472 else 473 disable_kprobe(&tk->rp.kp); 474 wait = 1; 475 } 476 477 /* 478 * if tk is not added to any list, it must be a local trace_kprobe 479 * created with perf_event_open. We don't need to wait for these 480 * trace_kprobes 481 */ 482 if (list_empty(&tk->list)) 483 wait = 0; 484 out: 485 if (wait) { 486 /* 487 * Synchronize with kprobe_trace_func/kretprobe_trace_func 488 * to ensure disabled (all running handlers are finished). 489 * This is not only for kfree(), but also the caller, 490 * trace_remove_event_call() supposes it for releasing 491 * event_call related objects, which will be accessed in 492 * the kprobe_trace_func/kretprobe_trace_func. 493 */ 494 synchronize_sched(); 495 kfree(link); /* Ignored if link == NULL */ 496 } 497 498 return ret; 499 } 500 501 /* Internal register function - just handle k*probes and flags */ 502 static int __register_trace_kprobe(struct trace_kprobe *tk) 503 { 504 int i, ret; 505 506 if (trace_probe_is_registered(&tk->tp)) 507 return -EINVAL; 508 509 for (i = 0; i < tk->tp.nr_args; i++) 510 traceprobe_update_arg(&tk->tp.args[i]); 511 512 /* Set/clear disabled flag according to tp->flag */ 513 if (trace_probe_is_enabled(&tk->tp)) 514 tk->rp.kp.flags &= ~KPROBE_FLAG_DISABLED; 515 else 516 tk->rp.kp.flags |= KPROBE_FLAG_DISABLED; 517 518 if (trace_kprobe_is_return(tk)) 519 ret = register_kretprobe(&tk->rp); 520 else 521 ret = register_kprobe(&tk->rp.kp); 522 523 if (ret == 0) 524 tk->tp.flags |= TP_FLAG_REGISTERED; 525 else { 526 if (ret == -ENOENT && trace_kprobe_is_on_module(tk)) { 527 pr_warn("This probe might be able to register after target module is loaded. Continue.\n"); 528 ret = 0; 529 } else if (ret == -EILSEQ) { 530 pr_warn("Probing address(0x%p) is not an instruction boundary.\n", 531 tk->rp.kp.addr); 532 ret = -EINVAL; 533 } 534 } 535 536 return ret; 537 } 538 539 /* Internal unregister function - just handle k*probes and flags */ 540 static void __unregister_trace_kprobe(struct trace_kprobe *tk) 541 { 542 if (trace_probe_is_registered(&tk->tp)) { 543 if (trace_kprobe_is_return(tk)) 544 unregister_kretprobe(&tk->rp); 545 else 546 unregister_kprobe(&tk->rp.kp); 547 tk->tp.flags &= ~TP_FLAG_REGISTERED; 548 /* Cleanup kprobe for reuse */ 549 if (tk->rp.kp.symbol_name) 550 tk->rp.kp.addr = NULL; 551 } 552 } 553 554 /* Unregister a trace_probe and probe_event: call with locking probe_lock */ 555 static int unregister_trace_kprobe(struct trace_kprobe *tk) 556 { 557 /* Enabled event can not be unregistered */ 558 if (trace_probe_is_enabled(&tk->tp)) 559 return -EBUSY; 560 561 /* Will fail if probe is being used by ftrace or perf */ 562 if (unregister_kprobe_event(tk)) 563 return -EBUSY; 564 565 __unregister_trace_kprobe(tk); 566 list_del(&tk->list); 567 568 return 0; 569 } 570 571 /* Register a trace_probe and probe_event */ 572 static int register_trace_kprobe(struct trace_kprobe *tk) 573 { 574 struct trace_kprobe *old_tk; 575 int ret; 576 577 mutex_lock(&probe_lock); 578 579 /* Delete old (same name) event if exist */ 580 old_tk = find_trace_kprobe(trace_event_name(&tk->tp.call), 581 tk->tp.call.class->system); 582 if (old_tk) { 583 ret = unregister_trace_kprobe(old_tk); 584 if (ret < 0) 585 goto end; 586 free_trace_kprobe(old_tk); 587 } 588 589 /* Register new event */ 590 ret = register_kprobe_event(tk); 591 if (ret) { 592 pr_warn("Failed to register probe event(%d)\n", ret); 593 goto end; 594 } 595 596 /* Register k*probe */ 597 ret = __register_trace_kprobe(tk); 598 if (ret < 0) 599 unregister_kprobe_event(tk); 600 else 601 list_add_tail(&tk->list, &probe_list); 602 603 end: 604 mutex_unlock(&probe_lock); 605 return ret; 606 } 607 608 /* Module notifier call back, checking event on the module */ 609 static int trace_kprobe_module_callback(struct notifier_block *nb, 610 unsigned long val, void *data) 611 { 612 struct module *mod = data; 613 struct trace_kprobe *tk; 614 int ret; 615 616 if (val != MODULE_STATE_COMING) 617 return NOTIFY_DONE; 618 619 /* Update probes on coming module */ 620 mutex_lock(&probe_lock); 621 list_for_each_entry(tk, &probe_list, list) { 622 if (trace_kprobe_within_module(tk, mod)) { 623 /* Don't need to check busy - this should have gone. */ 624 __unregister_trace_kprobe(tk); 625 ret = __register_trace_kprobe(tk); 626 if (ret) 627 pr_warn("Failed to re-register probe %s on %s: %d\n", 628 trace_event_name(&tk->tp.call), 629 mod->name, ret); 630 } 631 } 632 mutex_unlock(&probe_lock); 633 634 return NOTIFY_DONE; 635 } 636 637 static struct notifier_block trace_kprobe_module_nb = { 638 .notifier_call = trace_kprobe_module_callback, 639 .priority = 1 /* Invoked after kprobe module callback */ 640 }; 641 642 /* Convert certain expected symbols into '_' when generating event names */ 643 static inline void sanitize_event_name(char *name) 644 { 645 while (*name++ != '\0') 646 if (*name == ':' || *name == '.') 647 *name = '_'; 648 } 649 650 static int create_trace_kprobe(int argc, char **argv) 651 { 652 /* 653 * Argument syntax: 654 * - Add kprobe: 655 * p[:[GRP/]EVENT] [MOD:]KSYM[+OFFS]|KADDR [FETCHARGS] 656 * - Add kretprobe: 657 * r[MAXACTIVE][:[GRP/]EVENT] [MOD:]KSYM[+0] [FETCHARGS] 658 * Fetch args: 659 * $retval : fetch return value 660 * $stack : fetch stack address 661 * $stackN : fetch Nth of stack (N:0-) 662 * $comm : fetch current task comm 663 * @ADDR : fetch memory at ADDR (ADDR should be in kernel) 664 * @SYM[+|-offs] : fetch memory at SYM +|- offs (SYM is a data symbol) 665 * %REG : fetch register REG 666 * Dereferencing memory fetch: 667 * +|-offs(ARG) : fetch memory at ARG +|- offs address. 668 * Alias name of args: 669 * NAME=FETCHARG : set NAME as alias of FETCHARG. 670 * Type of args: 671 * FETCHARG:TYPE : use TYPE instead of unsigned long. 672 */ 673 struct trace_kprobe *tk; 674 int i, ret = 0; 675 bool is_return = false, is_delete = false; 676 char *symbol = NULL, *event = NULL, *group = NULL; 677 int maxactive = 0; 678 char *arg; 679 long offset = 0; 680 void *addr = NULL; 681 char buf[MAX_EVENT_NAME_LEN]; 682 683 /* argc must be >= 1 */ 684 if (argv[0][0] == 'p') 685 is_return = false; 686 else if (argv[0][0] == 'r') 687 is_return = true; 688 else if (argv[0][0] == '-') 689 is_delete = true; 690 else { 691 pr_info("Probe definition must be started with 'p', 'r' or" 692 " '-'.\n"); 693 return -EINVAL; 694 } 695 696 event = strchr(&argv[0][1], ':'); 697 if (event) { 698 event[0] = '\0'; 699 event++; 700 } 701 if (is_return && isdigit(argv[0][1])) { 702 ret = kstrtouint(&argv[0][1], 0, &maxactive); 703 if (ret) { 704 pr_info("Failed to parse maxactive.\n"); 705 return ret; 706 } 707 /* kretprobes instances are iterated over via a list. The 708 * maximum should stay reasonable. 709 */ 710 if (maxactive > KRETPROBE_MAXACTIVE_MAX) { 711 pr_info("Maxactive is too big (%d > %d).\n", 712 maxactive, KRETPROBE_MAXACTIVE_MAX); 713 return -E2BIG; 714 } 715 } 716 717 if (event) { 718 if (strchr(event, '/')) { 719 group = event; 720 event = strchr(group, '/') + 1; 721 event[-1] = '\0'; 722 if (strlen(group) == 0) { 723 pr_info("Group name is not specified\n"); 724 return -EINVAL; 725 } 726 } 727 if (strlen(event) == 0) { 728 pr_info("Event name is not specified\n"); 729 return -EINVAL; 730 } 731 } 732 if (!group) 733 group = KPROBE_EVENT_SYSTEM; 734 735 if (is_delete) { 736 if (!event) { 737 pr_info("Delete command needs an event name.\n"); 738 return -EINVAL; 739 } 740 mutex_lock(&probe_lock); 741 tk = find_trace_kprobe(event, group); 742 if (!tk) { 743 mutex_unlock(&probe_lock); 744 pr_info("Event %s/%s doesn't exist.\n", group, event); 745 return -ENOENT; 746 } 747 /* delete an event */ 748 ret = unregister_trace_kprobe(tk); 749 if (ret == 0) 750 free_trace_kprobe(tk); 751 mutex_unlock(&probe_lock); 752 return ret; 753 } 754 755 if (argc < 2) { 756 pr_info("Probe point is not specified.\n"); 757 return -EINVAL; 758 } 759 760 /* try to parse an address. if that fails, try to read the 761 * input as a symbol. */ 762 if (kstrtoul(argv[1], 0, (unsigned long *)&addr)) { 763 /* a symbol specified */ 764 symbol = argv[1]; 765 /* TODO: support .init module functions */ 766 ret = traceprobe_split_symbol_offset(symbol, &offset); 767 if (ret || offset < 0 || offset > UINT_MAX) { 768 pr_info("Failed to parse either an address or a symbol.\n"); 769 return ret; 770 } 771 if (offset && is_return && 772 !kprobe_on_func_entry(NULL, symbol, offset)) { 773 pr_info("Given offset is not valid for return probe.\n"); 774 return -EINVAL; 775 } 776 } 777 argc -= 2; argv += 2; 778 779 /* setup a probe */ 780 if (!event) { 781 /* Make a new event name */ 782 if (symbol) 783 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_%s_%ld", 784 is_return ? 'r' : 'p', symbol, offset); 785 else 786 snprintf(buf, MAX_EVENT_NAME_LEN, "%c_0x%p", 787 is_return ? 'r' : 'p', addr); 788 sanitize_event_name(buf); 789 event = buf; 790 } 791 tk = alloc_trace_kprobe(group, event, addr, symbol, offset, maxactive, 792 argc, is_return); 793 if (IS_ERR(tk)) { 794 pr_info("Failed to allocate trace_probe.(%d)\n", 795 (int)PTR_ERR(tk)); 796 return PTR_ERR(tk); 797 } 798 799 /* parse arguments */ 800 ret = 0; 801 for (i = 0; i < argc && i < MAX_TRACE_ARGS; i++) { 802 struct probe_arg *parg = &tk->tp.args[i]; 803 804 /* Increment count for freeing args in error case */ 805 tk->tp.nr_args++; 806 807 /* Parse argument name */ 808 arg = strchr(argv[i], '='); 809 if (arg) { 810 *arg++ = '\0'; 811 parg->name = kstrdup(argv[i], GFP_KERNEL); 812 } else { 813 arg = argv[i]; 814 /* If argument name is omitted, set "argN" */ 815 snprintf(buf, MAX_EVENT_NAME_LEN, "arg%d", i + 1); 816 parg->name = kstrdup(buf, GFP_KERNEL); 817 } 818 819 if (!parg->name) { 820 pr_info("Failed to allocate argument[%d] name.\n", i); 821 ret = -ENOMEM; 822 goto error; 823 } 824 825 if (!is_good_name(parg->name)) { 826 pr_info("Invalid argument[%d] name: %s\n", 827 i, parg->name); 828 ret = -EINVAL; 829 goto error; 830 } 831 832 if (traceprobe_conflict_field_name(parg->name, 833 tk->tp.args, i)) { 834 pr_info("Argument[%d] name '%s' conflicts with " 835 "another field.\n", i, argv[i]); 836 ret = -EINVAL; 837 goto error; 838 } 839 840 /* Parse fetch argument */ 841 ret = traceprobe_parse_probe_arg(arg, &tk->tp.size, parg, 842 is_return, true, 843 kprobes_fetch_type_table); 844 if (ret) { 845 pr_info("Parse error at argument[%d]. (%d)\n", i, ret); 846 goto error; 847 } 848 } 849 850 ret = register_trace_kprobe(tk); 851 if (ret) 852 goto error; 853 return 0; 854 855 error: 856 free_trace_kprobe(tk); 857 return ret; 858 } 859 860 static int release_all_trace_kprobes(void) 861 { 862 struct trace_kprobe *tk; 863 int ret = 0; 864 865 mutex_lock(&probe_lock); 866 /* Ensure no probe is in use. */ 867 list_for_each_entry(tk, &probe_list, list) 868 if (trace_probe_is_enabled(&tk->tp)) { 869 ret = -EBUSY; 870 goto end; 871 } 872 /* TODO: Use batch unregistration */ 873 while (!list_empty(&probe_list)) { 874 tk = list_entry(probe_list.next, struct trace_kprobe, list); 875 ret = unregister_trace_kprobe(tk); 876 if (ret) 877 goto end; 878 free_trace_kprobe(tk); 879 } 880 881 end: 882 mutex_unlock(&probe_lock); 883 884 return ret; 885 } 886 887 /* Probes listing interfaces */ 888 static void *probes_seq_start(struct seq_file *m, loff_t *pos) 889 { 890 mutex_lock(&probe_lock); 891 return seq_list_start(&probe_list, *pos); 892 } 893 894 static void *probes_seq_next(struct seq_file *m, void *v, loff_t *pos) 895 { 896 return seq_list_next(v, &probe_list, pos); 897 } 898 899 static void probes_seq_stop(struct seq_file *m, void *v) 900 { 901 mutex_unlock(&probe_lock); 902 } 903 904 static int probes_seq_show(struct seq_file *m, void *v) 905 { 906 struct trace_kprobe *tk = v; 907 int i; 908 909 seq_putc(m, trace_kprobe_is_return(tk) ? 'r' : 'p'); 910 seq_printf(m, ":%s/%s", tk->tp.call.class->system, 911 trace_event_name(&tk->tp.call)); 912 913 if (!tk->symbol) 914 seq_printf(m, " 0x%p", tk->rp.kp.addr); 915 else if (tk->rp.kp.offset) 916 seq_printf(m, " %s+%u", trace_kprobe_symbol(tk), 917 tk->rp.kp.offset); 918 else 919 seq_printf(m, " %s", trace_kprobe_symbol(tk)); 920 921 for (i = 0; i < tk->tp.nr_args; i++) 922 seq_printf(m, " %s=%s", tk->tp.args[i].name, tk->tp.args[i].comm); 923 seq_putc(m, '\n'); 924 925 return 0; 926 } 927 928 static const struct seq_operations probes_seq_op = { 929 .start = probes_seq_start, 930 .next = probes_seq_next, 931 .stop = probes_seq_stop, 932 .show = probes_seq_show 933 }; 934 935 static int probes_open(struct inode *inode, struct file *file) 936 { 937 int ret; 938 939 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) { 940 ret = release_all_trace_kprobes(); 941 if (ret < 0) 942 return ret; 943 } 944 945 return seq_open(file, &probes_seq_op); 946 } 947 948 static ssize_t probes_write(struct file *file, const char __user *buffer, 949 size_t count, loff_t *ppos) 950 { 951 return trace_parse_run_command(file, buffer, count, ppos, 952 create_trace_kprobe); 953 } 954 955 static const struct file_operations kprobe_events_ops = { 956 .owner = THIS_MODULE, 957 .open = probes_open, 958 .read = seq_read, 959 .llseek = seq_lseek, 960 .release = seq_release, 961 .write = probes_write, 962 }; 963 964 /* Probes profiling interfaces */ 965 static int probes_profile_seq_show(struct seq_file *m, void *v) 966 { 967 struct trace_kprobe *tk = v; 968 969 seq_printf(m, " %-44s %15lu %15lu\n", 970 trace_event_name(&tk->tp.call), 971 trace_kprobe_nhit(tk), 972 tk->rp.kp.nmissed); 973 974 return 0; 975 } 976 977 static const struct seq_operations profile_seq_op = { 978 .start = probes_seq_start, 979 .next = probes_seq_next, 980 .stop = probes_seq_stop, 981 .show = probes_profile_seq_show 982 }; 983 984 static int profile_open(struct inode *inode, struct file *file) 985 { 986 return seq_open(file, &profile_seq_op); 987 } 988 989 static const struct file_operations kprobe_profile_ops = { 990 .owner = THIS_MODULE, 991 .open = profile_open, 992 .read = seq_read, 993 .llseek = seq_lseek, 994 .release = seq_release, 995 }; 996 997 /* Kprobe handler */ 998 static nokprobe_inline void 999 __kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs, 1000 struct trace_event_file *trace_file) 1001 { 1002 struct kprobe_trace_entry_head *entry; 1003 struct ring_buffer_event *event; 1004 struct ring_buffer *buffer; 1005 int size, dsize, pc; 1006 unsigned long irq_flags; 1007 struct trace_event_call *call = &tk->tp.call; 1008 1009 WARN_ON(call != trace_file->event_call); 1010 1011 if (trace_trigger_soft_disabled(trace_file)) 1012 return; 1013 1014 local_save_flags(irq_flags); 1015 pc = preempt_count(); 1016 1017 dsize = __get_data_size(&tk->tp, regs); 1018 size = sizeof(*entry) + tk->tp.size + dsize; 1019 1020 event = trace_event_buffer_lock_reserve(&buffer, trace_file, 1021 call->event.type, 1022 size, irq_flags, pc); 1023 if (!event) 1024 return; 1025 1026 entry = ring_buffer_event_data(event); 1027 entry->ip = (unsigned long)tk->rp.kp.addr; 1028 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize); 1029 1030 event_trigger_unlock_commit_regs(trace_file, buffer, event, 1031 entry, irq_flags, pc, regs); 1032 } 1033 1034 static void 1035 kprobe_trace_func(struct trace_kprobe *tk, struct pt_regs *regs) 1036 { 1037 struct event_file_link *link; 1038 1039 list_for_each_entry_rcu(link, &tk->tp.files, list) 1040 __kprobe_trace_func(tk, regs, link->file); 1041 } 1042 NOKPROBE_SYMBOL(kprobe_trace_func); 1043 1044 /* Kretprobe handler */ 1045 static nokprobe_inline void 1046 __kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri, 1047 struct pt_regs *regs, 1048 struct trace_event_file *trace_file) 1049 { 1050 struct kretprobe_trace_entry_head *entry; 1051 struct ring_buffer_event *event; 1052 struct ring_buffer *buffer; 1053 int size, pc, dsize; 1054 unsigned long irq_flags; 1055 struct trace_event_call *call = &tk->tp.call; 1056 1057 WARN_ON(call != trace_file->event_call); 1058 1059 if (trace_trigger_soft_disabled(trace_file)) 1060 return; 1061 1062 local_save_flags(irq_flags); 1063 pc = preempt_count(); 1064 1065 dsize = __get_data_size(&tk->tp, regs); 1066 size = sizeof(*entry) + tk->tp.size + dsize; 1067 1068 event = trace_event_buffer_lock_reserve(&buffer, trace_file, 1069 call->event.type, 1070 size, irq_flags, pc); 1071 if (!event) 1072 return; 1073 1074 entry = ring_buffer_event_data(event); 1075 entry->func = (unsigned long)tk->rp.kp.addr; 1076 entry->ret_ip = (unsigned long)ri->ret_addr; 1077 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize); 1078 1079 event_trigger_unlock_commit_regs(trace_file, buffer, event, 1080 entry, irq_flags, pc, regs); 1081 } 1082 1083 static void 1084 kretprobe_trace_func(struct trace_kprobe *tk, struct kretprobe_instance *ri, 1085 struct pt_regs *regs) 1086 { 1087 struct event_file_link *link; 1088 1089 list_for_each_entry_rcu(link, &tk->tp.files, list) 1090 __kretprobe_trace_func(tk, ri, regs, link->file); 1091 } 1092 NOKPROBE_SYMBOL(kretprobe_trace_func); 1093 1094 /* Event entry printers */ 1095 static enum print_line_t 1096 print_kprobe_event(struct trace_iterator *iter, int flags, 1097 struct trace_event *event) 1098 { 1099 struct kprobe_trace_entry_head *field; 1100 struct trace_seq *s = &iter->seq; 1101 struct trace_probe *tp; 1102 u8 *data; 1103 int i; 1104 1105 field = (struct kprobe_trace_entry_head *)iter->ent; 1106 tp = container_of(event, struct trace_probe, call.event); 1107 1108 trace_seq_printf(s, "%s: (", trace_event_name(&tp->call)); 1109 1110 if (!seq_print_ip_sym(s, field->ip, flags | TRACE_ITER_SYM_OFFSET)) 1111 goto out; 1112 1113 trace_seq_putc(s, ')'); 1114 1115 data = (u8 *)&field[1]; 1116 for (i = 0; i < tp->nr_args; i++) 1117 if (!tp->args[i].type->print(s, tp->args[i].name, 1118 data + tp->args[i].offset, field)) 1119 goto out; 1120 1121 trace_seq_putc(s, '\n'); 1122 out: 1123 return trace_handle_return(s); 1124 } 1125 1126 static enum print_line_t 1127 print_kretprobe_event(struct trace_iterator *iter, int flags, 1128 struct trace_event *event) 1129 { 1130 struct kretprobe_trace_entry_head *field; 1131 struct trace_seq *s = &iter->seq; 1132 struct trace_probe *tp; 1133 u8 *data; 1134 int i; 1135 1136 field = (struct kretprobe_trace_entry_head *)iter->ent; 1137 tp = container_of(event, struct trace_probe, call.event); 1138 1139 trace_seq_printf(s, "%s: (", trace_event_name(&tp->call)); 1140 1141 if (!seq_print_ip_sym(s, field->ret_ip, flags | TRACE_ITER_SYM_OFFSET)) 1142 goto out; 1143 1144 trace_seq_puts(s, " <- "); 1145 1146 if (!seq_print_ip_sym(s, field->func, flags & ~TRACE_ITER_SYM_OFFSET)) 1147 goto out; 1148 1149 trace_seq_putc(s, ')'); 1150 1151 data = (u8 *)&field[1]; 1152 for (i = 0; i < tp->nr_args; i++) 1153 if (!tp->args[i].type->print(s, tp->args[i].name, 1154 data + tp->args[i].offset, field)) 1155 goto out; 1156 1157 trace_seq_putc(s, '\n'); 1158 1159 out: 1160 return trace_handle_return(s); 1161 } 1162 1163 1164 static int kprobe_event_define_fields(struct trace_event_call *event_call) 1165 { 1166 int ret, i; 1167 struct kprobe_trace_entry_head field; 1168 struct trace_kprobe *tk = (struct trace_kprobe *)event_call->data; 1169 1170 DEFINE_FIELD(unsigned long, ip, FIELD_STRING_IP, 0); 1171 /* Set argument names as fields */ 1172 for (i = 0; i < tk->tp.nr_args; i++) { 1173 struct probe_arg *parg = &tk->tp.args[i]; 1174 1175 ret = trace_define_field(event_call, parg->type->fmttype, 1176 parg->name, 1177 sizeof(field) + parg->offset, 1178 parg->type->size, 1179 parg->type->is_signed, 1180 FILTER_OTHER); 1181 if (ret) 1182 return ret; 1183 } 1184 return 0; 1185 } 1186 1187 static int kretprobe_event_define_fields(struct trace_event_call *event_call) 1188 { 1189 int ret, i; 1190 struct kretprobe_trace_entry_head field; 1191 struct trace_kprobe *tk = (struct trace_kprobe *)event_call->data; 1192 1193 DEFINE_FIELD(unsigned long, func, FIELD_STRING_FUNC, 0); 1194 DEFINE_FIELD(unsigned long, ret_ip, FIELD_STRING_RETIP, 0); 1195 /* Set argument names as fields */ 1196 for (i = 0; i < tk->tp.nr_args; i++) { 1197 struct probe_arg *parg = &tk->tp.args[i]; 1198 1199 ret = trace_define_field(event_call, parg->type->fmttype, 1200 parg->name, 1201 sizeof(field) + parg->offset, 1202 parg->type->size, 1203 parg->type->is_signed, 1204 FILTER_OTHER); 1205 if (ret) 1206 return ret; 1207 } 1208 return 0; 1209 } 1210 1211 #ifdef CONFIG_PERF_EVENTS 1212 1213 /* Kprobe profile handler */ 1214 static int 1215 kprobe_perf_func(struct trace_kprobe *tk, struct pt_regs *regs) 1216 { 1217 struct trace_event_call *call = &tk->tp.call; 1218 struct kprobe_trace_entry_head *entry; 1219 struct hlist_head *head; 1220 int size, __size, dsize; 1221 int rctx; 1222 1223 if (bpf_prog_array_valid(call)) { 1224 unsigned long orig_ip = instruction_pointer(regs); 1225 int ret; 1226 1227 ret = trace_call_bpf(call, regs); 1228 1229 /* 1230 * We need to check and see if we modified the pc of the 1231 * pt_regs, and if so clear the kprobe and return 1 so that we 1232 * don't do the single stepping. 1233 * The ftrace kprobe handler leaves it up to us to re-enable 1234 * preemption here before returning if we've modified the ip. 1235 */ 1236 if (orig_ip != instruction_pointer(regs)) { 1237 reset_current_kprobe(); 1238 preempt_enable_no_resched(); 1239 return 1; 1240 } 1241 if (!ret) 1242 return 0; 1243 } 1244 1245 head = this_cpu_ptr(call->perf_events); 1246 if (hlist_empty(head)) 1247 return 0; 1248 1249 dsize = __get_data_size(&tk->tp, regs); 1250 __size = sizeof(*entry) + tk->tp.size + dsize; 1251 size = ALIGN(__size + sizeof(u32), sizeof(u64)); 1252 size -= sizeof(u32); 1253 1254 entry = perf_trace_buf_alloc(size, NULL, &rctx); 1255 if (!entry) 1256 return 0; 1257 1258 entry->ip = (unsigned long)tk->rp.kp.addr; 1259 memset(&entry[1], 0, dsize); 1260 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize); 1261 perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs, 1262 head, NULL); 1263 return 0; 1264 } 1265 NOKPROBE_SYMBOL(kprobe_perf_func); 1266 1267 /* Kretprobe profile handler */ 1268 static void 1269 kretprobe_perf_func(struct trace_kprobe *tk, struct kretprobe_instance *ri, 1270 struct pt_regs *regs) 1271 { 1272 struct trace_event_call *call = &tk->tp.call; 1273 struct kretprobe_trace_entry_head *entry; 1274 struct hlist_head *head; 1275 int size, __size, dsize; 1276 int rctx; 1277 1278 if (bpf_prog_array_valid(call) && !trace_call_bpf(call, regs)) 1279 return; 1280 1281 head = this_cpu_ptr(call->perf_events); 1282 if (hlist_empty(head)) 1283 return; 1284 1285 dsize = __get_data_size(&tk->tp, regs); 1286 __size = sizeof(*entry) + tk->tp.size + dsize; 1287 size = ALIGN(__size + sizeof(u32), sizeof(u64)); 1288 size -= sizeof(u32); 1289 1290 entry = perf_trace_buf_alloc(size, NULL, &rctx); 1291 if (!entry) 1292 return; 1293 1294 entry->func = (unsigned long)tk->rp.kp.addr; 1295 entry->ret_ip = (unsigned long)ri->ret_addr; 1296 store_trace_args(sizeof(*entry), &tk->tp, regs, (u8 *)&entry[1], dsize); 1297 perf_trace_buf_submit(entry, size, rctx, call->event.type, 1, regs, 1298 head, NULL); 1299 } 1300 NOKPROBE_SYMBOL(kretprobe_perf_func); 1301 1302 int bpf_get_kprobe_info(const struct perf_event *event, u32 *fd_type, 1303 const char **symbol, u64 *probe_offset, 1304 u64 *probe_addr, bool perf_type_tracepoint) 1305 { 1306 const char *pevent = trace_event_name(event->tp_event); 1307 const char *group = event->tp_event->class->system; 1308 struct trace_kprobe *tk; 1309 1310 if (perf_type_tracepoint) 1311 tk = find_trace_kprobe(pevent, group); 1312 else 1313 tk = event->tp_event->data; 1314 if (!tk) 1315 return -EINVAL; 1316 1317 *fd_type = trace_kprobe_is_return(tk) ? BPF_FD_TYPE_KRETPROBE 1318 : BPF_FD_TYPE_KPROBE; 1319 if (tk->symbol) { 1320 *symbol = tk->symbol; 1321 *probe_offset = tk->rp.kp.offset; 1322 *probe_addr = 0; 1323 } else { 1324 *symbol = NULL; 1325 *probe_offset = 0; 1326 *probe_addr = (unsigned long)tk->rp.kp.addr; 1327 } 1328 return 0; 1329 } 1330 #endif /* CONFIG_PERF_EVENTS */ 1331 1332 /* 1333 * called by perf_trace_init() or __ftrace_set_clr_event() under event_mutex. 1334 * 1335 * kprobe_trace_self_tests_init() does enable_trace_probe/disable_trace_probe 1336 * lockless, but we can't race with this __init function. 1337 */ 1338 static int kprobe_register(struct trace_event_call *event, 1339 enum trace_reg type, void *data) 1340 { 1341 struct trace_kprobe *tk = (struct trace_kprobe *)event->data; 1342 struct trace_event_file *file = data; 1343 1344 switch (type) { 1345 case TRACE_REG_REGISTER: 1346 return enable_trace_kprobe(tk, file); 1347 case TRACE_REG_UNREGISTER: 1348 return disable_trace_kprobe(tk, file); 1349 1350 #ifdef CONFIG_PERF_EVENTS 1351 case TRACE_REG_PERF_REGISTER: 1352 return enable_trace_kprobe(tk, NULL); 1353 case TRACE_REG_PERF_UNREGISTER: 1354 return disable_trace_kprobe(tk, NULL); 1355 case TRACE_REG_PERF_OPEN: 1356 case TRACE_REG_PERF_CLOSE: 1357 case TRACE_REG_PERF_ADD: 1358 case TRACE_REG_PERF_DEL: 1359 return 0; 1360 #endif 1361 } 1362 return 0; 1363 } 1364 1365 static int kprobe_dispatcher(struct kprobe *kp, struct pt_regs *regs) 1366 { 1367 struct trace_kprobe *tk = container_of(kp, struct trace_kprobe, rp.kp); 1368 int ret = 0; 1369 1370 raw_cpu_inc(*tk->nhit); 1371 1372 if (tk->tp.flags & TP_FLAG_TRACE) 1373 kprobe_trace_func(tk, regs); 1374 #ifdef CONFIG_PERF_EVENTS 1375 if (tk->tp.flags & TP_FLAG_PROFILE) 1376 ret = kprobe_perf_func(tk, regs); 1377 #endif 1378 return ret; 1379 } 1380 NOKPROBE_SYMBOL(kprobe_dispatcher); 1381 1382 static int 1383 kretprobe_dispatcher(struct kretprobe_instance *ri, struct pt_regs *regs) 1384 { 1385 struct trace_kprobe *tk = container_of(ri->rp, struct trace_kprobe, rp); 1386 1387 raw_cpu_inc(*tk->nhit); 1388 1389 if (tk->tp.flags & TP_FLAG_TRACE) 1390 kretprobe_trace_func(tk, ri, regs); 1391 #ifdef CONFIG_PERF_EVENTS 1392 if (tk->tp.flags & TP_FLAG_PROFILE) 1393 kretprobe_perf_func(tk, ri, regs); 1394 #endif 1395 return 0; /* We don't tweek kernel, so just return 0 */ 1396 } 1397 NOKPROBE_SYMBOL(kretprobe_dispatcher); 1398 1399 static struct trace_event_functions kretprobe_funcs = { 1400 .trace = print_kretprobe_event 1401 }; 1402 1403 static struct trace_event_functions kprobe_funcs = { 1404 .trace = print_kprobe_event 1405 }; 1406 1407 static inline void init_trace_event_call(struct trace_kprobe *tk, 1408 struct trace_event_call *call) 1409 { 1410 INIT_LIST_HEAD(&call->class->fields); 1411 if (trace_kprobe_is_return(tk)) { 1412 call->event.funcs = &kretprobe_funcs; 1413 call->class->define_fields = kretprobe_event_define_fields; 1414 } else { 1415 call->event.funcs = &kprobe_funcs; 1416 call->class->define_fields = kprobe_event_define_fields; 1417 } 1418 1419 call->flags = TRACE_EVENT_FL_KPROBE; 1420 call->class->reg = kprobe_register; 1421 call->data = tk; 1422 } 1423 1424 static int register_kprobe_event(struct trace_kprobe *tk) 1425 { 1426 struct trace_event_call *call = &tk->tp.call; 1427 int ret = 0; 1428 1429 init_trace_event_call(tk, call); 1430 1431 if (set_print_fmt(&tk->tp, trace_kprobe_is_return(tk)) < 0) 1432 return -ENOMEM; 1433 ret = register_trace_event(&call->event); 1434 if (!ret) { 1435 kfree(call->print_fmt); 1436 return -ENODEV; 1437 } 1438 ret = trace_add_event_call(call); 1439 if (ret) { 1440 pr_info("Failed to register kprobe event: %s\n", 1441 trace_event_name(call)); 1442 kfree(call->print_fmt); 1443 unregister_trace_event(&call->event); 1444 } 1445 return ret; 1446 } 1447 1448 static int unregister_kprobe_event(struct trace_kprobe *tk) 1449 { 1450 int ret; 1451 1452 /* tp->event is unregistered in trace_remove_event_call() */ 1453 ret = trace_remove_event_call(&tk->tp.call); 1454 if (!ret) 1455 kfree(tk->tp.call.print_fmt); 1456 return ret; 1457 } 1458 1459 #ifdef CONFIG_PERF_EVENTS 1460 /* create a trace_kprobe, but don't add it to global lists */ 1461 struct trace_event_call * 1462 create_local_trace_kprobe(char *func, void *addr, unsigned long offs, 1463 bool is_return) 1464 { 1465 struct trace_kprobe *tk; 1466 int ret; 1467 char *event; 1468 1469 /* 1470 * local trace_kprobes are not added to probe_list, so they are never 1471 * searched in find_trace_kprobe(). Therefore, there is no concern of 1472 * duplicated name here. 1473 */ 1474 event = func ? func : "DUMMY_EVENT"; 1475 1476 tk = alloc_trace_kprobe(KPROBE_EVENT_SYSTEM, event, (void *)addr, func, 1477 offs, 0 /* maxactive */, 0 /* nargs */, 1478 is_return); 1479 1480 if (IS_ERR(tk)) { 1481 pr_info("Failed to allocate trace_probe.(%d)\n", 1482 (int)PTR_ERR(tk)); 1483 return ERR_CAST(tk); 1484 } 1485 1486 init_trace_event_call(tk, &tk->tp.call); 1487 1488 if (set_print_fmt(&tk->tp, trace_kprobe_is_return(tk)) < 0) { 1489 ret = -ENOMEM; 1490 goto error; 1491 } 1492 1493 ret = __register_trace_kprobe(tk); 1494 if (ret < 0) { 1495 kfree(tk->tp.call.print_fmt); 1496 goto error; 1497 } 1498 1499 return &tk->tp.call; 1500 error: 1501 free_trace_kprobe(tk); 1502 return ERR_PTR(ret); 1503 } 1504 1505 void destroy_local_trace_kprobe(struct trace_event_call *event_call) 1506 { 1507 struct trace_kprobe *tk; 1508 1509 tk = container_of(event_call, struct trace_kprobe, tp.call); 1510 1511 if (trace_probe_is_enabled(&tk->tp)) { 1512 WARN_ON(1); 1513 return; 1514 } 1515 1516 __unregister_trace_kprobe(tk); 1517 1518 kfree(tk->tp.call.print_fmt); 1519 free_trace_kprobe(tk); 1520 } 1521 #endif /* CONFIG_PERF_EVENTS */ 1522 1523 /* Make a tracefs interface for controlling probe points */ 1524 static __init int init_kprobe_trace(void) 1525 { 1526 struct dentry *d_tracer; 1527 struct dentry *entry; 1528 1529 if (register_module_notifier(&trace_kprobe_module_nb)) 1530 return -EINVAL; 1531 1532 d_tracer = tracing_init_dentry(); 1533 if (IS_ERR(d_tracer)) 1534 return 0; 1535 1536 entry = tracefs_create_file("kprobe_events", 0644, d_tracer, 1537 NULL, &kprobe_events_ops); 1538 1539 /* Event list interface */ 1540 if (!entry) 1541 pr_warn("Could not create tracefs 'kprobe_events' entry\n"); 1542 1543 /* Profile interface */ 1544 entry = tracefs_create_file("kprobe_profile", 0444, d_tracer, 1545 NULL, &kprobe_profile_ops); 1546 1547 if (!entry) 1548 pr_warn("Could not create tracefs 'kprobe_profile' entry\n"); 1549 return 0; 1550 } 1551 fs_initcall(init_kprobe_trace); 1552 1553 1554 #ifdef CONFIG_FTRACE_STARTUP_TEST 1555 /* 1556 * The "__used" keeps gcc from removing the function symbol 1557 * from the kallsyms table. 'noinline' makes sure that there 1558 * isn't an inlined version used by the test method below 1559 */ 1560 static __used __init noinline int 1561 kprobe_trace_selftest_target(int a1, int a2, int a3, int a4, int a5, int a6) 1562 { 1563 return a1 + a2 + a3 + a4 + a5 + a6; 1564 } 1565 1566 static __init struct trace_event_file * 1567 find_trace_probe_file(struct trace_kprobe *tk, struct trace_array *tr) 1568 { 1569 struct trace_event_file *file; 1570 1571 list_for_each_entry(file, &tr->events, list) 1572 if (file->event_call == &tk->tp.call) 1573 return file; 1574 1575 return NULL; 1576 } 1577 1578 /* 1579 * Nobody but us can call enable_trace_kprobe/disable_trace_kprobe at this 1580 * stage, we can do this lockless. 1581 */ 1582 static __init int kprobe_trace_self_tests_init(void) 1583 { 1584 int ret, warn = 0; 1585 int (*target)(int, int, int, int, int, int); 1586 struct trace_kprobe *tk; 1587 struct trace_event_file *file; 1588 1589 if (tracing_is_disabled()) 1590 return -ENODEV; 1591 1592 target = kprobe_trace_selftest_target; 1593 1594 pr_info("Testing kprobe tracing: "); 1595 1596 ret = trace_run_command("p:testprobe kprobe_trace_selftest_target " 1597 "$stack $stack0 +0($stack)", 1598 create_trace_kprobe); 1599 if (WARN_ON_ONCE(ret)) { 1600 pr_warn("error on probing function entry.\n"); 1601 warn++; 1602 } else { 1603 /* Enable trace point */ 1604 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM); 1605 if (WARN_ON_ONCE(tk == NULL)) { 1606 pr_warn("error on getting new probe.\n"); 1607 warn++; 1608 } else { 1609 file = find_trace_probe_file(tk, top_trace_array()); 1610 if (WARN_ON_ONCE(file == NULL)) { 1611 pr_warn("error on getting probe file.\n"); 1612 warn++; 1613 } else 1614 enable_trace_kprobe(tk, file); 1615 } 1616 } 1617 1618 ret = trace_run_command("r:testprobe2 kprobe_trace_selftest_target " 1619 "$retval", create_trace_kprobe); 1620 if (WARN_ON_ONCE(ret)) { 1621 pr_warn("error on probing function return.\n"); 1622 warn++; 1623 } else { 1624 /* Enable trace point */ 1625 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM); 1626 if (WARN_ON_ONCE(tk == NULL)) { 1627 pr_warn("error on getting 2nd new probe.\n"); 1628 warn++; 1629 } else { 1630 file = find_trace_probe_file(tk, top_trace_array()); 1631 if (WARN_ON_ONCE(file == NULL)) { 1632 pr_warn("error on getting probe file.\n"); 1633 warn++; 1634 } else 1635 enable_trace_kprobe(tk, file); 1636 } 1637 } 1638 1639 if (warn) 1640 goto end; 1641 1642 ret = target(1, 2, 3, 4, 5, 6); 1643 1644 /* 1645 * Not expecting an error here, the check is only to prevent the 1646 * optimizer from removing the call to target() as otherwise there 1647 * are no side-effects and the call is never performed. 1648 */ 1649 if (ret != 21) 1650 warn++; 1651 1652 /* Disable trace points before removing it */ 1653 tk = find_trace_kprobe("testprobe", KPROBE_EVENT_SYSTEM); 1654 if (WARN_ON_ONCE(tk == NULL)) { 1655 pr_warn("error on getting test probe.\n"); 1656 warn++; 1657 } else { 1658 if (trace_kprobe_nhit(tk) != 1) { 1659 pr_warn("incorrect number of testprobe hits\n"); 1660 warn++; 1661 } 1662 1663 file = find_trace_probe_file(tk, top_trace_array()); 1664 if (WARN_ON_ONCE(file == NULL)) { 1665 pr_warn("error on getting probe file.\n"); 1666 warn++; 1667 } else 1668 disable_trace_kprobe(tk, file); 1669 } 1670 1671 tk = find_trace_kprobe("testprobe2", KPROBE_EVENT_SYSTEM); 1672 if (WARN_ON_ONCE(tk == NULL)) { 1673 pr_warn("error on getting 2nd test probe.\n"); 1674 warn++; 1675 } else { 1676 if (trace_kprobe_nhit(tk) != 1) { 1677 pr_warn("incorrect number of testprobe2 hits\n"); 1678 warn++; 1679 } 1680 1681 file = find_trace_probe_file(tk, top_trace_array()); 1682 if (WARN_ON_ONCE(file == NULL)) { 1683 pr_warn("error on getting probe file.\n"); 1684 warn++; 1685 } else 1686 disable_trace_kprobe(tk, file); 1687 } 1688 1689 ret = trace_run_command("-:testprobe", create_trace_kprobe); 1690 if (WARN_ON_ONCE(ret)) { 1691 pr_warn("error on deleting a probe.\n"); 1692 warn++; 1693 } 1694 1695 ret = trace_run_command("-:testprobe2", create_trace_kprobe); 1696 if (WARN_ON_ONCE(ret)) { 1697 pr_warn("error on deleting a probe.\n"); 1698 warn++; 1699 } 1700 1701 end: 1702 release_all_trace_kprobes(); 1703 /* 1704 * Wait for the optimizer work to finish. Otherwise it might fiddle 1705 * with probes in already freed __init text. 1706 */ 1707 wait_for_kprobe_optimizer(); 1708 if (warn) 1709 pr_cont("NG: Some tests are failed. Please check them.\n"); 1710 else 1711 pr_cont("OK\n"); 1712 return 0; 1713 } 1714 1715 late_initcall(kprobe_trace_self_tests_init); 1716 1717 #endif 1718