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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
use std::collections::VecDeque;
use cairo_lang_defs::ids::FunctionWithBodyId;
use cairo_lang_diagnostics::Maybe;
use cairo_lang_semantic as semantic;
use cairo_lang_semantic::corelib::{get_enum_concrete_variant, get_panic_ty};
use cairo_lang_semantic::GenericArgumentId;
use cairo_lang_utils::ordered_hash_map::OrderedHashMap;
use id_arena::Arena;
use itertools::chain;
use semantic::items::functions::GenericFunctionId;
use crate::blocks::{Blocks, FlatBlocks};
use crate::db::LoweringGroup;
use crate::lower::context::{LoweringContext, LoweringContextBuilder, VarRequest};
use crate::{
BlockId, FlatBlock, FlatBlockEnd, FlatLowered, RefIndex, Statement, StatementCall,
StatementEnumConstruct, StatementMatchEnum, StructuredBlock, StructuredBlockEnd,
StructuredLowered, StructuredStatement, VarRemapping, Variable, VariableId,
};
pub fn lower_panics(
db: &dyn LoweringGroup,
function_id: FunctionWithBodyId,
lowered: &StructuredLowered,
) -> Maybe<FlatLowered> {
let lowering_info = LoweringContextBuilder::new(db, function_id)?;
let mut ctx = lowering_info.ctx()?;
ctx.variables = lowered.variables.clone();
if !db.function_with_body_may_panic(function_id)? {
return Ok(FlatLowered {
diagnostics: Default::default(),
root: lowered.root,
variables: ctx.variables,
blocks: Blocks(
lowered.blocks.0.iter().map(|block| block.clone().try_into().expect("")).collect(),
),
});
}
let func_ok_variant = get_enum_concrete_variant(
db.upcast(),
"PanicResult",
vec![GenericArgumentId::Type(ctx.signature.return_type)],
"Ok",
);
let func_err_variant = get_enum_concrete_variant(
db.upcast(),
"PanicResult",
vec![GenericArgumentId::Type(ctx.signature.return_type)],
"Err",
);
let panic_data_ty = func_err_variant.ty;
let mut ctx = PanicLoweringContext {
ctx,
block_queue: VecDeque::from(lowered.blocks.0.clone()),
flat_blocks: FlatBlocks::new(),
func_ok_variant,
func_err_variant,
panic_data_ty,
};
while let Some(block) = ctx.block_queue.pop_front() {
let mut block_ctx = PanicBlockLoweringContext {
ctx,
current_refs: block.initial_refs,
statements: Vec::new(),
};
for stmt in block.statements {
block_ctx.update_refs(&stmt.ref_updates);
block_ctx.handle_statement(&stmt)?;
}
ctx = block_ctx.handle_end(block.inputs, block.end);
}
Ok(FlatLowered {
diagnostics: Default::default(),
variables: ctx.ctx.variables,
blocks: ctx.flat_blocks,
root: lowered.root,
})
}
struct PanicLoweringContext<'a> {
ctx: LoweringContext<'a>,
block_queue: VecDeque<StructuredBlock>,
flat_blocks: Blocks<FlatBlock>,
func_ok_variant: semantic::ConcreteVariant,
func_err_variant: semantic::ConcreteVariant,
panic_data_ty: semantic::TypeId,
}
impl<'a> PanicLoweringContext<'a> {
pub fn db(&self) -> &dyn LoweringGroup {
self.ctx.db
}
fn enqueue_block(&mut self, block: StructuredBlock) -> BlockId {
self.block_queue.push_back(block);
BlockId(self.flat_blocks.len() + self.block_queue.len())
}
}
struct PanicBlockLoweringContext<'a> {
ctx: PanicLoweringContext<'a>,
current_refs: Vec<VariableId>,
statements: Vec<Statement>,
}
impl<'a> PanicBlockLoweringContext<'a> {
pub fn db(&self) -> &dyn LoweringGroup {
self.ctx.db()
}
pub fn variables_mut(&mut self) -> &mut Arena<Variable> {
&mut self.ctx.ctx.variables
}
fn new_var(&mut self, req: VarRequest) -> VariableId {
self.ctx.ctx.new_var(req)
}
fn update_refs(&mut self, ref_changes: &OrderedHashMap<RefIndex, VariableId>) {
for (ref_index, var_id) in ref_changes.iter() {
self.current_refs[ref_index.0] = *var_id;
}
}
fn handle_statement(&mut self, stmt: &StructuredStatement) -> Maybe<()> {
match &stmt.statement {
crate::Statement::Call(call) => {
let concerete_function = self.db().lookup_intern_function(call.function).function;
match concerete_function.generic_function {
GenericFunctionId::Free(free_callee)
if self.db().function_with_body_may_panic(FunctionWithBodyId::Free(
free_callee,
))? =>
{
self.handle_stmt_call(call)
}
GenericFunctionId::Impl(impl_callee)
if self.db().function_with_body_may_panic(FunctionWithBodyId::Impl(
impl_callee.function,
))? =>
{
self.handle_stmt_call(call)
}
_ => {
self.statements.push(stmt.statement.clone());
}
}
}
_ => {
self.statements.push(stmt.statement.clone());
}
}
Ok(())
}
fn handle_stmt_call(&mut self, call: &StatementCall) {
let mut outputs = call.outputs.clone();
let original_return_var = outputs.pop().unwrap();
let ty = self.variables_mut()[original_return_var].ty;
let location = self.ctx.ctx.variables[original_return_var].location;
let panic_result_var =
self.new_var(VarRequest { ty: get_panic_ty(self.db().upcast(), ty), location });
outputs.push(panic_result_var);
let inner_ok_value = self.new_var(VarRequest { ty, location });
self.statements.push(Statement::Call(StatementCall {
function: call.function,
inputs: call.inputs.clone(),
outputs,
location,
}));
let ty_arg = vec![GenericArgumentId::Type(ty)];
let call_ok_variant =
get_enum_concrete_variant(self.db().upcast(), "PanicResult", ty_arg.clone(), "Ok");
let call_err_variant =
get_enum_concrete_variant(self.db().upcast(), "PanicResult", ty_arg, "Err");
let block_ok = self.ctx.enqueue_block(StructuredBlock {
initial_refs: self.current_refs.clone(),
inputs: vec![inner_ok_value],
statements: vec![],
end: StructuredBlockEnd::Callsite(VarRemapping {
remapping: [(original_return_var, inner_ok_value)].into_iter().collect(),
}),
});
let data_var = self.new_var(VarRequest { ty: self.ctx.panic_data_ty, location });
let block_err = self.ctx.enqueue_block(StructuredBlock {
initial_refs: self.current_refs.clone(),
inputs: vec![data_var],
statements: vec![],
end: StructuredBlockEnd::Panic { refs: self.current_refs.clone(), data: data_var },
});
self.statements.push(Statement::MatchEnum(StatementMatchEnum {
concrete_enum_id: call_ok_variant.concrete_enum_id,
input: panic_result_var,
arms: vec![(call_ok_variant, block_ok), (call_err_variant, block_err)],
}));
}
fn handle_end(
mut self,
inputs: Vec<VariableId>,
end: StructuredBlockEnd,
) -> PanicLoweringContext<'a> {
let end = match end {
StructuredBlockEnd::Callsite(rets) => FlatBlockEnd::Callsite(rets),
StructuredBlockEnd::Panic { refs, data } => {
let ty = self.db().intern_type(semantic::TypeLongId::Concrete(
semantic::ConcreteTypeId::Enum(self.ctx.func_err_variant.concrete_enum_id),
));
let location = self.ctx.ctx.variables[data].location;
let output = self.new_var(VarRequest { ty, location });
self.statements.push(Statement::EnumConstruct(StatementEnumConstruct {
variant: self.ctx.func_err_variant.clone(),
input: data,
output,
}));
FlatBlockEnd::Return(chain!(refs, [output]).collect())
}
StructuredBlockEnd::Return { refs, returns } => {
assert_eq!(
returns.len(),
1,
"Panicable functions should be non-extern and thus have only 1 expr variables"
);
let inner_value_var = returns.into_iter().next().unwrap();
let location = self.ctx.ctx.variables[inner_value_var].location;
let ty = self.db().intern_type(semantic::TypeLongId::Concrete(
semantic::ConcreteTypeId::Enum(self.ctx.func_ok_variant.concrete_enum_id),
));
let output = self.new_var(VarRequest { ty, location });
self.statements.push(Statement::EnumConstruct(StatementEnumConstruct {
variant: self.ctx.func_ok_variant.clone(),
input: inner_value_var,
output,
}));
FlatBlockEnd::Return(chain!(refs, [output]).collect())
}
StructuredBlockEnd::Unreachable => FlatBlockEnd::Unreachable,
};
self.ctx.flat_blocks.alloc(FlatBlock { inputs, statements: self.statements, end });
self.ctx
}
}