1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
/* Copyright (c) [2023] [Syswonder Community]
* [Rukos] is licensed under Mulan PSL v2.
* You can use this software according to the terms and conditions of the Mulan PSL v2.
* You may obtain a copy of Mulan PSL v2 at:
* http://license.coscl.org.cn/MulanPSL2
* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
* See the Mulan PSL v2 for more details.
*/
#![no_std]
#![feature(const_mut_refs)]
#![doc = include_str!("../README.md")]
use core::fmt;
use core::ops::{Add, AddAssign, Sub, SubAssign};
/// The size of a 4K page (4096 bytes).
pub const PAGE_SIZE_4K: usize = 0x1000;
/// Align address downwards.
///
/// Returns the greatest `x` with alignment `align` so that `x <= addr`.
///
/// The alignment must be a power of two.
#[inline]
pub const fn align_down(addr: usize, align: usize) -> usize {
addr & !(align - 1)
}
/// Align address upwards.
///
/// Returns the smallest `x` with alignment `align` so that `x >= addr`.
///
/// The alignment must be a power of two.
#[inline]
pub const fn align_up(addr: usize, align: usize) -> usize {
(addr + align - 1) & !(align - 1)
}
/// Returns the offset of the address within the alignment.
///
/// Equivalent to `addr % align`, but the alignment must be a power of two.
#[inline]
pub const fn align_offset(addr: usize, align: usize) -> usize {
addr & (align - 1)
}
/// Checks whether the address has the demanded alignment.
///
/// Equivalent to `addr % align == 0`, but the alignment must be a power of two.
#[inline]
pub const fn is_aligned(addr: usize, align: usize) -> bool {
align_offset(addr, align) == 0
}
/// Align address downwards to 4096 (bytes).
#[inline]
pub const fn align_down_4k(addr: usize) -> usize {
align_down(addr, PAGE_SIZE_4K)
}
/// Align address upwards to 4096 (bytes).
#[inline]
pub const fn align_up_4k(addr: usize) -> usize {
align_up(addr, PAGE_SIZE_4K)
}
/// Returns the offset of the address within a 4K-sized page.
#[inline]
pub const fn align_offset_4k(addr: usize) -> usize {
align_offset(addr, PAGE_SIZE_4K)
}
/// Checks whether the address is 4K-aligned.
#[inline]
pub const fn is_aligned_4k(addr: usize) -> bool {
is_aligned(addr, PAGE_SIZE_4K)
}
/// A physical memory address.
///
/// It's a wrapper type around an `usize`.
#[repr(transparent)]
#[derive(Copy, Clone, Default, Ord, PartialOrd, Eq, PartialEq)]
pub struct PhysAddr(usize);
/// A virtual memory address.
///
/// It's a wrapper type around an `usize`.
#[repr(transparent)]
#[derive(Copy, Clone, Default, Ord, PartialOrd, Eq, PartialEq)]
pub struct VirtAddr(usize);
impl PhysAddr {
/// Converts an `usize` to a physical address.
#[inline]
pub const fn from(addr: usize) -> Self {
Self(addr)
}
/// Converts the address to an `usize`.
#[inline]
pub const fn as_usize(self) -> usize {
self.0
}
/// Aligns the address downwards to the given alignment.
///
/// See the [`align_down`] function for more information.
#[inline]
pub fn align_down<U>(self, align: U) -> Self
where
U: Into<usize>,
{
Self(align_down(self.0, align.into()))
}
/// Aligns the address upwards to the given alignment.
///
/// See the [`align_up`] function for more information.
#[inline]
pub fn align_up<U>(self, align: U) -> Self
where
U: Into<usize>,
{
Self(align_up(self.0, align.into()))
}
/// Returns the offset of the address within the given alignment.
///
/// See the [`align_offset`] function for more information.
#[inline]
pub fn align_offset<U>(self, align: U) -> usize
where
U: Into<usize>,
{
align_offset(self.0, align.into())
}
/// Checks whether the address has the demanded alignment.
///
/// See the [`is_aligned`] function for more information.
#[inline]
pub fn is_aligned<U>(self, align: U) -> bool
where
U: Into<usize>,
{
is_aligned(self.0, align.into())
}
/// Aligns the address downwards to 4096 (bytes).
#[inline]
pub fn align_down_4k(self) -> Self {
self.align_down(PAGE_SIZE_4K)
}
/// Aligns the address upwards to 4096 (bytes).
#[inline]
pub fn align_up_4k(self) -> Self {
self.align_up(PAGE_SIZE_4K)
}
/// Returns the offset of the address within a 4K-sized page.
#[inline]
pub fn align_offset_4k(self) -> usize {
self.align_offset(PAGE_SIZE_4K)
}
/// Checks whether the address is 4K-aligned.
#[inline]
pub fn is_aligned_4k(self) -> bool {
self.is_aligned(PAGE_SIZE_4K)
}
}
impl VirtAddr {
/// Converts an `usize` to a virtual address.
#[inline]
pub const fn from(addr: usize) -> Self {
Self(addr)
}
/// Converts the address to an `usize`.
#[inline]
pub const fn as_usize(self) -> usize {
self.0
}
/// Converts the virtual address to a raw pointer.
#[inline]
pub const fn as_ptr(self) -> *const u8 {
self.0 as *const u8
}
/// Converts the virtual address to a mutable raw pointer.
#[inline]
pub const fn as_mut_ptr(self) -> *mut u8 {
self.0 as *mut u8
}
/// Aligns the address downwards to the given alignment.
///
/// See the [`align_down`] function for more information.
#[inline]
pub fn align_down<U>(self, align: U) -> Self
where
U: Into<usize>,
{
Self(align_down(self.0, align.into()))
}
/// Aligns the address upwards to the given alignment.
///
/// See the [`align_up`] function for more information.
#[inline]
pub fn align_up<U>(self, align: U) -> Self
where
U: Into<usize>,
{
Self(align_up(self.0, align.into()))
}
/// Returns the offset of the address within the given alignment.
///
/// See the [`align_offset`] function for more information.
#[inline]
pub fn align_offset<U>(self, align: U) -> usize
where
U: Into<usize>,
{
align_offset(self.0, align.into())
}
/// Checks whether the address has the demanded alignment.
///
/// See the [`is_aligned`] function for more information.
#[inline]
pub fn is_aligned<U>(self, align: U) -> bool
where
U: Into<usize>,
{
is_aligned(self.0, align.into())
}
/// Aligns the address downwards to 4096 (bytes).
#[inline]
pub fn align_down_4k(self) -> Self {
self.align_down(PAGE_SIZE_4K)
}
/// Aligns the address upwards to 4096 (bytes).
#[inline]
pub fn align_up_4k(self) -> Self {
self.align_up(PAGE_SIZE_4K)
}
/// Returns the offset of the address within a 4K-sized page.
#[inline]
pub fn align_offset_4k(self) -> usize {
self.align_offset(PAGE_SIZE_4K)
}
/// Checks whether the address is 4K-aligned.
#[inline]
pub fn is_aligned_4k(self) -> bool {
self.is_aligned(PAGE_SIZE_4K)
}
}
impl From<usize> for PhysAddr {
#[inline]
fn from(addr: usize) -> Self {
Self(addr)
}
}
impl From<usize> for VirtAddr {
#[inline]
fn from(addr: usize) -> Self {
Self(addr)
}
}
impl From<PhysAddr> for usize {
#[inline]
fn from(addr: PhysAddr) -> usize {
addr.0
}
}
impl From<VirtAddr> for usize {
#[inline]
fn from(addr: VirtAddr) -> usize {
addr.0
}
}
impl Add<usize> for PhysAddr {
type Output = Self;
#[inline]
fn add(self, rhs: usize) -> Self {
Self(self.0 + rhs)
}
}
impl AddAssign<usize> for PhysAddr {
#[inline]
fn add_assign(&mut self, rhs: usize) {
*self = *self + rhs;
}
}
impl Sub<usize> for PhysAddr {
type Output = Self;
#[inline]
fn sub(self, rhs: usize) -> Self {
Self(self.0 - rhs)
}
}
impl SubAssign<usize> for PhysAddr {
#[inline]
fn sub_assign(&mut self, rhs: usize) {
*self = *self - rhs;
}
}
impl Add<usize> for VirtAddr {
type Output = Self;
#[inline]
fn add(self, rhs: usize) -> Self {
Self(self.0 + rhs)
}
}
impl AddAssign<usize> for VirtAddr {
#[inline]
fn add_assign(&mut self, rhs: usize) {
*self = *self + rhs;
}
}
impl Sub<usize> for VirtAddr {
type Output = Self;
#[inline]
fn sub(self, rhs: usize) -> Self {
Self(self.0 - rhs)
}
}
impl SubAssign<usize> for VirtAddr {
#[inline]
fn sub_assign(&mut self, rhs: usize) {
*self = *self - rhs;
}
}
impl fmt::Debug for PhysAddr {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_fmt(format_args!("PA:{:#x}", self.0))
}
}
impl fmt::Debug for VirtAddr {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_fmt(format_args!("VA:{:#x}", self.0))
}
}
impl fmt::LowerHex for PhysAddr {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_fmt(format_args!("PA:{:#x}", self.0))
}
}
impl fmt::UpperHex for PhysAddr {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_fmt(format_args!("PA:{:#X}", self.0))
}
}
impl fmt::LowerHex for VirtAddr {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_fmt(format_args!("VA:{:#x}", self.0))
}
}
impl fmt::UpperHex for VirtAddr {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_fmt(format_args!("VA:{:#X}", self.0))
}
}