2 .\" Copyright (c) 2013 Stacey D. Son
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" Support for miscellaneous binary image activators
35 .Nd manage binary image activators
47 .Op Cm --offset Ar offset
67 is the management utility for configuring miscellaneous binaries image
68 activators in the kernel.
69 It allows adding, deleting, disabling,
70 enabling, and looking up interpreters.
71 Also, all the interpreters can
74 The first argument on the command line indicates the operation to be
76 Operation must be one of the following:
77 .Bl -tag -width indent
88 .Op Cm --offset Ar offset
91 Add a new activator entry in the kernel.
95 interpreter path and its arguments
99 bytes that uniquely identify a suitable binary for the activator,
106 Optionally you may specify a
108 to do a bitwise AND with the header bytes.
109 This effectively allows you to ignore fields in the binary header that
110 do not uniquely indentify the binary file's type.
114 may be specified for the magic bytes using the
121 To enable the activator entry the
124 The activator default state is disabled.
128 may also contain arguments for the interpreter including
130 which gets replaced by the old
132 value in the interpreter string.
133 .It Cm remove Ar name
134 Remove the activator entry identified with
136 .It Cm disable Ar name
137 Disable the activator entry identified with
139 .It Cm enable Ar name
140 Enable the activator entry identified with
142 .It Cm lookup Ar name
143 Look up and print out the activator entry identified with
146 Take a snapshot and print all the activator entries currently configured.
149 Add an image activator to run the LLVM interpreter (lli) on bitcode
151 .Bd -ragged -offset indent
152 # binmiscctl add llvmbc --interpreter ''/usr/bin/lli --fake-argv0=#a''
153 --magic ''BC\\xc0\\xde'' --size 4 --set-enabled
157 is replaced with the old
159 value so that 'lli' can fake its
161 Set its state to enabled.
165 image activator to disabled:
166 .Dl # binmiscctl disable llvmbc
170 image activator to enabled:
171 .Dl # binmiscctl enable llvmbc
176 .Dl # binmiscctl remove llvmbc
178 Look up and list the record for the
181 .Dl # binmiscctl lookup llvmbc
183 Add QEMU bsd-user program as an image activator for ARM AARCH64 binaries:
184 .Bd -literal -offset indent
185 # binmiscctl add arm64 \e
186 --interpreter "/usr/local/bin/qemu-aarch64-static" \e
187 --magic "\ex7f\ex45\ex4c\ex46\ex02\ex01\ex01\ex00\ex00\ex00\e
188 \ex00\ex00\ex00\ex00\ex00\ex00\ex02\ex00\exb7\ex00" \e
189 --mask "\exff\exff\exff\exff\exff\exff\exff\ex00\exff\exff\e
190 \exff\exff\exff\exff\exff\exff\exfe\exff\exff\exff" \e
191 --size 20 --set-enabled
194 Add QEMU bsd-user program as an image activator for ARM little-endian binaries:
195 .Bd -literal -offset indent
196 # binmiscctl add armelf \e
197 --interpreter "/usr/local/bin/qemu-arm-static" \e
198 --magic "\ex7f\ex45\ex4c\ex46\ex01\ex01\ex01\ex00\ex00\ex00\e
199 \ex00\ex00\ex00\ex00\ex00\ex00\ex02\ex00\ex28\ex00" \e
200 --mask "\exff\exff\exff\exff\exff\exff\exff\ex00\exff\exff\e
201 \exff\exff\exff\exff\exff\exff\exfe\exff\exff\exff" \e
202 --size 20 --set-enabled
205 Add QEMU bsd-user program as an image activator for ARM big-endian binaries:
206 .Bd -literal -offset indent
207 # binmiscctl add armebelf \e
208 --interpreter "/usr/local/bin/qemu-arm-static" \e
209 --magic "\ex7f\ex45\ex4c\ex46\ex01\ex02\ex01\ex00\ex00\ex00\e
210 \ex00\ex00\ex00\ex00\ex00\ex00\ex00\ex02\ex00\ex28" \e
211 --mask "\exff\exff\exff\exff\exff\exff\exff\ex00\exff\exff\e
212 \exff\exff\exff\exff\exff\exff\exff\exfe\exff\exff" \e
213 --size 20 --set-enabled
216 Add QEMU bsd-user program as an image activator for MIPS32 binaries:
217 .Bd -literal -offset indent
218 # binmiscctl add mips32 \e
219 --interpreter "/usr/local/bin/qemu-mips-static" \e
220 --magic "\ex7f\ex45\ex4c\ex46\ex01\ex02\ex01\ex00\ex00\ex00\e
221 \ex00\ex00\ex00\ex00\ex00\ex00\ex00\ex02\ex00\ex08" \e
222 --mask "\exff\exff\exff\exff\exff\exff\exff\ex00\exff\exff\e
223 \exff\exff\exff\exff\exff\exff\exff\exfe\exff\exff" \e
224 --size 20 --set-enabled
227 Add QEMU bsd-user program as an image activator for MIPS64 binaries:
228 .Bd -literal -offset indent
229 # binmiscctl add mips64 \e
230 --interpreter "/usr/local/bin/qemu-mips64-static" \e
231 --magic "\ex7f\ex45\ex4c\ex46\ex02\ex02\ex01\ex00\ex00\ex00\e
232 \ex00\ex00\ex00\ex00\ex00\ex00\ex00\ex02\ex00\ex08" \e
233 --mask "\exff\exff\exff\exff\exff\exff\exff\ex00\exff\exff\e
234 \exff\exff\exff\exff\exff\exff\exff\exfe\exff\exff" \e
235 --size 20 --set-enabled
238 Add QEMU bsd-user program as an image activator for PowerPC binaries:
239 .Bd -literal -offset indent
240 # binmiscctl add powerpc \e
241 --interpreter "/usr/local/bin/qemu-ppc-static" \e
242 --magic "\ex7f\ex45\ex4c\ex46\ex01\ex02\ex01\ex00\ex00\ex00\e
243 \ex00\ex00\ex00\ex00\ex00\ex00\ex00\ex02\ex00\ex14" \e
244 --mask "\exff\exff\exff\exff\exff\exff\exff\ex00\exff\exff\e
245 \exff\exff\exff\exff\exff\exff\exff\exfe\exff\exff" \e
246 --size 20 --set-enabled
249 Add QEMU bsd-user program as an image activator for PowerPC64 binaries:
250 .Bd -literal -offset indent
251 # binmiscctl add powerpc64 \e
252 --interpreter "/usr/local/bin/qemu-ppc64-static" \e
253 --magic "\ex7f\ex45\ex4c\ex46\ex02\ex02\ex01\ex00\ex00\ex00\e
254 \ex00\ex00\ex00\ex00\ex00\ex00\ex00\ex02\ex00\ex15" \e
255 --mask "\exff\exff\exff\exff\exff\exff\exff\ex00\exff\exff\e
256 \exff\exff\exff\exff\exff\exff\exff\exfe\exff\exff" \e
257 --size 20 --set-enabled
260 Add QEMU bsd-user program as an image activator for SPARC64 binaries:
261 .Bd -literal -offset indent
262 # binmiscctl add sparc64 \e
263 --interpreter "/usr/local/bin/qemu-sparc64-static" \e
264 --magic "\ex7f\ex45\ex4c\ex46\ex02\ex02\ex01\ex00\ex00\ex00\e
265 \ex00\ex00\ex00\ex00\ex00\ex00\ex00\ex02\ex00\ex2b" \e
266 --mask "\exff\exff\exff\exff\exff\exff\exff\ex00\exff\exff\e
267 \exff\exff\exff\exff\exff\exff\exff\exfe\exff\exff" \e
268 --size 20 --set-enabled
271 .Ss "Create and use an ARMv6 chroot on an AMD64 host"
272 Use an existing source tree to build a chroot host with architecture
278 make world TARGET=arm TARGET_ARCH=armv6 DESTDIR=$D
279 make distribution TARGET=arm TARGET_ARCH=armv6 DESTDIR=$D
283 .Pa emulators/qemu-user-static
286 Ports Collection, the emulator must be copied into the jail path
287 specified in the binmiscctl command.
288 Using the example above:
290 mkdir $D/usr/local/bin
291 cp /usr/local/bin/qemu-arm-static $D/usr/local/bin
294 Now the user can chroot into the environment normally, as root:
307 It was developed to support the imgact_binmisc kernel module.