kprobe 0.4.0

A no_std Rust probe infrastructure crate for kprobe, kretprobe, and uprobe on multiple architectures.
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use alloc::{collections::BTreeMap, sync::Arc, vec::Vec};

use lock_api::RawMutex;

use crate::{KprobeAuxiliaryOps, KprobeOps, ProbePoint, UniProbe};

/// A manager for kprobes.
#[derive(Debug)]
pub struct ProbeManager<L: RawMutex + 'static, F: KprobeAuxiliaryOps> {
    break_list: BTreeMap<usize, Vec<UniProbe<L, F>>>,
    debug_list: BTreeMap<usize, Vec<UniProbe<L, F>>>,
}

impl<L: RawMutex + 'static, F: KprobeAuxiliaryOps> Default for ProbeManager<L, F> {
    fn default() -> Self {
        Self::new()
    }
}

impl<L: RawMutex + 'static, F: KprobeAuxiliaryOps> ProbeManager<L, F> {
    /// Create a new kprobe manager.
    pub const fn new() -> Self {
        ProbeManager {
            break_list: BTreeMap::new(),
            debug_list: BTreeMap::new(),
        }
    }
    /// Insert a kprobe into the manager.
    pub fn insert_probe(&mut self, probe: UniProbe<L, F>) {
        let probe_point = probe.probe_point().clone();
        self.insert_break_point(probe_point.break_address(), probe.clone());
        self.insert_debug_point(probe_point.debug_address(), probe);
    }

    /// Insert a kprobe into the break_list.
    ///
    /// # Parameters
    /// - `address`: The address of the kprobe, obtained from `KprobePoint::break_address()` or `KprobeBuilder::probe_addr()`.
    /// - `kprobe`: The instance of the kprobe.
    fn insert_break_point(&mut self, address: usize, probe: UniProbe<L, F>) {
        let list = self.break_list.entry(address).or_default();
        list.push(probe);
    }

    /// Insert a kprobe into the debug_list.
    ///
    /// # Parameters
    /// - `address`: The address of the kprobe, obtained from `KprobePoint::debug_address()`.
    /// - `kprobe`: The instance of the kprobe.
    ///
    fn insert_debug_point(&mut self, address: usize, probe: UniProbe<L, F>) {
        let list = self.debug_list.entry(address).or_default();
        list.push(probe);
    }

    /// Get the list of kprobes registered at a breakpoint address.
    pub fn get_break_list(&self, address: usize) -> Option<&Vec<UniProbe<L, F>>> {
        self.break_list.get(&address)
    }

    /// Get the list of kprobes registered at a debug address.
    pub fn get_debug_list(&self, address: usize) -> Option<&Vec<UniProbe<L, F>>> {
        self.debug_list.get(&address)
    }

    /// Get the number of kprobes registered at a breakpoint address.
    pub fn kprobe_num(&self, address: usize) -> usize {
        self.break_list_len(address)
    }

    pub(crate) fn replace_debug_list_with_new_address(
        &mut self,
        old_address: usize,
        new_address: usize,
    ) {
        if let Some(list) = self.debug_list.remove(&old_address) {
            self.debug_list.insert(new_address, list);
        }
    }

    #[inline]
    fn break_list_len(&self, address: usize) -> usize {
        self.break_list
            .get(&address)
            .map(|list| list.len())
            .unwrap_or(0)
    }
    #[inline]
    fn debug_list_len(&self, address: usize) -> usize {
        self.debug_list
            .get(&address)
            .map(|list| list.len())
            .unwrap_or(0)
    }

    /// Remove a kprobe from the manager.
    pub fn remove_probe(&mut self, probe: UniProbe<L, F>) {
        let probe_point = probe.probe_point().clone();
        self.remove_one_break(probe_point.break_address(), &probe);
        self.remove_one_debug(probe_point.debug_address(), &probe);
    }

    /// Remove a kprobe from the break_list.
    fn remove_one_break(&mut self, address: usize, probe: &UniProbe<L, F>) {
        if let Some(list) = self.break_list.get_mut(&address) {
            list.retain(|x| match x {
                UniProbe::Kprobe(kprobe) => match probe {
                    UniProbe::Kprobe(kprobe2) => !Arc::ptr_eq(kprobe, kprobe2),
                    UniProbe::Uprobe(_) | UniProbe::Uretprobe(_) | UniProbe::Kretprobe(_) => true,
                },
                UniProbe::Kretprobe(kretprobe) => match probe {
                    UniProbe::Kprobe(_) | UniProbe::Uprobe(_) | UniProbe::Uretprobe(_) => true,
                    UniProbe::Kretprobe(kretprobe2) => !Arc::ptr_eq(kretprobe, kretprobe2),
                },
                UniProbe::Uprobe(uprobe) => match probe {
                    UniProbe::Uprobe(uprobe2) => !Arc::ptr_eq(uprobe, uprobe2),
                    UniProbe::Uretprobe(_) | UniProbe::Kprobe(_) | UniProbe::Kretprobe(_) => true,
                },
                UniProbe::Uretprobe(uretprobe) => match probe {
                    UniProbe::Uprobe(_) | UniProbe::Kprobe(_) | UniProbe::Kretprobe(_) => true,
                    UniProbe::Uretprobe(uretprobe2) => !Arc::ptr_eq(uretprobe, uretprobe2),
                },
            });
        }
        if self.break_list_len(address) == 0 {
            self.break_list.remove(&address);
        }
    }

    /// Remove a kprobe from the debug_list.
    fn remove_one_debug(&mut self, address: usize, probe: &UniProbe<L, F>) {
        if let Some(list) = self.debug_list.get_mut(&address) {
            list.retain(|x| match x {
                UniProbe::Kprobe(kprobe) => match &probe {
                    UniProbe::Kprobe(kprobe2) => !Arc::ptr_eq(kprobe, kprobe2),
                    UniProbe::Kretprobe(_) | UniProbe::Uprobe(_) | UniProbe::Uretprobe(_) => true,
                },
                UniProbe::Kretprobe(kretprobe) => match &probe {
                    UniProbe::Kprobe(_) | UniProbe::Uprobe(_) | UniProbe::Uretprobe(_) => true,
                    UniProbe::Kretprobe(kretprobe2) => !Arc::ptr_eq(kretprobe, kretprobe2),
                },
                UniProbe::Uprobe(uprobe) => match &probe {
                    UniProbe::Uprobe(uprobe2) => !Arc::ptr_eq(uprobe, uprobe2),
                    UniProbe::Uretprobe(_) | UniProbe::Kprobe(_) | UniProbe::Kretprobe(_) => true,
                },
                UniProbe::Uretprobe(uretprobe) => match &probe {
                    UniProbe::Uprobe(_) | UniProbe::Kprobe(_) | UniProbe::Kretprobe(_) => true,
                    UniProbe::Uretprobe(uretprobe2) => !Arc::ptr_eq(uretprobe, uretprobe2),
                },
            });
        }
        if self.debug_list_len(address) == 0 {
            self.debug_list.remove(&address);
        }
    }
}

/// A list of kprobe points.
pub type ProbePointList<F> = BTreeMap<usize, Arc<ProbePoint<F>>>;