| // SPDX-License-Identifier: LGPL-2.1 | 
| /* | 
|  * trace/beauty/ioctl.c | 
|  * | 
|  *  Copyright (C) 2017, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com> | 
|  */ | 
|   | 
| #include "trace/beauty/beauty.h" | 
| #include <linux/kernel.h> | 
|   | 
| /* | 
|  * FIXME: to support all arches we have to improve this, for | 
|  * now, to build on older systems without things like TIOCGEXCL, | 
|  * get it directly from our copy. | 
|  * | 
|  * Right now only x86 is being supported for beautifying ioctl args | 
|  * in 'perf trace', see tools/perf/trace/beauty/Build and builtin-trace.c | 
|  */ | 
| #include <uapi/asm-generic/ioctls.h> | 
|   | 
| static size_t ioctl__scnprintf_tty_cmd(int nr, int dir, char *bf, size_t size) | 
| { | 
|     static const char *ioctl_tty_cmd[] = { | 
|     [_IOC_NR(TCGETS)] = "TCGETS", "TCSETS", "TCSETSW", "TCSETSF", "TCGETA", "TCSETA", "TCSETAW", | 
|     "TCSETAF", "TCSBRK", "TCXONC", "TCFLSH", "TIOCEXCL", "TIOCNXCL", "TIOCSCTTY", | 
|     "TIOCGPGRP", "TIOCSPGRP", "TIOCOUTQ", "TIOCSTI", "TIOCGWINSZ", "TIOCSWINSZ", | 
|     "TIOCMGET", "TIOCMBIS", "TIOCMBIC", "TIOCMSET", "TIOCGSOFTCAR", "TIOCSSOFTCAR", | 
|     "FIONREAD", "TIOCLINUX", "TIOCCONS", "TIOCGSERIAL", "TIOCSSERIAL", "TIOCPKT", | 
|     "FIONBIO", "TIOCNOTTY", "TIOCSETD", "TIOCGETD", "TCSBRKP", | 
|     [_IOC_NR(TIOCSBRK)] = "TIOCSBRK", "TIOCCBRK", "TIOCGSID", "TCGETS2", "TCSETS2", | 
|     "TCSETSW2", "TCSETSF2", "TIOCGRS48", "TIOCSRS485", "TIOCGPTN", "TIOCSPTLCK", | 
|     "TIOCGDEV", "TCSETX", "TCSETXF", "TCSETXW", "TIOCSIG", "TIOCVHANGUP", "TIOCGPKT", | 
|     "TIOCGPTLCK", [_IOC_NR(TIOCGEXCL)] = "TIOCGEXCL", "TIOCGPTPEER", | 
|     "TIOCGISO7816", "TIOCSISO7816", | 
|     [_IOC_NR(FIONCLEX)] = "FIONCLEX", "FIOCLEX", "FIOASYNC", "TIOCSERCONFIG", | 
|     "TIOCSERGWILD", "TIOCSERSWILD", "TIOCGLCKTRMIOS", "TIOCSLCKTRMIOS", | 
|     "TIOCSERGSTRUCT", "TIOCSERGETLSR", "TIOCSERGETMULTI", "TIOCSERSETMULTI", | 
|     "TIOCMIWAIT", "TIOCGICOUNT", }; | 
|     static DEFINE_STRARRAY(ioctl_tty_cmd, ""); | 
|   | 
|     if (nr < strarray__ioctl_tty_cmd.nr_entries && strarray__ioctl_tty_cmd.entries[nr] != NULL) | 
|         return scnprintf(bf, size, "%s", strarray__ioctl_tty_cmd.entries[nr]); | 
|   | 
|     return scnprintf(bf, size, "(%#x, %#x, %#x)", 'T', nr, dir); | 
| } | 
|   | 
| static size_t ioctl__scnprintf_drm_cmd(int nr, int dir, char *bf, size_t size) | 
| { | 
| #include "trace/beauty/generated/ioctl/drm_ioctl_array.c" | 
|     static DEFINE_STRARRAY(drm_ioctl_cmds, ""); | 
|   | 
|     if (nr < strarray__drm_ioctl_cmds.nr_entries && strarray__drm_ioctl_cmds.entries[nr] != NULL) | 
|         return scnprintf(bf, size, "DRM_%s", strarray__drm_ioctl_cmds.entries[nr]); | 
|   | 
|     return scnprintf(bf, size, "(%#x, %#x, %#x)", 'd', nr, dir); | 
| } | 
|   | 
| static size_t ioctl__scnprintf_sndrv_pcm_cmd(int nr, int dir, char *bf, size_t size) | 
| { | 
| #include "trace/beauty/generated/ioctl/sndrv_pcm_ioctl_array.c" | 
|     static DEFINE_STRARRAY(sndrv_pcm_ioctl_cmds, ""); | 
|   | 
|     if (nr < strarray__sndrv_pcm_ioctl_cmds.nr_entries && strarray__sndrv_pcm_ioctl_cmds.entries[nr] != NULL) | 
|         return scnprintf(bf, size, "SNDRV_PCM_%s", strarray__sndrv_pcm_ioctl_cmds.entries[nr]); | 
|   | 
|     return scnprintf(bf, size, "(%#x, %#x, %#x)", 'A', nr, dir); | 
| } | 
|   | 
| static size_t ioctl__scnprintf_sndrv_ctl_cmd(int nr, int dir, char *bf, size_t size) | 
| { | 
| #include "trace/beauty/generated/ioctl/sndrv_ctl_ioctl_array.c" | 
|     static DEFINE_STRARRAY(sndrv_ctl_ioctl_cmds, ""); | 
|   | 
|     if (nr < strarray__sndrv_ctl_ioctl_cmds.nr_entries && strarray__sndrv_ctl_ioctl_cmds.entries[nr] != NULL) | 
|         return scnprintf(bf, size, "SNDRV_CTL_%s", strarray__sndrv_ctl_ioctl_cmds.entries[nr]); | 
|   | 
|     return scnprintf(bf, size, "(%#x, %#x, %#x)", 'U', nr, dir); | 
| } | 
|   | 
| static size_t ioctl__scnprintf_kvm_cmd(int nr, int dir, char *bf, size_t size) | 
| { | 
| #include "trace/beauty/generated/ioctl/kvm_ioctl_array.c" | 
|     static DEFINE_STRARRAY(kvm_ioctl_cmds, ""); | 
|   | 
|     if (nr < strarray__kvm_ioctl_cmds.nr_entries && strarray__kvm_ioctl_cmds.entries[nr] != NULL) | 
|         return scnprintf(bf, size, "KVM_%s", strarray__kvm_ioctl_cmds.entries[nr]); | 
|   | 
|     return scnprintf(bf, size, "(%#x, %#x, %#x)", 0xAE, nr, dir); | 
| } | 
|   | 
| static size_t ioctl__scnprintf_vhost_virtio_cmd(int nr, int dir, char *bf, size_t size) | 
| { | 
| #include "trace/beauty/generated/ioctl/vhost_virtio_ioctl_array.c" | 
|     static DEFINE_STRARRAY(vhost_virtio_ioctl_cmds, ""); | 
|     static DEFINE_STRARRAY(vhost_virtio_ioctl_read_cmds, ""); | 
|     struct strarray *s = (dir & _IOC_READ) ? &strarray__vhost_virtio_ioctl_read_cmds : &strarray__vhost_virtio_ioctl_cmds; | 
|   | 
|     if (nr < s->nr_entries && s->entries[nr] != NULL) | 
|         return scnprintf(bf, size, "VHOST_%s", s->entries[nr]); | 
|   | 
|     return scnprintf(bf, size, "(%#x, %#x, %#x)", 0xAF, nr, dir); | 
| } | 
|   | 
| static size_t ioctl__scnprintf_perf_cmd(int nr, int dir, char *bf, size_t size) | 
| { | 
| #include "trace/beauty/generated/ioctl/perf_ioctl_array.c" | 
|     static DEFINE_STRARRAY(perf_ioctl_cmds, ""); | 
|   | 
|     if (nr < strarray__perf_ioctl_cmds.nr_entries && strarray__perf_ioctl_cmds.entries[nr] != NULL) | 
|         return scnprintf(bf, size, "PERF_%s", strarray__perf_ioctl_cmds.entries[nr]); | 
|   | 
|     return scnprintf(bf, size, "(%#x, %#x, %#x)", 0xAE, nr, dir); | 
| } | 
|   | 
| static size_t ioctl__scnprintf_usbdevfs_cmd(int nr, int dir, char *bf, size_t size) | 
| { | 
| #include "trace/beauty/generated/ioctl/usbdevfs_ioctl_array.c" | 
|     static DEFINE_STRARRAY(usbdevfs_ioctl_cmds, ""); | 
|   | 
|     if (nr < strarray__usbdevfs_ioctl_cmds.nr_entries && strarray__usbdevfs_ioctl_cmds.entries[nr] != NULL) | 
|         return scnprintf(bf, size, "USBDEVFS_%s", strarray__usbdevfs_ioctl_cmds.entries[nr]); | 
|   | 
|     return scnprintf(bf, size, "(%c, %#x, %#x)", 'U', nr, dir); | 
| } | 
|   | 
| static size_t ioctl__scnprintf_cmd(unsigned long cmd, char *bf, size_t size, bool show_prefix) | 
| { | 
|     const char *prefix = "_IOC_"; | 
|     int dir     = _IOC_DIR(cmd), | 
|         type = _IOC_TYPE(cmd), | 
|         nr     = _IOC_NR(cmd), | 
|         sz     = _IOC_SIZE(cmd); | 
|     int printed = 0; | 
|     static const struct ioctl_type { | 
|         int    type; | 
|         size_t    (*scnprintf)(int nr, int dir, char *bf, size_t size); | 
|     } ioctl_types[] = { /* Must be ordered by type */ | 
|                   { .type    = '$', .scnprintf = ioctl__scnprintf_perf_cmd, }, | 
|         ['A' - '$'] = { .type    = 'A', .scnprintf = ioctl__scnprintf_sndrv_pcm_cmd, }, | 
|         ['T' - '$'] = { .type    = 'T', .scnprintf = ioctl__scnprintf_tty_cmd, }, | 
|         ['U' - '$'] = { .type    = 'U', .scnprintf = ioctl__scnprintf_sndrv_ctl_cmd, }, | 
|         ['d' - '$'] = { .type    = 'd', .scnprintf = ioctl__scnprintf_drm_cmd, }, | 
|         [0xAE - '$'] = { .type    = 0xAE, .scnprintf = ioctl__scnprintf_kvm_cmd, }, | 
|         [0xAF - '$'] = { .type    = 0xAF, .scnprintf = ioctl__scnprintf_vhost_virtio_cmd, }, | 
|     }; | 
|     const int nr_types = ARRAY_SIZE(ioctl_types); | 
|   | 
|     if (type >= ioctl_types[0].type && type <= ioctl_types[nr_types - 1].type) { | 
|         const int index = type - ioctl_types[0].type; | 
|   | 
|         if (ioctl_types[index].scnprintf != NULL) | 
|             return ioctl_types[index].scnprintf(nr, dir, bf, size); | 
|     } | 
|   | 
|     printed += scnprintf(bf + printed, size - printed, "%c", '('); | 
|   | 
|     if (dir == _IOC_NONE) { | 
|         printed += scnprintf(bf + printed, size - printed, "%s%s", show_prefix ? prefix : "", "NONE"); | 
|     } else { | 
|         if (dir & _IOC_READ) | 
|             printed += scnprintf(bf + printed, size - printed, "%s%s", show_prefix ? prefix : "", "READ"); | 
|         if (dir & _IOC_WRITE) { | 
|             printed += scnprintf(bf + printed, size - printed, "%s%s%s", dir & _IOC_READ ? "|" : "", | 
|                          show_prefix ? prefix : "",  "WRITE"); | 
|         } | 
|     } | 
|   | 
|     return printed + scnprintf(bf + printed, size - printed, ", %#x, %#x, %#x)", type, nr, sz); | 
| } | 
|   | 
| #ifndef USB_DEVICE_MAJOR | 
| #define USB_DEVICE_MAJOR 189 | 
| #endif // USB_DEVICE_MAJOR | 
|   | 
| size_t syscall_arg__scnprintf_ioctl_cmd(char *bf, size_t size, struct syscall_arg *arg) | 
| { | 
|     unsigned long cmd = arg->val; | 
|     int fd = syscall_arg__val(arg, 0); | 
|     struct file *file = thread__files_entry(arg->thread, fd); | 
|   | 
|     if (file != NULL) { | 
|         if (file->dev_maj == USB_DEVICE_MAJOR) | 
|             return ioctl__scnprintf_usbdevfs_cmd(_IOC_NR(cmd), _IOC_DIR(cmd), bf, size); | 
|     } | 
|   | 
|     return ioctl__scnprintf_cmd(cmd, bf, size, arg->show_string_prefix); | 
| } |