x86_64

This release is compatible with Rust nightlies starting with nightly-2026-07-10 (this only applies when the nightly feature is used).

New Features

• implement DoubleEndedIterator for ranges + implement more iterator methods
• feat: Added the "from_pfn" in PhysFrame

Fixes

• fix(instructions): allow unused_unsafe for cpuid
• fix(mapper): inline internal map_to_* functions
• docs: fix typos
• docs(page): fix typos
• don't enable abi_x86_interrupt if not needed
• insert NOP after STI
• add missing {forward,backward}_overflowing impls

Other Improvements

• Bump actions/cache from 4 to 5
• ci: add typos job
• Bump actions/checkout from 6 to 7

New Features

• add SMAP helpers
• add ability to add iomap to TSS

Fixes

• fix docs.rs build

Other Improvements

• Bump actions/checkout from 5 to 6

New Features

• Add MapperFlush method to get page
• add update() to Cr3, Dr7, SFMask, UCet, SCet, mxcsr, rflags, and XCr0
• add IA32_APIC_BASE support
• add memory encryption support
• implement functions for accessing CR8
• add forwarding impl PageTableFrameMapping for &P
• add PageFaultErrorCode::HLAT

Fixes

• fix panic in impl fmt::Debug for EntryOptions
• Ensure that addition and subtraction of addresses panics on overflow/underflow
• fix typo

Other Improvements

• fix warnings & remove broken CI job
• use default python again
• don't pass -Crelocation-model=static to host targets
• fix kani build job
• improve VirtAddr Add & Sub impls
• Add "FMask" alias for SFMask
• Bump actions/checkout from 4 to 5

This release is compatible with Rust nightlies starting with nightly-2024-11-23 (this only applies when the nightly feature is used).

New Features

• add GlobalDescriptorTable::limit
• constify PhysFrame functions
• add size and len for PageRange, PhysFrameRange, PageRangeInclusive and PhysFrameRangeInclusive
• TryFrom implementation for ExceptionVector

Fixes

• Only enable instructions on x86_64
• Ensure that Page actually implements Hash
• fix field order for INVPCID descriptor
• fix typo in "InvPicdCommand"
• fix signature of Step::steps_between implementations

Other Improvements

• docs: add aliases for in{,b,w,l} and out{,b,w,l}
• ci: migrate away from unmaintained actions
• chore: migrate from legacy rust-toolchain to rust-toolchain.toml
• test: replace x86_64-bare-metal.json with x86_64-unknown-none
• docs: fix and detect warnings
• CI: Set -Crelocation-model=static in RUSTFLAGS for bootloader test job
• silence warning about cast
• fix cfg related warnings
• fix warnings
• don't use label starting with 1
• fix testing
• remove #![feature(asm_const)]
• Remove stabilized const_mut_refs feature
• Fix clippy warnings
• fix CI job for building on MSRV
• gate HandlerFunc behind target_arch = "x86{_64}"
• Typo fix in TaskStateSegment comment
• Minor clarification DescriptorTablePointer::limit comment

New Features

• add constructor for InterruptStackFrameValue
• add Cr3::write_pcid_no_flush

Fixes

• properly jump the address gap in CleanUp

Other Improvements

• added help on update_flags to get flags
• expose DEBUG_STR more directly

Breaking changes

• replace software_interrupt! macro with generic function
• Use SegmentSelector in InterruptStackFrame
• add InvalidStarSegmentSelectors error
• add PcidTooBig error
• implement Index<u8> for IDT instead of Index<usize>
• change cpu_flags's type to RFlags
• fix load_tss and GlobalDescriptorTable
• add an immutable getter for the level 4 page table
• make Cr2::read return a result
• remove external_asm and inline_asm features
• Allow the GDT to be of any length
• Remove software_interrupt! macro
• Remove usize trait impls
• Remove deprecated functions/flags
• VirtAddr improvements
• Add structures::gdt::Entry type
• Allow GDT to be loaded with shared reference
• seal off the PageSize trait
• idt: Fixup Options structure and cleanup set_handler_fn

New Features

