Newer
Older
// © 2023, The RefinedRust Developers and Contributors
//
// This Source Code Form is subject to the terms of the BSD-3-clause License.
// If a copy of the BSD-3-clause license was not distributed with this
// file, You can obtain one at https://opensource.org/license/bsd-3-clause/.
//! Part of the function translation responsible for translating the signature and specification.
use std::collections::{btree_map, BTreeMap, HashMap, HashSet};
use log::{info, trace, warn};
use radium::coq;
use rr_rustc_interface::hir::def_id::DefId;
use rr_rustc_interface::middle::mir::interpret::{ConstValue, ErrorHandled, Scalar};
use rr_rustc_interface::middle::mir::tcx::PlaceTy;
use rr_rustc_interface::middle::mir::{
BasicBlock, BasicBlockData, BinOp, Body, BorrowKind, Constant, ConstantKind, Local, LocalKind, Location,
Mutability, NonDivergingIntrinsic, Operand, Place, ProjectionElem, Rvalue, StatementKind, Terminator,
TerminatorKind, UnOp, VarDebugInfoContents,
};
use rr_rustc_interface::middle::ty::fold::TypeFolder;
use rr_rustc_interface::middle::ty::{ConstKind, Ty, TyKind};
use rr_rustc_interface::middle::{mir, ty};
use rr_rustc_interface::{abi, ast, middle};
use typed_arena::Arena;
use crate::base::*;
use crate::body::checked_op_analysis::CheckedOpLocalAnalysis;
use crate::environment::borrowck::facts;
use crate::environment::polonius_info::PoloniusInfo;
use crate::environment::procedure::Procedure;
use crate::environment::{dump_borrowck_info, polonius_info, Environment};
use crate::regions::inclusion_tracker::InclusionTracker;
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
use crate::spec_parsers::parse_utils::ParamLookup;
use crate::spec_parsers::verbose_function_spec_parser::{
ClosureMetaInfo, FunctionRequirements, FunctionSpecParser, VerboseFunctionSpecParser,
};
use crate::traits::{registry, resolution};
use crate::{base, consts, procedures, regions, search, traits, types};
/// A scope of trait attributes mapping to Coq names to be used in a function's spec
struct TraitSpecNameScope {
attrs: HashMap<String, String>,
}
/// When translating a function spec where attributes of a trait are in scope,
/// we create a wrapper to lookup references to the trait's attributes when parsing function specs.
struct FunctionSpecScope<'a, T> {
generics: &'a T,
attrs: &'a TraitSpecNameScope,
}
impl<'a, T: ParamLookup> ParamLookup for FunctionSpecScope<'a, T> {
fn lookup_ty_param(&self, path: &[&str]) -> Option<&radium::LiteralTyParam> {
self.generics.lookup_ty_param(path)
}
fn lookup_lft(&self, lft: &str) -> Option<&radium::Lft> {
self.generics.lookup_lft(lft)
}
fn lookup_literal(&self, path: &[&str]) -> Option<&str> {
if path.len() == 1 {
if let Some(lit) = self.attrs.attrs.get(path[0]) {
return Some(lit);
}
}
self.generics.lookup_literal(path)
}
}
pub struct TX<'a, 'def, 'tcx> {
env: &'def Environment<'tcx>,
/// this needs to be annotated with the right borrowck things
proc: &'def Procedure<'tcx>,
/// the Caesium function buildder
translated_fn: radium::FunctionBuilder<'def>,
/// tracking lifetime inclusions for the generation of lifetime inclusions
inclusion_tracker: InclusionTracker<'a, 'tcx>,
/// registry of other procedures
procedure_registry: &'a procedures::Scope<'def>,
/// registry of consts
const_registry: &'a consts::Scope<'def>,
/// attributes on this function
attrs: &'a [&'a ast::ast::AttrItem],
/// polonius info for this function
info: &'a PoloniusInfo<'a, 'tcx>,
/// translator for types
ty_translator: types::LocalTX<'def, 'tcx>,
/// trait registry in the current scope
trait_registry: &'def registry::TR<'tcx, 'def>,
/// argument types (from the signature, with generics substituted)
inputs: Vec<Ty<'tcx>>,
}
impl<'a, 'def: 'a, 'tcx: 'def> TX<'a, 'def, 'tcx> {
/// Generate a spec for a trait method.
pub fn spec_for_trait_method(
env: &'def Environment<'tcx>,
proc_did: DefId,
name: &str,
spec_name: &str,
attrs: &'a [&'a ast::ast::AttrItem],
ty_translator: &'def types::TX<'def, 'tcx>,
trait_registry: &'def registry::TR<'tcx, 'def>,
) -> Result<radium::FunctionSpec<'def, radium::InnerFunctionSpec<'def>>, TranslationError<'tcx>> {
let mut translated_fn = radium::FunctionBuilder::new(name, spec_name);
let ty: ty::EarlyBinder<Ty<'tcx>> = env.tcx().type_of(proc_did);
let ty = ty.instantiate_identity();
// substs are the generic args of this function (including lifetimes)
// sig is the function signature
let sig = match ty.kind() {
TyKind::FnDef(_def, _args) => {
assert!(ty.is_fn());
let sig = ty.fn_sig(env.tcx());
sig
},
_ => panic!("can not handle non-fns"),
};
info!("Function signature: {:?}", sig);
let params = Self::get_proc_ty_params(env.tcx(), proc_did);
info!("Function generic args: {:?}", params);
let (inputs, output, region_substitution) =
regions::init::replace_fnsig_args_with_polonius_vars(env, params, sig);
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
info!("inputs: {:?}, output: {:?}", inputs, output);
let (type_scope, trait_attrs) = Self::setup_local_scope(
env,
ty_translator,
trait_registry,
proc_did,
params.as_slice(),
&mut translated_fn,
region_substitution,
false,
None,
)?;
let type_translator = types::LocalTX::new(ty_translator, type_scope);
// TODO: add universal constraints (ideally in setup_local_scope)
let spec_builder = Self::process_attrs(
attrs,
&type_translator,
&mut translated_fn,
&trait_attrs,
inputs.as_slice(),
output,
)?;
translated_fn.add_function_spec_from_builder(spec_builder);
translated_fn.try_into().map_err(TranslationError::AttributeError)
}
/// Create a translation instance for a closure.
pub fn new_closure(
env: &'def Environment<'tcx>,
meta: &procedures::Meta,
proc: Procedure<'tcx>,
attrs: &'a [&'a ast::ast::AttrItem],
ty_translator: &'def types::TX<'def, 'tcx>,
trait_registry: &'def registry::TR<'tcx, 'def>,
proc_registry: &'a procedures::Scope<'def>,
const_registry: &'a consts::Scope<'def>,
) -> Result<Self, TranslationError<'tcx>> {
let mut translated_fn = radium::FunctionBuilder::new(meta.get_name(), meta.get_spec_name());
// TODO can we avoid the leak
let proc: &'def Procedure = &*Box::leak(Box::new(proc));
let body = proc.get_mir();
Self::dump_body(body);
let ty: ty::EarlyBinder<Ty<'tcx>> = env.tcx().type_of(proc.get_id());
let ty = ty.instantiate_identity();
let closure_kind = match ty.kind() {
TyKind::Closure(_def, closure_args) => {
assert!(ty.is_closure());
let clos = closure_args.as_closure();
clos.kind()
},
_ => panic!("can not handle non-closures"),
};
let local_decls = &body.local_decls;
let closure_arg = local_decls.get(Local::from_usize(1)).unwrap();
let closure_ty;
match closure_kind {
ty::ClosureKind::Fn => {
if let ty::TyKind::Ref(_, ty, _) = closure_arg.ty.kind() {
closure_ty = ty;
} else {
unreachable!();
}
},
ty::ClosureKind::FnMut => {
if let ty::TyKind::Ref(_, ty, _) = closure_arg.ty.kind() {
closure_ty = ty;
} else {
unreachable!("unexpected type {:?}", closure_arg.ty);
}
},
ty::ClosureKind::FnOnce => {
closure_ty = &closure_arg.ty;
},
}
let parent_args;
let mut capture_regions = Vec::new();
let sig;
let captures;
let upvars_tys;
if let ty::TyKind::Closure(did, closure_args) = closure_ty.kind() {
let clos = closure_args.as_closure();
let tupled_upvars_tys = clos.tupled_upvars_ty();
upvars_tys = clos.upvar_tys();
parent_args = clos.parent_args();
let unnormalized_sig = clos.sig();
sig = unnormalized_sig;
info!("closure sig: {:?}", sig);
captures = env.tcx().closure_captures(did.as_local().unwrap());
info!("Closure has captures: {:?}", captures);
// find additional lifetime parameters
for (place, ty) in captures.iter().zip(clos.upvar_tys().iter()) {
if place.region.is_some() {
// find region from ty
if let ty::TyKind::Ref(region, _, _) = ty.kind() {
capture_regions.push(*region);
}
}
}
info!("Closure capture regions: {:?}", capture_regions);
info!("Closure arg upvar_tys: {:?}", tupled_upvars_tys);
info!("Function signature: {:?}", sig);
info!("Closure generic args: {:?}", parent_args);
} else {
unreachable!();
}
match PoloniusInfo::new(env, proc) {
Ok(info) => {
// TODO: avoid leak
let info: &'def PoloniusInfo = &*Box::leak(Box::new(info));
// For closures, we only handle the parent's args here!
// TODO: do we need to do something special for the parent's late-bound region
// parameters?
// TODO: should we always take the lifetime parameters?
let params = parent_args;
//proc.get_type_params();
info!("Function generic args: {:?}", params);
// dump graphviz files
// color code: red: dying loan, pink: becoming a zombie; green: is zombie
if rrconfig::dump_borrowck_info() {
dump_borrowck_info(env, proc.get_id(), info);
}
let (tupled_inputs, output, mut region_substitution) =
regions::init::replace_fnsig_args_with_polonius_vars(env, params, sig);
// Process the lifetime parameters that come from the captures
for r in capture_regions {
// TODO: problem: we're introducing inconsistent names here.
if let ty::RegionKind::ReVar(r) = r.kind() {
let lft = info.mk_atomic_region(r);
let name = regions::format_atomic_region_direct(&lft, None);
region_substitution.region_names.insert(r, name);
// TODO: add to region_substitution?
} else {
unreachable!();
}
}
// also add the lifetime for the outer reference
let mut maybe_outer_lifetime = None;
if let ty::TyKind::Ref(r, _, _) = closure_arg.ty.kind() {
if let ty::RegionKind::ReVar(r) = r.kind() {
// We need to do some hacks here to find the right Polonius region:
// `r` is the non-placeholder region that the variable gets, but we are
// looking for the corresponding placeholder region
let r2 = regions::init::find_placeholder_region_for(r, info).unwrap();
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
info!("using lifetime {:?} for closure universal", r2);
let lft = info.mk_atomic_region(r2);
let name = regions::format_atomic_region_direct(&lft, None);
region_substitution.region_names.insert(r2, name);
maybe_outer_lifetime = Some(r2);
} else {
unreachable!();
}
}
// detuple the inputs
assert!(tupled_inputs.len() == 1);
let input_tuple_ty = tupled_inputs[0];
let mut inputs = Vec::new();
// push the closure as the first argument
/*
if let Some(r2) = maybe_outer_lifetime {
// in this case, we need to patch the region first
if let ty::TyKind::Ref(_, ty, m) = closure_arg.ty.kind() {
let new_region = ty::Region::new_var(env.tcx(), r2);
inputs.push(env.tcx().mk_ty_from_kind(ty::TyKind::Ref(new_region, *ty, *m)));
}
}
else {
inputs.push(closure_arg.ty);
}
*/
if let ty::TyKind::Tuple(args) = input_tuple_ty.kind() {
inputs.extend(args.iter());
}
info!("inputs({}): {:?}, output: {:?}", inputs.len(), inputs, output);
let mut inclusion_tracker = InclusionTracker::new(info);
// add placeholder subsets
let initial_point: facts::Point = facts::Point {
location: BasicBlock::from_u32(0).start_location(),
typ: facts::PointType::Start,
};
for (r1, r2) in &info.borrowck_in_facts.known_placeholder_subset {
inclusion_tracker.add_static_inclusion(
*r1,
*r2,
info.interner.get_point_index(&initial_point),
);
}
let (type_scope, trait_attrs) = Self::setup_local_scope(
env,
ty_translator,
trait_registry,
proc.get_id(),
params,
&mut translated_fn,
region_substitution,
true,
Some(info),
)?;
let type_translator = types::LocalTX::new(ty_translator, type_scope);
let mut t = Self {
env,
proc,
info,
translated_fn,
inclusion_tracker,
procedure_registry: proc_registry,
attrs,
ty_translator: type_translator,
trait_registry,
const_registry,
inputs: inputs.clone(),
};
// compute meta information needed to generate the spec
let mut translated_upvars_types = Vec::new();
for ty in upvars_tys {
let translated_ty = t.ty_translator.translate_type(ty)?;
translated_upvars_types.push(translated_ty);
}
let meta;
{
let scope = t.ty_translator.scope.borrow();
meta = ClosureMetaInfo {
kind: closure_kind,
captures,
capture_tys: &translated_upvars_types,
closure_lifetime: maybe_outer_lifetime
.map(|x| scope.lifetime_scope.lookup_region(x).unwrap().to_owned()),
};
}
// process attributes
t.process_closure_attrs(&trait_attrs, &inputs, output, meta)?;
Ok(t)
},
Err(err) => Err(TranslationError::UnknownError(format!("{:?}", err))),
}
}
/// Translate the body of a function.
pub fn new(
env: &'def Environment<'tcx>,
meta: &procedures::Meta,
proc: Procedure<'tcx>,
attrs: &'a [&'a ast::ast::AttrItem],
ty_translator: &'def types::TX<'def, 'tcx>,
trait_registry: &'def registry::TR<'tcx, 'def>,
proc_registry: &'a procedures::Scope<'def>,
const_registry: &'a consts::Scope<'def>,
) -> Result<Self, TranslationError<'tcx>> {
let mut translated_fn = radium::FunctionBuilder::new(meta.get_name(), meta.get_spec_name());
// TODO can we avoid the leak
let proc: &'def Procedure = &*Box::leak(Box::new(proc));
let body = proc.get_mir();
Self::dump_body(body);
let ty: ty::EarlyBinder<Ty<'tcx>> = env.tcx().type_of(proc.get_id());
let ty = ty.instantiate_identity();
// substs are the generic args of this function (including lifetimes)
// sig is the function signature
let sig = match ty.kind() {
TyKind::FnDef(_def, _args) => {
assert!(ty.is_fn());
let sig = ty.fn_sig(env.tcx());
sig
},
_ => panic!("can not handle non-fns"),
};
info!("Function signature: {:?}", sig);
match PoloniusInfo::new(env, proc) {
Ok(info) => {
// TODO: avoid leak
let info: &'def PoloniusInfo = &*Box::leak(Box::new(info));
let params = Self::get_proc_ty_params(env.tcx(), proc.get_id());
info!("Function generic args: {:?}", params);
// dump graphviz files
// color code: red: dying loan, pink: becoming a zombie; green: is zombie
if rrconfig::dump_borrowck_info() {
dump_borrowck_info(env, proc.get_id(), info);
}
let (inputs, output, region_substitution) =
regions::init::replace_fnsig_args_with_polonius_vars(env, params, sig);
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
info!("inputs: {:?}, output: {:?}", inputs, output);
let mut inclusion_tracker = InclusionTracker::new(info);
// add placeholder subsets
let initial_point: facts::Point = facts::Point {
location: BasicBlock::from_u32(0).start_location(),
typ: facts::PointType::Start,
};
for (r1, r2) in &info.borrowck_in_facts.known_placeholder_subset {
inclusion_tracker.add_static_inclusion(
*r1,
*r2,
info.interner.get_point_index(&initial_point),
);
}
let (type_scope, trait_attrs) = Self::setup_local_scope(
env,
ty_translator,
trait_registry,
proc.get_id(),
params.as_slice(),
&mut translated_fn,
region_substitution,
true,
Some(info),
)?;
let type_translator = types::LocalTX::new(ty_translator, type_scope);
// process attributes
let mut spec_builder = Self::process_attrs(
attrs,
&type_translator,
&mut translated_fn,
&trait_attrs,
inputs.as_slice(),
output,
)?;
let mut t = Self {
env,
proc,
info,
translated_fn,
inclusion_tracker,
procedure_registry: proc_registry,
attrs,
ty_translator: type_translator,
trait_registry,
const_registry,
inputs: inputs.clone(),
};
if spec_builder.has_spec() {
// add universal constraints
{
let scope = t.ty_translator.scope.borrow();
let universal_constraints = regions::init::get_relevant_universal_constraints(
&scope.lifetime_scope,
&mut t.inclusion_tracker,
t.info,
);
info!("univeral constraints: {:?}", universal_constraints);
for (lft1, lft2) in universal_constraints {
spec_builder.add_lifetime_constraint(lft1, lft2);
}
}
t.translated_fn.add_function_spec_from_builder(spec_builder);
} else {
let spec = t.make_trait_instance_spec()?;
if let Some(spec) = spec {
t.translated_fn.add_trait_function_spec(spec);
} else {
return Err(TranslationError::AttributeError(
"No valid specification provided".to_owned(),
));
}
}
Ok(t)
},
Err(err) => Err(TranslationError::UnknownError(format!("{:?}", err))),
}
}
/// Translate the body of the function.
pub fn translate(
mut self,
spec_arena: &'def Arena<radium::FunctionSpec<'def, radium::InnerFunctionSpec<'def>>>,
) -> Result<radium::Function<'def>, TranslationError<'tcx>> {
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
self.env,
self.procedure_registry,
self.const_registry,
self.trait_registry,
self.ty_translator,
self.proc,
self.attrs,
self.info,
&self.inputs,
self.inclusion_tracker,
self.translated_fn,
)?;
translator.translate(spec_arena)
}
/// Translation that only generates a specification.
pub fn generate_spec(
self,
) -> Result<radium::FunctionSpec<'def, radium::InnerFunctionSpec<'def>>, TranslationError<'tcx>> {
self.translated_fn.try_into().map_err(TranslationError::AttributeError)
}
}
impl<'a, 'def: 'a, 'tcx: 'def> TX<'a, 'def, 'tcx> {
/// Get type parameters of the given procedure.
fn get_proc_ty_params(tcx: ty::TyCtxt<'tcx>, did: DefId) -> ty::GenericArgsRef<'tcx> {
let ty = tcx.type_of(did).instantiate_identity();
match ty.kind() {
ty::TyKind::FnDef(_, params) => params,
ty::TyKind::Closure(_, closure_args) => {
assert!(ty.is_closure());
let clos = closure_args.as_closure();
let parent_args = clos.parent_args();
// TODO: this doesn't include lifetime parameters specific to this closure...
tcx.mk_args(parent_args)
},
_ => panic!("Procedure::new called on a procedure whose type is not TyKind::FnDef!"),
}
}
/// Set up the local generic scope of the function, including type parameters, lifetime
/// parameters, and trait constraints.
fn setup_local_scope(
env: &Environment<'tcx>,
ty_translator: &'def types::TX<'def, 'tcx>,
trait_registry: &'def registry::TR<'tcx, 'def>,
proc_did: DefId,
params: &[ty::GenericArg<'tcx>],
translated_fn: &mut radium::FunctionBuilder<'def>,
region_substitution: regions::EarlyLateRegionMap,
add_trait_specs: bool,
info: Option<&'def PoloniusInfo<'def, 'tcx>>,
) -> Result<(types::FunctionState<'tcx, 'def>, TraitSpecNameScope), TranslationError<'tcx>> {
// add universals to the function
// important: these need to be in the right order!
for (vid, name) in ®ion_substitution.region_names {
translated_fn.add_universal_lifetime(name.to_owned());
}
// enter the procedure
let param_env: ty::ParamEnv<'tcx> = env.tcx().param_env(proc_did);
let type_scope = types::FunctionState::new_with_traits(
proc_did,
env,
env.tcx().mk_args(params),
region_substitution,
param_env,
ty_translator,
trait_registry,
info,
)?;
// add generic args to the fn
let generics = &type_scope.generic_scope;
for t in generics.tyvars() {
translated_fn.add_ty_param(t);
}
// add specs for traits of generics
let trait_uses = type_scope.generic_scope.trait_scope().get_trait_uses();
for ((did, params), trait_ref) in trait_uses {
let trait_use_ref = trait_ref.trait_use.borrow();
let trait_use = trait_use_ref.as_ref().unwrap();
translated_fn.add_trait_requirement(trait_use.clone());
}
// check if we are in the implementation of a trait or trait impl
let mut trait_attr_map = HashMap::new();
if let Some(trait_did) = env.tcx().trait_of_item(proc_did) {
// we are in a trait declaration
if let Some(trait_ref) = trait_registry.lookup_trait(trait_did) {
// make the parameter for the attrs that the function is parametric over
if let Some(trait_use_ref) = type_scope.generic_scope.trait_scope().get_self_trait_use() {
let trait_use_ref = trait_use_ref.trait_use.borrow();
let trait_use = trait_use_ref.as_ref().unwrap();
let param_name = trait_use.make_spec_attrs_param_name();
// add the corresponding record entries to the map
for attr in &trait_ref.declared_attrs {
let record_item = trait_ref.make_spec_attr_name(attr);
trait_attr_map.insert(attr.to_owned(), format!("{param_name}.({record_item})"));
}
}
}
}
if let Some(impl_did) = env.tcx().impl_of_method(proc_did) {
if let Some(trait_did) = env.tcx().trait_id_of_impl(impl_did) {
// we are in a trait impl
if let Some(trait_ref) = trait_registry.lookup_trait(trait_did) {
let attrs = trait_registry.get_impl_attrs_term(impl_did)?;
// add the corresponding record entries to the map
for attr in &trait_ref.declared_attrs {
let record_item = trait_ref.make_spec_attr_name(attr);
trait_attr_map.insert(attr.to_owned(), format!("({attrs}).({record_item})"));
}
}
}
}
let trait_scope = TraitSpecNameScope {
attrs: trait_attr_map,
};
// TODO: can we also setup the lifetime constraints here?
// TODO: understand better how these clauses relate to Polonius
// Note: these constraints do not seem to include implied bounds.
/*
let clauses = param_env.caller_bounds();
info!("looking for outlives clauses");
for cl in clauses.iter() {
let cl_kind = cl.kind();
let cl_kind = cl_kind.skip_binder();
// only look for trait predicates for now
if let ty::ClauseKind::RegionOutlives(region_pred) = cl_kind {
info!("region outlives: {:?} {:?}", region_pred.0, region_pred.1);
}
if let ty::ClauseKind::TypeOutlives(outlives_pred) = cl_kind {
info!("type outlives: {:?} {:?}", outlives_pred.0, outlives_pred.1);
}
}
*/
Ok((type_scope, trait_scope))
}
/// Process extra requirements annotated on a function spec.
fn process_function_requirements(
fn_builder: &mut radium::FunctionBuilder<'def>,
requirements: FunctionRequirements,
) {
for e in requirements.early_coq_params {
fn_builder.add_early_coq_param(e);
}
for e in requirements.late_coq_params {
fn_builder.add_late_coq_param(e);
}
for e in requirements.proof_info.linktime_assumptions {
fn_builder.add_linktime_assumption(e);
}
for e in requirements.proof_info.sidecond_tactics {
fn_builder.add_manual_tactic(e);
}
}
/// Parse and process attributes of this closure.
fn process_closure_attrs<'b>(
&mut self,
trait_attrs: &TraitSpecNameScope,
inputs: &[Ty<'tcx>],
output: Ty<'tcx>,
meta: ClosureMetaInfo<'b, 'tcx, 'def>,
) -> Result<(), TranslationError<'tcx>> {
trace!("entering process_closure_attrs");
let v = self.attrs;
// Translate signature
info!("inputs: {:?}, output: {:?}", inputs, output);
let mut translated_arg_types: Vec<radium::Type<'def>> = Vec::new();
for arg in inputs {
let translated: radium::Type<'def> = self.ty_translator.translate_type(*arg)?;
translated_arg_types.push(translated);
}
let translated_ret_type: radium::Type<'def> = self.ty_translator.translate_type(output)?;
info!("translated function type: {:?} → {}", translated_arg_types, translated_ret_type);
// Determine parser
let parser = rrconfig::attribute_parser();
if parser.as_str() != "verbose" {
trace!("leaving process_closure_attrs");
return Err(TranslationError::UnknownAttributeParser(parser));
}
let mut spec_builder = radium::LiteralFunctionSpecBuilder::new();
// add universal constraints
{
let scope = self.ty_translator.scope.borrow();
let universal_constraints = regions::init::get_relevant_universal_constraints(
&scope.lifetime_scope,
&mut self.inclusion_tracker,
self.info,
);
info!("universal constraints: {:?}", universal_constraints);
for (lft1, lft2) in universal_constraints {
spec_builder.add_lifetime_constraint(lft1, lft2);
}
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
}
let ty_translator = &self.ty_translator;
// Hack: create indirection by tracking the tuple uses we create in here.
// (We need a read reference to the scope, so we can't write to it at the same time)
let mut tuple_uses = HashMap::new();
{
let scope = ty_translator.scope.borrow();
let scope = FunctionSpecScope {
generics: &*scope,
attrs: trait_attrs,
};
let mut parser =
VerboseFunctionSpecParser::new(&translated_arg_types, &translated_ret_type, &scope, |lit| {
ty_translator.translator.intern_literal(lit)
});
parser
.parse_closure_spec(v, &mut spec_builder, meta, |x| {
ty_translator.make_tuple_use(x, Some(&mut tuple_uses))
})
.map_err(TranslationError::AttributeError)?;
Self::process_function_requirements(&mut self.translated_fn, parser.into());
}
let mut scope = ty_translator.scope.borrow_mut();
scope.tuple_uses.extend(tuple_uses);
self.translated_fn.add_function_spec_from_builder(spec_builder);
trace!("leaving process_closure_attrs");
Ok(())
}
/// Parse and process attributes of this function.
fn process_attrs(
attrs: &[&ast::ast::AttrItem],
ty_translator: &types::LocalTX<'def, 'tcx>,
translator: &mut radium::FunctionBuilder<'def>,
trait_attrs: &TraitSpecNameScope,
inputs: &[Ty<'tcx>],
output: Ty<'tcx>,
) -> Result<radium::LiteralFunctionSpecBuilder<'def>, TranslationError<'tcx>> {
info!("inputs: {:?}, output: {:?}", inputs, output);
let mut translated_arg_types: Vec<radium::Type<'def>> = Vec::new();
for arg in inputs {
let translated: radium::Type<'def> = ty_translator.translate_type(*arg)?;
translated_arg_types.push(translated);
}
let translated_ret_type: radium::Type<'def> = ty_translator.translate_type(output)?;
info!("translated function type: {:?} → {}", translated_arg_types, translated_ret_type);
let mut spec_builder = radium::LiteralFunctionSpecBuilder::new();
let parser = rrconfig::attribute_parser();
match parser.as_str() {
"verbose" => {
{
let scope = ty_translator.scope.borrow();
let scope = FunctionSpecScope {
generics: &*scope,
attrs: trait_attrs,
};
let mut parser: VerboseFunctionSpecParser<'_, 'def, _, _> =
VerboseFunctionSpecParser::new(
&translated_arg_types,
&translated_ret_type,
&scope,
|lit| ty_translator.translator.intern_literal(lit),
);
parser
.parse_function_spec(attrs, &mut spec_builder)
.map_err(TranslationError::AttributeError)?;
Self::process_function_requirements(translator, parser.into());
}
Ok(spec_builder)
},
_ => Err(TranslationError::UnknownAttributeParser(parser)),
}
}
/// Make a specification for a method of a trait instance derived from the trait's default spec.
fn make_trait_instance_spec(
&self,
) -> Result<Option<radium::InstantiatedTraitFunctionSpec<'def>>, TranslationError<'tcx>> {
let did = self.proc.get_id();
if let Some(impl_did) = self.env.tcx().impl_of_method(did) {
if let Some(trait_did) = self.env.tcx().trait_id_of_impl(impl_did) {
let trait_ref = self
.trait_registry
.lookup_trait(trait_did)
.ok_or_else(|| TranslationError::TraitResolution(format!("{trait_did:?}")))?;
let fn_name = base::strip_coq_ident(self.env.tcx().item_name(self.proc.get_id()).as_str());
let trait_info = self.trait_registry.get_trait_impl_info(impl_did)?;
//self.trait_registry.lookup_impl(impl_did)?;
let attr_term = self.trait_registry.get_impl_attrs_term(impl_did)?;
return Ok(Some(radium::InstantiatedTraitFunctionSpec::new(trait_info, fn_name, attr_term)));
}
}
Ok(None)
}
fn dump_body(body: &Body) {
// TODO: print to file
//for dec in &body.local_decls {
//info!("Local decl: {:?}", dec);
//}
let basic_blocks = &body.basic_blocks;
for (bb_idx, bb) in basic_blocks.iter_enumerated() {
Self::dump_basic_block(bb_idx, bb);
}
}
/// Dump a basic block as info debug output.
fn dump_basic_block(bb_idx: BasicBlock, bb: &BasicBlockData) {
info!("Basic block {:?}:", bb_idx);
let mut i = 0;
for s in &bb.statements {
info!("{}\t{:?}", i, s);
i += 1;
}
info!("{}\t{:?}", i, bb.terminator());
}
}