bpflint 0.3.0

Linting functionality for BPF C programs.
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

use std::iter::FusedIterator;


/// An iterator over the lines in a byte slice (typically representing
/// code).
#[derive(Debug)]
pub(crate) struct Lines<'src> {
    /// The source code in question.
    code: &'src [u8],
    /// The index at which we continue forward searching for lines.
    idx: Option<usize>,
    /// The index at which we continue backward searching for lines.
    back_idx: Option<usize>,
}

impl<'src> Lines<'src> {
    /// Create a new [`Lines`] object, referencing the snippet `code` and
    /// starting line discovery/iteration at index `idx`.
    pub fn new(code: &'src [u8], idx: usize) -> Self {
        debug_assert!(
            idx <= code.len(),
            "invalid index `{idx}` for slice with length `{}`",
            code.len()
        );

        Self {
            code,
            idx: Some(idx),
            back_idx: Some(idx),
        }
    }

    #[track_caller]
    fn find_line_start(code: &[u8], idx: usize) -> usize {
        // SANITY: The caller has to ensure that `idx` always maps to a
        //         valid position.
        code[..idx]
            .iter()
            .rposition(|&b| b == b'\n')
            .map(|idx| idx + 1)
            .unwrap_or(0)
    }

    #[track_caller]
    fn find_line_end(code: &[u8], idx: usize) -> usize {
        // SANITY: The caller has to ensure that `idx` always maps to a
        //         valid position.
        let code = &code[idx..];
        idx + code.iter().position(|&b| b == b'\n').unwrap_or(code.len())
    }
}

impl<'src> Iterator for Lines<'src> {
    type Item = &'src [u8];

    fn next(&mut self) -> Option<Self::Item> {
        if let Some(idx) = self.idx {
            let start = Self::find_line_start(self.code, idx);
            let end = Self::find_line_end(self.code, idx);
            let line = &self.code[start..end];

            let next_idx = end + 1;
            if next_idx >= self.code.len() {
                self.idx = None;
            } else {
                self.idx = Some(next_idx);
            }
            Some(line)
        } else {
            None
        }
    }
}

impl<'src> DoubleEndedIterator for Lines<'src> {
    fn next_back(&mut self) -> Option<Self::Item> {
        if let Some(idx) = self.back_idx {
            let start = Self::find_line_start(self.code, idx);
            let end = Self::find_line_end(self.code, idx);
            let line = &self.code[start..end];

            if let Some(next_idx) = start.checked_sub(1) {
                self.back_idx = Some(next_idx);
            } else {
                self.back_idx = None;
            }
            Some(line)
        } else {
            None
        }
    }
}

