ostd 0.8.4

Rust OS framework that facilitates the development of and innovation in OS kernels
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

// SPDX-License-Identifier: MPL-2.0

/// Gets the offset of a field within a type as a pointer.
///
/// ```rust
/// #[repr(C)]
/// pub struct Foo {
///     first: u8,
///     second: u32,
/// }
///
/// assert!(offset_of(Foo, first) == (0 as *const u8));
/// assert!(offset_of(Foo, second) == (4 as *const u32));
/// ```
#[macro_export]
macro_rules! offset_of {
    ($container:ty, $($field:tt)+) => ({
        // SAFETY: It is ok to have this uninitialized value because
        // 1) Its memory won't be accessed;
        // 2) It will be forgotten rather than being dropped;
        // 3) Before it gets forgotten, the code won't return prematurely or panic.
        let tmp: $container = unsafe { core::mem::MaybeUninit::uninit().assume_init() };

        let container_addr = &tmp as *const _;
        let field_addr =  &tmp.$($field)* as *const _;

        ::core::mem::forget(tmp);

        let field_offset = (field_addr as usize - container_addr as usize) as *const _;

        // Let Rust compiler infer our intended pointer type of field_offset
        // by comparing it with another pointer.
        let _: bool = field_offset == field_addr;

        field_offset
    });
}

/// Gets the offset of a field within an object as a pointer.
///
/// ```rust
/// #[repr(C)]
/// pub struct Foo {
///     first: u8,
///     second: u32,
/// }
/// let foo = &Foo {first: 0, second: 0};
/// assert!(value_offset!(foo) == (0 as *const Foo));
/// assert!(value_offset!(foo.first) == (0 as *const u8));
/// assert!(value_offset!(foo.second) == (4 as *const u32));
/// ```
#[macro_export]
macro_rules! value_offset {
    ($container:ident) => ({
        let container_addr = &*$container as *const _;
        let offset = 0 as *const _;
        let _: bool = offset == container_addr;
        offset
    });
    ($container:ident.$($field:ident).*) => ({
        let container_addr = &*$container as *const _;
        // SAFETY: This is safe since we never access the field
        let field_addr = unsafe {&($container.$($field).*)} as *const _;
        let field_offset = (field_addr as usize- container_addr as usize) as *const _;
        let _: bool = field_offset == field_addr;
        field_offset
    });
}