]> granicus.if.org Git - strace/blobdiff - ioctl.c
CREDITS.in: use UTF-8 consistently
[strace] / ioctl.c
diff --git a/ioctl.c b/ioctl.c
index a2b42ba6a3860bbc37b56ec1b583028807558557..b61a5be5c464cd28a38e744dabce8235cb2c5a91 100644 (file)
--- a/ioctl.c
+++ b/ioctl.c
@@ -3,6 +3,7 @@
  * Copyright (c) 1993 Branko Lankester <branko@hacktic.nl>
  * Copyright (c) 1993, 1994, 1995, 1996 Rick Sladkey <jrs@world.std.com>
  * Copyright (c) 1996-2001 Wichert Akkerman <wichert@cistron.nl>
+ * Copyright (c) 1999-2017 The strace developers.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -29,7 +30,7 @@
  */
 
 #include "defs.h"
-#include <asm/ioctl.h>
+#include <linux/ioctl.h>
 #include "xlat/ioctl_dirs.h"
 
 #ifdef HAVE_LINUX_INPUT_H
 static int
 compare(const void *a, const void *b)
 {
-       const unsigned int code1 = (const unsigned long) a;
+       const unsigned int code1 = (const uintptr_t) a;
        const unsigned int code2 = ((struct_ioctlent *) b)->code;
        return (code1 > code2) ? 1 : (code1 < code2) ? -1 : 0;
 }
 
