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 <linux/xarray.h>
11 #include <asm/syscall.h>
13 #include "trace_output.h"
16 static DEFINE_MUTEX(syscall_trace_lock);
18 static int syscall_enter_register(struct trace_event_call *event,
19 enum trace_reg type, void *data);
20 static int syscall_exit_register(struct trace_event_call *event,
21 enum trace_reg type, void *data);
23 static struct list_head *
24 syscall_get_enter_fields(struct trace_event_call *call)
26 struct syscall_metadata *entry = call->data;
28 return &entry->enter_fields;
31 extern struct syscall_metadata *__start_syscalls_metadata[];
32 extern struct syscall_metadata *__stop_syscalls_metadata[];
34 static DEFINE_XARRAY(syscalls_metadata_sparse);
35 static struct syscall_metadata **syscalls_metadata;
37 #ifndef ARCH_HAS_SYSCALL_MATCH_SYM_NAME
38 static inline bool arch_syscall_match_sym_name(const char *sym, const char *name)
41 * Only compare after the "sys" prefix. Archs that use
42 * syscall wrappers may have syscalls symbols aliases prefixed
43 * with ".SyS" or ".sys" instead of "sys", leading to an unwanted
46 return !strcmp(sym + 3, name + 3);
50 #ifdef ARCH_TRACE_IGNORE_COMPAT_SYSCALLS
52 * Some architectures that allow for 32bit applications
53 * to run on a 64bit kernel, do not map the syscalls for
54 * the 32bit tasks the same as they do for 64bit tasks.
58 * In such a case, instead of reporting the wrong syscalls,
61 * For an arch to ignore the compat syscalls it needs to
62 * define ARCH_TRACE_IGNORE_COMPAT_SYSCALLS as well as
63 * define the function arch_trace_is_compat_syscall() to let
64 * the tracing system know that it should ignore it.
67 trace_get_syscall_nr(struct task_struct *task, struct pt_regs *regs)
69 if (unlikely(arch_trace_is_compat_syscall(regs)))
72 return syscall_get_nr(task, regs);
76 trace_get_syscall_nr(struct task_struct *task, struct pt_regs *regs)
78 return syscall_get_nr(task, regs);
80 #endif /* ARCH_TRACE_IGNORE_COMPAT_SYSCALLS */
82 static __init struct syscall_metadata *
83 find_syscall_meta(unsigned long syscall)
85 struct syscall_metadata **start;
86 struct syscall_metadata **stop;
87 char str[KSYM_SYMBOL_LEN];
90 start = __start_syscalls_metadata;
91 stop = __stop_syscalls_metadata;
92 kallsyms_lookup(syscall, NULL, NULL, NULL, str);
94 if (arch_syscall_match_sym_name(str, "sys_ni_syscall"))
97 for ( ; start < stop; start++) {
98 if ((*start)->name && arch_syscall_match_sym_name(str, (*start)->name))
104 static struct syscall_metadata *syscall_nr_to_meta(int nr)
106 if (IS_ENABLED(CONFIG_HAVE_SPARSE_SYSCALL_NR))
107 return xa_load(&syscalls_metadata_sparse, (unsigned long)nr);
109 if (!syscalls_metadata || nr >= NR_syscalls || nr < 0)
112 return syscalls_metadata[nr];
115 const char *get_syscall_name(int syscall)
117 struct syscall_metadata *entry;
119 entry = syscall_nr_to_meta(syscall);
126 static enum print_line_t
127 print_syscall_enter(struct trace_iterator *iter, int flags,
128 struct trace_event *event)
130 struct trace_array *tr = iter->tr;
131 struct trace_seq *s = &iter->seq;
132 struct trace_entry *ent = iter->ent;
133 struct syscall_trace_enter *trace;
134 struct syscall_metadata *entry;
137 trace = (typeof(trace))ent;
139 entry = syscall_nr_to_meta(syscall);
144 if (entry->enter_event->event.type != ent->type) {
149 trace_seq_printf(s, "%s(", entry->name);
151 for (i = 0; i < entry->nb_args; i++) {
153 if (trace_seq_has_overflowed(s))
156 /* parameter types */
157 if (tr->trace_flags & TRACE_ITER_VERBOSE)
158 trace_seq_printf(s, "%s ", entry->types[i]);
160 /* parameter values */
161 trace_seq_printf(s, "%s: %lx%s", entry->args[i],
163 i == entry->nb_args - 1 ? "" : ", ");
166 trace_seq_putc(s, ')');
168 trace_seq_putc(s, '\n');
170 return trace_handle_return(s);
173 static enum print_line_t
174 print_syscall_exit(struct trace_iterator *iter, int flags,
175 struct trace_event *event)
177 struct trace_seq *s = &iter->seq;
178 struct trace_entry *ent = iter->ent;
179 struct syscall_trace_exit *trace;
181 struct syscall_metadata *entry;
183 trace = (typeof(trace))ent;
185 entry = syscall_nr_to_meta(syscall);
188 trace_seq_putc(s, '\n');
192 if (entry->exit_event->event.type != ent->type) {
194 return TRACE_TYPE_UNHANDLED;
197 trace_seq_printf(s, "%s -> 0x%lx\n", entry->name,
201 return trace_handle_return(s);
204 extern char *__bad_type_size(void);
206 #define SYSCALL_FIELD(_type, _name) { \
207 .type = #_type, .name = #_name, \
208 .size = sizeof(_type), .align = __alignof__(_type), \
209 .is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER }
212 __set_enter_print_fmt(struct syscall_metadata *entry, char *buf, int len)
217 /* When len=0, we just calculate the needed length */
218 #define LEN_OR_ZERO (len ? len - pos : 0)
220 pos += snprintf(buf + pos, LEN_OR_ZERO, "\"");
221 for (i = 0; i < entry->nb_args; i++) {
222 pos += snprintf(buf + pos, LEN_OR_ZERO, "%s: 0x%%0%zulx%s",
223 entry->args[i], sizeof(unsigned long),
224 i == entry->nb_args - 1 ? "" : ", ");
226 pos += snprintf(buf + pos, LEN_OR_ZERO, "\"");
228 for (i = 0; i < entry->nb_args; i++) {
229 pos += snprintf(buf + pos, LEN_OR_ZERO,
230 ", ((unsigned long)(REC->%s))", entry->args[i]);
235 /* return the length of print_fmt */
239 static int __init set_syscall_print_fmt(struct trace_event_call *call)
243 struct syscall_metadata *entry = call->data;
245 if (entry->enter_event != call) {
246 call->print_fmt = "\"0x%lx\", REC->ret";
250 /* First: called with 0 length to calculate the needed length */
251 len = __set_enter_print_fmt(entry, NULL, 0);
253 print_fmt = kmalloc(len + 1, GFP_KERNEL);
257 /* Second: actually write the @print_fmt */
258 __set_enter_print_fmt(entry, print_fmt, len + 1);
259 call->print_fmt = print_fmt;
264 static void __init free_syscall_print_fmt(struct trace_event_call *call)
266 struct syscall_metadata *entry = call->data;
268 if (entry->enter_event == call)
269 kfree(call->print_fmt);
272 static int __init syscall_enter_define_fields(struct trace_event_call *call)
274 struct syscall_trace_enter trace;
275 struct syscall_metadata *meta = call->data;
276 int offset = offsetof(typeof(trace), args);
280 for (i = 0; i < meta->nb_args; i++) {
281 ret = trace_define_field(call, meta->types[i],
282 meta->args[i], offset,
283 sizeof(unsigned long), 0,
287 offset += sizeof(unsigned long);
293 static void ftrace_syscall_enter(void *data, struct pt_regs *regs, long id)
295 struct trace_array *tr = data;
296 struct trace_event_file *trace_file;
297 struct syscall_trace_enter *entry;
298 struct syscall_metadata *sys_data;
299 struct ring_buffer_event *event;
300 struct trace_buffer *buffer;
301 unsigned int trace_ctx;
302 unsigned long args[6];
306 syscall_nr = trace_get_syscall_nr(current, regs);
307 if (syscall_nr < 0 || syscall_nr >= NR_syscalls)
310 /* Here we're inside tp handler's rcu_read_lock_sched (__DO_TRACE) */
311 trace_file = rcu_dereference_sched(tr->enter_syscall_files[syscall_nr]);
315 if (trace_trigger_soft_disabled(trace_file))
318 sys_data = syscall_nr_to_meta(syscall_nr);
322 size = sizeof(*entry) + sizeof(unsigned long) * sys_data->nb_args;
324 trace_ctx = tracing_gen_ctx();
326 event = trace_event_buffer_lock_reserve(&buffer, trace_file,
327 sys_data->enter_event->event.type, size, trace_ctx);
331 entry = ring_buffer_event_data(event);
332 entry->nr = syscall_nr;
333 syscall_get_arguments(current, regs, args);
334 memcpy(entry->args, args, sizeof(unsigned long) * sys_data->nb_args);
336 event_trigger_unlock_commit(trace_file, buffer, event, entry,
340 static void ftrace_syscall_exit(void *data, struct pt_regs *regs, long ret)
342 struct trace_array *tr = data;
343 struct trace_event_file *trace_file;
344 struct syscall_trace_exit *entry;
345 struct syscall_metadata *sys_data;
346 struct ring_buffer_event *event;
347 struct trace_buffer *buffer;
348 unsigned int trace_ctx;
351 syscall_nr = trace_get_syscall_nr(current, regs);
352 if (syscall_nr < 0 || syscall_nr >= NR_syscalls)
355 /* Here we're inside tp handler's rcu_read_lock_sched (__DO_TRACE()) */
356 trace_file = rcu_dereference_sched(tr->exit_syscall_files[syscall_nr]);
360 if (trace_trigger_soft_disabled(trace_file))
363 sys_data = syscall_nr_to_meta(syscall_nr);
367 trace_ctx = tracing_gen_ctx();
369 event = trace_event_buffer_lock_reserve(&buffer, trace_file,
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;
531 if (!IS_ENABLED(CONFIG_HAVE_SPARSE_SYSCALL_NR)) {
532 syscalls_metadata = kcalloc(NR_syscalls,
533 sizeof(*syscalls_metadata),
535 if (!syscalls_metadata) {
541 for (i = 0; i < NR_syscalls; i++) {
542 addr = arch_syscall_addr(i);
543 meta = find_syscall_meta(addr);
547 meta->syscall_nr = i;
549 if (!IS_ENABLED(CONFIG_HAVE_SPARSE_SYSCALL_NR)) {
550 syscalls_metadata[i] = meta;
552 ret = xa_store(&syscalls_metadata_sparse, i, meta,
555 "Syscall memory allocation failed\n");
561 #ifdef CONFIG_PERF_EVENTS
563 static DECLARE_BITMAP(enabled_perf_enter_syscalls, NR_syscalls);
564 static DECLARE_BITMAP(enabled_perf_exit_syscalls, NR_syscalls);
565 static int sys_perf_refcount_enter;
566 static int sys_perf_refcount_exit;
568 static int perf_call_bpf_enter(struct trace_event_call *call, struct pt_regs *regs,
569 struct syscall_metadata *sys_data,
570 struct syscall_trace_enter *rec)
572 struct syscall_tp_t {
573 unsigned long long regs;
574 unsigned long syscall_nr;
575 unsigned long args[SYSCALL_DEFINE_MAXARGS];
579 *(struct pt_regs **)¶m = regs;
580 param.syscall_nr = rec->nr;
581 for (i = 0; i < sys_data->nb_args; i++)
582 param.args[i] = rec->args[i];
583 return trace_call_bpf(call, ¶m);
586 static void perf_syscall_enter(void *ignore, struct pt_regs *regs, long id)
588 struct syscall_metadata *sys_data;
589 struct syscall_trace_enter *rec;
590 struct hlist_head *head;
591 unsigned long args[6];
592 bool valid_prog_array;
597 syscall_nr = trace_get_syscall_nr(current, regs);
598 if (syscall_nr < 0 || syscall_nr >= NR_syscalls)
600 if (!test_bit(syscall_nr, enabled_perf_enter_syscalls))
603 sys_data = syscall_nr_to_meta(syscall_nr);
607 head = this_cpu_ptr(sys_data->enter_event->perf_events);
608 valid_prog_array = bpf_prog_array_valid(sys_data->enter_event);
609 if (!valid_prog_array && hlist_empty(head))
612 /* get the size after alignment with the u32 buffer size field */
613 size = sizeof(unsigned long) * sys_data->nb_args + sizeof(*rec);
614 size = ALIGN(size + sizeof(u32), sizeof(u64));
617 rec = perf_trace_buf_alloc(size, NULL, &rctx);
621 rec->nr = syscall_nr;
622 syscall_get_arguments(current, regs, args);
623 memcpy(&rec->args, args, sizeof(unsigned long) * sys_data->nb_args);
625 if ((valid_prog_array &&
626 !perf_call_bpf_enter(sys_data->enter_event, regs, sys_data, rec)) ||
628 perf_swevent_put_recursion_context(rctx);
632 perf_trace_buf_submit(rec, size, rctx,
633 sys_data->enter_event->event.type, 1, regs,
637 static int perf_sysenter_enable(struct trace_event_call *call)
642 num = ((struct syscall_metadata *)call->data)->syscall_nr;
644 mutex_lock(&syscall_trace_lock);
645 if (!sys_perf_refcount_enter)
646 ret = register_trace_sys_enter(perf_syscall_enter, NULL);
648 pr_info("event trace: Could not activate syscall entry trace point");
650 set_bit(num, enabled_perf_enter_syscalls);
651 sys_perf_refcount_enter++;
653 mutex_unlock(&syscall_trace_lock);
657 static void perf_sysenter_disable(struct trace_event_call *call)
661 num = ((struct syscall_metadata *)call->data)->syscall_nr;
663 mutex_lock(&syscall_trace_lock);
664 sys_perf_refcount_enter--;
665 clear_bit(num, enabled_perf_enter_syscalls);
666 if (!sys_perf_refcount_enter)
667 unregister_trace_sys_enter(perf_syscall_enter, NULL);
668 mutex_unlock(&syscall_trace_lock);
671 static int perf_call_bpf_exit(struct trace_event_call *call, struct pt_regs *regs,
672 struct syscall_trace_exit *rec)
674 struct syscall_tp_t {
675 unsigned long long regs;
676 unsigned long syscall_nr;
680 *(struct pt_regs **)¶m = regs;
681 param.syscall_nr = rec->nr;
682 param.ret = rec->ret;
683 return trace_call_bpf(call, ¶m);
686 static void perf_syscall_exit(void *ignore, struct pt_regs *regs, long ret)
688 struct syscall_metadata *sys_data;
689 struct syscall_trace_exit *rec;
690 struct hlist_head *head;
691 bool valid_prog_array;
696 syscall_nr = trace_get_syscall_nr(current, regs);
697 if (syscall_nr < 0 || syscall_nr >= NR_syscalls)
699 if (!test_bit(syscall_nr, enabled_perf_exit_syscalls))
702 sys_data = syscall_nr_to_meta(syscall_nr);
706 head = this_cpu_ptr(sys_data->exit_event->perf_events);
707 valid_prog_array = bpf_prog_array_valid(sys_data->exit_event);
708 if (!valid_prog_array && hlist_empty(head))
711 /* We can probably do that at build time */
712 size = ALIGN(sizeof(*rec) + sizeof(u32), sizeof(u64));
715 rec = perf_trace_buf_alloc(size, NULL, &rctx);
719 rec->nr = syscall_nr;
720 rec->ret = syscall_get_return_value(current, regs);
722 if ((valid_prog_array &&
723 !perf_call_bpf_exit(sys_data->exit_event, regs, rec)) ||
725 perf_swevent_put_recursion_context(rctx);
729 perf_trace_buf_submit(rec, size, rctx, sys_data->exit_event->event.type,
730 1, regs, head, NULL);
733 static int perf_sysexit_enable(struct trace_event_call *call)
738 num = ((struct syscall_metadata *)call->data)->syscall_nr;
740 mutex_lock(&syscall_trace_lock);
741 if (!sys_perf_refcount_exit)
742 ret = register_trace_sys_exit(perf_syscall_exit, NULL);
744 pr_info("event trace: Could not activate syscall exit trace point");
746 set_bit(num, enabled_perf_exit_syscalls);
747 sys_perf_refcount_exit++;
749 mutex_unlock(&syscall_trace_lock);
753 static void perf_sysexit_disable(struct trace_event_call *call)
757 num = ((struct syscall_metadata *)call->data)->syscall_nr;
759 mutex_lock(&syscall_trace_lock);
760 sys_perf_refcount_exit--;
761 clear_bit(num, enabled_perf_exit_syscalls);
762 if (!sys_perf_refcount_exit)
763 unregister_trace_sys_exit(perf_syscall_exit, NULL);
764 mutex_unlock(&syscall_trace_lock);
767 #endif /* CONFIG_PERF_EVENTS */
769 static int syscall_enter_register(struct trace_event_call *event,
770 enum trace_reg type, void *data)
772 struct trace_event_file *file = data;
775 case TRACE_REG_REGISTER:
776 return reg_event_syscall_enter(file, event);
777 case TRACE_REG_UNREGISTER:
778 unreg_event_syscall_enter(file, event);
781 #ifdef CONFIG_PERF_EVENTS
782 case TRACE_REG_PERF_REGISTER:
783 return perf_sysenter_enable(event);
784 case TRACE_REG_PERF_UNREGISTER:
785 perf_sysenter_disable(event);
787 case TRACE_REG_PERF_OPEN:
788 case TRACE_REG_PERF_CLOSE:
789 case TRACE_REG_PERF_ADD:
790 case TRACE_REG_PERF_DEL:
797 static int syscall_exit_register(struct trace_event_call *event,
798 enum trace_reg type, void *data)
800 struct trace_event_file *file = data;
803 case TRACE_REG_REGISTER:
804 return reg_event_syscall_exit(file, event);
805 case TRACE_REG_UNREGISTER:
806 unreg_event_syscall_exit(file, event);
809 #ifdef CONFIG_PERF_EVENTS
810 case TRACE_REG_PERF_REGISTER:
811 return perf_sysexit_enable(event);
812 case TRACE_REG_PERF_UNREGISTER:
813 perf_sysexit_disable(event);
815 case TRACE_REG_PERF_OPEN:
816 case TRACE_REG_PERF_CLOSE:
817 case TRACE_REG_PERF_ADD:
818 case TRACE_REG_PERF_DEL: