scripts/qemu-binfmt-conf.sh

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