xref: /openbmc/qemu/scripts/qemu-binfmt-conf.sh (revision 490c03ab1106121182f380c639a7db852e1b5401) 
1#!/bin/sh
2# Enable automatic program execution by the kernel.
3
4qemu_target_list="i386 i486 alpha arm armeb sparc sparc32plus sparc64 \
5ppc ppc64 ppc64le m68k mips mipsel mipsn32 mipsn32el mips64 mips64el \
6sh4 sh4eb s390x aarch64 aarch64_be hppa riscv32 riscv64 xtensa xtensaeb \
7microblaze microblazeel or1k x86_64 hexagon loongarch64"
8
9i386_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x03\x00'
10i386_mask='\xff\xff\xff\xff\xff\xfe\xfe\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
11i386_family=i386
12
13i486_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x06\x00'
14i486_mask='\xff\xff\xff\xff\xff\xfe\xfe\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
15i486_family=i386
16
17x86_64_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x3e\x00'
18x86_64_mask='\xff\xff\xff\xff\xff\xfe\xfe\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
19x86_64_family=i386
20
21alpha_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x26\x90'
22alpha_mask='\xff\xff\xff\xff\xff\xfe\xfe\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
23alpha_family=alpha
24
25arm_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00'
26arm_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
27arm_family=arm
28
29armeb_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28'
30armeb_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
31armeb_family=armeb
32
33sparc_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x02'
34sparc_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
35sparc_family=sparc
36
37sparc32plus_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x12'
38sparc32plus_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
39sparc32plus_family=sparc
40
41sparc64_magic='\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x2b'
42sparc64_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
43sparc64_family=sparc
44
45ppc_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x14'
46ppc_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
47ppc_family=ppc
48
49ppc64_magic='\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x15'
50ppc64_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
51ppc64_family=ppc
52
53ppc64le_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x15\x00'
54ppc64le_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\x00'
55ppc64le_family=ppcle
56
57m68k_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x04'
58m68k_mask='\xff\xff\xff\xff\xff\xff\xfe\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
59m68k_family=m68k
60
61# FIXME: We could use the other endianness on a MIPS host.
62
63mips_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
64mips_mask='\xff\xff\xff\xff\xff\xff\xff\x00\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff\xff\xff\xff\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20'
65mips_family=mips
66
67mipsel_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
68mipsel_mask='\xff\xff\xff\xff\xff\xff\xff\x00\x00\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff\xff\xff\xff\xff\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00'
69mipsel_family=mips
70
71mipsn32_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20'
72mipsn32_mask='\xff\xff\xff\xff\xff\xff\xff\x00\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff\xff\xff\xff\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20'
73mipsn32_family=mips
74
75mipsn32el_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00'
76mipsn32el_mask='\xff\xff\xff\xff\xff\xff\xff\x00\x00\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff\xff\xff\xff\xff\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00'
77mipsn32el_family=mips
78
79mips64_magic='\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08'
80mips64_mask='\xff\xff\xff\xff\xff\xff\xff\x00\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
81mips64_family=mips
82
83mips64el_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00'
84mips64el_mask='\xff\xff\xff\xff\xff\xff\xff\x00\x00\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
85mips64el_family=mips
86
87sh4_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x2a\x00'
88sh4_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
89sh4_family=sh4
90
91sh4eb_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x2a'
92sh4eb_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
93sh4eb_family=sh4
94
95s390x_magic='\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x16'
96s390x_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
97s390x_family=s390x
98
99aarch64_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xb7\x00'
100aarch64_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
101aarch64_family=arm
102
103aarch64_be_magic='\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xb7'
104aarch64_be_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
105aarch64_be_family=armeb
106
107hppa_magic='\x7f\x45\x4c\x46\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x0f'
108hppa_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
109hppa_family=hppa
110
111riscv32_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xf3\x00'
112riscv32_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
113riscv32_family=riscv
114
115riscv64_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xf3\x00'
116riscv64_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
117riscv64_family=riscv
118
119xtensa_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x5e\x00'
120xtensa_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
121xtensa_family=xtensa
122
123xtensaeb_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x5e'
124xtensaeb_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
125xtensaeb_family=xtensaeb
126
127microblaze_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xba\xab'
128microblaze_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
129microblaze_family=microblaze
130
131microblazeel_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xab\xba'
132microblazeel_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
133microblazeel_family=microblazeel
134
135or1k_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x5c'
136or1k_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
137or1k_family=or1k
138
139hexagon_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xa4\x00'
140hexagon_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
141hexagon_family=hexagon
142
143loongarch64_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x02\x01'
144loongarch64_mask='\xff\xff\xff\xff\xff\xff\xff\xfc\x00\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
145loongarch64_family=loongarch
146
147qemu_get_family() {
148    cpu=${HOST_ARCH:-$(uname -m)}
149    case "$cpu" in
150    amd64|i386|i486|i586|i686|i86pc|BePC|x86_64)
151        echo "i386"
152        ;;
153    mips*)
154        echo "mips"
155        ;;
156    "Power Macintosh"|ppc64|powerpc|ppc)
157        echo "ppc"
158        ;;
159    ppc64el|ppc64le)
160        echo "ppcle"
161        ;;
162    arm|armel|armhf|arm64|armv[4-9]*l|aarch64)
163        echo "arm"
164        ;;
165    armeb|armv[4-9]*b|aarch64_be)
166        echo "armeb"
167        ;;
168    sparc*)
169        echo "sparc"
170        ;;
171    riscv*)
172        echo "riscv"
173        ;;
174    *)
175        echo "$cpu"
176        ;;
177    esac
178}
179
180usage() {
181    cat <<EOF
182Usage: qemu-binfmt-conf.sh [--qemu-path PATH][--debian][--systemd CPU]
183                           [--help][--credential yes|no][--exportdir PATH]
184                           [--persistent yes|no][--qemu-suffix SUFFIX]
185                           [--preserve-argv0 yes|no]
186
187       Configure binfmt_misc to use qemu interpreter
188
189       --help:          display this usage
190       --qemu-path:     set path to qemu interpreter ($QEMU_PATH)
191       --qemu-suffix:   add a suffix to the default interpreter name
192       --debian:        don't write into /proc,
193                        instead generate update-binfmts templates
194       --systemd:       don't write into /proc,
195                        instead generate file for systemd-binfmt.service
196                        for the given CPU. If CPU is "ALL", generate a
197                        file for all known cpus
198       --exportdir:     define where to write configuration files
199                        (default: $SYSTEMDDIR or $DEBIANDIR)
200       --credential:    if yes, credential and security tokens are
201                        calculated according to the binary to interpret
202       --persistent:    if yes, the interpreter is loaded when binfmt is
203                        configured and remains in memory. All future uses
204                        are cloned from the open file.
205       --preserve-argv0 preserve argv[0]
206
207    To import templates with update-binfmts, use :
208
209        sudo update-binfmts --importdir ${EXPORTDIR:-$DEBIANDIR} --import qemu-CPU
210
211    To remove interpreter, use :
212
213        sudo update-binfmts --package qemu-CPU --remove qemu-CPU $QEMU_PATH
214
215    With systemd, binfmt files are loaded by systemd-binfmt.service
216
217    The environment variable HOST_ARCH allows to override 'uname' to generate
218    configuration files for a different architecture than the current one.
219
220    where CPU is one of:
221
222        $qemu_target_list
223
224EOF
225}
226
227qemu_check_access() {
228    if [ ! -w "$1" ] ; then
229        echo "ERROR: cannot write to $1" 1>&2
230        exit 1
231    fi
232}
233
234qemu_check_bintfmt_misc() {
235    # load the binfmt_misc module
236    if [ ! -d /proc/sys/fs/binfmt_misc ]; then
237      if ! /sbin/modprobe binfmt_misc ; then
238          exit 1
239      fi
240    fi
241    if [ ! -f /proc/sys/fs/binfmt_misc/register ]; then
242      if ! mount binfmt_misc -t binfmt_misc /proc/sys/fs/binfmt_misc ; then
243          exit 1
244      fi
245    fi
246
247    qemu_check_access /proc/sys/fs/binfmt_misc/register
248}
249
250installed_dpkg() {
251    dpkg --status "$1" > /dev/null 2>&1
252}
253
254qemu_check_debian() {
255    if [ ! -e /etc/debian_version ] ; then
256        echo "WARNING: your system is not a Debian based distro" 1>&2
257    elif ! installed_dpkg binfmt-support ; then
258        echo "WARNING: package binfmt-support is needed" 1>&2
259    fi
260    qemu_check_access "$EXPORTDIR"
261}
262
263qemu_check_systemd() {
264    if ! systemctl -q is-enabled systemd-binfmt.service ; then
265        echo "WARNING: systemd-binfmt.service is missing or disabled" 1>&2
266    fi
267    qemu_check_access "$EXPORTDIR"
268}
269
270qemu_generate_register() {
271    flags=""
272    if [ "$CREDENTIAL" = "yes" ] ; then
273        flags="OC"
274    fi
275    if [ "$PERSISTENT" = "yes" ] ; then
276        flags="${flags}F"
277    fi
278    if [ "$PRESERVE_ARG0" = "yes" ] ; then
279        flags="${flags}P"
280    fi
281
282    echo ":qemu-$cpu:M::$magic:$mask:$qemu:$flags"
283}
284
285qemu_register_interpreter() {
286    echo "Setting $qemu as binfmt interpreter for $cpu"
287    qemu_generate_register > /proc/sys/fs/binfmt_misc/register
288}
289
290qemu_generate_systemd() {
291    echo "Setting $qemu as binfmt interpreter for $cpu for systemd-binfmt.service"
292    qemu_generate_register > "$EXPORTDIR/qemu-$cpu.conf"
293}
294
295qemu_generate_debian() {
296    cat > "$EXPORTDIR/qemu-$cpu" <<EOF
297package qemu-$cpu
298interpreter $qemu
299magic $magic
300mask $mask
301credentials $CREDENTIAL
302preserve $PRESERVE_ARG0
303fix_binary $PERSISTENT
304EOF
305}
306
307qemu_set_binfmts() {
308    # probe cpu type
309    host_family=$(qemu_get_family)
310
311    # register the interpreter for each cpu except for the native one
312
313    for cpu in ${qemu_target_list} ; do
314        magic=$(eval echo \$${cpu}_magic)
315        mask=$(eval echo \$${cpu}_mask)
316        family=$(eval echo \$${cpu}_family)
317
318        if [ "$magic" = "" ] || [ "$mask" = "" ] || [ "$family" = "" ] ; then
319            echo "INTERNAL ERROR: unknown cpu $cpu" 1>&2
320            continue
321        fi
322
323        qemu="$QEMU_PATH/qemu-$cpu"
324        if [ "$cpu" = "i486" ] ; then
325            qemu="$QEMU_PATH/qemu-i386"
326        fi
327
328        qemu="$qemu$QEMU_SUFFIX"
329        if [ "$host_family" != "$family" ] ; then
330            $BINFMT_SET
331        fi
332    done
333}
334
335CHECK=qemu_check_bintfmt_misc
336BINFMT_SET=qemu_register_interpreter
337
338SYSTEMDDIR="/etc/binfmt.d"
339DEBIANDIR="/usr/share/binfmts"
340
341QEMU_PATH=/usr/local/bin
342CREDENTIAL=no
343PERSISTENT=no
344PRESERVE_ARG0=no
345QEMU_SUFFIX=""
346
347_longopts="debian,systemd:,qemu-path:,qemu-suffix:,exportdir:,help,credential:,\
348persistent:,preserve-argv0:"
349options=$(getopt -o ds:Q:S:e:hc:p:g:F: -l ${_longopts} -- "$@")
350eval set -- "$options"
351
352while true ; do
353    case "$1" in
354    -d|--debian)
355        CHECK=qemu_check_debian
356        BINFMT_SET=qemu_generate_debian
357        EXPORTDIR=${EXPORTDIR:-$DEBIANDIR}
358        ;;
359    -s|--systemd)
360        CHECK=qemu_check_systemd
361        BINFMT_SET=qemu_generate_systemd
362        EXPORTDIR=${EXPORTDIR:-$SYSTEMDDIR}
363        shift
364        # check given cpu is in the supported CPU list
365        if [ "$1" != "ALL" ] ; then
366            for cpu in ${qemu_target_list} ; do
367                if [ "$cpu" = "$1" ] ; then
368                    break
369                fi
370            done
371
372            if [ "$cpu" = "$1" ] ; then
373                qemu_target_list="$1"
374            else
375                echo "ERROR: unknown CPU \"$1\"" 1>&2
376                usage
377                exit 1
378            fi
379        fi
380        ;;
381    -Q|--qemu-path)
382        shift
383        QEMU_PATH="$1"
384        ;;
385    -F|--qemu-suffix)
386        shift
387        QEMU_SUFFIX="$1"
388        ;;
389    -e|--exportdir)
390        shift
391        EXPORTDIR="$1"
392        ;;
393    -h|--help)
394        usage
395        exit 1
396        ;;
397    -c|--credential)
398        shift
399        CREDENTIAL="$1"
400        ;;
401    -p|--persistent)
402        shift
403        PERSISTENT="$1"
404        ;;
405    -g|--preserve-argv0)
406        shift
407        PRESERVE_ARG0="$1"
408        ;;
409    *)
410        break
411        ;;
412    esac
413    shift
414done
415
416$CHECK
417qemu_set_binfmts
418