efi: Add GlobalAlloc for heap allocation support

Rust requires GlobalAlloc implementation to use heap allocated standard
library features. This firmware already has a dedicated page allocator
for EFI, but not implemented to satisfy GlobalAlloc trait bounds. This
commit introduces GlobalAlloc using linked_list_allocator crate. The
page allocator allocates 256 MiB for the heap allocator during the
initialization.

Signed-off-by: Akira Moroo <retrage01@gmail.com>

Author: retrage

.travis.yml

@@ -20,9 +20,9 @@ install:
   - ./make-test-disks.sh
 
 script:
-  - cargo build --target target.json -Zbuild-std=core -Zbuild-std-features=compiler-builtins-mem
-  - cargo build --release --target target.json -Zbuild-std=core -Zbuild-std-features=compiler-builtins-mem
-  - cargo clippy --target target.json -Zbuild-std=core
+  - cargo build --target target.json -Zbuild-std=core,alloc -Zbuild-std-features=compiler-builtins-mem
+  - cargo build --release --target target.json -Zbuild-std=core,alloc -Zbuild-std-features=compiler-builtins-mem
+  - cargo clippy --target target.json -Zbuild-std=core,alloc
   - cargo clippy --all-targets --all-features
   - cargo fmt --all -- --check
   - cargo test

Cargo.lock

@@ -30,6 +30,7 @@ x86_64 = "0.13.1"
 atomic_refcell = "0.1"
 r-efi = "3.2.0"
 uart_16550 = "0.2.10"
+linked_list_allocator = "0.8.11"
 
 [dev-dependencies]
 rand = "0.8.2"

Cargo.toml

@@ -24,7 +24,7 @@ all the way into the OS.
 
 To compile:
 
-cargo build --release --target target.json -Zbuild-std=core -Zbuild-std-features=compiler-builtins-mem
+cargo build --release --target target.json -Zbuild-std=core,alloc -Zbuild-std-features=compiler-builtins-mem
 
 The result will be in:
 

README.md

@@ -4,7 +4,7 @@ set -xeuf
 source "${CARGO_HOME:-$HOME/.cargo}/env"
 
 rustup component add rust-src
-cargo build --release --target target.json -Zbuild-std=core -Zbuild-std-features=compiler-builtins-mem --features "coreboot"
+cargo build --release --target target.json -Zbuild-std=core,alloc -Zbuild-std-features=compiler-builtins-mem --features "coreboot"
 
 FW_BIN="$(pwd)/target/target/release/hypervisor-fw"
 

run_coreboot_integration_tests.sh

@@ -4,7 +4,7 @@ set -xeuf
 source "${CARGO_HOME:-$HOME/.cargo}/env"
 
 rustup component add rust-src
-cargo build --release --target target.json -Zbuild-std=core -Zbuild-std-features=compiler-builtins-mem
+cargo build --release --target target.json -Zbuild-std=core,alloc -Zbuild-std-features=compiler-builtins-mem
 
 CH_VERSION="v0.8.0"
 CH_URL="https://github.com/cloud-hypervisor/cloud-hypervisor/releases/download/$CH_VERSION/cloud-hypervisor"

run_integration_tests.sh

@@ -12,9 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use core::{ffi::c_void, mem::transmute};
+use core::{alloc as heap_alloc, ffi::c_void, mem::transmute};
 
 use atomic_refcell::AtomicRefCell;
+use linked_list_allocator::LockedHeap;
 use r_efi::{
     efi::{
         self, AllocateType, Boolean, CapsuleHeader, Char16, Event, EventNotify, Guid, Handle,
@@ -52,6 +53,16 @@ struct HandleWrapper {
 
 pub static ALLOCATOR: AtomicRefCell<Allocator> = AtomicRefCell::new(Allocator::new());
 
+#[cfg(not(test))]
+#[global_allocator]
+pub static HEAP_ALLOCATOR: LockedHeap = LockedHeap::empty();
+
+#[cfg(not(test))]
+#[alloc_error_handler]
+fn heap_alloc_error_handler(layout: heap_alloc::Layout) -> ! {
+    panic!("heap allocation error: {:?}", layout);
+}
+
 static mut RS: efi::RuntimeServices = efi::RuntimeServices {
     hdr: efi::TableHeader {
         signature: efi::RUNTIME_SERVICES_SIGNATURE,
@@ -722,6 +733,7 @@ extern "win64" fn image_unload(_: Handle) -> Status {
 }
 
 const PAGE_SIZE: u64 = 4096;
+const HEAP_SIZE: usize = 256 * 1024 * 1024;
 
 // Populate allocator from E820, fixed ranges for the firmware and the loaded binary.
 fn populate_allocator(info: &dyn boot::Info, image_address: u64, image_size: u64) {
@@ -752,8 +764,28 @@ fn populate_allocator(info: &dyn boot::Info, image_address: u64, image_size: u64
         image_size / PAGE_SIZE,
         image_address,
     );
+
+    // Initialize heap allocator
+    init_heap_allocator(HEAP_SIZE);
+}
+
+#[cfg(not(test))]
+fn init_heap_allocator(size: usize) {
+    let (status, heap_start) = ALLOCATOR.borrow_mut().allocate_pages(
+        AllocateType::AllocateAnyPages,
+        MemoryType::BootServicesCode,
+        size as u64 / PAGE_SIZE,
+        0,
+    );
+    assert!(status == Status::SUCCESS);
+    unsafe {
+        HEAP_ALLOCATOR.lock().init(heap_start as usize, size);
+    }
 }
 
+#[cfg(test)]
+fn init_heap_allocator(_: usize) {}
+
 #[repr(C)]
 struct LoadedImageWrapper {
     hw: HandleWrapper,

src/efi/mod.rs

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#![feature(alloc_error_handler)]
 #![feature(global_asm, const_in_array_repeat_expressions)]
 #![cfg_attr(not(test), no_std)]
 #![cfg_attr(not(test), no_main)]