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

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

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