-const struct_ioctlent *
+static const struct_ioctlent *
 ioctl_lookup(const unsigned int code)
 {
        struct_ioctlent *iop;
 
-       iop = bsearch((const void *) (const unsigned long) code, ioctlent,
+       iop = bsearch((const void *) (const uintptr_t) code, ioctlent,
                        nioctlents, sizeof(ioctlent[0]), compare);
        while (iop > ioctlent) {
                iop--;
@@ -64,7 +65,7 @@ ioctl_lookup(const unsigned int code)
        return iop;
 }
 
-const struct_ioctlent *
+static const struct_ioctlent *
 ioctl_next_match(const struct_ioctlent *iop)
 {
        const unsigned int code = iop->code;
@@ -74,36 +75,36 @@ ioctl_next_match(const struct_ioctlent *iop)
        return NULL;
 }
 
-void
+static void
 ioctl_print_code(const unsigned int code)
 {
        tprints("_IOC(");
        printflags(ioctl_dirs, _IOC_DIR(code), "_IOC_???");
-       tprintf(", 0x%02x, 0x%02x, 0x%02x)",
+       tprintf(", %#x, %#x, %#x)",
                _IOC_TYPE(code), _IOC_NR(code), _IOC_SIZE(code));
 }
 
 static int
-evdev_decode_number(unsigned int arg)
+evdev_decode_number(const unsigned int code)
 {
-       unsigned int nr = _IOC_NR(arg);
+       const unsigned int nr = _IOC_NR(code);
 
-       if (_IOC_DIR(arg) == _IOC_WRITE) {
+       if (_IOC_DIR(code) == _IOC_WRITE) {
                if (nr >= 0xc0 && nr <= 0xc0 + 0x3f) {
                        tprints("EVIOCSABS(");
-                       printxval(evdev_abs, nr - 0xc0, "EV_???");
+                       printxval(evdev_abs, nr - 0xc0, "ABS_???");
                        tprints(")");
                        return 1;
                }
        }
 
-       if (_IOC_DIR(arg) != _IOC_READ)
+       if (_IOC_DIR(code) != _IOC_READ)
                return 0;
 
        if (nr >= 0x20 && nr <= 0x20 + 0x1f) {
                tprints("EVIOCGBIT(");
                printxval(evdev_ev, nr - 0x20, "EV_???");
-               tprintf(", %u)", _IOC_SIZE(arg));
+               tprintf(", %u)", _IOC_SIZE(code));
                return 1;
        } else if (nr >= 0x40 && nr <= 0x40 + 0x3f) {
                tprints("EVIOCGABS(");
@@ -114,31 +115,31 @@ evdev_decode_number(unsigned int arg)
 
        switch (_IOC_NR(nr)) {
                case 0x06:
-                       tprintf("EVIOCGNAME(%u)", _IOC_SIZE(arg));
+                       tprintf("EVIOCGNAME(%u)", _IOC_SIZE(code));
                        return 1;
                case 0x07:
-                       tprintf("EVIOCGPHYS(%u)", _IOC_SIZE(arg));
+                       tprintf("EVIOCGPHYS(%u)", _IOC_SIZE(code));
                        return 1;
                case 0x08:
-                       tprintf("EVIOCGUNIQ(%u)", _IOC_SIZE(arg));
+                       tprintf("EVIOCGUNIQ(%u)", _IOC_SIZE(code));
                        return 1;
                case 0x09:
-                       tprintf("EVIOCGPROP(%u)", _IOC_SIZE(arg));
+                       tprintf("EVIOCGPROP(%u)", _IOC_SIZE(code));
                        return 1;
                case 0x0a:
-                       tprintf("EVIOCGMTSLOTS(%u)", _IOC_SIZE(arg));
+                       tprintf("EVIOCGMTSLOTS(%u)", _IOC_SIZE(code));
                        return 1;
                case 0x18:
-                       tprintf("EVIOCGKEY(%u)", _IOC_SIZE(arg));
+                       tprintf("EVIOCGKEY(%u)", _IOC_SIZE(code));
                        return 1;
                case 0x19:
-                       tprintf("EVIOCGLED(%u)", _IOC_SIZE(arg));
+                       tprintf("EVIOCGLED(%u)", _IOC_SIZE(code));
                        return 1;
                case 0x1a:
-                       tprintf("EVIOCGSND(%u)", _IOC_SIZE(arg));
+                       tprintf("EVIOCGSND(%u)", _IOC_SIZE(code));
                        return 1;
                case 0x1b:
-                       tprintf("EVIOCGSW(%u)", _IOC_SIZE(arg));
+                       tprintf("EVIOCGSW(%u)", _IOC_SIZE(code));
                        return 1;
                default:
                        return 0;
@@ -146,32 +147,32 @@ evdev_decode_number(unsigned int arg)
 }
 
 static int
-hiddev_decode_number(unsigned int arg)
+hiddev_decode_number(const unsigned int code)
 {
-       if (_IOC_DIR(arg) == _IOC_READ) {
-               switch (_IOC_NR(arg)) {
+       if (_IOC_DIR(code) == _IOC_READ) {
+               switch (_IOC_NR(code)) {
                        case 0x04:
-                               tprintf("HIDIOCGRAWNAME(%u)", _IOC_SIZE(arg));
+                               tprintf("HIDIOCGRAWNAME(%u)", _IOC_SIZE(code));
                                return 1;
                        case 0x05:
-                               tprintf("HIDIOCGRAWPHYS(%u)", _IOC_SIZE(arg));
+                               tprintf("HIDIOCGRAWPHYS(%u)", _IOC_SIZE(code));
                                return 1;
                        case 0x06:
-                               tprintf("HIDIOCSFEATURE(%u)", _IOC_SIZE(arg));
+                               tprintf("HIDIOCSFEATURE(%u)", _IOC_SIZE(code));
                                return 1;
                        case 0x12:
-                               tprintf("HIDIOCGPHYS(%u)", _IOC_SIZE(arg));
+                               tprintf("HIDIOCGPHYS(%u)", _IOC_SIZE(code));
                                return 1;
                        default:
                                return 0;
                }
-       } else if (_IOC_DIR(arg) == (_IOC_READ | _IOC_WRITE)) {
-               switch (_IOC_NR(arg)) {
+       } else if (_IOC_DIR(code) == (_IOC_READ | _IOC_WRITE)) {
+               switch (_IOC_NR(code)) {
                        case 0x06:
-                               tprintf("HIDIOCSFEATURE(%u)", _IOC_SIZE(arg));
+                               tprintf("HIDIOCSFEATURE(%u)", _IOC_SIZE(code));
                                return 1;
                        case 0x07:
-                               tprintf("HIDIOCGFEATURE(%u)", _IOC_SIZE(arg));
+                               tprintf("HIDIOCGFEATURE(%u)", _IOC_SIZE(code));
                                return 1;
                        default:
                                return 0;
@@ -181,38 +182,40 @@ hiddev_decode_number(unsigned int arg)
        return 0;
 }
 
-int
-ioctl_decode_command_number(unsigned int arg)
+static int
+ioctl_decode_command_number(struct tcb *tcp)
 {
-       switch (_IOC_TYPE(arg)) {
+       const unsigned int code = tcp->u_arg[1];
+
+       switch (_IOC_TYPE(code)) {
                case 'E':
-                       return evdev_decode_number(arg);
+                       return evdev_decode_number(code);
                case 'H':
-                       return hiddev_decode_number(arg);
+                       return hiddev_decode_number(code);
                case 'M':
-                       if (_IOC_DIR(arg) == _IOC_WRITE) {
-                               tprintf("MIXER_WRITE(%u)", _IOC_NR(arg));
+                       if (_IOC_DIR(code) == _IOC_WRITE) {
+                               tprintf("MIXER_WRITE(%u)", _IOC_NR(code));
                                return 1;
-                       } else if (_IOC_DIR(arg) == _IOC_READ) {
-                               tprintf("MIXER_READ(%u)", _IOC_NR(arg));
+                       } else if (_IOC_DIR(code) == _IOC_READ) {
+                               tprintf("MIXER_READ(%u)", _IOC_NR(code));
                                return 1;
                        }
                        return 0;
                case 'U':
-                       if (_IOC_DIR(arg) == _IOC_READ && _IOC_NR(arg) == 0x2c) {
-                               tprintf("UI_GET_SYSNAME(%u)", _IOC_SIZE(arg));
+                       if (_IOC_DIR(code) == _IOC_READ && _IOC_NR(code) == 0x2c) {
+                               tprintf("UI_GET_SYSNAME(%u)", _IOC_SIZE(code));
                                return 1;
                        }
                        return 0;
                case 'j':
-                       if (_IOC_DIR(arg) == _IOC_READ && _IOC_NR(arg) == 0x13) {
-                               tprintf("JSIOCGNAME(%u)", _IOC_SIZE(arg));
+                       if (_IOC_DIR(code) == _IOC_READ && _IOC_NR(code) == 0x13) {
+                               tprintf("JSIOCGNAME(%u)", _IOC_SIZE(code));
                                return 1;
                        }
                        return 0;
                case 'k':
-                       if (_IOC_DIR(arg) == _IOC_WRITE && _IOC_NR(arg) == 0) {
-                               tprintf("SPI_IOC_MESSAGE(%u)", _IOC_SIZE(arg));
+                       if (_IOC_DIR(code) == _IOC_WRITE && _IOC_NR(code) == 0) {
+                               tprintf("SPI_IOC_MESSAGE(%u)", _IOC_SIZE(code));
                                return 1;
                        }
                        return 0;
@@ -221,13 +224,52 @@ ioctl_decode_command_number(unsigned int arg)
        }
 }
 
-int
-ioctl_decode(struct tcb *tcp, unsigned int code, long arg)
+/**
+ * Decode arg parameter of the ioctl call.
+ *
+ * @return There are two flags of the return value important for the purposes of
+ *         processing by SYS_FUNC(ioctl):
+ *          - RVAL_IOCTL_DECODED: indicates that ioctl decoder code
+ *                                has printed arg parameter;
+ *          - RVAL_DECODED: indicates that decoding is done.
+ *         As a result, the following behaviour is expected:
+ *          - on entering:
+ *            - 0: decoding should be continued on exiting;
+ *            - RVAL_IOCTL_DECODED: decoding on exiting is not needed
+ *                                  and decoder has printed arg value;
+ *            - RVAL_DECODED: decoding on exiting is not needed
+ *                            and generic handler should print arg value.
+ *          - on exiting:
+ *            - 0: generic handler should print arg value;
+ *            - RVAL_IOCTL_DECODED: decoder has printed arg value.
+ *
+ *         Note that it makes no sense to return just RVAL_DECODED on exiting,
+ *         but, of course, it is not prohibited (for example, it may be useful
+ *         in cases where the return path is common on entering and on exiting
+ *         the syscall).
+ *
+ *         SYS_FUNC(ioctl) converts RVAL_IOCTL_DECODED flag to RVAL_DECODED,
+ *         and passes all other bits of ioctl_decode return value unchanged.
+ */
+static int
+ioctl_decode(struct tcb *tcp)
 {
+       const unsigned int code = tcp->u_arg[1];
+       const kernel_ulong_t arg = tcp->u_arg[2];
+
        switch (_IOC_TYPE(code)) {
 #if defined(ALPHA) || defined(POWERPC)
-       case 'f': case 't': case 'T':
+       case 'f': {
+               int ret = file_ioctl(tcp, code, arg);
+               if (ret != RVAL_DECODED)
+                       return ret;
+       }
+       case 't':
+       case 'T':
+               return term_ioctl(tcp, code, arg);
 #else /* !ALPHA */
+       case 'f':
+               return file_ioctl(tcp, code, arg);
        case 0x54:
 #endif /* !ALPHA */
                return term_ioctl(tcp, code, arg);
@@ -236,13 +278,13 @@ ioctl_decode(struct tcb *tcp, unsigned int code, long arg)
        case 'p':
                return rtc_ioctl(tcp, code, arg);
        case 0x03:
+               return hdio_ioctl(tcp, code, arg);
        case 0x12:
-       case 'X':
                return block_ioctl(tcp, code, arg);
-#ifdef HAVE_SCSI_SG_H
+       case 'X':
+               return fs_x_ioctl(tcp, code, arg);
        case 0x22:
                return scsi_ioctl(tcp, code, arg);
-#endif
        case 'L':
                return loop_ioctl(tcp, code, arg);
        case 'M':
@@ -254,57 +296,62 @@ ioctl_decode(struct tcb *tcp, unsigned int code, long arg)
                return v4l2_ioctl(tcp, code, arg);
        case '=':
                return ptp_ioctl(tcp, code, arg);
+#ifdef HAVE_LINUX_INPUT_H
+       case 'E':
+               return evdev_ioctl(tcp, code, arg);
+#endif
+#ifdef HAVE_LINUX_USERFAULTFD_H
+       case 0xaa:
+               return uffdio_ioctl(tcp, code, arg);
+#endif
+#ifdef HAVE_LINUX_BTRFS_H
+       case 0x94:
+               return btrfs_ioctl(tcp, code, arg);
+#endif
+       case 0xb7:
+               return nsfs_ioctl(tcp, code, arg);
+#ifdef HAVE_LINUX_DM_IOCTL_H
+       case 0xfd:
+               return dm_ioctl(tcp, code, arg);
+#endif
        default:
                break;
        }
        return 0;
 }
 
-/*
- * Registry of ioctl characters, culled from
- *     @(#)ioccom.h 1.7 89/06/16 SMI; from UCB ioctl.h 7.1 6/4/86
- *
- * char        file where defined              notes
- * ----        ------------------              -----
- *   F sun/fbio.h
- *   G sun/gpio.h
- *   H vaxif/if_hy.h
- *   M sundev/mcpcmd.h                 *overlap*
- *   M sys/modem.h                     *overlap*
- *   S sys/stropts.h
- *   T sys/termio.h                    -no overlap-
- *   T sys/termios.h                   -no overlap-
- *   V sundev/mdreg.h
- *   a vaxuba/adreg.h
- *   d sun/dkio.h                      -no overlap with sys/des.h-
- *   d sys/des.h                       (possible overlap)
- *   d vax/dkio.h                      (possible overlap)
- *   d vaxuba/rxreg.h                  (possible overlap)
- *   f sys/filio.h
- *   g sunwindow/win_ioctl.h           -no overlap-
- *   g sunwindowdev/winioctl.c         !no manifest constant! -no overlap-
- *   h sundev/hrc_common.h
- *   i sys/sockio.h                    *overlap*
- *   i vaxuba/ikreg.h                  *overlap*
- *   k sundev/kbio.h
- *   m sundev/msio.h                   (possible overlap)
- *   m sundev/msreg.h                  (possible overlap)
- *   m sys/mtio.h                      (possible overlap)
- *   n sun/ndio.h
- *   p net/nit_buf.h                   (possible overlap)
- *   p net/nit_if.h                    (possible overlap)
- *   p net/nit_pf.h                    (possible overlap)
- *   p sundev/fpareg.h                 (possible overlap)
- *   p sys/sockio.h                    (possible overlap)
- *   p vaxuba/psreg.h                  (possible overlap)
- *   q sun/sqz.h
- *   r sys/sockio.h
- *   s sys/sockio.h
- *   t sys/ttold.h                     (possible overlap)
- *   t sys/ttycom.h                    (possible overlap)
- *   v sundev/vuid_event.h             *overlap*
- *   v sys/vcmd.h                      *overlap*
- *   V linux/videodev2.h
- *
- * End of Registry
- */
+SYS_FUNC(ioctl)
+{
+       const struct_ioctlent *iop;
+       int ret;
+
+       if (entering(tcp)) {
+               printfd(tcp, tcp->u_arg[0]);
+               tprints(", ");
+               ret = ioctl_decode_command_number(tcp);
+               if (!(ret & IOCTL_NUMBER_STOP_LOOKUP)) {
+                       iop = ioctl_lookup(tcp->u_arg[1]);
+                       if (iop) {
+                               if (ret)
+                                       tprints(" or ");
+                               tprints(iop->symbol);
+                               while ((iop = ioctl_next_match(iop)))
+                                       tprintf(" or %s", iop->symbol);
+                       } else if (!ret) {
+                               ioctl_print_code(tcp->u_arg[1]);
+                       }
+               }
+               ret = ioctl_decode(tcp);
+       } else {
+               ret = ioctl_decode(tcp) | RVAL_DECODED;
+       }
+
+       if (ret & RVAL_IOCTL_DECODED) {
+               ret &= ~RVAL_IOCTL_DECODED;
+               ret |= RVAL_DECODED;
+       } else if (ret & RVAL_DECODED) {
+               tprintf(", %#" PRI_klx, tcp->u_arg[2]);
+       }
+
+       return ret;
+}