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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
use std::collections::HashMap;
use cairo_lang_defs::ids::ModuleFileId;
use cairo_lang_diagnostics::skip_diagnostic;
pub use self::demand::Demand;
use crate::diagnostic::LoweringDiagnosticKind::*;
use crate::diagnostic::LoweringDiagnostics;
use crate::{
BlockId, FlatBlockEnd, FlatLowered, Statement, StatementMatchEnum, StatementMatchExtern,
VarRemapping,
};
mod demand;
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub struct RealBlock(BlockId, usize);
#[derive(Clone)]
pub struct CallsiteInfo<'a> {
return_site: RealBlock,
parent: Option<&'a CallsiteInfo<'a>>,
}
pub struct BorrowChecker<'a> {
diagnostics: &'a mut LoweringDiagnostics,
lowered: &'a FlatLowered,
new_ends: HashMap<BlockId, FlatBlockEnd>,
cache: HashMap<RealBlock, Demand>,
success: bool,
}
impl<'a> BorrowChecker<'a> {
pub fn get_demand(
&mut self,
callsite_info: Option<CallsiteInfo<'_>>,
block: RealBlock,
) -> Demand {
if let Some(cached_result) = self.cache.get(&block) {
return cached_result.clone();
}
let RealBlock(block_id, stmt_offset) = block;
let (real_block_end_offset, mut demand) = self
.get_demand_from_next_split(block_id, stmt_offset, callsite_info.clone())
.unwrap_or_else(|| {
let demand = self.get_block_end_demand(
block_id,
&self.lowered.blocks[block_id].end,
callsite_info,
);
(self.lowered.blocks[block_id].statements.len(), demand)
});
for stmt in self.lowered.blocks[block_id].statements[stmt_offset..real_block_end_offset]
.iter()
.rev()
{
demand.variables_introduced(self, &stmt.outputs());
demand.variables_used(self, &stmt.inputs());
}
if stmt_offset == 0 {
demand.variables_introduced(self, &self.lowered.blocks[block_id].inputs);
}
self.cache.insert(block, demand.clone());
demand
}
fn get_block_end_demand(
&mut self,
block_id: BlockId,
block_end: &FlatBlockEnd,
callsite_info: Option<CallsiteInfo<'_>>,
) -> Demand {
let demand = match block_end {
FlatBlockEnd::Fallthrough(_target_block_id, _remapping)
| FlatBlockEnd::Goto(_target_block_id, _remapping) => todo!(),
FlatBlockEnd::Callsite(remapping) => {
let callsite_info = callsite_info.unwrap();
let mut demand =
self.get_demand(callsite_info.parent.cloned(), callsite_info.return_site);
let mut new_remapping = VarRemapping::default();
for (dst, src) in remapping.iter() {
if demand.vars.swap_remove(dst) {
demand.vars.insert(*src);
new_remapping.insert(*dst, *src);
}
}
assert!(
self.new_ends.insert(block_id, FlatBlockEnd::Callsite(new_remapping)).is_none(),
"Borrow checker cannot visit a block more than once."
);
demand
}
FlatBlockEnd::Return(vars) => Demand { vars: vars.iter().copied().collect() },
FlatBlockEnd::Unreachable => Demand::default(),
};
demand
}
fn get_demand_from_next_split(
&mut self,
block_id: BlockId,
stmt_offset: usize,
callsite_info: Option<CallsiteInfo<'_>>,
) -> Option<(usize, Demand)> {
for (i, stmt) in self.lowered.blocks[block_id].statements[stmt_offset..].iter().enumerate()
{
let new_callsite = Some(CallsiteInfo {
return_site: RealBlock(block_id, stmt_offset + i + 1),
parent: callsite_info.as_ref(),
});
let demand = match stmt {
Statement::MatchExtern(StatementMatchExtern { arms, .. })
| Statement::MatchEnum(StatementMatchEnum { arms, .. }) => {
let arm_demands = arms
.iter()
.map(|(_, arm_block)| {
self.get_demand(new_callsite.clone(), RealBlock(*arm_block, 0))
})
.collect();
let mut demand = self.merge_demands(arm_demands);
demand.variables_used(self, &stmt.inputs()[..]);
demand
}
Statement::Desnap(stmt) => {
let var = &self.lowered.variables[stmt.output];
if !var.duplicatable {
self.diagnostics
.report_by_location(var.location, DesnappingANonCopyableType);
}
continue;
}
Statement::Literal(_)
| Statement::Call(_)
| Statement::StructConstruct(_)
| Statement::StructDestructure(_)
| Statement::EnumConstruct(_)
| Statement::Snapshot(_) => continue,
};
return Some((stmt_offset + i, demand));
}
None
}
fn merge_demands(&mut self, arm_demands: Vec<Demand>) -> Demand {
let mut demand = Demand::default();
for arm_demand in &arm_demands {
demand.vars.extend(arm_demand.vars.iter().copied());
}
for var in demand.vars.iter() {
for arm_demand in &arm_demands {
if !arm_demand.vars.contains(var) {
let var = &self.lowered.variables[*var];
#[allow(clippy::overly_complex_bool_expr)]
if false && !var.droppable {
self.diagnostics.report_by_location(var.location, VariableNotDropped);
}
break;
}
}
}
demand
}
}
pub fn borrow_check(module_file_id: ModuleFileId, lowered: &mut FlatLowered) {
let mut diagnostics = LoweringDiagnostics::new(module_file_id);
diagnostics.diagnostics.extend(std::mem::take(&mut lowered.diagnostics));
if let Ok(root) = lowered.root {
let mut checker = BorrowChecker {
diagnostics: &mut diagnostics,
lowered,
cache: Default::default(),
new_ends: Default::default(),
success: true,
};
let root_demand = checker.get_demand(None, RealBlock(root, 0));
let success = checker.success;
assert!(root_demand.vars.is_empty(), "Undefined variable should not happen at this stage");
for (block_id, new_end) in checker.new_ends {
lowered.blocks[block_id].end = new_end;
}
if !success {
lowered.root = Err(skip_diagnostic());
}
}
lowered.diagnostics = diagnostics.build();
}