src/librustc/ty/context.rs

   1 // Copyright 2012-2015 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.
   4 //
   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.
  10
  11 //! type context book-keeping
  12
  13 use dep_graph::DepGraph;
  14 use dep_graph::{DepNode, DepConstructor};
  15 use errors::DiagnosticBuilder;
  16 use session::Session;
  17 use session::config::{BorrowckMode, OutputFilenames, OptLevel};
  18 use session::config::CrateType::*;
  19 use middle;
  20 use hir::{TraitCandidate, HirId, ItemLocalId};
  21 use hir::def::{Def, Export};
  22 use hir::def_id::{CrateNum, DefId, DefIndex, LOCAL_CRATE};
  23 use hir::map as hir_map;
  24 use hir::map::DefPathHash;
  25 use lint::{self, Lint};
  26 use ich::{StableHashingContext, NodeIdHashingMode};
  27 use infer::canonical::{CanonicalVarInfo, CanonicalVarInfos};
  28 use infer::outlives::free_region_map::FreeRegionMap;
  29 use middle::cstore::{CrateStoreDyn, LinkMeta};
  30 use middle::cstore::EncodedMetadata;
  31 use middle::lang_items;
  32 use middle::resolve_lifetime::{self, ObjectLifetimeDefault};
  33 use middle::stability;
  34 use mir::{self, Mir, interpret};
  35 use mir::interpret::Allocation;
  36 use ty::subst::{Kind, Substs, Subst};
  37 use ty::ReprOptions;
  38 use traits;
  39 use traits::{Clause, Clauses, Goal, Goals};
  40 use ty::{self, Ty, TypeAndMut};
  41 use ty::{TyS, TypeVariants, Slice};
  42 use ty::{AdtKind, AdtDef, ClosureSubsts, GeneratorSubsts, Region, Const};
  43 use ty::{PolyFnSig, InferTy, ParamTy, ProjectionTy, ExistentialPredicate, Predicate};
  44 use ty::RegionKind;
  45 use ty::{TyVar, TyVid, IntVar, IntVid, FloatVar, FloatVid};
  46 use ty::TypeVariants::*;
  47 use ty::GenericParamDefKind;
  48 use ty::layout::{LayoutDetails, TargetDataLayout};
  49 use ty::maps;
  50 use ty::steal::Steal;
  51 use ty::BindingMode;
  52 use ty::CanonicalTy;
  53 use util::nodemap::{DefIdSet, ItemLocalMap};
  54 use util::nodemap::{FxHashMap, FxHashSet};
  55 use rustc_data_structures::accumulate_vec::AccumulateVec;
  56 use rustc_data_structures::stable_hasher::{HashStable, hash_stable_hashmap,
  57                                            StableHasher, StableHasherResult,
  58                                            StableVec};
  59 use arena::{TypedArena, SyncDroplessArena};
  60 use rustc_data_structures::indexed_vec::IndexVec;
  61 use rustc_data_structures::sync::{Lrc, Lock, WorkerLocal};
  62 use std::any::Any;
  63 use std::borrow::Borrow;
  64 use std::cmp::Ordering;
  65 use std::collections::hash_map::{self, Entry};
  66 use std::hash::{Hash, Hasher};
  67 use std::mem;
  68 use std::ops::Deref;
  69 use std::iter;
  70 use std::sync::mpsc;
  71 use std::sync::Arc;
  72 use rustc_target::spec::abi;
  73 use syntax::ast::{self, NodeId};
  74 use syntax::attr;
  75 use syntax::codemap::MultiSpan;
  76 use syntax::feature_gate;
  77 use syntax::symbol::{Symbol, keywords, InternedString};
  78 use syntax_pos::Span;
  79
  80 use hir;
  81
  82 pub struct AllArenas<'tcx> {
  83     pub global: WorkerLocal<GlobalArenas<'tcx>>,
  84     pub interner: SyncDroplessArena,
  85 }
  86
  87 impl<'tcx> AllArenas<'tcx> {
  88     pub fn new() -> Self {
  89         AllArenas {
  90             global: WorkerLocal::new(|_| GlobalArenas::new()),
  91             interner: SyncDroplessArena::new(),
  92         }
  93     }
  94 }
  95
  96 /// Internal storage
  97 pub struct GlobalArenas<'tcx> {
  98     // internings
  99     layout: TypedArena<LayoutDetails>,
 100
 101     // references
 102     generics: TypedArena<ty::Generics>,
 103     trait_def: TypedArena<ty::TraitDef>,
 104     adt_def: TypedArena<ty::AdtDef>,
 105     steal_mir: TypedArena<Steal<Mir<'tcx>>>,
 106     mir: TypedArena<Mir<'tcx>>,
 107     tables: TypedArena<ty::TypeckTables<'tcx>>,
 108     /// miri allocations
 109     const_allocs: TypedArena<interpret::Allocation>,
 110 }
 111
 112 impl<'tcx> GlobalArenas<'tcx> {
 113     pub fn new() -> GlobalArenas<'tcx> {
 114         GlobalArenas {
 115             layout: TypedArena::new(),
 116             generics: TypedArena::new(),
 117             trait_def: TypedArena::new(),
 118             adt_def: TypedArena::new(),
 119             steal_mir: TypedArena::new(),
 120             mir: TypedArena::new(),
 121             tables: TypedArena::new(),
 122             const_allocs: TypedArena::new(),
 123         }
 124     }
 125 }
 126
 127 type InternedSet<'tcx, T> = Lock<FxHashSet<Interned<'tcx, T>>>;
 128
 129 pub struct CtxtInterners<'tcx> {
 130     /// The arena that types, regions, etc are allocated from
 131     arena: &'tcx SyncDroplessArena,
 132
 133     /// Specifically use a speedy hash algorithm for these hash sets,
 134     /// they're accessed quite often.
 135     type_: InternedSet<'tcx, TyS<'tcx>>,
 136     type_list: InternedSet<'tcx, Slice<Ty<'tcx>>>,
 137     substs: InternedSet<'tcx, Substs<'tcx>>,
 138     canonical_var_infos: InternedSet<'tcx, Slice<CanonicalVarInfo>>,
 139     region: InternedSet<'tcx, RegionKind>,
 140     existential_predicates: InternedSet<'tcx, Slice<ExistentialPredicate<'tcx>>>,
 141     predicates: InternedSet<'tcx, Slice<Predicate<'tcx>>>,
 142     const_: InternedSet<'tcx, Const<'tcx>>,
 143     clauses: InternedSet<'tcx, Slice<Clause<'tcx>>>,
 144     goals: InternedSet<'tcx, Slice<Goal<'tcx>>>,
 145 }
 146
 147 impl<'gcx: 'tcx, 'tcx> CtxtInterners<'tcx> {
 148     fn new(arena: &'tcx SyncDroplessArena) -> CtxtInterners<'tcx> {
 149         CtxtInterners {
 150             arena,
 151             type_: Default::default(),
 152             type_list: Default::default(),
 153             substs: Default::default(),
 154             region: Default::default(),
 155             existential_predicates: Default::default(),
 156             canonical_var_infos: Default::default(),
 157             predicates: Default::default(),
 158             const_: Default::default(),
 159             clauses: Default::default(),
 160             goals: Default::default(),
 161         }
 162     }
 163
 164     /// Intern a type
 165     fn intern_ty(
 166         local: &CtxtInterners<'tcx>,
 167         global: &CtxtInterners<'gcx>,
 168         st: TypeVariants<'tcx>
 169     ) -> Ty<'tcx> {
 170         let flags = super::flags::FlagComputation::for_sty(&st);
 171
 172         // HACK(eddyb) Depend on flags being accurate to
 173         // determine that all contents are in the global tcx.
 174         // See comments on Lift for why we can't use that.
 175         if flags.flags.intersects(ty::TypeFlags::KEEP_IN_LOCAL_TCX) {
 176             let mut interner = local.type_.borrow_mut();
 177             if let Some(&Interned(ty)) = interner.get(&st) {
 178                 return ty;
 179             }
 180
 181             let ty_struct = TyS {
 182                 sty: st,
 183                 flags: flags.flags,
 184                 outer_exclusive_binder: flags.outer_exclusive_binder,
 185             };
 186
 187             // Make sure we don't end up with inference
 188             // types/regions in the global interner
 189             if local as *const _ as usize == global as *const _ as usize {
 190                 bug!("Attempted to intern `{:?}` which contains \
 191                     inference types/regions in the global type context",
 192                     &ty_struct);
 193             }
 194
 195             // Don't be &mut TyS.
 196             let ty: Ty<'tcx> = local.arena.alloc(ty_struct);
 197             interner.insert(Interned(ty));
 198             ty
 199         } else {
 200             let mut interner = global.type_.borrow_mut();
 201             if let Some(&Interned(ty)) = interner.get(&st) {
 202                 return ty;
 203             }
 204
 205             let ty_struct = TyS {
 206                 sty: st,
 207                 flags: flags.flags,
 208                 outer_exclusive_binder: flags.outer_exclusive_binder,
 209             };
 210
 211             // This is safe because all the types the ty_struct can point to
 212             // already is in the global arena
 213             let ty_struct: TyS<'gcx> = unsafe {
 214                 mem::transmute(ty_struct)
 215             };
 216
 217             // Don't be &mut TyS.
 218             let ty: Ty<'gcx> = global.arena.alloc(ty_struct);
 219             interner.insert(Interned(ty));
 220             ty
 221         }
 222     }
 223 }
 224
 225 pub struct CommonTypes<'tcx> {
 226     pub bool: Ty<'tcx>,
 227     pub char: Ty<'tcx>,
 228     pub isize: Ty<'tcx>,
 229     pub i8: Ty<'tcx>,
 230     pub i16: Ty<'tcx>,
 231     pub i32: Ty<'tcx>,
 232     pub i64: Ty<'tcx>,
 233     pub i128: Ty<'tcx>,
 234     pub usize: Ty<'tcx>,
 235     pub u8: Ty<'tcx>,
 236     pub u16: Ty<'tcx>,
 237     pub u32: Ty<'tcx>,
 238     pub u64: Ty<'tcx>,
 239     pub u128: Ty<'tcx>,
 240     pub f32: Ty<'tcx>,
 241     pub f64: Ty<'tcx>,
 242     pub never: Ty<'tcx>,
 243     pub err: Ty<'tcx>,
 244
 245     pub re_empty: Region<'tcx>,
 246     pub re_static: Region<'tcx>,
 247     pub re_erased: Region<'tcx>,
 248 }
 249
 250 pub struct LocalTableInContext<'a, V: 'a> {
 251     local_id_root: Option<DefId>,
 252     data: &'a ItemLocalMap<V>
 253 }
 254
 255 /// Validate that the given HirId (respectively its `local_id` part) can be
 256 /// safely used as a key in the tables of a TypeckTable. For that to be
 257 /// the case, the HirId must have the same `owner` as all the other IDs in
 258 /// this table (signified by `local_id_root`). Otherwise the HirId
 259 /// would be in a different frame of reference and using its `local_id`
 260 /// would result in lookup errors, or worse, in silently wrong data being
 261 /// stored/returned.
 262 fn validate_hir_id_for_typeck_tables(local_id_root: Option<DefId>,
 263                                      hir_id: hir::HirId,
 264                                      mut_access: bool) {
 265     if cfg!(debug_assertions) {
 266         if let Some(local_id_root) = local_id_root {
 267             if hir_id.owner != local_id_root.index {
 268                 ty::tls::with(|tcx| {
 269                     let node_id = tcx.hir.hir_to_node_id(hir_id);
 270
 271                     bug!("node {} with HirId::owner {:?} cannot be placed in \
 272                           TypeckTables with local_id_root {:?}",
 273                           tcx.hir.node_to_string(node_id),
 274                           DefId::local(hir_id.owner),
 275                           local_id_root)
 276                 });
 277             }
 278         } else {
 279             // We use "Null Object" TypeckTables in some of the analysis passes.
 280             // These are just expected to be empty and their `local_id_root` is
 281             // `None`. Therefore we cannot verify whether a given `HirId` would
 282             // be a valid key for the given table. Instead we make sure that
 283             // nobody tries to write to such a Null Object table.
 284             if mut_access {
 285                 bug!("access to invalid TypeckTables")
 286             }
 287         }
 288     }
 289 }
 290
 291 impl<'a, V> LocalTableInContext<'a, V> {
 292     pub fn contains_key(&self, id: hir::HirId) -> bool {
 293         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 294         self.data.contains_key(&id.local_id)
 295     }
 296
 297     pub fn get(&self, id: hir::HirId) -> Option<&V> {
 298         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 299         self.data.get(&id.local_id)
 300     }
 301
 302     pub fn iter(&self) -> hash_map::Iter<hir::ItemLocalId, V> {
 303         self.data.iter()
 304     }
 305 }
 306
 307 impl<'a, V> ::std::ops::Index<hir::HirId> for LocalTableInContext<'a, V> {
 308     type Output = V;
 309
 310     fn index(&self, key: hir::HirId) -> &V {
 311         self.get(key).expect("LocalTableInContext: key not found")
 312     }
 313 }
 314
 315 pub struct LocalTableInContextMut<'a, V: 'a> {
 316     local_id_root: Option<DefId>,
 317     data: &'a mut ItemLocalMap<V>
 318 }
 319
 320 impl<'a, V> LocalTableInContextMut<'a, V> {
 321     pub fn get_mut(&mut self, id: hir::HirId) -> Option<&mut V> {
 322         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 323         self.data.get_mut(&id.local_id)
 324     }
 325
 326     pub fn entry(&mut self, id: hir::HirId) -> Entry<hir::ItemLocalId, V> {
 327         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 328         self.data.entry(id.local_id)
 329     }
 330
 331     pub fn insert(&mut self, id: hir::HirId, val: V) -> Option<V> {
 332         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 333         self.data.insert(id.local_id, val)
 334     }
 335
 336     pub fn remove(&mut self, id: hir::HirId) -> Option<V> {
 337         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 338         self.data.remove(&id.local_id)
 339     }
 340 }
 341
 342 #[derive(RustcEncodable, RustcDecodable, Debug)]
 343 pub struct TypeckTables<'tcx> {
 344     /// The HirId::owner all ItemLocalIds in this table are relative to.
 345     pub local_id_root: Option<DefId>,
 346
 347     /// Resolved definitions for `<T>::X` associated paths and
 348     /// method calls, including those of overloaded operators.
 349     type_dependent_defs: ItemLocalMap<Def>,
 350
 351     /// Resolved field indices for field accesses in expressions (`S { field }`, `obj.field`)
 352     /// or patterns (`S { field }`). The index is often useful by itself, but to learn more
 353     /// about the field you also need definition of the variant to which the field
 354     /// belongs, but it may not exist if it's a tuple field (`tuple.0`).
 355     field_indices: ItemLocalMap<usize>,
 356
 357     /// Stores the canonicalized types provided by the user. See also `UserAssertTy` statement in
 358     /// MIR.
 359     user_provided_tys: ItemLocalMap<CanonicalTy<'tcx>>,
 360
 361     /// Stores the types for various nodes in the AST.  Note that this table
 362     /// is not guaranteed to be populated until after typeck.  See
 363     /// typeck::check::fn_ctxt for details.
 364     node_types: ItemLocalMap<Ty<'tcx>>,
 365
 366     /// Stores the type parameters which were substituted to obtain the type
 367     /// of this node.  This only applies to nodes that refer to entities
 368     /// parameterized by type parameters, such as generic fns, types, or
 369     /// other items.
 370     node_substs: ItemLocalMap<&'tcx Substs<'tcx>>,
 371
 372     adjustments: ItemLocalMap<Vec<ty::adjustment::Adjustment<'tcx>>>,
 373
 374     /// Stores the actual binding mode for all instances of hir::BindingAnnotation.
 375     pat_binding_modes: ItemLocalMap<BindingMode>,
 376
 377     /// Stores the types which were implicitly dereferenced in pattern binding modes
 378     /// for later usage in HAIR lowering. For example,
 379     ///
 380     /// ```
 381     /// match &&Some(5i32) {
 382     ///     Some(n) => {},
 383     ///     _ => {},
 384     /// }
 385     /// ```
 386     /// leads to a `vec![&&Option<i32>, &Option<i32>]`. Empty vectors are not stored.
 387     ///
 388     /// See:
 389     /// https://github.com/rust-lang/rfcs/blob/master/text/2005-match-ergonomics.md#definitions
 390     pat_adjustments: ItemLocalMap<Vec<Ty<'tcx>>>,
 391
 392     /// Borrows
 393     pub upvar_capture_map: ty::UpvarCaptureMap<'tcx>,
 394
 395     /// Records the reasons that we picked the kind of each closure;
 396     /// not all closures are present in the map.
 397     closure_kind_origins: ItemLocalMap<(Span, ast::Name)>,
 398
 399     /// For each fn, records the "liberated" types of its arguments
 400     /// and return type. Liberated means that all bound regions
 401     /// (including late-bound regions) are replaced with free
 402     /// equivalents. This table is not used in codegen (since regions
 403     /// are erased there) and hence is not serialized to metadata.
 404     liberated_fn_sigs: ItemLocalMap<ty::FnSig<'tcx>>,
 405
 406     /// For each FRU expression, record the normalized types of the fields
 407     /// of the struct - this is needed because it is non-trivial to
 408     /// normalize while preserving regions. This table is used only in
 409     /// MIR construction and hence is not serialized to metadata.
 410     fru_field_types: ItemLocalMap<Vec<Ty<'tcx>>>,
 411
 412     /// Maps a cast expression to its kind. This is keyed on the
 413     /// *from* expression of the cast, not the cast itself.
 414     cast_kinds: ItemLocalMap<ty::cast::CastKind>,
 415
 416     /// Set of trait imports actually used in the method resolution.
 417     /// This is used for warning unused imports. During type
 418     /// checking, this `Lrc` should not be cloned: it must have a ref-count
 419     /// of 1 so that we can insert things into the set mutably.
 420     pub used_trait_imports: Lrc<DefIdSet>,
 421
 422     /// If any errors occurred while type-checking this body,
 423     /// this field will be set to `true`.
 424     pub tainted_by_errors: bool,
 425
 426     /// Stores the free-region relationships that were deduced from
 427     /// its where clauses and parameter types. These are then
 428     /// read-again by borrowck.
 429     pub free_region_map: FreeRegionMap<'tcx>,
 430 }
 431
 432 impl<'tcx> TypeckTables<'tcx> {
 433     pub fn empty(local_id_root: Option<DefId>) -> TypeckTables<'tcx> {
 434         TypeckTables {
 435             local_id_root,
 436             type_dependent_defs: ItemLocalMap(),
 437             field_indices: ItemLocalMap(),
 438             user_provided_tys: ItemLocalMap(),
 439             node_types: ItemLocalMap(),
 440             node_substs: ItemLocalMap(),
 441             adjustments: ItemLocalMap(),
 442             pat_binding_modes: ItemLocalMap(),
 443             pat_adjustments: ItemLocalMap(),
 444             upvar_capture_map: FxHashMap(),
 445             closure_kind_origins: ItemLocalMap(),
 446             liberated_fn_sigs: ItemLocalMap(),
 447             fru_field_types: ItemLocalMap(),
 448             cast_kinds: ItemLocalMap(),
 449             used_trait_imports: Lrc::new(DefIdSet()),
 450             tainted_by_errors: false,
 451             free_region_map: FreeRegionMap::new(),
 452         }
 453     }
 454
 455     /// Returns the final resolution of a `QPath` in an `Expr` or `Pat` node.
 456     pub fn qpath_def(&self, qpath: &hir::QPath, id: hir::HirId) -> Def {
 457         match *qpath {
 458             hir::QPath::Resolved(_, ref path) => path.def,
 459             hir::QPath::TypeRelative(..) => {
 460                 validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 461                 self.type_dependent_defs.get(&id.local_id).cloned().unwrap_or(Def::Err)
 462             }
 463         }
 464     }
 465
 466     pub fn type_dependent_defs(&self) -> LocalTableInContext<Def> {
 467         LocalTableInContext {
 468             local_id_root: self.local_id_root,
 469             data: &self.type_dependent_defs
 470         }
 471     }
 472
 473     pub fn type_dependent_defs_mut(&mut self) -> LocalTableInContextMut<Def> {
 474         LocalTableInContextMut {
 475             local_id_root: self.local_id_root,
 476             data: &mut self.type_dependent_defs
 477         }
 478     }
 479
 480     pub fn field_indices(&self) -> LocalTableInContext<usize> {
 481         LocalTableInContext {
 482             local_id_root: self.local_id_root,
 483             data: &self.field_indices
 484         }
 485     }
 486
 487     pub fn field_indices_mut(&mut self) -> LocalTableInContextMut<usize> {
 488         LocalTableInContextMut {
 489             local_id_root: self.local_id_root,
 490             data: &mut self.field_indices
 491         }
 492     }
 493
 494     pub fn user_provided_tys(&self) -> LocalTableInContext<CanonicalTy<'tcx>> {
 495         LocalTableInContext {
 496             local_id_root: self.local_id_root,
 497             data: &self.user_provided_tys
 498         }
 499     }
 500
 501     pub fn user_provided_tys_mut(&mut self) -> LocalTableInContextMut<CanonicalTy<'tcx>> {
 502         LocalTableInContextMut {
 503             local_id_root: self.local_id_root,
 504             data: &mut self.user_provided_tys
 505         }
 506     }
 507
 508     pub fn node_types(&self) -> LocalTableInContext<Ty<'tcx>> {
 509         LocalTableInContext {
 510             local_id_root: self.local_id_root,
 511             data: &self.node_types
 512         }
 513     }
 514
 515     pub fn node_types_mut(&mut self) -> LocalTableInContextMut<Ty<'tcx>> {
 516         LocalTableInContextMut {
 517             local_id_root: self.local_id_root,
 518             data: &mut self.node_types
 519         }
 520     }
 521
 522     pub fn node_id_to_type(&self, id: hir::HirId) -> Ty<'tcx> {
 523         match self.node_id_to_type_opt(id) {
 524             Some(ty) => ty,
 525             None => {
 526                 bug!("node_id_to_type: no type for node `{}`",
 527                     tls::with(|tcx| {
 528                         let id = tcx.hir.hir_to_node_id(id);
 529                         tcx.hir.node_to_string(id)
 530                     }))
 531             }
 532         }
 533     }
 534
 535     pub fn node_id_to_type_opt(&self, id: hir::HirId) -> Option<Ty<'tcx>> {
 536         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 537         self.node_types.get(&id.local_id).cloned()
 538     }
 539
 540     pub fn node_substs_mut(&mut self) -> LocalTableInContextMut<&'tcx Substs<'tcx>> {
 541         LocalTableInContextMut {
 542             local_id_root: self.local_id_root,
 543             data: &mut self.node_substs
 544         }
 545     }
 546
 547     pub fn node_substs(&self, id: hir::HirId) -> &'tcx Substs<'tcx> {
 548         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 549         self.node_substs.get(&id.local_id).cloned().unwrap_or(Substs::empty())
 550     }
 551
 552     pub fn node_substs_opt(&self, id: hir::HirId) -> Option<&'tcx Substs<'tcx>> {
 553         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 554         self.node_substs.get(&id.local_id).cloned()
 555     }
 556
 557     // Returns the type of a pattern as a monotype. Like @expr_ty, this function
 558     // doesn't provide type parameter substitutions.
 559     pub fn pat_ty(&self, pat: &hir::Pat) -> Ty<'tcx> {
 560         self.node_id_to_type(pat.hir_id)
 561     }
 562
 563     pub fn pat_ty_opt(&self, pat: &hir::Pat) -> Option<Ty<'tcx>> {
 564         self.node_id_to_type_opt(pat.hir_id)
 565     }
 566
 567     // Returns the type of an expression as a monotype.
 568     //
 569     // NB (1): This is the PRE-ADJUSTMENT TYPE for the expression.  That is, in
 570     // some cases, we insert `Adjustment` annotations such as auto-deref or
 571     // auto-ref.  The type returned by this function does not consider such
 572     // adjustments.  See `expr_ty_adjusted()` instead.
 573     //
 574     // NB (2): This type doesn't provide type parameter substitutions; e.g. if you
 575     // ask for the type of "id" in "id(3)", it will return "fn(&isize) -> isize"
 576     // instead of "fn(ty) -> T with T = isize".
 577     pub fn expr_ty(&self, expr: &hir::Expr) -> Ty<'tcx> {
 578         self.node_id_to_type(expr.hir_id)
 579     }
 580
 581     pub fn expr_ty_opt(&self, expr: &hir::Expr) -> Option<Ty<'tcx>> {
 582         self.node_id_to_type_opt(expr.hir_id)
 583     }
 584
 585     pub fn adjustments(&self) -> LocalTableInContext<Vec<ty::adjustment::Adjustment<'tcx>>> {
 586         LocalTableInContext {
 587             local_id_root: self.local_id_root,
 588             data: &self.adjustments
 589         }
 590     }
 591
 592     pub fn adjustments_mut(&mut self)
 593                            -> LocalTableInContextMut<Vec<ty::adjustment::Adjustment<'tcx>>> {
 594         LocalTableInContextMut {
 595             local_id_root: self.local_id_root,
 596             data: &mut self.adjustments
 597         }
 598     }
 599
 600     pub fn expr_adjustments(&self, expr: &hir::Expr)
 601                             -> &[ty::adjustment::Adjustment<'tcx>] {
 602         validate_hir_id_for_typeck_tables(self.local_id_root, expr.hir_id, false);
 603         self.adjustments.get(&expr.hir_id.local_id).map_or(&[], |a| &a[..])
 604     }
 605
 606     /// Returns the type of `expr`, considering any `Adjustment`
 607     /// entry recorded for that expression.
 608     pub fn expr_ty_adjusted(&self, expr: &hir::Expr) -> Ty<'tcx> {
 609         self.expr_adjustments(expr)
 610             .last()
 611             .map_or_else(|| self.expr_ty(expr), |adj| adj.target)
 612     }
 613
 614     pub fn expr_ty_adjusted_opt(&self, expr: &hir::Expr) -> Option<Ty<'tcx>> {
 615         self.expr_adjustments(expr)
 616             .last()
 617             .map(|adj| adj.target)
 618             .or_else(|| self.expr_ty_opt(expr))
 619     }
 620
 621     pub fn is_method_call(&self, expr: &hir::Expr) -> bool {
 622         // Only paths and method calls/overloaded operators have
 623         // entries in type_dependent_defs, ignore the former here.
 624         if let hir::ExprPath(_) = expr.node {
 625             return false;
 626         }
 627
 628         match self.type_dependent_defs().get(expr.hir_id) {
 629             Some(&Def::Method(_)) => true,
 630             _ => false
 631         }
 632     }
 633
 634     pub fn pat_binding_modes(&self) -> LocalTableInContext<BindingMode> {
 635         LocalTableInContext {
 636             local_id_root: self.local_id_root,
 637             data: &self.pat_binding_modes
 638         }
 639     }
 640
 641     pub fn pat_binding_modes_mut(&mut self)
 642                            -> LocalTableInContextMut<BindingMode> {
 643         LocalTableInContextMut {
 644             local_id_root: self.local_id_root,
 645             data: &mut self.pat_binding_modes
 646         }
 647     }
 648
 649     pub fn pat_adjustments(&self) -> LocalTableInContext<Vec<Ty<'tcx>>> {
 650         LocalTableInContext {
 651             local_id_root: self.local_id_root,
 652             data: &self.pat_adjustments,
 653         }
 654     }
 655
 656     pub fn pat_adjustments_mut(&mut self)
 657                            -> LocalTableInContextMut<Vec<Ty<'tcx>>> {
 658         LocalTableInContextMut {
 659             local_id_root: self.local_id_root,
 660             data: &mut self.pat_adjustments,
 661         }
 662     }
 663
 664     pub fn upvar_capture(&self, upvar_id: ty::UpvarId) -> ty::UpvarCapture<'tcx> {
 665         self.upvar_capture_map[&upvar_id]
 666     }
 667
 668     pub fn closure_kind_origins(&self) -> LocalTableInContext<(Span, ast::Name)> {
 669         LocalTableInContext {
 670             local_id_root: self.local_id_root,
 671             data: &self.closure_kind_origins
 672         }
 673     }
 674
 675     pub fn closure_kind_origins_mut(&mut self) -> LocalTableInContextMut<(Span, ast::Name)> {
 676         LocalTableInContextMut {
 677             local_id_root: self.local_id_root,
 678             data: &mut self.closure_kind_origins
 679         }
 680     }
 681
 682     pub fn liberated_fn_sigs(&self) -> LocalTableInContext<ty::FnSig<'tcx>> {
 683         LocalTableInContext {
 684             local_id_root: self.local_id_root,
 685             data: &self.liberated_fn_sigs
 686         }
 687     }
 688
 689     pub fn liberated_fn_sigs_mut(&mut self) -> LocalTableInContextMut<ty::FnSig<'tcx>> {
 690         LocalTableInContextMut {
 691             local_id_root: self.local_id_root,
 692             data: &mut self.liberated_fn_sigs
 693         }
 694     }
 695
 696     pub fn fru_field_types(&self) -> LocalTableInContext<Vec<Ty<'tcx>>> {
 697         LocalTableInContext {
 698             local_id_root: self.local_id_root,
 699             data: &self.fru_field_types
 700         }
 701     }
 702
 703     pub fn fru_field_types_mut(&mut self) -> LocalTableInContextMut<Vec<Ty<'tcx>>> {
 704         LocalTableInContextMut {
 705             local_id_root: self.local_id_root,
 706             data: &mut self.fru_field_types
 707         }
 708     }
 709
 710     pub fn cast_kinds(&self) -> LocalTableInContext<ty::cast::CastKind> {
 711         LocalTableInContext {
 712             local_id_root: self.local_id_root,
 713             data: &self.cast_kinds
 714         }
 715     }
 716
 717     pub fn cast_kinds_mut(&mut self) -> LocalTableInContextMut<ty::cast::CastKind> {
 718         LocalTableInContextMut {
 719             local_id_root: self.local_id_root,
 720             data: &mut self.cast_kinds
 721         }
 722     }
 723 }
 724
 725 impl<'a, 'gcx> HashStable<StableHashingContext<'a>> for TypeckTables<'gcx> {
 726     fn hash_stable<W: StableHasherResult>(&self,
 727                                           hcx: &mut StableHashingContext<'a>,
 728                                           hasher: &mut StableHasher<W>) {
 729         let ty::TypeckTables {
 730             local_id_root,
 731             ref type_dependent_defs,
 732             ref field_indices,
 733             ref user_provided_tys,
 734             ref node_types,
 735             ref node_substs,
 736             ref adjustments,
 737             ref pat_binding_modes,
 738             ref pat_adjustments,
 739             ref upvar_capture_map,
 740             ref closure_kind_origins,
 741             ref liberated_fn_sigs,
 742             ref fru_field_types,
 743
 744             ref cast_kinds,
 745
 746             ref used_trait_imports,
 747             tainted_by_errors,
 748             ref free_region_map,
 749         } = *self;
 750
 751         hcx.with_node_id_hashing_mode(NodeIdHashingMode::HashDefPath, |hcx| {
 752             type_dependent_defs.hash_stable(hcx, hasher);
 753             field_indices.hash_stable(hcx, hasher);
 754             user_provided_tys.hash_stable(hcx, hasher);
 755             node_types.hash_stable(hcx, hasher);
 756             node_substs.hash_stable(hcx, hasher);
 757             adjustments.hash_stable(hcx, hasher);
 758             pat_binding_modes.hash_stable(hcx, hasher);
 759             pat_adjustments.hash_stable(hcx, hasher);
 760             hash_stable_hashmap(hcx, hasher, upvar_capture_map, |up_var_id, hcx| {
 761                 let ty::UpvarId {
 762                     var_id,
 763                     closure_expr_id
 764                 } = *up_var_id;
 765
 766                 let local_id_root =
 767                     local_id_root.expect("trying to hash invalid TypeckTables");
 768
 769                 let var_owner_def_id = DefId {
 770                     krate: local_id_root.krate,
 771                     index: var_id.owner,
 772                 };
 773                 let closure_def_id = DefId {
 774                     krate: local_id_root.krate,
 775                     index: closure_expr_id.to_def_id().index,
 776                 };
 777                 (hcx.def_path_hash(var_owner_def_id),
 778                  var_id.local_id,
 779                  hcx.def_path_hash(closure_def_id))
 780             });
 781
 782             closure_kind_origins.hash_stable(hcx, hasher);
 783             liberated_fn_sigs.hash_stable(hcx, hasher);
 784             fru_field_types.hash_stable(hcx, hasher);
 785             cast_kinds.hash_stable(hcx, hasher);
 786             used_trait_imports.hash_stable(hcx, hasher);
 787             tainted_by_errors.hash_stable(hcx, hasher);
 788             free_region_map.hash_stable(hcx, hasher);
 789         })
 790     }
 791 }
 792
 793 impl<'tcx> CommonTypes<'tcx> {
 794     fn new(interners: &CtxtInterners<'tcx>) -> CommonTypes<'tcx> {
 795         // Ensure our type representation does not grow
 796         #[cfg(target_pointer_width = "64")]
 797         assert!(mem::size_of::<ty::TypeVariants>() <= 24);
 798         #[cfg(target_pointer_width = "64")]
 799         assert!(mem::size_of::<ty::TyS>() <= 32);
 800
 801         let mk = |sty| CtxtInterners::intern_ty(interners, interners, sty);
 802         let mk_region = |r| {
 803             if let Some(r) = interners.region.borrow().get(&r) {
 804                 return r.0;
 805             }
 806             let r = interners.arena.alloc(r);
 807             interners.region.borrow_mut().insert(Interned(r));
 808             &*r
 809         };
 810         CommonTypes {
 811             bool: mk(TyBool),
 812             char: mk(TyChar),
 813             never: mk(TyNever),
 814             err: mk(TyError),
 815             isize: mk(TyInt(ast::IntTy::Isize)),
 816             i8: mk(TyInt(ast::IntTy::I8)),
 817             i16: mk(TyInt(ast::IntTy::I16)),
 818             i32: mk(TyInt(ast::IntTy::I32)),
 819             i64: mk(TyInt(ast::IntTy::I64)),
 820             i128: mk(TyInt(ast::IntTy::I128)),
 821             usize: mk(TyUint(ast::UintTy::Usize)),
 822             u8: mk(TyUint(ast::UintTy::U8)),
 823             u16: mk(TyUint(ast::UintTy::U16)),
 824             u32: mk(TyUint(ast::UintTy::U32)),
 825             u64: mk(TyUint(ast::UintTy::U64)),
 826             u128: mk(TyUint(ast::UintTy::U128)),
 827             f32: mk(TyFloat(ast::FloatTy::F32)),
 828             f64: mk(TyFloat(ast::FloatTy::F64)),
 829
 830             re_empty: mk_region(RegionKind::ReEmpty),
 831             re_static: mk_region(RegionKind::ReStatic),
 832             re_erased: mk_region(RegionKind::ReErased),
 833         }
 834     }
 835 }
 836
 837 /// The central data structure of the compiler. It stores references
 838 /// to the various **arenas** and also houses the results of the
 839 /// various **compiler queries** that have been performed. See the
 840 /// [rustc guide] for more details.
 841 ///
 842 /// [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/ty.html
 843 #[derive(Copy, Clone)]
 844 pub struct TyCtxt<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
 845     gcx: &'a GlobalCtxt<'gcx>,
 846     interners: &'a CtxtInterners<'tcx>
 847 }
 848
 849 impl<'a, 'gcx, 'tcx> Deref for TyCtxt<'a, 'gcx, 'tcx> {
 850     type Target = &'a GlobalCtxt<'gcx>;
 851     fn deref(&self) -> &Self::Target {
 852         &self.gcx
 853     }
 854 }
 855
 856 pub struct GlobalCtxt<'tcx> {
 857     global_arenas: &'tcx WorkerLocal<GlobalArenas<'tcx>>,
 858     global_interners: CtxtInterners<'tcx>,
 859
 860     cstore: &'tcx CrateStoreDyn,
 861
 862     pub sess: &'tcx Session,
 863
 864     pub dep_graph: DepGraph,
 865
 866     /// This provides access to the incr. comp. on-disk cache for query results.
 867     /// Do not access this directly. It is only meant to be used by
 868     /// `DepGraph::try_mark_green()` and the query infrastructure in `ty::maps`.
 869     pub(crate) on_disk_query_result_cache: maps::OnDiskCache<'tcx>,
 870
 871     /// Common types, pre-interned for your convenience.
 872     pub types: CommonTypes<'tcx>,
 873
 874     /// Map indicating what traits are in scope for places where this
 875     /// is relevant; generated by resolve.
 876     trait_map: FxHashMap<DefIndex,
 877                          Lrc<FxHashMap<ItemLocalId,
 878                                        Lrc<StableVec<TraitCandidate>>>>>,
 879
 880     /// Export map produced by name resolution.
 881     export_map: FxHashMap<DefId, Lrc<Vec<Export>>>,
 882
 883     pub hir: hir_map::Map<'tcx>,
 884
 885     /// A map from DefPathHash -> DefId. Includes DefIds from the local crate
 886     /// as well as all upstream crates. Only populated in incremental mode.
 887     pub def_path_hash_to_def_id: Option<FxHashMap<DefPathHash, DefId>>,
 888
 889     pub maps: maps::Maps<'tcx>,
 890
 891     // Records the free variables refrenced by every closure
 892     // expression. Do not track deps for this, just recompute it from
 893     // scratch every time.
 894     freevars: FxHashMap<DefId, Lrc<Vec<hir::Freevar>>>,
 895
 896     maybe_unused_trait_imports: FxHashSet<DefId>,
 897
 898     maybe_unused_extern_crates: Vec<(DefId, Span)>,
 899
 900     // Internal cache for metadata decoding. No need to track deps on this.
 901     pub rcache: Lock<FxHashMap<ty::CReaderCacheKey, Ty<'tcx>>>,
 902
 903     /// Caches the results of trait selection. This cache is used
 904     /// for things that do not have to do with the parameters in scope.
 905     pub selection_cache: traits::SelectionCache<'tcx>,
 906
 907     /// Caches the results of trait evaluation. This cache is used
 908     /// for things that do not have to do with the parameters in scope.
 909     /// Merge this with `selection_cache`?
 910     pub evaluation_cache: traits::EvaluationCache<'tcx>,
 911
 912     /// The definite name of the current crate after taking into account
 913     /// attributes, commandline parameters, etc.
 914     pub crate_name: Symbol,
 915
 916     /// Data layout specification for the current target.
 917     pub data_layout: TargetDataLayout,
 918
 919     stability_interner: Lock<FxHashSet<&'tcx attr::Stability>>,
 920
 921     /// Stores the value of constants (and deduplicates the actual memory)
 922     allocation_interner: Lock<FxHashSet<&'tcx Allocation>>,
 923
 924     pub alloc_map: Lock<interpret::AllocMap<'tcx, &'tcx Allocation>>,
 925
 926     layout_interner: Lock<FxHashSet<&'tcx LayoutDetails>>,
 927
 928     /// A general purpose channel to throw data out the back towards LLVM worker
 929     /// threads.
 930     ///
 931     /// This is intended to only get used during the codegen phase of the compiler
 932     /// when satisfying the query for a particular codegen unit. Internally in
 933     /// the query it'll send data along this channel to get processed later.
 934     pub tx_to_llvm_workers: Lock<mpsc::Sender<Box<dyn Any + Send>>>,
 935
 936     output_filenames: Arc<OutputFilenames>,
 937 }
 938
 939 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
 940     /// Get the global TyCtxt.
 941     #[inline]
 942     pub fn global_tcx(self) -> TyCtxt<'a, 'gcx, 'gcx> {
 943         TyCtxt {
 944             gcx: self.gcx,
 945             interners: &self.gcx.global_interners,
 946         }
 947     }
 948
 949     pub fn alloc_generics(self, generics: ty::Generics) -> &'gcx ty::Generics {
 950         self.global_arenas.generics.alloc(generics)
 951     }
 952
 953     pub fn alloc_steal_mir(self, mir: Mir<'gcx>) -> &'gcx Steal<Mir<'gcx>> {
 954         self.global_arenas.steal_mir.alloc(Steal::new(mir))
 955     }
 956
 957     pub fn alloc_mir(self, mir: Mir<'gcx>) -> &'gcx Mir<'gcx> {
 958         self.global_arenas.mir.alloc(mir)
 959     }
 960
 961     pub fn alloc_tables(self, tables: ty::TypeckTables<'gcx>) -> &'gcx ty::TypeckTables<'gcx> {
 962         self.global_arenas.tables.alloc(tables)
 963     }
 964
 965     pub fn alloc_trait_def(self, def: ty::TraitDef) -> &'gcx ty::TraitDef {
 966         self.global_arenas.trait_def.alloc(def)
 967     }
 968
 969     pub fn alloc_adt_def(self,
 970                          did: DefId,
 971                          kind: AdtKind,
 972                          variants: Vec<ty::VariantDef>,
 973                          repr: ReprOptions)
 974                          -> &'gcx ty::AdtDef {
 975         let def = ty::AdtDef::new(self, did, kind, variants, repr);
 976         self.global_arenas.adt_def.alloc(def)
 977     }
 978
 979     pub fn alloc_byte_array(self, bytes: &[u8]) -> &'gcx [u8] {
 980         if bytes.is_empty() {
 981             &[]
 982         } else {
 983             self.global_interners.arena.alloc_slice(bytes)
 984         }
 985     }
 986
 987     pub fn alloc_const_slice(self, values: &[&'tcx ty::Const<'tcx>])
 988                              -> &'tcx [&'tcx ty::Const<'tcx>] {
 989         if values.is_empty() {
 990             &[]
 991         } else {
 992             self.interners.arena.alloc_slice(values)
 993         }
 994     }
 995
 996     pub fn alloc_name_const_slice(self, values: &[(ast::Name, &'tcx ty::Const<'tcx>)])
 997                                   -> &'tcx [(ast::Name, &'tcx ty::Const<'tcx>)] {
 998         if values.is_empty() {
 999             &[]
1000         } else {
1001             self.interners.arena.alloc_slice(values)
1002         }
1003     }
1004
1005     pub fn intern_const_alloc(
1006         self,
1007         alloc: Allocation,
1008     ) -> &'gcx Allocation {
1009         let allocs = &mut self.allocation_interner.borrow_mut();
1010         if let Some(alloc) = allocs.get(&alloc) {
1011             return alloc;
1012         }
1013
1014         let interned = self.global_arenas.const_allocs.alloc(alloc);
1015         if let Some(prev) = allocs.replace(interned) {
1016             bug!("Tried to overwrite interned Allocation: {:#?}", prev)
1017         }
1018         interned
1019     }
1020
1021     /// Allocates a byte or string literal for `mir::interpret`
1022     pub fn allocate_bytes(self, bytes: &[u8]) -> interpret::AllocId {
1023         // create an allocation that just contains these bytes
1024         let alloc = interpret::Allocation::from_byte_aligned_bytes(bytes);
1025         let alloc = self.intern_const_alloc(alloc);
1026         self.alloc_map.lock().allocate(alloc)
1027     }
1028
1029     pub fn intern_stability(self, stab: attr::Stability) -> &'gcx attr::Stability {
1030         let mut stability_interner = self.stability_interner.borrow_mut();
1031         if let Some(st) = stability_interner.get(&stab) {
1032             return st;
1033         }
1034
1035         let interned = self.global_interners.arena.alloc(stab);
1036         if let Some(prev) = stability_interner.replace(interned) {
1037             bug!("Tried to overwrite interned Stability: {:?}", prev)
1038         }
1039         interned
1040     }
1041
1042     pub fn intern_layout(self, layout: LayoutDetails) -> &'gcx LayoutDetails {
1043         let mut layout_interner = self.layout_interner.borrow_mut();
1044         if let Some(layout) = layout_interner.get(&layout) {
1045             return layout;
1046         }
1047
1048         let interned = self.global_arenas.layout.alloc(layout);
1049         if let Some(prev) = layout_interner.replace(interned) {
1050             bug!("Tried to overwrite interned Layout: {:?}", prev)
1051         }
1052         interned
1053     }
1054
1055     pub fn lift<T: ?Sized + Lift<'tcx>>(self, value: &T) -> Option<T::Lifted> {
1056         value.lift_to_tcx(self)
1057     }
1058
1059     /// Like lift, but only tries in the global tcx.
1060     pub fn lift_to_global<T: ?Sized + Lift<'gcx>>(self, value: &T) -> Option<T::Lifted> {
1061         value.lift_to_tcx(self.global_tcx())
1062     }
1063
1064     /// Returns true if self is the same as self.global_tcx().
1065     fn is_global(self) -> bool {
1066         let local = self.interners as *const _;
1067         let global = &self.global_interners as *const _;
1068         local as usize == global as usize
1069     }
1070
1071     /// Create a type context and call the closure with a `TyCtxt` reference
1072     /// to the context. The closure enforces that the type context and any interned
1073     /// value (types, substs, etc.) can only be used while `ty::tls` has a valid
1074     /// reference to the context, to allow formatting values that need it.
1075     pub fn create_and_enter<F, R>(s: &'tcx Session,
1076                                   cstore: &'tcx CrateStoreDyn,
1077                                   local_providers: ty::maps::Providers<'tcx>,
1078                                   extern_providers: ty::maps::Providers<'tcx>,
1079                                   arenas: &'tcx AllArenas<'tcx>,
1080                                   resolutions: ty::Resolutions,
1081                                   hir: hir_map::Map<'tcx>,
1082                                   on_disk_query_result_cache: maps::OnDiskCache<'tcx>,
1083                                   crate_name: &str,
1084                                   tx: mpsc::Sender<Box<dyn Any + Send>>,
1085                                   output_filenames: &OutputFilenames,
1086                                   f: F) -> R
1087                                   where F: for<'b> FnOnce(TyCtxt<'b, 'tcx, 'tcx>) -> R
1088     {
1089         let data_layout = TargetDataLayout::parse(&s.target.target).unwrap_or_else(|err| {
1090             s.fatal(&err);
1091         });
1092         let interners = CtxtInterners::new(&arenas.interner);
1093         let common_types = CommonTypes::new(&interners);
1094         let dep_graph = hir.dep_graph.clone();
1095         let max_cnum = cstore.crates_untracked().iter().map(|c| c.as_usize()).max().unwrap_or(0);
1096         let mut providers = IndexVec::from_elem_n(extern_providers, max_cnum + 1);
1097         providers[LOCAL_CRATE] = local_providers;
1098
1099         let def_path_hash_to_def_id = if s.opts.build_dep_graph() {
1100             let upstream_def_path_tables: Vec<(CrateNum, Lrc<_>)> = cstore
1101                 .crates_untracked()
1102                 .iter()
1103                 .map(|&cnum| (cnum, cstore.def_path_table(cnum)))
1104                 .collect();
1105
1106             let def_path_tables = || {
1107                 upstream_def_path_tables
1108                     .iter()
1109                     .map(|&(cnum, ref rc)| (cnum, &**rc))
1110                     .chain(iter::once((LOCAL_CRATE, hir.definitions().def_path_table())))
1111             };
1112
1113             // Precompute the capacity of the hashmap so we don't have to
1114             // re-allocate when populating it.
1115             let capacity = def_path_tables().map(|(_, t)| t.size()).sum::<usize>();
1116
1117             let mut map: FxHashMap<_, _> = FxHashMap::with_capacity_and_hasher(
1118                 capacity,
1119                 ::std::default::Default::default()
1120             );
1121
1122             for (cnum, def_path_table) in def_path_tables() {
1123                 def_path_table.add_def_path_hashes_to(cnum, &mut map);
1124             }
1125
1126             Some(map)
1127         } else {
1128             None
1129         };
1130
1131         let mut trait_map = FxHashMap();
1132         for (k, v) in resolutions.trait_map {
1133             let hir_id = hir.node_to_hir_id(k);
1134             let map = trait_map.entry(hir_id.owner)
1135                 .or_insert_with(|| Lrc::new(FxHashMap()));
1136             Lrc::get_mut(map).unwrap()
1137                             .insert(hir_id.local_id,
1138                                     Lrc::new(StableVec::new(v)));
1139         }
1140
1141         let gcx = &GlobalCtxt {
1142             sess: s,
1143             cstore,
1144             global_arenas: &arenas.global,
1145             global_interners: interners,
1146             dep_graph: dep_graph.clone(),
1147             on_disk_query_result_cache,
1148             types: common_types,
1149             trait_map,
1150             export_map: resolutions.export_map.into_iter().map(|(k, v)| {
1151                 (k, Lrc::new(v))
1152             }).collect(),
1153             freevars: resolutions.freevars.into_iter().map(|(k, v)| {
1154                 (hir.local_def_id(k), Lrc::new(v))
1155             }).collect(),
1156             maybe_unused_trait_imports:
1157                 resolutions.maybe_unused_trait_imports
1158                     .into_iter()
1159                     .map(|id| hir.local_def_id(id))
1160                     .collect(),
1161             maybe_unused_extern_crates:
1162                 resolutions.maybe_unused_extern_crates
1163                     .into_iter()
1164                     .map(|(id, sp)| (hir.local_def_id(id), sp))
1165                     .collect(),
1166             hir,
1167             def_path_hash_to_def_id,
1168             maps: maps::Maps::new(providers),
1169             rcache: Lock::new(FxHashMap()),
1170             selection_cache: traits::SelectionCache::new(),
1171             evaluation_cache: traits::EvaluationCache::new(),
1172             crate_name: Symbol::intern(crate_name),
1173             data_layout,
1174             layout_interner: Lock::new(FxHashSet()),
1175             stability_interner: Lock::new(FxHashSet()),
1176             allocation_interner: Lock::new(FxHashSet()),
1177             alloc_map: Lock::new(interpret::AllocMap::new()),
1178             tx_to_llvm_workers: Lock::new(tx),
1179             output_filenames: Arc::new(output_filenames.clone()),
1180         };
1181
1182         tls::enter_global(gcx, f)
1183     }
1184
1185     pub fn consider_optimizing<T: Fn() -> String>(&self, msg: T) -> bool {
1186         let cname = self.crate_name(LOCAL_CRATE).as_str();
1187         self.sess.consider_optimizing(&cname, msg)
1188     }
1189
1190     pub fn lang_items(self) -> Lrc<middle::lang_items::LanguageItems> {
1191         self.get_lang_items(LOCAL_CRATE)
1192     }
1193
1194     /// Due to missing llvm support for lowering 128 bit math to software emulation
1195     /// (on some targets), the lowering can be done in MIR.
1196     ///
1197     /// This function only exists until said support is implemented.
1198     pub fn is_binop_lang_item(&self, def_id: DefId) -> Option<(mir::BinOp, bool)> {
1199         let items = self.lang_items();
1200         let def_id = Some(def_id);
1201         if items.i128_add_fn() == def_id { Some((mir::BinOp::Add, false)) }
1202         else if items.u128_add_fn() == def_id { Some((mir::BinOp::Add, false)) }
1203         else if items.i128_sub_fn() == def_id { Some((mir::BinOp::Sub, false)) }
1204         else if items.u128_sub_fn() == def_id { Some((mir::BinOp::Sub, false)) }
1205         else if items.i128_mul_fn() == def_id { Some((mir::BinOp::Mul, false)) }
1206         else if items.u128_mul_fn() == def_id { Some((mir::BinOp::Mul, false)) }
1207         else if items.i128_div_fn() == def_id { Some((mir::BinOp::Div, false)) }
1208         else if items.u128_div_fn() == def_id { Some((mir::BinOp::Div, false)) }
1209         else if items.i128_rem_fn() == def_id { Some((mir::BinOp::Rem, false)) }
1210         else if items.u128_rem_fn() == def_id { Some((mir::BinOp::Rem, false)) }
1211         else if items.i128_shl_fn() == def_id { Some((mir::BinOp::Shl, false)) }
1212         else if items.u128_shl_fn() == def_id { Some((mir::BinOp::Shl, false)) }
1213         else if items.i128_shr_fn() == def_id { Some((mir::BinOp::Shr, false)) }
1214         else if items.u128_shr_fn() == def_id { Some((mir::BinOp::Shr, false)) }
1215         else if items.i128_addo_fn() == def_id { Some((mir::BinOp::Add, true)) }
1216         else if items.u128_addo_fn() == def_id { Some((mir::BinOp::Add, true)) }
1217         else if items.i128_subo_fn() == def_id { Some((mir::BinOp::Sub, true)) }
1218         else if items.u128_subo_fn() == def_id { Some((mir::BinOp::Sub, true)) }
1219         else if items.i128_mulo_fn() == def_id { Some((mir::BinOp::Mul, true)) }
1220         else if items.u128_mulo_fn() == def_id { Some((mir::BinOp::Mul, true)) }
1221         else if items.i128_shlo_fn() == def_id { Some((mir::BinOp::Shl, true)) }
1222         else if items.u128_shlo_fn() == def_id { Some((mir::BinOp::Shl, true)) }
1223         else if items.i128_shro_fn() == def_id { Some((mir::BinOp::Shr, true)) }
1224         else if items.u128_shro_fn() == def_id { Some((mir::BinOp::Shr, true)) }
1225         else { None }
1226     }
1227
1228     pub fn stability(self) -> Lrc<stability::Index<'tcx>> {
1229         self.stability_index(LOCAL_CRATE)
1230     }
1231
1232     pub fn crates(self) -> Lrc<Vec<CrateNum>> {
1233         self.all_crate_nums(LOCAL_CRATE)
1234     }
1235
1236     pub fn features(self) -> Lrc<feature_gate::Features> {
1237         self.features_query(LOCAL_CRATE)
1238     }
1239
1240     pub fn def_key(self, id: DefId) -> hir_map::DefKey {
1241         if id.is_local() {
1242             self.hir.def_key(id)
1243         } else {
1244             self.cstore.def_key(id)
1245         }
1246     }
1247
1248     /// Convert a `DefId` into its fully expanded `DefPath` (every
1249     /// `DefId` is really just an interned def-path).
1250     ///
1251     /// Note that if `id` is not local to this crate, the result will
1252     ///  be a non-local `DefPath`.
1253     pub fn def_path(self, id: DefId) -> hir_map::DefPath {
1254         if id.is_local() {
1255             self.hir.def_path(id)
1256         } else {
1257             self.cstore.def_path(id)
1258         }
1259     }
1260
1261     #[inline]
1262     pub fn def_path_hash(self, def_id: DefId) -> hir_map::DefPathHash {
1263         if def_id.is_local() {
1264             self.hir.definitions().def_path_hash(def_id.index)
1265         } else {
1266             self.cstore.def_path_hash(def_id)
1267         }
1268     }
1269
1270     pub fn def_path_debug_str(self, def_id: DefId) -> String {
1271         // We are explicitly not going through queries here in order to get
1272         // crate name and disambiguator since this code is called from debug!()
1273         // statements within the query system and we'd run into endless
1274         // recursion otherwise.
1275         let (crate_name, crate_disambiguator) = if def_id.is_local() {
1276             (self.crate_name.clone(),
1277              self.sess.local_crate_disambiguator())
1278         } else {
1279             (self.cstore.crate_name_untracked(def_id.krate),
1280              self.cstore.crate_disambiguator_untracked(def_id.krate))
1281         };
1282
1283         format!("{}[{}]{}",
1284                 crate_name,
1285                 // Don't print the whole crate disambiguator. That's just
1286                 // annoying in debug output.
1287                 &(crate_disambiguator.to_fingerprint().to_hex())[..4],
1288                 self.def_path(def_id).to_string_no_crate())
1289     }
1290
1291     pub fn metadata_encoding_version(self) -> Vec<u8> {
1292         self.cstore.metadata_encoding_version().to_vec()
1293     }
1294
1295     // Note that this is *untracked* and should only be used within the query
1296     // system if the result is otherwise tracked through queries
1297     pub fn crate_data_as_rc_any(self, cnum: CrateNum) -> Lrc<dyn Any> {
1298         self.cstore.crate_data_as_rc_any(cnum)
1299     }
1300
1301     pub fn create_stable_hashing_context(self) -> StableHashingContext<'a> {
1302         let krate = self.dep_graph.with_ignore(|| self.gcx.hir.krate());
1303
1304         StableHashingContext::new(self.sess,
1305                                   krate,
1306                                   self.hir.definitions(),
1307                                   self.cstore)
1308     }
1309
1310     // This method makes sure that we have a DepNode and a Fingerprint for
1311     // every upstream crate. It needs to be called once right after the tcx is
1312     // created.
1313     // With full-fledged red/green, the method will probably become unnecessary
1314     // as this will be done on-demand.
1315     pub fn allocate_metadata_dep_nodes(self) {
1316         // We cannot use the query versions of crates() and crate_hash(), since
1317         // those would need the DepNodes that we are allocating here.
1318         for cnum in self.cstore.crates_untracked() {
1319             let dep_node = DepNode::new(self, DepConstructor::CrateMetadata(cnum));
1320             let crate_hash = self.cstore.crate_hash_untracked(cnum);
1321             self.dep_graph.with_task(dep_node,
1322                                      self,
1323                                      crate_hash,
1324                                      |_, x| x // No transformation needed
1325             );
1326         }
1327     }
1328
1329     // This method exercises the `in_scope_traits_map` query for all possible
1330     // values so that we have their fingerprints available in the DepGraph.
1331     // This is only required as long as we still use the old dependency tracking
1332     // which needs to have the fingerprints of all input nodes beforehand.
1333     pub fn precompute_in_scope_traits_hashes(self) {
1334         for &def_index in self.trait_map.keys() {
1335             self.in_scope_traits_map(def_index);
1336         }
1337     }
1338
1339     pub fn serialize_query_result_cache<E>(self,
1340                                            encoder: &mut E)
1341                                            -> Result<(), E::Error>
1342         where E: ty::codec::TyEncoder
1343     {
1344         self.on_disk_query_result_cache.serialize(self.global_tcx(), encoder)
1345     }
1346
1347     /// If true, we should use a naive AST walk to determine if match
1348     /// guard could perform bad mutations (or mutable-borrows).
1349     pub fn check_for_mutation_in_guard_via_ast_walk(self) -> bool {
1350         !self.sess.opts.debugging_opts.disable_ast_check_for_mutation_in_guard
1351     }
1352
1353     /// If true, we should use the MIR-based borrowck (we may *also* use
1354     /// the AST-based borrowck).
1355     pub fn use_mir_borrowck(self) -> bool {
1356         self.borrowck_mode().use_mir()
1357     }
1358
1359     /// If true, make MIR codegen for `match` emit a temp that holds a
1360     /// borrow of the input to the match expression.
1361     pub fn generate_borrow_of_any_match_input(&self) -> bool {
1362         self.emit_read_for_match()
1363     }
1364
1365     /// If true, make MIR codegen for `match` emit ReadForMatch
1366     /// statements (which simulate the maximal effect of executing the
1367     /// patterns in a match arm).
1368     pub fn emit_read_for_match(&self) -> bool {
1369         self.use_mir_borrowck() && !self.sess.opts.debugging_opts.nll_dont_emit_read_for_match
1370     }
1371
1372     /// If true, pattern variables for use in guards on match arms
1373     /// will be bound as references to the data, and occurrences of
1374     /// those variables in the guard expression will implicitly
1375     /// dereference those bindings. (See rust-lang/rust#27282.)
1376     pub fn all_pat_vars_are_implicit_refs_within_guards(self) -> bool {
1377         self.borrowck_mode().use_mir()
1378     }
1379
1380     /// If true, we should enable two-phase borrows checks. This is
1381     /// done with either `-Ztwo-phase-borrows` or with
1382     /// `#![feature(nll)]`.
1383     pub fn two_phase_borrows(self) -> bool {
1384         self.features().nll || self.sess.opts.debugging_opts.two_phase_borrows
1385     }
1386
1387     /// What mode(s) of borrowck should we run? AST? MIR? both?
1388     /// (Also considers the `#![feature(nll)]` setting.)
1389     pub fn borrowck_mode(&self) -> BorrowckMode {
1390         match self.sess.opts.borrowck_mode {
1391             mode @ BorrowckMode::Mir |
1392             mode @ BorrowckMode::Compare => mode,
1393
1394             mode @ BorrowckMode::Ast => {
1395                 if self.features().nll {
1396                     BorrowckMode::Mir
1397                 } else {
1398                     mode
1399                 }
1400             }
1401
1402         }
1403     }
1404
1405     /// Should we emit EndRegion MIR statements? These are consumed by
1406     /// MIR borrowck, but not when NLL is used. They are also consumed
1407     /// by the validation stuff.
1408     pub fn emit_end_regions(self) -> bool {
1409         self.sess.opts.debugging_opts.emit_end_regions ||
1410             self.sess.opts.debugging_opts.mir_emit_validate > 0 ||
1411             self.use_mir_borrowck()
1412     }
1413
1414     #[inline]
1415     pub fn share_generics(self) -> bool {
1416         match self.sess.opts.debugging_opts.share_generics {
1417             Some(setting) => setting,
1418             None => {
1419                 self.sess.opts.incremental.is_some() ||
1420                 match self.sess.opts.optimize {
1421                     OptLevel::No   |
1422                     OptLevel::Less |
1423                     OptLevel::Size |
1424                     OptLevel::SizeMin => true,
1425                     OptLevel::Default    |
1426                     OptLevel::Aggressive => false,
1427                 }
1428             }
1429         }
1430     }
1431
1432     #[inline]
1433     pub fn local_crate_exports_generics(self) -> bool {
1434         debug_assert!(self.share_generics());
1435
1436         self.sess.crate_types.borrow().iter().any(|crate_type| {
1437             match crate_type {
1438                 CrateTypeExecutable |
1439                 CrateTypeStaticlib  |
1440                 CrateTypeProcMacro  |
1441                 CrateTypeCdylib     => false,
1442                 CrateTypeRlib       |
1443                 CrateTypeDylib      => true,
1444             }
1445         })
1446     }
1447 }
1448
1449 impl<'a, 'tcx> TyCtxt<'a, 'tcx, 'tcx> {
1450     pub fn encode_metadata(self, link_meta: &LinkMeta)
1451         -> EncodedMetadata
1452     {
1453         self.cstore.encode_metadata(self, link_meta)
1454     }
1455 }
1456
1457 impl<'gcx: 'tcx, 'tcx> GlobalCtxt<'gcx> {
1458     /// Call the closure with a local `TyCtxt` using the given arena.
1459     pub fn enter_local<F, R>(
1460         &self,
1461         arena: &'tcx SyncDroplessArena,
1462         f: F
1463     ) -> R
1464     where
1465         F: for<'a> FnOnce(TyCtxt<'a, 'gcx, 'tcx>) -> R
1466     {
1467         let interners = CtxtInterners::new(arena);
1468         let tcx = TyCtxt {
1469             gcx: self,
1470             interners: &interners,
1471         };
1472         ty::tls::with_related_context(tcx.global_tcx(), |icx| {
1473             let new_icx = ty::tls::ImplicitCtxt {
1474                 tcx,
1475                 query: icx.query.clone(),
1476                 layout_depth: icx.layout_depth,
1477                 task: icx.task,
1478             };
1479             ty::tls::enter_context(&new_icx, |new_icx| {
1480                 f(new_icx.tcx)
1481             })
1482         })
1483     }
1484 }
1485
1486 /// A trait implemented for all X<'a> types which can be safely and
1487 /// efficiently converted to X<'tcx> as long as they are part of the
1488 /// provided TyCtxt<'tcx>.
1489 /// This can be done, for example, for Ty<'tcx> or &'tcx Substs<'tcx>
1490 /// by looking them up in their respective interners.
1491 ///
1492 /// However, this is still not the best implementation as it does
1493 /// need to compare the components, even for interned values.
1494 /// It would be more efficient if TypedArena provided a way to
1495 /// determine whether the address is in the allocated range.
1496 ///
1497 /// None is returned if the value or one of the components is not part
1498 /// of the provided context.
1499 /// For Ty, None can be returned if either the type interner doesn't
1500 /// contain the TypeVariants key or if the address of the interned
1501 /// pointer differs. The latter case is possible if a primitive type,
1502 /// e.g. `()` or `u8`, was interned in a different context.
1503 pub trait Lift<'tcx> {
1504     type Lifted: 'tcx;
1505     fn lift_to_tcx<'a, 'gcx>(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Option<Self::Lifted>;
1506 }
1507
1508 impl<'a, 'tcx> Lift<'tcx> for Ty<'a> {
1509     type Lifted = Ty<'tcx>;
1510     fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>) -> Option<Ty<'tcx>> {
1511         if tcx.interners.arena.in_arena(*self as *const _) {
1512             return Some(unsafe { mem::transmute(*self) });
1513         }
1514         // Also try in the global tcx if we're not that.
1515         if !tcx.is_global() {
1516             self.lift_to_tcx(tcx.global_tcx())
1517         } else {
1518             None
1519         }
1520     }
1521 }
1522
1523 impl<'a, 'tcx> Lift<'tcx> for Region<'a> {
1524     type Lifted = Region<'tcx>;
1525     fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>) -> Option<Region<'tcx>> {
1526         if tcx.interners.arena.in_arena(*self as *const _) {
1527             return Some(unsafe { mem::transmute(*self) });
1528         }
1529         // Also try in the global tcx if we're not that.
1530         if !tcx.is_global() {
1531             self.lift_to_tcx(tcx.global_tcx())
1532         } else {
1533             None
1534         }
1535     }
1536 }
1537
1538 impl<'a, 'tcx> Lift<'tcx> for &'a Goal<'a> {
1539     type Lifted = &'tcx Goal<'tcx>;
1540     fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>) -> Option<&'tcx Goal<'tcx>> {
1541         if tcx.interners.arena.in_arena(*self as *const _) {
1542             return Some(unsafe { mem::transmute(*self) });
1543         }
1544         // Also try in the global tcx if we're not that.
1545         if !tcx.is_global() {
1546             self.lift_to_tcx(tcx.global_tcx())
1547         } else {
1548             None
1549         }
1550     }
1551 }
1552
1553 impl<'a, 'tcx> Lift<'tcx> for &'a Slice<Goal<'a>> {
1554     type Lifted = &'tcx Slice<Goal<'tcx>>;
1555     fn lift_to_tcx<'b, 'gcx>(
1556         &self,
1557         tcx: TyCtxt<'b, 'gcx, 'tcx>,
1558     ) -> Option<&'tcx Slice<Goal<'tcx>>> {
1559         if tcx.interners.arena.in_arena(*self as *const _) {
1560             return Some(unsafe { mem::transmute(*self) });
1561         }
1562         // Also try in the global tcx if we're not that.
1563         if !tcx.is_global() {
1564             self.lift_to_tcx(tcx.global_tcx())
1565         } else {
1566             None
1567         }
1568     }
1569 }
1570
1571 impl<'a, 'tcx> Lift<'tcx> for &'a Slice<Clause<'a>> {
1572     type Lifted = &'tcx Slice<Clause<'tcx>>;
1573     fn lift_to_tcx<'b, 'gcx>(
1574         &self,
1575         tcx: TyCtxt<'b, 'gcx, 'tcx>,
1576     ) -> Option<&'tcx Slice<Clause<'tcx>>> {
1577         if tcx.interners.arena.in_arena(*self as *const _) {
1578             return Some(unsafe { mem::transmute(*self) });
1579         }
1580         // Also try in the global tcx if we're not that.
1581         if !tcx.is_global() {
1582             self.lift_to_tcx(tcx.global_tcx())
1583         } else {
1584             None
1585         }
1586     }
1587 }
1588
1589 impl<'a, 'tcx> Lift<'tcx> for &'a Const<'a> {
1590     type Lifted = &'tcx Const<'tcx>;
1591     fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>) -> Option<&'tcx Const<'tcx>> {
1592         if tcx.interners.arena.in_arena(*self as *const _) {
1593             return Some(unsafe { mem::transmute(*self) });
1594         }
1595         // Also try in the global tcx if we're not that.
1596         if !tcx.is_global() {
1597             self.lift_to_tcx(tcx.global_tcx())
1598         } else {
1599             None
1600         }
1601     }
1602 }
1603
1604 impl<'a, 'tcx> Lift<'tcx> for &'a Substs<'a> {
1605     type Lifted = &'tcx Substs<'tcx>;
1606     fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>) -> Option<&'tcx Substs<'tcx>> {
1607         if self.len() == 0 {
1608             return Some(Slice::empty());
1609         }
1610         if tcx.interners.arena.in_arena(&self[..] as *const _) {
1611             return Some(unsafe { mem::transmute(*self) });
1612         }
1613         // Also try in the global tcx if we're not that.
1614         if !tcx.is_global() {
1615             self.lift_to_tcx(tcx.global_tcx())
1616         } else {
1617             None
1618         }
1619     }
1620 }
1621
1622 impl<'a, 'tcx> Lift<'tcx> for &'a Slice<Ty<'a>> {
1623     type Lifted = &'tcx Slice<Ty<'tcx>>;
1624     fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>)
1625                              -> Option<&'tcx Slice<Ty<'tcx>>> {
1626         if self.len() == 0 {
1627             return Some(Slice::empty());
1628         }
1629         if tcx.interners.arena.in_arena(*self as *const _) {
1630             return Some(unsafe { mem::transmute(*self) });
1631         }
1632         // Also try in the global tcx if we're not that.
1633         if !tcx.is_global() {
1634             self.lift_to_tcx(tcx.global_tcx())
1635         } else {
1636             None
1637         }
1638     }
1639 }
1640
1641 impl<'a, 'tcx> Lift<'tcx> for &'a Slice<ExistentialPredicate<'a>> {
1642     type Lifted = &'tcx Slice<ExistentialPredicate<'tcx>>;
1643     fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>)
1644         -> Option<&'tcx Slice<ExistentialPredicate<'tcx>>> {
1645         if self.is_empty() {
1646             return Some(Slice::empty());
1647         }
1648         if tcx.interners.arena.in_arena(*self as *const _) {
1649             return Some(unsafe { mem::transmute(*self) });
1650         }
1651         // Also try in the global tcx if we're not that.
1652         if !tcx.is_global() {
1653             self.lift_to_tcx(tcx.global_tcx())
1654         } else {
1655             None
1656         }
1657     }
1658 }
1659
1660 impl<'a, 'tcx> Lift<'tcx> for &'a Slice<Predicate<'a>> {
1661     type Lifted = &'tcx Slice<Predicate<'tcx>>;
1662     fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>)
1663         -> Option<&'tcx Slice<Predicate<'tcx>>> {
1664         if self.is_empty() {
1665             return Some(Slice::empty());
1666         }
1667         if tcx.interners.arena.in_arena(*self as *const _) {
1668             return Some(unsafe { mem::transmute(*self) });
1669         }
1670         // Also try in the global tcx if we're not that.
1671         if !tcx.is_global() {
1672             self.lift_to_tcx(tcx.global_tcx())
1673         } else {
1674             None
1675         }
1676     }
1677 }
1678
1679 impl<'a, 'tcx> Lift<'tcx> for &'a Slice<CanonicalVarInfo> {
1680     type Lifted = &'tcx Slice<CanonicalVarInfo>;
1681     fn lift_to_tcx<'b, 'gcx>(&self, tcx: TyCtxt<'b, 'gcx, 'tcx>) -> Option<Self::Lifted> {
1682         if self.len() == 0 {
1683             return Some(Slice::empty());
1684         }
1685         if tcx.interners.arena.in_arena(*self as *const _) {
1686             return Some(unsafe { mem::transmute(*self) });
1687         }
1688         // Also try in the global tcx if we're not that.
1689         if !tcx.is_global() {
1690             self.lift_to_tcx(tcx.global_tcx())
1691         } else {
1692             None
1693         }
1694     }
1695 }
1696
1697 pub mod tls {
1698     use super::{GlobalCtxt, TyCtxt};
1699
1700     use std::cell::Cell;
1701     use std::fmt;
1702     use std::mem;
1703     use syntax_pos;
1704     use ty::maps;
1705     use errors::{Diagnostic, TRACK_DIAGNOSTICS};
1706     use rustc_data_structures::OnDrop;
1707     use rustc_data_structures::sync::{self, Lrc};
1708     use dep_graph::OpenTask;
1709
1710     /// This is the implicit state of rustc. It contains the current
1711     /// TyCtxt and query. It is updated when creating a local interner or
1712     /// executing a new query. Whenever there's a TyCtxt value available
1713     /// you should also have access to an ImplicitCtxt through the functions
1714     /// in this module.
1715     #[derive(Clone)]
1716     pub struct ImplicitCtxt<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
1717         /// The current TyCtxt. Initially created by `enter_global` and updated
1718         /// by `enter_local` with a new local interner
1719         pub tcx: TyCtxt<'a, 'gcx, 'tcx>,
1720
1721         /// The current query job, if any. This is updated by start_job in
1722         /// ty::maps::plumbing when executing a query
1723         pub query: Option<Lrc<maps::QueryJob<'gcx>>>,
1724
1725         /// Used to prevent layout from recursing too deeply.
1726         pub layout_depth: usize,
1727
1728         /// The current dep graph task. This is used to add dependencies to queries
1729         /// when executing them
1730         pub task: &'a OpenTask,
1731     }
1732
1733     // A thread local value which stores a pointer to the current ImplicitCtxt
1734     thread_local!(static TLV: Cell<usize> = Cell::new(0));
1735
1736     fn set_tlv<F: FnOnce() -> R, R>(value: usize, f: F) -> R {
1737         let old = get_tlv();
1738         let _reset = OnDrop(move || TLV.with(|tlv| tlv.set(old)));
1739         TLV.with(|tlv| tlv.set(value));
1740         f()
1741     }
1742
1743     fn get_tlv() -> usize {
1744         TLV.with(|tlv| tlv.get())
1745     }
1746
1747     /// This is a callback from libsyntax as it cannot access the implicit state
1748     /// in librustc otherwise
1749     fn span_debug(span: syntax_pos::Span, f: &mut fmt::Formatter) -> fmt::Result {
1750         with(|tcx| {
1751             write!(f, "{}", tcx.sess.codemap().span_to_string(span))
1752         })
1753     }
1754
1755     /// This is a callback from libsyntax as it cannot access the implicit state
1756     /// in librustc otherwise. It is used to when diagnostic messages are
1757     /// emitted and stores them in the current query, if there is one.
1758     fn track_diagnostic(diagnostic: &Diagnostic) {
1759         with_context_opt(|icx| {
1760             if let Some(icx) = icx {
1761                 if let Some(ref query) = icx.query {
1762                     query.diagnostics.lock().push(diagnostic.clone());
1763                 }
1764             }
1765         })
1766     }
1767
1768     /// Sets up the callbacks from libsyntax on the current thread
1769     pub fn with_thread_locals<F, R>(f: F) -> R
1770         where F: FnOnce() -> R
1771     {
1772         syntax_pos::SPAN_DEBUG.with(|span_dbg| {
1773             let original_span_debug = span_dbg.get();
1774             span_dbg.set(span_debug);
1775
1776             let _on_drop = OnDrop(move || {
1777                 span_dbg.set(original_span_debug);
1778             });
1779
1780             TRACK_DIAGNOSTICS.with(|current| {
1781                 let original = current.get();
1782                 current.set(track_diagnostic);
1783
1784                 let _on_drop = OnDrop(move || {
1785                     current.set(original);
1786                 });
1787
1788                 f()
1789             })
1790         })
1791     }
1792
1793     /// Sets `context` as the new current ImplicitCtxt for the duration of the function `f`
1794     pub fn enter_context<'a, 'gcx: 'tcx, 'tcx, F, R>(context: &ImplicitCtxt<'a, 'gcx, 'tcx>,
1795                                                      f: F) -> R
1796         where F: FnOnce(&ImplicitCtxt<'a, 'gcx, 'tcx>) -> R
1797     {
1798         set_tlv(context as *const _ as usize, || {
1799             f(&context)
1800         })
1801     }
1802
1803     /// Enters GlobalCtxt by setting up libsyntax callbacks and
1804     /// creating a initial TyCtxt and ImplicitCtxt.
1805     /// This happens once per rustc session and TyCtxts only exists
1806     /// inside the `f` function.
1807     pub fn enter_global<'gcx, F, R>(gcx: &GlobalCtxt<'gcx>, f: F) -> R
1808         where F: for<'a> FnOnce(TyCtxt<'a, 'gcx, 'gcx>) -> R
1809     {
1810         with_thread_locals(|| {
1811             let tcx = TyCtxt {
1812                 gcx,
1813                 interners: &gcx.global_interners,
1814             };
1815             let icx = ImplicitCtxt {
1816                 tcx,
1817                 query: None,
1818                 layout_depth: 0,
1819                 task: &OpenTask::Ignore,
1820             };
1821             enter_context(&icx, |_| {
1822                 f(tcx)
1823             })
1824         })
1825     }
1826
1827     /// Allows access to the current ImplicitCtxt in a closure if one is available
1828     pub fn with_context_opt<F, R>(f: F) -> R
1829         where F: for<'a, 'gcx, 'tcx> FnOnce(Option<&ImplicitCtxt<'a, 'gcx, 'tcx>>) -> R
1830     {
1831         let context = get_tlv();
1832         if context == 0 {
1833             f(None)
1834         } else {
1835             // We could get a ImplicitCtxt pointer from another thread.
1836             // Ensure that ImplicitCtxt is Sync
1837             sync::assert_sync::<ImplicitCtxt>();
1838
1839             unsafe { f(Some(&*(context as *const ImplicitCtxt))) }
1840         }
1841     }
1842
1843     /// Allows access to the current ImplicitCtxt.
1844     /// Panics if there is no ImplicitCtxt available
1845     pub fn with_context<F, R>(f: F) -> R
1846         where F: for<'a, 'gcx, 'tcx> FnOnce(&ImplicitCtxt<'a, 'gcx, 'tcx>) -> R
1847     {
1848         with_context_opt(|opt_context| f(opt_context.expect("no ImplicitCtxt stored in tls")))
1849     }
1850
1851     /// Allows access to the current ImplicitCtxt whose tcx field has the same global
1852     /// interner as the tcx argument passed in. This means the closure is given an ImplicitCtxt
1853     /// with the same 'gcx lifetime as the TyCtxt passed in.
1854     /// This will panic if you pass it a TyCtxt which has a different global interner from
1855     /// the current ImplicitCtxt's tcx field.
1856     pub fn with_related_context<'a, 'gcx, 'tcx1, F, R>(tcx: TyCtxt<'a, 'gcx, 'tcx1>, f: F) -> R
1857         where F: for<'b, 'tcx2> FnOnce(&ImplicitCtxt<'b, 'gcx, 'tcx2>) -> R
1858     {
1859         with_context(|context| {
1860             unsafe {
1861                 let gcx = tcx.gcx as *const _ as usize;
1862                 assert!(context.tcx.gcx as *const _ as usize == gcx);
1863                 let context: &ImplicitCtxt = mem::transmute(context);
1864                 f(context)
1865             }
1866         })
1867     }
1868
1869     /// Allows access to the current ImplicitCtxt whose tcx field has the same global
1870     /// interner and local interner as the tcx argument passed in. This means the closure
1871     /// is given an ImplicitCtxt with the same 'tcx and 'gcx lifetimes as the TyCtxt passed in.
1872     /// This will panic if you pass it a TyCtxt which has a different global interner or
1873     /// a different local interner from the current ImplicitCtxt's tcx field.
1874     pub fn with_fully_related_context<'a, 'gcx, 'tcx, F, R>(tcx: TyCtxt<'a, 'gcx, 'tcx>, f: F) -> R
1875         where F: for<'b> FnOnce(&ImplicitCtxt<'b, 'gcx, 'tcx>) -> R
1876     {
1877         with_context(|context| {
1878             unsafe {
1879                 let gcx = tcx.gcx as *const _ as usize;
1880                 let interners = tcx.interners as *const _ as usize;
1881                 assert!(context.tcx.gcx as *const _ as usize == gcx);
1882                 assert!(context.tcx.interners as *const _ as usize == interners);
1883                 let context: &ImplicitCtxt = mem::transmute(context);
1884                 f(context)
1885             }
1886         })
1887     }
1888
1889     /// Allows access to the TyCtxt in the current ImplicitCtxt.
1890     /// Panics if there is no ImplicitCtxt available
1891     pub fn with<F, R>(f: F) -> R
1892         where F: for<'a, 'gcx, 'tcx> FnOnce(TyCtxt<'a, 'gcx, 'tcx>) -> R
1893     {
1894         with_context(|context| f(context.tcx))
1895     }
1896
1897     /// Allows access to the TyCtxt in the current ImplicitCtxt.
1898     /// The closure is passed None if there is no ImplicitCtxt available
1899     pub fn with_opt<F, R>(f: F) -> R
1900         where F: for<'a, 'gcx, 'tcx> FnOnce(Option<TyCtxt<'a, 'gcx, 'tcx>>) -> R
1901     {
1902         with_context_opt(|opt_context| f(opt_context.map(|context| context.tcx)))
1903     }
1904 }
1905
1906 macro_rules! sty_debug_print {
1907     ($ctxt: expr, $($variant: ident),*) => {{
1908         // curious inner module to allow variant names to be used as
1909         // variable names.
1910         #[allow(non_snake_case)]
1911         mod inner {
1912             use ty::{self, TyCtxt};
1913             use ty::context::Interned;
1914
1915             #[derive(Copy, Clone)]
1916             struct DebugStat {
1917                 total: usize,
1918                 region_infer: usize,
1919                 ty_infer: usize,
1920                 both_infer: usize,
1921             }
1922
1923             pub fn go(tcx: TyCtxt) {
1924                 let mut total = DebugStat {
1925                     total: 0,
1926                     region_infer: 0, ty_infer: 0, both_infer: 0,
1927                 };
1928                 $(let mut $variant = total;)*
1929
1930
1931                 for &Interned(t) in tcx.interners.type_.borrow().iter() {
1932                     let variant = match t.sty {
1933                         ty::TyBool | ty::TyChar | ty::TyInt(..) | ty::TyUint(..) |
1934                             ty::TyFloat(..) | ty::TyStr | ty::TyNever => continue,
1935                         ty::TyError => /* unimportant */ continue,
1936                         $(ty::$variant(..) => &mut $variant,)*
1937                     };
1938                     let region = t.flags.intersects(ty::TypeFlags::HAS_RE_INFER);
1939                     let ty = t.flags.intersects(ty::TypeFlags::HAS_TY_INFER);
1940
1941                     variant.total += 1;
1942                     total.total += 1;
1943                     if region { total.region_infer += 1; variant.region_infer += 1 }
1944                     if ty { total.ty_infer += 1; variant.ty_infer += 1 }
1945                     if region && ty { total.both_infer += 1; variant.both_infer += 1 }
1946                 }
1947                 println!("Ty interner             total           ty region  both");
1948                 $(println!("    {:18}: {uses:6} {usespc:4.1}%, \
1949 {ty:4.1}% {region:5.1}% {both:4.1}%",
1950                            stringify!($variant),
1951                            uses = $variant.total,
1952                            usespc = $variant.total as f64 * 100.0 / total.total as f64,
1953                            ty = $variant.ty_infer as f64 * 100.0  / total.total as f64,
1954                            region = $variant.region_infer as f64 * 100.0  / total.total as f64,
1955                            both = $variant.both_infer as f64 * 100.0  / total.total as f64);
1956                   )*
1957                 println!("                  total {uses:6}        \
1958 {ty:4.1}% {region:5.1}% {both:4.1}%",
1959                          uses = total.total,
1960                          ty = total.ty_infer as f64 * 100.0  / total.total as f64,
1961                          region = total.region_infer as f64 * 100.0  / total.total as f64,
1962                          both = total.both_infer as f64 * 100.0  / total.total as f64)
1963             }
1964         }
1965
1966         inner::go($ctxt)
1967     }}
1968 }
1969
1970 impl<'a, 'tcx> TyCtxt<'a, 'tcx, 'tcx> {
1971     pub fn print_debug_stats(self) {
1972         sty_debug_print!(
1973             self,
1974             TyAdt, TyArray, TySlice, TyRawPtr, TyRef, TyFnDef, TyFnPtr,
1975             TyGenerator, TyGeneratorWitness, TyDynamic, TyClosure, TyTuple,
1976             TyParam, TyInfer, TyProjection, TyAnon, TyForeign);
1977
1978         println!("Substs interner: #{}", self.interners.substs.borrow().len());
1979         println!("Region interner: #{}", self.interners.region.borrow().len());
1980         println!("Stability interner: #{}", self.stability_interner.borrow().len());
1981         println!("Allocation interner: #{}", self.allocation_interner.borrow().len());
1982         println!("Layout interner: #{}", self.layout_interner.borrow().len());
1983     }
1984 }
1985
1986
1987 /// An entry in an interner.
1988 struct Interned<'tcx, T: 'tcx+?Sized>(&'tcx T);
1989
1990 // NB: An Interned<Ty> compares and hashes as a sty.
1991 impl<'tcx> PartialEq for Interned<'tcx, TyS<'tcx>> {
1992     fn eq(&self, other: &Interned<'tcx, TyS<'tcx>>) -> bool {
1993         self.0.sty == other.0.sty
1994     }
1995 }
1996
1997 impl<'tcx> Eq for Interned<'tcx, TyS<'tcx>> {}
1998
1999 impl<'tcx> Hash for Interned<'tcx, TyS<'tcx>> {
2000     fn hash<H: Hasher>(&self, s: &mut H) {
2001         self.0.sty.hash(s)
2002     }
2003 }
2004
2005 impl<'tcx: 'lcx, 'lcx> Borrow<TypeVariants<'lcx>> for Interned<'tcx, TyS<'tcx>> {
2006     fn borrow<'a>(&'a self) -> &'a TypeVariants<'lcx> {
2007         &self.0.sty
2008     }
2009 }
2010
2011 // NB: An Interned<Slice<T>> compares and hashes as its elements.
2012 impl<'tcx, T: PartialEq> PartialEq for Interned<'tcx, Slice<T>> {
2013     fn eq(&self, other: &Interned<'tcx, Slice<T>>) -> bool {
2014         self.0[..] == other.0[..]
2015     }
2016 }
2017
2018 impl<'tcx, T: Eq> Eq for Interned<'tcx, Slice<T>> {}
2019
2020 impl<'tcx, T: Hash> Hash for Interned<'tcx, Slice<T>> {
2021     fn hash<H: Hasher>(&self, s: &mut H) {
2022         self.0[..].hash(s)
2023     }
2024 }
2025
2026 impl<'tcx: 'lcx, 'lcx> Borrow<[Ty<'lcx>]> for Interned<'tcx, Slice<Ty<'tcx>>> {
2027     fn borrow<'a>(&'a self) -> &'a [Ty<'lcx>] {
2028         &self.0[..]
2029     }
2030 }
2031
2032 impl<'tcx: 'lcx, 'lcx> Borrow<[CanonicalVarInfo]> for Interned<'tcx, Slice<CanonicalVarInfo>> {
2033     fn borrow<'a>(&'a self) -> &'a [CanonicalVarInfo] {
2034         &self.0[..]
2035     }
2036 }
2037
2038 impl<'tcx: 'lcx, 'lcx> Borrow<[Kind<'lcx>]> for Interned<'tcx, Substs<'tcx>> {
2039     fn borrow<'a>(&'a self) -> &'a [Kind<'lcx>] {
2040         &self.0[..]
2041     }
2042 }
2043
2044 impl<'tcx> Borrow<RegionKind> for Interned<'tcx, RegionKind> {
2045     fn borrow<'a>(&'a self) -> &'a RegionKind {
2046         &self.0
2047     }
2048 }
2049
2050 impl<'tcx: 'lcx, 'lcx> Borrow<[ExistentialPredicate<'lcx>]>
2051     for Interned<'tcx, Slice<ExistentialPredicate<'tcx>>> {
2052     fn borrow<'a>(&'a self) -> &'a [ExistentialPredicate<'lcx>] {
2053         &self.0[..]
2054     }
2055 }
2056
2057 impl<'tcx: 'lcx, 'lcx> Borrow<[Predicate<'lcx>]>
2058     for Interned<'tcx, Slice<Predicate<'tcx>>> {
2059     fn borrow<'a>(&'a self) -> &'a [Predicate<'lcx>] {
2060         &self.0[..]
2061     }
2062 }
2063
2064 impl<'tcx: 'lcx, 'lcx> Borrow<Const<'lcx>> for Interned<'tcx, Const<'tcx>> {
2065     fn borrow<'a>(&'a self) -> &'a Const<'lcx> {
2066         &self.0
2067     }
2068 }
2069
2070 impl<'tcx: 'lcx, 'lcx> Borrow<[Clause<'lcx>]>
2071 for Interned<'tcx, Slice<Clause<'tcx>>> {
2072     fn borrow<'a>(&'a self) -> &'a [Clause<'lcx>] {
2073         &self.0[..]
2074     }
2075 }
2076
2077 impl<'tcx: 'lcx, 'lcx> Borrow<[Goal<'lcx>]>
2078 for Interned<'tcx, Slice<Goal<'tcx>>> {
2079     fn borrow<'a>(&'a self) -> &'a [Goal<'lcx>] {
2080         &self.0[..]
2081     }
2082 }
2083
2084 macro_rules! intern_method {
2085     ($lt_tcx:tt, $name:ident: $method:ident($alloc:ty,
2086                                             $alloc_method:expr,
2087                                             $alloc_to_key:expr,
2088                                             $keep_in_local_tcx:expr) -> $ty:ty) => {
2089         impl<'a, 'gcx, $lt_tcx> TyCtxt<'a, 'gcx, $lt_tcx> {
2090             pub fn $method(self, v: $alloc) -> &$lt_tcx $ty {
2091                 let key = ($alloc_to_key)(&v);
2092
2093                 // HACK(eddyb) Depend on flags being accurate to
2094                 // determine that all contents are in the global tcx.
2095                 // See comments on Lift for why we can't use that.
2096                 if ($keep_in_local_tcx)(&v) {
2097                     let mut interner = self.interners.$name.borrow_mut();
2098                     if let Some(&Interned(v)) = interner.get(key) {
2099                         return v;
2100                     }
2101
2102                     // Make sure we don't end up with inference
2103                     // types/regions in the global tcx.
2104                     if self.is_global() {
2105                         bug!("Attempted to intern `{:?}` which contains \
2106                               inference types/regions in the global type context",
2107                              v);
2108                     }
2109
2110                     let i = $alloc_method(&self.interners.arena, v);
2111                     interner.insert(Interned(i));
2112                     i
2113                 } else {
2114                     let mut interner = self.global_interners.$name.borrow_mut();
2115                     if let Some(&Interned(v)) = interner.get(key) {
2116                         return v;
2117                     }
2118
2119                     // This transmutes $alloc<'tcx> to $alloc<'gcx>
2120                     let v = unsafe {
2121                         mem::transmute(v)
2122                     };
2123                     let i: &$lt_tcx $ty = $alloc_method(&self.global_interners.arena, v);
2124                     // Cast to 'gcx
2125                     let i = unsafe { mem::transmute(i) };
2126                     interner.insert(Interned(i));
2127                     i
2128                 }
2129             }
2130         }
2131     }
2132 }
2133
2134 macro_rules! direct_interners {
2135     ($lt_tcx:tt, $($name:ident: $method:ident($keep_in_local_tcx:expr) -> $ty:ty),+) => {
2136         $(impl<$lt_tcx> PartialEq for Interned<$lt_tcx, $ty> {
2137             fn eq(&self, other: &Self) -> bool {
2138                 self.0 == other.0
2139             }
2140         }
2141
2142         impl<$lt_tcx> Eq for Interned<$lt_tcx, $ty> {}
2143
2144         impl<$lt_tcx> Hash for Interned<$lt_tcx, $ty> {
2145             fn hash<H: Hasher>(&self, s: &mut H) {
2146                 self.0.hash(s)
2147             }
2148         }
2149
2150         intern_method!(
2151             $lt_tcx,
2152             $name: $method($ty,
2153                            |a: &$lt_tcx SyncDroplessArena, v| -> &$lt_tcx $ty { a.alloc(v) },
2154                            |x| x,
2155                            $keep_in_local_tcx) -> $ty);)+
2156     }
2157 }
2158
2159 pub fn keep_local<'tcx, T: ty::TypeFoldable<'tcx>>(x: &T) -> bool {
2160     x.has_type_flags(ty::TypeFlags::KEEP_IN_LOCAL_TCX)
2161 }
2162
2163 direct_interners!('tcx,
2164     region: mk_region(|r: &RegionKind| r.keep_in_local_tcx()) -> RegionKind,
2165     const_: mk_const(|c: &Const| keep_local(&c.ty) || keep_local(&c.val)) -> Const<'tcx>
2166 );
2167
2168 macro_rules! slice_interners {
2169     ($($field:ident: $method:ident($ty:ident)),+) => (
2170         $(intern_method!( 'tcx, $field: $method(
2171             &[$ty<'tcx>],
2172             |a, v| Slice::from_arena(a, v),
2173             Deref::deref,
2174             |xs: &[$ty]| xs.iter().any(keep_local)) -> Slice<$ty<'tcx>>);)+
2175     )
2176 }
2177
2178 slice_interners!(
2179     existential_predicates: _intern_existential_predicates(ExistentialPredicate),
2180     predicates: _intern_predicates(Predicate),
2181     type_list: _intern_type_list(Ty),
2182     substs: _intern_substs(Kind),
2183     clauses: _intern_clauses(Clause),
2184     goals: _intern_goals(Goal)
2185 );
2186
2187 // This isn't a perfect fit: CanonicalVarInfo slices are always
2188 // allocated in the global arena, so this `intern_method!` macro is
2189 // overly general.  But we just return false for the code that checks
2190 // whether they belong in the thread-local arena, so no harm done, and
2191 // seems better than open-coding the rest.
2192 intern_method! {
2193     'tcx,
2194     canonical_var_infos: _intern_canonical_var_infos(
2195         &[CanonicalVarInfo],
2196         |a, v| Slice::from_arena(a, v),
2197         Deref::deref,
2198         |_xs: &[CanonicalVarInfo]| -> bool { false }
2199     ) -> Slice<CanonicalVarInfo>
2200 }
2201
2202 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
2203     /// Given a `fn` type, returns an equivalent `unsafe fn` type;
2204     /// that is, a `fn` type that is equivalent in every way for being
2205     /// unsafe.
2206     pub fn safe_to_unsafe_fn_ty(self, sig: PolyFnSig<'tcx>) -> Ty<'tcx> {
2207         assert_eq!(sig.unsafety(), hir::Unsafety::Normal);
2208         self.mk_fn_ptr(sig.map_bound(|sig| ty::FnSig {
2209             unsafety: hir::Unsafety::Unsafe,
2210             ..sig
2211         }))
2212     }
2213
2214     /// Given a closure signature `sig`, returns an equivalent `fn`
2215     /// type with the same signature. Detuples and so forth -- so
2216     /// e.g. if we have a sig with `Fn<(u32, i32)>` then you would get
2217     /// a `fn(u32, i32)`.
2218     pub fn coerce_closure_fn_ty(self, sig: PolyFnSig<'tcx>) -> Ty<'tcx> {
2219         let converted_sig = sig.map_bound(|s| {
2220             let params_iter = match s.inputs()[0].sty {
2221                 ty::TyTuple(params) => {
2222                     params.into_iter().cloned()
2223                 }
2224                 _ => bug!(),
2225             };
2226             self.mk_fn_sig(
2227                 params_iter,
2228                 s.output(),
2229                 s.variadic,
2230                 hir::Unsafety::Normal,
2231                 abi::Abi::Rust,
2232             )
2233         });
2234
2235         self.mk_fn_ptr(converted_sig)
2236     }
2237
2238     pub fn mk_ty(&self, st: TypeVariants<'tcx>) -> Ty<'tcx> {
2239         CtxtInterners::intern_ty(&self.interners, &self.global_interners, st)
2240     }
2241
2242     pub fn mk_mach_int(self, tm: ast::IntTy) -> Ty<'tcx> {
2243         match tm {
2244             ast::IntTy::Isize   => self.types.isize,
2245             ast::IntTy::I8   => self.types.i8,
2246             ast::IntTy::I16  => self.types.i16,
2247             ast::IntTy::I32  => self.types.i32,
2248             ast::IntTy::I64  => self.types.i64,
2249             ast::IntTy::I128  => self.types.i128,
2250         }
2251     }
2252
2253     pub fn mk_mach_uint(self, tm: ast::UintTy) -> Ty<'tcx> {
2254         match tm {
2255             ast::UintTy::Usize   => self.types.usize,
2256             ast::UintTy::U8   => self.types.u8,
2257             ast::UintTy::U16  => self.types.u16,
2258             ast::UintTy::U32  => self.types.u32,
2259             ast::UintTy::U64  => self.types.u64,
2260             ast::UintTy::U128  => self.types.u128,
2261         }
2262     }
2263
2264     pub fn mk_mach_float(self, tm: ast::FloatTy) -> Ty<'tcx> {
2265         match tm {
2266             ast::FloatTy::F32  => self.types.f32,
2267             ast::FloatTy::F64  => self.types.f64,
2268         }
2269     }
2270
2271     pub fn mk_str(self) -> Ty<'tcx> {
2272         self.mk_ty(TyStr)
2273     }
2274
2275     pub fn mk_static_str(self) -> Ty<'tcx> {
2276         self.mk_imm_ref(self.types.re_static, self.mk_str())
2277     }
2278
2279     pub fn mk_adt(self, def: &'tcx AdtDef, substs: &'tcx Substs<'tcx>) -> Ty<'tcx> {
2280         // take a copy of substs so that we own the vectors inside
2281         self.mk_ty(TyAdt(def, substs))
2282     }
2283
2284     pub fn mk_foreign(self, def_id: DefId) -> Ty<'tcx> {
2285         self.mk_ty(TyForeign(def_id))
2286     }
2287
2288     pub fn mk_box(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2289         let def_id = self.require_lang_item(lang_items::OwnedBoxLangItem);
2290         let adt_def = self.adt_def(def_id);
2291         let substs = Substs::for_item(self, def_id, |param, substs| {
2292             match param.kind {
2293                 GenericParamDefKind::Lifetime => bug!(),
2294                 GenericParamDefKind::Type { has_default, .. } => {
2295                     if param.index == 0 {
2296                         ty.into()
2297                     } else {
2298                         assert!(has_default);
2299                         self.type_of(param.def_id).subst(self, substs).into()
2300                     }
2301                 }
2302             }
2303         });
2304         self.mk_ty(TyAdt(adt_def, substs))
2305     }
2306
2307     pub fn mk_ptr(self, tm: TypeAndMut<'tcx>) -> Ty<'tcx> {
2308         self.mk_ty(TyRawPtr(tm))
2309     }
2310
2311     pub fn mk_ref(self, r: Region<'tcx>, tm: TypeAndMut<'tcx>) -> Ty<'tcx> {
2312         self.mk_ty(TyRef(r, tm.ty, tm.mutbl))
2313     }
2314
2315     pub fn mk_mut_ref(self, r: Region<'tcx>, ty: Ty<'tcx>) -> Ty<'tcx> {
2316         self.mk_ref(r, TypeAndMut {ty: ty, mutbl: hir::MutMutable})
2317     }
2318
2319     pub fn mk_imm_ref(self, r: Region<'tcx>, ty: Ty<'tcx>) -> Ty<'tcx> {
2320         self.mk_ref(r, TypeAndMut {ty: ty, mutbl: hir::MutImmutable})
2321     }
2322
2323     pub fn mk_mut_ptr(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2324         self.mk_ptr(TypeAndMut {ty: ty, mutbl: hir::MutMutable})
2325     }
2326
2327     pub fn mk_imm_ptr(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2328         self.mk_ptr(TypeAndMut {ty: ty, mutbl: hir::MutImmutable})
2329     }
2330
2331     pub fn mk_nil_ptr(self) -> Ty<'tcx> {
2332         self.mk_imm_ptr(self.mk_nil())
2333     }
2334
2335     pub fn mk_array(self, ty: Ty<'tcx>, n: u64) -> Ty<'tcx> {
2336         self.mk_ty(TyArray(ty, ty::Const::from_usize(self, n)))
2337     }
2338
2339     pub fn mk_slice(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2340         self.mk_ty(TySlice(ty))
2341     }
2342
2343     pub fn intern_tup(self, ts: &[Ty<'tcx>]) -> Ty<'tcx> {
2344         self.mk_ty(TyTuple(self.intern_type_list(ts)))
2345     }
2346
2347     pub fn mk_tup<I: InternAs<[Ty<'tcx>], Ty<'tcx>>>(self, iter: I) -> I::Output {
2348         iter.intern_with(|ts| self.mk_ty(TyTuple(self.intern_type_list(ts))))
2349     }
2350
2351     pub fn mk_nil(self) -> Ty<'tcx> {
2352         self.intern_tup(&[])
2353     }
2354
2355     pub fn mk_diverging_default(self) -> Ty<'tcx> {
2356         if self.features().never_type {
2357             self.types.never
2358         } else {
2359             self.intern_tup(&[])
2360         }
2361     }
2362
2363     pub fn mk_bool(self) -> Ty<'tcx> {
2364         self.mk_ty(TyBool)
2365     }
2366
2367     pub fn mk_fn_def(self, def_id: DefId,
2368                      substs: &'tcx Substs<'tcx>) -> Ty<'tcx> {
2369         self.mk_ty(TyFnDef(def_id, substs))
2370     }
2371
2372     pub fn mk_fn_ptr(self, fty: PolyFnSig<'tcx>) -> Ty<'tcx> {
2373         self.mk_ty(TyFnPtr(fty))
2374     }
2375
2376     pub fn mk_dynamic(
2377         self,
2378         obj: ty::Binder<&'tcx Slice<ExistentialPredicate<'tcx>>>,
2379         reg: ty::Region<'tcx>
2380     ) -> Ty<'tcx> {
2381         self.mk_ty(TyDynamic(obj, reg))
2382     }
2383
2384     pub fn mk_projection(self,
2385                          item_def_id: DefId,
2386                          substs: &'tcx Substs<'tcx>)
2387         -> Ty<'tcx> {
2388             self.mk_ty(TyProjection(ProjectionTy {
2389                 item_def_id,
2390                 substs,
2391             }))
2392         }
2393
2394     pub fn mk_closure(self, closure_id: DefId, closure_substs: ClosureSubsts<'tcx>)
2395                                           -> Ty<'tcx> {
2396         self.mk_ty(TyClosure(closure_id, closure_substs))
2397     }
2398
2399     pub fn mk_generator(self,
2400                         id: DefId,
2401                         generator_substs: GeneratorSubsts<'tcx>,
2402                         movability: hir::GeneratorMovability)
2403                         -> Ty<'tcx> {
2404         self.mk_ty(TyGenerator(id, generator_substs, movability))
2405     }
2406
2407     pub fn mk_generator_witness(self, types: ty::Binder<&'tcx Slice<Ty<'tcx>>>) -> Ty<'tcx> {
2408         self.mk_ty(TyGeneratorWitness(types))
2409     }
2410
2411     pub fn mk_var(self, v: TyVid) -> Ty<'tcx> {
2412         self.mk_infer(TyVar(v))
2413     }
2414
2415     pub fn mk_int_var(self, v: IntVid) -> Ty<'tcx> {
2416         self.mk_infer(IntVar(v))
2417     }
2418
2419     pub fn mk_float_var(self, v: FloatVid) -> Ty<'tcx> {
2420         self.mk_infer(FloatVar(v))
2421     }
2422
2423     pub fn mk_infer(self, it: InferTy) -> Ty<'tcx> {
2424         self.mk_ty(TyInfer(it))
2425     }
2426
2427     pub fn mk_ty_param(self,
2428                     index: u32,
2429                     name: InternedString) -> Ty<'tcx> {
2430         self.mk_ty(TyParam(ParamTy { idx: index, name: name }))
2431     }
2432
2433     pub fn mk_self_type(self) -> Ty<'tcx> {
2434         self.mk_ty_param(0, keywords::SelfType.name().as_interned_str())
2435     }
2436
2437     pub fn mk_param_from_def(self, param: &ty::GenericParamDef) -> Kind<'tcx> {
2438         match param.kind {
2439             GenericParamDefKind::Lifetime => {
2440                 self.mk_region(ty::ReEarlyBound(param.to_early_bound_region_data())).into()
2441             }
2442             GenericParamDefKind::Type {..} => self.mk_ty_param(param.index, param.name).into(),
2443         }
2444     }
2445
2446     pub fn mk_anon(self, def_id: DefId, substs: &'tcx Substs<'tcx>) -> Ty<'tcx> {
2447         self.mk_ty(TyAnon(def_id, substs))
2448     }
2449
2450     pub fn intern_existential_predicates(self, eps: &[ExistentialPredicate<'tcx>])
2451         -> &'tcx Slice<ExistentialPredicate<'tcx>> {
2452         assert!(!eps.is_empty());
2453         assert!(eps.windows(2).all(|w| w[0].cmp(self, &w[1]) != Ordering::Greater));
2454         self._intern_existential_predicates(eps)
2455     }
2456
2457     pub fn intern_predicates(self, preds: &[Predicate<'tcx>])
2458         -> &'tcx Slice<Predicate<'tcx>> {
2459         // FIXME consider asking the input slice to be sorted to avoid
2460         // re-interning permutations, in which case that would be asserted
2461         // here.
2462         if preds.len() == 0 {
2463             // The macro-generated method below asserts we don't intern an empty slice.
2464             Slice::empty()
2465         } else {
2466             self._intern_predicates(preds)
2467         }
2468     }
2469
2470     pub fn intern_type_list(self, ts: &[Ty<'tcx>]) -> &'tcx Slice<Ty<'tcx>> {
2471         if ts.len() == 0 {
2472             Slice::empty()
2473         } else {
2474             self._intern_type_list(ts)
2475         }
2476     }
2477
2478     pub fn intern_substs(self, ts: &[Kind<'tcx>]) -> &'tcx Slice<Kind<'tcx>> {
2479         if ts.len() == 0 {
2480             Slice::empty()
2481         } else {
2482             self._intern_substs(ts)
2483         }
2484     }
2485
2486     pub fn intern_canonical_var_infos(self, ts: &[CanonicalVarInfo]) -> CanonicalVarInfos<'gcx> {
2487         if ts.len() == 0 {
2488             Slice::empty()
2489         } else {
2490             self.global_tcx()._intern_canonical_var_infos(ts)
2491         }
2492     }
2493
2494     pub fn intern_clauses(self, ts: &[Clause<'tcx>]) -> Clauses<'tcx> {
2495         if ts.len() == 0 {
2496             Slice::empty()
2497         } else {
2498             self._intern_clauses(ts)
2499         }
2500     }
2501
2502     pub fn intern_goals(self, ts: &[Goal<'tcx>]) -> Goals<'tcx> {
2503         if ts.len() == 0 {
2504             Slice::empty()
2505         } else {
2506             self._intern_goals(ts)
2507         }
2508     }
2509
2510     pub fn mk_fn_sig<I>(self,
2511                         inputs: I,
2512                         output: I::Item,
2513                         variadic: bool,
2514                         unsafety: hir::Unsafety,
2515                         abi: abi::Abi)
2516         -> <I::Item as InternIteratorElement<Ty<'tcx>, ty::FnSig<'tcx>>>::Output
2517         where I: Iterator,
2518               I::Item: InternIteratorElement<Ty<'tcx>, ty::FnSig<'tcx>>
2519     {
2520         inputs.chain(iter::once(output)).intern_with(|xs| ty::FnSig {
2521             inputs_and_output: self.intern_type_list(xs),
2522             variadic, unsafety, abi
2523         })
2524     }
2525
2526     pub fn mk_existential_predicates<I: InternAs<[ExistentialPredicate<'tcx>],
2527                                      &'tcx Slice<ExistentialPredicate<'tcx>>>>(self, iter: I)
2528                                      -> I::Output {
2529         iter.intern_with(|xs| self.intern_existential_predicates(xs))
2530     }
2531
2532     pub fn mk_predicates<I: InternAs<[Predicate<'tcx>],
2533                                      &'tcx Slice<Predicate<'tcx>>>>(self, iter: I)
2534                                      -> I::Output {
2535         iter.intern_with(|xs| self.intern_predicates(xs))
2536     }
2537
2538     pub fn mk_type_list<I: InternAs<[Ty<'tcx>],
2539                         &'tcx Slice<Ty<'tcx>>>>(self, iter: I) -> I::Output {
2540         iter.intern_with(|xs| self.intern_type_list(xs))
2541     }
2542
2543     pub fn mk_substs<I: InternAs<[Kind<'tcx>],
2544                      &'tcx Slice<Kind<'tcx>>>>(self, iter: I) -> I::Output {
2545         iter.intern_with(|xs| self.intern_substs(xs))
2546     }
2547
2548     pub fn mk_substs_trait(self,
2549                      self_ty: Ty<'tcx>,
2550                      rest: &[Kind<'tcx>])
2551                     -> &'tcx Substs<'tcx>
2552     {
2553         self.mk_substs(iter::once(self_ty.into()).chain(rest.iter().cloned()))
2554     }
2555
2556     pub fn mk_clauses<I: InternAs<[Clause<'tcx>], Clauses<'tcx>>>(self, iter: I) -> I::Output {
2557         iter.intern_with(|xs| self.intern_clauses(xs))
2558     }
2559
2560     pub fn mk_goals<I: InternAs<[Goal<'tcx>], Goals<'tcx>>>(self, iter: I) -> I::Output {
2561         iter.intern_with(|xs| self.intern_goals(xs))
2562     }
2563
2564     pub fn mk_goal(self, goal: Goal<'tcx>) -> &'tcx Goal {
2565         &self.intern_goals(&[goal])[0]
2566     }
2567
2568     pub fn lint_hir<S: Into<MultiSpan>>(self,
2569                                         lint: &'static Lint,
2570                                         hir_id: HirId,
2571                                         span: S,
2572                                         msg: &str) {
2573         self.struct_span_lint_hir(lint, hir_id, span.into(), msg).emit()
2574     }
2575
2576     pub fn lint_node<S: Into<MultiSpan>>(self,
2577                                          lint: &'static Lint,
2578                                          id: NodeId,
2579                                          span: S,
2580                                          msg: &str) {
2581         self.struct_span_lint_node(lint, id, span.into(), msg).emit()
2582     }
2583
2584     pub fn lint_hir_note<S: Into<MultiSpan>>(self,
2585                                               lint: &'static Lint,
2586                                               hir_id: HirId,
2587                                               span: S,
2588                                               msg: &str,
2589                                               note: &str) {
2590         let mut err = self.struct_span_lint_hir(lint, hir_id, span.into(), msg);
2591         err.note(note);
2592         err.emit()
2593     }
2594
2595     pub fn lint_node_note<S: Into<MultiSpan>>(self,
2596                                               lint: &'static Lint,
2597                                               id: NodeId,
2598                                               span: S,
2599                                               msg: &str,
2600                                               note: &str) {
2601         let mut err = self.struct_span_lint_node(lint, id, span.into(), msg);
2602         err.note(note);
2603         err.emit()
2604     }
2605
2606     pub fn lint_level_at_node(self, lint: &'static Lint, mut id: NodeId)
2607         -> (lint::Level, lint::LintSource)
2608     {
2609         // Right now we insert a `with_ignore` node in the dep graph here to
2610         // ignore the fact that `lint_levels` below depends on the entire crate.
2611         // For now this'll prevent false positives of recompiling too much when
2612         // anything changes.
2613         //
2614         // Once red/green incremental compilation lands we should be able to
2615         // remove this because while the crate changes often the lint level map
2616         // will change rarely.
2617         self.dep_graph.with_ignore(|| {
2618             let sets = self.lint_levels(LOCAL_CRATE);
2619             loop {
2620                 let hir_id = self.hir.definitions().node_to_hir_id(id);
2621                 if let Some(pair) = sets.level_and_source(lint, hir_id, self.sess) {
2622                     return pair
2623                 }
2624                 let next = self.hir.get_parent_node(id);
2625                 if next == id {
2626                     bug!("lint traversal reached the root of the crate");
2627                 }
2628                 id = next;
2629             }
2630         })
2631     }
2632
2633     pub fn struct_span_lint_hir<S: Into<MultiSpan>>(self,
2634                                                     lint: &'static Lint,
2635                                                     hir_id: HirId,
2636                                                     span: S,
2637                                                     msg: &str)
2638         -> DiagnosticBuilder<'tcx>
2639     {
2640         let node_id = self.hir.hir_to_node_id(hir_id);
2641         let (level, src) = self.lint_level_at_node(lint, node_id);
2642         lint::struct_lint_level(self.sess, lint, level, src, Some(span.into()), msg)
2643     }
2644
2645     pub fn struct_span_lint_node<S: Into<MultiSpan>>(self,
2646                                                      lint: &'static Lint,
2647                                                      id: NodeId,
2648                                                      span: S,
2649                                                      msg: &str)
2650         -> DiagnosticBuilder<'tcx>
2651     {
2652         let (level, src) = self.lint_level_at_node(lint, id);
2653         lint::struct_lint_level(self.sess, lint, level, src, Some(span.into()), msg)
2654     }
2655
2656     pub fn struct_lint_node(self, lint: &'static Lint, id: NodeId, msg: &str)
2657         -> DiagnosticBuilder<'tcx>
2658     {
2659         let (level, src) = self.lint_level_at_node(lint, id);
2660         lint::struct_lint_level(self.sess, lint, level, src, None, msg)
2661     }
2662
2663     pub fn in_scope_traits(self, id: HirId) -> Option<Lrc<StableVec<TraitCandidate>>> {
2664         self.in_scope_traits_map(id.owner)
2665             .and_then(|map| map.get(&id.local_id).cloned())
2666     }
2667
2668     pub fn named_region(self, id: HirId) -> Option<resolve_lifetime::Region> {
2669         self.named_region_map(id.owner)
2670             .and_then(|map| map.get(&id.local_id).cloned())
2671     }
2672
2673     pub fn is_late_bound(self, id: HirId) -> bool {
2674         self.is_late_bound_map(id.owner)
2675             .map(|set| set.contains(&id.local_id))
2676             .unwrap_or(false)
2677     }
2678
2679     pub fn object_lifetime_defaults(self, id: HirId)
2680         -> Option<Lrc<Vec<ObjectLifetimeDefault>>>
2681     {
2682         self.object_lifetime_defaults_map(id.owner)
2683             .and_then(|map| map.get(&id.local_id).cloned())
2684     }
2685 }
2686
2687 pub trait InternAs<T: ?Sized, R> {
2688     type Output;
2689     fn intern_with<F>(self, f: F) -> Self::Output
2690         where F: FnOnce(&T) -> R;
2691 }
2692
2693 impl<I, T, R, E> InternAs<[T], R> for I
2694     where E: InternIteratorElement<T, R>,
2695           I: Iterator<Item=E> {
2696     type Output = E::Output;
2697     fn intern_with<F>(self, f: F) -> Self::Output
2698         where F: FnOnce(&[T]) -> R {
2699         E::intern_with(self, f)
2700     }
2701 }
2702
2703 pub trait InternIteratorElement<T, R>: Sized {
2704     type Output;
2705     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output;
2706 }
2707
2708 impl<T, R> InternIteratorElement<T, R> for T {
2709     type Output = R;
2710     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
2711         f(&iter.collect::<AccumulateVec<[_; 8]>>())
2712     }
2713 }
2714
2715 impl<'a, T, R> InternIteratorElement<T, R> for &'a T
2716     where T: Clone + 'a
2717 {
2718     type Output = R;
2719     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
2720         f(&iter.cloned().collect::<AccumulateVec<[_; 8]>>())
2721     }
2722 }
2723
2724 impl<T, R, E> InternIteratorElement<T, R> for Result<T, E> {
2725     type Output = Result<R, E>;
2726     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
2727         Ok(f(&iter.collect::<Result<AccumulateVec<[_; 8]>, _>>()?))
2728     }
2729 }
2730
2731 pub fn provide(providers: &mut ty::maps::Providers) {
2732     // FIXME(#44234) - almost all of these queries have no sub-queries and
2733     // therefore no actual inputs, they're just reading tables calculated in
2734     // resolve! Does this work? Unsure! That's what the issue is about
2735     providers.in_scope_traits_map = |tcx, id| tcx.gcx.trait_map.get(&id).cloned();
2736     providers.module_exports = |tcx, id| tcx.gcx.export_map.get(&id).cloned();
2737     providers.crate_name = |tcx, id| {
2738         assert_eq!(id, LOCAL_CRATE);
2739         tcx.crate_name
2740     };
2741     providers.get_lang_items = |tcx, id| {
2742         assert_eq!(id, LOCAL_CRATE);
2743         // FIXME(#42293) Right now we insert a `with_ignore` node in the dep
2744         // graph here to ignore the fact that `get_lang_items` below depends on
2745         // the entire crate.  For now this'll prevent false positives of
2746         // recompiling too much when anything changes.
2747         //
2748         // Once red/green incremental compilation lands we should be able to
2749         // remove this because while the crate changes often the lint level map
2750         // will change rarely.
2751         tcx.dep_graph.with_ignore(|| Lrc::new(middle::lang_items::collect(tcx)))
2752     };
2753     providers.freevars = |tcx, id| tcx.gcx.freevars.get(&id).cloned();
2754     providers.maybe_unused_trait_import = |tcx, id| {
2755         tcx.maybe_unused_trait_imports.contains(&id)
2756     };
2757     providers.maybe_unused_extern_crates = |tcx, cnum| {
2758         assert_eq!(cnum, LOCAL_CRATE);
2759         Lrc::new(tcx.maybe_unused_extern_crates.clone())
2760     };
2761
2762     providers.stability_index = |tcx, cnum| {
2763         assert_eq!(cnum, LOCAL_CRATE);
2764         Lrc::new(stability::Index::new(tcx))
2765     };
2766     providers.lookup_stability = |tcx, id| {
2767         assert_eq!(id.krate, LOCAL_CRATE);
2768         let id = tcx.hir.definitions().def_index_to_hir_id(id.index);
2769         tcx.stability().local_stability(id)
2770     };
2771     providers.lookup_deprecation_entry = |tcx, id| {
2772         assert_eq!(id.krate, LOCAL_CRATE);
2773         let id = tcx.hir.definitions().def_index_to_hir_id(id.index);
2774         tcx.stability().local_deprecation_entry(id)
2775     };
2776     providers.extern_mod_stmt_cnum = |tcx, id| {
2777         let id = tcx.hir.as_local_node_id(id).unwrap();
2778         tcx.cstore.extern_mod_stmt_cnum_untracked(id)
2779     };
2780     providers.all_crate_nums = |tcx, cnum| {
2781         assert_eq!(cnum, LOCAL_CRATE);
2782         Lrc::new(tcx.cstore.crates_untracked())
2783     };
2784     providers.postorder_cnums = |tcx, cnum| {
2785         assert_eq!(cnum, LOCAL_CRATE);
2786         Lrc::new(tcx.cstore.postorder_cnums_untracked())
2787     };
2788     providers.output_filenames = |tcx, cnum| {
2789         assert_eq!(cnum, LOCAL_CRATE);
2790         tcx.output_filenames.clone()
2791     };
2792     providers.features_query = |tcx, cnum| {
2793         assert_eq!(cnum, LOCAL_CRATE);
2794         Lrc::new(tcx.sess.features_untracked().clone())
2795     };
2796     providers.is_panic_runtime = |tcx, cnum| {
2797         assert_eq!(cnum, LOCAL_CRATE);
2798         attr::contains_name(tcx.hir.krate_attrs(), "panic_runtime")
2799     };
2800     providers.is_compiler_builtins = |tcx, cnum| {
2801         assert_eq!(cnum, LOCAL_CRATE);
2802         attr::contains_name(tcx.hir.krate_attrs(), "compiler_builtins")
2803     };
2804 }