1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! UEFI Memory Allocators
//!
//! This module provides a memory allocator that integrates with the UEFI pool
//! allocator. It exports an `Allocator` type that wraps a System-Table
//! together with a UEFI memory type and forwards memory requests to the UEFI
//! pool allocator.
//!
//! The allocator implements the `core::alloc::Allocator` API defined by the
//! rust standard library. Furthermore, as an alternative to this unstable
//! standard library trait, raw alloc and dealloc functions are provided that
//! map to their equivalents from the `raw` module.
//!
//! The `core::alloc::Allocator` trait is only implemented if the
//! `allocator_api` feature is enabled. This requires a nightly / unstable
//! compiler. If the feature is not enabled, only the raw interface is
//! available.

use r_efi::efi;

/// Memory Allocator
///
/// This crate implements a rust memory allocator that forwards requests to the
/// UEFI pool allocator. It takes a System-Table as input, as well as the
/// memory type to use as backing, and then forwards all memory allocation
/// requests to the `AllocatePool()` UEFI system.
///
/// The `core::alloc::Allocator` trait is implemented for this allocator.
/// Hence, this allocator can also be used to back the global memory-allocator
/// of `liballoc` (or `libstd`). See the `Global` type for an implementation of
/// the global allocator, based on this type.
pub struct Allocator {
    system_table: *mut efi::SystemTable,
    memory_type: efi::MemoryType,
}

impl Allocator {
    /// Create Allocator from UEFI System-Table
    ///
    /// This creates a new Allocator object from a UEFI System-Table pointer
    /// and the memory-type to use for allocations. That is, all allocations on
    /// this object will be tunnelled through the `AllocatePool` API on the
    /// given System-Table. Allocations will always use the memory type given
    /// as `memtype`.
    ///
    /// Note that this interface is unsafe, since the caller must guarantee
    /// that the System-Table is valid for as long as the Allocator is.
    /// Furthermore, the caller must guarantee validity of the
    /// system-table-interface. The latter is usually guaranteed by the
    /// provider of the System-Table. The former is usually just a matter of
    /// tearing down the allocator before returning from your application
    /// entry-point.
    pub unsafe fn from_system_table(
        st: *mut efi::SystemTable,
        memtype: efi::MemoryType,
    ) -> Allocator {
        Allocator {
            system_table: st,
            memory_type: memtype,
        }
    }

    /// Allocate Memory from UEFI Boot-Services
    ///
    /// Use the UEFI `allocate_pool` boot-services to request a block of memory
    /// satisfying the given memory layout. The memory type tied to this
    /// allocator object is used.
    ///
    /// This returns a null-pointer if the allocator could not serve the
    /// request (which on UEFI implies out-of-memory). Otherwise, a non-null
    /// pointer to the aligned block is returned.
    ///
    /// Safety
    /// ------
    ///
    /// To ensure safety of this interface, the caller must guarantee:
    ///
    ///  * The allocation size must not be 0. The function will panic
    ///    otherwise.
    ///
    ///  * The returned pointer is not necessarily the same pointer as returned
    ///    by `allocate_pool` of the boot-services. A caller must not assume
    ///    this when forwarding the pointer to other allocation services
    ///    outside of this module.
    pub unsafe fn alloc(&self, layout: core::alloc::Layout) -> *mut u8 {
        crate::raw::alloc(self.system_table, layout, self.memory_type)
    }

    /// Deallocate Memory from UEFI Boot-Services
    ///
    /// Use the UEFI `free_pool` boot-services to release a block of memory
    /// previously allocated through `alloc()`.
    ///
    /// Safety
    /// ------
    ///
    /// To ensure safety of this interface, the caller must guarantee:
    ///
    ///  * The memory block must be the same as previously returned by a call
    ///    to `alloc()`. Every memory block must be released exactly once.
    ///
    ///  * The passed layout must match the layout used to allocate the memory
    ///    block.
    pub unsafe fn dealloc(&self, ptr: *mut u8, layout: core::alloc::Layout) {
        crate::raw::dealloc(self.system_table, ptr, layout)
    }
}

#[cfg(feature = "allocator_api")]
unsafe impl core::alloc::Allocator for Allocator {
    fn allocate(
        &self,
        layout: core::alloc::Layout,
    ) -> Result<core::ptr::NonNull<[u8]>, core::alloc::AllocError> {
        let size = layout.size();

        let ptr = if size > 0 {
            unsafe {
                crate::raw::alloc(self.system_table, layout, self.memory_type)
            }
        } else {
            layout.dangling().as_ptr() as *mut _
        };

        if ptr.is_null() {
            Err(core::alloc::AllocError)
        } else {
            Ok(
                core::ptr::NonNull::new(
                    core::ptr::slice_from_raw_parts(ptr, size) as *mut _,
                ).unwrap(),
            )
        }
    }

    unsafe fn deallocate(
        &self,
        ptr: core::ptr::NonNull<u8>,
        layout: core::alloc::Layout,
    ) {
        if layout.size() != 0 {
            crate::raw::dealloc(self.system_table, ptr.as_ptr(), layout)
        }
    }
}