bcc 0.0.34

Idiomatic Rust bindings for BPF Compiler Collection (BCC)
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288

use crate::core::make_alphanumeric;
use crate::core::BPF;
use crate::error::BccError;

use bcc_sys::bccapi::bpf_probe_attach_type_BPF_PROBE_ENTRY as BPF_PROBE_ENTRY;
use bcc_sys::bccapi::bpf_probe_attach_type_BPF_PROBE_RETURN as BPF_PROBE_RETURN;
use bcc_sys::bccapi::bpf_prog_type_BPF_PROG_TYPE_KPROBE as BPF_PROG_TYPE_KPROBE;
use bcc_sys::bccapi::pid_t;

use std::path::{Path, PathBuf};

#[derive(Default)]
/// A `Uprobe` is used to configure and then attach a uprobe to a userspace
/// function on entry into that function. Must be attached to a `BPF` struct to
/// be useful.
pub struct Uprobe {
    binary: Option<PathBuf>,
    handler: Option<String>,
    pid: Option<pid_t>,
    symbol: Option<String>,
    addr: Option<u64>,
    ref_ctr_offset: u32,
}

impl Uprobe {
    /// Create a new probe with the defaults. Further initialization is required
    /// before attaching.
    pub fn new() -> Self {
        Default::default()
    }

    /// Specify the name of the probe handler within the BPF code. This is a
    /// required item.
    pub fn handler(mut self, name: &str) -> Self {
        self.handler = Some(name.to_owned());
        self
    }

    /// Specify the path to the binary to probe. This is a required item.
    pub fn binary<T: AsRef<Path>>(mut self, path: T) -> Self {
        self.binary = Some(PathBuf::from(path.as_ref()));
        self
    }

    /// Specify the symbol to probe. This is optional.
    ///
    /// Typically required when not specifying the symbol address directly via `address`.
    pub fn symbol(mut self, symbol: &str) -> Self {
        self.symbol = Some(symbol.to_owned());
        self
    }

    /// Specify the symbol address to probe.  This is optional.
    pub fn address(mut self, addr: u64) -> Self {
        self.addr = Some(addr);
        self
    }

    /// Specify a pid to probe. This is optional.
    pub fn pid(mut self, pid: Option<pid_t>) -> Self {
        self.pid = pid;
        self
    }

    /// Specify reference counter offset
    pub fn ref_ctr_offset(mut self, offset: u32) -> Self {
        self.ref_ctr_offset = offset;
        self
    }

    /// Consumes the probe and attaches it to the `BPF` struct. May return an
    /// error if there is a incomplete configuration or error while loading or
    /// attaching the probe.
    pub fn attach(self, bpf: &mut BPF) -> Result<(), BccError> {
        if self.handler.is_none() {
            return Err(BccError::InvalidUprobe {
                message: "handler is required".to_string(),
            });
        }
        if self.binary.is_none() {
            return Err(BccError::InvalidUprobe {
                message: "binary is required".to_string(),
            });
        }
        let binary = self.binary.unwrap().to_str().map(|v| v.to_owned());
        if binary.is_none() {
            return Err(BccError::InvalidUprobe {
                message: "binary path is invalid".to_string(),
            });
        }
        let binary = binary.unwrap();
        let symbol = self.symbol.as_deref().unwrap_or("");
        let pid = self.pid.unwrap_or(-1);
        let handler = self.handler.unwrap();
        let addr = self.addr;

        let (path, addr) =
            crate::symbol::resolve_symbol_path(&binary, &symbol, addr.unwrap_or(0x0), pid)?;
        let alpha_path = make_alphanumeric(&path);
        let ev_name = format!("p_{}_0x{:x}", &alpha_path, addr);

        let code_fd = bpf.load(&handler, BPF_PROG_TYPE_KPROBE, 0, 0)?;

        #[cfg(any(
            feature = "v0_4_0",
            feature = "v0_5_0",
            feature = "v0_6_0",
            feature = "v0_6_1",
            feature = "v0_7_0",
            feature = "v0_8_0",
            feature = "v0_9_0",
            feature = "v0_10_0",
            feature = "v0_11_0",
            feature = "v0_12_0",
            feature = "v0_13_0",
            feature = "v0_14_0",
            feature = "v0_15_0",
            feature = "v0_16_0",
        ))]
        let uprobe =
            crate::core::Uprobe::new(&ev_name, BPF_PROBE_ENTRY, &path, addr, code_fd, pid)?;

        #[cfg(not(any(
            feature = "v0_4_0",
            feature = "v0_5_0",
            feature = "v0_6_0",
            feature = "v0_6_1",
            feature = "v0_7_0",
            feature = "v0_8_0",
            feature = "v0_9_0",
            feature = "v0_10_0",
            feature = "v0_11_0",
            feature = "v0_12_0",
            feature = "v0_13_0",
            feature = "v0_14_0",
            feature = "v0_15_0",
            feature = "v0_16_0",
        )))]
        let uprobe = crate::core::Uprobe::new(
            &ev_name,
            BPF_PROBE_ENTRY,
            &path,
            addr,
            code_fd,
            pid,
            self.ref_ctr_offset,
        )?;

        bpf.uprobes.insert(uprobe);
        Ok(())
    }
}

