1 // SPDX-License-Identifier: GPL-2.0
5 * Part of this code was copied from kernel/trace/trace_kprobe.c written by
6 * Masami Hiramatsu <mhiramat@kernel.org>
8 * Copyright (C) 2021, VMware Inc, Steven Rostedt <rostedt@goodmis.org>
9 * Copyright (C) 2021, VMware Inc, Tzvetomir Stoyanov tz.stoyanov@gmail.com>
12 #include <linux/module.h>
13 #include <linux/mutex.h>
14 #include <linux/ftrace.h>
16 #include "trace_dynevent.h"
17 #include "trace_probe.h"
18 #include "trace_probe_tmpl.h"
20 #define EPROBE_EVENT_SYSTEM "eprobes"
23 /* tracepoint system */
24 const char *event_system;
26 /* tracepoint event */
27 const char *event_name;
29 struct trace_event_call *event;
31 struct dyn_event devent;
32 struct trace_probe tp;
36 struct trace_event_file *file;
37 struct trace_eprobe *ep;
40 static int __trace_eprobe_create(int argc, const char *argv[]);
42 static void trace_event_probe_cleanup(struct trace_eprobe *ep)
46 trace_probe_cleanup(&ep->tp);
47 kfree(ep->event_name);
48 kfree(ep->event_system);
50 trace_event_put_ref(ep->event);
54 static struct trace_eprobe *to_trace_eprobe(struct dyn_event *ev)
56 return container_of(ev, struct trace_eprobe, devent);
59 static int eprobe_dyn_event_create(const char *raw_command)
61 return trace_probe_create(raw_command, __trace_eprobe_create);
64 static int eprobe_dyn_event_show(struct seq_file *m, struct dyn_event *ev)
66 struct trace_eprobe *ep = to_trace_eprobe(ev);
69 seq_printf(m, "e:%s/%s", trace_probe_group_name(&ep->tp),
70 trace_probe_name(&ep->tp));
71 seq_printf(m, " %s.%s", ep->event_system, ep->event_name);
73 for (i = 0; i < ep->tp.nr_args; i++)
74 seq_printf(m, " %s=%s", ep->tp.args[i].name, ep->tp.args[i].comm);
80 static int unregister_trace_eprobe(struct trace_eprobe *ep)
82 /* If other probes are on the event, just unregister eprobe */
83 if (trace_probe_has_sibling(&ep->tp))
86 /* Enabled event can not be unregistered */
87 if (trace_probe_is_enabled(&ep->tp))
90 /* Will fail if probe is being used by ftrace or perf */
91 if (trace_probe_unregister_event_call(&ep->tp))
95 dyn_event_remove(&ep->devent);
96 trace_probe_unlink(&ep->tp);
101 static int eprobe_dyn_event_release(struct dyn_event *ev)
103 struct trace_eprobe *ep = to_trace_eprobe(ev);
104 int ret = unregister_trace_eprobe(ep);
107 trace_event_probe_cleanup(ep);
111 static bool eprobe_dyn_event_is_busy(struct dyn_event *ev)
113 struct trace_eprobe *ep = to_trace_eprobe(ev);
115 return trace_probe_is_enabled(&ep->tp);
118 static bool eprobe_dyn_event_match(const char *system, const char *event,
119 int argc, const char **argv, struct dyn_event *ev)
121 struct trace_eprobe *ep = to_trace_eprobe(ev);
125 * We match the following:
126 * event only - match all eprobes with event name
127 * system and event only - match all system/event probes
128 * system only - match all system probes
130 * The below has the above satisfied with more arguments:
132 * attached system/event - If the arg has the system and event
133 * the probe is attached to, match
134 * probes with the attachment.
136 * If any more args are given, then it requires a full match.
140 * If system exists, but this probe is not part of that system
143 if (system && strcmp(trace_probe_group_name(&ep->tp), system) != 0)
146 /* Must match the event name */
147 if (event[0] != '\0' && strcmp(trace_probe_name(&ep->tp), event) != 0)
150 /* No arguments match all */
154 /* First argument is the system/event the probe is attached to */
156 slash = strchr(argv[0], '/');
158 slash = strchr(argv[0], '.');
162 if (strncmp(ep->event_system, argv[0], slash - argv[0]))
164 if (strcmp(ep->event_name, slash + 1))
170 /* If there are no other args, then match */
174 return trace_probe_match_command_args(&ep->tp, argc, argv);
177 static struct dyn_event_operations eprobe_dyn_event_ops = {
178 .create = eprobe_dyn_event_create,
179 .show = eprobe_dyn_event_show,
180 .is_busy = eprobe_dyn_event_is_busy,
181 .free = eprobe_dyn_event_release,
182 .match = eprobe_dyn_event_match,
185 static struct trace_eprobe *alloc_event_probe(const char *group,
186 const char *this_event,
187 struct trace_event_call *event,
190 struct trace_eprobe *ep;
191 const char *event_name;
192 const char *sys_name;
196 return ERR_PTR(-ENODEV);
198 sys_name = event->class->system;
199 event_name = trace_event_name(event);
201 ep = kzalloc(struct_size(ep, tp.args, nargs), GFP_KERNEL);
203 trace_event_put_ref(event);
207 ep->event_name = kstrdup(event_name, GFP_KERNEL);
210 ep->event_system = kstrdup(sys_name, GFP_KERNEL);
211 if (!ep->event_system)
214 ret = trace_probe_init(&ep->tp, this_event, group, false);
218 dyn_event_init(&ep->devent, &eprobe_dyn_event_ops);
221 trace_event_probe_cleanup(ep);
225 static int trace_eprobe_tp_arg_update(struct trace_eprobe *ep, int i)
227 struct probe_arg *parg = &ep->tp.args[i];
228 struct ftrace_event_field *field;
229 struct list_head *head;
231 head = trace_get_fields(ep->event);
232 list_for_each_entry(field, head, link) {
233 if (!strcmp(parg->code->data, field->name)) {
234 kfree(parg->code->data);
235 parg->code->data = field;
239 kfree(parg->code->data);
240 parg->code->data = NULL;
244 static int eprobe_event_define_fields(struct trace_event_call *event_call)
246 struct eprobe_trace_entry_head field;
247 struct trace_probe *tp;
249 tp = trace_probe_primary_from_call(event_call);
250 if (WARN_ON_ONCE(!tp))
253 return traceprobe_define_arg_fields(event_call, sizeof(field), tp);
256 static struct trace_event_fields eprobe_fields_array[] = {
257 { .type = TRACE_FUNCTION_TYPE,
258 .define_fields = eprobe_event_define_fields },
262 /* Event entry printers */
263 static enum print_line_t
264 print_eprobe_event(struct trace_iterator *iter, int flags,
265 struct trace_event *event)
267 struct eprobe_trace_entry_head *field;
268 struct trace_event_call *pevent;
269 struct trace_event *probed_event;
270 struct trace_seq *s = &iter->seq;
271 struct trace_eprobe *ep;
272 struct trace_probe *tp;
275 field = (struct eprobe_trace_entry_head *)iter->ent;
276 tp = trace_probe_primary_from_call(
277 container_of(event, struct trace_event_call, event));
278 if (WARN_ON_ONCE(!tp))
281 ep = container_of(tp, struct trace_eprobe, tp);
282 type = ep->event->event.type;
284 trace_seq_printf(s, "%s: (", trace_probe_name(tp));
286 probed_event = ftrace_find_event(type);
288 pevent = container_of(probed_event, struct trace_event_call, event);
289 trace_seq_printf(s, "%s.%s", pevent->class->system,
290 trace_event_name(pevent));
292 trace_seq_printf(s, "%u", type);
295 trace_seq_putc(s, ')');
297 if (print_probe_args(s, tp->args, tp->nr_args,
298 (u8 *)&field[1], field) < 0)
301 trace_seq_putc(s, '\n');
303 return trace_handle_return(s);
306 static unsigned long get_event_field(struct fetch_insn *code, void *rec)
308 struct ftrace_event_field *field = code->data;
312 addr = rec + field->offset;
314 switch (field->size) {
316 if (field->is_signed)
319 val = *(unsigned char *)addr;
322 if (field->is_signed)
323 val = *(short *)addr;
325 val = *(unsigned short *)addr;
328 if (field->is_signed)
331 val = *(unsigned int *)addr;
334 if (field->is_signed)
337 val = *(unsigned long *)addr;
343 static int get_eprobe_size(struct trace_probe *tp, void *rec)
345 struct probe_arg *arg;
348 for (i = 0; i < tp->nr_args; i++) {
350 if (unlikely(arg->dynamic)) {
353 val = get_event_field(arg->code, rec);
354 len = process_fetch_insn_bottom(arg->code + 1, val, NULL, NULL);
363 /* Kprobe specific fetch functions */
365 /* Note that we don't verify it, since the code does not come from user space */
367 process_fetch_insn(struct fetch_insn *code, void *rec, void *dest,
372 val = get_event_field(code, rec);
373 return process_fetch_insn_bottom(code + 1, val, dest, base);
375 NOKPROBE_SYMBOL(process_fetch_insn)
377 /* Return the length of string -- including null terminal byte */
378 static nokprobe_inline int
379 fetch_store_strlen_user(unsigned long addr)
381 const void __user *uaddr = (__force const void __user *)addr;
383 return strnlen_user_nofault(uaddr, MAX_STRING_SIZE);
386 /* Return the length of string -- including null terminal byte */
387 static nokprobe_inline int
388 fetch_store_strlen(unsigned long addr)
393 #ifdef CONFIG_ARCH_HAS_NON_OVERLAPPING_ADDRESS_SPACE
394 if (addr < TASK_SIZE)
395 return fetch_store_strlen_user(addr);
399 ret = copy_from_kernel_nofault(&c, (u8 *)addr + len, 1);
401 } while (c && ret == 0 && len < MAX_STRING_SIZE);
403 return (ret < 0) ? ret : len;
407 * Fetch a null-terminated string from user. Caller MUST set *(u32 *)buf
408 * with max length and relative data location.
410 static nokprobe_inline int
411 fetch_store_string_user(unsigned long addr, void *dest, void *base)
413 const void __user *uaddr = (__force const void __user *)addr;
414 int maxlen = get_loc_len(*(u32 *)dest);
418 if (unlikely(!maxlen))
421 __dest = get_loc_data(dest, base);
423 ret = strncpy_from_user_nofault(__dest, uaddr, maxlen);
425 *(u32 *)dest = make_data_loc(ret, __dest - base);
431 * Fetch a null-terminated string. Caller MUST set *(u32 *)buf with max
432 * length and relative data location.
434 static nokprobe_inline int
435 fetch_store_string(unsigned long addr, void *dest, void *base)
437 int maxlen = get_loc_len(*(u32 *)dest);
441 #ifdef CONFIG_ARCH_HAS_NON_OVERLAPPING_ADDRESS_SPACE
442 if ((unsigned long)addr < TASK_SIZE)
443 return fetch_store_string_user(addr, dest, base);
446 if (unlikely(!maxlen))
449 __dest = get_loc_data(dest, base);
452 * Try to get string again, since the string can be changed while
455 ret = strncpy_from_kernel_nofault(__dest, (void *)addr, maxlen);
457 *(u32 *)dest = make_data_loc(ret, __dest - base);
462 static nokprobe_inline int
463 probe_mem_read_user(void *dest, void *src, size_t size)
465 const void __user *uaddr = (__force const void __user *)src;
467 return copy_from_user_nofault(dest, uaddr, size);
470 static nokprobe_inline int
471 probe_mem_read(void *dest, void *src, size_t size)
473 #ifdef CONFIG_ARCH_HAS_NON_OVERLAPPING_ADDRESS_SPACE
474 if ((unsigned long)src < TASK_SIZE)
475 return probe_mem_read_user(dest, src, size);
477 return copy_from_kernel_nofault(dest, src, size);
482 __eprobe_trace_func(struct eprobe_data *edata, void *rec)
484 struct eprobe_trace_entry_head *entry;
485 struct trace_event_call *call = trace_probe_event_call(&edata->ep->tp);
486 struct trace_event_buffer fbuffer;
489 if (WARN_ON_ONCE(call != edata->file->event_call))
492 if (trace_trigger_soft_disabled(edata->file))
495 dsize = get_eprobe_size(&edata->ep->tp, rec);
497 entry = trace_event_buffer_reserve(&fbuffer, edata->file,
498 sizeof(*entry) + edata->ep->tp.size + dsize);
503 entry = fbuffer.entry = ring_buffer_event_data(fbuffer.event);
504 store_trace_args(&entry[1], &edata->ep->tp, rec, sizeof(*entry), dsize);
506 trace_event_buffer_commit(&fbuffer);
510 * The event probe implementation uses event triggers to get access to
511 * the event it is attached to, but is not an actual trigger. The below
512 * functions are just stubs to fulfill what is needed to use the trigger
515 static int eprobe_trigger_init(struct event_trigger_data *data)
520 static void eprobe_trigger_free(struct event_trigger_data *data)
525 static int eprobe_trigger_print(struct seq_file *m,
526 struct event_trigger_data *data)
528 /* Do not print eprobe event triggers */
532 static void eprobe_trigger_func(struct event_trigger_data *data,
533 struct trace_buffer *buffer, void *rec,
534 struct ring_buffer_event *rbe)
536 struct eprobe_data *edata = data->private_data;
538 __eprobe_trace_func(edata, rec);
541 static struct event_trigger_ops eprobe_trigger_ops = {
542 .trigger = eprobe_trigger_func,
543 .print = eprobe_trigger_print,
544 .init = eprobe_trigger_init,
545 .free = eprobe_trigger_free,
548 static int eprobe_trigger_cmd_parse(struct event_command *cmd_ops,
549 struct trace_event_file *file,
550 char *glob, char *cmd,
551 char *param_and_filter)
556 static int eprobe_trigger_reg_func(char *glob,
557 struct event_trigger_data *data,
558 struct trace_event_file *file)
563 static void eprobe_trigger_unreg_func(char *glob,
564 struct event_trigger_data *data,
565 struct trace_event_file *file)
570 static struct event_trigger_ops *eprobe_trigger_get_ops(char *cmd,
573 return &eprobe_trigger_ops;
576 static struct event_command event_trigger_cmd = {
578 .trigger_type = ETT_EVENT_EPROBE,
579 .flags = EVENT_CMD_FL_NEEDS_REC,
580 .parse = eprobe_trigger_cmd_parse,
581 .reg = eprobe_trigger_reg_func,
582 .unreg = eprobe_trigger_unreg_func,
584 .get_trigger_ops = eprobe_trigger_get_ops,
588 static struct event_trigger_data *
589 new_eprobe_trigger(struct trace_eprobe *ep, struct trace_event_file *file)
591 struct event_trigger_data *trigger;
592 struct eprobe_data *edata;
594 edata = kzalloc(sizeof(*edata), GFP_KERNEL);
595 trigger = kzalloc(sizeof(*trigger), GFP_KERNEL);
596 if (!trigger || !edata) {
599 return ERR_PTR(-ENOMEM);
602 trigger->flags = EVENT_TRIGGER_FL_PROBE;
604 trigger->ops = &eprobe_trigger_ops;
607 * EVENT PROBE triggers are not registered as commands with
608 * register_event_command(), as they are not controlled by the user
609 * from the trigger file
611 trigger->cmd_ops = &event_trigger_cmd;
613 INIT_LIST_HEAD(&trigger->list);
614 RCU_INIT_POINTER(trigger->filter, NULL);
618 trigger->private_data = edata;
623 static int enable_eprobe(struct trace_eprobe *ep,
624 struct trace_event_file *eprobe_file)
626 struct event_trigger_data *trigger;
627 struct trace_event_file *file;
628 struct trace_array *tr = eprobe_file->tr;
630 file = find_event_file(tr, ep->event_system, ep->event_name);
633 trigger = new_eprobe_trigger(ep, eprobe_file);
635 return PTR_ERR(trigger);
637 list_add_tail_rcu(&trigger->list, &file->triggers);
639 trace_event_trigger_enable_disable(file, 1);
640 update_cond_flag(file);
645 static struct trace_event_functions eprobe_funcs = {
646 .trace = print_eprobe_event
649 static int disable_eprobe(struct trace_eprobe *ep,
650 struct trace_array *tr)
652 struct event_trigger_data *trigger = NULL, *iter;
653 struct trace_event_file *file;
654 struct eprobe_data *edata;
656 file = find_event_file(tr, ep->event_system, ep->event_name);
660 list_for_each_entry(iter, &file->triggers, list) {
661 if (!(iter->flags & EVENT_TRIGGER_FL_PROBE))
663 edata = iter->private_data;
664 if (edata->ep == ep) {
672 list_del_rcu(&trigger->list);
674 trace_event_trigger_enable_disable(file, 0);
675 update_cond_flag(file);
677 /* Make sure nothing is using the edata or trigger */
678 tracepoint_synchronize_unregister();
686 static int enable_trace_eprobe(struct trace_event_call *call,
687 struct trace_event_file *file)
689 struct trace_probe *pos, *tp;
690 struct trace_eprobe *ep;
694 tp = trace_probe_primary_from_call(call);
695 if (WARN_ON_ONCE(!tp))
697 enabled = trace_probe_is_enabled(tp);
699 /* This also changes "enabled" state */
701 ret = trace_probe_add_file(tp, file);
705 trace_probe_set_flag(tp, TP_FLAG_PROFILE);
710 list_for_each_entry(pos, trace_probe_probe_list(tp), list) {
711 ep = container_of(pos, struct trace_eprobe, tp);
712 ret = enable_eprobe(ep, file);
719 /* Failed to enable one of them. Roll back all */
721 disable_eprobe(ep, file->tr);
723 trace_probe_remove_file(tp, file);
725 trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
731 static int disable_trace_eprobe(struct trace_event_call *call,
732 struct trace_event_file *file)
734 struct trace_probe *pos, *tp;
735 struct trace_eprobe *ep;
737 tp = trace_probe_primary_from_call(call);
738 if (WARN_ON_ONCE(!tp))
742 if (!trace_probe_get_file_link(tp, file))
744 if (!trace_probe_has_single_file(tp))
746 trace_probe_clear_flag(tp, TP_FLAG_TRACE);
748 trace_probe_clear_flag(tp, TP_FLAG_PROFILE);
750 if (!trace_probe_is_enabled(tp)) {
751 list_for_each_entry(pos, trace_probe_probe_list(tp), list) {
752 ep = container_of(pos, struct trace_eprobe, tp);
753 disable_eprobe(ep, file->tr);
760 * Synchronization is done in below function. For perf event,
761 * file == NULL and perf_trace_event_unreg() calls
762 * tracepoint_synchronize_unregister() to ensure synchronize
763 * event. We don't need to care about it.
765 trace_probe_remove_file(tp, file);
770 static int eprobe_register(struct trace_event_call *event,
771 enum trace_reg type, void *data)
773 struct trace_event_file *file = data;
776 case TRACE_REG_REGISTER:
777 return enable_trace_eprobe(event, file);
778 case TRACE_REG_UNREGISTER:
779 return disable_trace_eprobe(event, file);
780 #ifdef CONFIG_PERF_EVENTS
781 case TRACE_REG_PERF_REGISTER:
782 case TRACE_REG_PERF_UNREGISTER:
783 case TRACE_REG_PERF_OPEN:
784 case TRACE_REG_PERF_CLOSE:
785 case TRACE_REG_PERF_ADD:
786 case TRACE_REG_PERF_DEL:
793 static inline void init_trace_eprobe_call(struct trace_eprobe *ep)
795 struct trace_event_call *call = trace_probe_event_call(&ep->tp);
797 call->flags = TRACE_EVENT_FL_EPROBE;
798 call->event.funcs = &eprobe_funcs;
799 call->class->fields_array = eprobe_fields_array;
800 call->class->reg = eprobe_register;
803 static struct trace_event_call *
804 find_and_get_event(const char *system, const char *event_name)
806 struct trace_event_call *tp_event;
809 list_for_each_entry(tp_event, &ftrace_events, list) {
810 /* Skip other probes and ftrace events */
811 if (tp_event->flags &
812 (TRACE_EVENT_FL_IGNORE_ENABLE |
813 TRACE_EVENT_FL_KPROBE |
814 TRACE_EVENT_FL_UPROBE |
815 TRACE_EVENT_FL_EPROBE))
817 if (!tp_event->class->system ||
818 strcmp(system, tp_event->class->system))
820 name = trace_event_name(tp_event);
821 if (!name || strcmp(event_name, name))
823 if (!trace_event_try_get_ref(tp_event)) {
833 static int trace_eprobe_tp_update_arg(struct trace_eprobe *ep, const char *argv[], int i)
835 unsigned int flags = TPARG_FL_KERNEL | TPARG_FL_TPOINT;
838 ret = traceprobe_parse_probe_arg(&ep->tp, i, argv[i], flags);
842 if (ep->tp.args[i].code->op == FETCH_OP_TP_ARG) {
843 ret = trace_eprobe_tp_arg_update(ep, i);
845 trace_probe_log_err(0, BAD_ATTACH_ARG);
851 static int __trace_eprobe_create(int argc, const char *argv[])
855 * e[:[GRP/][ENAME]] SYSTEM.EVENT [FETCHARGS]
857 * <name>=$<field>[:TYPE]
859 const char *event = NULL, *group = EPROBE_EVENT_SYSTEM;
860 const char *sys_event = NULL, *sys_name = NULL;
861 struct trace_event_call *event_call;
862 struct trace_eprobe *ep = NULL;
863 char buf1[MAX_EVENT_NAME_LEN];
864 char buf2[MAX_EVENT_NAME_LEN];
865 char gbuf[MAX_EVENT_NAME_LEN];
869 if (argc < 2 || argv[0][0] != 'e')
872 trace_probe_log_init("event_probe", argc, argv);
874 event = strchr(&argv[0][1], ':');
877 ret = traceprobe_parse_event_name(&event, &group, gbuf,
883 trace_probe_log_set_index(1);
885 ret = traceprobe_parse_event_name(&sys_event, &sys_name, buf2, 0);
886 if (!sys_event || !sys_name) {
887 trace_probe_log_err(0, NO_EVENT_INFO);
892 strscpy(buf1, argv[1], MAX_EVENT_NAME_LEN);
893 sanitize_event_name(buf1);
897 mutex_lock(&event_mutex);
898 event_call = find_and_get_event(sys_name, sys_event);
899 ep = alloc_event_probe(group, event, event_call, argc - 2);
900 mutex_unlock(&event_mutex);
905 trace_probe_log_err(0, BAD_ATTACH_EVENT);
906 /* This must return -ENOMEM or missing event, else there is a bug */
907 WARN_ON_ONCE(ret != -ENOMEM && ret != -ENODEV);
912 argc -= 2; argv += 2;
913 /* parse arguments */
914 for (i = 0; i < argc && i < MAX_TRACE_ARGS; i++) {
915 trace_probe_log_set_index(i + 2);
916 ret = trace_eprobe_tp_update_arg(ep, argv, i);
920 ret = traceprobe_set_print_fmt(&ep->tp, PROBE_PRINT_EVENT);
923 init_trace_eprobe_call(ep);
924 mutex_lock(&event_mutex);
925 ret = trace_probe_register_event_call(&ep->tp);
927 if (ret == -EEXIST) {
928 trace_probe_log_set_index(0);
929 trace_probe_log_err(0, EVENT_EXIST);
931 mutex_unlock(&event_mutex);
934 ret = dyn_event_add(&ep->devent, &ep->tp.event->call);
935 mutex_unlock(&event_mutex);
940 trace_event_probe_cleanup(ep);
945 * Register dynevent at core_initcall. This allows kernel to setup eprobe
946 * events in postcore_initcall without tracefs.
948 static __init int trace_events_eprobe_init_early(void)
952 err = dyn_event_register(&eprobe_dyn_event_ops);
954 pr_warn("Could not register eprobe_dyn_event_ops\n");
958 core_initcall(trace_events_eprobe_init_early);