Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make all CSR writes unsafe by default #251

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Make all CSR writes unsafe by default #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions riscv/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

### Changed

- Make all CSR writes `unsafe` by default (#209)
- Simplify register macros with `cfg` field
- Align assembly functions with `cortex-m`
- Use CSR helper macros to define `marchid` register
Expand Down
62 changes: 54 additions & 8 deletions riscv/src/register/macros.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ macro_rules! read_csr {
/// Reads the CSR.
///
/// **WARNING**: panics on non-`riscv` targets.
#[inline]
#[inline(always)]
unsafe fn _read() -> usize {
_try_read().unwrap()
}

/// Attempts to read the CSR.
#[inline]
#[inline(always)]
unsafe fn _try_read() -> $crate::result::Result<usize> {
match () {
#[cfg($($cfg),*)]
Expand Down Expand Up @@ -155,13 +155,13 @@ macro_rules! write_csr {
/// Writes the CSR.
///
/// **WARNING**: panics on non-`riscv` targets.
#[inline]
#[inline(always)]
unsafe fn _write(bits: usize) {
_try_write(bits).unwrap();
}

/// Attempts to write the CSR.
#[inline]
#[inline(always)]
#[cfg_attr(not($($cfg),*), allow(unused_variables))]
unsafe fn _try_write(bits: usize) -> $crate::result::Result<()> {
match () {
Expand Down Expand Up @@ -195,9 +195,29 @@ macro_rules! write_csr_as {
($csr_type:ty, $csr_number:literal) => {
$crate::write_csr_as!($csr_type, $csr_number, any(target_arch = "riscv32", target_arch = "riscv64"));
};
(safe $csr_type:ty, $csr_number:literal) => {
$crate::write_csr_as!(safe $csr_type, $csr_number, any(target_arch = "riscv32", target_arch = "riscv64"));
};
($csr_type:ty, $csr_number:literal, $($cfg:meta),*) => {
$crate::write_csr!($csr_number, $($cfg),*);

/// Writes the CSR.
///
/// **WARNING**: panics on non-`riscv` targets.
#[inline]
pub unsafe fn write(value: $csr_type) {
_write(value.bits);
}

/// Attempts to write the CSR.
#[inline]
pub unsafe fn try_write(value: $csr_type) -> $crate::result::Result<()> {
_try_write(value.bits)
}
};
(safe $csr_type:ty, $csr_number:literal, $($cfg:meta),*) => {
$crate::write_csr!($csr_number, $($cfg),*);

/// Writes the CSR.
///
/// **WARNING**: panics on non-`riscv` targets.
Expand All @@ -220,6 +240,9 @@ macro_rules! write_csr_as_rv32 {
($csr_type:ty, $csr_number:literal) => {
$crate::write_csr_as!($csr_type, $csr_number, target_arch = "riscv32");
};
(safe $csr_type:ty, $csr_number:literal) => {
$crate::write_csr_as!(safe $csr_type, $csr_number, target_arch = "riscv32");
};
}

/// Convenience macro to write a [`usize`] value to a CSR register.
Expand All @@ -228,9 +251,29 @@ macro_rules! write_csr_as_usize {
($csr_number:literal) => {
$crate::write_csr_as_usize!($csr_number, any(target_arch = "riscv32", target_arch = "riscv64"));
};
(safe $csr_number:literal) => {
$crate::write_csr_as_usize!(safe $csr_number, any(target_arch = "riscv32", target_arch = "riscv64"));
};
($csr_number:literal, $($cfg:meta),*) => {
$crate::write_csr!($csr_number, $($cfg),*);

/// Writes the CSR.
///
/// **WARNING**: panics on non-`riscv` targets.
#[inline]
pub unsafe fn write(bits: usize) {
_write(bits);
}

/// Attempts to write the CSR.
#[inline]
pub unsafe fn try_write(bits: usize) -> $crate::result::Result<()> {
_try_write(bits)
}
};
(safe $csr_number:literal, $($cfg:meta),*) => {
$crate::write_csr!($csr_number, $($cfg),*);

/// Writes the CSR.
///
/// **WARNING**: panics on non-`riscv` targets.
Expand All @@ -253,6 +296,9 @@ macro_rules! write_csr_as_usize_rv32 {
($csr_number:literal) => {
$crate::write_csr_as_usize!($csr_number, target_arch = "riscv32");
};
(safe $csr_number:literal) => {
$crate::write_csr_as_usize!(safe $csr_number, target_arch = "riscv32");
};
}

/// Convenience macro around the `csrrs` assembly instruction to set the CSR register.
Expand All @@ -267,13 +313,13 @@ macro_rules! set {
/// Set the CSR.
///
/// **WARNING**: panics on non-`riscv` targets.
#[inline]
#[inline(always)]
unsafe fn _set(bits: usize) {
_try_set(bits).unwrap();
}

/// Attempts to set the CSR.
#[inline]
#[inline(always)]
#[cfg_attr(not($($cfg),*), allow(unused_variables))]
unsafe fn _try_set(bits: usize) -> $crate::result::Result<()> {
match () {
Expand Down Expand Up @@ -311,13 +357,13 @@ macro_rules! clear {
/// Clear the CSR.
///
/// **WARNING**: panics on non-`riscv` targets.
#[inline]
#[inline(always)]
unsafe fn _clear(bits: usize) {
_try_clear(bits).unwrap();
}

/// Attempts to clear the CSR.
#[inline]
#[inline(always)]
#[cfg_attr(not($($cfg),*), allow(unused_variables))]
unsafe fn _try_clear(bits: usize) -> $crate::result::Result<()> {
match () {
Expand Down
Loading