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