rustc_mir_dataflow/framework/
visitor.rs

1use rustc_middle::mir::{self, BasicBlock, Location};
2
3use super::{Analysis, Direction, Results};
4
5/// Calls the visitor methods in `vis` for every location in every block in `blocks`. Note that
6/// every block in `blocks` must be reachable, and a `debug_assert` checks this.
7pub fn visit_results<'mir, 'tcx, A>(
8    body: &'mir mir::Body<'tcx>,
9    blocks: impl IntoIterator<Item = BasicBlock>,
10    results: &Results<'tcx, A>,
11    vis: &mut impl ResultsVisitor<'tcx, A>,
12) where
13    A: Analysis<'tcx>,
14{
15    let mut state = results.analysis.bottom_value(body);
16
17    #[cfg(debug_assertions)]
18    let reachable_blocks = mir::traversal::reachable_as_bitset(body);
19
20    for block in blocks {
21        #[cfg(debug_assertions)]
22        if !reachable_blocks.contains(block) {
    ::core::panicking::panic("assertion failed: reachable_blocks.contains(block)")
};assert!(reachable_blocks.contains(block));
23
24        let block_data = &body[block];
25        state.clone_from(&results.entry_states[block]);
26        A::Direction::visit_results_in_block(&results.analysis, &mut state, block, block_data, vis);
27    }
28}
29
30/// A visitor over the results of an `Analysis`. Use this when you want to inspect domain values in
31/// many or all locations; use `ResultsCursor` if you want to inspect domain values only in certain
32/// locations.
33pub trait ResultsVisitor<'tcx, A>
34where
35    A: Analysis<'tcx>,
36{
37    /// Called after the "early" effect of the given statement is applied to `state`.
38    fn visit_after_early_statement_effect(
39        &mut self,
40        _analysis: &A,
41        _state: &A::Domain,
42        _statement: &mir::Statement<'tcx>,
43        _location: Location,
44    ) {
45    }
46
47    /// Called after the "primary" effect of the given statement is applied to `state`.
48    fn visit_after_primary_statement_effect(
49        &mut self,
50        _analysis: &A,
51        _state: &A::Domain,
52        _statement: &mir::Statement<'tcx>,
53        _location: Location,
54    ) {
55    }
56
57    /// Called after the "early" effect of the given terminator is applied to `state`.
58    fn visit_after_early_terminator_effect(
59        &mut self,
60        _analysis: &A,
61        _state: &A::Domain,
62        _terminator: &mir::Terminator<'tcx>,
63        _location: Location,
64    ) {
65    }
66
67    /// Called after the "primary" effect of the given terminator is applied to `state`.
68    ///
69    /// The `call_return_effect` (if one exists) will *not* be applied to `state`.
70    fn visit_after_primary_terminator_effect(
71        &mut self,
72        _analysis: &A,
73        _state: &A::Domain,
74        _terminator: &mir::Terminator<'tcx>,
75        _location: Location,
76    ) {
77    }
78}
rustc_mir_dataflow/framework/visitor.rs

rustc_mir_dataflow/framework/
visitor.rs