#[derive(Default)]
/// A `UserspaceReturnProbe` is used to configure and then attach a uprobe to a
/// userspace function on return from that function. Must be attached to a `BPF`
/// struct to be useful.
pub struct Uretprobe {
    binary: Option<PathBuf>,
    handler: Option<String>,
    pid: Option<pid_t>,
    symbol: Option<String>,
    ref_ctr_offset: u32,
}

impl Uretprobe {
    /// Create a new probe with the defaults. Further initialization is required
    /// before attaching.
    pub fn new() -> Self {
        Default::default()
    }

    /// Specify the name of the probe handler within the BPF code. This is a
    /// required item.
    pub fn handler(mut self, name: &str) -> Self {
        self.handler = Some(name.to_owned());
        self
    }

    /// Specify the path to the binary to probe. This is a required item.
    pub fn binary<T: AsRef<Path>>(mut self, path: T) -> Self {
        self.binary = Some(PathBuf::from(path.as_ref()));
        self
    }

    /// Specify the symbol to probe. This is required.
    pub fn symbol(mut self, symbol: &str) -> Self {
        self.symbol = Some(symbol.to_owned());
        self
    }

    /// Specify a pid to probe. This is optional.
    pub fn pid(mut self, pid: Option<pid_t>) -> Self {
        self.pid = pid;
        self
    }

    /// Specify reference counter offset
    pub fn ref_ctr_offset(mut self, offset: u32) -> Self {
        self.ref_ctr_offset = offset;
        self
    }

    /// Consumes the probe and attaches it to the `BPF` struct. May return an
    /// error if there is a incomplete configuration or error while loading or
    /// attaching the probe.
    pub fn attach(self, bpf: &mut BPF) -> Result<(), BccError> {
        if self.handler.is_none() {
            return Err(BccError::InvalidUprobe {
                message: "handler is required".to_string(),
            });
        }
        if self.binary.is_none() {
            return Err(BccError::InvalidUprobe {
                message: "binary is required".to_string(),
            });
        }
        let binary = self.binary.unwrap().to_str().map(|v| v.to_owned());
        if binary.is_none() {
            return Err(BccError::InvalidUprobe {
                message: "binary path is invalid".to_string(),
            });
        }
        if self.symbol.is_none() {
            return Err(BccError::InvalidUprobe {
                message: "symbol is required".to_string(),
            });
        }
        let binary = binary.unwrap();
        let symbol = self.symbol.unwrap();
        let pid = self.pid.unwrap_or(-1);
        let handler = self.handler.unwrap();

        let (path, addr) = crate::symbol::resolve_symbol_path(&binary, &symbol, 0x0, pid)?;
        let alpha_path = make_alphanumeric(&path);
        let ev_name = format!("r_{}_0x{:x}", &alpha_path, addr);

        let code_fd = bpf.load(&handler, BPF_PROG_TYPE_KPROBE, 0, 0)?;

        #[cfg(any(
            feature = "v0_4_0",
            feature = "v0_5_0",
            feature = "v0_6_0",
            feature = "v0_6_1",
            feature = "v0_7_0",
            feature = "v0_8_0",
            feature = "v0_9_0",
            feature = "v0_10_0",
            feature = "v0_11_0",
            feature = "v0_12_0",
            feature = "v0_13_0",
            feature = "v0_14_0",
            feature = "v0_15_0",
            feature = "v0_16_0",
        ))]
        let uprobe =
            crate::core::Uprobe::new(&ev_name, BPF_PROBE_RETURN, &path, addr, code_fd, pid)?;

        #[cfg(not(any(
            feature = "v0_4_0",
            feature = "v0_5_0",
            feature = "v0_6_0",
            feature = "v0_6_1",
            feature = "v0_7_0",
            feature = "v0_8_0",
            feature = "v0_9_0",
            feature = "v0_10_0",
            feature = "v0_11_0",
            feature = "v0_12_0",
            feature = "v0_13_0",
            feature = "v0_14_0",
            feature = "v0_15_0",
            feature = "v0_16_0",
        )))]
        let uprobe = crate::core::Uprobe::new(
            &ev_name,
            BPF_PROBE_RETURN,
            &path,
            addr,
            code_fd,
            pid,
            self.ref_ctr_offset,
        )?;

        bpf.uprobes.insert(uprobe);
        Ok(())
    }
}