Struct riscy::Addr

pub struct Addr(_);

A struct to representing an address value.

Addresses in rv32i are 32-bits wide. We usually write them out in hexadecimal.

Addrs are used in the interface of the Memory trait. An Addr is used to name the location of a specific byte in the memory space.

An important operation for operating for working with Addrs is adding or subtracting an offset. Several RISC-V instructions take a register together with a small immediate value (for example, lw, load word, and jalr, jump-and-link return). The value in the register becomes the base address, but the instruction then operates on memory on a small distance away from the base address. And so, several integer types, (including u32, i32, and RegVal can be added to an Addr.

When using offsets, the order must be: Addr + offset.

It doesn't make sense to add an Addr to another Addr, so this operation is not provided.

Addrs may be converted to RegVals and vice versa:

let value = RegVal::from_u32(0x2000_0000);
let addr: Addr = value.into();
let new_value = (addr + 0x0a).into();

Addrs can also be compared with <, <=, etc. This is useful for certain implementations of Memory which would like to store Addrs in BTreeMaps.

While Addr (together with the Memory interface) give every byte in memory a unique address, physical hardware often operates with memory on the level of words. That is, it is common that memory might only operate on groups of four bytes. Because of this, some operations will only work when the Addr has a proper alignment.

No restrictions on alignment are given in this version of riscy, but this is subject (and likely) to change in future versions.

Implementations

impl Addr

pub fn new(addr: u32) -> Addr

Trait Implementations

impl Add<RegVal> for Addr

type Output = Addr

The resulting type after applying the + operator.

pub fn add(self, offset: RegVal) -> Self

Performs the + operation.

impl Add<i32> for Addr

type Output = Addr

The resulting type after applying the + operator.

pub fn add(self, offset: i32) -> Self

Performs the + operation.

impl Add<u32> for Addr

type Output = Addr

The resulting type after applying the + operator.

pub fn add(self, offset: u32) -> Self

Performs the + operation.

impl Add<usize> for Addr

type Output = Addr

The resulting type after applying the + operator.

pub fn add(self, offset: usize) -> Self

Performs the + operation.

impl AddAssign<RegVal> for Addr

pub fn add_assign(&mut self, offset: RegVal)

Performs the += operation.

impl AddAssign<i32> for Addr

pub fn add_assign(&mut self, offset: i32)

Performs the += operation.

impl AddAssign<u32> for Addr

pub fn add_assign(&mut self, offset: u32)

Performs the += operation.

impl AddAssign<usize> for Addr

pub fn add_assign(&mut self, offset: usize)

Performs the += operation.

impl Clone for Addr

pub fn clone(&self) -> Addr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Addr

impl Debug for Addr

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

Formats the value using the given formatter.

impl Display for Addr

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

Formats the value using the given formatter.

impl Eq for Addr

impl From<Addr> for u32

pub fn from(addr: Addr) -> u32

Performs the conversion.

impl From<Addr> for usize

pub fn from(addr: Addr) -> usize

Performs the conversion.

impl From<Addr> for RegVal

pub fn from(addr: Addr) -> RegVal

Performs the conversion.

impl From<RegVal> for Addr

pub fn from(val: RegVal) -> Addr

Performs the conversion.

impl Hash for Addr

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Addr

pub fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Addr> for Addr

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

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

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

This method tests for !=.

impl PartialOrd<Addr> for Addr

pub fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Addr

impl StructuralPartialEq for Addr