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

use crate::error::BccError;
use crate::ring_buf::callback::RingCallback;
use crate::table::Table;

/// A builder type for producing `PerfMap`s
pub struct RingBufBuilder {
    table_cb_pairs: Vec<(Table, RingCallback)>,
}

impl RingBufBuilder {
    /// Create a new builder for a given ring buffer and callback function
    pub fn new(table: Table, rcb: RingCallback) -> Self {
        Self {
            table_cb_pairs: vec![(table, rcb)],
        }
    }

    /// Add a ring buffer and callback function
    pub fn add(mut self, table: Table, rcb: RingCallback) -> Self {
        self.table_cb_pairs.push((table, rcb));
        self
    }

    #[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",
    ))]
    /// Try constructing a `RingBuf` from the builder
    pub fn build(self) -> Result<RingBuf, BccError> {
        Err(BccError::BccVersionTooLow {
            cause: "ring buffer".to_owned(),
            min_version: "0.16.0".to_owned(),
        })
    }

    #[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",
    )))]
    /// Try constructing a `RingBuf` from the builder
    pub fn build(mut self) -> Result<RingBuf, BccError> {
        let ring_buf_manager = self
            .table_cb_pairs
            .get_mut(0)
            .ok_or(BccError::InitializeRingBuf)
            .and_then(|(table, rcb)| {
                let prcb: *mut _ = rcb;
                let rbm = unsafe {
                    bcc_sys::bccapi::bpf_new_ringbuf(
                        table.fd(),
                        Some(super::callback::raw_callback),
                        prcb as crate::types::MutPointer,
                    )
                } as *mut bcc_sys::bccapi::ring_buffer;
                if rbm.is_null() {
                    Err(BccError::OpenRingBuf {
                        message: format!("failed to open ring buffer ({})", table.name()),
                    })
                } else {
                    Ok(rbm)
                }
            })?;

        self.table_cb_pairs
            .iter_mut()
            .skip(1)
            .try_for_each(|(table, rcb)| {
                let prcb: *mut _ = rcb;
                let add_res = unsafe {
                    bcc_sys::bccapi::bpf_add_ringbuf(
                        ring_buf_manager,
                        table.fd(),
                        Some(super::callback::raw_callback),
                        prcb as crate::types::MutPointer,
                    )
                };
                if add_res < 0 {
                    Err(BccError::OpenRingBuf {
                        message: format!("failed to open ring buffer ({})", table.name()),
                    })
                } else {
                    Ok(())
                }
            })?;

        Ok(RingBuf {
            table_cb_pairs: self.table_cb_pairs,
            ring_buf_manager,
        })
    }
}

pub struct RingBuf {
    #[allow(dead_code)]
    table_cb_pairs: Vec<(Table, RingCallback)>,

    #[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",
    )))]
    ring_buf_manager: *mut bcc_sys::bccapi::ring_buffer,
}

impl RingBuf {
    pub fn consume(&mut self) {
        #[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",
        )))]
        unsafe {
            bcc_sys::bccapi::bpf_consume_ringbuf(self.ring_buf_manager)
        };
    }

    pub fn poll(&mut self, timeout_ms: i32) {
        #[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",
        )))]
        unsafe {
            bcc_sys::bccapi::bpf_poll_ringbuf(self.ring_buf_manager, timeout_ms)
        };
    }
}

impl Drop for RingBuf {
    fn drop(&mut self) {
        #[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",
        )))]
        unsafe {
            bcc_sys::bccapi::bpf_free_ringbuf(self.ring_buf_manager)
        }
    }
}