memfaultd 1.26.1

Memfault daemon for embedded Linux systems. Observability, logging, crash reporting, and updating all in one service. Learn more at https://docs.memfault.com/
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
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

//
// Copyright (c) Memfault, Inc.
// See License.txt for details
use std::cmp::min;

use crate::cli::memfault_core_handler::arch::{get_stack_pointer, ElfGRegSet};
use crate::cli::memfault_core_handler::memory_range::MemoryRange;
use crate::cli::memfault_core_handler::ElfPtrSize;

use psm::StackDirection;

/// Attempts to find a MemoryRange for the stack based on the supplied register set.
/// The returned range is bound by the max_thread_size and the end of the segment in which
/// the stack is found. The assumption herein is that an anonymous memory mapping is created as
/// stack (and used exclusively as such). If the stack pointer is not contained in any segment,
/// None is returned.
pub fn find_stack(
    regs: &ElfGRegSet,
    mapped_memory_ranges: &[MemoryRange],
    max_thread_size: usize,
) -> Option<MemoryRange> {
    let stack_pointer = get_stack_pointer(regs) as ElfPtrSize;
    let stack_direction = StackDirection::new();

    find_stack_inner(
        stack_pointer,
        mapped_memory_ranges,
        max_thread_size,
        stack_direction,
    )
}

fn find_stack_inner(
    stack_pointer: ElfPtrSize,
    mapped_memory_ranges: &[MemoryRange],
    max_thread_size: usize,
    stack_direction: StackDirection,
) -> Option<MemoryRange> {
    // Iterate over all PT_LOAD segments and find the one that contains the stack
    // pointer. If the stack pointer is not contained in any PT_LOAD segment, we
    // ignore the thread.
    //
    // NOTE: This is an M*N operation, but both M(#segments) and N(#threads) are
    // likely quite small so this should be fine.
    for memory_range in mapped_memory_ranges {
        if memory_range.contains(stack_pointer as ElfPtrSize) {
            let (stack_start, stack_end) = match stack_direction {
                StackDirection::Ascending => {
                    let stack_size = min(
                        stack_pointer.saturating_sub(memory_range.start),
                        max_thread_size as ElfPtrSize,
                    );

                    let stack_base = stack_pointer - stack_size;
                    (stack_base, stack_pointer)
                }
                StackDirection::Descending => {
                    let stack_size = min(
                        memory_range.end.saturating_sub(stack_pointer),
                        max_thread_size as ElfPtrSize,
                    );

                    let stack_base = stack_pointer + stack_size;
                    (stack_pointer, stack_base)
                }
            };

            return Some(MemoryRange::new(stack_start, stack_end));
        }
    }

    None
}

#[cfg(test)]
mod test {
    use super::*;

    use rstest::rstest;

    #[rstest]
    #[case::stack_ascending(
        StackDirection::Ascending,
        0x1500,
        MemoryRange::new(0x500, 0x1500),
        0x1000
    )]
    #[case::stack_descending(
        StackDirection::Descending,
        0x1500,
        MemoryRange::new(0x1500, 0x2500),
        0x1000
    )]
    fn test_stack_calculation(
        #[case] stack_direction: StackDirection,
        #[case] stack_pointer: ElfPtrSize,
        #[case] expected_stack: MemoryRange,
        #[case] max_thread_size: usize,
    ) {
        let mapped_regions = program_header_fixture();

        let stack = find_stack_inner(
            stack_pointer,
            &mapped_regions,
            max_thread_size,
            stack_direction,
        );
        assert_eq!(stack, Some(expected_stack));
    }

    #[rstest]
    #[case::below_regions(0x0050)]
    #[case::between_regions(0x0400)]
    #[case::above_regions(0x3000)]
    fn test_stack_not_found(#[case] stack_pointer: ElfPtrSize) {
        let mapped_ranges = program_header_fixture();

        let stack = find_stack_inner(
            stack_pointer,
            &mapped_ranges,
            0x1000,
            StackDirection::Ascending,
        );
        assert!(stack.is_none());
    }

    fn program_header_fixture() -> Vec<MemoryRange> {
        vec![
            MemoryRange::from_start_and_size(0x0100, 0x0250),
            MemoryRange::from_start_and_size(0x0500, 0x2500),
        ]
    }
}