scripts/qemu-binfmt-conf.sh

   1 #!/bin/sh
   2 # enable automatic i386/ARM/M68K/MIPS/SPARC/PPC/s390/HPPA
   3 # program execution by the kernel
   4
   5 qemu_target_list="i386 i486 alpha arm armeb sparc32plus ppc ppc64 ppc64le m68k \
   6 mips mipsel mipsn32 mipsn32el mips64 mips64el \
   7 sh4 sh4eb s390x aarch64 aarch64_be hppa riscv32 riscv64"
   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\xff\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\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
  15 i486_family=i386
  16
  17 alpha_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x26\x90'
  18 alpha_mask='\xff\xff\xff\xff\xff\xfe\xfe\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
  19 alpha_family=alpha
  20
  21 arm_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00'
  22 arm_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
  23 arm_family=arm
  24
  25 armeb_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28'
  26 armeb_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  27 armeb_family=armeb
  28
  29 sparc_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x02'
  30 sparc_mask='\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  31 sparc_family=sparc
  32
  33 sparc32plus_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x12'
  34 sparc32plus_mask='\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  35 sparc32plus_family=sparc
  36
  37 ppc_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x14'
  38 ppc_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  39 ppc_family=ppc
  40
  41 ppc64_magic='\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x15'
  42 ppc64_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  43 ppc64_family=ppc
  44
  45 ppc64le_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x15\x00'
  46 ppc64le_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\x00'
  47 ppc64le_family=ppcle
  48
  49 m68k_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x04'
  50 m68k_mask='\xff\xff\xff\xff\xff\xff\xfe\xfe\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  51 m68k_family=m68k
  52
  53 # FIXME: We could use the other endianness on a MIPS host.
  54
  55 mips_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08'
  56 mips_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  57 mips_family=mips
  58
  59 mipsel_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00'
  60 mipsel_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
  61 mipsel_family=mips
  62
  63 mipsn32_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08'
  64 mipsn32_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  65 mipsn32_family=mips
  66
  67 mipsn32el_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00'
  68 mipsn32el_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
  69 mipsn32el_family=mips
  70
  71 mips64_magic='\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08'
  72 mips64_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  73 mips64_family=mips
  74
  75 mips64el_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00'
  76 mips64el_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
  77 mips64el_family=mips
  78
  79 sh4_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x2a\x00'
  80 sh4_mask='\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
  81 sh4_family=sh4
  82
  83 sh4eb_magic='\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x2a'
  84 sh4eb_mask='\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  85 sh4eb_family=sh4
  86
  87 s390x_magic='\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x16'
  88 s390x_mask='\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  89 s390x_family=s390x
  90
  91 aarch64_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xb7\x00'
  92 aarch64_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
  93 aarch64_family=arm
  94
  95 aarch64_be_magic='\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xb7'
  96 aarch64_be_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
  97 aarch64_be_family=armeb
  98
  99 hppa_magic='\x7f\x45\x4c\x46\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x0f'
 100 hppa_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff'
 101 hppa_family=hppa
 102
 103 riscv32_magic='\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xf3\x00'
 104 riscv32_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
 105 riscv32_family=riscv
 106
 107 riscv64_magic='\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xf3\x00'
 108 riscv64_mask='\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff'
 109 riscv64_family=riscv
 110
 111 qemu_get_family() {
 112     cpu=${HOST_ARCH:-$(uname -m)}
 113     case "$cpu" in
 114     amd64|i386|i486|i586|i686|i86pc|BePC|x86_64)
 115         echo "i386"
 116         ;;
 117     mips*)
 118         echo "mips"
 119         ;;
 120     "Power Macintosh"|ppc64|powerpc|ppc)
 121         echo "ppc"
 122         ;;
 123     ppc64el|ppc64le)
 124         echo "ppcle"
 125         ;;
 126     arm|armel|armhf|arm64|armv[4-9]*l|aarch64)
 127         echo "arm"
 128         ;;
 129     armeb|armv[4-9]*b|aarch64_be)
 130         echo "armeb"
 131         ;;
 132     sparc*)
 133         echo "sparc"
 134         ;;
 135     riscv*)
 136         echo "riscv"
 137         ;;
 138     *)
 139         echo "$cpu"
 140         ;;
 141     esac
 142 }
 143
 144 usage() {
 145     cat <<EOF
 146 Usage: qemu-binfmt-conf.sh [--qemu-path PATH][--debian][--systemd CPU]
 147                            [--help][--credential yes|no][--exportdir PATH]
 148
 149        Configure binfmt_misc to use qemu interpreter
 150
 151        --help:       display this usage
 152        --qemu-path:  set path to qemu interpreter ($QEMU_PATH)
 153        --debian:     don't write into /proc,
 154                      instead generate update-binfmts templates
 155        --systemd:    don't write into /proc,
 156                      instead generate file for systemd-binfmt.service
 157                      for the given CPU
 158        --exportdir:  define where to write configuration files
 159                      (default: $SYSTEMDDIR or $DEBIANDIR)
 160        --credential: if yes, credential and security tokens are
 161                      calculated according to the binary to interpret
 162
 163     To import templates with update-binfmts, use :
 164
 165         sudo update-binfmts --importdir ${EXPORTDIR:-$DEBIANDIR} --import qemu-CPU
 166
 167     To remove interpreter, use :
 168
 169         sudo update-binfmts --package qemu-CPU --remove qemu-CPU $QEMU_PATH
 170
 171     With systemd, binfmt files are loaded by systemd-binfmt.service
 172
 173     The environment variable HOST_ARCH allows to override 'uname' to generate
 174     configuration files for a different architecture than the current one.
 175
 176     where CPU is one of:
 177
 178         $qemu_target_list
 179
 180 EOF
 181 }
 182
 183 qemu_check_access() {
 184     if [ ! -w "$1" ] ; then
 185         echo "ERROR: cannot write to $1" 1>&2
 186         exit 1
 187     fi
 188 }
 189
 190 qemu_check_bintfmt_misc() {
 191     # load the binfmt_misc module
 192     if [ ! -d /proc/sys/fs/binfmt_misc ]; then
 193       if ! /sbin/modprobe binfmt_misc ; then
 194           exit 1
 195       fi
 196     fi
 197     if [ ! -f /proc/sys/fs/binfmt_misc/register ]; then
 198       if ! mount binfmt_misc -t binfmt_misc /proc/sys/fs/binfmt_misc ; then
 199           exit 1
 200       fi
 201     fi
 202
 203     qemu_check_access /proc/sys/fs/binfmt_misc/register
 204 }
 205
 206 installed_dpkg() {
 207     dpkg --status "$1" > /dev/null 2>&1
 208 }
 209
 210 qemu_check_debian() {
 211     if [ ! -e /etc/debian_version ] ; then
 212         echo "WARNING: your system is not a Debian based distro" 1>&2
 213     elif ! installed_dpkg binfmt-support ; then
 214         echo "WARNING: package binfmt-support is needed" 1>&2
 215     fi
 216     qemu_check_access "$EXPORTDIR"
 217 }
 218
 219 qemu_check_systemd() {
 220     if ! systemctl -q is-enabled systemd-binfmt.service ; then
 221         echo "WARNING: systemd-binfmt.service is missing or disabled" 1>&2
 222     fi
 223     qemu_check_access "$EXPORTDIR"
 224 }
 225
 226 qemu_generate_register() {
 227     echo ":qemu-$cpu:M::$magic:$mask:$qemu:$FLAGS"
 228 }
 229
 230 qemu_register_interpreter() {
 231     echo "Setting $qemu as binfmt interpreter for $cpu"
 232     qemu_generate_register > /proc/sys/fs/binfmt_misc/register
 233 }
 234
 235 qemu_generate_systemd() {
 236     echo "Setting $qemu as binfmt interpreter for $cpu for systemd-binfmt.service"
 237     qemu_generate_register > "$EXPORTDIR/qemu-$cpu.conf"
 238 }
 239
 240 qemu_generate_debian() {
 241     cat > "$EXPORTDIR/qemu-$cpu" <<EOF
 242 package qemu-$cpu
 243 interpreter $qemu
 244 magic $magic
 245 mask $mask
 246 EOF
 247     if [ "$FLAGS" = "OC" ] ; then
 248         echo "credentials yes" >> "$EXPORTDIR/qemu-$cpu"
 249     fi
 250 }
 251
 252 qemu_set_binfmts() {
 253     # probe cpu type
 254     host_family=$(qemu_get_family)
 255
 256     # register the interpreter for each cpu except for the native one
 257
 258     for cpu in ${qemu_target_list} ; do
 259         magic=$(eval echo \$${cpu}_magic)
 260         mask=$(eval echo \$${cpu}_mask)
 261         family=$(eval echo \$${cpu}_family)
 262
 263         if [ "$magic" = "" ] || [ "$mask" = "" ] || [ "$family" = "" ] ; then
 264             echo "INTERNAL ERROR: unknown cpu $cpu" 1>&2
 265             continue
 266         fi
 267
 268         qemu="$QEMU_PATH/qemu-$cpu"
 269         if [ "$cpu" = "i486" ] ; then
 270             qemu="$QEMU_PATH/qemu-i386"
 271         fi
 272
 273         if [ "$host_family" != "$family" ] ; then
 274             $BINFMT_SET
 275         fi
 276     done
 277 }
 278
 279 CHECK=qemu_check_bintfmt_misc
 280 BINFMT_SET=qemu_register_interpreter
 281
 282 SYSTEMDDIR="/etc/binfmt.d"
 283 DEBIANDIR="/usr/share/binfmts"
 284
 285 QEMU_PATH=/usr/local/bin
 286 FLAGS=""
 287
 288 options=$(getopt -o ds:Q:e:hc: -l debian,systemd:,qemu-path:,exportdir:,help,credential: -- "$@")
 289 eval set -- "$options"
 290
 291 while true ; do
 292     case "$1" in
 293     -d|--debian)
 294         CHECK=qemu_check_debian
 295         BINFMT_SET=qemu_generate_debian
 296         EXPORTDIR=${EXPORTDIR:-$DEBIANDIR}
 297         ;;
 298     -s|--systemd)
 299         CHECK=qemu_check_systemd
 300         BINFMT_SET=qemu_generate_systemd
 301         EXPORTDIR=${EXPORTDIR:-$SYSTEMDDIR}
 302         shift
 303         # check given cpu is in the supported CPU list
 304         for cpu in ${qemu_target_list} ; do
 305             if [ "$cpu" = "$1" ] ; then
 306                 break
 307             fi
 308         done
 309
 310         if [ "$cpu" = "$1" ] ; then
 311             qemu_target_list="$1"
 312         else
 313             echo "ERROR: unknown CPU \"$1\"" 1>&2
 314             usage
 315             exit 1
 316         fi
 317         ;;
 318     -Q|--qemu-path)
 319         shift
 320         QEMU_PATH="$1"
 321         ;;
 322     -e|--exportdir)
 323         shift
 324         EXPORTDIR="$1"
 325         ;;
 326     -h|--help)
 327         usage
 328         exit 1
 329         ;;
 330     -c|--credential)
 331         shift
 332         if [ "$1" = "yes" ] ; then
 333             FLAGS="OC"
 334         else
 335             FLAGS=""
 336         fi
 337         ;;
 338     *)
 339         break
 340         ;;
 341     esac
 342     shift
 343 done
 344
 345 $CHECK
 346 qemu_set_binfmts