xref: /qemu/scripts/qemu-binfmt-conf.sh (revision d7a84021) 
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"
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'
64mips_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
65mips_family=mips
66
67mipsel_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00'
68mipsel_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
69mipsel_family=mips
70
71mipsn32_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08'
72mipsn32_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
73mipsn32_family=mips
74
75mipsn32el_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00'
76mipsn32el_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
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\xff\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\xff\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
143qemu_get_family() {
144    cpu=${HOST_ARCH:-$(uname -m)}
145    case "$cpu" in
146    amd64|i386|i486|i586|i686|i86pc|BePC|x86_64)
147        echo "i386"
148        ;;
149    mips*)
150        echo "mips"
151        ;;
152    "Power Macintosh"|ppc64|powerpc|ppc)
153        echo "ppc"
154        ;;
155    ppc64el|ppc64le)
156        echo "ppcle"
157        ;;
158    arm|armel|armhf|arm64|armv[4-9]*l|aarch64)
159        echo "arm"
160        ;;
161    armeb|armv[4-9]*b|aarch64_be)
162        echo "armeb"
163        ;;
164    sparc*)
165        echo "sparc"
166        ;;
167    riscv*)
168        echo "riscv"
169        ;;
170    *)
171        echo "$cpu"
172        ;;
173    esac
174}
175
176usage() {
177    cat <<EOF
178Usage: qemu-binfmt-conf.sh [--qemu-path PATH][--debian][--systemd CPU]
179                           [--help][--credential yes|no][--exportdir PATH]
180                           [--persistent yes|no][--qemu-suffix SUFFIX]
181
182       Configure binfmt_misc to use qemu interpreter
183
184       --help:        display this usage
185       --qemu-path:   set path to qemu interpreter ($QEMU_PATH)
186       --qemu-suffix: add a suffix to the default interpreter name
187       --debian:      don't write into /proc,
188                      instead generate update-binfmts templates
189       --systemd:     don't write into /proc,
190                      instead generate file for systemd-binfmt.service
191                      for the given CPU. If CPU is "ALL", generate a
192                      file for all known cpus
193       --exportdir:   define where to write configuration files
194                      (default: $SYSTEMDDIR or $DEBIANDIR)
195       --credential:  if yes, credential and security tokens are
196                      calculated according to the binary to interpret
197       --persistent:  if yes, the interpreter is loaded when binfmt is
198                      configured and remains in memory. All future uses
199                      are cloned from the open file.
200
201    To import templates with update-binfmts, use :
202
203        sudo update-binfmts --importdir ${EXPORTDIR:-$DEBIANDIR} --import qemu-CPU
204
205    To remove interpreter, use :
206
207        sudo update-binfmts --package qemu-CPU --remove qemu-CPU $QEMU_PATH
208
209    With systemd, binfmt files are loaded by systemd-binfmt.service
210
211    The environment variable HOST_ARCH allows to override 'uname' to generate
212    configuration files for a different architecture than the current one.
213
214    where CPU is one of:
215
216        $qemu_target_list
217
218EOF
219}
220
221qemu_check_access() {
222    if [ ! -w "$1" ] ; then
223        echo "ERROR: cannot write to $1" 1>&2
224        exit 1
225    fi
226}
227
228qemu_check_bintfmt_misc() {
229    # load the binfmt_misc module
230    if [ ! -d /proc/sys/fs/binfmt_misc ]; then
231      if ! /sbin/modprobe binfmt_misc ; then
232          exit 1
233      fi
234    fi
235    if [ ! -f /proc/sys/fs/binfmt_misc/register ]; then
236      if ! mount binfmt_misc -t binfmt_misc /proc/sys/fs/binfmt_misc ; then
237          exit 1
238      fi
239    fi
240
241    qemu_check_access /proc/sys/fs/binfmt_misc/register
242}
243
244installed_dpkg() {
245    dpkg --status "$1" > /dev/null 2>&1
246}
247
248qemu_check_debian() {
249    if [ ! -e /etc/debian_version ] ; then
250        echo "WARNING: your system is not a Debian based distro" 1>&2
251    elif ! installed_dpkg binfmt-support ; then
252        echo "WARNING: package binfmt-support is needed" 1>&2
253    fi
254    qemu_check_access "$EXPORTDIR"
255}
256
257qemu_check_systemd() {
258    if ! systemctl -q is-enabled systemd-binfmt.service ; then
259        echo "WARNING: systemd-binfmt.service is missing or disabled" 1>&2
260    fi
261    qemu_check_access "$EXPORTDIR"
262}
263
264qemu_generate_register() {
265    flags=""
266    if [ "$CREDENTIAL" = "yes" ] ; then
267        flags="OC"
268    fi
269    if [ "$PERSISTENT" = "yes" ] ; then
270        flags="${flags}F"
271    fi
272
273    echo ":qemu-$cpu:M::$magic:$mask:$qemu:$flags"
274}
275
276qemu_register_interpreter() {
277    echo "Setting $qemu as binfmt interpreter for $cpu"
278    qemu_generate_register > /proc/sys/fs/binfmt_misc/register
279}
280
281qemu_generate_systemd() {
282    echo "Setting $qemu as binfmt interpreter for $cpu for systemd-binfmt.service"
283    qemu_generate_register > "$EXPORTDIR/qemu-$cpu.conf"
284}
285
286qemu_generate_debian() {
287    cat > "$EXPORTDIR/qemu-$cpu" <<EOF
288package qemu-$cpu
289interpreter $qemu
290magic $magic
291mask $mask
292credential $CREDENTIAL
293EOF
294}
295
296qemu_set_binfmts() {
297    # probe cpu type
298    host_family=$(qemu_get_family)
299
300    # register the interpreter for each cpu except for the native one
301
302    for cpu in ${qemu_target_list} ; do
303        magic=$(eval echo \$${cpu}_magic)
304        mask=$(eval echo \$${cpu}_mask)
305        family=$(eval echo \$${cpu}_family)
306
307        if [ "$magic" = "" ] || [ "$mask" = "" ] || [ "$family" = "" ] ; then
308            echo "INTERNAL ERROR: unknown cpu $cpu" 1>&2
309            continue
310        fi
311
312        qemu="$QEMU_PATH/qemu-$cpu"
313        if [ "$cpu" = "i486" ] ; then
314            qemu="$QEMU_PATH/qemu-i386"
315        fi
316
317        qemu="$qemu$QEMU_SUFFIX"
318        if [ "$host_family" != "$family" ] ; then
319            $BINFMT_SET
320        fi
321    done
322}
323
324CHECK=qemu_check_bintfmt_misc
325BINFMT_SET=qemu_register_interpreter
326
327SYSTEMDDIR="/etc/binfmt.d"
328DEBIANDIR="/usr/share/binfmts"
329
330QEMU_PATH=/usr/local/bin
331CREDENTIAL=no
332PERSISTENT=no
333QEMU_SUFFIX=""
334
335options=$(getopt -o ds:Q:S:e:hc:p: -l debian,systemd:,qemu-path:,qemu-suffix:,exportdir:,help,credential:,persistent: -- "$@")
336eval set -- "$options"
337
338while true ; do
339    case "$1" in
340    -d|--debian)
341        CHECK=qemu_check_debian
342        BINFMT_SET=qemu_generate_debian
343        EXPORTDIR=${EXPORTDIR:-$DEBIANDIR}
344        ;;
345    -s|--systemd)
346        CHECK=qemu_check_systemd
347        BINFMT_SET=qemu_generate_systemd
348        EXPORTDIR=${EXPORTDIR:-$SYSTEMDDIR}
349        shift
350        # check given cpu is in the supported CPU list
351        if [ "$1" != "ALL" ] ; then
352            for cpu in ${qemu_target_list} ; do
353                if [ "$cpu" = "$1" ] ; then
354                    break
355                fi
356            done
357
358            if [ "$cpu" = "$1" ] ; then
359                qemu_target_list="$1"
360            else
361                echo "ERROR: unknown CPU \"$1\"" 1>&2
362                usage
363                exit 1
364            fi
365        fi
366        ;;
367    -Q|--qemu-path)
368        shift
369        QEMU_PATH="$1"
370        ;;
371    -F|--qemu-suffix)
372        shift
373        QEMU_SUFFIX="$1"
374        ;;
375    -e|--exportdir)
376        shift
377        EXPORTDIR="$1"
378        ;;
379    -h|--help)
380        usage
381        exit 1
382        ;;
383    -c|--credential)
384        shift
385        CREDENTIAL="$1"
386        ;;
387    -p|--persistent)
388        shift
389        PERSISTENT="$1"
390        ;;
391    *)
392        break
393        ;;
394    esac
395    shift
396done
397
398$CHECK
399qemu_set_binfmts
400