1 // Copyright 2012 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! # Standalone Tests for the Inference Module
13 use std::path::PathBuf;
18 use rustc_resolve::MakeGlobMap;
19 use rustc::middle::region;
20 use rustc::ty::subst::Subst;
21 use rustc::traits::ObligationCause;
22 use rustc::ty::{self, Ty, TyCtxt, TypeFoldable};
23 use rustc::ty::maps::OnDiskCache;
24 use rustc::infer::{self, InferOk, InferResult};
25 use rustc::infer::outlives::env::OutlivesEnvironment;
26 use rustc::infer::type_variable::TypeVariableOrigin;
27 use rustc_metadata::cstore::CStore;
28 use rustc::hir::map as hir_map;
29 use rustc::session::{self, config};
30 use rustc::session::config::{OutputFilenames, OutputTypes};
31 use rustc_data_structures::sync::{self, Lrc};
34 use rustc_target::spec::abi::Abi;
35 use syntax::codemap::{CodeMap, FilePathMapping, FileName};
37 use errors::emitter::Emitter;
38 use errors::{Level, DiagnosticBuilder};
39 use syntax::feature_gate::UnstableFeatures;
40 use syntax::symbol::Symbol;
41 use syntax_pos::DUMMY_SP;
45 struct Env<'a, 'gcx: 'a + 'tcx, 'tcx: 'a> {
46 infcx: &'a infer::InferCtxt<'a, 'gcx, 'tcx>,
47 region_scope_tree: &'a mut region::ScopeTree,
48 param_env: ty::ParamEnv<'tcx>,
56 const EMPTY_SOURCE_STR: &'static str = "#![feature(no_core)] #![no_core]";
58 struct ExpectErrorEmitter {
59 messages: Vec<String>,
62 fn remove_message(e: &mut ExpectErrorEmitter, msg: &str, lvl: Level) {
64 Level::Bug | Level::Fatal | Level::Error => {}
70 debug!("Error: {}", msg);
71 match e.messages.iter().position(|m| msg.contains(m)) {
76 debug!("Unexpected error: {} Expected: {:?}", msg, e.messages);
77 panic!("Unexpected error: {} Expected: {:?}", msg, e.messages);
82 impl Emitter for ExpectErrorEmitter {
83 fn emit(&mut self, db: &DiagnosticBuilder) {
84 remove_message(self, &db.message(), db.level);
85 for child in &db.children {
86 remove_message(self, &child.message(), child.level);
91 fn errors(msgs: &[&str]) -> (Box<Emitter + sync::Send>, usize) {
92 let v = msgs.iter().map(|m| m.to_string()).collect();
93 (box ExpectErrorEmitter { messages: v } as Box<Emitter + sync::Send>, msgs.len())
96 fn test_env<F>(source_string: &str,
97 args: (Box<Emitter + sync::Send>, usize),
101 syntax::with_globals(|| {
102 test_env_impl(source_string, args, body)
106 fn test_env_impl<F>(source_string: &str,
107 (emitter, expected_err_count): (Box<Emitter + sync::Send>, usize),
111 let mut options = config::basic_options();
112 options.debugging_opts.verbose = true;
113 options.unstable_features = UnstableFeatures::Allow;
114 let diagnostic_handler = errors::Handler::with_emitter(true, false, emitter);
116 let sess = session::build_session_(options,
119 Lrc::new(CodeMap::new(FilePathMapping::empty())));
120 let cstore = CStore::new(::get_trans(&sess).metadata_loader());
121 rustc_lint::register_builtins(&mut sess.lint_store.borrow_mut(), Some(&sess));
122 let input = config::Input::Str {
123 name: FileName::Anon,
124 input: source_string.to_string(),
126 let krate = driver::phase_1_parse_input(&driver::CompileController::basic(),
129 let driver::ExpansionResult { defs, resolutions, mut hir_forest, .. } = {
130 driver::phase_2_configure_and_expand(&sess,
138 .expect("phase 2 aborted")
141 let arenas = ty::AllArenas::new();
142 let hir_map = hir_map::map_crate(&sess, &cstore, &mut hir_forest, &defs);
144 // run just enough stuff to build a tcx:
145 let (tx, _rx) = mpsc::channel();
146 let outputs = OutputFilenames {
147 out_directory: PathBuf::new(),
148 out_filestem: String::new(),
149 single_output_file: None,
150 extra: String::new(),
151 outputs: OutputTypes::new(&[]),
153 TyCtxt::create_and_enter(&sess,
155 ty::maps::Providers::default(),
156 ty::maps::Providers::default(),
160 OnDiskCache::new_empty(sess.codemap()),
165 tcx.infer_ctxt().enter(|infcx| {
166 let mut region_scope_tree = region::ScopeTree::default();
167 let param_env = ty::ParamEnv::empty();
170 region_scope_tree: &mut region_scope_tree,
171 param_env: param_env,
173 let outlives_env = OutlivesEnvironment::new(param_env);
174 let def_id = tcx.hir.local_def_id(ast::CRATE_NODE_ID);
175 infcx.resolve_regions_and_report_errors(def_id, ®ion_scope_tree, &outlives_env);
176 assert_eq!(tcx.sess.err_count(), expected_err_count);
181 impl<'a, 'gcx, 'tcx> Env<'a, 'gcx, 'tcx> {
182 pub fn tcx(&self) -> TyCtxt<'a, 'gcx, 'tcx> {
186 pub fn create_region_hierarchy(&mut self, rh: &RH, parent: region::Scope) {
187 let me = region::Scope::Node(rh.id);
188 self.region_scope_tree.record_scope_parent(me, Some(parent));
189 for child_rh in rh.sub {
190 self.create_region_hierarchy(child_rh, me);
194 pub fn create_simple_region_hierarchy(&mut self) {
195 // creates a region hierarchy where 1 is root, 10 and 11 are
196 // children of 1, etc
198 let dscope = region::Scope::Destruction(hir::ItemLocalId(1));
199 self.region_scope_tree.record_scope_parent(dscope, None);
200 self.create_region_hierarchy(&RH {
201 id: hir::ItemLocalId(1),
203 id: hir::ItemLocalId(10),
207 id: hir::ItemLocalId(11),
213 #[allow(dead_code)] // this seems like it could be useful, even if we don't use it now
214 pub fn lookup_item(&self, names: &[String]) -> ast::NodeId {
215 return match search_mod(self, &self.infcx.tcx.hir.krate().module, 0, names) {
218 panic!("no item found: `{}`", names.join("::"));
222 fn search_mod(this: &Env,
226 -> Option<ast::NodeId> {
227 assert!(idx < names.len());
228 for item in &m.item_ids {
229 let item = this.infcx.tcx.hir.expect_item(item.id);
230 if item.name.to_string() == names[idx] {
231 return search(this, item, idx + 1, names);
237 fn search(this: &Env, it: &hir::Item, idx: usize, names: &[String]) -> Option<ast::NodeId> {
238 if idx == names.len() {
242 return match it.node {
244 hir::ItemExternCrate(..) |
246 hir::ItemStatic(..) |
248 hir::ItemForeignMod(..) |
249 hir::ItemGlobalAsm(..) |
250 hir::ItemTy(..) => None,
253 hir::ItemStruct(..) |
256 hir::ItemTraitAlias(..) |
257 hir::ItemImpl(..) => None,
259 hir::ItemMod(ref m) => search_mod(this, m, idx, names),
264 pub fn make_subtype(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
265 match self.infcx.at(&ObligationCause::dummy(), self.param_env).sub(a, b) {
267 Err(ref e) => panic!("Encountered error: {}", e),
271 pub fn is_subtype(&self, a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
272 self.infcx.can_sub(self.param_env, a, b).is_ok()
275 pub fn assert_subtype(&self, a: Ty<'tcx>, b: Ty<'tcx>) {
276 if !self.is_subtype(a, b) {
277 panic!("{} is not a subtype of {}, but it should be", a, b);
281 pub fn assert_eq(&self, a: Ty<'tcx>, b: Ty<'tcx>) {
282 self.assert_subtype(a, b);
283 self.assert_subtype(b, a);
286 pub fn t_fn(&self, input_tys: &[Ty<'tcx>], output_ty: Ty<'tcx>) -> Ty<'tcx> {
287 self.infcx.tcx.mk_fn_ptr(ty::Binder::bind(self.infcx.tcx.mk_fn_sig(
288 input_tys.iter().cloned(),
291 hir::Unsafety::Normal,
296 pub fn t_nil(&self) -> Ty<'tcx> {
297 self.infcx.tcx.mk_nil()
300 pub fn t_pair(&self, ty1: Ty<'tcx>, ty2: Ty<'tcx>) -> Ty<'tcx> {
301 self.infcx.tcx.intern_tup(&[ty1, ty2])
304 pub fn t_param(&self, index: u32) -> Ty<'tcx> {
305 let name = format!("T{}", index);
306 self.infcx.tcx.mk_param(index, Symbol::intern(&name).as_interned_str())
309 pub fn re_early_bound(&self, index: u32, name: &'static str) -> ty::Region<'tcx> {
310 let name = Symbol::intern(name).as_interned_str();
311 self.infcx.tcx.mk_region(ty::ReEarlyBound(ty::EarlyBoundRegion {
312 def_id: self.infcx.tcx.hir.local_def_id(ast::CRATE_NODE_ID),
318 pub fn re_late_bound_with_debruijn(&self,
320 debruijn: ty::DebruijnIndex)
321 -> ty::Region<'tcx> {
322 self.infcx.tcx.mk_region(ty::ReLateBound(debruijn, ty::BrAnon(id)))
325 pub fn t_rptr(&self, r: ty::Region<'tcx>) -> Ty<'tcx> {
326 self.infcx.tcx.mk_imm_ref(r, self.tcx().types.isize)
329 pub fn t_rptr_late_bound(&self, id: u32) -> Ty<'tcx> {
330 let r = self.re_late_bound_with_debruijn(id, ty::DebruijnIndex::new(1));
331 self.infcx.tcx.mk_imm_ref(r, self.tcx().types.isize)
334 pub fn t_rptr_late_bound_with_debruijn(&self,
336 debruijn: ty::DebruijnIndex)
338 let r = self.re_late_bound_with_debruijn(id, debruijn);
339 self.infcx.tcx.mk_imm_ref(r, self.tcx().types.isize)
342 pub fn t_rptr_scope(&self, id: u32) -> Ty<'tcx> {
343 let r = ty::ReScope(region::Scope::Node(hir::ItemLocalId(id)));
344 self.infcx.tcx.mk_imm_ref(self.infcx.tcx.mk_region(r), self.tcx().types.isize)
347 pub fn re_free(&self, id: u32) -> ty::Region<'tcx> {
348 self.infcx.tcx.mk_region(ty::ReFree(ty::FreeRegion {
349 scope: self.infcx.tcx.hir.local_def_id(ast::CRATE_NODE_ID),
350 bound_region: ty::BrAnon(id),
354 pub fn t_rptr_free(&self, id: u32) -> Ty<'tcx> {
355 let r = self.re_free(id);
356 self.infcx.tcx.mk_imm_ref(r, self.tcx().types.isize)
359 pub fn sub(&self, t1: Ty<'tcx>, t2: Ty<'tcx>) -> InferResult<'tcx, ()> {
360 self.infcx.at(&ObligationCause::dummy(), self.param_env).sub(t1, t2)
363 /// Checks that `t1 <: t2` is true (this may register additional
365 pub fn check_sub(&self, t1: Ty<'tcx>, t2: Ty<'tcx>) {
366 match self.sub(t1, t2) {
367 Ok(InferOk { obligations, value: () }) => {
368 // None of these tests should require nested obligations:
369 assert!(obligations.is_empty());
372 panic!("unexpected error computing sub({:?},{:?}): {}", t1, t2, e);
377 /// Checks that `t1 <: t2` is false (this may register additional
379 pub fn check_not_sub(&self, t1: Ty<'tcx>, t2: Ty<'tcx>) {
380 match self.sub(t1, t2) {
383 panic!("unexpected success computing sub({:?},{:?})", t1, t2);
390 fn contravariant_region_ptr_ok() {
391 test_env(EMPTY_SOURCE_STR, errors(&[]), |mut env| {
392 env.create_simple_region_hierarchy();
393 let t_rptr1 = env.t_rptr_scope(1);
394 let t_rptr10 = env.t_rptr_scope(10);
395 env.assert_eq(t_rptr1, t_rptr1);
396 env.assert_eq(t_rptr10, t_rptr10);
397 env.make_subtype(t_rptr1, t_rptr10);
402 fn contravariant_region_ptr_err() {
403 test_env(EMPTY_SOURCE_STR, errors(&["mismatched types"]), |mut env| {
404 env.create_simple_region_hierarchy();
405 let t_rptr1 = env.t_rptr_scope(1);
406 let t_rptr10 = env.t_rptr_scope(10);
407 env.assert_eq(t_rptr1, t_rptr1);
408 env.assert_eq(t_rptr10, t_rptr10);
410 // will cause an error when regions are resolved
411 env.make_subtype(t_rptr10, t_rptr1);
416 fn sub_free_bound_false() {
419 //! fn(&'a isize) <: for<'b> fn(&'b isize)
423 test_env(EMPTY_SOURCE_STR, errors(&[]), |mut env| {
424 env.create_simple_region_hierarchy();
425 let t_rptr_free1 = env.t_rptr_free(1);
426 let t_rptr_bound1 = env.t_rptr_late_bound(1);
427 env.check_not_sub(env.t_fn(&[t_rptr_free1], env.tcx().types.isize),
428 env.t_fn(&[t_rptr_bound1], env.tcx().types.isize));
433 fn sub_bound_free_true() {
436 //! for<'a> fn(&'a isize) <: fn(&'b isize)
440 test_env(EMPTY_SOURCE_STR, errors(&[]), |mut env| {
441 env.create_simple_region_hierarchy();
442 let t_rptr_bound1 = env.t_rptr_late_bound(1);
443 let t_rptr_free1 = env.t_rptr_free(1);
444 env.check_sub(env.t_fn(&[t_rptr_bound1], env.tcx().types.isize),
445 env.t_fn(&[t_rptr_free1], env.tcx().types.isize));
450 fn sub_free_bound_false_infer() {
453 //! fn(_#1) <: for<'b> fn(&'b isize)
455 //! does NOT hold for any instantiation of `_#1`.
457 test_env(EMPTY_SOURCE_STR, errors(&[]), |env| {
458 let t_infer1 = env.infcx.next_ty_var(TypeVariableOrigin::MiscVariable(DUMMY_SP));
459 let t_rptr_bound1 = env.t_rptr_late_bound(1);
460 env.check_not_sub(env.t_fn(&[t_infer1], env.tcx().types.isize),
461 env.t_fn(&[t_rptr_bound1], env.tcx().types.isize));
465 /// Test substituting a bound region into a function, which introduces another level of binding.
466 /// This requires adjusting the Debruijn index.
468 fn subst_ty_renumber_bound() {
470 test_env(EMPTY_SOURCE_STR, errors(&[]), |env| {
472 // Theta = [A -> &'a foo]
474 let t_rptr_bound1 = env.t_rptr_late_bound(1);
478 let t_param = env.t_param(0);
479 env.t_fn(&[t_param], env.t_nil())
482 let substs = env.infcx.tcx.intern_substs(&[t_rptr_bound1.into()]);
483 let t_substituted = t_source.subst(env.infcx.tcx, substs);
485 // t_expected = fn(&'a isize)
487 let t_ptr_bound2 = env.t_rptr_late_bound_with_debruijn(1, ty::DebruijnIndex::new(2));
488 env.t_fn(&[t_ptr_bound2], env.t_nil())
491 debug!("subst_bound: t_source={:?} substs={:?} t_substituted={:?} t_expected={:?}",
497 assert_eq!(t_substituted, t_expected);
501 /// Test substituting a bound region into a function, which introduces another level of binding.
502 /// This requires adjusting the Debruijn index.
504 fn subst_ty_renumber_some_bounds() {
505 test_env(EMPTY_SOURCE_STR, errors(&[]), |env| {
507 // Theta = [A -> &'a foo]
509 let t_rptr_bound1 = env.t_rptr_late_bound(1);
511 // t_source = (A, fn(A))
513 let t_param = env.t_param(0);
514 env.t_pair(t_param, env.t_fn(&[t_param], env.t_nil()))
517 let substs = env.infcx.tcx.intern_substs(&[t_rptr_bound1.into()]);
518 let t_substituted = t_source.subst(env.infcx.tcx, substs);
520 // t_expected = (&'a isize, fn(&'a isize))
522 // but not that the Debruijn index is different in the different cases.
524 let t_rptr_bound2 = env.t_rptr_late_bound_with_debruijn(1, ty::DebruijnIndex::new(2));
525 env.t_pair(t_rptr_bound1, env.t_fn(&[t_rptr_bound2], env.t_nil()))
528 debug!("subst_bound: t_source={:?} substs={:?} t_substituted={:?} t_expected={:?}",
534 assert_eq!(t_substituted, t_expected);
538 /// Test that we correctly compute whether a type has escaping regions or not.
542 test_env(EMPTY_SOURCE_STR, errors(&[]), |mut env| {
544 // Theta = [A -> &'a foo]
545 env.create_simple_region_hierarchy();
547 assert!(!env.t_nil().has_escaping_regions());
549 let t_rptr_free1 = env.t_rptr_free(1);
550 assert!(!t_rptr_free1.has_escaping_regions());
552 let t_rptr_bound1 = env.t_rptr_late_bound_with_debruijn(1, ty::DebruijnIndex::new(1));
553 assert!(t_rptr_bound1.has_escaping_regions());
555 let t_rptr_bound2 = env.t_rptr_late_bound_with_debruijn(1, ty::DebruijnIndex::new(2));
556 assert!(t_rptr_bound2.has_escaping_regions());
559 let t_param = env.t_param(0);
560 assert!(!t_param.has_escaping_regions());
561 let t_fn = env.t_fn(&[t_param], env.t_nil());
562 assert!(!t_fn.has_escaping_regions());
566 /// Test applying a substitution where the value being substituted for an early-bound region is a
567 /// late-bound region.
569 fn subst_region_renumber_region() {
570 test_env(EMPTY_SOURCE_STR, errors(&[]), |env| {
571 let re_bound1 = env.re_late_bound_with_debruijn(1, ty::DebruijnIndex::new(1));
573 // type t_source<'a> = fn(&'a isize)
575 let re_early = env.re_early_bound(0, "'a");
576 env.t_fn(&[env.t_rptr(re_early)], env.t_nil())
579 let substs = env.infcx.tcx.intern_substs(&[re_bound1.into()]);
580 let t_substituted = t_source.subst(env.infcx.tcx, substs);
582 // t_expected = fn(&'a isize)
584 // but not that the Debruijn index is different in the different cases.
586 let t_rptr_bound2 = env.t_rptr_late_bound_with_debruijn(1, ty::DebruijnIndex::new(2));
587 env.t_fn(&[t_rptr_bound2], env.t_nil())
590 debug!("subst_bound: t_source={:?} substs={:?} t_substituted={:?} t_expected={:?}",
596 assert_eq!(t_substituted, t_expected);
602 test_env(EMPTY_SOURCE_STR, errors(&[]), |env| {
603 let tcx = env.infcx.tcx;
604 let int_ty = tcx.types.isize;
605 let usize_ty = tcx.types.usize;
606 let tup1_ty = tcx.intern_tup(&[int_ty, usize_ty, int_ty, usize_ty]);
607 let tup2_ty = tcx.intern_tup(&[tup1_ty, tup1_ty, usize_ty]);
608 let walked: Vec<_> = tup2_ty.walk().collect();
610 [tup2_ty, tup1_ty, int_ty, usize_ty, int_ty, usize_ty, tup1_ty, int_ty,
611 usize_ty, int_ty, usize_ty, usize_ty]);
616 fn walk_ty_skip_subtree() {
617 test_env(EMPTY_SOURCE_STR, errors(&[]), |env| {
618 let tcx = env.infcx.tcx;
619 let int_ty = tcx.types.isize;
620 let usize_ty = tcx.types.usize;
621 let tup1_ty = tcx.intern_tup(&[int_ty, usize_ty, int_ty, usize_ty]);
622 let tup2_ty = tcx.intern_tup(&[tup1_ty, tup1_ty, usize_ty]);
624 // types we expect to see (in order), plus a boolean saying
625 // whether to skip the subtree.
626 let mut expected = vec![(tup2_ty, false),
632 (tup1_ty, true), // skip the isize/usize/isize/usize
636 let mut walker = tup2_ty.walk();
637 while let Some(t) = walker.next() {
638 debug!("walked to {:?}", t);
639 let (expected_ty, skip) = expected.pop().unwrap();
640 assert_eq!(t, expected_ty);
642 walker.skip_current_subtree();
646 assert!(expected.is_empty());