Struct rstubs::arch::gdt::Descriptor

#[repr(transparent)]
pub struct Descriptor(u64);

Describes the structure of segment descriptors

A data structure that contains size, position, access rights, and purpose of any segment. Segment descriptors are used in both the GDT, as well as in LDTs.

• ISDMv3, 3.4.5; Segment Descriptors
• AAPMv2, 4.7 Legacy Segment Descriptors

Tuple Fields

0: u64

Implementations

impl Descriptor

pub const fn new() -> Self

Creates a new default initialized bitfield.

const LIMIT_LOW_BITS: usize = 16usize

const LIMIT_LOW_OFFSET: usize = 0usize

const fn with_limit_low(self, value: u32) -> Self

Least-significant bits of segment size (influenced by pages!)

Bits: 0..16

const fn limit_low(&self) -> u32

Least-significant bits of segment size (influenced by pages!)

Bits: 0..16

fn set_limit_low(&mut self, value: u32)

Least-significant bits of segment size (influenced by pages!)

Bits: 0..16

const BASE_LOW_BITS: usize = 24usize

const BASE_LOW_OFFSET: usize = 16usize

const fn with_base_low(self, value: u32) -> Self

Least-significant bits of base address

Bits: 16..40

const fn base_low(&self) -> u32

Least-significant bits of base address

Bits: 16..40

fn set_base_low(&mut self, value: u32)

Least-significant bits of base address

Bits: 16..40

const KIND_BITS: usize = 4usize

const KIND_OFFSET: usize = 40usize

pub const fn with_kind(self, value: u8) -> Self

Meaning of those 4 bits depends on kind_code_data below

Bits: 40..44

pub const fn kind(&self) -> u8

Meaning of those 4 bits depends on kind_code_data below

Bits: 40..44

pub fn set_kind(&mut self, value: u8)

Meaning of those 4 bits depends on kind_code_data below

Bits: 40..44

const DESCRIPTOR_KIND_BITS: usize = 1usize

const DESCRIPTOR_KIND_OFFSET: usize = 44usize

pub const fn with_descriptor_kind(self, value: bool) -> Self

Descriptor type (influences the meaning of the 3 bits above)

Bits: 44..45

pub const fn descriptor_kind(&self) -> bool

Descriptor type (influences the meaning of the 3 bits above)

Bits: 44..45

pub fn set_descriptor_kind(&mut self, value: bool)

Descriptor type (influences the meaning of the 3 bits above)

Bits: 44..45

const RING_BITS: usize = 2usize

const RING_OFFSET: usize = 45usize

pub const fn with_ring(self, value: u8) -> Self

Ring for this segment

Bits: 45..47

pub const fn ring(&self) -> u8

Ring for this segment

Bits: 45..47

pub fn set_ring(&mut self, value: u8)

Ring for this segment

Bits: 45..47

const PRESENT_BITS: usize = 1usize

const PRESENT_OFFSET: usize = 47usize

pub const fn with_present(self, value: bool) -> Self

Entry is valid iff set to true

Bits: 47..48

pub const fn present(&self) -> bool

Entry is valid iff set to true

Bits: 47..48

pub fn set_present(&mut self, value: bool)

Entry is valid iff set to true

Bits: 47..48

const LIMIT_HIGH_BITS: usize = 4usize

const LIMIT_HIGH_OFFSET: usize = 48usize

const fn with_limit_high(self, value: u32) -> Self

Most-significant bits of segment size

Bits: 48..52

const fn limit_high(&self) -> u32

Most-significant bits of segment size

Bits: 48..52

fn set_limit_high(&mut self, value: u32)

Most-significant bits of segment size

Bits: 48..52

const AVAILABLE_BITS: usize = 1usize

const AVAILABLE_OFFSET: usize = 52usize

pub const fn with_available(self, value: bool) -> Self

Bit which can be used for other purposes (in software)

Bits: 52..53

pub const fn available(&self) -> bool

Bit which can be used for other purposes (in software)

Bits: 52..53

pub fn set_available(&mut self, value: bool)

Bit which can be used for other purposes (in software)

Bits: 52..53

const CUSTOM_BITS: usize = 2usize

const CUSTOM_OFFSET: usize = 53usize

pub const fn with_custom(self, value: u8) -> Self

Meaning of those 2 bits relate to descriptor_kind and kind

Bits: 53..55

pub const fn custom(&self) -> u8

Meaning of those 2 bits relate to descriptor_kind and kind

Bits: 53..55

pub fn set_custom(&mut self, value: u8)

Meaning of those 2 bits relate to descriptor_kind and kind

Bits: 53..55

const PAGES_BITS: usize = 1usize

const PAGES_OFFSET: usize = 55usize

pub const fn with_pages(self, value: bool) -> Self

Uses page granularity for the segment limit (instead of bytes)

Bits: 55..56

pub const fn pages(&self) -> bool

Uses page granularity for the segment limit (instead of bytes)

Bits: 55..56

pub fn set_pages(&mut self, value: bool)

Uses page granularity for the segment limit (instead of bytes)

Bits: 55..56

const BASE_HIGH_BITS: usize = 8usize

const BASE_HIGH_OFFSET: usize = 56usize

const fn with_base_high(self, value: u8) -> Self

most-significant bits of base address

Bits: 56..64

const fn base_high(&self) -> u8

most-significant bits of base address

Bits: 56..64

fn set_base_high(&mut self, value: u8)

most-significant bits of base address

Bits: 56..64

impl Descriptor

pub const fn segment( memory: RangeInclusive<u32>, code: bool, user: bool ) -> Descriptor

Create a code/data segment descriptor

pub fn tss(tss: &TaskStateSegment) -> Descriptor

Creates a new task state segment descriptor for the Global Descriptor Table.

pub const fn base(&self) -> u32

Base/starting address

pub const fn with_base(self, v: u32) -> Self

Base/starting address

pub const fn limit(&self) -> u32

Segment size

pub const fn with_limit(self, v: u32) -> Self

Segment size

Trait Implementations

impl Clone for Descriptor

fn clone(&self) -> Descriptor

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Descriptor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Descriptor

fn default() -> Self

Returns the “default value” for a type.

impl From<Descriptor> for u64

fn from(v: Descriptor) -> u64

Converts to this type from the input type.

impl From<u64> for Descriptor

fn from(v: u64) -> Self

Converts to this type from the input type.

impl PartialEq for Descriptor

fn eq(&self, other: &Descriptor) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Descriptor

impl Eq for Descriptor

impl StructuralEq for Descriptor

impl StructuralPartialEq for Descriptor