pub enum MemoryRegionType {
+MemoryRegionType in frame_allocator - Rust pub enum MemoryRegionType {
Free,
Reserved,
Unknown,
@@ -10,9 +10,9 @@
§Unknown
Memory of an unknown type.
This is a default value that acts as a sanity check, because it is invalid
to do any real work (e.g., allocation, access) with an unknown memory region.
-source. Read moreself and other values to be equal, and is used
+source. Read moreself and other values to be equal, and is used
by ==.Returns the argument unchanged.
diff --git a/doc/frame_allocator/fn.allocate_frames.html b/doc/frame_allocator/fn.allocate_frames.html index 6836fdff83..94d95aceee 100644 --- a/doc/frame_allocator/fn.allocate_frames.html +++ b/doc/frame_allocator/fn.allocate_frames.html @@ -1,3 +1,3 @@ -pub fn allocate_frames(num_frames: usize) -> Option<AllocatedFrames>Allocates the given number of frames with no constraints on the starting physical address.
+pub fn allocate_frames(num_frames: usize) -> Option<AllocatedFrames>Allocates the given number of frames with no constraints on the starting physical address.
See allocate_frames_deferred() for more details.
pub fn allocate_frames_at(
+allocate_frames_at in frame_allocator - Rust Function frame_allocator::allocate_frames_at
source · pub fn allocate_frames_at(
paddr: PhysicalAddress,
num_frames: usize
-) -> Result<AllocatedFrames, &'static str>
Expand description
Allocates the given number of frames starting at (inclusive of) the frame containing the given PhysicalAddress.
+) -> Result<AllocatedFrames, &'static str>Expand description
Allocates the given number of frames starting at (inclusive of) the frame containing the given PhysicalAddress.
See allocate_frames_deferred() for more details.
\ No newline at end of file
diff --git a/doc/frame_allocator/fn.allocate_frames_by_bytes.html b/doc/frame_allocator/fn.allocate_frames_by_bytes.html
index ff7432b795..0625737e39 100644
--- a/doc/frame_allocator/fn.allocate_frames_by_bytes.html
+++ b/doc/frame_allocator/fn.allocate_frames_by_bytes.html
@@ -1,4 +1,4 @@
-allocate_frames_by_bytes in frame_allocator - Rust Function frame_allocator::allocate_frames_by_bytes
source · pub fn allocate_frames_by_bytes(num_bytes: usize) -> Option<AllocatedFrames>
Expand description
Allocates frames with no constraints on the starting physical address,
+
allocate_frames_by_bytes in frame_allocator - Rust Function frame_allocator::allocate_frames_by_bytes
source · pub fn allocate_frames_by_bytes(num_bytes: usize) -> Option<AllocatedFrames>
Expand description
Allocates frames with no constraints on the starting physical address,
with a size given by the number of bytes.
This function still allocates whole frames by rounding up the number of bytes.
See allocate_frames_deferred() for more details.
diff --git a/doc/frame_allocator/fn.allocate_frames_by_bytes_at.html b/doc/frame_allocator/fn.allocate_frames_by_bytes_at.html
index 34cd5ecdf5..727af2c307 100644
--- a/doc/frame_allocator/fn.allocate_frames_by_bytes_at.html
+++ b/doc/frame_allocator/fn.allocate_frames_by_bytes_at.html
@@ -1,7 +1,7 @@
-allocate_frames_by_bytes_at in frame_allocator - Rust Function frame_allocator::allocate_frames_by_bytes_at
source · pub fn allocate_frames_by_bytes_at(
+allocate_frames_by_bytes_at in frame_allocator - Rust Function frame_allocator::allocate_frames_by_bytes_at
source · pub fn allocate_frames_by_bytes_at(
paddr: PhysicalAddress,
num_bytes: usize
-) -> Result<AllocatedFrames, &'static str>
Expand description
Allocates frames starting at the given PhysicalAddress with a size given in number of bytes.
+) -> Result<AllocatedFrames, &'static str>Expand description
Allocates frames starting at the given PhysicalAddress with a size given in number of bytes.
This function still allocates whole frames by rounding up the number of bytes.
See allocate_frames_deferred() for more details.
\ No newline at end of file
diff --git a/doc/frame_allocator/fn.allocate_frames_by_bytes_deferred.html b/doc/frame_allocator/fn.allocate_frames_by_bytes_deferred.html
index 8e64591405..b5e816fbdc 100644
--- a/doc/frame_allocator/fn.allocate_frames_by_bytes_deferred.html
+++ b/doc/frame_allocator/fn.allocate_frames_by_bytes_deferred.html
@@ -1,7 +1,7 @@
-allocate_frames_by_bytes_deferred in frame_allocator - Rust pub fn allocate_frames_by_bytes_deferred(
+allocate_frames_by_bytes_deferred in frame_allocator - Rust pub fn allocate_frames_by_bytes_deferred(
requested_paddr: Option<PhysicalAddress>,
num_bytes: usize
-) -> Result<(AllocatedFrames, DeferredAllocAction<'static>), &'static str>
Expand description
Similar to allocated_frames_deferred(),
+) -> Result<(AllocatedFrames, DeferredAllocAction<'static>), &'static str>Expand description
Similar to allocated_frames_deferred(),
but accepts a size value for the allocated frames in number of bytes instead of number of frames.
This function still allocates whole frames by rounding up the number of bytes.
\ No newline at end of file
diff --git a/doc/frame_allocator/fn.allocate_frames_deferred.html b/doc/frame_allocator/fn.allocate_frames_deferred.html
index 38050ccfbc..08bbca10e2 100644
--- a/doc/frame_allocator/fn.allocate_frames_deferred.html
+++ b/doc/frame_allocator/fn.allocate_frames_deferred.html
@@ -1,7 +1,7 @@
-allocate_frames_deferred in frame_allocator - Rust Function frame_allocator::allocate_frames_deferred
source · pub fn allocate_frames_deferred(
+allocate_frames_deferred in frame_allocator - Rust Function frame_allocator::allocate_frames_deferred
source · pub fn allocate_frames_deferred(
requested_paddr: Option<PhysicalAddress>,
num_frames: usize
-) -> Result<(AllocatedFrames, DeferredAllocAction<'static>), &'static str>
Expand description
The core frame allocation routine that allocates the given number of physical frames,
+) -> Result<(AllocatedFrames, DeferredAllocAction<'static>), &'static str>Expand description
The core frame allocation routine that allocates the given number of physical frames,
optionally at the requested starting PhysicalAddress.
This simply reserves a range of frames; it does not perform any memory mapping.
Thus, the memory represented by the returned AllocatedFrames isn’t directly accessible
diff --git a/doc/frame_allocator/fn.init.html b/doc/frame_allocator/fn.init.html
index 42febf57db..d2e0bc28b1 100644
--- a/doc/frame_allocator/fn.init.html
+++ b/doc/frame_allocator/fn.init.html
@@ -1,7 +1,7 @@
-
init in frame_allocator - Rust Function frame_allocator::init
source · pub fn init<F, R, P>(
+init in frame_allocator - Rust Function frame_allocator::init
source · pub fn init<F, R, P>(
free_physical_memory_areas: F,
reserved_physical_memory_areas: R
-) -> Result<fn(_: FrameRange) -> AllocatedFrames, &'static str>where
+) -> Result<fn(_: FrameRange) -> UnmappedFrames, &'static str>where
P: Borrow<PhysicalMemoryRegion>,
F: IntoIterator<Item = P>,
R: IntoIterator<Item = P> + Clone,
Expand description
Initialize the frame allocator with the given list of available and reserved physical memory regions.
@@ -13,5 +13,5 @@
Return
Upon success, this function returns a callback function that allows the caller
(the memory subsystem init function) to convert a range of unmapped frames
-back into an AllocatedFrames object.
+back into an UnmappedFrames object.
frame_allocator - Rust Crate frame_allocator
source · Expand description
Provides an allocator for physical memory frames.
+
frame_allocator - Rust Crate frame_allocator
source · Expand description
Provides an allocator for physical memory frames.
The minimum unit of allocation is a single frame.
This is currently a modified and more complex version of the page_allocator crate.
TODO: extract the common code and create a generic allocator that can be specialized to allocate pages or frames.
@@ -9,11 +9,13 @@
The core allocation function is allocate_frames_deferred(),
but there are several convenience functions that offer simpler interfaces for general usage.
Notes and Missing Features
-This allocator currently does not merge freed chunks (de-fragmentation).
-We don’t need to do so until we actually run out of address space or until
-a requested address is in a chunk that needs to be merged.
-Structs
- A reference to a single frame within a range of
AllocatedFrames. - Represents a range of allocated physical memory [
Frame]s; derefs to [FrameRange]. - An iterator over each
AllocatedFrame in a range of AllocatedFrames. - A series of pending actions related to frame allocator bookkeeping,
-which may result in heap allocation.
- A region of physical memory.
Enums
- Types of physical memory. See each variant’s documentation.
Functions
- Allocates the given number of frames with no constraints on the starting physical address.
- Allocates the given number of frames starting at (inclusive of) the frame containing the given
PhysicalAddress. - Allocates frames with no constraints on the starting physical address,
+
This allocator only makes one attempt to merge deallocated frames into existing
+free chunks for de-fragmentation. It does not iteratively merge adjacent chunks in order to
+maximally combine separate chunks into the biggest single chunk.
+Instead, free chunks are merged only when they are dropped or when needed to fulfill a specific request.
+Structs
- A reference to a single frame within a range of
AllocatedFrames. - An iterator over each
AllocatedFrame in a range of AllocatedFrames. - A series of pending actions related to frame allocator bookkeeping,
+which may result in heap allocation.
- A range of contiguous frames in physical memory.
PhysicalMemoryRegion represents a range of contiguous frames in physical memory for bookkeeping purposes.
+It does not give access to the underlying frames.- The result of splitting a
Frames object into multiple smaller Frames objects.
Enums
- Types of physical memory. See each variant’s documentation.
Functions
- Allocates the given number of frames with no constraints on the starting physical address.
- Allocates the given number of frames starting at (inclusive of) the frame containing the given
PhysicalAddress. - Allocates frames with no constraints on the starting physical address,
with a size given by the number of bytes.
- Allocates frames starting at the given
PhysicalAddress with a size given in number of bytes. - Similar to
allocated_frames_deferred(),
but accepts a size value for the allocated frames in number of bytes instead of number of frames. - The core frame allocation routine that allocates the given number of physical frames,
-optionally at the requested starting
PhysicalAddress. - Initialize the frame allocator with the given list of available and reserved physical memory regions.
PhysicalAddress.Initialize the frame allocator with the given list of available and reserved physical memory regions. Type Definitions
- A type alias for
Frames in the Allocated state. - A type alias for
Frames in the Free state. - A type alias for
Frames in the Mapped state. - A type alias for
Frames in the Unmapped state.
AllocatedFrame in frame_allocator - Rust Struct frame_allocator::AllocatedFrame
source · pub struct AllocatedFrame<'f> { /* private fields */ }
Expand description
A reference to a single frame within a range of AllocatedFrames.
+AllocatedFrame in frame_allocator - Rust Struct frame_allocator::AllocatedFrame
source · pub struct AllocatedFrame<'f> { /* private fields */ }
Expand description
A reference to a single frame within a range of AllocatedFrames.
The lifetime of this type is tied to the lifetime of its owning AllocatedFrames.
Methods from Deref<Target = Frame>§
pub fn start_address(&self) -> PhysicalAddress
Returns the PhysicalAddress at the start of this Frame.
Trait Implementations§
source§impl<'f> Debug for AllocatedFrame<'f>
Auto Trait Implementations§
§impl<'f> RefUnwindSafe for AllocatedFrame<'f>
§impl<'f> Send for AllocatedFrame<'f>
§impl<'f> Sync for AllocatedFrame<'f>
§impl<'f> Unpin for AllocatedFrame<'f>
§impl<'f> UnwindSafe for AllocatedFrame<'f>
Blanket Implementations§
Trait Implementations§
source§impl<'f> Debug for AllocatedFrame<'f>
Auto Trait Implementations§
§impl<'f> RefUnwindSafe for AllocatedFrame<'f>
§impl<'f> Send for AllocatedFrame<'f>
§impl<'f> Sync for AllocatedFrame<'f>
§impl<'f> Unpin for AllocatedFrame<'f>
§impl<'f> UnwindSafe for AllocatedFrame<'f>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/doc/frame_allocator/struct.AllocatedFrames.html b/doc/frame_allocator/struct.AllocatedFrames.html
deleted file mode 100644
index 6303acef08..0000000000
--- a/doc/frame_allocator/struct.AllocatedFrames.html
+++ /dev/null
@@ -1,67 +0,0 @@
-AllocatedFrames in frame_allocator - Rust Struct frame_allocator::AllocatedFrames
source · pub struct AllocatedFrames { /* private fields */ }
Expand description
Represents a range of allocated physical memory [Frame]s; derefs to [FrameRange].
-These frames are not immediately accessible because they’re not yet mapped
-by any virtual memory pages.
-You must do that separately in order to create a MappedPages type,
-which can then be used to access the contents of these frames.
-This object represents ownership of the range of allocated physical frames;
-if this object falls out of scope, its allocated frames will be auto-deallocated upon drop.
-Implementations§
source§impl AllocatedFrames
sourcepub const fn empty() -> AllocatedFrames
Returns an empty AllocatedFrames object that performs no frame allocation.
-Can be used as a placeholder, but will not permit any real usage.
-sourcepub fn merge(&mut self, other: AllocatedFrames) -> Result<(), AllocatedFrames>
Merges the given AllocatedFrames object other into this AllocatedFrames object (self).
-This is just for convenience and usability purposes, it performs no allocation or remapping.
-The given other must be physically contiguous with self, i.e., come immediately before or after self.
-That is, either self.start == other.end + 1 or self.end + 1 == other.start must be true.
-If either of those conditions are met, self is modified and Ok(()) is returned,
-otherwise Err(other) is returned.
-sourcepub fn split(
- self,
- at_frame: Frame
-) -> Result<(AllocatedFrames, AllocatedFrames), AllocatedFrames>
Splits this AllocatedFrames into two separate AllocatedFrames objects:
-
-[beginning : at_frame - 1][at_frame : end]
-This function follows the behavior of core::slice::split_at(),
-thus, either one of the returned AllocatedFrames objects may be empty.
-
-- If
at_frame == self.start, the first returned AllocatedFrames object will be empty.
-- If
at_frame == self.end + 1, the second returned AllocatedFrames object will be empty.
-
-Returns an Err containing this AllocatedFrames if at_frame is otherwise out of bounds.
-sourcepub fn as_allocated_frame(&self) -> AllocatedFrame<'_>
Returns an AllocatedFrame if this AllocatedFrames object contains only one frame.
-Panic
-Panics if this AllocatedFrame contains multiple frames or zero frames.
-Methods from Deref<Target = FrameRange>§
pub fn start_address(&self) -> PhysicalAddress
Returns the [PhysicalAddress] of the starting [Frame] in this FrameRange.
-pub fn size_in_frames(&self) -> usize
Returns the number of [Frame]s covered by this iterator.
-Use this instead of Iterator::count() method. This is instant, because it doesn’t need to iterate over each entry, unlike normal iterators.
-pub fn size_in_bytes(&self) -> usize
Returns the size of this range in number of bytes.
-pub fn contains_address(&self, addr: PhysicalAddress) -> bool
Returns true if this FrameRange contains the given [PhysicalAddress].
-pub fn offset_of_address(&self, addr: PhysicalAddress) -> Option<usize>
Returns the offset of the given [PhysicalAddress] within this FrameRange, i.e., addr - self.start_address().
-If the given addr is not covered by this range of [Frame]s, this returns None.
-Examples
-If the range covers addresses 0x2000 to 0x4000, then offset_of_address(0x3500) would return Some(0x1500).
-pub fn address_at_offset(&self, offset: usize) -> Option<PhysicalAddress>
Returns the [PhysicalAddress] at the given offset into this FrameRangewithin this FrameRange, i.e., self.start_address() + offset.
-If the given offset is not within this range of [Frame]s, this returns None.
-Examples
-If the range covers addresses 0x2000 through 0x3FFF, then address_at_offset(0x1500) would return Some(0x3500), and address_at_offset(0x2000) would return None.
-pub fn to_extended(&self, to_include: Frame) -> FrameRange
Returns a new separate FrameRange that is extended to include the given [Frame].
-Methods from Deref<Target = RangeInclusive<Frame>>§
sourcepub fn iter(&self) -> RangeInclusiveIterator<Idx>
Returns an iterator with the same start and end values as the range.
-sourcepub fn contains<U>(&self, item: &U) -> boolwhere
- Idx: PartialOrd<U>,
- U: PartialOrd<Idx> + ?Sized,
Returns true if item is contained in the range.
-Trait Implementations§
source§impl Debug for AllocatedFrames
source§impl Deref for AllocatedFrames
source§impl Drop for AllocatedFrames
source§impl<'f> IntoIterator for &'f AllocatedFrames
Auto Trait Implementations§
§impl RefUnwindSafe for AllocatedFrames
§impl Send for AllocatedFrames
§impl Sync for AllocatedFrames
§impl Unpin for AllocatedFrames
§impl UnwindSafe for AllocatedFrames
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreAllocatedFramesIter in frame_allocator - Rust Struct frame_allocator::AllocatedFramesIter
source · pub struct AllocatedFramesIter<'f> { /* private fields */ }
Expand description
An iterator over each AllocatedFrame in a range of AllocatedFrames.
+AllocatedFramesIter in frame_allocator - Rust Struct frame_allocator::AllocatedFramesIter
source · pub struct AllocatedFramesIter<'f> { /* private fields */ }
Expand description
An iterator over each AllocatedFrame in a range of AllocatedFrames.
We must implement our own iterator type here in order to tie the lifetime 'f
of a returned AllocatedFrame<'f> type to the lifetime of its containing AllocatedFrames.
This is because the underlying type of AllocatedFrames is a [FrameRange],
which itself is a RangeInclusive of [Frame]s.
-Currently, the RangeInclusiveIterator type creates a clone of the original
+Currently, the [RangeInclusiveIterator] type creates a clone of the original
RangeInclusive instances rather than borrowing a reference to it.
-Trait Implementations§
source§impl<'f> Iterator for AllocatedFramesIter<'f>
Trait Implementations§
source§impl<'f> Iterator for AllocatedFramesIter<'f>
§type Item = AllocatedFrame<'f>
The type of the elements being iterated over.source§fn next(&mut self) -> Option<Self::Item>
Advances the iterator and returns the next value. Read moresource§fn next_chunk<const N: usize>(
&mut self
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,
🔬This is a nightly-only experimental API. (iter_next_chunk)Advances the iterator and returns an array containing the next N values. Read more1.0.0 · source§fn size_hint(&self) -> (usize, Option<usize>)
Returns the bounds on the remaining length of the iterator. Read more1.0.0 · source§fn count(self) -> usizewhere
diff --git a/doc/frame_allocator/struct.DeferredAllocAction.html b/doc/frame_allocator/struct.DeferredAllocAction.html
index 466debb55d..1ff3b1a59c 100644
--- a/doc/frame_allocator/struct.DeferredAllocAction.html
+++ b/doc/frame_allocator/struct.DeferredAllocAction.html
@@ -1,4 +1,4 @@
-DeferredAllocAction in frame_allocator - Rust Struct frame_allocator::DeferredAllocAction
source · pub struct DeferredAllocAction<'list> { /* private fields */ }
Expand description
A series of pending actions related to frame allocator bookkeeping,
+
DeferredAllocAction in frame_allocator - Rust Struct frame_allocator::DeferredAllocAction
source · pub struct DeferredAllocAction<'list> { /* private fields */ }
Expand description
A series of pending actions related to frame allocator bookkeeping,
which may result in heap allocation.
The actions are triggered upon dropping this struct.
This struct can be returned from the allocate_frames() family of functions
@@ -8,7 +8,7 @@
The vast majority of use cases don’t care about such precise control,
so you can simply drop this struct at any time or ignore it
with a let _ = ... binding to instantly drop it.
-Trait Implementations§
Auto Trait Implementations§
§impl<'list> !RefUnwindSafe for DeferredAllocAction<'list>
§impl<'list> Send for DeferredAllocAction<'list>
§impl<'list> Sync for DeferredAllocAction<'list>
§impl<'list> Unpin for DeferredAllocAction<'list>
§impl<'list> !UnwindSafe for DeferredAllocAction<'list>
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl<'list> !RefUnwindSafe for DeferredAllocAction<'list>
§impl<'list> Send for DeferredAllocAction<'list>
§impl<'list> Sync for DeferredAllocAction<'list>
§impl<'list> Unpin for DeferredAllocAction<'list>
§impl<'list> !UnwindSafe for DeferredAllocAction<'list>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/doc/frame_allocator/struct.Frames.html b/doc/frame_allocator/struct.Frames.html
new file mode 100644
index 0000000000..c45c61e43a
--- /dev/null
+++ b/doc/frame_allocator/struct.Frames.html
@@ -0,0 +1,114 @@
+Frames in frame_allocator - Rust Struct frame_allocator::Frames
source · pub struct Frames<const S: MemoryState> { /* private fields */ }
Expand description
A range of contiguous frames in physical memory.
+Each Frames object is globally unique, meaning that the owner of a Frames object
+has globally-exclusive access to the range of frames it contains.
+A Frames object can be in one of four states:
+
+Free: frames are owned by the frame allocator and have not been allocated for any use.Allocated: frames have been removed from the allocator’s free list and are owned elsewhere;
+they can now be used for mapping purposes.Mapped: frames have been (and are currently) mapped by a range of virtual memory pages.Unmapped: frames have been unmapped and can be returned to the frame allocator.
+The drop behavior for a Frames object is based on its state:
+
+Free: the frames will be added back to the frame allocator’s free list.Allocated: the frames will be transitioned into the Free state.Unmapped: the frames will be transitioned into the Allocated state.Mapped: currently, Theseus does not actually drop mapped Frames, but rather they are forgotten
+when they are mapped by virtual pages, and then re-created in the Unmapped state
+after being unmapped from the page tables.
+As such, one can visualize the Frames state diagram as such:
+
+(Free) <---> (Allocated) --> (Mapped) --> (Unmapped) --> (Allocated) <---> (Free)
+Ordering and Equality
+Frames implements the Ord trait, and its total ordering is ONLY based on
+its starting Frame. This is useful so we can store Frames in a sorted collection.
+Similarly, Frames implements equality traits, Eq and PartialEq,
+both of which are also based ONLY on the starting Frame of the Frames.
+Thus, comparing two Frames with the == or != operators may not work as expected.
+since it ignores their actual range of frames.
+Similarly, Frames implements the Borrow trait to return a Frame,
+not a FrameRange. This is required so we can search for Frames in a sorted collection
+using a Frame value.
+It differs from the behavior of the Deref trait which returns a FrameRange.
+Implementations§
source§impl Frames<{MemoryState::Free}>
sourcepub fn into_allocated_frames(self) -> AllocatedFrames
Consumes this Frames in the Free state and converts them into the Allocated state.
+source§impl Frames<{MemoryState::Allocated}>
sourcepub fn into_mapped_frames(self) -> MappedFrames
Consumes this Frames in the Allocated state and converts them into the Mapped state.
+This should only be called once a MappedPages has been created from the Frames.
+sourcepub fn as_allocated_frame(&self) -> AllocatedFrame<'_>
Returns an AllocatedFrame if this AllocatedFrames object contains only one frame.
+Panic
+Panics if this AllocatedFrame contains multiple frames or zero frames.
+source§impl Frames<{MemoryState::Unmapped}>
sourcepub fn into_allocated_frames(self) -> AllocatedFrames
Consumes this Frames in the Unmapped state and converts them into the Allocated state.
+source§impl<const S: MemoryState> Frames<S>
sourcepub const fn empty() -> Frames<S>
Returns a new Frames with an empty range of frames.
+Can be used as a placeholder, but will not permit any real usage.
+sourcepub fn merge(&mut self, other: Self) -> Result<(), Self>
Merges the given other Frames object into this Frames object (self).
+This function performs no allocation or re-mapping, it exists for convenience and usability purposes.
+The given other must be physically contiguous with self, i.e., come immediately before or after self.
+That is, either self.start == other.end + 1 or self.end + 1 == other.start must be true.
+If either of those conditions are met, self is modified and Ok(()) is returned,
+otherwise Err(other) is returned.
+sourcepub fn split_range(
+ self,
+ frames_to_extract: FrameRange
+) -> Result<SplitFrames<S>, Self>
Splits up the given Frames into multiple smaller Frames.
+Returns a SplitFrames instance containing three Frames:
+
+- The range of frames in
self that are before the beginning of frames_to_extract.
+- The
Frames containing the requested range of frames, frames_to_extract.
+- The range of frames in
self that are after the end of frames_to_extract.
+
+If frames_to_extract is not contained within self, then self is returned unchanged within an Err.
+sourcepub fn split_at(self, at_frame: Frame) -> Result<(Self, Self), Self>
Splits this Frames into two separate Frames objects:
+
+[beginning : at_frame - 1][at_frame : end]
+This function follows the behavior of core::slice::split_at(),
+thus, either one of the returned Frames objects may be empty.
+
+- If
at_frame == self.start, the first returned Frames object will be empty.
+- If
at_frame == self.end + 1, the second returned Frames object will be empty.
+
+Returns an Err containing this Frames if at_frame is otherwise out of bounds, or if self was empty.
+Methods from Deref<Target = FrameRange>§
pub fn start_address(&self) -> PhysicalAddress
Returns the [PhysicalAddress] of the starting [Frame] in this FrameRange.
+pub fn size_in_frames(&self) -> usize
Returns the number of [Frame]s covered by this iterator.
+Use this instead of Iterator::count() method. This is instant, because it doesn’t need to iterate over each entry, unlike normal iterators.
+pub fn size_in_bytes(&self) -> usize
Returns the size of this range in number of bytes.
+pub fn contains_address(&self, addr: PhysicalAddress) -> bool
Returns true if this FrameRange contains the given [PhysicalAddress].
+pub fn offset_of_address(&self, addr: PhysicalAddress) -> Option<usize>
Returns the offset of the given [PhysicalAddress] within this FrameRange, i.e., addr - self.start_address().
+If the given addr is not covered by this range of [Frame]s, this returns None.
+Examples
+If the range covers addresses 0x2000 to 0x4000, then offset_of_address(0x3500) would return Some(0x1500).
+pub fn address_at_offset(&self, offset: usize) -> Option<PhysicalAddress>
Returns the [PhysicalAddress] at the given offset into this FrameRangewithin this FrameRange, i.e., self.start_address() + offset.
+If the given offset is not within this range of [Frame]s, this returns None.
+Examples
+If the range covers addresses 0x2000 through 0x3FFF, then address_at_offset(0x1500) would return Some(0x3500), and address_at_offset(0x2000) would return None.
+pub fn to_extended(&self, to_include: Frame) -> FrameRange
Returns a new separate FrameRange that is extended to include the given [Frame].
+pub fn overlap(&self, other: &FrameRange) -> Option<FrameRange>
Returns an inclusive FrameRange representing the [Frame]s that overlap across this FrameRange and the given other FrameRange.
+If there is no overlap between the two ranges, None is returned.
+pub fn contains_range(&self, other: &FrameRange) -> bool
Returns true if the other FrameRange is fully contained within this FrameRange.
+Methods from Deref<Target = RangeInclusive<Frame>>§
sourcepub fn iter(&self) -> RangeInclusiveIterator<Idx>
Returns an iterator with the same start and end values as the range.
+sourcepub fn contains<U>(&self, item: &U) -> boolwhere
+ Idx: PartialOrd<U>,
+ U: PartialOrd<Idx> + ?Sized,
Returns true if item is contained in the range.
+Trait Implementations§
source§impl<const S: MemoryState> Ord for Frames<S>
source§impl<const S: MemoryState> PartialEq<Frames<S>> for Frames<S>
source§impl<const S: MemoryState> PartialOrd<Frames<S>> for Frames<S>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
+operator. Read moresource§impl<const S: MemoryState> Eq for Frames<S>
source§impl<const S: MemoryState> StructuralEq for Frames<S>
Auto Trait Implementations§
§impl<const S: MemoryState> RefUnwindSafe for Frames<S>
§impl<const S: MemoryState> Send for Frames<S>
§impl<const S: MemoryState> Sync for Frames<S>
§impl<const S: MemoryState> Unpin for Frames<S>
§impl<const S: MemoryState> UnwindSafe for Frames<S>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read morePhysicalMemoryRegion in frame_allocator - Rust Struct frame_allocator::PhysicalMemoryRegion
source · pub struct PhysicalMemoryRegion {
+PhysicalMemoryRegion in frame_allocator - Rust Struct frame_allocator::PhysicalMemoryRegion
source · pub struct PhysicalMemoryRegion {
pub frames: FrameRange,
pub typ: MemoryRegionType,
-}
Expand description
A region of physical memory.
-Fields§
§frames: FrameRange§typ: MemoryRegionTypeImplementations§
source§impl PhysicalMemoryRegion
sourcepub fn new(frames: FrameRange, typ: MemoryRegionType) -> PhysicalMemoryRegion
Methods from Deref<Target = FrameRange>§
pub fn start_address(&self) -> PhysicalAddress
Returns the [PhysicalAddress] of the starting [Frame] in this FrameRange.
+}Expand description
PhysicalMemoryRegion represents a range of contiguous frames in physical memory for bookkeeping purposes.
+It does not give access to the underlying frames.
+Ordering and Equality
+PhysicalMemoryRegion implements the Ord trait, and its total ordering is ONLY based on
+its starting Frame. This is useful so we can store PhysicalMemoryRegions in a sorted collection.
+Similarly, PhysicalMemoryRegion implements equality traits, Eq and PartialEq,
+both of which are also based ONLY on the starting Frame of the PhysicalMemoryRegion.
+Thus, comparing two PhysicalMemoryRegions with the == or != operators may not work as expected.
+since it ignores their actual range of frames.
+Fields§
§frames: FrameRangeThe Frames covered by this region, an inclusive range.
+§typ: MemoryRegionTypeThe type of this memory region, e.g., whether it’s in a free or reserved region.
+Implementations§
source§impl PhysicalMemoryRegion
sourcepub fn new(frames: FrameRange, typ: MemoryRegionType) -> PhysicalMemoryRegion
Methods from Deref<Target = FrameRange>§
pub fn start_address(&self) -> PhysicalAddress
Returns the [PhysicalAddress] of the starting [Frame] in this FrameRange.
pub fn size_in_frames(&self) -> usize
Returns the number of [Frame]s covered by this iterator.
Use this instead of Iterator::count() method. This is instant, because it doesn’t need to iterate over each entry, unlike normal iterators.
pub fn size_in_bytes(&self) -> usize
Returns the size of this range in number of bytes.
@@ -18,6 +28,7 @@ Examples
pub fn to_extended(&self, to_include: Frame) -> FrameRange
Returns a new separate FrameRange that is extended to include the given [Frame].
pub fn overlap(&self, other: &FrameRange) -> Option<FrameRange>
Returns an inclusive FrameRange representing the [Frame]s that overlap across this FrameRange and the given other FrameRange.
If there is no overlap between the two ranges, None is returned.
+pub fn contains_range(&self, other: &FrameRange) -> bool
Returns true if the other FrameRange is fully contained within this FrameRange.
Methods from Deref<Target = RangeInclusive<Frame>>§
sourcepub fn is_empty(&self) -> bool
Returns true if the range contains no items.
@@ -25,9 +36,16 @@ Examples
sourcepub fn contains<U>(&self, item: &U) -> boolwhere
Idx: PartialOrd<U>,
U: PartialOrd<Idx> + ?Sized,
Returns true if item is contained in the range.
-Trait Implementations§
source§impl Clone for PhysicalMemoryRegion
source§fn clone(&self) -> PhysicalMemoryRegion
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PhysicalMemoryRegion
Auto Trait Implementations§
§impl RefUnwindSafe for PhysicalMemoryRegion
§impl Send for PhysicalMemoryRegion
§impl Sync for PhysicalMemoryRegion
§impl Unpin for PhysicalMemoryRegion
§impl UnwindSafe for PhysicalMemoryRegion
Blanket Implementations§
Trait Implementations§
source§impl Borrow<Frame> for &PhysicalMemoryRegion
source§impl Clone for PhysicalMemoryRegion
source§fn clone(&self) -> PhysicalMemoryRegion
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PhysicalMemoryRegion
source§impl Deref for PhysicalMemoryRegion
source§impl Ord for PhysicalMemoryRegion
source§impl PartialEq<PhysicalMemoryRegion> for PhysicalMemoryRegion
source§impl PartialOrd<PhysicalMemoryRegion> for PhysicalMemoryRegion
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
+operator. Read moresource§impl Eq for PhysicalMemoryRegion
source§impl StructuralEq for PhysicalMemoryRegion
Auto Trait Implementations§
§impl RefUnwindSafe for PhysicalMemoryRegion
§impl Send for PhysicalMemoryRegion
§impl Sync for PhysicalMemoryRegion
§impl Unpin for PhysicalMemoryRegion
§impl UnwindSafe for PhysicalMemoryRegion
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
diff --git a/doc/frame_allocator/struct.SplitFrames.html b/doc/frame_allocator/struct.SplitFrames.html
new file mode 100644
index 0000000000..d53ddccd25
--- /dev/null
+++ b/doc/frame_allocator/struct.SplitFrames.html
@@ -0,0 +1,12 @@
+SplitFrames in frame_allocator - Rust Struct frame_allocator::SplitFrames
source · pub struct SplitFrames<const S: MemoryState> { /* private fields */ }
Expand description
The result of splitting a Frames object into multiple smaller Frames objects.
+Auto Trait Implementations§
§impl<const S: MemoryState> RefUnwindSafe for SplitFrames<S>
§impl<const S: MemoryState> Send for SplitFrames<S>
§impl<const S: MemoryState> Sync for SplitFrames<S>
§impl<const S: MemoryState> Unpin for SplitFrames<S>
§impl<const S: MemoryState> UnwindSafe for SplitFrames<S>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreAllocatedFrames in frame_allocator - Rust Type Definition frame_allocator::AllocatedFrames
source · pub type AllocatedFrames = Frames<{ MemoryState::Allocated }>;
Expand description
A type alias for Frames in the Allocated state.
+Implementations§
source§impl AllocatedFrames
sourcepub fn into_mapped_frames(self) -> MappedFrames
Consumes this Frames in the Allocated state and converts them into the Mapped state.
+This should only be called once a MappedPages has been created from the Frames.
+sourcepub fn as_allocated_frame(&self) -> AllocatedFrame<'_>
Returns an AllocatedFrame if this AllocatedFrames object contains only one frame.
+Panic
+Panics if this AllocatedFrame contains multiple frames or zero frames.
+Trait Implementations§
source§impl<'f> IntoIterator for &'f AllocatedFrames
FreeFrames in frame_allocator - Rust Type Definition frame_allocator::FreeFrames
source · pub type FreeFrames = Frames<{ MemoryState::Free }>;
Expand description
A type alias for Frames in the Free state.
+Implementations§
source§impl FreeFrames
sourcepub fn into_allocated_frames(self) -> AllocatedFrames
Consumes this Frames in the Free state and converts them into the Allocated state.
+MappedFrames in frame_allocator - Rust Type Definition frame_allocator::MappedFrames
source · pub type MappedFrames = Frames<{ MemoryState::Mapped }>;
Expand description
A type alias for Frames in the Mapped state.
+UnmappedFrames in frame_allocator - Rust Type Definition frame_allocator::UnmappedFrames
source · pub type UnmappedFrames = Frames<{ MemoryState::Unmapped }>;
Expand description
A type alias for Frames in the Unmapped state.
+Implementations§
source§impl UnmappedFrames
sourcepub fn into_allocated_frames(self) -> AllocatedFrames
Consumes this Frames in the Unmapped state and converts them into the Allocated state.
+List of all items in this crate List of all items
Structs
- AllocatedFrames
- AllocatedPages
- BorrowedMappedPages
- BorrowedSliceMappedPages
- CopyableFrameRange
- CopyablePageRange
- EarlyIdentityMappedPages
- Frame
- FrameRange
- Immutable
- InitialMemoryMappings
- MappedPages
- Mapper
- MemoryManagementInfo
- Mutable
- Page
- PageRange
- PageTable
- PhysicalAddress
- PteFlags
- PteFlagsArch
- PteFlagsX86_64
- VirtualAddress
Enums
Traits
Functions
- allocate_frames
- allocate_frames_at
- allocate_frames_by_bytes
- allocate_frames_by_bytes_at
- allocate_pages
- allocate_pages_at
- allocate_pages_by_bytes
- allocate_pages_by_bytes_at
- allocate_pages_by_bytes_in_range
- allocate_pages_in_range
- create_contiguous_mapping
- create_mapping
- get_kernel_mmi_ref
- init
- init_post_heap
- map_frame_range
- set_broadcast_tlb_shootdown_cb
- translate
Type Definitions
Constants
List of all items in this crate List of all items
Structs
- AllocatedPages
- BorrowedMappedPages
- BorrowedSliceMappedPages
- CopyableFrameRange
- CopyablePageRange
- EarlyIdentityMappedPages
- Frame
- FrameRange
- Immutable
- InitialMemoryMappings
- MappedPages
- Mapper
- MemoryManagementInfo
- Mutable
- Page
- PageRange
- PageTable
- PhysicalAddress
- PteFlags
- PteFlagsArch
- PteFlagsX86_64
- VirtualAddress
Enums
Traits
Functions
- allocate_frames
- allocate_frames_at
- allocate_frames_by_bytes
- allocate_frames_by_bytes_at
- allocate_pages
- allocate_pages_at
- allocate_pages_by_bytes
- allocate_pages_by_bytes_at
- allocate_pages_by_bytes_in_range
- allocate_pages_in_range
- create_contiguous_mapping
- create_mapping
- get_kernel_mmi_ref
- init
- init_post_heap
- map_frame_range
- set_broadcast_tlb_shootdown_cb
- translate
Type Definitions
Constants
DMA_FLAGS in memory - Rust pub const DMA_FLAGS: PteFlags;
Expand description
Mapping flags that can be used to map DMA (Direct Memory Access) memory.
+DMA_FLAGS in memory - Rust MMIO_FLAGS in memory - Rust Constant memory::MMIO_FLAGS
source · pub const MMIO_FLAGS: PteFlags;
Expand description
Mapping flags that can be used to map MMIO registers.
+MMIO_FLAGS in memory - Rust Constant memory::MMIO_FLAGS
source · pub const MMIO_FLAGS: PteFlags;
Expand description
Mapping flags that can be used to map MMIO registers.
MemoryState in memory - Rust Enum memory::MemoryState
pub enum MemoryState {
+ Free,
+ Allocated,
+ Mapped,
+ Unmapped,
+}
Expand description
The possible states that a range of exclusively-owned pages or frames can be in.
+Variants§
§Free
Memory is free and owned by the allocator
+§Allocated
Memory is allocated and can be used for a mapping
+§Mapped
Memory is mapped (PTE has been set)
+§Unmapped
Memory has been unmapped (PTE has been cleared)
+Trait Implementations§
§impl PartialEq<MemoryState> for MemoryState
§fn eq(&self, other: &MemoryState) -> bool
This method tests for self and other values to be equal, and is used
+by ==.§impl ConstParamTy for MemoryState
§impl Eq for MemoryState
§impl StructuralEq for MemoryState
§impl StructuralPartialEq for MemoryState
Auto Trait Implementations§
§impl RefUnwindSafe for MemoryState
§impl Send for MemoryState
§impl Sync for MemoryState
§impl Unpin for MemoryState
§impl UnwindSafe for MemoryState
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreallocate_frames in memory - Rust Function memory::allocate_frames
pub fn allocate_frames(num_frames: usize) -> Option<AllocatedFrames>
Expand description
Allocates the given number of frames with no constraints on the starting physical address.
+allocate_frames in memory - Rust Function memory::allocate_frames
pub fn allocate_frames(
+ num_frames: usize
+) -> Option<Frames<frame_allocator::::AllocatedFrames::{constant#0}>>
Expand description
Allocates the given number of frames with no constraints on the starting physical address.
See allocate_frames_deferred() for more details.
allocate_frames_at in memory - Rust Function memory::allocate_frames_at
pub fn allocate_frames_at(
paddr: PhysicalAddress,
num_frames: usize
-) -> Result<AllocatedFrames, &'static str>
Expand description
Allocates the given number of frames starting at (inclusive of) the frame containing the given PhysicalAddress.
+) -> Result<Frames<frame_allocator::::AllocatedFrames::{constant#0}>, &'static str>Expand description
Allocates the given number of frames starting at (inclusive of) the frame containing the given PhysicalAddress.
See allocate_frames_deferred() for more details.
\ No newline at end of file
diff --git a/doc/memory/fn.allocate_frames_by_bytes.html b/doc/memory/fn.allocate_frames_by_bytes.html
index fda140ace3..3a97945621 100644
--- a/doc/memory/fn.allocate_frames_by_bytes.html
+++ b/doc/memory/fn.allocate_frames_by_bytes.html
@@ -1,4 +1,6 @@
-allocate_frames_by_bytes in memory - Rust Function memory::allocate_frames_by_bytes
pub fn allocate_frames_by_bytes(num_bytes: usize) -> Option<AllocatedFrames>
Expand description
Allocates frames with no constraints on the starting physical address,
+
allocate_frames_by_bytes in memory - Rust Function memory::allocate_frames_by_bytes
pub fn allocate_frames_by_bytes(
+ num_bytes: usize
+) -> Option<Frames<frame_allocator::::AllocatedFrames::{constant#0}>>
Expand description
Allocates frames with no constraints on the starting physical address,
with a size given by the number of bytes.
This function still allocates whole frames by rounding up the number of bytes.
See allocate_frames_deferred() for more details.
diff --git a/doc/memory/fn.allocate_frames_by_bytes_at.html b/doc/memory/fn.allocate_frames_by_bytes_at.html
index 548326f4fb..eb37d13124 100644
--- a/doc/memory/fn.allocate_frames_by_bytes_at.html
+++ b/doc/memory/fn.allocate_frames_by_bytes_at.html
@@ -1,7 +1,7 @@
allocate_frames_by_bytes_at in memory - Rust Function memory::allocate_frames_by_bytes_at
pub fn allocate_frames_by_bytes_at(
paddr: PhysicalAddress,
num_bytes: usize
-) -> Result<AllocatedFrames, &'static str>
Expand description
Allocates frames starting at the given PhysicalAddress with a size given in number of bytes.
+) -> Result<Frames<frame_allocator::::AllocatedFrames::{constant#0}>, &'static str>Expand description
Allocates frames starting at the given PhysicalAddress with a size given in number of bytes.
This function still allocates whole frames by rounding up the number of bytes.
See allocate_frames_deferred() for more details.
\ No newline at end of file
diff --git a/doc/memory/fn.create_contiguous_mapping.html b/doc/memory/fn.create_contiguous_mapping.html
index 8b279cbd4e..d674c518f8 100644
--- a/doc/memory/fn.create_contiguous_mapping.html
+++ b/doc/memory/fn.create_contiguous_mapping.html
@@ -1,4 +1,4 @@
-create_contiguous_mapping in memory - Rust Function memory::create_contiguous_mapping
source · pub fn create_contiguous_mapping<F: Into<PteFlagsArch>>(
+create_contiguous_mapping in memory - Rust Function memory::create_contiguous_mapping
source · pub fn create_contiguous_mapping<F: Into<PteFlagsArch>>(
size_in_bytes: usize,
flags: F
) -> Result<(MappedPages, PhysicalAddress), &'static str>
Expand description
A convenience function that creates a new memory mapping by allocating frames that are contiguous in physical memory.
diff --git a/doc/memory/fn.create_mapping.html b/doc/memory/fn.create_mapping.html
index 57f914d3a9..e04dde973a 100644
--- a/doc/memory/fn.create_mapping.html
+++ b/doc/memory/fn.create_mapping.html
@@ -1,4 +1,4 @@
-
create_mapping in memory - Rust Function memory::create_mapping
source · pub fn create_mapping<F: Into<PteFlagsArch>>(
+create_mapping in memory - Rust Function memory::create_mapping
source · pub fn create_mapping<F: Into<PteFlagsArch>>(
size_in_bytes: usize,
flags: F
) -> Result<MappedPages, &'static str>
Expand description
A convenience function that creates a new memory mapping. The pages allocated are contiguous in memory but there’s
diff --git a/doc/memory/fn.get_kernel_mmi_ref.html b/doc/memory/fn.get_kernel_mmi_ref.html
index 88859c5f73..1bd517b6ef 100644
--- a/doc/memory/fn.get_kernel_mmi_ref.html
+++ b/doc/memory/fn.get_kernel_mmi_ref.html
@@ -1,3 +1,3 @@
-
get_kernel_mmi_ref in memory - Rust Function memory::get_kernel_mmi_ref
source · pub fn get_kernel_mmi_ref() -> Option<&'static MmiRef>
Expand description
Returns a reference to the kernel’s MemoryManagementInfo, if initialized.
+
get_kernel_mmi_ref in memory - Rust Function memory::get_kernel_mmi_ref
source · pub fn get_kernel_mmi_ref() -> Option<&'static MmiRef>
Expand description
Returns a reference to the kernel’s MemoryManagementInfo, if initialized.
If not, it returns None.
init in memory - Rust pub fn init(
+init in memory - Rust pub fn init(
boot_info: &impl BootInformation,
kernel_stack_start: VirtualAddress
) -> Result<InitialMemoryMappings, &'static str>
Expand description
Initializes the virtual memory management system.
diff --git a/doc/memory/fn.init_post_heap.html b/doc/memory/fn.init_post_heap.html
index e969d880ed..b13219a2fe 100644
--- a/doc/memory/fn.init_post_heap.html
+++ b/doc/memory/fn.init_post_heap.html
@@ -1,4 +1,4 @@
-
init_post_heap in memory - Rust Function memory::init_post_heap
source · pub fn init_post_heap(
+init_post_heap in memory - Rust Function memory::init_post_heap
source · pub fn init_post_heap(
page_table: PageTable,
additional_mapped_pages: MappedPages,
heap_mapped_pages: MappedPages
diff --git a/doc/memory/fn.map_frame_range.html b/doc/memory/fn.map_frame_range.html
index ef7e3b4b58..5631da4c1d 100644
--- a/doc/memory/fn.map_frame_range.html
+++ b/doc/memory/fn.map_frame_range.html
@@ -1,4 +1,4 @@
-map_frame_range in memory - Rust Function memory::map_frame_range
source · pub fn map_frame_range<F: Into<PteFlagsArch>>(
+map_frame_range in memory - Rust Function memory::map_frame_range
source · pub fn map_frame_range<F: Into<PteFlagsArch>>(
start_address: PhysicalAddress,
size_in_bytes: usize,
flags: F
diff --git a/doc/memory/fn.set_broadcast_tlb_shootdown_cb.html b/doc/memory/fn.set_broadcast_tlb_shootdown_cb.html
index cf5b369dbd..da3fad4b08 100644
--- a/doc/memory/fn.set_broadcast_tlb_shootdown_cb.html
+++ b/doc/memory/fn.set_broadcast_tlb_shootdown_cb.html
@@ -1,3 +1,3 @@
-set_broadcast_tlb_shootdown_cb in memory - Rust Function memory::set_broadcast_tlb_shootdown_cb
source · pub fn set_broadcast_tlb_shootdown_cb(func: fn(_: PageRange))
Expand description
Set the function callback that will be invoked every time a TLB shootdown is necessary,
+
set_broadcast_tlb_shootdown_cb in memory - Rust Function memory::set_broadcast_tlb_shootdown_cb
source · pub fn set_broadcast_tlb_shootdown_cb(func: fn(_: PageRange))
Expand description
Set the function callback that will be invoked every time a TLB shootdown is necessary,
i.e., during page table remapping and unmapping operations.
memory - Rust Expand description
This crate implements the main memory management subsystem for Theseus.
+memory - Rust Expand description
This crate implements the main memory management subsystem for Theseus.
The primary type of interest is MappedPages, which offers a robust
interface that unifies the usage of arbitrary memory regions
with that of Rust’s safe type system and lifetimes.
Acknowledgments
Some of the internal page table management code was based on
Philipp Oppermann’s blog_os, but has since changed significantly.
-Structs
- Represents a range of allocated physical memory
Frames; derefs to FrameRange. - Represents a range of allocated
VirtualAddresses, specified in Pages. - A
FrameRange that implements Copy - A
PageRange that implements Copy - The set of identity mappings that should be dropped before starting the first application.
- A
Frame is a chunk of physical memory aligned to a PAGE_SIZE boundary. - A range of
Frames that are contiguous in physical memory. - A marker type used to indicate that a
BorrowedMappedPages
+Structs
- Represents a range of allocated
VirtualAddresses, specified in Pages. - A
FrameRange that implements Copy - A
PageRange that implements Copy - The set of identity mappings that should be dropped before starting the first application.
- A
Frame is a chunk of physical memory aligned to a PAGE_SIZE boundary. - A range of
Frames that are contiguous in physical memory. - A marker type used to indicate that a
BorrowedMappedPages
or BorrowedSliceMappedPages is borrowed immutably. - Information returned after initialising the memory subsystem.
- Represents a contiguous range of virtual memory pages that are currently mapped.
A
MappedPages object can only have a single range of contiguous pages, not multiple disjoint ranges.
This does not guarantee that its pages are mapped to frames that are contiguous in physical memory. - This holds all the information for a
Task’s memory mappings and address space
(this is basically the equivalent of Linux’s mm_struct) - A marker type used to indicate that a
BorrowedMappedPages
or BorrowedSliceMappedPages is borrowed mutably. - A
Page is a chunk of virtual memory aligned to a PAGE_SIZE boundary. - A range of
Pages that are contiguous in virtual memory. - A top-level root (P4) page table.
- A physical memory address, which is a
usize under the hood. - Common, architecture-independent flags for a page table entry (PTE)
-that define how a page is mapped.
- PteFlagsArchx86-64Page table entry (PTE) flags on x86_64.
- PteFlagsX86_64x86-64Page table entry (PTE) flags on x86_64.
- A virtual memory address, which is a
usize under the hood.
Enums
- Possible options when requested pages from the page allocator.
Constants
- Mapping flags that can be used to map DMA (Direct Memory Access) memory.
- Mapping flags that can be used to map MMIO registers.
- Page size is 4096 bytes, 4KiB pages.
- A mask for the bits of a page table entry that contain the physical frame address.
Traits
- A trait for parameterizing a
BorrowedMappedPages
+that define how a page is mapped. - PteFlagsArchx86-64Page table entry (PTE) flags on x86_64.
- PteFlagsX86_64x86-64Page table entry (PTE) flags on x86_64.
- A virtual memory address, which is a
usize under the hood.
Enums
- Possible options when requested pages from the page allocator.
- The possible states that a range of exclusively-owned pages or frames can be in.
Constants
- Mapping flags that can be used to map DMA (Direct Memory Access) memory.
- Mapping flags that can be used to map MMIO registers.
- Page size is 4096 bytes, 4KiB pages.
- A mask for the bits of a page table entry that contain the physical frame address.
Traits
- A trait for parameterizing a
BorrowedMappedPages
or BorrowedSliceMappedPages as mutably or immutably borrowed.
Functions
- Allocates the given number of frames with no constraints on the starting physical address.
- Allocates the given number of frames starting at (inclusive of) the frame containing the given
PhysicalAddress. - Allocates frames with no constraints on the starting physical address,
with a size given by the number of bytes.
- Allocates frames starting at the given
PhysicalAddress with a size given in number of bytes. - Allocates the given number of pages with no constraints on the starting virtual address.
- Allocates the given number of pages starting at (inclusive of) the page containing the given
VirtualAddress. - Allocates pages with no constraints on the starting virtual address,
with a size given by the number of bytes.
- Allocates pages starting at the given
VirtualAddress with a size given in number of bytes. - Allocates pages with a size given in number of bytes with the constraint that
@@ -27,4 +27,4 @@
Acknowledgments
Consumes the given BootInformation, because after the memory system is initialized,
the original BootInformation will be unmapped and inaccessible. - Finishes initializing the memory management system after the heap is ready.
- A convenience function that maps randomly-allocated pages to the given range of frames.
- Set the function callback that will be invoked every time a TLB shootdown is necessary,
i.e., during page table remapping and unmapping operations.
- A convenience function to translate the given virtual address into a
-physical address using the currently-active page table.
Type Definitions
- A shareable reference to a
MemoryManagementInfo struct wrapper in a lock.
Type Definitions
- A type alias for
Frames in the Allocated state. - A shareable reference to a
MemoryManagementInfo struct wrapper in a lock. - A type alias for
Frames in the Unmapped state.
AllocatedFrames in memory - Rust Struct memory::AllocatedFrames
pub struct AllocatedFrames { /* private fields */ }
Expand description
Represents a range of allocated physical memory Frames; derefs to FrameRange.
-These frames are not immediately accessible because they’re not yet mapped
-by any virtual memory pages.
-You must do that separately in order to create a MappedPages type,
-which can then be used to access the contents of these frames.
-This object represents ownership of the range of allocated physical frames;
-if this object falls out of scope, its allocated frames will be auto-deallocated upon drop.
-Implementations§
§impl AllocatedFrames
pub const fn empty() -> AllocatedFrames
Returns an empty AllocatedFrames object that performs no frame allocation.
-Can be used as a placeholder, but will not permit any real usage.
-pub fn merge(&mut self, other: AllocatedFrames) -> Result<(), AllocatedFrames>
Merges the given AllocatedFrames object other into this AllocatedFrames object (self).
-This is just for convenience and usability purposes, it performs no allocation or remapping.
-The given other must be physically contiguous with self, i.e., come immediately before or after self.
-That is, either self.start == other.end + 1 or self.end + 1 == other.start must be true.
-If either of those conditions are met, self is modified and Ok(()) is returned,
-otherwise Err(other) is returned.
-pub fn split(
- self,
- at_frame: Frame
-) -> Result<(AllocatedFrames, AllocatedFrames), AllocatedFrames>
Splits this AllocatedFrames into two separate AllocatedFrames objects:
-
-[beginning : at_frame - 1][at_frame : end]
-This function follows the behavior of core::slice::split_at(),
-thus, either one of the returned AllocatedFrames objects may be empty.
-
-- If
at_frame == self.start, the first returned AllocatedFrames object will be empty.
-- If
at_frame == self.end + 1, the second returned AllocatedFrames object will be empty.
-
-Returns an Err containing this AllocatedFrames if at_frame is otherwise out of bounds.
-pub fn as_allocated_frame(&self) -> AllocatedFrame<'_>
Returns an AllocatedFrame if this AllocatedFrames object contains only one frame.
-Panic
-Panics if this AllocatedFrame contains multiple frames or zero frames.
-Methods from Deref<Target = FrameRange>§
pub fn start_address(&self) -> PhysicalAddress
Returns the PhysicalAddress of the starting Frame in this FrameRange.
-pub fn size_in_frames(&self) -> usize
Returns the number of Frames covered by this iterator.
-Use this instead of Iterator::count() method. This is instant, because it doesn’t need to iterate over each entry, unlike normal iterators.
-pub fn size_in_bytes(&self) -> usize
Returns the size of this range in number of bytes.
-pub fn contains_address(&self, addr: PhysicalAddress) -> bool
Returns true if this FrameRange contains the given PhysicalAddress.
-pub fn offset_of_address(&self, addr: PhysicalAddress) -> Option<usize>
Returns the offset of the given PhysicalAddress within this FrameRange, i.e., addr - self.start_address().
-If the given addr is not covered by this range of Frames, this returns None.
-Examples
-If the range covers addresses 0x2000 to 0x4000, then offset_of_address(0x3500) would return Some(0x1500).
-pub fn address_at_offset(&self, offset: usize) -> Option<PhysicalAddress>
Returns the PhysicalAddress at the given offset into this FrameRangewithin this FrameRange, i.e., self.start_address() + offset.
-If the given offset is not within this range of Frames, this returns None.
-Examples
-If the range covers addresses 0x2000 through 0x3FFF, then address_at_offset(0x1500) would return Some(0x3500), and address_at_offset(0x2000) would return None.
-pub fn to_extended(&self, to_include: Frame) -> FrameRange
Returns a new separate FrameRange that is extended to include the given Frame.
-pub fn overlap(&self, other: &FrameRange) -> Option<FrameRange>
Returns an inclusive FrameRange representing the Frames that overlap across this FrameRange and the given other FrameRange.
-If there is no overlap between the two ranges, None is returned.
-Methods from Deref<Target = RangeInclusive<Frame>>§
sourcepub fn iter(&self) -> RangeInclusiveIterator<Idx>
Returns an iterator with the same start and end values as the range.
-sourcepub fn contains<U>(&self, item: &U) -> boolwhere
- Idx: PartialOrd<U>,
- U: PartialOrd<Idx> + ?Sized,
Returns true if item is contained in the range.
-Trait Implementations§
§impl Debug for AllocatedFrames
§impl Deref for AllocatedFrames
§type Target = FrameRange
The resulting type after dereferencing.§fn deref(&self) -> &FrameRange
Dereferences the value.§impl<'f> IntoIterator for &'f AllocatedFrames
§fn into_iter(self) -> <&'f AllocatedFrames as IntoIterator>::IntoIter
Creates an iterator from a value. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for AllocatedFrames
§impl Send for AllocatedFrames
§impl Sync for AllocatedFrames
§impl Unpin for AllocatedFrames
§impl UnwindSafe for AllocatedFrames
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreBorrowedMappedPages in memory - Rust Struct memory::BorrowedMappedPages
source · pub struct BorrowedMappedPages<T, M = Immutable, B = MappedPages>where
+BorrowedMappedPages in memory - Rust Struct memory::BorrowedMappedPages
source · pub struct BorrowedMappedPages<T, M = Immutable, B = MappedPages>where
T: FromBytes,
M: Mutability,
B: Borrow<MappedPages>,{ /* private fields */ }
Expand description
A borrowed MappedPages object that derefs to &T and optionally also &mut T.
@@ -29,7 +29,7 @@ Drop behavior
Also, you can manually end the borrow to reclaim the inner B MappedPages type
via the Self::into_inner() method.
-Implementations§
source§impl<T: FromBytes, B: Borrow<MappedPages>> BorrowedMappedPages<T, Immutable, B>
sourcepub fn from(mp: B, byte_offset: usize) -> Result<Self, (B, &'static str)>
Immutably borrows the given MappedPages as an instance of type &T
+
Implementations§
source§impl<T: FromBytes, B: Borrow<MappedPages>> BorrowedMappedPages<T, Immutable, B>
sourcepub fn from(mp: B, byte_offset: usize) -> Result<Self, (B, &'static str)>
Immutably borrows the given MappedPages as an instance of type &T
located at the given byte_offset into the MappedPages.
See MappedPages::as_type() for more info.
Arguments
@@ -49,7 +49,7 @@ Arguments
Upon failure, this returns an error tuple containing the unmodified mp argument
and a string describing the error.
-source§impl<T: FromBytes, B: BorrowMut<MappedPages>> BorrowedMappedPages<T, Mutable, B>
source§impl<T: FromBytes, B: BorrowMut<MappedPages>> BorrowedMappedPages<T, Mutable, B>
sourcepub fn from_mut(mp: B, byte_offset: usize) -> Result<Self, (B, &'static str)>
Mutably borrows the given MappedPages as an instance of type &mut T
located at the given byte_offset into the MappedPages.
See MappedPages::as_type_mut() for more info.
Arguments
@@ -69,26 +69,26 @@ Arguments
Upon failure, returns an error containing the unmodified MappedPages
and a string describing the error.
-source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> BorrowedMappedPages<T, M, B>
sourcepub fn into_inner(self) -> B
Consumes this object and returns the inner MappedPages value
+
source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> BorrowedMappedPages<T, M, B>
sourcepub fn into_inner(self) -> B
Consumes this object and returns the inner MappedPages value
(more specifically, the Borrow-able container holding the MappedPages).
-Trait Implementations§
source§impl<T: FromBytes, B: BorrowMut<MappedPages>> AsMut<T> for BorrowedMappedPages<T, Mutable, B>
Only Mutable BorrowedMappedPages implement AsMut<T>.
-source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> AsRef<T> for BorrowedMappedPages<T, M, B>
Both Mutable and Immutable BorrowedMappedPages implement AsRef<T>.
-source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> Borrow<T> for BorrowedMappedPages<T, M, B>
Both Mutable and Immutable BorrowedMappedPages implement Borrow<T>.
-source§impl<T: FromBytes, B: BorrowMut<MappedPages>> BorrowMut<T> for BorrowedMappedPages<T, Mutable, B>
Only Mutable BorrowedMappedPages implement BorrowMut<T>.
-source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> Deref for BorrowedMappedPages<T, M, B>
Both Mutable and Immutable BorrowedMappedPages can deref into &T.
-source§impl<T: FromBytes, B: BorrowMut<MappedPages>> DerefMut for BorrowedMappedPages<T, Mutable, B>
Only Mutable BorrowedMappedPages can deref into &mut T.
-source§impl<T: FromBytes + Hash, M: Mutability, B: Borrow<MappedPages>> Hash for BorrowedMappedPages<T, M, B>
Trait Implementations§
source§impl<T: FromBytes, B: BorrowMut<MappedPages>> AsMut<T> for BorrowedMappedPages<T, Mutable, B>
Only Mutable BorrowedMappedPages implement AsMut<T>.
+source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> AsRef<T> for BorrowedMappedPages<T, M, B>
Both Mutable and Immutable BorrowedMappedPages implement AsRef<T>.
+source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> Borrow<T> for BorrowedMappedPages<T, M, B>
Both Mutable and Immutable BorrowedMappedPages implement Borrow<T>.
+source§impl<T: FromBytes, B: BorrowMut<MappedPages>> BorrowMut<T> for BorrowedMappedPages<T, Mutable, B>
Only Mutable BorrowedMappedPages implement BorrowMut<T>.
+source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> Deref for BorrowedMappedPages<T, M, B>
Both Mutable and Immutable BorrowedMappedPages can deref into &T.
+source§impl<T: FromBytes, B: BorrowMut<MappedPages>> DerefMut for BorrowedMappedPages<T, Mutable, B>
Only Mutable BorrowedMappedPages can deref into &mut T.
+source§impl<T: FromBytes + Hash, M: Mutability, B: Borrow<MappedPages>> Hash for BorrowedMappedPages<T, M, B>
source§impl<T: FromBytes + Ord, M: Mutability, B: Borrow<MappedPages>> Ord for BorrowedMappedPages<T, M, B>
source§impl<T: FromBytes + Ord, M: Mutability, B: Borrow<MappedPages>> Ord for BorrowedMappedPages<T, M, B>
source§impl<T: FromBytes + PartialEq, M: Mutability, B: Borrow<MappedPages>> PartialEq<BorrowedMappedPages<T, M, B>> for BorrowedMappedPages<T, M, B>
source§fn eq(&self, other: &Self) -> bool
This method tests for self and other values to be equal, and is used
+ Self: Sized + PartialOrd<Self>,Restrict a value to a certain interval. Read moresource§impl<T: FromBytes + PartialEq, M: Mutability, B: Borrow<MappedPages>> PartialEq<BorrowedMappedPages<T, M, B>> for BorrowedMappedPages<T, M, B>
source§impl<T: FromBytes + PartialOrd, M: Mutability, B: Borrow<MappedPages>> PartialOrd<BorrowedMappedPages<T, M, B>> for BorrowedMappedPages<T, M, B>
source§impl<T: FromBytes + PartialOrd, M: Mutability, B: Borrow<MappedPages>> PartialOrd<BorrowedMappedPages<T, M, B>> for BorrowedMappedPages<T, M, B>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read moresource§impl<T: FromBytes + Eq, M: Mutability, B: Borrow<MappedPages>> Eq for BorrowedMappedPages<T, M, B>
Auto Trait Implementations§
§impl<T, M, B> RefUnwindSafe for BorrowedMappedPages<T, M, B>where
+operator. Read more
source§impl<T: FromBytes + Eq, M: Mutability, B: Borrow<MappedPages>> Eq for BorrowedMappedPages<T, M, B>
Auto Trait Implementations§
§impl<T, M, B> RefUnwindSafe for BorrowedMappedPages<T, M, B>where
B: RefUnwindSafe,
M: RefUnwindSafe,
T: RefUnwindSafe,
§impl<T, M, B> Send for BorrowedMappedPages<T, M, B>where
diff --git a/doc/memory/struct.BorrowedSliceMappedPages.html b/doc/memory/struct.BorrowedSliceMappedPages.html
index 57716b9d1a..8bcb5a2f8d 100644
--- a/doc/memory/struct.BorrowedSliceMappedPages.html
+++ b/doc/memory/struct.BorrowedSliceMappedPages.html
@@ -1,9 +1,9 @@
-BorrowedSliceMappedPages in memory - Rust Struct memory::BorrowedSliceMappedPages
source · pub struct BorrowedSliceMappedPages<T, M = Immutable, B = MappedPages>where
+BorrowedSliceMappedPages in memory - Rust Struct memory::BorrowedSliceMappedPages
source · pub struct BorrowedSliceMappedPages<T, M = Immutable, B = MappedPages>where
T: FromBytes,
M: Mutability,
B: Borrow<MappedPages>,{ /* private fields */ }
Expand description
A borrowed MappedPages object that derefs to a slice &[T] and optionally also &mut [T].
See the docs of BorrowedMappedPages for more detail.
-Implementations§
source§impl<T: FromBytes, B: Borrow<MappedPages>> BorrowedSliceMappedPages<T, Immutable, B>
Implementations§
source§impl<T: FromBytes, B: BorrowMut<MappedPages>> BorrowedSliceMappedPages<T, Mutable, B>
source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> BorrowedSliceMappedPages<T, M, B>
sourcepub fn into_inner(self) -> B
Consumes this object and returns the inner MappedPages.
-source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> BorrowedSliceMappedPages<T, M, B>
sourcepub fn into_inner(self) -> B
Consumes this object and returns the inner MappedPages.
+
Methods from Deref<Target = [T]>§
1.0.0 · sourcepub fn len(&self) -> usize
Returns the number of elements in the slice.
Examples
Trait Implementations§
source§impl<T: FromBytes, B: BorrowMut<MappedPages>> AsMut<[T]> for BorrowedSliceMappedPages<T, Mutable, B>
Only Mutable BorrowedSliceMappedPages implement AsMut<T>.
-source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> AsRef<[T]> for BorrowedSliceMappedPages<T, M, B>
Both Mutable and Immutable BorrowedSliceMappedPages implement AsRef<[T]>.
-source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> Borrow<[T]> for BorrowedSliceMappedPages<T, M, B>
Both Mutable and Immutable BorrowedSliceMappedPages implement Borrow<T>.
-source§impl<T: FromBytes, B: BorrowMut<MappedPages>> BorrowMut<[T]> for BorrowedSliceMappedPages<T, Mutable, B>
Only Mutable BorrowedSliceMappedPages implement BorrowMut<T>.
-source§fn borrow_mut(&mut self) -> &mut [T]
Mutably borrows from an owned value. Read moresource§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> Deref for BorrowedSliceMappedPages<T, M, B>
Both Mutable and Immutable BorrowedSliceMappedPages can deref into &[T].
-source§impl<T: FromBytes, B: BorrowMut<MappedPages>> DerefMut for BorrowedSliceMappedPages<T, Mutable, B>
Only Mutable BorrowedSliceMappedPages can deref into &mut T.
-source§impl<T: FromBytes + Hash, M: Mutability, B: Borrow<MappedPages>> Hash for BorrowedSliceMappedPages<T, M, B>
Trait Implementations§
source§impl<T: FromBytes, B: BorrowMut<MappedPages>> AsMut<[T]> for BorrowedSliceMappedPages<T, Mutable, B>
Only Mutable BorrowedSliceMappedPages implement AsMut<T>.
+source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> AsRef<[T]> for BorrowedSliceMappedPages<T, M, B>
Both Mutable and Immutable BorrowedSliceMappedPages implement AsRef<[T]>.
+source§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> Borrow<[T]> for BorrowedSliceMappedPages<T, M, B>
Both Mutable and Immutable BorrowedSliceMappedPages implement Borrow<T>.
+source§impl<T: FromBytes, B: BorrowMut<MappedPages>> BorrowMut<[T]> for BorrowedSliceMappedPages<T, Mutable, B>
Only Mutable BorrowedSliceMappedPages implement BorrowMut<T>.
+source§fn borrow_mut(&mut self) -> &mut [T]
Mutably borrows from an owned value. Read moresource§impl<T: FromBytes, M: Mutability, B: Borrow<MappedPages>> Deref for BorrowedSliceMappedPages<T, M, B>
Both Mutable and Immutable BorrowedSliceMappedPages can deref into &[T].
+source§impl<T: FromBytes, B: BorrowMut<MappedPages>> DerefMut for BorrowedSliceMappedPages<T, Mutable, B>
Only Mutable BorrowedSliceMappedPages can deref into &mut T.
+source§impl<T: FromBytes + Hash, M: Mutability, B: Borrow<MappedPages>> Hash for BorrowedSliceMappedPages<T, M, B>
source§impl<T: FromBytes + Ord, M: Mutability, B: Borrow<MappedPages>> Ord for BorrowedSliceMappedPages<T, M, B>
source§impl<T: FromBytes + Ord, M: Mutability, B: Borrow<MappedPages>> Ord for BorrowedSliceMappedPages<T, M, B>
source§impl<T: FromBytes + PartialEq, M: Mutability, B: Borrow<MappedPages>> PartialEq<BorrowedSliceMappedPages<T, M, B>> for BorrowedSliceMappedPages<T, M, B>
source§fn eq(&self, other: &Self) -> bool
This method tests for self and other values to be equal, and is used
+ Self: Sized + PartialOrd<Self>,Restrict a value to a certain interval. Read moresource§impl<T: FromBytes + PartialEq, M: Mutability, B: Borrow<MappedPages>> PartialEq<BorrowedSliceMappedPages<T, M, B>> for BorrowedSliceMappedPages<T, M, B>
source§impl<T: FromBytes + PartialOrd, M: Mutability, B: Borrow<MappedPages>> PartialOrd<BorrowedSliceMappedPages<T, M, B>> for BorrowedSliceMappedPages<T, M, B>
source§impl<T: FromBytes + PartialOrd, M: Mutability, B: Borrow<MappedPages>> PartialOrd<BorrowedSliceMappedPages<T, M, B>> for BorrowedSliceMappedPages<T, M, B>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read moresource§impl<T: FromBytes + Eq, M: Mutability, B: Borrow<MappedPages>> Eq for BorrowedSliceMappedPages<T, M, B>
Auto Trait Implementations§
§impl<T, M, B> RefUnwindSafe for BorrowedSliceMappedPages<T, M, B>where
+operator. Read more
source§impl<T: FromBytes + Eq, M: Mutability, B: Borrow<MappedPages>> Eq for BorrowedSliceMappedPages<T, M, B>
Auto Trait Implementations§
§impl<T, M, B> RefUnwindSafe for BorrowedSliceMappedPages<T, M, B>where
B: RefUnwindSafe,
M: RefUnwindSafe,
T: RefUnwindSafe,
§impl<T, M, B> Send for BorrowedSliceMappedPages<T, M, B>where
diff --git a/doc/memory/struct.CopyableFrameRange.html b/doc/memory/struct.CopyableFrameRange.html
index c5daa5a0cd..ffc3febcd4 100644
--- a/doc/memory/struct.CopyableFrameRange.html
+++ b/doc/memory/struct.CopyableFrameRange.html
@@ -1,5 +1,5 @@
CopyableFrameRange in memory - Rust Struct memory::CopyableFrameRange
pub struct CopyableFrameRange { /* private fields */ }
Expand description
A FrameRange that implements Copy
-Trait Implementations§
§impl Clone for CopyableFrameRange
§fn clone(&self) -> CopyableFrameRange
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl From<CopyableFrameRange> for FrameRange
§fn from(cr: CopyableFrameRange) -> FrameRange
Converts to this type from the input type.§impl From<FrameRange> for CopyableFrameRange
§fn from(r: FrameRange) -> CopyableFrameRange
Converts to this type from the input type.§impl Copy for CopyableFrameRange
Auto Trait Implementations§
§impl RefUnwindSafe for CopyableFrameRange
§impl Send for CopyableFrameRange
§impl Sync for CopyableFrameRange
§impl Unpin for CopyableFrameRange
§impl UnwindSafe for CopyableFrameRange
Blanket Implementations§
Trait Implementations§
§impl Clone for CopyableFrameRange
§fn clone(&self) -> CopyableFrameRange
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl From<CopyableFrameRange> for FrameRange
§fn from(cr: CopyableFrameRange) -> FrameRange
Converts to this type from the input type.§impl From<FrameRange> for CopyableFrameRange
§fn from(r: FrameRange) -> CopyableFrameRange
Converts to this type from the input type.§impl Copy for CopyableFrameRange
Auto Trait Implementations§
§impl RefUnwindSafe for CopyableFrameRange
§impl Send for CopyableFrameRange
§impl Sync for CopyableFrameRange
§impl Unpin for CopyableFrameRange
§impl UnwindSafe for CopyableFrameRange
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/doc/memory/struct.EarlyIdentityMappedPages.html b/doc/memory/struct.EarlyIdentityMappedPages.html
index 00a1d04a09..2cb932dfaa 100644
--- a/doc/memory/struct.EarlyIdentityMappedPages.html
+++ b/doc/memory/struct.EarlyIdentityMappedPages.html
@@ -1,4 +1,4 @@
-EarlyIdentityMappedPages in memory - Rust Struct memory::EarlyIdentityMappedPages
source · pub struct EarlyIdentityMappedPages { /* private fields */ }
Expand description
The set of identity mappings that should be dropped before starting the first application.
+EarlyIdentityMappedPages in memory - Rust Struct memory::EarlyIdentityMappedPages
source · pub struct EarlyIdentityMappedPages { /* private fields */ }
Expand description
The set of identity mappings that should be dropped before starting the first application.
Currently there are only 4 identity mappings, used for the base kernel image:
- the
.init early text section,
@@ -6,7 +6,7 @@
- the
.rodata section, which includes all read-only data,
- the
.data section, which includes .bss and all read-write data.
-Trait Implementations§