shuck-semantic 0.0.38

Semantic analysis model for shell scripts with scopes, bindings, and dataflow
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

use super::*;

/// Lazily materialized exact variable-flow indexes for one semantic model.
///
/// This is the shared cache point for dataflow-heavy semantic queries. A rule
/// such as unused assignment and a query such as reaching definitions can reuse
/// the same dense name table, binding/block indexes, and CFG orders without
/// constructing their own per-rule maps. That matters for shell snippets like:
///
/// ```sh
/// make_flag() { flag=1; }
/// make_flag
/// printf '%s\n' "$flag"
/// ```
///
/// where deciding whether `flag` is visible after the call requires the same
/// scope and call summaries that unused-assignment analysis also needs.
#[derive(Debug)]
pub(crate) struct ExactVariableDataflow {
    pub(super) names: NameTable,
    pub(super) binding_data: DenseBindingData,
    pub(super) binding_blocks: Vec<Option<BlockId>>,
    pub(super) reference_blocks: Vec<Option<BlockId>>,
    pub(super) unreachable_blocks: DenseBitSet,
    pub(super) forward_block_order: OnceLock<Box<[BlockId]>>,
    pub(super) backward_block_order: OnceLock<Box<[BlockId]>>,
    pub(super) reaching_definitions: OnceLock<DenseReachingDefinitions>,
    pub(super) initialized_name_states: OnceLock<DenseInitializedNameStates>,
    pub(super) c006_initialized_name_states: OnceLock<DenseInitializedNameStates>,
    pub(super) scope_components: OnceLock<Vec<ExactScopeComponent>>,
}

impl ExactVariableDataflow {
    pub(super) fn forward_block_order(&self, cfg: &ControlFlowGraph) -> &[BlockId] {
        self.forward_block_order
            .get_or_init(|| compute_reverse_postorder(cfg))
    }

    pub(super) fn backward_block_order(&self, cfg: &ControlFlowGraph) -> &[BlockId] {
        self.backward_block_order
            .get_or_init(|| compute_postorder(cfg))
    }

    pub(super) fn reaching_definitions<'a>(
        &'a self,
        context: &DataflowContext<'_>,
    ) -> &'a DenseReachingDefinitions {
        self.reaching_definitions.get_or_init(|| {
            compute_reaching_definitions_dense(
                context.cfg,
                context.bindings,
                &self.binding_data,
                context.entry_bindings,
                self.forward_block_order(context.cfg),
            )
        })
    }

    pub(super) fn initialized_name_states<'a>(
        &'a self,
        context: &DataflowContext<'_>,
    ) -> &'a DenseInitializedNameStates {
        self.initialized_name_states.get_or_init(|| {
            compute_initialized_name_states_dense(
                context.cfg,
                context.bindings,
                &self.binding_data,
                context.entry_bindings,
                self.forward_block_order(context.cfg),
            )
        })
    }

    pub(super) fn c006_initialized_name_states<'a>(
        &'a self,
        context: &DataflowContext<'_>,
    ) -> &'a DenseInitializedNameStates {
        self.c006_initialized_name_states.get_or_init(|| {
            let extra_initialized_names = context
                .parameter_guard_flow_refs
                .iter()
                .copied()
                .filter_map(|reference_id| {
                    let reference = &context.references[reference_id.index()];
                    let block = self.reference_blocks[reference_id.index()]?;
                    let name = self.names.get(&reference.name)?;
                    Some((block, name))
                })
                .collect::<Vec<_>>();
            compute_initialized_name_states_dense_with_extra_name_gens(
                context.cfg,
                context.bindings,
                &self.binding_data,
                context.entry_bindings,
                &extra_initialized_names,
                self.forward_block_order(context.cfg),
            )
        })
    }

    pub(super) fn scope_components<'a>(
        &'a self,
        context: &DataflowContext<'_>,
    ) -> &'a [ExactScopeComponent] {
        self.scope_components
            .get_or_init(|| {
                compute_scope_components_dense(
                    context.cfg,
                    context.scopes.len(),
                    context.cfg.blocks().len(),
                )
            })
            .as_slice()
    }

    pub(crate) fn reaching_bindings_for_reference(
        &self,
        context: &DataflowContext<'_>,
        reference: &Reference,
    ) -> Vec<BindingId> {
        let Some(block_id) = self.reference_blocks[reference.id.index()] else {
            return Vec::new();
        };
        if self.unreachable_blocks.contains(block_id.index()) {
            return Vec::new();
        }

        let Some(name_id) = self.names.get(&reference.name) else {
            return Vec::new();
        };
        let incoming = &self.reaching_definitions(context).reaching_in[block_id.index()];

        self.binding_data.bindings_for_name[name_id.index()]
            .iter_ones()
            .filter(|binding_index| incoming.contains(*binding_index))
            .map(|binding_index| BindingId(binding_index as u32))
            .collect()
    }

    pub(crate) fn binding_block(&self, binding_id: BindingId) -> Option<BlockId> {
        self.binding_blocks[binding_id.index()]
    }

    pub(crate) fn reference_block(&self, reference: &Reference) -> Option<BlockId> {
        self.reference_blocks[reference.id.index()]
    }
}