one_collect 0.1.34811

Cross-platform library for capturing machine-level traces.
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

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

use super::*;
use tracing::{debug, trace};

impl Unwindable for Process {
    fn find<'a>(
        &'a self,
        ip: u64) -> Option<&'a dyn CodeSection> {
        self.find(ip)
    }
}

impl Process {
    pub fn new() -> Self { Self::default() }

    pub fn add_module(
        &mut self,
        module: Module) {
        debug!("Module added to process: start={:#x}, end={:#x}", module.start, module.end);
        self.mods.push(module);
        self.sorted = false;
    }

    pub fn fork(&self) -> Self {
        debug!("Process forked: module_count={}", self.mods.len());
        let mut child = Self::new();

        for module in &self.mods {
            child.mods.push(*module);
        }

        child
    }

    pub fn sort(
        &mut self) {
        if !self.sorted {
            debug!("Sorting process modules: module_count={}", self.mods.len());
            self.mods.sort();
            self.sorted = true;
        }
    }

    pub fn find(
        &self,
        ip: u64) -> Option<&dyn CodeSection> {
        if self.mods.is_empty() {
            trace!("Module lookup failed: ip={:#x}, no modules loaded", ip);
            return None;
        }

        let mut index = self.mods.partition_point(
            |module| module.start <= ip );

        index = index.saturating_sub(1);

        let module = &self.mods[index];

        if module.start <= ip &&
           module.end >= ip {
            debug!("Module found for ip={:#x}: start={:#x}, end={:#x}", ip, module.start, module.end);
            return Some(module);
        }

        trace!("Module lookup failed: ip={:#x}, closest_start={:#x}, closest_end={:#x}", ip, module.start, module.end);
        None
    }
}

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

    #[test]
    fn find() {
        let mut proc = Process::new();
        let first = Module::new(1, 1024, 0, 0, 1, 0, UnwindType::DWARF);
        let second = Module::new(1025, 2048, 0, 0, 2, 0, UnwindType::DWARF);
        let third = Module::new(2049, 3072, 0, 0, 3, 0, UnwindType::DWARF);
        proc.add_module(first);
        proc.add_module(second);
        proc.add_module(third);
        proc.sort();

        /* Entirely out of bounds (Start) */
        match proc.find(0) {
            Some(_module) => {
                assert!(false, "Shouldn't have any");
            },
            None => { /* Expected */ },
        }

        /* First module case */
        let found = proc.find(1).unwrap();
        assert!(found.key().dev == 1);

        let found = proc.find(1024).unwrap();
        assert!(found.key().dev == 1);

        /* Second module case */
        let found = proc.find(1025).unwrap();
        assert!(found.key().dev == 2);

        let found = proc.find(2048).unwrap();
        assert!(found.key().dev == 2);

        /* Third module case */
        let found = proc.find(2049).unwrap();
        assert!(found.key().dev == 3);

        let found = proc.find(3072).unwrap();
        assert!(found.key().dev == 3);

        /* Entirely out of bounds (End) */
        match proc.find(3073) {
            Some(_module) => {
                assert!(false, "Shouldn't have any");
            },
            None => { /* Expected */ },
        }
    }
}