rapx 0.7.20

A static analysis platform for Rust program analysis and verification
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

use crate::analysis::{
    Analysis,
    path_analysis::graph::{PathEnumerator, PathGraph},
};
use crate::compat::FxHashMap;
use rustc_hir::{def::DefKind, def_id::DefId};
use rustc_middle::ty::TyCtxt;

use super::PathTree;

/// PathAnalyzer is responsible only for extracting path-sensitive CFG paths.
/// Downstream analyses can reuse these paths without depending on alias logic.
pub struct PathAnalyzer<'tcx> {
    pub tcx: TyCtxt<'tcx>,
    pub debug: bool,
    pub paths: FxHashMap<DefId, PathTree>,
    pub graphs: FxHashMap<DefId, PathGraph<'tcx>>,
}

impl<'tcx> PathAnalyzer<'tcx> {
    pub fn new(tcx: TyCtxt<'tcx>, debug: bool) -> Self {
        Self {
            tcx,
            debug,
            paths: FxHashMap::default(),
            graphs: FxHashMap::default(),
        }
    }

    /// Analyze a single function, returning all whole-CFG paths for it.
    /// Results are cached — subsequent calls for the same `def_id` return
    /// the cached tree.
    pub fn analyze(&mut self, def_id: DefId) -> Option<PathTree> {
        self.analyze_repeat(def_id, 0)
    }

    /// Analyze a single function allowing each SCC postfix segment to
    /// repeat up to `postfix_repeat` additional times.
    pub fn analyze_repeat(&mut self, def_id: DefId, postfix_repeat: usize) -> Option<PathTree> {
        if let Some(paths) = self.paths.get(&def_id) {
            return Some(paths.clone());
        }

        if !self.tcx.is_mir_available(def_id) {
            return None;
        }

        let mut graph = PathGraph::new(self.tcx, def_id);
        graph.find_scc();
        let mut enumerator = PathEnumerator::new(&graph);
        let paths = enumerator.enumerate_paths_repeat(postfix_repeat);

        self.graphs.insert(def_id, graph);
        self.paths.insert(def_id, paths.clone());
        Some(paths)
    }

    pub fn get_fn_paths(&self, def_id: DefId) -> Option<PathTree> {
        self.paths.get(&def_id).cloned()
    }

    pub fn get_all_paths(&self) -> FxHashMap<DefId, PathTree> {
        self.paths.clone()
    }

    /// Analyze all functions in the local crate.
    pub fn analyze_all(&mut self) {
        self.analyze_all_repeat(0);
    }

    /// Analyze all functions with the given postfix-repeat count.
    pub fn analyze_all_repeat(&mut self, postfix_repeat: usize) {
        for local_def_id in self.tcx.iter_local_def_id() {
            if matches!(self.tcx.def_kind(local_def_id), DefKind::Fn) {
                let def_id = local_def_id.to_def_id();
                let _ = self.analyze_repeat(def_id, postfix_repeat);
            }
        }
    }

    pub fn run_with_repeat(&mut self, postfix_repeat: usize) {
        self.analyze_all_repeat(postfix_repeat);
    }
}

impl<'tcx> Analysis for PathAnalyzer<'tcx> {
    fn name(&self) -> &'static str {
        "Path Analysis"
    }

    fn run(&mut self) {
        self.analyze_all();
    }

    fn reset(&mut self) {
        self.paths.clear();
        self.graphs.clear();
    }
}