secmem-alloc 0.2.0

Custom allocators for secret memory
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
63
64
65
66
67
68
69
70
71

//! Macros used in the crate source.

macro_rules! debug_handleallocerror_precondition {
    ($condition:expr, $layout:ident) => {
        mirai_annotations::precondition!($condition);
        if cfg!(debug_assertions) {
            // check that `layout` is a valid layout
            if !($condition) {
                alloc::alloc::handle_alloc_error($layout);
            }
        }
    };
}

macro_rules! debug_handleallocerror_precondition_valid_layout {
    ($layout:ident) => {
        mirai_annotations::precondition!(
            core::alloc::Layout::from_size_align($layout.size(), $layout.align()).is_ok(),
            "invalid layout"
        );
        if cfg!(debug_assertions) {
            // check that `layout` is a valid layout
            if core::alloc::Layout::from_size_align($layout.size(), $layout.align()).is_err() {
                alloc::alloc::handle_alloc_error($layout);
            }
        }
    };
}

macro_rules! precondition_memory_range {
    ($ptr:expr, $len:expr) => {
        mirai_annotations::precondition!(!($ptr.is_null()), "null pointer is never valid");
        mirai_annotations::precondition!(
            sptr::Strict::addr($ptr).checked_add($len).is_some(),
            "memory range wraps the address space"
        );
    };
}

macro_rules! debug_precondition_logmultiple {
    ($logmultiple:expr, $val:expr) => {
        mirai_annotations::debug_checked_precondition!(
            2_usize.checked_pow($logmultiple.into()).is_some(),
            "2^logmultiple must fit a usize"
        );
        mirai_annotations::debug_checked_precondition_eq!(
            $val % 2_usize.pow($logmultiple.into()),
            0,
            "must be multiple of 2^logmultiple"
        );
    };
}

macro_rules! debug_precondition_logaligned {
    ($logalign:expr, $ptr:expr) => {
        mirai_annotations::debug_checked_precondition!(
            2_usize.checked_pow($logalign.into()).is_some(),
            "alignment must fit a usize"
        );
        mirai_annotations::debug_checked_precondition_eq!(
            sptr::Strict::addr($ptr) % 2_usize.pow($logalign.into()),
            0,
            "pointer must be aligned"
        );
    };
}

pub(crate) use {
    debug_handleallocerror_precondition, debug_handleallocerror_precondition_valid_layout,
    debug_precondition_logaligned, debug_precondition_logmultiple, precondition_memory_range,
};