ioctl: take all 32 bits of ioctl commands into account
Historically, only 16 bits (8-bit number and 8-bit type) of 32-bit ioctl
commands were used for decoding, which was the source for numerous
annoying collisions like this:
ioctl(0, SNDCTL_TMR_TIMEBASE or SNDRV_TIMER_IOCTL_NEXT_DEVICE or TCGETS, {B38400 opost isig icanon echo ...}) = 0
ioctl(0, MGSL_IOCGPARAMS or MMTIMER_GETRES or MTIOCTOP or SNDCTL_MIDI_MPUMODE, 0x7fffd47f7338) = -1 ENOTTY (Inappropriate ioctl for device)
The solution is to use all 32 bits for decoding, not just "number" and
"type", but also "size" and "direction".
As some architectures override defaults that come from asm-generic/ and
provide alternative definitions for some ioctl commands, we support
per-architecture ioctl definitions and merge them with common
definitions at build time. During the merge, we used to keep both
generic and architecture-specific definitions, now architecture-specific
definitions have precedence over generic ones -- ioctlsort omits
definitions from asm-generic/ for those ioctl names that have different
definitions in asm/.
Additional bits of "direction" are architecture specific -- the number
of bits and their values differ between architectures. To reduce
architecture differences in the source code, we keep "direction" in
symbolic form and compile it in ioctlsort.
Additional bits of "size" are also architecture specific -- not only the
number of bits differ between architectures, but sizes of many types
depend on sizeof(long). To reduce architecture differences in the
source code, we keep 32-bit and 64-bit versions of common ioctl
definitions, and use the appropriate version for each architecture and
personality.
To implement this, the tools for generating ioctl definitions from
kernel headers have been rewritten, and the source format of ioctl
definitions has been extended. The final ioctlent*.h files that are
included by syscall.c are now generated from source ioctls_inc*.h and
ioctls_arch*.h files at build time with ioctlsort.
* ioctl.c (ioctl_lookup): Use all 32 bits of ioctl command code.
* ioctlsort.c: Rewritten.
* linux/32/ioctls_inc.h: New file.
* linux/64/ioctls_inc.h: New file.
* linux/aarch64/ioctls_arch0.h: New file.
* linux/aarch64/ioctls_arch1.h: New file.
* linux/aarch64/ioctls_inc0.h: New file.
* linux/aarch64/ioctls_inc1.h: New file.
* linux/alpha/ioctls_arch0.h: New file.
* linux/alpha/ioctls_inc0.h: New file.
* linux/arc/ioctls_arch0.h: New file.
* linux/arc/ioctls_inc0.h: New file.
* linux/arm/ioctls_arch0.h: New file.
* linux/arm/ioctls_inc0.h: New file.
* linux/avr32/ioctls_arch0.h: New file.
* linux/avr32/ioctls_inc0.h: New file.
* linux/bfin/ioctls_arch0.h: New file.
* linux/bfin/ioctls_inc0.h: New file.
* linux/hppa/ioctls_arch0.h: New file.
* linux/hppa/ioctls_inc0.h: New file.
* linux/i386/ioctls_arch0.h: New file.
* linux/i386/ioctls_inc0.h: New file.
* linux/ia64/ioctls_arch0.h: New file.
* linux/ia64/ioctls_inc0.h: New file.
* linux/m68k/ioctls_arch0.h: New file.
* linux/m68k/ioctls_inc0.h: New file.
* linux/metag/ioctls_arch0.h: New file.
* linux/metag/ioctls_inc0.h: New file.
* linux/microblaze/ioctls_arch0.h: New file.
* linux/microblaze/ioctls_inc0.h: New file.
* linux/mips/ioctls_arch0.h: New file.
* linux/mips/ioctls_inc0.h: New file.
* linux/or1k/ioctls_arch0.h: New file.
* linux/or1k/ioctls_inc0.h: New file.
* linux/powerpc/ioctls_arch0.h: New file.
* linux/powerpc/ioctls_inc0.h: New file.
* linux/powerpc64/ioctls_arch0.h: New file.
* linux/powerpc64/ioctls_arch1.h: New file.
* linux/powerpc64/ioctls_inc0.h: New file.
* linux/powerpc64/ioctls_inc1.h: New file.
* linux/s390/ioctls_arch0.h: New file.
* linux/s390/ioctls_inc0.h: New file.
* linux/s390x/ioctls_arch0.h: New file.
* linux/s390x/ioctls_inc0.h: New file.
* linux/sh/ioctls_arch0.h: New file.
* linux/sh/ioctls_inc0.h: New file.
* linux/sh64/ioctls_arch0.h: New file.
* linux/sh64/ioctls_inc0.h: New file.
* linux/sparc/ioctls_arch0.h: New file.
* linux/sparc/ioctls_inc0.h: New file.
* linux/sparc64/ioctls_arch0.h: New file.
* linux/sparc64/ioctls_arch2.h: New file.
* linux/sparc64/ioctls_inc0.h: New file.
* linux/sparc64/ioctls_inc2.h: New file.
* linux/tile/ioctls_arch0.h: New file.
* linux/tile/ioctls_arch1.h: New file.
* linux/tile/ioctls_inc0.h: New file.
* linux/tile/ioctls_inc1.h: New file.
* linux/x32/ioctls_arch0.h: New file.
* linux/x32/ioctls_arch1.h: New file.
* linux/x32/ioctls_inc0.h: New file.
* linux/x32/ioctls_inc1.h: New file.
* linux/x86_64/ioctls_arch0.h: New file.
* linux/x86_64/ioctls_arch1.h: New file.
* linux/x86_64/ioctls_inc0.h: New file.
* linux/x86_64/ioctls_inc1.h: New file.
* linux/xtensa/ioctls_arch0.h: New file.
* linux/xtensa/ioctls_inc0.h: New file.
* linux/aarch64/ioctlent.h.in: Remove.
* linux/aarch64/ioctlent1.h: Remove.
* linux/alpha/ioctlent.h.in: Remove.
* linux/arc/ioctlent.h.in: Remove.
* linux/arm/ioctlent.h.in: Remove.
* linux/avr32/ioctlent.h.in: Remove.
* linux/bfin/ioctlent.h.in: Remove.
* linux/hppa/ioctlent.h.in: Remove.
* linux/i386/ioctlent.h.in: Remove.
* linux/ia64/ioctlent.h.in: Remove.
* linux/ioctlent.h.in: Remove.
* linux/ioctlent.sh: Remove.
* linux/m68k/ioctlent.h.in: Remove.
* linux/metag/ioctlent.h.in: Remove.
* linux/microblaze/ioctlent.h.in: Remove.
* linux/mips/ioctlent.h.in: Remove.
* linux/mips/ioctlent.sh: Remove.
* linux/or1k/ioctlent.h.in: Remove.
* linux/powerpc/ioctlent.h.in: Remove.
* linux/powerpc64/ioctlent.h: Remove.
* linux/powerpc64/ioctlent1.h: Remove.
* linux/s390/ioctlent.h.in: Remove.
* linux/s390x/ioctlent.h.in: Remove.
* linux/sh/ioctlent.h.in: Remove.
* linux/sh64/ioctlent.h.in: Remove.
* linux/sparc/ioctlent.h.in: Remove.
* linux/sparc64/ioctlent.h.in: Remove.
* linux/sparc64/ioctlent2.h: Remove.
* linux/tile/ioctlent.h.in: Remove.
* linux/tile/ioctlent1.h: Remove.
* linux/x32/ioctlent.h.in: Remove.
* linux/x32/ioctlent1.h: Remove.
* linux/x86_64/ioctlent.h.in: Remove.
* linux/x86_64/ioctlent1.h: Remove.
* linux/xtensa/ioctlent.h.in: Remove.
* linux/x86_64/ioctlent2.h: Include ioctlent0.h instead of ioctlent.h.
* syscall.c (struct_ioctlent ioctlent0): Likewise.
* Makefile.am: Remove all ioctlent-related definitions.
Define the list of ioctlent*.h files that have to be generated by
presence of $(srcdir)/$(OS)/$(ARCH)/ioctls_inc*.h files.
Add rules for ioctlent*.h files generation.
(EXTRA_DIST): Update.
* maint/ioctls_gen.sh: New file.
* maint/ioctls_hex.sh: New file.
* maint/ioctls_sym.sh: New file.
* maint/print_ioctlent.c: New file.
* HACKING-scripts: Update for ioctlent.sh -> ioctls_gen.sh migration.
* .gitignore: Add ioctlent[012].h and ioctls_all[012].h.
* configure.ac (AC_CHECK_HEADERS): Add linux/hiddev.h
and linux/mmtimer.h for tests.
* tests/ioctl.c: New file.
* tests/ioctl.test: New test.
* tests/Makefile.am (check_PROGRAMS): Add ioctl.
(TESTS): Add ioctl.test.
* tests/.gitignore: Add ioctl.
diff --git a/ioctlsort.c b/ioctlsort.c
index f0f5744..c81c949 100644
--- a/ioctlsort.c
+++ b/ioctlsort.c
@@ -1,58 +1,176 @@
+/*
+ * Copyright (c) 2001 Wichert Akkerman <wichert@cistron.nl>
+ * Copyright (c) 2004-2015 Dmitry V. Levin <ldv@altlinux.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ * derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#ifdef MIPS
+# include <sgidefs.h>
+# if _MIPS_SIM == _MIPS_SIM_ABI64
+# define LINUX_MIPSN64
+# elif _MIPS_SIM == _MIPS_SIM_NABI32
+# define LINUX_MIPSN32
+# elif _MIPS_SIM == _MIPS_SIM_ABI32
+# define LINUX_MIPSO32
+# else
+# error Unsupported _MIPS_SIM
+# endif
+#endif
+
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
-#include <sys/types.h>
-#include <stdint.h>
-
#include <asm/ioctl.h>
-#include <linux/types.h>
-
-#include "ioctldefs.h"
-#include <linux/atmioc.h>
struct ioctlent {
- const char* header;
- const char* name;
- unsigned int code;
+ const char *info;
+ const char *name;
+ unsigned int dir;
+ unsigned int type_nr;
+ unsigned int size;
};
-struct ioctlent ioctls[] = {
-#include "ioctls.h"
-};
-
-int nioctls = sizeof(ioctls) / sizeof(ioctls[0]);
-
-int compare(const void* a, const void* b) {
- unsigned int code1 = ((struct ioctlent *) a)->code;
- unsigned int code2 = ((struct ioctlent *) b)->code;
- const char *name1 = ((struct ioctlent *) a)->name;
- const char *name2 = ((struct ioctlent *) b)->name;
- return (code1 > code2) ? 1 : (code1 < code2) ? -1 : strcmp(name1, name2);
-}
-
-static int is_not_prefix(const char *s1, const char *s2) {
+static int
+is_prefix(const char *s1, const char *s2)
+{
size_t len = strlen(s1);
if (len > strlen(s2))
- return 1;
- return memcmp(s1, s2, len);
+ return 0;
+ return !memcmp(s1, s2, len);
}
-int main(int argc, char** argv) {
- int i;
+static int
+compare_name_info(const void* a, const void* b)
+{
+ int rc;
- /* ioctl_lookup() only looks at the NR and TYPE bits atm. */
- for (i = 0; i < nioctls; i++)
- ioctls[i].code &= (_IOC_NRMASK << _IOC_NRSHIFT) |
- (_IOC_TYPEMASK << _IOC_TYPESHIFT);
+ const char *name1 = ((struct ioctlent *) a)->name;
+ const char *name2 = ((struct ioctlent *) b)->name;
+ const char *info1 = ((struct ioctlent *) a)->info;
+ const char *info2 = ((struct ioctlent *) b)->info;
- qsort(ioctls, nioctls, sizeof(ioctls[0]), compare);
- puts("\t/* Generated by ioctlsort */");
- for (i = 0; i < nioctls; i++)
- if (i == 0 || ioctls[i-1].code != ioctls[i].code ||
- is_not_prefix(ioctls[i-1].name, ioctls[i].name))
- printf("\t{\"%s\",\t\"%s\",\t%#06x},\n",
- ioctls[i].header, ioctls[i].name, ioctls[i].code);
+ rc = strcmp(name1, name2);
+ if (rc)
+ return rc;
+ /*
+ * exception from lexicographical order:
+ * "asm/" < "asm-generic/"
+ */
+ if (is_prefix("asm/", info1) &&
+ is_prefix("asm-generic/", info2))
+ return -1;
+
+ if (is_prefix("asm/", info2) &&
+ is_prefix("asm-generic/", info1))
+ return 1;
+
+ return strcmp(info1, info2);
+}
+
+static unsigned int
+code(const struct ioctlent *e)
+{
+ return e->type_nr |
+ (e->size << _IOC_SIZESHIFT) |
+ (e->dir << _IOC_DIRSHIFT);
+}
+
+static int
+compare_code_name(const void* a, const void* b)
+{
+ unsigned int code1 = code((struct ioctlent *) a);
+ unsigned int code2 = code((struct ioctlent *) b);
+ const char *name1 = ((struct ioctlent *) a)->name;
+ const char *name2 = ((struct ioctlent *) b)->name;
+ return (code1 > code2) ?
+ 1 : (code1 < code2) ? -1 : strcmp(name1, name2);
+}
+
+static void
+ioctlsort(struct ioctlent *ioctls, size_t nioctls)
+{
+ size_t i;
+
+ qsort(ioctls, nioctls, sizeof(ioctls[0]), compare_name_info);
+
+ for (i = 1; i < nioctls; ++i)
+ if (!strcmp(ioctls[i-1].name, ioctls[i].name)) {
+ /*
+ * If there are multiple definitions for the same
+ * name, keep the first one and mark all the rest
+ * for deletion.
+ */
+ ioctls[i].info = NULL;
+ }
+
+ for (i = 1; i < nioctls; ++i)
+ if (!ioctls[i].info) {
+ /*
+ * Change ioctl code of marked elements
+ * to make them sorted to the end of array.
+ */
+ ioctls[i].dir =
+ ioctls[i].type_nr =
+ ioctls[i].size = 0xffffffffu;
+ }
+
+ qsort(ioctls, nioctls, sizeof(ioctls[0]), compare_code_name);
+
+ puts("/* Generated by ioctlsort. */");
+ for (i = 0; i < nioctls; ++i) {
+ if (!ioctls[i].info) {
+ /*
+ * We've reached the first element marked for deletion.
+ */
+ break;
+ }
+ if (i == 0 || code(&ioctls[i-1]) != code(&ioctls[i]) ||
+ !is_prefix(ioctls[i-1].name, ioctls[i].name))
+ printf("{ \"%s\", %#010x },\n",
+ ioctls[i].name, code(ioctls+i));
+ }
+}
+
+static struct ioctlent ioctls[] = {
+#ifdef IOCTLSORT_INC
+# include IOCTLSORT_INC
+#else
+# include "ioctls_arch.h"
+# include "ioctls_inc.h"
+#endif
+};
+
+int
+main(void)
+{
+ ioctlsort(ioctls, sizeof(ioctls) / sizeof(ioctls[0]));
return 0;
}