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