scripts/qemustart

   1 #!/usr/bin/env bash
   2
   3 SELF="$0"
   4
   5 # Linux bridge for connecting lan and wan network of guest machines
   6 BR_LAN="${BR_LAN:-br-lan}"
   7 BR_WAN="${BR_WAN:-br-wan}"
   8
   9 # Host network interface providing internet access for guest machines
  10 IF_INET="${IF_INET:-eth0}"
  11
  12 # qemu-bridge-helper does two things here
  13 #
  14 # - create tap interface
  15 # - add the tap interface to bridge
  16 #
  17 # as such it requires CAP_NET_ADMIN to do its job.  It will be convenient to
  18 # have it as a root setuid program.  Be aware of the security risks implied
  19 #
  20 # the helper has an acl list which defaults to deny all bridge.  we need to add
  21 # $BR_LAN and $BR_WAN to its allow list
  22 #
  23 #       # sudo vim /etc/qemu/bridge.conf
  24 #       allow br-lan
  25 #       allow br-wan
  26 #
  27 # Other allowed directives can be 'allow all', 'deny all', 'include xxx',  See
  28 # qemu-bridge-helper.c of qemu source code for details.
  29 #
  30 # The helper can be provided by package qemu-system-common on debian, or
  31 # qemu-kvm-common on rhel
  32 #
  33 HELPER="${HELPER:-/usr/libexec/qemu-bridge-helper}"
  34
  35 ### end of global settings
  36
  37 __errmsg() {
  38         echo "$*" >&2
  39 }
  40
  41 do_setup() {
  42         # setup bridge for LAN network
  43         sudo ip link add dev "$BR_LAN" type bridge
  44         sudo ip link set dev "$BR_LAN" up
  45         sudo ip addr add 192.168.1.3/24 dev "$BR_LAN"
  46
  47         # setup bridge for WAN network
  48         #
  49         # minimal dnsmasq config for configuring guest wan network with dhcp
  50         #
  51         #       # sudo apt-get install dnsmasq
  52         #       # sudo vi /etc/dnsmasq.conf
  53         #       interface=br-wan
  54         #       dhcp-range=192.168.7.50,192.168.7.150,255.255.255.0,30m
  55         #
  56         sudo ip link add dev "$BR_WAN" type bridge
  57         sudo ip link set dev "$BR_WAN" up
  58         sudo ip addr add 192.168.7.1/24 dev "$BR_WAN"
  59
  60         # guest internet access
  61         sudo sysctl -w "net.ipv4.ip_forward=1"
  62         sudo sysctl -w "net.ipv4.conf.$BR_WAN.proxy_arp=1"
  63         while sudo iptables -t nat -D POSTROUTING -o "$IF_INET" -j MASQUERADE 2>/dev/null; do true; done
  64               sudo iptables -t nat -A POSTROUTING -o "$IF_INET" -j MASQUERADE
  65 }
  66
  67 check_setup_() {
  68         ip link show "$BR_LAN" >/dev/null || return 1
  69         ip link show "$BR_WAN" >/dev/null || return 1
  70         [ -x "$HELPER" ] || {
  71                 __errmsg "helper $HELPER is not an executable"
  72                 return 1
  73         }
  74 }
  75
  76 check_setup() {
  77         [ -n "$o_network" ] || return 0
  78         check_setup_ || {
  79                 __errmsg "please check the script content to see the environment requirement"
  80                 return 1
  81         }
  82 }
  83 #do_setup; check_setup; exit $?
  84
  85 usage() {
  86         cat >&2 <<EOF
  87 Usage: $SELF [-h|--help]
  88        $SELF <target>
  89          [<subtarget> [<extra-qemu-options>]]
  90          [--kernel <kernel>]
  91          [--rootfs <rootfs>]
  92          [--machine <machine>]
  93          [-n|--network]
  94
  95 <subtarget> will default to "generic" and must be specified if
  96 <extra-qemu-options> are present
  97
  98 e.g. <subtarget> for malta can be le, be, le64, be64, le-glibc, le64-glibc, etc
  99
 100 <kernel>, <rootfs> can be required or optional arguments to qemu depending on
 101 the actual <target> in use.  They will default to files under bin/targets/
 102
 103 Examples
 104
 105   $SELF x86 64
 106   $SELF x86 64 --machine q35,accel=kvm -device virtio-balloon-pci
 107   $SELF x86 64 -incoming tcp:0:4444
 108   $SELF x86 64-glibc
 109   $SELF malta be -m 64
 110   $SELF malta le64
 111   $SELF malta be-glibc
 112   $SELF armvirt 32 \\
 113                 --machine virt,highmem=off \\
 114                 --kernel bin/targets/armvirt/32/openwrt-armvirt-32-zImage \\
 115                 --rootfs bin/targets/armvirt/32/openwrt-armvirt-32-root.ext4
 116 EOF
 117 }
 118
 119 rand_mac() {
 120         hexdump -n 3 -e '"52:54:00" 3/1 ":%02x"' /dev/urandom
 121 }
 122
 123 parse_args() {
 124         o_network=
 125         o_qemu_extra=()
 126         while [ "$#" -gt 0 ]; do
 127                 case "$1" in
 128                         --kernel) o_kernel="$2"; shift 2 ;;
 129                         --rootfs) o_rootfs="$2"; shift 2 ;;
 130                         --machine|-machine|-M) o_mach="$2"; shift 2 ;;
 131                         --network|-n) o_network=1; shift ;;
 132                         --help|-h)
 133                                 usage
 134                                 exit 0
 135                                 ;;
 136                         *)
 137                                 if [ -z "$o_target" ]; then
 138                                         o_target="$1"
 139                                 elif [ -z "$o_subtarget" ]; then
 140                                         o_subtarget="$1"
 141                                 else
 142                                         o_qemu_extra+=("$1")
 143                                 fi
 144                                 shift
 145                                 ;;
 146                 esac
 147         done
 148
 149         MAC_LAN="$(rand_mac)"
 150         MAC_WAN="$(rand_mac)"
 151         [ -n "$o_target" ] || {
 152                 usage
 153                 return 1
 154         }
 155         [ -n "$o_subtarget" ] || o_subtarget="generic"
 156         o_bindir="bin/targets/$o_target/$o_subtarget"
 157 }
 158
 159 start_qemu_armvirt() {
 160         local kernel="$o_kernel"
 161         local rootfs="$o_rootfs"
 162         local mach="${o_mach:-virt}"
 163         local cpu
 164         local qemu_exe
 165
 166         case "${o_subtarget%-*}" in
 167                 32)
 168                         qemu_exe="qemu-system-arm"
 169                         cpu="cortex-a15"
 170                         [ -n "$kernel" ] || kernel="$o_bindir/openwrt-$o_target-${o_subtarget%-*}-zImage-initramfs"
 171                         ;;
 172                 64)
 173                         qemu_exe="qemu-system-aarch64"
 174                         cpu="cortex-a57"
 175                         [ -n "$kernel" ] || kernel="$o_bindir/openwrt-$o_target-${o_subtarget%-*}-Image-initramfs"
 176                         ;;
 177                 *)
 178                         __errmsg "target $o_target: unknown subtarget $o_subtarget"
 179                         return 1
 180                         ;;
 181         esac
 182         [ -z "$rootfs" ] || {
 183                 if [ ! -f "$rootfs" -a -s "$rootfs.gz" ]; then
 184                         gunzip "$rootfs.gz"
 185                 fi
 186                 o_qemu_extra+=( \
 187                         "-drive" "file=$rootfs,format=raw,if=virtio" \
 188                         "-append" "root=/dev/vda rootwait" \
 189                 )
 190         }
 191
 192         [ -z "$o_network" ] || {
 193                 o_qemu_extra+=( \
 194                         "-netdev" "bridge,id=lan,br=$BR_LAN,helper=$HELPER" \
 195                             "-device" "virtio-net-pci,id=devlan,netdev=lan,mac=$MAC_LAN" \
 196                         "-netdev" "bridge,id=wan,br=$BR_WAN,helper=$HELPER" "-device" \
 197                             "virtio-net-pci,id=devwan,netdev=wan,mac=$MAC_WAN" \
 198                 )
 199         }
 200
 201         "$qemu_exe" -machine "$mach" -cpu "$cpu" -nographic \
 202                 -kernel "$kernel" \
 203                 "${o_qemu_extra[@]}"
 204 }
 205
 206 start_qemu_malta() {
 207         local is64
 208         local isel
 209         local qemu_exe
 210         local rootfs="$o_rootfs"
 211         local kernel="$o_kernel"
 212         local mach="${o_mach:-malta}"
 213
 214         # o_subtarget can be le, be, le64, be64, le-glibc, le64-glibc, etc..
 215         is64="$(echo $o_subtarget | grep -o 64)"
 216         [ "$(echo "$o_subtarget" | grep -o '^..')" = "le" ] && isel="el"
 217         qemu_exe="qemu-system-mips$is64$isel"
 218
 219         [ -n "$kernel" ] || kernel="$o_bindir/openwrt-malta-${o_subtarget%-*}-vmlinux-initramfs.elf"
 220
 221         [ -z "$rootfs" ] || {
 222                 if [ ! -f "$rootfs" -a -s "$rootfs.gz" ]; then
 223                         gunzip "$rootfs.gz"
 224                 fi
 225                 o_qemu_extra+=( \
 226                         "-drive" "file=$rootfs,format=raw" \
 227                         "-append" "root=/dev/sda rootwait" \
 228                 )
 229         }
 230
 231         # NOTE: order of wan, lan -device arguments matters as it will affect which
 232         # one will be actually used as the wan, lan network interface inside the
 233         # guest machine
 234         [ -z "$o_network" ] || {
 235                 o_qemu_extra+=(
 236                         -netdev bridge,id=wan,br="$BR_WAN,helper=$HELPER" -device pcnet,netdev=wan,mac="$MAC_WAN"
 237                         -netdev bridge,id=lan,br="$BR_LAN,helper=$HELPER" -device pcnet,netdev=lan,mac="$MAC_LAN"
 238                 )
 239         }
 240
 241         "$qemu_exe" -machine "$mach" -nographic \
 242                 -kernel "$kernel" \
 243                 "${o_qemu_extra[@]}"
 244 }
 245
 246 start_qemu_x86() {
 247         local qemu_exe
 248         local kernel="$o_kernel"
 249         local rootfs="$o_rootfs"
 250         local mach="${o_mach:-pc}"
 251
 252         [ -n "$rootfs" ] || {
 253                 rootfs="$o_bindir/openwrt-$o_target-${o_subtarget%-*}-combined-ext4.img"
 254                 if [ ! -f "$rootfs" -a -s "$rootfs.gz" ]; then
 255                         gunzip "$rootfs.gz"
 256                 fi
 257         }
 258         #
 259         # generic: 32-bit, pentium4 (CONFIG_MPENTIUM4), kvm guest, virtio
 260         # legacy: 32-bit, i486 (CONFIG_M486)
 261         # 64: 64-bit, kvm guest, virtio
 262         #
 263         case "${o_subtarget%-*}" in
 264                 legacy)                 qemu_exe="qemu-system-i386"     ;;
 265                 generic|64)             qemu_exe="qemu-system-x86_64"   ;;
 266                 *)
 267                         __errmsg "target $o_target: unknown subtarget $o_subtarget"
 268                         return 1
 269                         ;;
 270         esac
 271
 272         [ -n "$kernel" ] && {
 273             o_qemu_extra+=( \
 274                 "-kernel" "$kernel" \
 275                 "-append" "root=/dev/vda console=ttyS0 rootwait" \
 276             )
 277         }
 278
 279         [ -z "$o_network" ] || {
 280                 case "${o_subtarget%-*}" in
 281                         legacy)
 282                                 o_qemu_extra+=(
 283                                         -netdev "bridge,id=lan,br=$BR_LAN,helper=$HELPER" -device "e1000,id=devlan,netdev=lan,mac=$MAC_LAN"
 284                                         -netdev "bridge,id=wan,br=$BR_WAN,helper=$HELPER" -device "e1000,id=devwan,netdev=wan,mac=$MAC_WAN"
 285                                 )
 286                                 ;;
 287                         generic|64)
 288                                 o_qemu_extra+=(
 289                                         -netdev "bridge,id=lan,br=$BR_LAN,helper=$HELPER" -device "virtio-net-pci,id=devlan,netdev=lan,mac=$MAC_LAN"
 290                                         -netdev "bridge,id=wan,br=$BR_WAN,helper=$HELPER" -device "virtio-net-pci,id=devwan,netdev=wan,mac=$MAC_WAN"
 291                                 )
 292                                 ;;
 293                 esac
 294         }
 295
 296         case "${o_subtarget%-*}" in
 297                 legacy)
 298                         # use IDE (PATA) disk instead of AHCI (SATA).  Refer to link
 299                         # [1] for related discussions
 300                         #
 301                         # To use AHCI interface
 302                         #
 303                         #       -device ich9-ahci,id=ahci \
 304                         #       -device ide-drive,drive=drv0,bus=ahci.0 \
 305                         #       -drive "file=$rootfs,format=raw,id=drv0,if=none" \
 306                         #
 307                         # [1] https://dev.openwrt.org/ticket/17947
 308                         "$qemu_exe" -machine "$mach" -nographic \
 309                                 -device ide-drive,drive=drv0 \
 310                                 -drive "file=$rootfs,format=raw,id=drv0,if=none" \
 311                                 "${o_qemu_extra[@]}"
 312                         ;;
 313                 generic|64)
 314                         "$qemu_exe" -machine "$mach" -nographic \
 315                                 -drive "file=$rootfs,format=raw,if=virtio" \
 316                                 "${o_qemu_extra[@]}"
 317                         ;;
 318         esac
 319 }
 320
 321 start_qemu() {
 322         case "$o_target" in
 323                 armvirt)        start_qemu_armvirt      ;;
 324                 malta)          start_qemu_malta        ;;
 325                 x86)            start_qemu_x86          ;;
 326                 *)
 327                         __errmsg "target $o_target is not supported yet"
 328                         return 1
 329                         ;;
 330         esac
 331 }
 332
 333 parse_args "$@" \
 334         && check_setup \
 335         && start_qemu