Dockerfile to build OVMF with NVME support tuned off

- We need to disable NVME support to emulate target environment

Signed-off-by: Mikhail Malyshev <[email protected]>

Author: rucoder

.gitignore

@@ -12,3 +12,9 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+# OVMF build artifacts, logs and QEMU VM directory
+/ovmf-no-nvme
+/vm
+debug.log
+

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "cSpell.words": [
+        "uefi"
+    ]
+}

Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "jumpstart"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+log = "0.4.20"
+uefi = { version = "0.26.0", features = ["alloc", "global_allocator"] }
+uefi-services = "0.23.0"

Dockerfile

@@ -0,0 +1,48 @@
+FROM ubuntu:22.04 as base-build
+
+RUN apt-get update && apt-get install -y \
+    build-essential \
+    git \
+    nasm \
+    python3 \
+    python3-pip \
+    uuid-dev \
+    iasl
+
+# make a link to python3
+RUN ln -s /usr/bin/python3 /usr/bin/python
+
+ADD --keep-git-dir=true https://github.com/tianocore/edk2.git#edk2-stable202402 /edk2
+
+WORKDIR /edk2
+
+RUN git submodule update --init --recursive
+
+RUN make -j $(nproc) -C BaseTools
+
+FROM base-build as build-ovmf
+WORKDIR /edk2
+RUN bash -c "source edksetup.sh; build -n $(nproc) -b RELEASE -a X64 -t GCC5 -p OvmfPkg/OvmfPkgX64.dsc"
+
+FROM base-build as build-ovmf-no-nvme
+WORKDIR /edk2
+# disable NVME support
+RUN sed -i 's/.*NvmExpressDxe.*/# disable NVME/' OvmfPkg/OvmfPkgX64.dsc && \
+    sed -i 's/.*NvmExpressDxe.*/# disable NVME/' OvmfPkg/OvmfPkgX64.fdf
+RUN bash -c "source edksetup.sh; build -n $(nproc) -b RELEASE -a X64 -t GCC5 -p OvmfPkg/OvmfPkgX64.dsc"
+
+FROM base-build as build-shell
+WORKDIR /edk2
+RUN bash -c "source edksetup.sh; build -n $(nproc) -b RELEASE -a X64 -t GCC5 -p ShellPkg/ShellPkg.dsc"
+
+FROM scratch as ovmf
+# get NVME DXE driver
+COPY --from=build-ovmf /edk2/Build/OvmfX64/RELEASE_GCC5/X64/NvmExpressDxe.efi /NvmExpressDxe.efi
+# get OVMF firmware without NVME support
+COPY --from=build-ovmf-no-nvme /edk2/Build/OvmfX64/RELEASE_GCC5/FV/OVMF.fd /OVMF_no_nvme.fd
+COPY --from=build-ovmf-no-nvme /edk2/Build/OvmfX64/RELEASE_GCC5/FV/OVMF_VARS.fd /OVMF_VARS_no_nvme.fd
+COPY --from=build-ovmf-no-nvme /edk2/Build/OvmfX64/RELEASE_GCC5/FV/OVMF_CODE.fd /OVMF_CODE_no_nvme.fd
+# get shell
+COPY --from=build-shell /edk2/Build/Shell/RELEASE_GCC5/X64/ShellPkg/Application/Shell/Shell/OUTPUT/Shell.efi /shellx64.efi
+
+

Makefile

