Merge pull request #91 from mythril-hypervisor/adam-dev

Include guest bios and linux loader in mythril binary

Author: dlrobertson

.github/workflows/rust.yml

@@ -21,6 +21,8 @@ jobs:
       options: "-u 0:0"
     steps:
     - uses: actions/checkout@v1
+      with:
+        submodules: true
     - name: Unit Tests
       run: |
         make test

.gitignore

@@ -1,6 +1,7 @@
 /boot
 /target
 mythril/target
+mythril/src/blob/bios.bin
 _boot.img
 **/*.rs.bk
 debug.log

Makefile

@@ -7,6 +7,7 @@ mythril_src = $(shell find mythril* -type f -name '*.rs' -or -name '*.S' -or -na
 	                   -name 'Cargo.toml')
 kernel = linux/arch/x86_64/boot/bzImage
 seabios = seabios/out/bios.bin
+seabios_blob = mythril/src/blob/bios.bin
 git_hooks_src = $(wildcard .mythril_githooks/*)
 git_hooks = $(subst .mythril_githooks,.git/hooks,$(git_hooks_src))
 
@@ -40,20 +41,23 @@ $(seabios):
 	cp scripts/seabios.config seabios/.config
 	make -C seabios
 
+$(seabios_blob): $(seabios)
+	cp $(seabios) $(seabios_blob)
+
 $(kernel):
 	cp scripts/kernel.config linux/.config
 	make -C linux bzImage
 
 .PHONY: qemu
-qemu: mythril $(seabios) $(kernel)
+qemu: mythril $(kernel)
 	./scripts/mythril-run.sh $(mythril_binary) $(QEMU_EXTRA)
 
 .PHONY: qemu-debug
-qemu-debug: mythril-debug $(seabios) $(kernel)
+qemu-debug: mythril-debug $(kernel)
 	./scripts/mythril-run.sh $(mythril_binary) \
 	    -gdb tcp::1234 -S $(QEMU_EXTRA)
 
-$(mythril_binary): $(mythril_src)
+$(mythril_binary): $(mythril_src) $(seabios_blob)
 	$(CARGO) build $(CARGO_BUILD_FLAGS) $(CARGO_MANIFEST) \
 	    -Z build-std=core,alloc \
 	    --target mythril/mythril_target.json \
@@ -67,7 +71,7 @@ fmt:
 	$(CARGO) fmt $(CARGO_MANIFEST) --all
 
 .PHONY: test_core
-test_common:
+test_common: $(seabios_blob)
 	$(CARGO) test $(CARGO_MANIFEST) --lib \
 	    --features=test \
 
@@ -77,6 +81,7 @@ test: test_common
 .PHONY: clean
 clean:
 	$(CARGO) clean $(CARGO_MANIFEST)
+	rm $(seabios_blob)
 	make -C seabios clean
 	make -C linux clean
 

scripts/linuxboot_dma.bin renamed to mythril/src/blob/linuxboot_dma.bin

@@ -49,9 +49,6 @@ fn default_vm(
     let mut config =
         vm::VirtualMachineConfig::new(vec![core], mem, physical_config);
 
-    // FIXME: When `map_bios` may return an error, log the error.
-    config.map_bios("seabios.bin".into()).unwrap_or(());
-
     let device_map = config.virtual_devices_mut();
     device_map
         .register_device(virtdev::acpi::AcpiRuntime::new(0xb000).unwrap())
@@ -100,10 +97,7 @@ fn default_vm(
     // The 'linuxboot' file is an option rom that loads the linux kernel
     // via qemu_fw_cfg
     fw_cfg_builder
-        .add_file(
-            "genroms/linuxboot_dma.bin",
-            info.find_module("linuxboot_dma.bin").unwrap().data(),
-        )
+        .add_file("genroms/linuxboot_dma.bin", linux::LINUXBOOT_DMA_ROM)
         .unwrap();
 
     // Passing the bootorder file automatically selects the option rom

mythril/src/kmain.rs

@@ -4,6 +4,11 @@ use crate::virtdev::qemu_fw_cfg::{FwCfgSelector, QemuFwCfgBuilder};
 use bitflags::bitflags;
 use byteorder::{ByteOrder, LittleEndian};
 
+// This blob is taken from QEMU. See:
+// https://github.com/qemu/qemu/blob/887adde81d1f1f3897f1688d37ec6851b4fdad86/pc-bios/optionrom/linuxboot_dma.c
+pub const LINUXBOOT_DMA_ROM: &'static [u8] =
+    include_bytes!("blob/linuxboot_dma.bin");
+
 bitflags! {
     pub struct XLoadFlags: u32 {
         const KERNEL_64 = 1 << 0;

mythril/src/linux.rs

@@ -21,6 +21,8 @@ use alloc::vec::Vec;
 use arraydeque::ArrayDeque;
 use spin::RwLock;
 
+static BIOS_BLOB: &'static [u8] = include_bytes!("blob/bios.bin");
+
 static VIRTUAL_MACHINES: RoAfterInit<VirtualMachines> =
     RoAfterInit::uninitialized();
 
@@ -218,7 +220,6 @@ pub struct PhysicalDeviceConfig {
 pub struct VirtualMachineConfig {
     cpus: Vec<percore::CoreId>,
     images: Vec<(String, GuestPhysAddr)>,
-    bios: Option<String>,
     virtual_devices: DeviceMap,
     physical_devices: PhysicalDeviceConfig,
     memory: u64, // in MB
@@ -241,7 +242,6 @@ impl VirtualMachineConfig {
             images: vec![],
             virtual_devices: DeviceMap::default(),
             physical_devices: physical_devices,
-            bios: None,
             memory: memory,
         }
     }
@@ -259,18 +259,6 @@ impl VirtualMachineConfig {
         Ok(())
     }
 
-    /// Specify that the given image 'path' should be mapped as the BIOS
-    ///
-    /// The precise meaning of `image` will vary by platform. This will be a
-    /// value suitable to be passed to `VmServices::read_file`.
-    ///
-    /// The BIOS image will be mapped such that the end of the image is at
-    /// 0xffffffff and 0xfffff (i.e., it will be mapped in two places)
-    pub fn map_bios(&mut self, bios: String) -> Result<()> {
-        self.bios = Some(bios);
-        Ok(())
-    }
-
     /// Access the configurations virtual `DeviceMap`
     pub fn virtual_devices(&self) -> &DeviceMap {
         &self.virtual_devices
@@ -398,25 +386,15 @@ impl VirtualMachine {
         Self::map_data(data, addr, space)
     }
 
-    fn map_bios(
-        bios: &str,
-        space: &mut GuestAddressSpace,
-        info: &BootInfo,
-    ) -> Result<()> {
-        let data = info
-            .find_module(bios)
-            .ok_or_else(|| {
-                Error::InvalidValue(format!("No such bios '{}'", bios))
-            })?
-            .data();
-        let bios_size = data.len() as u64;
+    fn map_bios(space: &mut GuestAddressSpace) -> Result<()> {
+        let bios_size = BIOS_BLOB.len() as u64;
         Self::map_data(
-            data,
+            BIOS_BLOB,
             &memory::GuestPhysAddr::new((1024 * 1024) - bios_size),
             space,
         )?;
         Self::map_data(
-            data,
+            BIOS_BLOB,
             &memory::GuestPhysAddr::new((4 * 1024 * 1024 * 1024) - bios_size),
             space,
         )
@@ -429,9 +407,7 @@ impl VirtualMachine {
         let mut guest_space = GuestAddressSpace::new()?;
 
         // First map the bios
-        if let Some(ref bios) = config.bios {
-            Self::map_bios(&bios, &mut guest_space, info)?;
-        }
+        Self::map_bios(&mut guest_space)?;
 
         // Now map any guest iamges
         for image in config.images.iter() {

mythril/src/vm.rs

@@ -5,8 +5,6 @@ menuentry 'Mythril' {
    echo	'Loading Mythril'
    acpi -2
    multiboot2 /boot/mythril.bin
-   module2 /boot/seabios.bin seabios.bin
-   module2 /boot/linuxboot_dma.bin linuxboot_dma.bin
    module2 /boot/vmlinuz kernel
    module2 /boot/initramfs initramfs
 }

scripts/grub.cfg

@@ -13,9 +13,7 @@ rm -rf _isofiles
 mkdir -p _isofiles/boot/grub
 
 cp scripts/grub.cfg _isofiles/boot/grub/
-cp seabios/out/bios.bin _isofiles/boot/seabios.bin
 cp linux/arch/x86_64/boot/bzImage _isofiles/boot/vmlinuz
-cp scripts/linuxboot_dma.bin _isofiles/boot/linuxboot_dma.bin
 cp scripts/initramfs _isofiles/boot/initramfs
 cp "$1" _isofiles/boot/mythril.bin