Merge pull request #223 from rust-osdev/next

Release version v0.13.0

Author: phil-opp

Cargo.toml

@@ -22,7 +22,7 @@ license = "MIT/Apache-2.0"
 name = "x86_64"
 readme = "README.md"
 repository = "https://github.com/rust-osdev/x86_64"
-version = "0.12.4"
+version = "0.13.0"
 edition = "2018"
 
 [dependencies]
@@ -35,7 +35,6 @@ cc = { version = "1.0.37", optional = true }
 [features]
 default = [ "nightly", "instructions" ]
 instructions = []
-deny-warnings = []
 external_asm = [ "cc" ]
 nightly = [ "inline_asm", "const_fn", "abi_x86_interrupt" ]
 inline_asm = []
@@ -47,6 +46,7 @@ no-dev-version = true
 pre-release-replacements = [
     { file="Changelog.md", search="# Unreleased", replace="# Unreleased\n\n# {{version}} – {{date}}", exactly=1 },
 ]
-pre-release-commit-message = "Release version {{version}}"
+pre-release-commit-message = "Bump version to {{version}}"
 disable-push = true
 disable-publish = true
+disable-tag = true

Changelog.md

@@ -1,5 +1,22 @@
 # Unreleased
 
+# 0.13.0 – 2020-12-28
+
+- **Breaking:** Also return flags for `MapperAllSizes::translate()` ([#207](https://github.com/rust-osdev/x86_64/pull/207))
+- **Breaking:** Restructure the `TranslateResult` type and create separate `Translate` trait ([#211](https://github.com/rust-osdev/x86_64/pull/211))
+- **Breaking:** Rename `PhysToVirt` trait to `PageTableFrameMapping` ([#214](https://github.com/rust-osdev/x86_64/pull/214))
+- **Breaking:** Use custom error types instead of `()` ([#199](https://github.com/rust-osdev/x86_64/pull/199))
+- **Breaking:** Remove deprecated items
+  - `UnusedPhysFrame`
+  - `ExceptionStackFrame`
+  - `VirtAddr::new_unchecked`
+  - `interrupts::enable_interrupts_and_hlt`
+- **Breaking:** Make `DescriptorTablePointer::base` a `VirtAddr` ([#215](https://github.com/rust-osdev/x86_64/pull/215))
+- **Breaking:** Change return type of `read_rip` to `VirtAddr` ([#216](https://github.com/rust-osdev/x86_64/pull/216))
+- **Breaking:** Make writing the RFLAGS register unsafe ([#219](https://github.com/rust-osdev/x86_64/pull/219))
+- **Breaking:** Remove `PortReadWrite` trait, which is no longer needed ([#217](https://github.com/rust-osdev/x86_64/pull/217))
+- Relaxe `Sized` requirement for `FrameAllocator` in `Mapper::map_to` ([204](https://github.com/rust-osdev/x86_64/pull/204))
+
 # 0.12.4 – 2020-12-28
 
 - Fix bad conversion from llvm_asm! to asm! ([#218](https://github.com/rust-osdev/x86_64/pull/218))

src/addr.rs

@@ -85,13 +85,6 @@ impl VirtAddr {
         VirtAddr(((addr << 16) as i64 >> 16) as u64)
     }
 
-    /// Alias for [`new_truncate`][VirtAddr::new_truncate] for backwards compatibility.
-    #[inline]
-    #[deprecated(note = "Use new_truncate or new_unsafe instead")]
-    pub const fn new_unchecked(addr: u64) -> VirtAddr {
-        Self::new_truncate(addr)
-    }
-
     /// Creates a new virtual address, without any checks.
     ///
     /// ## Safety

src/instructions/interrupts.rs

@@ -139,13 +139,6 @@ pub fn enable_and_hlt() {
     }
 }
 
-/// Alias for [`enable_and_hlt`][enable_and_hlt] for backwards compatibility.
-#[inline]
-#[deprecated(note = "Use enable_and_hlt instead")]
-pub fn enable_interrupts_and_hlt() {
-    enable_and_hlt();
-}
-
 /// Cause a breakpoint exception by invoking the `int3` instruction.
 #[inline]
 pub fn int3() {

src/instructions/mod.rs

@@ -2,6 +2,8 @@
 
 //! Special x86_64 instructions.
 
+use crate::VirtAddr;
+
 pub mod interrupts;
 pub mod port;
 pub mod random;
@@ -56,12 +58,12 @@ pub fn bochs_breakpoint() {
 /// instructions to execute.
 #[cfg(feature = "inline_asm")]
 #[inline(always)]
-pub fn read_rip() -> u64 {
+pub fn read_rip() -> VirtAddr {
     let rip: u64;
     unsafe {
         asm!(
             "lea {}, [rip]", out(reg) rip, options(nostack, nomem)
         );
     }
-    rip
+    VirtAddr::new(rip)
 }

src/instructions/port.rs

@@ -2,7 +2,7 @@
 
 use core::marker::PhantomData;
 
-pub use crate::structures::port::{PortRead, PortReadWrite, PortWrite};
+pub use crate::structures::port::{PortRead, PortWrite};
 
 impl PortRead for u8 {
     #[cfg(feature = "inline_asm")]
@@ -94,10 +94,6 @@ impl PortWrite for u32 {
     }
 }
 
-impl PortReadWrite for u8 {}
-impl PortReadWrite for u16 {}
-impl PortReadWrite for u32 {}
-
 /// A read only I/O port.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct PortReadOnly<T> {
@@ -178,7 +174,7 @@ impl<T> Port<T> {
     }
 }
 
-impl<T: PortReadWrite> Port<T> {
+impl<T: PortRead> Port<T> {
     /// Reads from the port.
     ///
     /// ## Safety
@@ -189,7 +185,9 @@ impl<T: PortReadWrite> Port<T> {
     pub unsafe fn read(&mut self) -> T {
         T::read_from_port(self.port)
     }
+}
 
+impl<T: PortWrite> Port<T> {
     /// Writes to the port.
     ///
     /// ## Safety

src/lib.rs

@@ -9,9 +9,7 @@
 #![cfg_attr(feature = "const_fn", feature(const_in_array_repeat_expressions))]
 #![cfg_attr(feature = "inline_asm", feature(asm))]
 #![cfg_attr(feature = "abi_x86_interrupt", feature(abi_x86_interrupt))]
-#![cfg_attr(feature = "deny-warnings", deny(warnings))]
-#![cfg_attr(feature = "deny-warnings", deny(missing_docs))]
-#![cfg_attr(not(feature = "deny-warnings"), warn(missing_docs))]
+#![warn(missing_docs)]
 #![deny(missing_debug_implementations)]
 
 pub use crate::addr::{align_down, align_up, PhysAddr, VirtAddr};

src/registers/rflags.rs

@@ -92,8 +92,14 @@ mod x86_64 {
     }
 
     /// Writes the RFLAGS register, preserves reserved bits.
+    ///
+    /// ## Safety
+    ///
+    /// Unsafe because undefined becavior can occur if certain flags are modified. For example,
+    /// the `DF` flag must be unset in all Rust code. Also, modifying `CF`, `PF`, or any other
+    /// flags also used by Rust/LLVM can result in undefined behavior too.
     #[inline]
-    pub fn write(flags: RFlags) {
+    pub unsafe fn write(flags: RFlags) {
         let old_value = read_raw();
         let reserved = old_value & !(RFlags::all().bits());
         let new_value = reserved | flags.bits();
@@ -104,16 +110,23 @@ mod x86_64 {
     /// Writes the RFLAGS register.
     ///
     /// Does not preserve any bits, including reserved bits.
+    ///
+    ///
+    /// ## Safety
+    ///
+    /// Unsafe because undefined becavior can occur if certain flags are modified. For example,
+    /// the `DF` flag must be unset in all Rust code. Also, modifying `CF`, `PF`, or any other
+    /// flags also used by Rust/LLVM can result in undefined behavior too.
     #[inline]
-    pub fn write_raw(val: u64) {
+    pub unsafe fn write_raw(val: u64) {
         #[cfg(feature = "inline_asm")]
-        unsafe {
+        {
             // FIXME - There's probably a better way than saying we preserve the flags even though we actually don't
             asm!("push {}; popf", in(reg) val, options(preserves_flags))
         };
 
         #[cfg(not(feature = "inline_asm"))]
-        unsafe {
+        {
             crate::asm::x86_64_asm_write_rflags(val)
         }
     }

src/structures/gdt.rs

@@ -1,7 +1,10 @@
 //! Types for the Global Descriptor Table and segment selectors.
 
-use crate::structures::{tss::TaskStateSegment, DescriptorTablePointer};
 use crate::PrivilegeLevel;
+use crate::{
+    structures::{tss::TaskStateSegment, DescriptorTablePointer},
+    VirtAddr,
+};
 use bit_field::BitField;
 use bitflags::bitflags;
 use core::fmt;
@@ -221,7 +224,7 @@ impl GlobalDescriptorTable {
     fn pointer(&self) -> DescriptorTablePointer {
         use core::mem::size_of;
         DescriptorTablePointer {
-            base: self.table.as_ptr() as u64,
+            base: VirtAddr::new(self.table.as_ptr() as u64),
             limit: (self.next_free * size_of::<u64>() - 1) as u16,
         }
     }

src/structures/idt.rs

@@ -440,7 +440,7 @@ impl InterruptDescriptorTable {
     fn pointer(&self) -> DescriptorTablePointer {
         use core::mem::size_of;
         DescriptorTablePointer {
-            base: self as *const _ as u64,
+            base: VirtAddr::new(self as *const _ as u64),
             limit: (size_of::<Self>() - 1) as u16,
         }
     }
@@ -706,12 +706,6 @@ impl EntryOptions {
     }
 }
 
-/// Wrapper type for the exception stack frame pushed by the CPU.
-///
-/// Identical to [`InterruptStackFrame`].
-#[deprecated(note = "This type was renamed to InterruptStackFrame.")]
-pub type ExceptionStackFrame = InterruptStackFrame;
-
 /// Wrapper type for the interrupt stack frame pushed by the CPU.
 ///
 /// This type derefs to an [`InterruptStackFrameValue`], which allows reading the actual values.

src/structures/mod.rs

@@ -1,5 +1,7 @@
 //! Representations of various x86 specific structures and descriptor tables.
 
+use crate::VirtAddr;
+
 pub mod gdt;
 
 // idt needs `feature(abi_x86_interrupt)`, which is not available on stable rust
@@ -18,5 +20,5 @@ pub struct DescriptorTablePointer {
     /// Size of the DT.
     pub limit: u16,
     /// Pointer to the memory region containing the DT.
-    pub base: u64,
+    pub base: VirtAddr,
 }

src/structures/paging/frame.rs

@@ -1,5 +1,6 @@
 //! Abstractions for default-sized and huge physical memory frames.
 
+use super::page::AddressNotAligned;
 use crate::structures::paging::page::{PageSize, Size4KiB};
 use crate::PhysAddr;
 use core::fmt;
@@ -19,9 +20,9 @@ impl<S: PageSize> PhysFrame<S> {
     ///
     /// Returns an error if the address is not correctly aligned (i.e. is not a valid frame start).
     #[inline]
-    pub fn from_start_address(address: PhysAddr) -> Result<Self, ()> {
+    pub fn from_start_address(address: PhysAddr) -> Result<Self, AddressNotAligned> {
         if !address.is_aligned(S::SIZE) {
-            return Err(());
+            return Err(AddressNotAligned);
         }
         Ok(PhysFrame::containing_address(address))
     }

src/structures/paging/frame_alloc.rs

@@ -1,7 +1,6 @@
 //! Traits for abstracting away frame allocation and deallocation.
 
-use crate::structures::paging::{PageSize, PhysFrame, Size4KiB};
-use core::ops::{Deref, DerefMut};
+use crate::structures::paging::{PageSize, PhysFrame};
 
 /// A trait for types that can allocate a frame of memory.
 ///
@@ -21,46 +20,3 @@ pub trait FrameDeallocator<S: PageSize> {
     /// The caller must ensure that the passed frame is unused.
     unsafe fn deallocate_frame(&mut self, frame: PhysFrame<S>);
 }
-
-/// Represents a physical frame that is not used for any mapping.
-#[deprecated(note = "This wrapper type is no longer used. Use `PhysFrame` instead.")]
-#[derive(Debug)]
-pub struct UnusedPhysFrame<S: PageSize = Size4KiB>(PhysFrame<S>);
-
-#[allow(deprecated)]
-impl<S: PageSize> UnusedPhysFrame<S> {
-    /// Creates a new UnusedPhysFrame from the given frame.
-    ///
-    /// ## Safety
-    ///
-    /// This method is unsafe because the caller must guarantee
-    /// that the given frame is unused.
-    #[inline]
-    pub unsafe fn new(frame: PhysFrame<S>) -> Self {
-        Self(frame)
-    }
-
-    /// Returns the physical frame as `PhysFrame` type.
-    #[inline]
-    pub fn frame(self) -> PhysFrame<S> {
-        self.0
-    }
-}
-
-#[allow(deprecated)]
-impl<S: PageSize> Deref for UnusedPhysFrame<S> {
-    type Target = PhysFrame<S>;
-
-    #[inline]
-    fn deref(&self) -> &Self::Target {
-        &self.0
-    }
-}
-
-#[allow(deprecated)]
-impl<S: PageSize> DerefMut for UnusedPhysFrame<S> {
-    #[inline]
-    fn deref_mut(&mut self) -> &mut Self::Target {
-        &mut self.0
-    }
-}