• implement Step for PageTableIndex

Fixes

• fix typo in docs
• activate feature(asm_const)
• gdt: Check that MAX is in range

Other Improvements

• allow inlining Step methods
• constify more Page and PageTableIndex functions

Merge branch 'next' into master

This switches to using the sparse index as reccomended by:
https://crates.io/data-access#api

Once merged, this should automatically release v0.14.12 (see #457).

Signed-off-by: Joe Richey joerichey@google.com

New Features

• Add missing IDT entries #CP and #HV`
• Adding next_higher_level to PageLevelIndex
• Adding is_empty to PageTable
• Add Descriptor::tss_segment_unchecked
• Add the iretq function to the InterruptStackFrameValue struct.
• add flush_broadcast and tlbsync functions

Fixes

• Change Star::write() to use checked subtractions
• add workaround for recursive page tables with recursive index 511
• Fix off-by-one in documentation
• Fix misc doc typos
• add compiler fences to enable and disable

Other Improvements

• set repr to transparent for various types
• Remove unused doc_cfg feature
• Enable doc_auto_cfg on docs.rs builds
• Add Descriptor::dpl const method and use it in GDT construction
• Bump bitflags to 2.3.2
• Add inline attribute to segment functions

New Features

• Add registers::debug
• Provide null segment selector as associated constant on SegmentSelector
• Add getters for the page table frame mapping

Fixes

• Fix align functions
• Correct wrong comment

Other Improvements

• Cleanup Segment macros
• Update comment and docs

New Features

• Address in VirtAddrNotValid and PhysAddrNotValid is now public (#340).
  • This field now contains the whole invalid address (#347).
• Remove all uses of external assembly (#343)
  • external_asm and inline_asm features are deprecated and now have no effect.
  • instructions feature (on by default) now requires Rust 1.59
  • Specific MSRV now noted in README (#355)
• Implement core::iter::Step for VirtAddr and Page (#342)
  • This trait is only available on nightly.
  • Gated behind step_trait feature flag
• Add UCet and SCet registers (#349)
• Use rustversion to mark certain functions const fn on Rust 1.61 (#353)
• Entry::handler_addr() is now public (#354)
• Increase packed structure alignment (#362)
• Make more address methods const fn (#369)
  • VirtAddr::as_ptr()
  • VirtAddr::as_mut_ptr()
  • PhysAddr::new()
  • PhysAddr::try_new()

Bug fixes and Documentation

• Fixed overflow bug in PageRangeInclusive (#351)
• Remove stabilized const_fn_fn_ptr_basics and const_fn_trait_bound features (#352)
• Don't set nomem in load_tss (#358)
• Correctly initialize TSS's IOPB to be empty (#357)
• Improve GlobalDescriptorTable::add_entry error handling (#361)
• Update tss_segment documentation (#366)

• Add Cr2::read_raw (#334)
• Add support for MXCSR register (#336)

• fix: build error on the latest nightly (#329)
• add set_general_handler macro (#285)
• Derive common traits for number, range and enum types (#315)
• Add the VMM Communication Exception (#VC) to the InterruptDescriptorTable (#313)
• fix: enable manipulation of InterruptStackFrame (#312)
• fix docs for page_table_index (#318)
• Remove redundant alignment check (#314)
• fix(idt): fix panic messages for index and #VC (#321)
• remove const_assert! in favor of std's assert! (#326)
• Move bootloader integration test to separate CI job (#330)

• New registers::segmentation module (#309), containing:
  • instructions::segmentation::{Segment, Segment64, CS, DS, ES, FS, GS, SS}
  • structures::gdt::SegmentSelector
  • Old locations still re-export all the types, so this is not a breaking change.
• Fixes build so that cargo doc --no-default-features succeeds.

• Add ExceptionVector enum and additional flags to PageFaultErrorCode (#303)
• Add clean_up and clean_up_with_filter methods to deallocate unused page tables (#264)
• Rename some XCr0 and CR4 flags (#275)
• Expose MapperFlush::new and MapperFlushAll::new constructor functions (#296)
• Use #[cfg(doc)] instead of docs.rs-specific cfg flag (#287)
• Some documentation updates:
  • Update segment register references in GDT::load* method to non-deprecated methods (#301)
  • Remove a panic note (#300)
• Update bit_field dependency (#306)

• Add instructions::tables::sgdt (#279)
• Improve control register bits (#273)
  • Add Cr0 bits: EXTENSION_TYPE (ET)
  • Add Cr4 bits:
    • KEY_LOCKER (KL)
    • CONTROL_FLOW_ENFORCEMENT (CET)
    • PROTECTION_KEY_SUPERVISOR (PKS)
  • Add XCr0 bits: BNDREG, BNDCSR, OPMASK, ZMM_HI256, HI16_ZMM
  • Add consistency checks for XCr0 bits
• Add SelectorErrorCode for parsing interrupt error codes from #TS, #NP, #SS, and #GP (#274)
• Make addr::{align_up, align_down} const (#270)
• Make structures::idt available on stable Rust (#271)
  • Use dummy types for the HandlerFuncs if the "abi_x86_interrupt" feature is disabled
  • Add unsafe set_handler_addr that just takes a VirtAddr
• Add common abstractions for x86 Segments (#258)
  • Add SS, CS, DS, ES, FS, GS marker types
  • Add Segment trait for reading/writing the segment register
  • Add Segment64 trait for reading/writing the segment base
  • Add GS::swap()
  • Deprecate the corresponding free functions:
    • cs, set_cs
    • swap_gs
    • load_{ss,ds,es,fs,gs}
    • {wr,rd}{fs,gs}base
• Bug fixes:
  • Corrected documentation typo (#278)
  • Avoided off-by-one error in GlobalDescriptorTable::from_raw_slice when "const_fn" is not enabled (#269)
  • Specify sysv64 as the calling convention for the "external_asm" functions (#267)

• Make the following types aliases of the new PortGeneric type (#248):
  • Port<T> = PortGeneric<T, ReadWriteAccess>
  • PortReadOnly<T> = PortGeneric<T, ReadOnlyAccess>
  • PortWriteOnly<T> = PortGeneric<T, WriteOnlyAccess>
• The following methods no longer require the nightly feature to be const fns (#255):
  • PageTable::new
  • GlobalDescriptorTable::from_raw_slice
  • MappedFrame::{start_address, size}
  • Page<Size4KiB>::p1_index
• Add Debug implementation for InterruptDescriptorTable (#253)
  • Improve Debug implementations for Entry and EntryOptions

• Multiple improvements to assembly code (#251)
  • Added external_asm implementations for bochs_breakpoint and XCr0
  • Updated options for asm! blocks (to improve performance)
  • Updated docs to use doc_cfg

• Use new const_fn_trait_bound feature to fix build on latest nightly (#250)
  • Attention: The const_fn feature now requires at least Rust nightly 2021-05-06.
• Add support for sidt instruction (#246)
• Fix Debug and PartialEq implementations for IDT entry type (#249)
• Looser trait bounds for Port types (#247)

• Breaking: Take the interrupt stack frame by value (not by reference) #242
• Breaking: Change InterruptStackFrame::as_mut to return a Volatile<_> wrapper #242

• Add support for XCR0 register (#239)

• Implement more fmt traits for addr types (#237)

• Implement Clone for PageTable (#236)

• Fix build on latest nightly: The feature const_in_array_repeat_expressions was removed (#230)

• PCID support instructions ([#169])(https://github.com/rust-osdev/x86_64/pull/169))

• Breaking: Also return flags for MapperAllSizes::translate() (#207)
• Breaking: Restructure the TranslateResult type and create separate Translate trait (#211)
• Breaking: Rename PhysToVirt trait to PageTableFrameMapping (#214)
• Breaking: Use custom error types instead of () (#199)
• Breaking: Remove deprecated items
  • UnusedPhysFrame
  • ExceptionStackFrame
  • VirtAddr::new_unchecked
  • interrupts::enable_interrupts_and_hlt
• Breaking: Make DescriptorTablePointer::base a VirtAddr (#215)
• Breaking: Change return type of read_rip to VirtAddr (#216)
• Breaking: Make writing the RFLAGS register unsafe (#219)
• Breaking: Remove PortReadWrite trait, which is no longer needed (#217)
• Relaxe Sized requirement for FrameAllocator in Mapper::map_to (204)

• Fix bad conversion from llvm_asm! to asm! (#218)
• GDT: Add load_unchecked, from_raw_slice, and as_raw_slice (#210)

• Use asm! instead of perma-unstable llvm_asm! macro (#165)
• Make GlobalDescriptorTable::add_entry a const fn (#191)
• Rename enable_interrupts_and_hlt to enable_and_hlt (#206)
• Provide functions for accessing the underlying L4 table for mapper types (#184)
• Remove Trait constraint for Port::new() (#188)

• Add additional DescriptorFlags and aliases compatible with syscall/sysenter (#181)
• Fix (another) build error on latest nightly (#186)

• Fix build error on latest nightly (#182)

• Breaking: Decouple instructions into a separate feature flag (#179)
  • Gates the instructions module by a new instructions feature (enabled by default).
  • Rename the stable feature to external_asm
  • PageTable::new is no longer a const fn on stable (i.e. without the nightly feature)

• Add VirtAddr::is_null (#180)

• Fix const_item_mutation warnings added in latest Rust nightly (#178)

• (accidental empty release)

• Don't rely on promotion of PageTableEntry::new inside a const fn (#175)

• Add a function for the nop instruction (#174)

• (accidental release, yanked)

• Add rdfsbase, rdgsbase, wrfsbase, wrgsbase (#172)

• Export PhysAddrNotValid and VirtAddrNotValid error types (#163)

• Breaking: Handle parent table flags in Mapper methods (#114)

• Fix: Inclusive ranges is_empty() comparison (#156)

• Nightly Breakage: Use llvm_asm! instead of deprecated asm! macro (#151)
• Return the correct RPL from GDT::add_entry() (#153)

• Add InterruptDescriptorTable::load_unsafe (#137)

• Breaking: Make map_to and update_flags unsafe (#135)
• Breaking: Make FrameDeallocator::deallocate_frame unsafe (#146)
• Breaking: Don't pass small trivially copyable types by reference (#147)
• Various improvements to VirtAddr and PhysAddr (#141)
  • Among other things, this renamed the VirtAddr::new_unchecked function to new_truncate.
• Add const_fn!{} macro to make functions const without duplication (#144)
  • Also makes some more functions const.
• Add {PhysFrame,Page}::from_start_address_unchecked (#142)
• Use #[inline] everywhere (#145)
• In VirtAddr::new_truncate, use shift instead of mul and div (#143)
• Use Self::new() in InterruptDescriptorTable::reset() (#148)

• Add an enable_interrupts_and_hlt function that executes sti; hlt (#138)
• Fix some clippy warnings (#130)
• Resolve remaining clippy warnings and add clippy job to CI (#132)

• Add #[inline] attribute to small functions (#129)

• asm: add target_env = "musl" to pickup the underscore asm names (#128)

• Enable usage with non-nightly rust (#127)

• Remove the cast dependency (#124)

• Improve PageTableIndex and PageOffset (#122)

• Breaking: Return the UnusedPhysFrame on MapToError::PageAlreadyMapped (#118)
• Add User Mode registers (#119)

• Allow immediate port version of in/out instructions (#115)
• Make more functions const (#116)

• Add support for cr4 control register (#111)

• Fix: Add required reexport for new UnusedPhysFrame type (#110)

• Breaking: Replace ux dependency with custom wrapper structs (#91)
• Breaking: Add new UnsafePhysFrame type and use it in Mapper::map_to (#89)
• Breaking: Rename divide_by_zero field of interrupt descriptor table to divide_error (#108)
• Breaking: Introduce new diverging handler functions for double faults and machine check exceptions (#109)
• Possibly Breaking: Make Mapper trait object safe by adding Self: Sized bounds on generic functions (#84)

• Add slice and slice_mut methods to IDT (#95)