rapx/analysis/opt/data_collection/suboptimal/
vec_remove.rs

1use annotate_snippets::{Level, Renderer, Snippet};
2
3use once_cell::sync::OnceCell;
4
5use crate::{
6    analysis::{
7        core::dataflow::{graph::*, *},
8        opt::OptCheck,
9        utils::def_path::DefPath,
10    },
11    utils::log::{relative_pos_range, span_to_filename, span_to_line_number, span_to_source_code},
12};
13use rustc_middle::ty::TyCtxt;
14use rustc_span::Span;
15
16struct DefPaths {
17    vec_remove: DefPath,
18    vec_insert: DefPath,
19}
20
21static DEFPATHS: OnceCell<DefPaths> = OnceCell::new();
22
23impl DefPaths {
24    fn new(tcx: &TyCtxt<'_>) -> Self {
25        Self {
26            vec_remove: DefPath::new("std::vec::Vec::remove", tcx),
27            vec_insert: DefPath::new("std::vec::Vec::insert", tcx),
28        }
29    }
30}
31
32pub struct VecRemoveCheck {
33    record: Vec<Span>,
34}
35
36fn is_vec_insert_or_remove(node: &GraphNode) -> bool {
37    let def_paths = DEFPATHS.get().unwrap();
38    for op in node.ops.iter() {
39        if let NodeOp::Call(def_id) = op {
40            if *def_id == def_paths.vec_remove.last_def_id()
41                || *def_id == def_paths.vec_insert.last_def_id()
42            {
43                return true;
44            }
45        }
46    }
47    false
48}
49
50fn is_0_usize(node: &GraphNode) -> bool {
51    for op in node.ops.iter() {
52        if let NodeOp::Const(desc, _) = op {
53            if desc.eq("0_usize") {
54                return true;
55            }
56        }
57    }
58    false
59}
60
61impl OptCheck for VecRemoveCheck {
62    fn new() -> Self {
63        Self { record: vec![] }
64    }
65
66    fn check(&mut self, graph: &Graph, tcx: &TyCtxt) {
67        let _ = &DEFPATHS.get_or_init(|| DefPaths::new(tcx));
68        for node in graph.nodes.iter() {
69            if is_vec_insert_or_remove(node) {
70                let index_edge = &graph.edges[node.in_edges[1]];
71                let index_node = &graph.nodes[index_edge.src];
72                if is_0_usize(index_node) {
73                    self.record.push(node.span);
74                }
75            }
76        }
77    }
78
79    fn report(&self, graph: &Graph) {
80        for span in self.record.iter() {
81            report_vec_remove_bug(graph, *span);
82        }
83    }
84
85    fn cnt(&self) -> usize {
86        self.record.len()
87    }
88}
89
90fn report_vec_remove_bug(graph: &Graph, span: Span) {
91    let code_source = span_to_source_code(graph.span);
92    let filename = span_to_filename(graph.span);
93    let snippet = Snippet::source(&code_source)
94        .line_start(span_to_line_number(graph.span))
95        .origin(&filename)
96        .fold(true)
97        .annotation(
98            Level::Error
99                .span(relative_pos_range(graph.span, span))
100                .label("Vec increasement / decreasement happens here."),
101        );
102    let message = Level::Warning
103        .title("Improper data collection detected")
104        .snippet(snippet)
105        .footer(Level::Help.title("Use VecQueue instead of Vec."));
106    let renderer = Renderer::styled();
107    println!("{}", renderer.render(message));
108}
rapx/analysis/opt/data_collection/suboptimal/vec_remove.rs

rapx/analysis/opt/data_collection/suboptimal/
vec_remove.rs
