axtest 0.5.12

A white-box unit testing framework for ArceOS.
Documentation 
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

use crate::AxTestDescriptor;

/// Function pointer type for per-module test hooks.
pub type AxTestModHookFn = fn(AxTestDescriptor);

/// Linker-collected descriptor for a module's optional init/exit hooks.
#[derive(Clone, Copy)]
#[repr(C)]
pub struct AxTestModHookDescriptor {
    /// Module path this hook descriptor belongs to.
    pub module: &'static str,
    /// Optional pre-test hook.
    pub init: Option<AxTestModHookFn>,
    /// Optional post-test hook.
    pub exit: Option<AxTestModHookFn>,
}

impl AxTestModHookDescriptor {
    /// Construct a new immutable module hook descriptor.
    pub const fn new(
        module: &'static str,
        init: Option<AxTestModHookFn>,
        exit: Option<AxTestModHookFn>,
    ) -> Self {
        Self { module, init, exit }
    }
}

fn find_module_hook(module: &str) -> Option<&'static AxTestModHookDescriptor> {
    #[allow(improper_ctypes)]
    unsafe extern "C" {
        #[link_name = "__axtest_mod_hooks_start"]
        static _axtest_mod_hooks_start: AxTestModHookDescriptor;
        #[link_name = "__axtest_mod_hooks_end"]
        static _axtest_mod_hooks_end: AxTestModHookDescriptor;
    }

    unsafe {
        let start = core::ptr::addr_of!(_axtest_mod_hooks_start);
        let end = core::ptr::addr_of!(_axtest_mod_hooks_end);
        if start.is_null() || end.is_null() || start >= end {
            return None;
        }

        let hooks = core::slice::from_raw_parts(start, end.offset_from(start) as usize);
        hooks.iter().find(|h| h.module == module)
    }
}

/// Invoke module init hook if this module registered one.
pub fn call_module_init(module: &str, sym: AxTestDescriptor) {
    if let Some(hook) = find_module_hook(module).and_then(|h| h.init) {
        hook(sym);
    }
}

/// Invoke module exit hook if this module registered one.
pub fn call_module_exit(module: &str, sym: AxTestDescriptor) {
    if let Some(hook) = find_module_hook(module).and_then(|h| h.exit) {
        hook(sym);
    }
}