Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

perf trace: Beautify 'fspick' arguments

Use existing beautifiers for the first 2 args (dfd, path) and wire up
the recently introduced fspick flags table generator.

Now it should be possible to just use:

perf trace -e fspick

As root and see all move_mount syscalls with its args beautified, either
using the vfs_getname perf probe method or using the
augmented_raw_syscalls.c eBPF helper to get the pathnames, the other
args should work in all cases, i.e. all that is needed can be obtained
directly from the raw_syscalls:sys_enter tracepoint args.

# cat sys_fspick.c
#define _GNU_SOURCE /* See feature_test_macros(7) */
#include <unistd.h>
#include <sys/syscall.h> /* For SYS_xxx definitions */
#include <fcntl.h>

#define __NR_fspick 433

#define FSPICK_CLOEXEC 0x00000001
#define FSPICK_SYMLINK_NOFOLLOW 0x00000002
#define FSPICK_NO_AUTOMOUNT 0x00000004
#define FSPICK_EMPTY_PATH 0x00000008

static inline int sys_fspick(int fd, const char *path, int flags)
{
syscall(__NR_fspick, fd, path, flags);
}

int main(int argc, char *argv[])
{
int flags = 0, fd = 0;

open("/foo", 0);
sys_fspick(fd++, "/foo1", flags);
flags |= FSPICK_CLOEXEC;
sys_fspick(fd++, "/foo2", flags);
flags |= FSPICK_SYMLINK_NOFOLLOW;
sys_fspick(fd++, "/foo3", flags);
flags |= FSPICK_NO_AUTOMOUNT;
sys_fspick(fd++, "/foo4", flags);
flags |= FSPICK_EMPTY_PATH;
return sys_fspick(fd++, "/foo5", flags);
}
# perf trace -e fspick ./sys_fspick
LLVM: dumping /home/acme/git/perf/tools/perf/examples/bpf/augmented_raw_syscalls.o
fspick(0, "/foo1", 0) = -1 ENOENT (No such file or directory)
fspick(1, "/foo2", FSPICK_CLOEXEC) = -1 ENOENT (No such file or directory)
fspick(2, "/foo3", FSPICK_CLOEXEC|FSPICK_SYMLINK_NOFOLLOW) = -1 ENOENT (No such file or directory)
fspick(3, "/foo4", FSPICK_CLOEXEC|FSPICK_SYMLINK_NOFOLLOW|FSPICK_NO_AUTOMOUNT) = -1 ENOENT (No such file or directory)
fspick(4, "/foo5", FSPICK_CLOEXEC|FSPICK_SYMLINK_NOFOLLOW|FSPICK_NO_AUTOMOUNT|FSPICK_EMPTY_PATH) = -1 ENOENT (No such file or directory)
#

Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Al Viro <viro@zeniv.linux.org.uk>
Cc: Brendan Gregg <brendan.d.gregg@gmail.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Luis Cláudio Gonçalves <lclaudio@redhat.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Link: https://lkml.kernel.org/n/tip-erau5xjtt8wvgnhvdbchstuk@git.kernel.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

