# # Copyright 2019-2021 Canonical Ltd. # Authors: # - dann frazier # # This program is free software: you can redistribute it and/or modify it # under the terms of the GNU General Public License version 3, as published # by the Free Software Foundation. # # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranties of MERCHANTABILITY, # SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. # # You should have received a copy of the GNU General Public License along with # this program. If not, see . # import enum import os import shutil import tempfile from util import delete_tempfile class QemuEfiMachine(enum.Enum): OVMF_PC = enum.auto() OVMF_Q35 = enum.auto() OVMF32_PC = enum.auto() OVMF32_Q35 = enum.auto() AAVMF = enum.auto() AAVMF32 = enum.auto() RISCV64 = enum.auto() LOONGARCH64 = enum.auto() class QemuEfiVariant(enum.Enum): MS = enum.auto() SECBOOT = enum.auto() MS_STRICTNX = enum.auto() SNAKEOIL = enum.auto() class QemuEfiFlashSize(enum.Enum): DEFAULT = enum.auto() SIZE_4MB = enum.auto() class QemuCommand: Qemu_Common_Params = [ '-no-user-config', '-nodefaults', '-m', '256', '-smp', '1,sockets=1,cores=1,threads=1', '-display', 'none', '-serial', 'stdio', ] Aavmf_Common_Params = Qemu_Common_Params + [ '-machine', 'virt', '-device', 'virtio-serial-device', ] LoongArch_Common_Params = Qemu_Common_Params + [ '-machine', 'virt', ] Ovmf_Common_Params = Qemu_Common_Params + [ '-chardev', 'pty,id=charserial1', '-device', 'isa-serial,chardev=charserial1,id=serial1', ] RiscV_Common_Params = Qemu_Common_Params + [ '-machine', 'virt', '-device', 'virtio-serial-device', ] Machine_Base_Command = { QemuEfiMachine.AAVMF: [ 'qemu-system-aarch64', '-cpu', 'cortex-a57', ] + Aavmf_Common_Params, QemuEfiMachine.AAVMF32: [ 'qemu-system-arm', '-cpu', 'cortex-a15', ] + Aavmf_Common_Params, QemuEfiMachine.LOONGARCH64: [ 'qemu-system-loongarch64', ] + LoongArch_Common_Params, QemuEfiMachine.OVMF_PC: [ 'qemu-system-x86_64', '-machine', 'pc,accel=tcg', ] + Ovmf_Common_Params, QemuEfiMachine.OVMF_Q35: [ 'qemu-system-x86_64', '-machine', 'q35,accel=tcg', ] + Ovmf_Common_Params, QemuEfiMachine.OVMF32_PC: [ 'qemu-system-i386', '-machine', 'pc,accel=tcg', ] + Ovmf_Common_Params, QemuEfiMachine.OVMF32_Q35: [ 'qemu-system-i386', '-machine', 'q35,accel=tcg', ] + Ovmf_Common_Params, QemuEfiMachine.RISCV64: [ 'qemu-system-riscv64', ] + RiscV_Common_Params, } def _get_default_flash_paths(self, machine, variant, flash_size): assert(machine in QemuEfiMachine) assert(variant is None or variant in QemuEfiVariant) assert(flash_size in QemuEfiFlashSize) code_ext = '.no-secboot' if machine == QemuEfiMachine.AAVMF else '' vars_ext = '' if variant == QemuEfiVariant.MS: code_ext = vars_ext = '.ms' elif variant == QemuEfiVariant.SECBOOT: code_ext = '.secboot' elif variant == QemuEfiVariant.MS_STRICTNX: code_ext = '.secboot.strictnx' vars_ext = '.ms' elif variant == QemuEfiVariant.SNAKEOIL: code_ext = vars_ext = '.snakeoil' if variant == QemuEfiVariant.SNAKEOIL: # We provide one size - you don't get to pick. assert(flash_size == QemuEfiFlashSize.DEFAULT) if machine == QemuEfiMachine.AAVMF: assert(flash_size == QemuEfiFlashSize.DEFAULT) return ( f'/usr/share/AAVMF/AAVMF_CODE{code_ext}.fd', f'/usr/share/AAVMF/AAVMF_VARS{vars_ext}.fd', ) if machine == QemuEfiMachine.AAVMF32: assert(variant is None) assert(flash_size == QemuEfiFlashSize.DEFAULT) return ( '/usr/share/AAVMF/AAVMF32_CODE.fd', '/usr/share/AAVMF/AAVMF32_VARS.fd' ) if machine == QemuEfiMachine.LOONGARCH64: assert(variant is None) assert(flash_size == QemuEfiFlashSize.DEFAULT) return ( '/usr/share/qemu-efi-loongarch64/QEMU_EFI.fd', '/usr/share/qemu-efi-loongarch64/QEMU_VARS.fd', ) if machine == QemuEfiMachine.RISCV64: assert(variant is None) assert(flash_size == QemuEfiFlashSize.DEFAULT) return ( '/usr/share/qemu-efi-riscv64/RISCV_VIRT_CODE.fd', '/usr/share/qemu-efi-riscv64/RISCV_VIRT_VARS.fd', ) # Remaining possibilities are OVMF variants assert( flash_size in [ QemuEfiFlashSize.DEFAULT, QemuEfiFlashSize.SIZE_4MB ] ) size_ext = '_4M' if machine in [QemuEfiMachine.OVMF_PC, QemuEfiMachine.OVMF32_PC]: assert(variant is None) if machine == QemuEfiMachine.OVMF32_Q35: assert(variant is None or variant in [QemuEfiVariant.SECBOOT, QemuEfiVariant.SECBOOT_STRICTNX]) if machine in [QemuEfiMachine.OVMF32_PC, QemuEfiMachine.OVMF32_Q35]: OVMF_ARCH = "OVMF32" else: OVMF_ARCH = "OVMF" return ( f'/usr/share/OVMF/{OVMF_ARCH}_CODE{size_ext}{code_ext}.fd', f'/usr/share/OVMF/{OVMF_ARCH}_VARS{size_ext}{vars_ext}.fd' ) def __init__( self, machine, variant=None, code_path=None, vars_template_path=None, flash_size=QemuEfiFlashSize.DEFAULT, ): assert( (code_path and vars_template_path) or (not code_path and not vars_template_path) ) if not code_path: (code_path, vars_template_path) = self._get_default_flash_paths( machine, variant, flash_size) self.pflash = self.PflashParams(code_path, vars_template_path) self.command = self.Machine_Base_Command[machine] + self.pflash.params def add_disk(self, path): self.command = self.command + [ '-drive', 'file=%s,format=raw' % (path) ] def add_oem_string(self, type, string): string = string.replace(",", ",,") self.command = self.command + [ '-smbios', f'type={type},value={string}' ] class PflashParams: ''' Used to generate the appropriate -pflash arguments for QEMU. Mostly used as a fancy way to generate a per-instance vars file and have it be automatically cleaned up when the object is destroyed. ''' def __init__(self, code_path, vars_template_path): self.params = [ '-drive', 'file=%s,if=pflash,format=raw,unit=0,readonly=on' % (code_path), ] if vars_template_path is None: return self.varfile = tempfile.NamedTemporaryFile( prefix=os.path.basename(vars_template_path), delete=delete_tempfile(), ) with open(vars_template_path, 'rb') as template: shutil.copyfileobj(template, self.varfile) self.params = self.params + [ '-drive', 'file=%s,if=pflash,format=raw,unit=1,readonly=off' % (self.varfile.name) ]