impl FusedIterator for Lines<'_> {}


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

    use indoc::indoc;


    /// Check that the [`Lines::find_line_start`] function works as it
    /// should.
    #[test]
    fn line_start_finding() {
        assert_eq!(Lines::find_line_start(b"", 0), 0);
        assert_eq!(Lines::find_line_start(b"a", 0), 0);
        assert_eq!(Lines::find_line_start(b"a", 1), 0);

        let code = b"\n";
        assert_eq!(Lines::find_line_start(code, 0), 0);
        assert_eq!(Lines::find_line_start(code, 1), 1);

        let code = b"a\n";
        assert_eq!(Lines::find_line_start(code, 0), 0);
        assert_eq!(Lines::find_line_start(code, 1), 0);
        assert_eq!(Lines::find_line_start(code, 2), 2);

        let code = b"ab\ncd";
        assert_eq!(Lines::find_line_start(code, 0), 0);
        assert_eq!(Lines::find_line_start(code, 1), 0);
        assert_eq!(Lines::find_line_start(code, 2), 0);
        assert_eq!(Lines::find_line_start(code, 3), 3);
        assert_eq!(Lines::find_line_start(code, 4), 3);
        assert_eq!(Lines::find_line_start(code, 5), 3);
    }

    /// Check that the [`Lines::find_line_end`] function works as it
    /// should.
    #[test]
    fn line_end_finding() {
        assert_eq!(Lines::find_line_end(b"", 0), 0);
        assert_eq!(Lines::find_line_end(b"a", 0), 1);
        assert_eq!(Lines::find_line_end(b"a", 1), 1);

        let code = b"\n";
        assert_eq!(Lines::find_line_end(code, 0), 0);
        assert_eq!(Lines::find_line_end(code, 1), 1);

        let code = b"a\n";
        assert_eq!(Lines::find_line_end(code, 0), 1);
        assert_eq!(Lines::find_line_end(code, 1), 1);
        assert_eq!(Lines::find_line_end(code, 2), 2);

        let code = b"\na";
        assert_eq!(Lines::find_line_end(code, 0), 0);
        assert_eq!(Lines::find_line_end(code, 1), 2);
        assert_eq!(Lines::find_line_end(code, 2), 2);

        let code = b"ab\ncd";
        assert_eq!(Lines::find_line_end(code, 0), 2);
        assert_eq!(Lines::find_line_end(code, 1), 2);
        assert_eq!(Lines::find_line_end(code, 2), 2);
        assert_eq!(Lines::find_line_end(code, 3), 5);
        assert_eq!(Lines::find_line_end(code, 4), 5);
        assert_eq!(Lines::find_line_end(code, 5), 5);
    }

    /// Test that we can iterate over lines in a forward fashion.
    #[test]
    fn forward_iteration() {
        let mut lines = Lines::new(b"", 0);
        assert_eq!(lines.next(), Some(b"".as_slice()));
        assert_eq!(lines.next(), None);

        let mut lines = Lines::new(b"a", 0);
        assert_eq!(lines.next(), Some(b"a".as_slice()));
        assert_eq!(lines.next(), None);

        let mut lines = Lines::new(b"a", 1);
        assert_eq!(lines.next(), Some(b"a".as_slice()));
        assert_eq!(lines.next(), None);

        let code = indoc! { br#"
            abc
            cde
            fgh
        "# };

        let mut lines = Lines::new(code, 0);
        assert_eq!(lines.next(), Some(b"abc".as_slice()));
        assert_eq!(lines.next(), Some(b"cde".as_slice()));
        assert_eq!(lines.next(), Some(b"fgh".as_slice()));
        assert_eq!(lines.next(), None);

        let mut lines = Lines::new(code, 3);
        assert_eq!(lines.next(), Some(b"abc".as_slice()));
        assert_eq!(lines.next(), Some(b"cde".as_slice()));
        assert_eq!(lines.next(), Some(b"fgh".as_slice()));
        assert_eq!(lines.next(), None);

        let mut lines = Lines::new(code, 4);
        assert_eq!(lines.next(), Some(b"cde".as_slice()));
        assert_eq!(lines.next(), Some(b"fgh".as_slice()));
        assert_eq!(lines.next(), None);
    }

    /// Test that we can iterate over lines in a backward fashion.
    #[test]
    fn backward_iteration() {
        let mut lines = Lines::new(b"", 0);
        assert_eq!(lines.next_back(), Some(b"".as_slice()));
        assert_eq!(lines.next_back(), None);

        let mut lines = Lines::new(b"a", 0);
        assert_eq!(lines.next_back(), Some(b"a".as_slice()));
        assert_eq!(lines.next_back(), None);

        let mut lines = Lines::new(b"a", 1);
        assert_eq!(lines.next_back(), Some(b"a".as_slice()));
        assert_eq!(lines.next_back(), None);

        let code = indoc! { br#"
            abc
            cde
            fgh
        "# };

        let mut lines = Lines::new(code, 0);
        assert_eq!(lines.next_back(), Some(b"abc".as_slice()));
        assert_eq!(lines.next_back(), None);

        let mut lines = Lines::new(code, 3);
        assert_eq!(lines.next_back(), Some(b"abc".as_slice()));
        assert_eq!(lines.next_back(), None);

        let mut lines = Lines::new(code, 4);
        assert_eq!(lines.next_back(), Some(b"cde".as_slice()));
        assert_eq!(lines.next_back(), Some(b"abc".as_slice()));
        assert_eq!(lines.next_back(), None);

        let mut lines = Lines::new(code, code.len() - 1);
        assert_eq!(lines.next_back(), Some(b"fgh".as_slice()));
        assert_eq!(lines.next_back(), Some(b"cde".as_slice()));
        assert_eq!(lines.next_back(), Some(b"abc".as_slice()));
        assert_eq!(lines.next_back(), None);
    }

    /// Make sure that we fail [`Lines`] construction with an invalid
    /// index.
    #[test]
    #[cfg(debug_assertions)]
    #[should_panic = "invalid index `1` for slice with length `0`"]
    fn invalid_initial_index_1() {
        let _lines = Lines::new(b"", 1);
    }

    /// Make sure that we fail [`Lines`] construction with an invalid
    /// index.
    #[test]
    #[cfg(debug_assertions)]
    #[should_panic = "invalid index `2` for slice with length `1`"]
    fn invalid_initial_index_2() {
        let _lines = Lines::new(b"a", 2);
    }
}