+42
+8
tools/perf/Makefile.perf
··· 419 419 $(fadvise_advice_array): $(linux_uapi_dir)/in.h $(fadvise_advice_tbl) 420 420 $(Q)$(SHELL) '$(fadvise_advice_tbl)' $(linux_uapi_dir) > $@ 421 421 422 + fspick_arrays := $(beauty_outdir)/fspick_arrays.c 423 + fspick_tbls := $(srctree)/tools/perf/trace/beauty/fspick.sh 424 + 425 + $(fspick_arrays): $(linux_uapi_dir)/fs.h $(fspick_tbls) 426 + $(Q)$(SHELL) '$(fspick_tbls)' $(linux_uapi_dir) > $@ 427 + 422 428 pkey_alloc_access_rights_array := $(beauty_outdir)/pkey_alloc_access_rights_array.c 423 429 asm_generic_hdr_dir := $(srctree)/tools/include/uapi/asm-generic/ 424 430 pkey_alloc_access_rights_tbl := $(srctree)/tools/perf/trace/beauty/pkey_alloc_access_rights.sh ··· 640 634 641 635 prepare: $(OUTPUT)PERF-VERSION-FILE $(OUTPUT)common-cmds.h archheaders $(drm_ioctl_array) \ 642 636 $(fadvise_advice_array) \ 637 + $(fspick_arrays) \ 643 638 $(pkey_alloc_access_rights_array) \ 644 639 $(sndrv_pcm_ioctl_array) \ 645 640 $(sndrv_ctl_ioctl_array) \ ··· 936 929 $(OUTPUT)tests/llvm-src-{base,kbuild,prologue,relocation}.c \ 937 930 $(OUTPUT)pmu-events/pmu-events.c \ 938 931 $(OUTPUT)$(fadvise_advice_array) \ 932 + $(OUTPUT)$(fspick_arrays) \ 939 933 $(OUTPUT)$(madvise_behavior_array) \ 940 934 $(OUTPUT)$(mmap_flags_array) \ 941 935 $(OUTPUT)$(mount_flags_array) \
+4
tools/perf/builtin-trace.c
··· 713 713 [2] = { .scnprintf = SCA_FCNTL_ARG, /* arg */ }, }, }, 714 714 { .name = "flock", 715 715 .arg = { [1] = { .scnprintf = SCA_FLOCK, /* cmd */ }, }, }, 716 + { .name = "fspick", 717 + .arg = { [0] = { .scnprintf = SCA_FDAT, /* dfd */ }, 718 + [1] = { .scnprintf = SCA_FILENAME, /* path */ }, 719 + [2] = { .scnprintf = SCA_FSPICK_FLAGS, /* flags */ }, }, }, 716 720 { .name = "fstat", .alias = "newfstat", }, 717 721 { .name = "fstatat", .alias = "newfstatat", }, 718 722 { .name = "futex",
+2
tools/perf/examples/bpf/augmented_raw_syscalls.c
··· 118 118 #define SYS_EXECVEAT 322 119 119 #define SYS_STATX 332 120 120 #define SYS_MOVE_MOUNT 429 121 + #define SYS_FSPICK 433 121 122 122 123 pid_filter(pids_filtered); 123 124 ··· 254 253 case SYS_FINIT_MODULE: 255 254 case SYS_FREMOVEXATTR: 256 255 case SYS_FSETXATTR: 256 + case SYS_FSPICK: 257 257 case SYS_FUTIMESAT: 258 258 case SYS_INOTIFY_ADD_WATCH: 259 259 case SYS_LINKAT:
+1
tools/perf/trace/beauty/Build
··· 1 1 perf-y += clone.o 2 2 perf-y += fcntl.o 3 3 perf-y += flock.o 4 + perf-y += fspick.o 4 5 ifeq ($(SRCARCH),$(filter $(SRCARCH),x86)) 5 6 perf-y += ioctl.o 6 7 endif
+3
tools/perf/trace/beauty/beauty.h
··· 141 141 size_t syscall_arg__scnprintf_flock(char *bf, size_t size, struct syscall_arg *arg); 142 142 #define SCA_FLOCK syscall_arg__scnprintf_flock 143 143 144 + size_t syscall_arg__scnprintf_fspick_flags(char *bf, size_t size, struct syscall_arg *arg); 145 + #define SCA_FSPICK_FLAGS syscall_arg__scnprintf_fspick_flags 146 + 144 147 size_t syscall_arg__scnprintf_ioctl_cmd(char *bf, size_t size, struct syscall_arg *arg); 145 148 #define SCA_IOCTL_CMD syscall_arg__scnprintf_ioctl_cmd 146 149
+24
tools/perf/trace/beauty/fspick.c
··· 1 + // SPDX-License-Identifier: LGPL-2.1 2 + /* 3 + * trace/beauty/fspick.c 4 + * 5 + * Copyright (C) 2019, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com> 6 + */ 7 + 8 + #include "trace/beauty/beauty.h" 9 + #include <linux/log2.h> 10 + 11 + static size_t fspick__scnprintf_flags(unsigned long flags, char *bf, size_t size, bool show_prefix) 12 + { 13 + #include "trace/beauty/generated/fspick_arrays.c" 14 + static DEFINE_STRARRAY(fspick_flags, "FSPICK_"); 15 + 16 + return strarray__scnprintf_flags(&strarray__fspick_flags, bf, size, show_prefix, flags); 17 + } 18 + 19 + size_t syscall_arg__scnprintf_fspick_flags(char *bf, size_t size, struct syscall_arg *arg) 20 + { 21 + unsigned long flags = arg->val; 22 + 23 + return fspick__scnprintf_flags(flags, bf, size, arg->show_string_prefix); 24 + }