2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2013 Stacey D. Son
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #ifndef _IMGACT_BINMISC_H_
31 #define _IMGACT_BINMISC_H_
34 * Miscellaneous binary interpreter image activator.
37 #include <sys/param.h> /* for MAXPATHLEN */
40 * Imgact bin misc parameters.
42 #define IBE_VERSION 1 /* struct ximgact_binmisc_entry version. */
43 #define IBE_NAME_MAX 32 /* Max size for entry name. */
44 #define IBE_MAGIC_MAX 256 /* Max size for header magic and mask. */
45 #define IBE_ARG_LEN_MAX 256 /* Max space for optional interpreter command-
46 line arguments separated by white space */
47 #define IBE_INTERP_LEN_MAX (MAXPATHLEN + IBE_ARG_LEN_MAX)
48 #define IBE_MAX_ENTRIES 64 /* Max number of interpreter entries. */
50 /* We only map the first page for identification purposes. */
51 #define IBE_MATCH_MAX PAGE_SIZE
52 _Static_assert(IBE_MAGIC_MAX <= IBE_MATCH_MAX,
53 "Cannot identify binaries past the first page.");
56 * Imgact bin misc interpreter entry flags.
58 #define IBF_ENABLED 0x0001 /* Entry is active. */
59 #define IBF_USE_MASK 0x0002 /* Use mask on header magic field. */
60 #define IBF_PRE_OPEN 0x0004 /* Cache the vnode for interpreter */
62 #define IBF_VALID_UFLAGS 0x0007 /* Bits allowed from userland. */
65 * Used with sysctlbyname() to pass imgact bin misc entries in and out of the
68 typedef struct ximgact_binmisc_entry {
69 uint32_t xbe_version; /* Struct version(IBE_VERSION) */
70 uint32_t xbe_flags; /* Entry flags (IBF_*) */
71 uint32_t xbe_moffset; /* Magic offset in header */
72 uint32_t xbe_msize; /* Magic size */
73 uint32_t spare[3]; /* Spare fields for future use */
74 char xbe_name[IBE_NAME_MAX]; /* Unique interpreter name */
75 char xbe_interpreter[IBE_INTERP_LEN_MAX]; /* Interpreter path + args */
76 uint8_t xbe_magic[IBE_MAGIC_MAX]; /* Header Magic */
77 uint8_t xbe_mask[IBE_MAGIC_MAX]; /* Magic Mask */
78 } ximgact_binmisc_entry_t;
81 * sysctl() command names.
83 #define IBE_SYSCTL_NAME "kern.binmisc"
85 #define IBE_SYSCTL_NAME_ADD IBE_SYSCTL_NAME ".add"
86 #define IBE_SYSCTL_NAME_REMOVE IBE_SYSCTL_NAME ".remove"
87 #define IBE_SYSCTL_NAME_DISABLE IBE_SYSCTL_NAME ".disable"
88 #define IBE_SYSCTL_NAME_ENABLE IBE_SYSCTL_NAME ".enable"
89 #define IBE_SYSCTL_NAME_LOOKUP IBE_SYSCTL_NAME ".lookup"
90 #define IBE_SYSCTL_NAME_LIST IBE_SYSCTL_NAME ".list"
92 #define KMOD_NAME "imgact_binmisc"
95 * Examples of manipulating the interpreter table using sysctlbyname(3):
97 * #include <sys/imgact_binmisc.h>
99 * #define LLVM_MAGIC "BC\xc0\xde"
101 * #define MIPS64_ELF_MAGIC "\x7f\x45\x4c\x46\x02\x02\x01\x00\x00\x00" \
102 * "\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08"
103 * #define MIPS64_ELF_MASK "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff" \
104 * "\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff"
106 * ximgact_binmisc_entry_t xbe, *xbep, out_xbe;
107 * size_t size = 0, osize;
110 * // Add image activator for LLVM byte code
111 * bzero(&xbe, sizeof(xbe));
112 * xbe.xbe_version = IBE_VERSION;
113 * xbe.xbe_flags = IBF_ENABLED;
114 * strlcpy(xbe.xbe_name, "llvm_bc", IBE_NAME_MAX);
115 * strlcpy(xbe.xbe_interpreter, "/usr/bin/lli --fake-arg0=#a",
116 * IBE_INTERP_LEN_MAX);
117 * xbe.xbe_moffset = 0;
119 * memcpy(xbe.xbe_magic, LLVM_MAGIC, xbe.xbe_msize);
120 * error = sysctlbyname(IBE_SYSCTL_NAME_ADD, NULL, NULL, &xbe, sizeof(xbe));
122 * // Add image activator for mips64 ELF binaries to use qemu user mode
123 * bzero(&xbe, sizeof(xbe));
124 * xbe.xbe_version = IBE_VERSION;
125 * xbe.xbe_flags = IBF_ENABLED | IBF_USE_MASK;
126 * strlcpy(xbe.xbe_name, "mips64elf", IBE_NAME_MAX);
127 * strlcpy(xbe.xbe_interpreter, "/usr/local/bin/qemu-mips64",
128 * IBE_INTERP_LEN_MAX);
129 * xbe.xbe_moffset = 0;
130 * xbe.xbe_msize = 20;
131 * memcpy(xbe.xbe_magic, MIPS64_ELF_MAGIC, xbe.xbe_msize);
132 * memcpy(xbe.xbe_mask, MIPS64_ELF_MASK, xbe.xbe_msize);
133 * sysctlbyname(IBE_SYSCTL_NAME_ADD, NULL, NULL, &xbe, sizeof(xbe));
135 * // Disable (OR Enable OR Remove) image activator for LLVM byte code
136 * bzero(&xbe, sizeof(xbe));
137 * xbe.xbe_version = IBE_VERSION;
138 * strlcpy(xbe.xbe_name, "llvm_bc", IBE_NAME_MAX);
139 * error = sysctlbyname(IBE_SYSCTL_NAME_DISABLE, NULL, NULL, &xbe, sizeof(xbe));
140 * // OR sysctlbyname(IBE_SYSCTL_NAME_ENABLE, NULL, NULL, &xbe, sizeof(xbe));
141 * // OR sysctlbyname(IBE_SYSCTL_NAME_REMOVE, NULL, NULL, &xbe, sizeof(xbe));
143 * // Lookup image activator "llvm_bc"
144 * bzero(&xbe, sizeof(xbe));
145 * xbe.xbe_version = IBE_VERSION;
146 * strlcpy(xbe.xbe_name, "llvm_bc", IBE_NAME_MAX);
147 * size = sizeof(out_xbe);
148 * error = sysctlbyname(IBE_SYSCTL_NAME_LOOKUP, &out_xbe, &size, &xbe,
151 * // Get all the currently configured image activators and report
152 * error = sysctlbyname(IBE_SYSCTL_NAME_LIST, NULL, &size, NULL, 0);
153 * if (0 == error && size > 0) {
154 * xbep = malloc(size);
157 * error = sysctlbyname("kern.binmisc.list", xbep, &size, NULL, 0);
158 * if (-1 == error && ENOMEM == errno && size == osize) {
159 * // The buffer too small and needs to grow
160 * size += sizeof(xbe);
161 * xbep = realloc(xbep, size);
166 * for(i = 0; i < (size / sizeof(xbe)); i++, xbep++)
167 * printf("name: %s interpreter: %s flags: %s %s\n", xbep->xbe_name,
168 * xbep->xbe_interpreter, (xbep->xbe_flags & IBF_ENABLED) ?
169 * "ENABLED" : "", (xbep->xbe_flags & IBF_ENABLED) ? "USE_MASK" : "");
171 * The sysctlbyname() calls above may return the following errors in addition
172 * to the standard ones:
174 * [EINVAL] Invalid argument in the input ximgact_binmisc_entry_t structure.
175 * [EEXIST] Interpreter entry for given name already exist in kernel list.
176 * [ENOMEM] Allocating memory in the kernel failed or, in the case of
177 * kern.binmisc.list, the user buffer is too small.
178 * [ENOENT] Interpreter entry for given name is not found.
179 * [ENOSPC] Attempted to exceed maximum number of entries (IBE_MAX_ENTRIES).
182 #endif /* !_IMGACT_BINMISC_H_ */