@@ -0,0 +1,68 @@
+TARGET ?= release
+
+OVMF_DIR = ./ovmf-no-nvme
+OVMF_FILES = \
+	./$(OVMF_DIR)/OVMF_CODE_no_nvme.fd \
+	./$(OVMF_DIR)/OVMF_VARS_no_nvme.fd \
+	./$(OVMF_DIR)/OVMF_no_nvme.fd \
+	./$(OVMF_DIR)/NvmExpressDxe.efi \
+	./$(OVMF_DIR)/shellx64.efi
+
+ESP_DIR = ./vm/esp
+NVME_DIR = ./vm/nvme
+
+BOOT_FILES = \
+	$(ESP_DIR)/EFI/BOOT/BOOTX64.efi \
+	$(ESP_DIR)/EFI/BOOT/JS/DRIVERS/NvmExpressDxe.efi
+
+ifeq ($(TARGET),debug)
+	BOOT_FILES += $(ESP_DIR)/EFI/BOOT/shellx64.efi
+endif
+
+BOOTLOADER = ./target/x86_64-unknown-uefi/$(TARGET)/jumpstart.efi
+
+.PHONY: all
+all: run
+
+.PHONY: ovmf
+ovmf: $(OVMF_FILES)
+$(OVMF_FILES): Dockerfile
+	docker buildx build  -o type=local,dest=$(OVMF_DIR) .
+
+.PHONY: vm-dir
+vm-dir: $(BOOT_FILES)
+$(BOOT_FILES): jumpstart_$(TARGET) ovmf
+	mkdir -p $(ESP_DIR)/EFI/BOOT/JS/DRIVERS
+	mkdir -p $(NVME_DIR)
+	touch $(NVME_DIR)/nvme-dummy.txt
+	cp $(OVMF_DIR)/NvmExpressDxe.efi $(ESP_DIR)/EFI/BOOT/JS/DRIVERS
+	cp $(BOOTLOADER) $(ESP_DIR)/EFI/BOOT/BOOTX64.efi
+# copy UEFI Shell to the ESP only for debug target
+ifeq ($(TARGET),debug)
+	cp $(OVMF_DIR)/shellx64.efi $(ESP_DIR)/EFI/BOOT
+endif
+
+.PHONY: jumpstart_debug jumpstart_release
+jumpstart_$(TARGET): $(BOOTLOADER)
+
+jumpstart_debug: CARGO_TARGET:=
+jumpstart_release: CARGO_TARGET:=--release
+
+$(BOOTLOADER):
+	cargo build --target=x86_64-unknown-uefi $(CARGO_TARGET)
+
+.PHONY: run
+run: vm-dir
+	qemu-system-x86_64 -enable-kvm -serial stdio \
+	-debugcon file:debug.log -global isa-debugcon.iobase=0x402 \
+    -drive if=pflash,format=raw,readonly=on,file=./$(OVMF_DIR)/OVMF_CODE_no_nvme.fd \
+    -drive if=pflash,format=raw,readonly=on,file=./$(OVMF_DIR)/OVMF_VARS_no_nvme.fd \
+	-drive format=raw,file=fat:rw:$(NVME_DIR),if=none,id=nvm \
+	-device nvme,serial=deadbeef,drive=nvm \
+    -drive format=raw,file=fat:rw:$(ESP_DIR)
+
+.PHONY: clean
+clean:
+	rm -rf $(OVMF_DIR)
+	rm -rf ./vm
+	rm debug.log

rust-toolchain.toml

@@ -0,0 +1,2 @@
+[toolchain]
+targets = ["x86_64-unknown-uefi"]

src/main.rs

@@ -0,0 +1,74 @@
+#![no_main]
+#![no_std]
+
+use log::info;
+use uefi::prelude::*;
+use uefi::proto::device_path::text::{AllowShortcuts, DevicePathToText, DisplayOnly, PoolString};
+use uefi::proto::loaded_image::LoadedImage;
+use uefi::table::boot::SearchType;
+use uefi::{Identify, Result};
+
+// Print the file path to the _image_handle
+fn print_image_path(boot_services: &BootServices) -> Result {
+    let loaded_image =
+        boot_services.open_protocol_exclusive::<LoadedImage>(boot_services.image_handle())?;
+
+    let device_path_to_text_handle = *boot_services
+        .locate_handle_buffer(SearchType::ByProtocol(&DevicePathToText::GUID))?
+        .first()
+        .expect("DevicePathToText is missing");
+
+    let device_path_to_text =
+        boot_services.open_protocol_exclusive::<DevicePathToText>(device_path_to_text_handle)?;
+
+    let image_device_path = loaded_image.file_path().expect("File path is not set");
+    let image_device_path_text = device_path_to_text
+        .convert_device_path_to_text(
+            boot_services,
+            image_device_path,
+            DisplayOnly(true),
+            AllowShortcuts(false),
+        )
+        .expect("convert_device_path_to_text failed");
+
+    info!("Image path: {}", &*image_device_path_text);
+    Ok(())
+}
+
+// get the file path of the image handle
+fn get_image_path(boot_services: &BootServices) -> Result<PoolString> {
+    let loaded_image =
+        boot_services.open_protocol_exclusive::<LoadedImage>(boot_services.image_handle())?;
+
+    let device_path_to_text_handle = *boot_services
+        .locate_handle_buffer(SearchType::ByProtocol(&DevicePathToText::GUID))?
+        .first()
+        .expect("DevicePathToText is missing");
+
+    let device_path_to_text =
+        boot_services.open_protocol_exclusive::<DevicePathToText>(device_path_to_text_handle)?;
+
+    let image_device_path = loaded_image.file_path().expect("File path is not set");
+    let image_device_path_text = device_path_to_text
+        .convert_device_path_to_text(
+            boot_services,
+            image_device_path,
+            DisplayOnly(true),
+            AllowShortcuts(false),
+        )
+        .expect("convert_device_path_to_text failed");
+
+    Ok(image_device_path_text.into())
+}
+
+// The entry point for this UEFI application
+#[entry]
+fn main(_image_handle: Handle, mut system_table: SystemTable<Boot>) -> Status {
+    uefi_services::init(&mut system_table).unwrap();
+    let boot_services = system_table.boot_services();
+
+    print_image_path(boot_services).unwrap();
+
+    boot_services.stall(10_000_000);
+    Status::SUCCESS
+}