1 // SPDX-License-Identifier: LGPL-2.1 2 /* 3 * trace/beauty/ioctl.c 4 * 5 * Copyright (C) 2017, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com> 6 */ 7 8 #include "trace/beauty/beauty.h" 9 #include <linux/kernel.h> 10 11 /* 12 * FIXME: to support all arches we have to improve this, for 13 * now, to build on older systems without things like TIOCGEXCL, 14 * get it directly from our copy. 15 * 16 * Right now only x86 is being supported for beautifying ioctl args 17 * in 'perf trace', see tools/perf/trace/beauty/Build and builtin-trace.c 18 */ 19 #include <uapi/asm-generic/ioctls.h> 20 21 static size_t ioctl__scnprintf_tty_cmd(int nr, int dir, char *bf, size_t size) 22 { 23 static const char *ioctl_tty_cmd[] = { 24 "TCGETS", "TCSETS", "TCSETSW", "TCSETSF", "TCGETA", "TCSETA", "TCSETAW", 25 "TCSETAF", "TCSBRK", "TCXONC", "TCFLSH", "TIOCEXCL", "TIOCNXCL", "TIOCSCTTY", 26 "TIOCGPGRP", "TIOCSPGRP", "TIOCOUTQ", "TIOCSTI", "TIOCGWINSZ", "TIOCSWINSZ", 27 "TIOCMGET", "TIOCMBIS", "TIOCMBIC", "TIOCMSET", "TIOCGSOFTCAR", "TIOCSSOFTCAR", 28 "FIONREAD", "TIOCLINUX", "TIOCCONS", "TIOCGSERIAL", "TIOCSSERIAL", "TIOCPKT", 29 "FIONBIO", "TIOCNOTTY", "TIOCSETD", "TIOCGETD", "TCSBRKP", 30 [_IOC_NR(TIOCSBRK)] = "TIOCSBRK", "TIOCCBRK", "TIOCGSID", "TCGETS2", "TCSETS2", 31 "TCSETSW2", "TCSETSF2", "TIOCGRS48", "TIOCSRS485", "TIOCGPTN", "TIOCSPTLCK", 32 "TIOCGDEV", "TCSETX", "TCSETXF", "TCSETXW", "TIOCSIG", "TIOCVHANGUP", "TIOCGPKT", 33 "TIOCGPTLCK", [_IOC_NR(TIOCGEXCL)] = "TIOCGEXCL", "TIOCGPTPEER", 34 [_IOC_NR(FIONCLEX)] = "FIONCLEX", "FIOCLEX", "FIOASYNC", "TIOCSERCONFIG", 35 "TIOCSERGWILD", "TIOCSERSWILD", "TIOCGLCKTRMIOS", "TIOCSLCKTRMIOS", 36 "TIOCSERGSTRUCT", "TIOCSERGETLSR", "TIOCSERGETMULTI", "TIOCSERSETMULTI", 37 "TIOCMIWAIT", "TIOCGICOUNT", }; 38 static DEFINE_STRARRAY(ioctl_tty_cmd); 39 40 if (nr < strarray__ioctl_tty_cmd.nr_entries && strarray__ioctl_tty_cmd.entries[nr] != NULL) 41 return scnprintf(bf, size, "%s", strarray__ioctl_tty_cmd.entries[nr]); 42 43 return scnprintf(bf, size, "(%#x, %#x, %#x)", 'T', nr, dir); 44 } 45 46 static size_t ioctl__scnprintf_drm_cmd(int nr, int dir, char *bf, size_t size) 47 { 48 #include "trace/beauty/generated/ioctl/drm_ioctl_array.c" 49 static DEFINE_STRARRAY(drm_ioctl_cmds); 50 51 if (nr < strarray__drm_ioctl_cmds.nr_entries && strarray__drm_ioctl_cmds.entries[nr] != NULL) 52 return scnprintf(bf, size, "DRM_%s", strarray__drm_ioctl_cmds.entries[nr]); 53 54 return scnprintf(bf, size, "(%#x, %#x, %#x)", 'd', nr, dir); 55 } 56 57 static size_t ioctl__scnprintf_sndrv_pcm_cmd(int nr, int dir, char *bf, size_t size) 58 { 59 #include "trace/beauty/generated/ioctl/sndrv_pcm_ioctl_array.c" 60 static DEFINE_STRARRAY(sndrv_pcm_ioctl_cmds); 61 62 if (nr < strarray__sndrv_pcm_ioctl_cmds.nr_entries && strarray__sndrv_pcm_ioctl_cmds.entries[nr] != NULL) 63 return scnprintf(bf, size, "SNDRV_PCM_%s", strarray__sndrv_pcm_ioctl_cmds.entries[nr]); 64 65 return scnprintf(bf, size, "(%#x, %#x, %#x)", 'A', nr, dir); 66 } 67 68 static size_t ioctl__scnprintf_sndrv_ctl_cmd(int nr, int dir, char *bf, size_t size) 69 { 70 #include "trace/beauty/generated/ioctl/sndrv_ctl_ioctl_array.c" 71 static DEFINE_STRARRAY(sndrv_ctl_ioctl_cmds); 72 73 if (nr < strarray__sndrv_ctl_ioctl_cmds.nr_entries && strarray__sndrv_ctl_ioctl_cmds.entries[nr] != NULL) 74 return scnprintf(bf, size, "SNDRV_CTL_%s", strarray__sndrv_ctl_ioctl_cmds.entries[nr]); 75 76 return scnprintf(bf, size, "(%#x, %#x, %#x)", 'U', nr, dir); 77 } 78 79 static size_t ioctl__scnprintf_kvm_cmd(int nr, int dir, char *bf, size_t size) 80 { 81 #include "trace/beauty/generated/ioctl/kvm_ioctl_array.c" 82 static DEFINE_STRARRAY(kvm_ioctl_cmds); 83 84 if (nr < strarray__kvm_ioctl_cmds.nr_entries && strarray__kvm_ioctl_cmds.entries[nr] != NULL) 85 return scnprintf(bf, size, "KVM_%s", strarray__kvm_ioctl_cmds.entries[nr]); 86 87 return scnprintf(bf, size, "(%#x, %#x, %#x)", 0xAE, nr, dir); 88 } 89 90 static size_t ioctl__scnprintf_vhost_virtio_cmd(int nr, int dir, char *bf, size_t size) 91 { 92 #include "trace/beauty/generated/ioctl/vhost_virtio_ioctl_array.c" 93 static DEFINE_STRARRAY(vhost_virtio_ioctl_cmds); 94 static DEFINE_STRARRAY(vhost_virtio_ioctl_read_cmds); 95 struct strarray *s = (dir & _IOC_READ) ? &strarray__vhost_virtio_ioctl_read_cmds : &strarray__vhost_virtio_ioctl_cmds; 96 97 if (nr < s->nr_entries && s->entries[nr] != NULL) 98 return scnprintf(bf, size, "VHOST_%s", s->entries[nr]); 99 100 return scnprintf(bf, size, "(%#x, %#x, %#x)", 0xAF, nr, dir); 101 } 102 103 static size_t ioctl__scnprintf_perf_cmd(int nr, int dir, char *bf, size_t size) 104 { 105 #include "trace/beauty/generated/ioctl/perf_ioctl_array.c" 106 static DEFINE_STRARRAY(perf_ioctl_cmds); 107 108 if (nr < strarray__perf_ioctl_cmds.nr_entries && strarray__perf_ioctl_cmds.entries[nr] != NULL) 109 return scnprintf(bf, size, "PERF_%s", strarray__perf_ioctl_cmds.entries[nr]); 110 111 return scnprintf(bf, size, "(%#x, %#x, %#x)", 0xAE, nr, dir); 112 } 113 114 static size_t ioctl__scnprintf_cmd(unsigned long cmd, char *bf, size_t size) 115 { 116 int dir = _IOC_DIR(cmd), 117 type = _IOC_TYPE(cmd), 118 nr = _IOC_NR(cmd), 119 sz = _IOC_SIZE(cmd); 120 int printed = 0; 121 static const struct ioctl_type { 122 int type; 123 size_t (*scnprintf)(int nr, int dir, char *bf, size_t size); 124 } ioctl_types[] = { /* Must be ordered by type */ 125 { .type = '$', .scnprintf = ioctl__scnprintf_perf_cmd, }, 126 ['A' - '$'] = { .type = 'A', .scnprintf = ioctl__scnprintf_sndrv_pcm_cmd, }, 127 ['T' - '$'] = { .type = 'T', .scnprintf = ioctl__scnprintf_tty_cmd, }, 128 ['U' - '$'] = { .type = 'U', .scnprintf = ioctl__scnprintf_sndrv_ctl_cmd, }, 129 ['d' - '$'] = { .type = 'd', .scnprintf = ioctl__scnprintf_drm_cmd, }, 130 [0xAE - '$'] = { .type = 0xAE, .scnprintf = ioctl__scnprintf_kvm_cmd, }, 131 [0xAF - '$'] = { .type = 0xAF, .scnprintf = ioctl__scnprintf_vhost_virtio_cmd, }, 132 }; 133 const int nr_types = ARRAY_SIZE(ioctl_types); 134 135 if (type >= ioctl_types[0].type && type <= ioctl_types[nr_types - 1].type) { 136 const int index = type - ioctl_types[0].type; 137 138 if (ioctl_types[index].scnprintf != NULL) 139 return ioctl_types[index].scnprintf(nr, dir, bf, size); 140 } 141 142 printed += scnprintf(bf + printed, size - printed, "%c", '('); 143 144 if (dir == _IOC_NONE) { 145 printed += scnprintf(bf + printed, size - printed, "%s", "NONE"); 146 } else { 147 if (dir & _IOC_READ) 148 printed += scnprintf(bf + printed, size - printed, "%s", "READ"); 149 if (dir & _IOC_WRITE) 150 printed += scnprintf(bf + printed, size - printed, "%s%s", dir & _IOC_READ ? "|" : "", "WRITE"); 151 } 152 153 return printed + scnprintf(bf + printed, size - printed, ", %#x, %#x, %#x)", type, nr, sz); 154 } 155 156 size_t syscall_arg__scnprintf_ioctl_cmd(char *bf, size_t size, struct syscall_arg *arg) 157 { 158 unsigned long cmd = arg->val; 159 160 return ioctl__scnprintf_cmd(cmd, bf, size); 161 } 162