1 // SPDX-License-Identifier: GPL-2.0
2 #include <trace/syscall.h>
3 #include <trace/events/syscalls.h>
4 #include <linux/syscalls.h>
5 #include <linux/slab.h>
6 #include <linux/kernel.h>
7 #include <linux/module.h> /* for MODULE_NAME_LEN via KSYM_SYMBOL_LEN */
8 #include <linux/ftrace.h>
9 #include <linux/perf_event.h>
10 #include <asm/syscall.h>
12 #include "trace_output.h"
15 static DEFINE_MUTEX(syscall_trace_lock);
17 static int syscall_enter_register(struct trace_event_call *event,
18 enum trace_reg type, void *data);
19 static int syscall_exit_register(struct trace_event_call *event,
20 enum trace_reg type, void *data);
22 static struct list_head *
23 syscall_get_enter_fields(struct trace_event_call *call)
25 struct syscall_metadata *entry = call->data;
27 return &entry->enter_fields;
30 extern struct syscall_metadata *__start_syscalls_metadata[];
31 extern struct syscall_metadata *__stop_syscalls_metadata[];
33 static struct syscall_metadata **syscalls_metadata;
35 #ifndef ARCH_HAS_SYSCALL_MATCH_SYM_NAME
36 static inline bool arch_syscall_match_sym_name(const char *sym, const char *name)
39 * Only compare after the "sys" prefix. Archs that use
40 * syscall wrappers may have syscalls symbols aliases prefixed
41 * with ".SyS" or ".sys" instead of "sys", leading to an unwanted
44 return !strcmp(sym + 3, name + 3);
48 #ifdef ARCH_TRACE_IGNORE_COMPAT_SYSCALLS
50 * Some architectures that allow for 32bit applications
51 * to run on a 64bit kernel, do not map the syscalls for
52 * the 32bit tasks the same as they do for 64bit tasks.
56 * In such a case, instead of reporting the wrong syscalls,
59 * For an arch to ignore the compat syscalls it needs to
60 * define ARCH_TRACE_IGNORE_COMPAT_SYSCALLS as well as
61 * define the function arch_trace_is_compat_syscall() to let
62 * the tracing system know that it should ignore it.
65 trace_get_syscall_nr(struct task_struct *task, struct pt_regs *regs)
67 if (unlikely(arch_trace_is_compat_syscall(regs)))
70 return syscall_get_nr(task, regs);
74 trace_get_syscall_nr(struct task_struct *task, struct pt_regs *regs)
76 return syscall_get_nr(task, regs);
78 #endif /* ARCH_TRACE_IGNORE_COMPAT_SYSCALLS */
80 static __init struct syscall_metadata *
81 find_syscall_meta(unsigned long syscall)
83 struct syscall_metadata **start;
84 struct syscall_metadata **stop;
85 char str[KSYM_SYMBOL_LEN];
88 start = __start_syscalls_metadata;
89 stop = __stop_syscalls_metadata;
90 kallsyms_lookup(syscall, NULL, NULL, NULL, str);
92 if (arch_syscall_match_sym_name(str, "sys_ni_syscall"))
95 for ( ; start < stop; start++) {
96 if ((*start)->name && arch_syscall_match_sym_name(str, (*start)->name))
102 static struct syscall_metadata *syscall_nr_to_meta(int nr)
104 if (!syscalls_metadata || nr >= NR_syscalls || nr < 0)
107 return syscalls_metadata[nr];
110 const char *get_syscall_name(int syscall)
112 struct syscall_metadata *entry;
114 entry = syscall_nr_to_meta(syscall);
121 static enum print_line_t
122 print_syscall_enter(struct trace_iterator *iter, int flags,
123 struct trace_event *event)
125 struct trace_array *tr = iter->tr;
126 struct trace_seq *s = &iter->seq;
127 struct trace_entry *ent = iter->ent;
128 struct syscall_trace_enter *trace;
129 struct syscall_metadata *entry;
132 trace = (typeof(trace))ent;
134 entry = syscall_nr_to_meta(syscall);
139 if (entry->enter_event->event.type != ent->type) {
144 trace_seq_printf(s, "%s(", entry->name);
146 for (i = 0; i < entry->nb_args; i++) {
148 if (trace_seq_has_overflowed(s))
151 /* parameter types */
152 if (tr->trace_flags & TRACE_ITER_VERBOSE)
153 trace_seq_printf(s, "%s ", entry->types[i]);
155 /* parameter values */
156 trace_seq_printf(s, "%s: %lx%s", entry->args[i],
158 i == entry->nb_args - 1 ? "" : ", ");
161 trace_seq_putc(s, ')');
163 trace_seq_putc(s, '\n');
165 return trace_handle_return(s);
168 static enum print_line_t
169 print_syscall_exit(struct trace_iterator *iter, int flags,
170 struct trace_event *event)
172 struct trace_seq *s = &iter->seq;
173 struct trace_entry *ent = iter->ent;
174 struct syscall_trace_exit *trace;
176 struct syscall_metadata *entry;
178 trace = (typeof(trace))ent;
180 entry = syscall_nr_to_meta(syscall);
183 trace_seq_putc(s, '\n');
187 if (entry->exit_event->event.type != ent->type) {
189 return TRACE_TYPE_UNHANDLED;
192 trace_seq_printf(s, "%s -> 0x%lx\n", entry->name,
196 return trace_handle_return(s);
199 extern char *__bad_type_size(void);
201 #define SYSCALL_FIELD(_type, _name) { \
202 .type = #_type, .name = #_name, \
203 .size = sizeof(_type), .align = __alignof__(_type), \
204 .is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER }
207 __set_enter_print_fmt(struct syscall_metadata *entry, char *buf, int len)
212 /* When len=0, we just calculate the needed length */
213 #define LEN_OR_ZERO (len ? len - pos : 0)
215 pos += snprintf(buf + pos, LEN_OR_ZERO, "\"");
216 for (i = 0; i < entry->nb_args; i++) {
217 pos += snprintf(buf + pos, LEN_OR_ZERO, "%s: 0x%%0%zulx%s",
218 entry->args[i], sizeof(unsigned long),
219 i == entry->nb_args - 1 ? "" : ", ");
221 pos += snprintf(buf + pos, LEN_OR_ZERO, "\"");
223 for (i = 0; i < entry->nb_args; i++) {
224 pos += snprintf(buf + pos, LEN_OR_ZERO,
225 ", ((unsigned long)(REC->%s))", entry->args[i]);
230 /* return the length of print_fmt */
234 static int __init set_syscall_print_fmt(struct trace_event_call *call)
238 struct syscall_metadata *entry = call->data;
240 if (entry->enter_event != call) {
241 call->print_fmt = "\"0x%lx\", REC->ret";
245 /* First: called with 0 length to calculate the needed length */
246 len = __set_enter_print_fmt(entry, NULL, 0);
248 print_fmt = kmalloc(len + 1, GFP_KERNEL);
252 /* Second: actually write the @print_fmt */
253 __set_enter_print_fmt(entry, print_fmt, len + 1);
254 call->print_fmt = print_fmt;
259 static void __init free_syscall_print_fmt(struct trace_event_call *call)
261 struct syscall_metadata *entry = call->data;
263 if (entry->enter_event == call)
264 kfree(call->print_fmt);
267 static int __init syscall_enter_define_fields(struct trace_event_call *call)
269 struct syscall_trace_enter trace;
270 struct syscall_metadata *meta = call->data;
271 int offset = offsetof(typeof(trace), args);
274 for (i = 0; i < meta->nb_args; i++) {
275 ret = trace_define_field(call, meta->types[i],
276 meta->args[i], offset,
277 sizeof(unsigned long), 0,
281 offset += sizeof(unsigned long);
287 static void ftrace_syscall_enter(void *data, struct pt_regs *regs, long id)
289 struct trace_array *tr = data;
290 struct trace_event_file *trace_file;
291 struct syscall_trace_enter *entry;
292 struct syscall_metadata *sys_data;
293 struct ring_buffer_event *event;
294 struct ring_buffer *buffer;
295 unsigned long irq_flags;
296 unsigned long args[6];
301 syscall_nr = trace_get_syscall_nr(current, regs);
302 if (syscall_nr < 0 || syscall_nr >= NR_syscalls)
305 /* Here we're inside tp handler's rcu_read_lock_sched (__DO_TRACE) */
306 trace_file = rcu_dereference_sched(tr->enter_syscall_files[syscall_nr]);
310 if (trace_trigger_soft_disabled(trace_file))
313 sys_data = syscall_nr_to_meta(syscall_nr);
317 size = sizeof(*entry) + sizeof(unsigned long) * sys_data->nb_args;
319 local_save_flags(irq_flags);
320 pc = preempt_count();
322 buffer = tr->trace_buffer.buffer;
323 event = trace_buffer_lock_reserve(buffer,
324 sys_data->enter_event->event.type, size, irq_flags, pc);
328 entry = ring_buffer_event_data(event);
329 entry->nr = syscall_nr;
330 syscall_get_arguments(current, regs, args);
331 memcpy(entry->args, args, sizeof(unsigned long) * sys_data->nb_args);
333 event_trigger_unlock_commit(trace_file, buffer, event, entry,
337 static void ftrace_syscall_exit(void *data, struct pt_regs *regs, long ret)
339 struct trace_array *tr = data;
340 struct trace_event_file *trace_file;
341 struct syscall_trace_exit *entry;
342 struct syscall_metadata *sys_data;
343 struct ring_buffer_event *event;
344 struct ring_buffer *buffer;
345 unsigned long irq_flags;
349 syscall_nr = trace_get_syscall_nr(current, regs);
350 if (syscall_nr < 0 || syscall_nr >= NR_syscalls)
353 /* Here we're inside tp handler's rcu_read_lock_sched (__DO_TRACE()) */
354 trace_file = rcu_dereference_sched(tr->exit_syscall_files[syscall_nr]);
358 if (trace_trigger_soft_disabled(trace_file))
361 sys_data = syscall_nr_to_meta(syscall_nr);
365 local_save_flags(irq_flags);
366 pc = preempt_count();
368 buffer = tr->trace_buffer.buffer;
369 event = trace_buffer_lock_reserve(buffer,
370 sys_data->exit_event->event.type, sizeof(*entry),
375 entry = ring_buffer_event_data(event);
376 entry->nr = syscall_nr;
377 entry->ret = syscall_get_return_value(current, regs);
379 event_trigger_unlock_commit(trace_file, buffer, event, entry,
383 static int reg_event_syscall_enter(struct trace_event_file *file,
384 struct trace_event_call *call)
386 struct trace_array *tr = file->tr;
390 num = ((struct syscall_metadata *)call->data)->syscall_nr;
391 if (WARN_ON_ONCE(num < 0 || num >= NR_syscalls))
393 mutex_lock(&syscall_trace_lock);
394 if (!tr->sys_refcount_enter)
395 ret = register_trace_sys_enter(ftrace_syscall_enter, tr);
397 rcu_assign_pointer(tr->enter_syscall_files[num], file);
398 tr->sys_refcount_enter++;
400 mutex_unlock(&syscall_trace_lock);
404 static void unreg_event_syscall_enter(struct trace_event_file *file,
405 struct trace_event_call *call)
407 struct trace_array *tr = file->tr;
410 num = ((struct syscall_metadata *)call->data)->syscall_nr;
411 if (WARN_ON_ONCE(num < 0 || num >= NR_syscalls))
413 mutex_lock(&syscall_trace_lock);
414 tr->sys_refcount_enter--;
415 RCU_INIT_POINTER(tr->enter_syscall_files[num], NULL);
416 if (!tr->sys_refcount_enter)
417 unregister_trace_sys_enter(ftrace_syscall_enter, tr);
418 mutex_unlock(&syscall_trace_lock);
421 static int reg_event_syscall_exit(struct trace_event_file *file,
422 struct trace_event_call *call)
424 struct trace_array *tr = file->tr;
428 num = ((struct syscall_metadata *)call->data)->syscall_nr;
429 if (WARN_ON_ONCE(num < 0 || num >= NR_syscalls))
431 mutex_lock(&syscall_trace_lock);
432 if (!tr->sys_refcount_exit)
433 ret = register_trace_sys_exit(ftrace_syscall_exit, tr);
435 rcu_assign_pointer(tr->exit_syscall_files[num], file);
436 tr->sys_refcount_exit++;
438 mutex_unlock(&syscall_trace_lock);
442 static void unreg_event_syscall_exit(struct trace_event_file *file,
443 struct trace_event_call *call)
445 struct trace_array *tr = file->tr;
448 num = ((struct syscall_metadata *)call->data)->syscall_nr;
449 if (WARN_ON_ONCE(num < 0 || num >= NR_syscalls))
451 mutex_lock(&syscall_trace_lock);
452 tr->sys_refcount_exit--;
453 RCU_INIT_POINTER(tr->exit_syscall_files[num], NULL);
454 if (!tr->sys_refcount_exit)
455 unregister_trace_sys_exit(ftrace_syscall_exit, tr);
456 mutex_unlock(&syscall_trace_lock);
459 static int __init init_syscall_trace(struct trace_event_call *call)
464 num = ((struct syscall_metadata *)call->data)->syscall_nr;
465 if (num < 0 || num >= NR_syscalls) {
466 pr_debug("syscall %s metadata not mapped, disabling ftrace event\n",
467 ((struct syscall_metadata *)call->data)->name);
471 if (set_syscall_print_fmt(call) < 0)
474 id = trace_event_raw_init(call);
477 free_syscall_print_fmt(call);
484 static struct trace_event_fields __refdata syscall_enter_fields_array[] = {
485 SYSCALL_FIELD(int, __syscall_nr),
486 { .type = TRACE_FUNCTION_TYPE,
487 .define_fields = syscall_enter_define_fields },
491 struct trace_event_functions enter_syscall_print_funcs = {
492 .trace = print_syscall_enter,
495 struct trace_event_functions exit_syscall_print_funcs = {
496 .trace = print_syscall_exit,
499 struct trace_event_class __refdata event_class_syscall_enter = {
500 .system = "syscalls",
501 .reg = syscall_enter_register,
502 .fields_array = syscall_enter_fields_array,
503 .get_fields = syscall_get_enter_fields,
504 .raw_init = init_syscall_trace,
507 struct trace_event_class __refdata event_class_syscall_exit = {
508 .system = "syscalls",
509 .reg = syscall_exit_register,
510 .fields_array = (struct trace_event_fields[]){
511 SYSCALL_FIELD(int, __syscall_nr),
512 SYSCALL_FIELD(long, ret),
515 .fields = LIST_HEAD_INIT(event_class_syscall_exit.fields),
516 .raw_init = init_syscall_trace,
519 unsigned long __init __weak arch_syscall_addr(int nr)
521 return (unsigned long)sys_call_table[nr];
524 void __init init_ftrace_syscalls(void)
526 struct syscall_metadata *meta;
530 syscalls_metadata = kcalloc(NR_syscalls, sizeof(*syscalls_metadata),
532 if (!syscalls_metadata) {
537 for (i = 0; i < NR_syscalls; i++) {
538 addr = arch_syscall_addr(i);
539 meta = find_syscall_meta(addr);
543 meta->syscall_nr = i;
544 syscalls_metadata[i] = meta;
548 #ifdef CONFIG_PERF_EVENTS
550 static DECLARE_BITMAP(enabled_perf_enter_syscalls, NR_syscalls);
551 static DECLARE_BITMAP(enabled_perf_exit_syscalls, NR_syscalls);
552 static int sys_perf_refcount_enter;
553 static int sys_perf_refcount_exit;
555 static int perf_call_bpf_enter(struct trace_event_call *call, struct pt_regs *regs,
556 struct syscall_metadata *sys_data,
557 struct syscall_trace_enter *rec)
559 struct syscall_tp_t {
560 unsigned long long regs;
561 unsigned long syscall_nr;
562 unsigned long args[SYSCALL_DEFINE_MAXARGS];
566 *(struct pt_regs **)¶m = regs;
567 param.syscall_nr = rec->nr;
568 for (i = 0; i < sys_data->nb_args; i++)
569 param.args[i] = rec->args[i];
570 return trace_call_bpf(call, ¶m);
573 static void perf_syscall_enter(void *ignore, struct pt_regs *regs, long id)
575 struct syscall_metadata *sys_data;
576 struct syscall_trace_enter *rec;
577 struct hlist_head *head;
578 unsigned long args[6];
579 bool valid_prog_array;
584 syscall_nr = trace_get_syscall_nr(current, regs);
585 if (syscall_nr < 0 || syscall_nr >= NR_syscalls)
587 if (!test_bit(syscall_nr, enabled_perf_enter_syscalls))
590 sys_data = syscall_nr_to_meta(syscall_nr);
594 head = this_cpu_ptr(sys_data->enter_event->perf_events);
595 valid_prog_array = bpf_prog_array_valid(sys_data->enter_event);
596 if (!valid_prog_array && hlist_empty(head))
599 /* get the size after alignment with the u32 buffer size field */
600 size = sizeof(unsigned long) * sys_data->nb_args + sizeof(*rec);
601 size = ALIGN(size + sizeof(u32), sizeof(u64));
604 rec = perf_trace_buf_alloc(size, NULL, &rctx);
608 rec->nr = syscall_nr;
609 syscall_get_arguments(current, regs, args);
610 memcpy(&rec->args, args, sizeof(unsigned long) * sys_data->nb_args);
612 if ((valid_prog_array &&
613 !perf_call_bpf_enter(sys_data->enter_event, regs, sys_data, rec)) ||
615 perf_swevent_put_recursion_context(rctx);
619 perf_trace_buf_submit(rec, size, rctx,
620 sys_data->enter_event->event.type, 1, regs,
624 static int perf_sysenter_enable(struct trace_event_call *call)
629 num = ((struct syscall_metadata *)call->data)->syscall_nr;
631 mutex_lock(&syscall_trace_lock);
632 if (!sys_perf_refcount_enter)
633 ret = register_trace_sys_enter(perf_syscall_enter, NULL);
635 pr_info("event trace: Could not activate syscall entry trace point");
637 set_bit(num, enabled_perf_enter_syscalls);
638 sys_perf_refcount_enter++;
640 mutex_unlock(&syscall_trace_lock);
644 static void perf_sysenter_disable(struct trace_event_call *call)
648 num = ((struct syscall_metadata *)call->data)->syscall_nr;
650 mutex_lock(&syscall_trace_lock);
651 sys_perf_refcount_enter--;
652 clear_bit(num, enabled_perf_enter_syscalls);
653 if (!sys_perf_refcount_enter)
654 unregister_trace_sys_enter(perf_syscall_enter, NULL);
655 mutex_unlock(&syscall_trace_lock);
658 static int perf_call_bpf_exit(struct trace_event_call *call, struct pt_regs *regs,
659 struct syscall_trace_exit *rec)
661 struct syscall_tp_t {
662 unsigned long long regs;
663 unsigned long syscall_nr;
667 *(struct pt_regs **)¶m = regs;
668 param.syscall_nr = rec->nr;
669 param.ret = rec->ret;
670 return trace_call_bpf(call, ¶m);
673 static void perf_syscall_exit(void *ignore, struct pt_regs *regs, long ret)
675 struct syscall_metadata *sys_data;
676 struct syscall_trace_exit *rec;
677 struct hlist_head *head;
678 bool valid_prog_array;
683 syscall_nr = trace_get_syscall_nr(current, regs);
684 if (syscall_nr < 0 || syscall_nr >= NR_syscalls)
686 if (!test_bit(syscall_nr, enabled_perf_exit_syscalls))
689 sys_data = syscall_nr_to_meta(syscall_nr);
693 head = this_cpu_ptr(sys_data->exit_event->perf_events);
694 valid_prog_array = bpf_prog_array_valid(sys_data->exit_event);
695 if (!valid_prog_array && hlist_empty(head))
698 /* We can probably do that at build time */
699 size = ALIGN(sizeof(*rec) + sizeof(u32), sizeof(u64));
702 rec = perf_trace_buf_alloc(size, NULL, &rctx);
706 rec->nr = syscall_nr;
707 rec->ret = syscall_get_return_value(current, regs);
709 if ((valid_prog_array &&
710 !perf_call_bpf_exit(sys_data->exit_event, regs, rec)) ||
712 perf_swevent_put_recursion_context(rctx);
716 perf_trace_buf_submit(rec, size, rctx, sys_data->exit_event->event.type,
717 1, regs, head, NULL);
720 static int perf_sysexit_enable(struct trace_event_call *call)
725 num = ((struct syscall_metadata *)call->data)->syscall_nr;
727 mutex_lock(&syscall_trace_lock);
728 if (!sys_perf_refcount_exit)
729 ret = register_trace_sys_exit(perf_syscall_exit, NULL);
731 pr_info("event trace: Could not activate syscall exit trace point");
733 set_bit(num, enabled_perf_exit_syscalls);
734 sys_perf_refcount_exit++;
736 mutex_unlock(&syscall_trace_lock);
740 static void perf_sysexit_disable(struct trace_event_call *call)
744 num = ((struct syscall_metadata *)call->data)->syscall_nr;
746 mutex_lock(&syscall_trace_lock);
747 sys_perf_refcount_exit--;
748 clear_bit(num, enabled_perf_exit_syscalls);
749 if (!sys_perf_refcount_exit)
750 unregister_trace_sys_exit(perf_syscall_exit, NULL);
751 mutex_unlock(&syscall_trace_lock);
754 #endif /* CONFIG_PERF_EVENTS */
756 static int syscall_enter_register(struct trace_event_call *event,
757 enum trace_reg type, void *data)
759 struct trace_event_file *file = data;
762 case TRACE_REG_REGISTER:
763 return reg_event_syscall_enter(file, event);
764 case TRACE_REG_UNREGISTER:
765 unreg_event_syscall_enter(file, event);
768 #ifdef CONFIG_PERF_EVENTS
769 case TRACE_REG_PERF_REGISTER:
770 return perf_sysenter_enable(event);
771 case TRACE_REG_PERF_UNREGISTER:
772 perf_sysenter_disable(event);
774 case TRACE_REG_PERF_OPEN:
775 case TRACE_REG_PERF_CLOSE:
776 case TRACE_REG_PERF_ADD:
777 case TRACE_REG_PERF_DEL:
784 static int syscall_exit_register(struct trace_event_call *event,
785 enum trace_reg type, void *data)
787 struct trace_event_file *file = data;
790 case TRACE_REG_REGISTER:
791 return reg_event_syscall_exit(file, event);
792 case TRACE_REG_UNREGISTER:
793 unreg_event_syscall_exit(file, event);
796 #ifdef CONFIG_PERF_EVENTS
797 case TRACE_REG_PERF_REGISTER:
798 return perf_sysexit_enable(event);
799 case TRACE_REG_PERF_UNREGISTER:
800 perf_sysexit_disable(event);
802 case TRACE_REG_PERF_OPEN:
803 case TRACE_REG_PERF_CLOSE:
804 case TRACE_REG_PERF_ADD:
805 case TRACE_REG_PERF_DEL: