src/librustc/ty/context.rs

   1 // ignore-tidy-filelength
   2 //! Type context book-keeping.
   3
   4 use crate::arena::Arena;
   5 use crate::dep_graph::DepGraph;
   6 use crate::dep_graph::{self, DepNode, DepConstructor};
   7 use crate::session::Session;
   8 use crate::session::config::{BorrowckMode, OutputFilenames};
   9 use crate::session::config::CrateType;
  10 use crate::middle;
  11 use crate::middle::lang_items::PanicLocationLangItem;
  12 use crate::hir::{self, TraitCandidate, HirId, ItemKind, ItemLocalId, Node};
  13 use crate::hir::def::{Res, DefKind, Export};
  14 use crate::hir::def_id::{CrateNum, DefId, DefIndex, LOCAL_CRATE};
  15 use crate::hir::map as hir_map;
  16 use crate::hir::map::DefPathHash;
  17 use crate::lint::{self, Lint};
  18 use crate::ich::{StableHashingContext, NodeIdHashingMode};
  19 use crate::infer::canonical::{Canonical, CanonicalVarInfo, CanonicalVarInfos};
  20 use crate::infer::outlives::free_region_map::FreeRegionMap;
  21 use crate::middle::cstore::CrateStoreDyn;
  22 use crate::middle::cstore::EncodedMetadata;
  23 use crate::middle::lang_items;
  24 use crate::middle::resolve_lifetime::{self, ObjectLifetimeDefault};
  25 use crate::middle::stability;
  26 use crate::mir::{BodyAndCache, Field, interpret, Local, Place, PlaceElem, ProjectionKind, Promoted};
  27 use crate::mir::interpret::{ConstValue, Allocation, Scalar};
  28 use crate::ty::subst::{GenericArg, InternalSubsts, SubstsRef, Subst};
  29 use crate::ty::ReprOptions;
  30 use crate::traits;
  31 use crate::traits::{Clause, Clauses, GoalKind, Goal, Goals};
  32 use crate::ty::{self, DefIdTree, Ty, TypeAndMut};
  33 use crate::ty::{TyS, TyKind, List};
  34 use crate::ty::{AdtKind, AdtDef, Region, Const};
  35 use crate::ty::{PolyFnSig, InferTy, ParamTy, ProjectionTy, ExistentialPredicate, Predicate};
  36 use crate::ty::RegionKind;
  37 use crate::ty::{TyVar, TyVid, IntVar, IntVid, FloatVar, FloatVid, ConstVid};
  38 use crate::ty::TyKind::*;
  39 use crate::ty::{InferConst, ParamConst};
  40 use crate::ty::GenericParamDefKind;
  41 use crate::ty::layout::{LayoutDetails, TargetDataLayout, VariantIdx};
  42 use crate::ty::query;
  43 use crate::ty::steal::Steal;
  44 use crate::ty::subst::{UserSubsts, GenericArgKind};
  45 use crate::ty::{BoundVar, BindingMode};
  46 use crate::ty::CanonicalPolyFnSig;
  47 use crate::util::common::ErrorReported;
  48 use crate::util::nodemap::{DefIdMap, DefIdSet, ItemLocalMap, ItemLocalSet, NodeMap};
  49 use crate::util::nodemap::{FxHashMap, FxHashSet};
  50
  51 use errors::DiagnosticBuilder;
  52 use arena::SyncDroplessArena;
  53 use smallvec::SmallVec;
  54 use rustc_data_structures::profiling::SelfProfilerRef;
  55 use rustc_data_structures::stable_hasher::{
  56     HashStable, StableHasher, StableVec, hash_stable_hashmap,
  57 };
  58 use rustc_index::vec::{Idx, IndexVec};
  59 use rustc_data_structures::sharded::ShardedHashMap;
  60 use rustc_data_structures::sync::{Lrc, Lock, WorkerLocal};
  61 use std::any::Any;
  62 use std::borrow::Borrow;
  63 use std::cmp::Ordering;
  64 use std::collections::hash_map::{self, Entry};
  65 use std::hash::{Hash, Hasher};
  66 use std::fmt;
  67 use std::mem;
  68 use std::ops::{Deref, Bound};
  69 use std::iter;
  70 use std::sync::Arc;
  71 use rustc_target::spec::abi;
  72 use rustc_macros::HashStable;
  73 use syntax::ast;
  74 use syntax::attr;
  75 use syntax::source_map::MultiSpan;
  76 use syntax::symbol::{Symbol, kw, sym};
  77 use syntax_pos::Span;
  78 use syntax::expand::allocator::AllocatorKind;
  79
  80 pub struct AllArenas {
  81     pub interner: SyncDroplessArena,
  82 }
  83
  84 impl AllArenas {
  85     pub fn new() -> Self {
  86         AllArenas {
  87             interner: SyncDroplessArena::default(),
  88         }
  89     }
  90 }
  91
  92 type InternedSet<'tcx, T> = ShardedHashMap<Interned<'tcx, T>, ()>;
  93
  94 pub struct CtxtInterners<'tcx> {
  95     /// The arena that types, regions, etc. are allocated from.
  96     arena: &'tcx SyncDroplessArena,
  97
  98     /// Specifically use a speedy hash algorithm for these hash sets, since
  99     /// they're accessed quite often.
 100     type_: InternedSet<'tcx, TyS<'tcx>>,
 101     type_list: InternedSet<'tcx, List<Ty<'tcx>>>,
 102     substs: InternedSet<'tcx, InternalSubsts<'tcx>>,
 103     canonical_var_infos: InternedSet<'tcx, List<CanonicalVarInfo>>,
 104     region: InternedSet<'tcx, RegionKind>,
 105     existential_predicates: InternedSet<'tcx, List<ExistentialPredicate<'tcx>>>,
 106     predicates: InternedSet<'tcx, List<Predicate<'tcx>>>,
 107     clauses: InternedSet<'tcx, List<Clause<'tcx>>>,
 108     goal: InternedSet<'tcx, GoalKind<'tcx>>,
 109     goal_list: InternedSet<'tcx, List<Goal<'tcx>>>,
 110     projs: InternedSet<'tcx, List<ProjectionKind>>,
 111     place_elems: InternedSet<'tcx, List<PlaceElem<'tcx>>>,
 112     const_: InternedSet<'tcx, Const<'tcx>>,
 113 }
 114
 115 impl<'tcx> CtxtInterners<'tcx> {
 116     fn new(arena: &'tcx SyncDroplessArena) -> CtxtInterners<'tcx> {
 117         CtxtInterners {
 118             arena,
 119             type_: Default::default(),
 120             type_list: Default::default(),
 121             substs: Default::default(),
 122             region: Default::default(),
 123             existential_predicates: Default::default(),
 124             canonical_var_infos: Default::default(),
 125             predicates: Default::default(),
 126             clauses: Default::default(),
 127             goal: Default::default(),
 128             goal_list: Default::default(),
 129             projs: Default::default(),
 130             place_elems: Default::default(),
 131             const_: Default::default(),
 132         }
 133     }
 134
 135     /// Interns a type.
 136     #[allow(rustc::usage_of_ty_tykind)]
 137     #[inline(never)]
 138     fn intern_ty(&self,
 139         kind: TyKind<'tcx>
 140     ) -> Ty<'tcx> {
 141         self.type_.intern(kind, |kind| {
 142             let flags = super::flags::FlagComputation::for_kind(&kind);
 143
 144             let ty_struct = TyS {
 145                 kind,
 146                 flags: flags.flags,
 147                 outer_exclusive_binder: flags.outer_exclusive_binder,
 148             };
 149
 150             Interned(self.arena.alloc(ty_struct))
 151         }).0
 152     }
 153 }
 154
 155 pub struct CommonTypes<'tcx> {
 156     pub unit: Ty<'tcx>,
 157     pub bool: Ty<'tcx>,
 158     pub char: Ty<'tcx>,
 159     pub isize: Ty<'tcx>,
 160     pub i8: Ty<'tcx>,
 161     pub i16: Ty<'tcx>,
 162     pub i32: Ty<'tcx>,
 163     pub i64: Ty<'tcx>,
 164     pub i128: Ty<'tcx>,
 165     pub usize: Ty<'tcx>,
 166     pub u8: Ty<'tcx>,
 167     pub u16: Ty<'tcx>,
 168     pub u32: Ty<'tcx>,
 169     pub u64: Ty<'tcx>,
 170     pub u128: Ty<'tcx>,
 171     pub f32: Ty<'tcx>,
 172     pub f64: Ty<'tcx>,
 173     pub never: Ty<'tcx>,
 174     pub self_param: Ty<'tcx>,
 175     pub err: Ty<'tcx>,
 176
 177     /// Dummy type used for the `Self` of a `TraitRef` created for converting
 178     /// a trait object, and which gets removed in `ExistentialTraitRef`.
 179     /// This type must not appear anywhere in other converted types.
 180     pub trait_object_dummy_self: Ty<'tcx>,
 181 }
 182
 183 pub struct CommonLifetimes<'tcx> {
 184     pub re_empty: Region<'tcx>,
 185     pub re_static: Region<'tcx>,
 186     pub re_erased: Region<'tcx>,
 187 }
 188
 189 pub struct CommonConsts<'tcx> {
 190     pub err: &'tcx Const<'tcx>,
 191 }
 192
 193 pub struct LocalTableInContext<'a, V> {
 194     local_id_root: Option<DefId>,
 195     data: &'a ItemLocalMap<V>
 196 }
 197
 198 /// Validate that the given HirId (respectively its `local_id` part) can be
 199 /// safely used as a key in the tables of a TypeckTable. For that to be
 200 /// the case, the HirId must have the same `owner` as all the other IDs in
 201 /// this table (signified by `local_id_root`). Otherwise the HirId
 202 /// would be in a different frame of reference and using its `local_id`
 203 /// would result in lookup errors, or worse, in silently wrong data being
 204 /// stored/returned.
 205 fn validate_hir_id_for_typeck_tables(local_id_root: Option<DefId>,
 206                                      hir_id: hir::HirId,
 207                                      mut_access: bool) {
 208     if let Some(local_id_root) = local_id_root {
 209         if hir_id.owner != local_id_root.index {
 210             ty::tls::with(|tcx| {
 211                 bug!("node {} with HirId::owner {:?} cannot be placed in \
 212                         TypeckTables with local_id_root {:?}",
 213                         tcx.hir().node_to_string(hir_id),
 214                         DefId::local(hir_id.owner),
 215                         local_id_root)
 216             });
 217         }
 218     } else {
 219         // We use "Null Object" TypeckTables in some of the analysis passes.
 220         // These are just expected to be empty and their `local_id_root` is
 221         // `None`. Therefore we cannot verify whether a given `HirId` would
 222         // be a valid key for the given table. Instead we make sure that
 223         // nobody tries to write to such a Null Object table.
 224         if mut_access {
 225             bug!("access to invalid TypeckTables")
 226         }
 227     }
 228 }
 229
 230 impl<'a, V> LocalTableInContext<'a, V> {
 231     pub fn contains_key(&self, id: hir::HirId) -> bool {
 232         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 233         self.data.contains_key(&id.local_id)
 234     }
 235
 236     pub fn get(&self, id: hir::HirId) -> Option<&V> {
 237         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 238         self.data.get(&id.local_id)
 239     }
 240
 241     pub fn iter(&self) -> hash_map::Iter<'_, hir::ItemLocalId, V> {
 242         self.data.iter()
 243     }
 244 }
 245
 246 impl<'a, V> ::std::ops::Index<hir::HirId> for LocalTableInContext<'a, V> {
 247     type Output = V;
 248
 249     fn index(&self, key: hir::HirId) -> &V {
 250         self.get(key).expect("LocalTableInContext: key not found")
 251     }
 252 }
 253
 254 pub struct LocalTableInContextMut<'a, V> {
 255     local_id_root: Option<DefId>,
 256     data: &'a mut ItemLocalMap<V>
 257 }
 258
 259 impl<'a, V> LocalTableInContextMut<'a, V> {
 260     pub fn get_mut(&mut self, id: hir::HirId) -> Option<&mut V> {
 261         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 262         self.data.get_mut(&id.local_id)
 263     }
 264
 265     pub fn entry(&mut self, id: hir::HirId) -> Entry<'_, hir::ItemLocalId, V> {
 266         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 267         self.data.entry(id.local_id)
 268     }
 269
 270     pub fn insert(&mut self, id: hir::HirId, val: V) -> Option<V> {
 271         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 272         self.data.insert(id.local_id, val)
 273     }
 274
 275     pub fn remove(&mut self, id: hir::HirId) -> Option<V> {
 276         validate_hir_id_for_typeck_tables(self.local_id_root, id, true);
 277         self.data.remove(&id.local_id)
 278     }
 279 }
 280
 281 /// All information necessary to validate and reveal an `impl Trait`.
 282 #[derive(RustcEncodable, RustcDecodable, Debug, HashStable)]
 283 pub struct ResolvedOpaqueTy<'tcx> {
 284     /// The revealed type as seen by this function.
 285     pub concrete_type: Ty<'tcx>,
 286     /// Generic parameters on the opaque type as passed by this function.
 287     /// For `type Foo<A, B> = impl Bar<A, B>; fn foo<T, U>() -> Foo<T, U> { .. }`
 288     /// this is `[T, U]`, not `[A, B]`.
 289     pub substs: SubstsRef<'tcx>,
 290 }
 291
 292 /// Whenever a value may be live across a generator yield, the type of that value winds up in the
 293 /// `GeneratorInteriorTypeCause` struct. This struct adds additional information about such
 294 /// captured types that can be useful for diagnostics. In particular, it stores the span that
 295 /// caused a given type to be recorded, along with the scope that enclosed the value (which can
 296 /// be used to find the await that the value is live across).
 297 ///
 298 /// For example:
 299 ///
 300 /// ```ignore (pseudo-Rust)
 301 /// async move {
 302 ///     let x: T = ...;
 303 ///     foo.await
 304 ///     ...
 305 /// }
 306 /// ```
 307 ///
 308 /// Here, we would store the type `T`, the span of the value `x`, and the "scope-span" for
 309 /// the scope that contains `x`.
 310 #[derive(RustcEncodable, RustcDecodable, Clone, Debug, Eq, Hash, PartialEq)]
 311 #[derive(HashStable, TypeFoldable)]
 312 pub struct GeneratorInteriorTypeCause<'tcx> {
 313     /// Type of the captured binding.
 314     pub ty: Ty<'tcx>,
 315     /// Span of the binding that was captured.
 316     pub span: Span,
 317     /// Span of the scope of the captured binding.
 318     pub scope_span: Option<Span>,
 319 }
 320
 321 #[derive(RustcEncodable, RustcDecodable, Debug)]
 322 pub struct TypeckTables<'tcx> {
 323     /// The HirId::owner all ItemLocalIds in this table are relative to.
 324     pub local_id_root: Option<DefId>,
 325
 326     /// Resolved definitions for `<T>::X` associated paths and
 327     /// method calls, including those of overloaded operators.
 328     type_dependent_defs: ItemLocalMap<Result<(DefKind, DefId), ErrorReported>>,
 329
 330     /// Resolved field indices for field accesses in expressions (`S { field }`, `obj.field`)
 331     /// or patterns (`S { field }`). The index is often useful by itself, but to learn more
 332     /// about the field you also need definition of the variant to which the field
 333     /// belongs, but it may not exist if it's a tuple field (`tuple.0`).
 334     field_indices: ItemLocalMap<usize>,
 335
 336     /// Stores the types for various nodes in the AST. Note that this table
 337     /// is not guaranteed to be populated until after typeck. See
 338     /// typeck::check::fn_ctxt for details.
 339     node_types: ItemLocalMap<Ty<'tcx>>,
 340
 341     /// Stores the type parameters which were substituted to obtain the type
 342     /// of this node. This only applies to nodes that refer to entities
 343     /// parameterized by type parameters, such as generic fns, types, or
 344     /// other items.
 345     node_substs: ItemLocalMap<SubstsRef<'tcx>>,
 346
 347     /// This will either store the canonicalized types provided by the user
 348     /// or the substitutions that the user explicitly gave (if any) attached
 349     /// to `id`. These will not include any inferred values. The canonical form
 350     /// is used to capture things like `_` or other unspecified values.
 351     ///
 352     /// For example, if the user wrote `foo.collect::<Vec<_>>()`, then the
 353     /// canonical substitutions would include only `for<X> { Vec<X> }`.
 354     ///
 355     /// See also `AscribeUserType` statement in MIR.
 356     user_provided_types: ItemLocalMap<CanonicalUserType<'tcx>>,
 357
 358     /// Stores the canonicalized types provided by the user. See also
 359     /// `AscribeUserType` statement in MIR.
 360     pub user_provided_sigs: DefIdMap<CanonicalPolyFnSig<'tcx>>,
 361
 362     adjustments: ItemLocalMap<Vec<ty::adjustment::Adjustment<'tcx>>>,
 363
 364     /// Stores the actual binding mode for all instances of hir::BindingAnnotation.
 365     pat_binding_modes: ItemLocalMap<BindingMode>,
 366
 367     /// Stores the types which were implicitly dereferenced in pattern binding modes
 368     /// for later usage in HAIR lowering. For example,
 369     ///
 370     /// ```
 371     /// match &&Some(5i32) {
 372     ///     Some(n) => {},
 373     ///     _ => {},
 374     /// }
 375     /// ```
 376     /// leads to a `vec![&&Option<i32>, &Option<i32>]`. Empty vectors are not stored.
 377     ///
 378     /// See:
 379     /// https://github.com/rust-lang/rfcs/blob/master/text/2005-match-ergonomics.md#definitions
 380     pat_adjustments: ItemLocalMap<Vec<Ty<'tcx>>>,
 381
 382     /// Borrows
 383     pub upvar_capture_map: ty::UpvarCaptureMap<'tcx>,
 384
 385     /// Records the reasons that we picked the kind of each closure;
 386     /// not all closures are present in the map.
 387     closure_kind_origins: ItemLocalMap<(Span, ast::Name)>,
 388
 389     /// For each fn, records the "liberated" types of its arguments
 390     /// and return type. Liberated means that all bound regions
 391     /// (including late-bound regions) are replaced with free
 392     /// equivalents. This table is not used in codegen (since regions
 393     /// are erased there) and hence is not serialized to metadata.
 394     liberated_fn_sigs: ItemLocalMap<ty::FnSig<'tcx>>,
 395
 396     /// For each FRU expression, record the normalized types of the fields
 397     /// of the struct - this is needed because it is non-trivial to
 398     /// normalize while preserving regions. This table is used only in
 399     /// MIR construction and hence is not serialized to metadata.
 400     fru_field_types: ItemLocalMap<Vec<Ty<'tcx>>>,
 401
 402     /// For every coercion cast we add the HIR node ID of the cast
 403     /// expression to this set.
 404     coercion_casts: ItemLocalSet,
 405
 406     /// Set of trait imports actually used in the method resolution.
 407     /// This is used for warning unused imports. During type
 408     /// checking, this `Lrc` should not be cloned: it must have a ref-count
 409     /// of 1 so that we can insert things into the set mutably.
 410     pub used_trait_imports: Lrc<DefIdSet>,
 411
 412     /// If any errors occurred while type-checking this body,
 413     /// this field will be set to `true`.
 414     pub tainted_by_errors: bool,
 415
 416     /// Stores the free-region relationships that were deduced from
 417     /// its where-clauses and parameter types. These are then
 418     /// read-again by borrowck.
 419     pub free_region_map: FreeRegionMap<'tcx>,
 420
 421     /// All the opaque types that are restricted to concrete types
 422     /// by this function.
 423     pub concrete_opaque_types: FxHashMap<DefId, ResolvedOpaqueTy<'tcx>>,
 424
 425     /// Given the closure ID this map provides the list of UpvarIDs used by it.
 426     /// The upvarID contains the HIR node ID and it also contains the full path
 427     /// leading to the member of the struct or tuple that is used instead of the
 428     /// entire variable.
 429     pub upvar_list: ty::UpvarListMap,
 430
 431     /// Stores the type, span and optional scope span of all types
 432     /// that are live across the yield of this generator (if a generator).
 433     pub generator_interior_types: Vec<GeneratorInteriorTypeCause<'tcx>>,
 434 }
 435
 436 impl<'tcx> TypeckTables<'tcx> {
 437     pub fn empty(local_id_root: Option<DefId>) -> TypeckTables<'tcx> {
 438         TypeckTables {
 439             local_id_root,
 440             type_dependent_defs: Default::default(),
 441             field_indices: Default::default(),
 442             user_provided_types: Default::default(),
 443             user_provided_sigs: Default::default(),
 444             node_types: Default::default(),
 445             node_substs: Default::default(),
 446             adjustments: Default::default(),
 447             pat_binding_modes: Default::default(),
 448             pat_adjustments: Default::default(),
 449             upvar_capture_map: Default::default(),
 450             closure_kind_origins: Default::default(),
 451             liberated_fn_sigs: Default::default(),
 452             fru_field_types: Default::default(),
 453             coercion_casts: Default::default(),
 454             used_trait_imports: Lrc::new(Default::default()),
 455             tainted_by_errors: false,
 456             free_region_map: Default::default(),
 457             concrete_opaque_types: Default::default(),
 458             upvar_list: Default::default(),
 459             generator_interior_types: Default::default(),
 460         }
 461     }
 462
 463     /// Returns the final resolution of a `QPath` in an `Expr` or `Pat` node.
 464     pub fn qpath_res(&self, qpath: &hir::QPath, id: hir::HirId) -> Res {
 465         match *qpath {
 466             hir::QPath::Resolved(_, ref path) => path.res,
 467             hir::QPath::TypeRelative(..) => self.type_dependent_def(id)
 468                 .map_or(Res::Err, |(kind, def_id)| Res::Def(kind, def_id)),
 469         }
 470     }
 471
 472     pub fn type_dependent_defs(
 473         &self,
 474     ) -> LocalTableInContext<'_, Result<(DefKind, DefId), ErrorReported>> {
 475         LocalTableInContext {
 476             local_id_root: self.local_id_root,
 477             data: &self.type_dependent_defs
 478         }
 479     }
 480
 481     pub fn type_dependent_def(&self, id: HirId) -> Option<(DefKind, DefId)> {
 482         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 483         self.type_dependent_defs.get(&id.local_id).cloned().and_then(|r| r.ok())
 484     }
 485
 486     pub fn type_dependent_def_id(&self, id: HirId) -> Option<DefId> {
 487         self.type_dependent_def(id).map(|(_, def_id)| def_id)
 488     }
 489
 490     pub fn type_dependent_defs_mut(
 491         &mut self,
 492     ) -> LocalTableInContextMut<'_, Result<(DefKind, DefId), ErrorReported>> {
 493         LocalTableInContextMut {
 494             local_id_root: self.local_id_root,
 495             data: &mut self.type_dependent_defs
 496         }
 497     }
 498
 499     pub fn field_indices(&self) -> LocalTableInContext<'_, usize> {
 500         LocalTableInContext {
 501             local_id_root: self.local_id_root,
 502             data: &self.field_indices
 503         }
 504     }
 505
 506     pub fn field_indices_mut(&mut self) -> LocalTableInContextMut<'_, usize> {
 507         LocalTableInContextMut {
 508             local_id_root: self.local_id_root,
 509             data: &mut self.field_indices
 510         }
 511     }
 512
 513     pub fn user_provided_types(
 514         &self
 515     ) -> LocalTableInContext<'_, CanonicalUserType<'tcx>> {
 516         LocalTableInContext {
 517             local_id_root: self.local_id_root,
 518             data: &self.user_provided_types
 519         }
 520     }
 521
 522     pub fn user_provided_types_mut(
 523         &mut self
 524     ) -> LocalTableInContextMut<'_, CanonicalUserType<'tcx>> {
 525         LocalTableInContextMut {
 526             local_id_root: self.local_id_root,
 527             data: &mut self.user_provided_types
 528         }
 529     }
 530
 531     pub fn node_types(&self) -> LocalTableInContext<'_, Ty<'tcx>> {
 532         LocalTableInContext {
 533             local_id_root: self.local_id_root,
 534             data: &self.node_types
 535         }
 536     }
 537
 538     pub fn node_types_mut(&mut self) -> LocalTableInContextMut<'_, Ty<'tcx>> {
 539         LocalTableInContextMut {
 540             local_id_root: self.local_id_root,
 541             data: &mut self.node_types
 542         }
 543     }
 544
 545     pub fn node_type(&self, id: hir::HirId) -> Ty<'tcx> {
 546         self.node_type_opt(id).unwrap_or_else(||
 547             bug!("node_type: no type for node `{}`",
 548                  tls::with(|tcx| tcx.hir().node_to_string(id)))
 549         )
 550     }
 551
 552     pub fn node_type_opt(&self, id: hir::HirId) -> Option<Ty<'tcx>> {
 553         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 554         self.node_types.get(&id.local_id).cloned()
 555     }
 556
 557     pub fn node_substs_mut(&mut self) -> LocalTableInContextMut<'_, SubstsRef<'tcx>> {
 558         LocalTableInContextMut {
 559             local_id_root: self.local_id_root,
 560             data: &mut self.node_substs
 561         }
 562     }
 563
 564     pub fn node_substs(&self, id: hir::HirId) -> SubstsRef<'tcx> {
 565         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 566         self.node_substs.get(&id.local_id).cloned().unwrap_or_else(|| InternalSubsts::empty())
 567     }
 568
 569     pub fn node_substs_opt(&self, id: hir::HirId) -> Option<SubstsRef<'tcx>> {
 570         validate_hir_id_for_typeck_tables(self.local_id_root, id, false);
 571         self.node_substs.get(&id.local_id).cloned()
 572     }
 573
 574     // Returns the type of a pattern as a monotype. Like @expr_ty, this function
 575     // doesn't provide type parameter substitutions.
 576     pub fn pat_ty(&self, pat: &hir::Pat) -> Ty<'tcx> {
 577         self.node_type(pat.hir_id)
 578     }
 579
 580     pub fn pat_ty_opt(&self, pat: &hir::Pat) -> Option<Ty<'tcx>> {
 581         self.node_type_opt(pat.hir_id)
 582     }
 583
 584     // Returns the type of an expression as a monotype.
 585     //
 586     // NB (1): This is the PRE-ADJUSTMENT TYPE for the expression.  That is, in
 587     // some cases, we insert `Adjustment` annotations such as auto-deref or
 588     // auto-ref.  The type returned by this function does not consider such
 589     // adjustments.  See `expr_ty_adjusted()` instead.
 590     //
 591     // NB (2): This type doesn't provide type parameter substitutions; e.g., if you
 592     // ask for the type of "id" in "id(3)", it will return "fn(&isize) -> isize"
 593     // instead of "fn(ty) -> T with T = isize".
 594     pub fn expr_ty(&self, expr: &hir::Expr) -> Ty<'tcx> {
 595         self.node_type(expr.hir_id)
 596     }
 597
 598     pub fn expr_ty_opt(&self, expr: &hir::Expr) -> Option<Ty<'tcx>> {
 599         self.node_type_opt(expr.hir_id)
 600     }
 601
 602     pub fn adjustments(&self) -> LocalTableInContext<'_, Vec<ty::adjustment::Adjustment<'tcx>>> {
 603         LocalTableInContext {
 604             local_id_root: self.local_id_root,
 605             data: &self.adjustments
 606         }
 607     }
 608
 609     pub fn adjustments_mut(&mut self)
 610                            -> LocalTableInContextMut<'_, Vec<ty::adjustment::Adjustment<'tcx>>> {
 611         LocalTableInContextMut {
 612             local_id_root: self.local_id_root,
 613             data: &mut self.adjustments
 614         }
 615     }
 616
 617     pub fn expr_adjustments(&self, expr: &hir::Expr)
 618                             -> &[ty::adjustment::Adjustment<'tcx>] {
 619         validate_hir_id_for_typeck_tables(self.local_id_root, expr.hir_id, false);
 620         self.adjustments.get(&expr.hir_id.local_id).map_or(&[], |a| &a[..])
 621     }
 622
 623     /// Returns the type of `expr`, considering any `Adjustment`
 624     /// entry recorded for that expression.
 625     pub fn expr_ty_adjusted(&self, expr: &hir::Expr) -> Ty<'tcx> {
 626         self.expr_adjustments(expr)
 627             .last()
 628             .map_or_else(|| self.expr_ty(expr), |adj| adj.target)
 629     }
 630
 631     pub fn expr_ty_adjusted_opt(&self, expr: &hir::Expr) -> Option<Ty<'tcx>> {
 632         self.expr_adjustments(expr)
 633             .last()
 634             .map(|adj| adj.target)
 635             .or_else(|| self.expr_ty_opt(expr))
 636     }
 637
 638     pub fn is_method_call(&self, expr: &hir::Expr) -> bool {
 639         // Only paths and method calls/overloaded operators have
 640         // entries in type_dependent_defs, ignore the former here.
 641         if let hir::ExprKind::Path(_) = expr.kind {
 642             return false;
 643         }
 644
 645         match self.type_dependent_defs().get(expr.hir_id) {
 646             Some(Ok((DefKind::Method, _))) => true,
 647             _ => false
 648         }
 649     }
 650
 651     pub fn extract_binding_mode(&self, s: &Session, id: HirId, sp: Span) -> Option<BindingMode> {
 652         self.pat_binding_modes().get(id).copied().or_else(|| {
 653             s.delay_span_bug(sp, "missing binding mode");
 654             None
 655         })
 656     }
 657
 658     pub fn pat_binding_modes(&self) -> LocalTableInContext<'_, BindingMode> {
 659         LocalTableInContext {
 660             local_id_root: self.local_id_root,
 661             data: &self.pat_binding_modes
 662         }
 663     }
 664
 665     pub fn pat_binding_modes_mut(&mut self)
 666                            -> LocalTableInContextMut<'_, BindingMode> {
 667         LocalTableInContextMut {
 668             local_id_root: self.local_id_root,
 669             data: &mut self.pat_binding_modes
 670         }
 671     }
 672
 673     pub fn pat_adjustments(&self) -> LocalTableInContext<'_, Vec<Ty<'tcx>>> {
 674         LocalTableInContext {
 675             local_id_root: self.local_id_root,
 676             data: &self.pat_adjustments,
 677         }
 678     }
 679
 680     pub fn pat_adjustments_mut(&mut self)
 681                                -> LocalTableInContextMut<'_, Vec<Ty<'tcx>>> {
 682         LocalTableInContextMut {
 683             local_id_root: self.local_id_root,
 684             data: &mut self.pat_adjustments,
 685         }
 686     }
 687
 688     pub fn upvar_capture(&self, upvar_id: ty::UpvarId) -> ty::UpvarCapture<'tcx> {
 689         self.upvar_capture_map[&upvar_id]
 690     }
 691
 692     pub fn closure_kind_origins(&self) -> LocalTableInContext<'_, (Span, ast::Name)> {
 693         LocalTableInContext {
 694             local_id_root: self.local_id_root,
 695             data: &self.closure_kind_origins
 696         }
 697     }
 698
 699     pub fn closure_kind_origins_mut(&mut self) -> LocalTableInContextMut<'_, (Span, ast::Name)> {
 700         LocalTableInContextMut {
 701             local_id_root: self.local_id_root,
 702             data: &mut self.closure_kind_origins
 703         }
 704     }
 705
 706     pub fn liberated_fn_sigs(&self) -> LocalTableInContext<'_, ty::FnSig<'tcx>> {
 707         LocalTableInContext {
 708             local_id_root: self.local_id_root,
 709             data: &self.liberated_fn_sigs
 710         }
 711     }
 712
 713     pub fn liberated_fn_sigs_mut(&mut self) -> LocalTableInContextMut<'_, ty::FnSig<'tcx>> {
 714         LocalTableInContextMut {
 715             local_id_root: self.local_id_root,
 716             data: &mut self.liberated_fn_sigs
 717         }
 718     }
 719
 720     pub fn fru_field_types(&self) -> LocalTableInContext<'_, Vec<Ty<'tcx>>> {
 721         LocalTableInContext {
 722             local_id_root: self.local_id_root,
 723             data: &self.fru_field_types
 724         }
 725     }
 726
 727     pub fn fru_field_types_mut(&mut self) -> LocalTableInContextMut<'_, Vec<Ty<'tcx>>> {
 728         LocalTableInContextMut {
 729             local_id_root: self.local_id_root,
 730             data: &mut self.fru_field_types
 731         }
 732     }
 733
 734     pub fn is_coercion_cast(&self, hir_id: hir::HirId) -> bool {
 735         validate_hir_id_for_typeck_tables(self.local_id_root, hir_id, true);
 736         self.coercion_casts.contains(&hir_id.local_id)
 737     }
 738
 739     pub fn set_coercion_cast(&mut self, id: ItemLocalId) {
 740         self.coercion_casts.insert(id);
 741     }
 742
 743     pub fn coercion_casts(&self) -> &ItemLocalSet {
 744         &self.coercion_casts
 745     }
 746
 747 }
 748
 749 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for TypeckTables<'tcx> {
 750     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
 751         let ty::TypeckTables {
 752             local_id_root,
 753             ref type_dependent_defs,
 754             ref field_indices,
 755             ref user_provided_types,
 756             ref user_provided_sigs,
 757             ref node_types,
 758             ref node_substs,
 759             ref adjustments,
 760             ref pat_binding_modes,
 761             ref pat_adjustments,
 762             ref upvar_capture_map,
 763             ref closure_kind_origins,
 764             ref liberated_fn_sigs,
 765             ref fru_field_types,
 766
 767             ref coercion_casts,
 768
 769             ref used_trait_imports,
 770             tainted_by_errors,
 771             ref free_region_map,
 772             ref concrete_opaque_types,
 773             ref upvar_list,
 774             ref generator_interior_types,
 775
 776         } = *self;
 777
 778         hcx.with_node_id_hashing_mode(NodeIdHashingMode::HashDefPath, |hcx| {
 779             type_dependent_defs.hash_stable(hcx, hasher);
 780             field_indices.hash_stable(hcx, hasher);
 781             user_provided_types.hash_stable(hcx, hasher);
 782             user_provided_sigs.hash_stable(hcx, hasher);
 783             node_types.hash_stable(hcx, hasher);
 784             node_substs.hash_stable(hcx, hasher);
 785             adjustments.hash_stable(hcx, hasher);
 786             pat_binding_modes.hash_stable(hcx, hasher);
 787             pat_adjustments.hash_stable(hcx, hasher);
 788             hash_stable_hashmap(hcx, hasher, upvar_capture_map, |up_var_id, hcx| {
 789                 let ty::UpvarId {
 790                     var_path,
 791                     closure_expr_id
 792                 } = *up_var_id;
 793
 794                 let local_id_root =
 795                     local_id_root.expect("trying to hash invalid TypeckTables");
 796
 797                 let var_owner_def_id = DefId {
 798                     krate: local_id_root.krate,
 799                     index: var_path.hir_id.owner,
 800                 };
 801                 let closure_def_id = DefId {
 802                     krate: local_id_root.krate,
 803                     index: closure_expr_id.to_def_id().index,
 804                 };
 805                 (hcx.def_path_hash(var_owner_def_id),
 806                  var_path.hir_id.local_id,
 807                  hcx.def_path_hash(closure_def_id))
 808             });
 809
 810             closure_kind_origins.hash_stable(hcx, hasher);
 811             liberated_fn_sigs.hash_stable(hcx, hasher);
 812             fru_field_types.hash_stable(hcx, hasher);
 813             coercion_casts.hash_stable(hcx, hasher);
 814             used_trait_imports.hash_stable(hcx, hasher);
 815             tainted_by_errors.hash_stable(hcx, hasher);
 816             free_region_map.hash_stable(hcx, hasher);
 817             concrete_opaque_types.hash_stable(hcx, hasher);
 818             upvar_list.hash_stable(hcx, hasher);
 819             generator_interior_types.hash_stable(hcx, hasher);
 820         })
 821     }
 822 }
 823
 824 rustc_index::newtype_index! {
 825     pub struct UserTypeAnnotationIndex {
 826         derive [HashStable]
 827         DEBUG_FORMAT = "UserType({})",
 828         const START_INDEX = 0,
 829     }
 830 }
 831
 832 /// Mapping of type annotation indices to canonical user type annotations.
 833 pub type CanonicalUserTypeAnnotations<'tcx> =
 834     IndexVec<UserTypeAnnotationIndex, CanonicalUserTypeAnnotation<'tcx>>;
 835
 836 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable, TypeFoldable, Lift)]
 837 pub struct CanonicalUserTypeAnnotation<'tcx> {
 838     pub user_ty: CanonicalUserType<'tcx>,
 839     pub span: Span,
 840     pub inferred_ty: Ty<'tcx>,
 841 }
 842
 843 /// Canonicalized user type annotation.
 844 pub type CanonicalUserType<'tcx> = Canonical<'tcx, UserType<'tcx>>;
 845
 846 impl CanonicalUserType<'tcx> {
 847     /// Returns `true` if this represents a substitution of the form `[?0, ?1, ?2]`,
 848     /// i.e., each thing is mapped to a canonical variable with the same index.
 849     pub fn is_identity(&self) -> bool {
 850         match self.value {
 851             UserType::Ty(_) => false,
 852             UserType::TypeOf(_, user_substs) => {
 853                 if user_substs.user_self_ty.is_some() {
 854                     return false;
 855                 }
 856
 857                 user_substs.substs.iter().zip(BoundVar::new(0)..).all(|(kind, cvar)| {
 858                     match kind.unpack() {
 859                         GenericArgKind::Type(ty) => match ty.kind {
 860                             ty::Bound(debruijn, b) => {
 861                                 // We only allow a `ty::INNERMOST` index in substitutions.
 862                                 assert_eq!(debruijn, ty::INNERMOST);
 863                                 cvar == b.var
 864                             }
 865                             _ => false,
 866                         },
 867
 868                         GenericArgKind::Lifetime(r) => match r {
 869                             ty::ReLateBound(debruijn, br) => {
 870                                 // We only allow a `ty::INNERMOST` index in substitutions.
 871                                 assert_eq!(*debruijn, ty::INNERMOST);
 872                                 cvar == br.assert_bound_var()
 873                             }
 874                             _ => false,
 875                         },
 876
 877                         GenericArgKind::Const(ct) => match ct.val {
 878                             ty::ConstKind::Bound(debruijn, b) => {
 879                                 // We only allow a `ty::INNERMOST` index in substitutions.
 880                                 assert_eq!(debruijn, ty::INNERMOST);
 881                                 cvar == b
 882                             }
 883                             _ => false,
 884                         },
 885                     }
 886                 })
 887             },
 888         }
 889     }
 890 }
 891
 892 /// A user-given type annotation attached to a constant. These arise
 893 /// from constants that are named via paths, like `Foo::<A>::new` and
 894 /// so forth.
 895 #[derive(Copy, Clone, Debug, PartialEq, RustcEncodable, RustcDecodable)]
 896 #[derive(HashStable, TypeFoldable, Lift)]
 897 pub enum UserType<'tcx> {
 898     Ty(Ty<'tcx>),
 899
 900     /// The canonical type is the result of `type_of(def_id)` with the
 901     /// given substitutions applied.
 902     TypeOf(DefId, UserSubsts<'tcx>),
 903 }
 904
 905 impl<'tcx> CommonTypes<'tcx> {
 906     fn new(interners: &CtxtInterners<'tcx>) -> CommonTypes<'tcx> {
 907         let mk = |ty| interners.intern_ty(ty);
 908
 909         CommonTypes {
 910             unit: mk(Tuple(List::empty())),
 911             bool: mk(Bool),
 912             char: mk(Char),
 913             never: mk(Never),
 914             err: mk(Error),
 915             isize: mk(Int(ast::IntTy::Isize)),
 916             i8: mk(Int(ast::IntTy::I8)),
 917             i16: mk(Int(ast::IntTy::I16)),
 918             i32: mk(Int(ast::IntTy::I32)),
 919             i64: mk(Int(ast::IntTy::I64)),
 920             i128: mk(Int(ast::IntTy::I128)),
 921             usize: mk(Uint(ast::UintTy::Usize)),
 922             u8: mk(Uint(ast::UintTy::U8)),
 923             u16: mk(Uint(ast::UintTy::U16)),
 924             u32: mk(Uint(ast::UintTy::U32)),
 925             u64: mk(Uint(ast::UintTy::U64)),
 926             u128: mk(Uint(ast::UintTy::U128)),
 927             f32: mk(Float(ast::FloatTy::F32)),
 928             f64: mk(Float(ast::FloatTy::F64)),
 929             self_param: mk(ty::Param(ty::ParamTy {
 930                 index: 0,
 931                 name: kw::SelfUpper,
 932             })),
 933
 934             trait_object_dummy_self: mk(Infer(ty::FreshTy(0))),
 935         }
 936     }
 937 }
 938
 939 impl<'tcx> CommonLifetimes<'tcx> {
 940     fn new(interners: &CtxtInterners<'tcx>) -> CommonLifetimes<'tcx> {
 941         let mk = |r| {
 942             interners.region.intern(r, |r| {
 943                 Interned(interners.arena.alloc(r))
 944             }).0
 945         };
 946
 947         CommonLifetimes {
 948             re_empty: mk(RegionKind::ReEmpty),
 949             re_static: mk(RegionKind::ReStatic),
 950             re_erased: mk(RegionKind::ReErased),
 951         }
 952     }
 953 }
 954
 955 impl<'tcx> CommonConsts<'tcx> {
 956     fn new(interners: &CtxtInterners<'tcx>, types: &CommonTypes<'tcx>) -> CommonConsts<'tcx> {
 957         let mk_const = |c| {
 958             interners.const_.intern(c, |c| {
 959                 Interned(interners.arena.alloc(c))
 960             }).0
 961         };
 962
 963         CommonConsts {
 964             err: mk_const(ty::Const {
 965                 val: ty::ConstKind::Value(ConstValue::Scalar(Scalar::zst())),
 966                 ty: types.err,
 967             }),
 968         }
 969     }
 970 }
 971
 972 // This struct contains information regarding the `ReFree(FreeRegion)` corresponding to a lifetime
 973 // conflict.
 974 #[derive(Debug)]
 975 pub struct FreeRegionInfo {
 976     // def id corresponding to FreeRegion
 977     pub def_id: DefId,
 978     // the bound region corresponding to FreeRegion
 979     pub boundregion: ty::BoundRegion,
 980     // checks if bound region is in Impl Item
 981     pub is_impl_item: bool,
 982 }
 983
 984 /// The central data structure of the compiler. It stores references
 985 /// to the various **arenas** and also houses the results of the
 986 /// various **compiler queries** that have been performed. See the
 987 /// [rustc guide] for more details.
 988 ///
 989 /// [rustc guide]: https://rust-lang.github.io/rustc-guide/ty.html
 990 #[derive(Copy, Clone)]
 991 #[rustc_diagnostic_item = "TyCtxt"]
 992 pub struct TyCtxt<'tcx> {
 993     gcx: &'tcx GlobalCtxt<'tcx>,
 994 }
 995
 996 impl<'tcx> Deref for TyCtxt<'tcx> {
 997     type Target = &'tcx GlobalCtxt<'tcx>;
 998     #[inline(always)]
 999     fn deref(&self) -> &Self::Target {
1000         &self.gcx
1001     }
1002 }
1003
1004 pub struct GlobalCtxt<'tcx> {
1005     pub arena: &'tcx WorkerLocal<Arena<'tcx>>,
1006
1007     interners: CtxtInterners<'tcx>,
1008
1009     cstore: Box<CrateStoreDyn>,
1010
1011     pub sess: &'tcx Session,
1012
1013     pub lint_store: Lrc<lint::LintStore>,
1014
1015     pub dep_graph: DepGraph,
1016
1017     pub prof: SelfProfilerRef,
1018
1019     /// Common types, pre-interned for your convenience.
1020     pub types: CommonTypes<'tcx>,
1021
1022     /// Common lifetimes, pre-interned for your convenience.
1023     pub lifetimes: CommonLifetimes<'tcx>,
1024
1025     /// Common consts, pre-interned for your convenience.
1026     pub consts: CommonConsts<'tcx>,
1027
1028     /// Resolutions of `extern crate` items produced by resolver.
1029     extern_crate_map: NodeMap<CrateNum>,
1030
1031     /// Map indicating what traits are in scope for places where this
1032     /// is relevant; generated by resolve.
1033     trait_map: FxHashMap<DefIndex,
1034                          FxHashMap<ItemLocalId,
1035                                    StableVec<TraitCandidate>>>,
1036
1037     /// Export map produced by name resolution.
1038     export_map: FxHashMap<DefId, Vec<Export<hir::HirId>>>,
1039
1040     hir_map: hir_map::Map<'tcx>,
1041
1042     /// A map from `DefPathHash` -> `DefId`. Includes `DefId`s from the local crate
1043     /// as well as all upstream crates. Only populated in incremental mode.
1044     pub def_path_hash_to_def_id: Option<FxHashMap<DefPathHash, DefId>>,
1045
1046     pub queries: query::Queries<'tcx>,
1047
1048     maybe_unused_trait_imports: FxHashSet<DefId>,
1049     maybe_unused_extern_crates: Vec<(DefId, Span)>,
1050     /// A map of glob use to a set of names it actually imports. Currently only
1051     /// used in save-analysis.
1052     glob_map: FxHashMap<DefId, FxHashSet<ast::Name>>,
1053     /// Extern prelude entries. The value is `true` if the entry was introduced
1054     /// via `extern crate` item and not `--extern` option or compiler built-in.
1055     pub extern_prelude: FxHashMap<ast::Name, bool>,
1056
1057     // Internal cache for metadata decoding. No need to track deps on this.
1058     pub rcache: Lock<FxHashMap<ty::CReaderCacheKey, Ty<'tcx>>>,
1059
1060     /// Caches the results of trait selection. This cache is used
1061     /// for things that do not have to do with the parameters in scope.
1062     pub selection_cache: traits::SelectionCache<'tcx>,
1063
1064     /// Caches the results of trait evaluation. This cache is used
1065     /// for things that do not have to do with the parameters in scope.
1066     /// Merge this with `selection_cache`?
1067     pub evaluation_cache: traits::EvaluationCache<'tcx>,
1068
1069     /// The definite name of the current crate after taking into account
1070     /// attributes, commandline parameters, etc.
1071     pub crate_name: Symbol,
1072
1073     /// Data layout specification for the current target.
1074     pub data_layout: TargetDataLayout,
1075
1076     /// `#[stable]` and `#[unstable]` attributes
1077     stability_interner: ShardedHashMap<&'tcx attr::Stability, ()>,
1078
1079     /// `#[rustc_const_stable]` and `#[rustc_const_unstable]` attributes
1080     const_stability_interner: ShardedHashMap<&'tcx attr::ConstStability, ()>,
1081
1082     /// Stores the value of constants (and deduplicates the actual memory)
1083     allocation_interner: ShardedHashMap<&'tcx Allocation, ()>,
1084
1085     pub alloc_map: Lock<interpret::AllocMap<'tcx>>,
1086
1087     layout_interner: ShardedHashMap<&'tcx LayoutDetails, ()>,
1088
1089     output_filenames: Arc<OutputFilenames>,
1090 }
1091
1092 impl<'tcx> TyCtxt<'tcx> {
1093     #[inline(always)]
1094     pub fn hir(self) -> &'tcx hir_map::Map<'tcx> {
1095         &self.hir_map
1096     }
1097
1098     pub fn alloc_steal_mir(self, mir: BodyAndCache<'tcx>) -> &'tcx Steal<BodyAndCache<'tcx>> {
1099         self.arena.alloc(Steal::new(mir))
1100     }
1101
1102     pub fn alloc_steal_promoted(self, promoted: IndexVec<Promoted, BodyAndCache<'tcx>>) ->
1103         &'tcx Steal<IndexVec<Promoted, BodyAndCache<'tcx>>> {
1104         self.arena.alloc(Steal::new(promoted))
1105     }
1106
1107     pub fn intern_promoted(self, promoted: IndexVec<Promoted, BodyAndCache<'tcx>>) ->
1108         &'tcx IndexVec<Promoted, BodyAndCache<'tcx>> {
1109         self.arena.alloc(promoted)
1110     }
1111
1112     pub fn alloc_adt_def(
1113         self,
1114         did: DefId,
1115         kind: AdtKind,
1116         variants: IndexVec<VariantIdx, ty::VariantDef>,
1117         repr: ReprOptions,
1118     ) -> &'tcx ty::AdtDef {
1119         let def = ty::AdtDef::new(self, did, kind, variants, repr);
1120         self.arena.alloc(def)
1121     }
1122
1123     pub fn intern_const_alloc(self, alloc: Allocation) -> &'tcx Allocation {
1124         self.allocation_interner.intern(alloc, |alloc| {
1125             self.arena.alloc(alloc)
1126         })
1127     }
1128
1129     /// Allocates a read-only byte or string literal for `mir::interpret`.
1130     pub fn allocate_bytes(self, bytes: &[u8]) -> interpret::AllocId {
1131         // Create an allocation that just contains these bytes.
1132         let alloc = interpret::Allocation::from_byte_aligned_bytes(bytes);
1133         let alloc = self.intern_const_alloc(alloc);
1134         self.alloc_map.lock().create_memory_alloc(alloc)
1135     }
1136
1137     pub fn intern_stability(self, stab: attr::Stability) -> &'tcx attr::Stability {
1138         self.stability_interner.intern(stab, |stab| {
1139             self.arena.alloc(stab)
1140         })
1141     }
1142
1143     pub fn intern_const_stability(self, stab: attr::ConstStability) -> &'tcx attr::ConstStability {
1144         self.const_stability_interner.intern(stab, |stab| {
1145             self.arena.alloc(stab)
1146         })
1147     }
1148
1149     pub fn intern_layout(self, layout: LayoutDetails) -> &'tcx LayoutDetails {
1150         self.layout_interner.intern(layout, |layout| {
1151             self.arena.alloc(layout)
1152         })
1153     }
1154
1155     /// Returns a range of the start/end indices specified with the
1156     /// `rustc_layout_scalar_valid_range` attribute.
1157     pub fn layout_scalar_valid_range(self, def_id: DefId) -> (Bound<u128>, Bound<u128>) {
1158         let attrs = self.get_attrs(def_id);
1159         let get = |name| {
1160             let attr = match attrs.iter().find(|a| a.check_name(name)) {
1161                 Some(attr) => attr,
1162                 None => return Bound::Unbounded,
1163             };
1164             for meta in attr.meta_item_list().expect("rustc_layout_scalar_valid_range takes args") {
1165                 match meta.literal().expect("attribute takes lit").kind {
1166                     ast::LitKind::Int(a, _) => return Bound::Included(a),
1167                     _ => span_bug!(attr.span, "rustc_layout_scalar_valid_range expects int arg"),
1168                 }
1169             }
1170             span_bug!(attr.span, "no arguments to `rustc_layout_scalar_valid_range` attribute");
1171         };
1172         (get(sym::rustc_layout_scalar_valid_range_start),
1173          get(sym::rustc_layout_scalar_valid_range_end))
1174     }
1175
1176     pub fn lift<T: ?Sized + Lift<'tcx>>(self, value: &T) -> Option<T::Lifted> {
1177         value.lift_to_tcx(self)
1178     }
1179
1180     /// Creates a type context and call the closure with a `TyCtxt` reference
1181     /// to the context. The closure enforces that the type context and any interned
1182     /// value (types, substs, etc.) can only be used while `ty::tls` has a valid
1183     /// reference to the context, to allow formatting values that need it.
1184     pub fn create_global_ctxt(
1185         s: &'tcx Session,
1186         lint_store: Lrc<lint::LintStore>,
1187         local_providers: ty::query::Providers<'tcx>,
1188         extern_providers: ty::query::Providers<'tcx>,
1189         arenas: &'tcx AllArenas,
1190         arena: &'tcx WorkerLocal<Arena<'tcx>>,
1191         resolutions: ty::ResolverOutputs,
1192         hir: hir_map::Map<'tcx>,
1193         on_disk_query_result_cache: query::OnDiskCache<'tcx>,
1194         crate_name: &str,
1195         output_filenames: &OutputFilenames,
1196     ) -> GlobalCtxt<'tcx> {
1197         let data_layout = TargetDataLayout::parse(&s.target.target).unwrap_or_else(|err| {
1198             s.fatal(&err);
1199         });
1200         let interners = CtxtInterners::new(&arenas.interner);
1201         let common_types = CommonTypes::new(&interners);
1202         let common_lifetimes = CommonLifetimes::new(&interners);
1203         let common_consts = CommonConsts::new(&interners, &common_types);
1204         let dep_graph = hir.dep_graph.clone();
1205         let cstore = resolutions.cstore;
1206         let crates = cstore.crates_untracked();
1207         let max_cnum = crates.iter().map(|c| c.as_usize()).max().unwrap_or(0);
1208         let mut providers = IndexVec::from_elem_n(extern_providers, max_cnum + 1);
1209         providers[LOCAL_CRATE] = local_providers;
1210
1211         let def_path_hash_to_def_id = if s.opts.build_dep_graph() {
1212             let def_path_tables = crates
1213                 .iter()
1214                 .map(|&cnum| (cnum, cstore.def_path_table(cnum)))
1215                 .chain(iter::once((LOCAL_CRATE, hir.definitions().def_path_table())));
1216
1217             // Precompute the capacity of the hashmap so we don't have to
1218             // re-allocate when populating it.
1219             let capacity = def_path_tables.clone().map(|(_, t)| t.size()).sum::<usize>();
1220
1221             let mut map: FxHashMap<_, _> = FxHashMap::with_capacity_and_hasher(
1222                 capacity,
1223                 ::std::default::Default::default()
1224             );
1225
1226             for (cnum, def_path_table) in def_path_tables {
1227                 def_path_table.add_def_path_hashes_to(cnum, &mut map);
1228             }
1229
1230             Some(map)
1231         } else {
1232             None
1233         };
1234
1235         let mut trait_map: FxHashMap<_, FxHashMap<_, _>> = FxHashMap::default();
1236         for (k, v) in resolutions.trait_map {
1237             let hir_id = hir.node_to_hir_id(k);
1238             let map = trait_map.entry(hir_id.owner).or_default();
1239             map.insert(hir_id.local_id, StableVec::new(v));
1240         }
1241
1242         GlobalCtxt {
1243             sess: s,
1244             lint_store,
1245             cstore,
1246             arena,
1247             interners,
1248             dep_graph,
1249             prof: s.prof.clone(),
1250             types: common_types,
1251             lifetimes: common_lifetimes,
1252             consts: common_consts,
1253             extern_crate_map: resolutions.extern_crate_map,
1254             trait_map,
1255             export_map: resolutions.export_map.into_iter().map(|(k, v)| {
1256                 let exports: Vec<_> = v.into_iter().map(|e| {
1257                     e.map_id(|id| hir.node_to_hir_id(id))
1258                 }).collect();
1259                 (k, exports)
1260             }).collect(),
1261             maybe_unused_trait_imports:
1262                 resolutions.maybe_unused_trait_imports
1263                     .into_iter()
1264                     .map(|id| hir.local_def_id_from_node_id(id))
1265                     .collect(),
1266             maybe_unused_extern_crates:
1267                 resolutions.maybe_unused_extern_crates
1268                     .into_iter()
1269                     .map(|(id, sp)| (hir.local_def_id_from_node_id(id), sp))
1270                     .collect(),
1271             glob_map: resolutions.glob_map.into_iter().map(|(id, names)| {
1272                 (hir.local_def_id_from_node_id(id), names)
1273             }).collect(),
1274             extern_prelude: resolutions.extern_prelude,
1275             hir_map: hir,
1276             def_path_hash_to_def_id,
1277             queries: query::Queries::new(
1278                 providers,
1279                 extern_providers,
1280                 on_disk_query_result_cache,
1281             ),
1282             rcache: Default::default(),
1283             selection_cache: Default::default(),
1284             evaluation_cache: Default::default(),
1285             crate_name: Symbol::intern(crate_name),
1286             data_layout,
1287             layout_interner: Default::default(),
1288             stability_interner: Default::default(),
1289             const_stability_interner: Default::default(),
1290             allocation_interner: Default::default(),
1291             alloc_map: Lock::new(interpret::AllocMap::new()),
1292             output_filenames: Arc::new(output_filenames.clone()),
1293         }
1294     }
1295
1296     pub fn consider_optimizing<T: Fn() -> String>(&self, msg: T) -> bool {
1297         let cname = self.crate_name(LOCAL_CRATE).as_str();
1298         self.sess.consider_optimizing(&cname, msg)
1299     }
1300
1301     pub fn lib_features(self) -> &'tcx middle::lib_features::LibFeatures {
1302         self.get_lib_features(LOCAL_CRATE)
1303     }
1304
1305     /// Obtain all lang items of this crate and all dependencies (recursively)
1306     pub fn lang_items(self) -> &'tcx middle::lang_items::LanguageItems {
1307         self.get_lang_items(LOCAL_CRATE)
1308     }
1309
1310     /// Obtain the given diagnostic item's `DefId`. Use `is_diagnostic_item` if you just want to
1311     /// compare against another `DefId`, since `is_diagnostic_item` is cheaper.
1312     pub fn get_diagnostic_item(self, name: Symbol) -> Option<DefId> {
1313         self.all_diagnostic_items(LOCAL_CRATE).get(&name).copied()
1314     }
1315
1316     /// Check whether the diagnostic item with the given `name` has the given `DefId`.
1317     pub fn is_diagnostic_item(self, name: Symbol, did: DefId) -> bool {
1318         self.diagnostic_items(did.krate).get(&name) == Some(&did)
1319     }
1320
1321     pub fn stability(self) -> &'tcx stability::Index<'tcx> {
1322         self.stability_index(LOCAL_CRATE)
1323     }
1324
1325     pub fn crates(self) -> &'tcx [CrateNum] {
1326         self.all_crate_nums(LOCAL_CRATE)
1327     }
1328
1329     pub fn allocator_kind(self) -> Option<AllocatorKind> {
1330         self.cstore.allocator_kind()
1331     }
1332
1333     pub fn features(self) -> &'tcx rustc_feature::Features {
1334         self.features_query(LOCAL_CRATE)
1335     }
1336
1337     pub fn def_key(self, id: DefId) -> hir_map::DefKey {
1338         if id.is_local() {
1339             self.hir().def_key(id)
1340         } else {
1341             self.cstore.def_key(id)
1342         }
1343     }
1344
1345     /// Converts a `DefId` into its fully expanded `DefPath` (every
1346     /// `DefId` is really just an interned `DefPath`).
1347     ///
1348     /// Note that if `id` is not local to this crate, the result will
1349     ///  be a non-local `DefPath`.
1350     pub fn def_path(self, id: DefId) -> hir_map::DefPath {
1351         if id.is_local() {
1352             self.hir().def_path(id)
1353         } else {
1354             self.cstore.def_path(id)
1355         }
1356     }
1357
1358     /// Returns whether or not the crate with CrateNum 'cnum'
1359     /// is marked as a private dependency
1360     pub fn is_private_dep(self, cnum: CrateNum) -> bool {
1361         if cnum == LOCAL_CRATE {
1362             false
1363         } else {
1364             self.cstore.crate_is_private_dep_untracked(cnum)
1365         }
1366     }
1367
1368     #[inline]
1369     pub fn def_path_hash(self, def_id: DefId) -> hir_map::DefPathHash {
1370         if def_id.is_local() {
1371             self.hir().definitions().def_path_hash(def_id.index)
1372         } else {
1373             self.cstore.def_path_hash(def_id)
1374         }
1375     }
1376
1377     pub fn def_path_debug_str(self, def_id: DefId) -> String {
1378         // We are explicitly not going through queries here in order to get
1379         // crate name and disambiguator since this code is called from debug!()
1380         // statements within the query system and we'd run into endless
1381         // recursion otherwise.
1382         let (crate_name, crate_disambiguator) = if def_id.is_local() {
1383             (self.crate_name.clone(),
1384              self.sess.local_crate_disambiguator())
1385         } else {
1386             (self.cstore.crate_name_untracked(def_id.krate),
1387              self.cstore.crate_disambiguator_untracked(def_id.krate))
1388         };
1389
1390         format!("{}[{}]{}",
1391                 crate_name,
1392                 // Don't print the whole crate disambiguator. That's just
1393                 // annoying in debug output.
1394                 &(crate_disambiguator.to_fingerprint().to_hex())[..4],
1395                 self.def_path(def_id).to_string_no_crate())
1396     }
1397
1398     pub fn metadata_encoding_version(self) -> Vec<u8> {
1399         self.cstore.metadata_encoding_version().to_vec()
1400     }
1401
1402     pub fn encode_metadata(self)-> EncodedMetadata {
1403         let _prof_timer = self.prof.generic_activity("generate_crate_metadata");
1404         self.cstore.encode_metadata(self)
1405     }
1406
1407     // Note that this is *untracked* and should only be used within the query
1408     // system if the result is otherwise tracked through queries
1409     pub fn cstore_as_any(self) -> &'tcx dyn Any {
1410         self.cstore.as_any()
1411     }
1412
1413     #[inline(always)]
1414     pub fn create_stable_hashing_context(self) -> StableHashingContext<'tcx> {
1415         let krate = self.gcx.hir_map.forest.untracked_krate();
1416
1417         StableHashingContext::new(self.sess,
1418                                   krate,
1419                                   self.hir().definitions(),
1420                                   &*self.cstore)
1421     }
1422
1423     // This method makes sure that we have a DepNode and a Fingerprint for
1424     // every upstream crate. It needs to be called once right after the tcx is
1425     // created.
1426     // With full-fledged red/green, the method will probably become unnecessary
1427     // as this will be done on-demand.
1428     pub fn allocate_metadata_dep_nodes(self) {
1429         // We cannot use the query versions of crates() and crate_hash(), since
1430         // those would need the DepNodes that we are allocating here.
1431         for cnum in self.cstore.crates_untracked() {
1432             let dep_node = DepNode::new(self, DepConstructor::CrateMetadata(cnum));
1433             let crate_hash = self.cstore.crate_hash_untracked(cnum);
1434             self.dep_graph.with_task(dep_node,
1435                                      self,
1436                                      crate_hash,
1437                                      |_, x| x, // No transformation needed
1438                                      dep_graph::hash_result,
1439             );
1440         }
1441     }
1442
1443     pub fn serialize_query_result_cache<E>(self,
1444                                            encoder: &mut E)
1445                                            -> Result<(), E::Error>
1446         where E: ty::codec::TyEncoder
1447     {
1448         self.queries.on_disk_cache.serialize(self, encoder)
1449     }
1450
1451     /// If `true`, we should use the MIR-based borrowck, but also
1452     /// fall back on the AST borrowck if the MIR-based one errors.
1453     pub fn migrate_borrowck(self) -> bool {
1454         self.borrowck_mode().migrate()
1455     }
1456
1457     /// If `true`, make MIR codegen for `match` emit a temp that holds a
1458     /// borrow of the input to the match expression.
1459     pub fn generate_borrow_of_any_match_input(&self) -> bool {
1460         self.emit_read_for_match()
1461     }
1462
1463     /// If `true`, make MIR codegen for `match` emit FakeRead
1464     /// statements (which simulate the maximal effect of executing the
1465     /// patterns in a match arm).
1466     pub fn emit_read_for_match(&self) -> bool {
1467         !self.sess.opts.debugging_opts.nll_dont_emit_read_for_match
1468     }
1469
1470     /// What mode(s) of borrowck should we run? AST? MIR? both?
1471     /// (Also considers the `#![feature(nll)]` setting.)
1472     pub fn borrowck_mode(&self) -> BorrowckMode {
1473         // Here are the main constraints we need to deal with:
1474         //
1475         // 1. An opts.borrowck_mode of `BorrowckMode::Migrate` is
1476         //    synonymous with no `-Z borrowck=...` flag at all.
1477         //
1478         // 2. We want to allow developers on the Nightly channel
1479         //    to opt back into the "hard error" mode for NLL,
1480         //    (which they can do via specifying `#![feature(nll)]`
1481         //    explicitly in their crate).
1482         //
1483         // So, this precedence list is how pnkfelix chose to work with
1484         // the above constraints:
1485         //
1486         // * `#![feature(nll)]` *always* means use NLL with hard
1487         //   errors. (To simplify the code here, it now even overrides
1488         //   a user's attempt to specify `-Z borrowck=compare`, which
1489         //   we arguably do not need anymore and should remove.)
1490         //
1491         // * Otherwise, if no `-Z borrowck=...` then use migrate mode
1492         //
1493         // * Otherwise, use the behavior requested via `-Z borrowck=...`
1494
1495         if self.features().nll { return BorrowckMode::Mir; }
1496
1497         self.sess.opts.borrowck_mode
1498     }
1499
1500     #[inline]
1501     pub fn local_crate_exports_generics(self) -> bool {
1502         debug_assert!(self.sess.opts.share_generics());
1503
1504         self.sess.crate_types.borrow().iter().any(|crate_type| {
1505             match crate_type {
1506                 CrateType::Executable |
1507                 CrateType::Staticlib  |
1508                 CrateType::ProcMacro  |
1509                 CrateType::Cdylib     => false,
1510
1511                 // FIXME rust-lang/rust#64319, rust-lang/rust#64872:
1512                 // We want to block export of generics from dylibs,
1513                 // but we must fix rust-lang/rust#65890 before we can
1514                 // do that robustly.
1515                 CrateType::Dylib      => true,
1516
1517                 CrateType::Rlib       => true,
1518             }
1519         })
1520     }
1521
1522     // Returns the `DefId` and the `BoundRegion` corresponding to the given region.
1523     pub fn is_suitable_region(&self, region: Region<'tcx>) -> Option<FreeRegionInfo> {
1524         let (suitable_region_binding_scope, bound_region) = match *region {
1525             ty::ReFree(ref free_region) => (free_region.scope, free_region.bound_region),
1526             ty::ReEarlyBound(ref ebr) => (
1527                 self.parent(ebr.def_id).unwrap(),
1528                 ty::BoundRegion::BrNamed(ebr.def_id, ebr.name),
1529             ),
1530             _ => return None, // not a free region
1531         };
1532
1533         let hir_id = self.hir()
1534             .as_local_hir_id(suitable_region_binding_scope)
1535             .unwrap();
1536         let is_impl_item = match self.hir().find(hir_id) {
1537             Some(Node::Item(..)) | Some(Node::TraitItem(..)) => false,
1538             Some(Node::ImplItem(..)) => {
1539                 self.is_bound_region_in_impl_item(suitable_region_binding_scope)
1540             }
1541             _ => return None,
1542         };
1543
1544         return Some(FreeRegionInfo {
1545             def_id: suitable_region_binding_scope,
1546             boundregion: bound_region,
1547             is_impl_item,
1548         });
1549     }
1550
1551     pub fn return_type_impl_trait(
1552         &self,
1553         scope_def_id: DefId,
1554     ) -> Option<(Ty<'tcx>, Span)> {
1555         // HACK: `type_of_def_id()` will fail on these (#55796), so return `None`.
1556         let hir_id = self.hir().as_local_hir_id(scope_def_id).unwrap();
1557         match self.hir().get(hir_id) {
1558             Node::Item(item) => {
1559                 match item.kind {
1560                     ItemKind::Fn(..) => { /* `type_of_def_id()` will work */ }
1561                     _ => {
1562                         return None;
1563                     }
1564                 }
1565             }
1566             _ => { /* `type_of_def_id()` will work or panic */ }
1567         }
1568
1569         let ret_ty = self.type_of(scope_def_id);
1570         match ret_ty.kind {
1571             ty::FnDef(_, _) => {
1572                 let sig = ret_ty.fn_sig(*self);
1573                 let output = self.erase_late_bound_regions(&sig.output());
1574                 if output.is_impl_trait() {
1575                     let fn_decl = self.hir().fn_decl_by_hir_id(hir_id).unwrap();
1576                     Some((output, fn_decl.output.span()))
1577                 } else {
1578                     None
1579                 }
1580             }
1581             _ => None
1582         }
1583     }
1584
1585     // Checks if the bound region is in Impl Item.
1586     pub fn is_bound_region_in_impl_item(
1587         &self,
1588         suitable_region_binding_scope: DefId,
1589     ) -> bool {
1590         let container_id = self.associated_item(suitable_region_binding_scope)
1591             .container
1592             .id();
1593         if self.impl_trait_ref(container_id).is_some() {
1594             // For now, we do not try to target impls of traits. This is
1595             // because this message is going to suggest that the user
1596             // change the fn signature, but they may not be free to do so,
1597             // since the signature must match the trait.
1598             //
1599             // FIXME(#42706) -- in some cases, we could do better here.
1600             return true;
1601         }
1602         false
1603     }
1604
1605     /// Determines whether identifiers in the assembly have strict naming rules.
1606     /// Currently, only NVPTX* targets need it.
1607     pub fn has_strict_asm_symbol_naming(&self) -> bool {
1608         self.sess.target.target.arch.contains("nvptx")
1609     }
1610
1611     /// Returns `&'static core::panic::Location<'static>`.
1612     pub fn caller_location_ty(&self) -> Ty<'tcx> {
1613         self.mk_imm_ref(
1614             self.lifetimes.re_static,
1615             self.type_of(self.require_lang_item(PanicLocationLangItem, None))
1616                 .subst(*self, self.mk_substs([self.lifetimes.re_static.into()].iter())),
1617         )
1618     }
1619 }
1620
1621 impl<'tcx> GlobalCtxt<'tcx> {
1622     /// Calls the closure with a local `TyCtxt` using the given arena.
1623     /// `interners` is a slot passed so we can create a CtxtInterners
1624     /// with the same lifetime as `arena`.
1625     pub fn enter_local<F, R>(&'tcx self, f: F) -> R
1626     where
1627         F: FnOnce(TyCtxt<'tcx>) -> R,
1628     {
1629         let tcx = TyCtxt {
1630             gcx: self,
1631         };
1632         ty::tls::with_related_context(tcx, |icx| {
1633             let new_icx = ty::tls::ImplicitCtxt {
1634                 tcx,
1635                 query: icx.query.clone(),
1636                 diagnostics: icx.diagnostics,
1637                 layout_depth: icx.layout_depth,
1638                 task_deps: icx.task_deps,
1639             };
1640             ty::tls::enter_context(&new_icx, |_| {
1641                 f(tcx)
1642             })
1643         })
1644     }
1645 }
1646
1647 /// A trait implemented for all `X<'a>` types that can be safely and
1648 /// efficiently converted to `X<'tcx>` as long as they are part of the
1649 /// provided `TyCtxt<'tcx>`.
1650 /// This can be done, for example, for `Ty<'tcx>` or `SubstsRef<'tcx>`
1651 /// by looking them up in their respective interners.
1652 ///
1653 /// However, this is still not the best implementation as it does
1654 /// need to compare the components, even for interned values.
1655 /// It would be more efficient if `TypedArena` provided a way to
1656 /// determine whether the address is in the allocated range.
1657 ///
1658 /// `None` is returned if the value or one of the components is not part
1659 /// of the provided context.
1660 /// For `Ty`, `None` can be returned if either the type interner doesn't
1661 /// contain the `TyKind` key or if the address of the interned
1662 /// pointer differs. The latter case is possible if a primitive type,
1663 /// e.g., `()` or `u8`, was interned in a different context.
1664 pub trait Lift<'tcx>: fmt::Debug {
1665     type Lifted: fmt::Debug + 'tcx;
1666     fn lift_to_tcx(&self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted>;
1667 }
1668
1669 macro_rules! nop_lift {
1670     ($ty:ty => $lifted:ty) => {
1671         impl<'a, 'tcx> Lift<'tcx> for $ty {
1672                     type Lifted = $lifted;
1673                     fn lift_to_tcx(&self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted> {
1674                         if tcx.interners.arena.in_arena(*self as *const _) {
1675                             Some(unsafe { mem::transmute(*self) })
1676                         } else {
1677                             None
1678                         }
1679                     }
1680                 }
1681     };
1682 }
1683
1684 macro_rules! nop_list_lift {
1685     ($ty:ty => $lifted:ty) => {
1686         impl<'a, 'tcx> Lift<'tcx> for &'a List<$ty> {
1687                     type Lifted = &'tcx List<$lifted>;
1688                     fn lift_to_tcx(&self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted> {
1689                         if self.is_empty() {
1690                             return Some(List::empty());
1691                         }
1692                         if tcx.interners.arena.in_arena(*self as *const _) {
1693                             Some(unsafe { mem::transmute(*self) })
1694                         } else {
1695                             None
1696                         }
1697                     }
1698                 }
1699     };
1700 }
1701
1702 nop_lift!{Ty<'a> => Ty<'tcx>}
1703 nop_lift!{Region<'a> => Region<'tcx>}
1704 nop_lift!{Goal<'a> => Goal<'tcx>}
1705 nop_lift!{&'a Const<'a> => &'tcx Const<'tcx>}
1706
1707 nop_list_lift!{Goal<'a> => Goal<'tcx>}
1708 nop_list_lift!{Clause<'a> => Clause<'tcx>}
1709 nop_list_lift!{Ty<'a> => Ty<'tcx>}
1710 nop_list_lift!{ExistentialPredicate<'a> => ExistentialPredicate<'tcx>}
1711 nop_list_lift!{Predicate<'a> => Predicate<'tcx>}
1712 nop_list_lift!{CanonicalVarInfo => CanonicalVarInfo}
1713 nop_list_lift!{ProjectionKind => ProjectionKind}
1714
1715 // This is the impl for `&'a InternalSubsts<'a>`.
1716 nop_list_lift!{GenericArg<'a> => GenericArg<'tcx>}
1717
1718 pub mod tls {
1719     use super::{GlobalCtxt, TyCtxt, ptr_eq};
1720
1721     use std::fmt;
1722     use std::mem;
1723     use syntax_pos;
1724     use crate::ty::query;
1725     use errors::{Diagnostic, TRACK_DIAGNOSTICS};
1726     use rustc_data_structures::OnDrop;
1727     use rustc_data_structures::sync::{self, Lrc, Lock};
1728     use rustc_data_structures::thin_vec::ThinVec;
1729     use crate::dep_graph::TaskDeps;
1730
1731     #[cfg(not(parallel_compiler))]
1732     use std::cell::Cell;
1733
1734     #[cfg(parallel_compiler)]
1735     use rustc_rayon_core as rayon_core;
1736
1737     /// This is the implicit state of rustc. It contains the current
1738     /// `TyCtxt` and query. It is updated when creating a local interner or
1739     /// executing a new query. Whenever there's a `TyCtxt` value available
1740     /// you should also have access to an `ImplicitCtxt` through the functions
1741     /// in this module.
1742     #[derive(Clone)]
1743     pub struct ImplicitCtxt<'a, 'tcx> {
1744         /// The current `TyCtxt`. Initially created by `enter_global` and updated
1745         /// by `enter_local` with a new local interner.
1746         pub tcx: TyCtxt<'tcx>,
1747
1748         /// The current query job, if any. This is updated by `JobOwner::start` in
1749         /// `ty::query::plumbing` when executing a query.
1750         pub query: Option<Lrc<query::QueryJob<'tcx>>>,
1751
1752         /// Where to store diagnostics for the current query job, if any.
1753         /// This is updated by `JobOwner::start` in `ty::query::plumbing` when executing a query.
1754         pub diagnostics: Option<&'a Lock<ThinVec<Diagnostic>>>,
1755
1756         /// Used to prevent layout from recursing too deeply.
1757         pub layout_depth: usize,
1758
1759         /// The current dep graph task. This is used to add dependencies to queries
1760         /// when executing them.
1761         pub task_deps: Option<&'a Lock<TaskDeps>>,
1762     }
1763
1764     /// Sets Rayon's thread-local variable, which is preserved for Rayon jobs
1765     /// to `value` during the call to `f`. It is restored to its previous value after.
1766     /// This is used to set the pointer to the new `ImplicitCtxt`.
1767     #[cfg(parallel_compiler)]
1768     #[inline]
1769     fn set_tlv<F: FnOnce() -> R, R>(value: usize, f: F) -> R {
1770         rayon_core::tlv::with(value, f)
1771     }
1772
1773     /// Gets Rayon's thread-local variable, which is preserved for Rayon jobs.
1774     /// This is used to get the pointer to the current `ImplicitCtxt`.
1775     #[cfg(parallel_compiler)]
1776     #[inline]
1777     fn get_tlv() -> usize {
1778         rayon_core::tlv::get()
1779     }
1780
1781     #[cfg(not(parallel_compiler))]
1782     thread_local! {
1783         /// A thread local variable that stores a pointer to the current `ImplicitCtxt`.
1784         static TLV: Cell<usize> = Cell::new(0);
1785     }
1786
1787     /// Sets TLV to `value` during the call to `f`.
1788     /// It is restored to its previous value after.
1789     /// This is used to set the pointer to the new `ImplicitCtxt`.
1790     #[cfg(not(parallel_compiler))]
1791     #[inline]
1792     fn set_tlv<F: FnOnce() -> R, R>(value: usize, f: F) -> R {
1793         let old = get_tlv();
1794         let _reset = OnDrop(move || TLV.with(|tlv| tlv.set(old)));
1795         TLV.with(|tlv| tlv.set(value));
1796         f()
1797     }
1798
1799     /// Gets the pointer to the current `ImplicitCtxt`.
1800     #[cfg(not(parallel_compiler))]
1801     fn get_tlv() -> usize {
1802         TLV.with(|tlv| tlv.get())
1803     }
1804
1805     /// This is a callback from libsyntax as it cannot access the implicit state
1806     /// in librustc otherwise.
1807     fn span_debug(span: syntax_pos::Span, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1808         with_opt(|tcx| {
1809             if let Some(tcx) = tcx {
1810                 write!(f, "{}", tcx.sess.source_map().span_to_string(span))
1811             } else {
1812                 syntax_pos::default_span_debug(span, f)
1813             }
1814         })
1815     }
1816
1817     /// This is a callback from libsyntax as it cannot access the implicit state
1818     /// in librustc otherwise. It is used to when diagnostic messages are
1819     /// emitted and stores them in the current query, if there is one.
1820     fn track_diagnostic(diagnostic: &Diagnostic) {
1821         with_context_opt(|icx| {
1822             if let Some(icx) = icx {
1823                 if let Some(ref diagnostics) = icx.diagnostics {
1824                     let mut diagnostics = diagnostics.lock();
1825                     diagnostics.extend(Some(diagnostic.clone()));
1826                 }
1827             }
1828         })
1829     }
1830
1831     /// Sets up the callbacks from libsyntax on the current thread.
1832     pub fn with_thread_locals<F, R>(f: F) -> R
1833         where F: FnOnce() -> R
1834     {
1835         syntax_pos::SPAN_DEBUG.with(|span_dbg| {
1836             let original_span_debug = span_dbg.get();
1837             span_dbg.set(span_debug);
1838
1839             let _on_drop = OnDrop(move || {
1840                 span_dbg.set(original_span_debug);
1841             });
1842
1843             TRACK_DIAGNOSTICS.with(|current| {
1844                 let original = current.get();
1845                 current.set(track_diagnostic);
1846
1847                 let _on_drop = OnDrop(move || {
1848                     current.set(original);
1849                 });
1850
1851                 f()
1852             })
1853         })
1854     }
1855
1856     /// Sets `context` as the new current `ImplicitCtxt` for the duration of the function `f`.
1857     #[inline]
1858     pub fn enter_context<'a, 'tcx, F, R>(context: &ImplicitCtxt<'a, 'tcx>, f: F) -> R
1859     where
1860         F: FnOnce(&ImplicitCtxt<'a, 'tcx>) -> R,
1861     {
1862         set_tlv(context as *const _ as usize, || {
1863             f(&context)
1864         })
1865     }
1866
1867     /// Enters `GlobalCtxt` by setting up libsyntax callbacks and
1868     /// creating a initial `TyCtxt` and `ImplicitCtxt`.
1869     /// This happens once per rustc session and `TyCtxt`s only exists
1870     /// inside the `f` function.
1871     pub fn enter_global<'tcx, F, R>(gcx: &'tcx GlobalCtxt<'tcx>, f: F) -> R
1872     where
1873         F: FnOnce(TyCtxt<'tcx>) -> R,
1874     {
1875         // Update `GCX_PTR` to indicate there's a `GlobalCtxt` available.
1876         GCX_PTR.with(|lock| {
1877             *lock.lock() = gcx as *const _ as usize;
1878         });
1879         // Set `GCX_PTR` back to 0 when we exit.
1880         let _on_drop = OnDrop(move || {
1881             GCX_PTR.with(|lock| *lock.lock() = 0);
1882         });
1883
1884         let tcx = TyCtxt {
1885             gcx,
1886         };
1887         let icx = ImplicitCtxt {
1888             tcx,
1889             query: None,
1890             diagnostics: None,
1891             layout_depth: 0,
1892             task_deps: None,
1893         };
1894         enter_context(&icx, |_| {
1895             f(tcx)
1896         })
1897     }
1898
1899     scoped_thread_local! {
1900         /// Stores a pointer to the `GlobalCtxt` if one is available.
1901         /// This is used to access the `GlobalCtxt` in the deadlock handler given to Rayon.
1902         pub static GCX_PTR: Lock<usize>
1903     }
1904
1905     /// Creates a `TyCtxt` and `ImplicitCtxt` based on the `GCX_PTR` thread local.
1906     /// This is used in the deadlock handler.
1907     pub unsafe fn with_global<F, R>(f: F) -> R
1908     where
1909         F: for<'tcx> FnOnce(TyCtxt<'tcx>) -> R,
1910     {
1911         let gcx = GCX_PTR.with(|lock| *lock.lock());
1912         assert!(gcx != 0);
1913         let gcx = &*(gcx as *const GlobalCtxt<'_>);
1914         let tcx = TyCtxt {
1915             gcx,
1916         };
1917         let icx = ImplicitCtxt {
1918             query: None,
1919             diagnostics: None,
1920             tcx,
1921             layout_depth: 0,
1922             task_deps: None,
1923         };
1924         enter_context(&icx, |_| f(tcx))
1925     }
1926
1927     /// Allows access to the current `ImplicitCtxt` in a closure if one is available.
1928     #[inline]
1929     pub fn with_context_opt<F, R>(f: F) -> R
1930     where
1931         F: for<'a, 'tcx> FnOnce(Option<&ImplicitCtxt<'a, 'tcx>>) -> R,
1932     {
1933         let context = get_tlv();
1934         if context == 0 {
1935             f(None)
1936         } else {
1937             // We could get a `ImplicitCtxt` pointer from another thread.
1938             // Ensure that `ImplicitCtxt` is `Sync`.
1939             sync::assert_sync::<ImplicitCtxt<'_, '_>>();
1940
1941             unsafe { f(Some(&*(context as *const ImplicitCtxt<'_, '_>))) }
1942         }
1943     }
1944
1945     /// Allows access to the current `ImplicitCtxt`.
1946     /// Panics if there is no `ImplicitCtxt` available.
1947     #[inline]
1948     pub fn with_context<F, R>(f: F) -> R
1949     where
1950         F: for<'a, 'tcx> FnOnce(&ImplicitCtxt<'a, 'tcx>) -> R,
1951     {
1952         with_context_opt(|opt_context| f(opt_context.expect("no ImplicitCtxt stored in tls")))
1953     }
1954
1955     /// Allows access to the current `ImplicitCtxt` whose tcx field has the same global
1956     /// interner as the tcx argument passed in. This means the closure is given an `ImplicitCtxt`
1957     /// with the same `'tcx` lifetime as the `TyCtxt` passed in.
1958     /// This will panic if you pass it a `TyCtxt` which has a different global interner from
1959     /// the current `ImplicitCtxt`'s `tcx` field.
1960     #[inline]
1961     pub fn with_related_context<'tcx, F, R>(tcx: TyCtxt<'tcx>, f: F) -> R
1962     where
1963         F: FnOnce(&ImplicitCtxt<'_, 'tcx>) -> R,
1964     {
1965         with_context(|context| {
1966             unsafe {
1967                 assert!(ptr_eq(context.tcx.gcx, tcx.gcx));
1968                 let context: &ImplicitCtxt<'_, '_> = mem::transmute(context);
1969                 f(context)
1970             }
1971         })
1972     }
1973
1974     /// Allows access to the `TyCtxt` in the current `ImplicitCtxt`.
1975     /// Panics if there is no `ImplicitCtxt` available.
1976     #[inline]
1977     pub fn with<F, R>(f: F) -> R
1978     where
1979         F: for<'tcx> FnOnce(TyCtxt<'tcx>) -> R,
1980     {
1981         with_context(|context| f(context.tcx))
1982     }
1983
1984     /// Allows access to the `TyCtxt` in the current `ImplicitCtxt`.
1985     /// The closure is passed None if there is no `ImplicitCtxt` available.
1986     #[inline]
1987     pub fn with_opt<F, R>(f: F) -> R
1988     where
1989         F: for<'tcx> FnOnce(Option<TyCtxt<'tcx>>) -> R,
1990     {
1991         with_context_opt(|opt_context| f(opt_context.map(|context| context.tcx)))
1992     }
1993 }
1994
1995 macro_rules! sty_debug_print {
1996     ($ctxt: expr, $($variant: ident),*) => {{
1997         // Curious inner module to allow variant names to be used as
1998         // variable names.
1999         #[allow(non_snake_case)]
2000         mod inner {
2001             use crate::ty::{self, TyCtxt};
2002             use crate::ty::context::Interned;
2003
2004             #[derive(Copy, Clone)]
2005             struct DebugStat {
2006                 total: usize,
2007                 lt_infer: usize,
2008                 ty_infer: usize,
2009                 ct_infer: usize,
2010                 all_infer: usize,
2011             }
2012
2013             pub fn go(tcx: TyCtxt<'_>) {
2014                 let mut total = DebugStat {
2015                     total: 0,
2016                     lt_infer: 0,
2017                     ty_infer: 0,
2018                     ct_infer: 0,
2019                     all_infer: 0,
2020                 };
2021                 $(let mut $variant = total;)*
2022
2023                 let shards = tcx.interners.type_.lock_shards();
2024                 let types = shards.iter().flat_map(|shard| shard.keys());
2025                 for &Interned(t) in types {
2026                     let variant = match t.kind {
2027                         ty::Bool | ty::Char | ty::Int(..) | ty::Uint(..) |
2028                             ty::Float(..) | ty::Str | ty::Never => continue,
2029                         ty::Error => /* unimportant */ continue,
2030                         $(ty::$variant(..) => &mut $variant,)*
2031                     };
2032                     let lt = t.flags.intersects(ty::TypeFlags::HAS_RE_INFER);
2033                     let ty = t.flags.intersects(ty::TypeFlags::HAS_TY_INFER);
2034                     let ct = t.flags.intersects(ty::TypeFlags::HAS_CT_INFER);
2035
2036                     variant.total += 1;
2037                     total.total += 1;
2038                     if lt { total.lt_infer += 1; variant.lt_infer += 1 }
2039                     if ty { total.ty_infer += 1; variant.ty_infer += 1 }
2040                     if ct { total.ct_infer += 1; variant.ct_infer += 1 }
2041                     if lt && ty && ct { total.all_infer += 1; variant.all_infer += 1 }
2042                 }
2043                 println!("Ty interner             total           ty lt ct all");
2044                 $(println!("    {:18}: {uses:6} {usespc:4.1}%, \
2045                             {ty:4.1}% {lt:5.1}% {ct:4.1}% {all:4.1}%",
2046                     stringify!($variant),
2047                     uses = $variant.total,
2048                     usespc = $variant.total as f64 * 100.0 / total.total as f64,
2049                     ty = $variant.ty_infer as f64 * 100.0  / total.total as f64,
2050                     lt = $variant.lt_infer as f64 * 100.0  / total.total as f64,
2051                     ct = $variant.ct_infer as f64 * 100.0  / total.total as f64,
2052                     all = $variant.all_infer as f64 * 100.0  / total.total as f64);
2053                 )*
2054                 println!("                  total {uses:6}        \
2055                           {ty:4.1}% {lt:5.1}% {ct:4.1}% {all:4.1}%",
2056                     uses = total.total,
2057                     ty = total.ty_infer as f64 * 100.0  / total.total as f64,
2058                     lt = total.lt_infer as f64 * 100.0  / total.total as f64,
2059                     ct = total.ct_infer as f64 * 100.0  / total.total as f64,
2060                     all = total.all_infer as f64 * 100.0  / total.total as f64)
2061             }
2062         }
2063
2064         inner::go($ctxt)
2065     }}
2066 }
2067
2068 impl<'tcx> TyCtxt<'tcx> {
2069     pub fn print_debug_stats(self) {
2070         sty_debug_print!(
2071             self,
2072             Adt, Array, Slice, RawPtr, Ref, FnDef, FnPtr, Placeholder,
2073             Generator, GeneratorWitness, Dynamic, Closure, Tuple, Bound,
2074             Param, Infer, UnnormalizedProjection, Projection, Opaque, Foreign);
2075
2076         println!("InternalSubsts interner: #{}", self.interners.substs.len());
2077         println!("Region interner: #{}", self.interners.region.len());
2078         println!("Stability interner: #{}", self.stability_interner.len());
2079         println!("Const Stability interner: #{}", self.const_stability_interner.len());
2080         println!("Allocation interner: #{}", self.allocation_interner.len());
2081         println!("Layout interner: #{}", self.layout_interner.len());
2082     }
2083 }
2084
2085
2086 /// An entry in an interner.
2087 struct Interned<'tcx, T: ?Sized>(&'tcx T);
2088
2089 impl<'tcx, T: 'tcx+?Sized> Clone for Interned<'tcx, T> {
2090     fn clone(&self) -> Self {
2091         Interned(self.0)
2092     }
2093 }
2094 impl<'tcx, T: 'tcx+?Sized> Copy for Interned<'tcx, T> {}
2095
2096 // N.B., an `Interned<Ty>` compares and hashes as a `TyKind`.
2097 impl<'tcx> PartialEq for Interned<'tcx, TyS<'tcx>> {
2098     fn eq(&self, other: &Interned<'tcx, TyS<'tcx>>) -> bool {
2099         self.0.kind == other.0.kind
2100     }
2101 }
2102
2103 impl<'tcx> Eq for Interned<'tcx, TyS<'tcx>> {}
2104
2105 impl<'tcx> Hash for Interned<'tcx, TyS<'tcx>> {
2106     fn hash<H: Hasher>(&self, s: &mut H) {
2107         self.0.kind.hash(s)
2108     }
2109 }
2110
2111 #[allow(rustc::usage_of_ty_tykind)]
2112 impl<'tcx> Borrow<TyKind<'tcx>> for Interned<'tcx, TyS<'tcx>> {
2113     fn borrow<'a>(&'a self) -> &'a TyKind<'tcx> {
2114         &self.0.kind
2115     }
2116 }
2117
2118 // N.B., an `Interned<List<T>>` compares and hashes as its elements.
2119 impl<'tcx, T: PartialEq> PartialEq for Interned<'tcx, List<T>> {
2120     fn eq(&self, other: &Interned<'tcx, List<T>>) -> bool {
2121         self.0[..] == other.0[..]
2122     }
2123 }
2124
2125 impl<'tcx, T: Eq> Eq for Interned<'tcx, List<T>> {}
2126
2127 impl<'tcx, T: Hash> Hash for Interned<'tcx, List<T>> {
2128     fn hash<H: Hasher>(&self, s: &mut H) {
2129         self.0[..].hash(s)
2130     }
2131 }
2132
2133 impl<'tcx> Borrow<[Ty<'tcx>]> for Interned<'tcx, List<Ty<'tcx>>> {
2134     fn borrow<'a>(&'a self) -> &'a [Ty<'tcx>] {
2135         &self.0[..]
2136     }
2137 }
2138
2139 impl<'tcx> Borrow<[CanonicalVarInfo]> for Interned<'tcx, List<CanonicalVarInfo>> {
2140     fn borrow(&self) -> &[CanonicalVarInfo] {
2141         &self.0[..]
2142     }
2143 }
2144
2145 impl<'tcx> Borrow<[GenericArg<'tcx>]> for Interned<'tcx, InternalSubsts<'tcx>> {
2146     fn borrow<'a>(&'a self) -> &'a [GenericArg<'tcx>] {
2147         &self.0[..]
2148     }
2149 }
2150
2151 impl<'tcx> Borrow<[ProjectionKind]>
2152     for Interned<'tcx, List<ProjectionKind>> {
2153     fn borrow(&self) -> &[ProjectionKind] {
2154         &self.0[..]
2155     }
2156 }
2157
2158 impl<'tcx> Borrow<[PlaceElem<'tcx>]>
2159     for Interned<'tcx, List<PlaceElem<'tcx>>> {
2160     fn borrow(&self) -> &[PlaceElem<'tcx>] {
2161         &self.0[..]
2162     }
2163 }
2164
2165 impl<'tcx> Borrow<RegionKind> for Interned<'tcx, RegionKind> {
2166     fn borrow(&self) -> &RegionKind {
2167         &self.0
2168     }
2169 }
2170
2171 impl<'tcx> Borrow<GoalKind<'tcx>> for Interned<'tcx, GoalKind<'tcx>> {
2172     fn borrow<'a>(&'a self) -> &'a GoalKind<'tcx> {
2173         &self.0
2174     }
2175 }
2176
2177 impl<'tcx> Borrow<[ExistentialPredicate<'tcx>]>
2178     for Interned<'tcx, List<ExistentialPredicate<'tcx>>>
2179 {
2180     fn borrow<'a>(&'a self) -> &'a [ExistentialPredicate<'tcx>] {
2181         &self.0[..]
2182     }
2183 }
2184
2185 impl<'tcx> Borrow<[Predicate<'tcx>]> for Interned<'tcx, List<Predicate<'tcx>>> {
2186     fn borrow<'a>(&'a self) -> &'a [Predicate<'tcx>] {
2187         &self.0[..]
2188     }
2189 }
2190
2191 impl<'tcx> Borrow<Const<'tcx>> for Interned<'tcx, Const<'tcx>> {
2192     fn borrow<'a>(&'a self) -> &'a Const<'tcx> {
2193         &self.0
2194     }
2195 }
2196
2197 impl<'tcx> Borrow<[Clause<'tcx>]> for Interned<'tcx, List<Clause<'tcx>>> {
2198     fn borrow<'a>(&'a self) -> &'a [Clause<'tcx>] {
2199         &self.0[..]
2200     }
2201 }
2202
2203 impl<'tcx> Borrow<[Goal<'tcx>]> for Interned<'tcx, List<Goal<'tcx>>> {
2204     fn borrow<'a>(&'a self) -> &'a [Goal<'tcx>] {
2205         &self.0[..]
2206     }
2207 }
2208
2209 macro_rules! direct_interners {
2210     ($($name:ident: $method:ident($ty:ty)),+) => {
2211         $(impl<'tcx> PartialEq for Interned<'tcx, $ty> {
2212             fn eq(&self, other: &Self) -> bool {
2213                 self.0 == other.0
2214             }
2215         }
2216
2217         impl<'tcx> Eq for Interned<'tcx, $ty> {}
2218
2219         impl<'tcx> Hash for Interned<'tcx, $ty> {
2220             fn hash<H: Hasher>(&self, s: &mut H) {
2221                 self.0.hash(s)
2222             }
2223         }
2224
2225         impl<'tcx> TyCtxt<'tcx> {
2226             pub fn $method(self, v: $ty) -> &'tcx $ty {
2227                 self.interners.$name.intern_ref(&v, || {
2228                     Interned(self.interners.arena.alloc(v))
2229                 }).0
2230             }
2231         })+
2232     }
2233 }
2234
2235 pub fn keep_local<'tcx, T: ty::TypeFoldable<'tcx>>(x: &T) -> bool {
2236     x.has_type_flags(ty::TypeFlags::KEEP_IN_LOCAL_TCX)
2237 }
2238
2239 direct_interners!(
2240     region: mk_region(RegionKind),
2241     goal: mk_goal(GoalKind<'tcx>),
2242     const_: mk_const(Const<'tcx>)
2243 );
2244
2245 macro_rules! slice_interners {
2246     ($($field:ident: $method:ident($ty:ty)),+) => (
2247         $(impl<'tcx> TyCtxt<'tcx> {
2248             pub fn $method(self, v: &[$ty]) -> &'tcx List<$ty> {
2249                 self.interners.$field.intern_ref(v, || {
2250                     Interned(List::from_arena(&self.interners.arena, v))
2251                 }).0
2252             }
2253         })+
2254     );
2255 }
2256
2257 slice_interners!(
2258     type_list: _intern_type_list(Ty<'tcx>),
2259     substs: _intern_substs(GenericArg<'tcx>),
2260     canonical_var_infos: _intern_canonical_var_infos(CanonicalVarInfo),
2261     existential_predicates: _intern_existential_predicates(ExistentialPredicate<'tcx>),
2262     predicates: _intern_predicates(Predicate<'tcx>),
2263     clauses: _intern_clauses(Clause<'tcx>),
2264     goal_list: _intern_goals(Goal<'tcx>),
2265     projs: _intern_projs(ProjectionKind),
2266     place_elems: _intern_place_elems(PlaceElem<'tcx>)
2267 );
2268
2269 impl<'tcx> TyCtxt<'tcx> {
2270     /// Given a `fn` type, returns an equivalent `unsafe fn` type;
2271     /// that is, a `fn` type that is equivalent in every way for being
2272     /// unsafe.
2273     pub fn safe_to_unsafe_fn_ty(self, sig: PolyFnSig<'tcx>) -> Ty<'tcx> {
2274         assert_eq!(sig.unsafety(), hir::Unsafety::Normal);
2275         self.mk_fn_ptr(sig.map_bound(|sig| ty::FnSig {
2276             unsafety: hir::Unsafety::Unsafe,
2277             ..sig
2278         }))
2279     }
2280
2281     /// Given a closure signature `sig`, returns an equivalent `fn`
2282     /// type with the same signature. Detuples and so forth -- so
2283     /// e.g., if we have a sig with `Fn<(u32, i32)>` then you would get
2284     /// a `fn(u32, i32)`.
2285     /// `unsafety` determines the unsafety of the `fn` type. If you pass
2286     /// `hir::Unsafety::Unsafe` in the previous example, then you would get
2287     /// an `unsafe fn (u32, i32)`.
2288     /// It cannot convert a closure that requires unsafe.
2289     pub fn coerce_closure_fn_ty(self, sig: PolyFnSig<'tcx>, unsafety: hir::Unsafety) -> Ty<'tcx> {
2290         let converted_sig = sig.map_bound(|s| {
2291             let params_iter = match s.inputs()[0].kind {
2292                 ty::Tuple(params) => {
2293                     params.into_iter().map(|k| k.expect_ty())
2294                 }
2295                 _ => bug!(),
2296             };
2297             self.mk_fn_sig(
2298                 params_iter,
2299                 s.output(),
2300                 s.c_variadic,
2301                 unsafety,
2302                 abi::Abi::Rust,
2303             )
2304         });
2305
2306         self.mk_fn_ptr(converted_sig)
2307     }
2308
2309     #[allow(rustc::usage_of_ty_tykind)]
2310     #[inline]
2311     pub fn mk_ty(&self, st: TyKind<'tcx>) -> Ty<'tcx> {
2312         self.interners.intern_ty(st)
2313     }
2314
2315     pub fn mk_mach_int(self, tm: ast::IntTy) -> Ty<'tcx> {
2316         match tm {
2317             ast::IntTy::Isize   => self.types.isize,
2318             ast::IntTy::I8   => self.types.i8,
2319             ast::IntTy::I16  => self.types.i16,
2320             ast::IntTy::I32  => self.types.i32,
2321             ast::IntTy::I64  => self.types.i64,
2322             ast::IntTy::I128  => self.types.i128,
2323         }
2324     }
2325
2326     pub fn mk_mach_uint(self, tm: ast::UintTy) -> Ty<'tcx> {
2327         match tm {
2328             ast::UintTy::Usize   => self.types.usize,
2329             ast::UintTy::U8   => self.types.u8,
2330             ast::UintTy::U16  => self.types.u16,
2331             ast::UintTy::U32  => self.types.u32,
2332             ast::UintTy::U64  => self.types.u64,
2333             ast::UintTy::U128  => self.types.u128,
2334         }
2335     }
2336
2337     pub fn mk_mach_float(self, tm: ast::FloatTy) -> Ty<'tcx> {
2338         match tm {
2339             ast::FloatTy::F32  => self.types.f32,
2340             ast::FloatTy::F64  => self.types.f64,
2341         }
2342     }
2343
2344     #[inline]
2345     pub fn mk_str(self) -> Ty<'tcx> {
2346         self.mk_ty(Str)
2347     }
2348
2349     #[inline]
2350     pub fn mk_static_str(self) -> Ty<'tcx> {
2351         self.mk_imm_ref(self.lifetimes.re_static, self.mk_str())
2352     }
2353
2354     #[inline]
2355     pub fn mk_adt(self, def: &'tcx AdtDef, substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2356         // Take a copy of substs so that we own the vectors inside.
2357         self.mk_ty(Adt(def, substs))
2358     }
2359
2360     #[inline]
2361     pub fn mk_foreign(self, def_id: DefId) -> Ty<'tcx> {
2362         self.mk_ty(Foreign(def_id))
2363     }
2364
2365     fn mk_generic_adt(self, wrapper_def_id: DefId, ty_param: Ty<'tcx>) -> Ty<'tcx> {
2366         let adt_def = self.adt_def(wrapper_def_id);
2367         let substs = InternalSubsts::for_item(self, wrapper_def_id, |param, substs| {
2368             match param.kind {
2369                 GenericParamDefKind::Lifetime |
2370                 GenericParamDefKind::Const => {
2371                     bug!()
2372                 }
2373                 GenericParamDefKind::Type { has_default, .. } => {
2374                     if param.index == 0 {
2375                         ty_param.into()
2376                     } else {
2377                         assert!(has_default);
2378                         self.type_of(param.def_id).subst(self, substs).into()
2379                     }
2380                 }
2381             }
2382         });
2383         self.mk_ty(Adt(adt_def, substs))
2384     }
2385
2386     #[inline]
2387     pub fn mk_box(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2388         let def_id = self.require_lang_item(lang_items::OwnedBoxLangItem, None);
2389         self.mk_generic_adt(def_id, ty)
2390     }
2391
2392     #[inline]
2393     pub fn mk_lang_item(self, ty: Ty<'tcx>, item: lang_items::LangItem)  -> Option<Ty<'tcx>> {
2394         let def_id = self.lang_items().require(item).ok()?;
2395         Some(self.mk_generic_adt(def_id, ty))
2396     }
2397
2398     #[inline]
2399     pub fn mk_maybe_uninit(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2400         let def_id = self.require_lang_item(lang_items::MaybeUninitLangItem, None);
2401         self.mk_generic_adt(def_id, ty)
2402     }
2403
2404     #[inline]
2405     pub fn mk_ptr(self, tm: TypeAndMut<'tcx>) -> Ty<'tcx> {
2406         self.mk_ty(RawPtr(tm))
2407     }
2408
2409     #[inline]
2410     pub fn mk_ref(self, r: Region<'tcx>, tm: TypeAndMut<'tcx>) -> Ty<'tcx> {
2411         self.mk_ty(Ref(r, tm.ty, tm.mutbl))
2412     }
2413
2414     #[inline]
2415     pub fn mk_mut_ref(self, r: Region<'tcx>, ty: Ty<'tcx>) -> Ty<'tcx> {
2416         self.mk_ref(r, TypeAndMut {ty: ty, mutbl: hir::Mutability::Mut })
2417     }
2418
2419     #[inline]
2420     pub fn mk_imm_ref(self, r: Region<'tcx>, ty: Ty<'tcx>) -> Ty<'tcx> {
2421         self.mk_ref(r, TypeAndMut {ty: ty, mutbl: hir::Mutability::Not })
2422     }
2423
2424     #[inline]
2425     pub fn mk_mut_ptr(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2426         self.mk_ptr(TypeAndMut {ty: ty, mutbl: hir::Mutability::Mut })
2427     }
2428
2429     #[inline]
2430     pub fn mk_imm_ptr(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2431         self.mk_ptr(TypeAndMut {ty: ty, mutbl: hir::Mutability::Not })
2432     }
2433
2434     #[inline]
2435     pub fn mk_nil_ptr(self) -> Ty<'tcx> {
2436         self.mk_imm_ptr(self.mk_unit())
2437     }
2438
2439     #[inline]
2440     pub fn mk_array(self, ty: Ty<'tcx>, n: u64) -> Ty<'tcx> {
2441         self.mk_ty(Array(ty, ty::Const::from_usize(self, n)))
2442     }
2443
2444     #[inline]
2445     pub fn mk_slice(self, ty: Ty<'tcx>) -> Ty<'tcx> {
2446         self.mk_ty(Slice(ty))
2447     }
2448
2449     #[inline]
2450     pub fn intern_tup(self, ts: &[Ty<'tcx>]) -> Ty<'tcx> {
2451         let kinds: Vec<_> = ts.into_iter().map(|&t| GenericArg::from(t)).collect();
2452         self.mk_ty(Tuple(self.intern_substs(&kinds)))
2453     }
2454
2455     pub fn mk_tup<I: InternAs<[Ty<'tcx>], Ty<'tcx>>>(self, iter: I) -> I::Output {
2456         iter.intern_with(|ts| {
2457             let kinds: Vec<_> = ts.into_iter().map(|&t| GenericArg::from(t)).collect();
2458             self.mk_ty(Tuple(self.intern_substs(&kinds)))
2459         })
2460     }
2461
2462     #[inline]
2463     pub fn mk_unit(self) -> Ty<'tcx> {
2464         self.types.unit
2465     }
2466
2467     #[inline]
2468     pub fn mk_diverging_default(self) -> Ty<'tcx> {
2469         if self.features().never_type_fallback {
2470             self.types.never
2471         } else {
2472             self.types.unit
2473         }
2474     }
2475
2476     #[inline]
2477     pub fn mk_bool(self) -> Ty<'tcx> {
2478         self.mk_ty(Bool)
2479     }
2480
2481     #[inline]
2482     pub fn mk_fn_def(self, def_id: DefId,
2483                      substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2484         self.mk_ty(FnDef(def_id, substs))
2485     }
2486
2487     #[inline]
2488     pub fn mk_fn_ptr(self, fty: PolyFnSig<'tcx>) -> Ty<'tcx> {
2489         self.mk_ty(FnPtr(fty))
2490     }
2491
2492     #[inline]
2493     pub fn mk_dynamic(
2494         self,
2495         obj: ty::Binder<&'tcx List<ExistentialPredicate<'tcx>>>,
2496         reg: ty::Region<'tcx>
2497     ) -> Ty<'tcx> {
2498         self.mk_ty(Dynamic(obj, reg))
2499     }
2500
2501     #[inline]
2502     pub fn mk_projection(self,
2503                          item_def_id: DefId,
2504                          substs: SubstsRef<'tcx>)
2505         -> Ty<'tcx> {
2506             self.mk_ty(Projection(ProjectionTy {
2507                 item_def_id,
2508                 substs,
2509             }))
2510         }
2511
2512     #[inline]
2513     pub fn mk_closure(self, closure_id: DefId, closure_substs: SubstsRef<'tcx>)
2514                       -> Ty<'tcx> {
2515         self.mk_ty(Closure(closure_id, closure_substs))
2516     }
2517
2518     #[inline]
2519     pub fn mk_generator(self,
2520                         id: DefId,
2521                         generator_substs: SubstsRef<'tcx>,
2522                         movability: hir::Movability)
2523                         -> Ty<'tcx> {
2524         self.mk_ty(Generator(id, generator_substs, movability))
2525     }
2526
2527     #[inline]
2528     pub fn mk_generator_witness(self, types: ty::Binder<&'tcx List<Ty<'tcx>>>) -> Ty<'tcx> {
2529         self.mk_ty(GeneratorWitness(types))
2530     }
2531
2532     #[inline]
2533     pub fn mk_ty_var(self, v: TyVid) -> Ty<'tcx> {
2534         self.mk_ty_infer(TyVar(v))
2535     }
2536
2537     #[inline]
2538     pub fn mk_const_var(self, v: ConstVid<'tcx>, ty: Ty<'tcx>) -> &'tcx Const<'tcx> {
2539         self.mk_const(ty::Const {
2540             val: ty::ConstKind::Infer(InferConst::Var(v)),
2541             ty,
2542         })
2543     }
2544
2545     #[inline]
2546     pub fn mk_int_var(self, v: IntVid) -> Ty<'tcx> {
2547         self.mk_ty_infer(IntVar(v))
2548     }
2549
2550     #[inline]
2551     pub fn mk_float_var(self, v: FloatVid) -> Ty<'tcx> {
2552         self.mk_ty_infer(FloatVar(v))
2553     }
2554
2555     #[inline]
2556     pub fn mk_ty_infer(self, it: InferTy) -> Ty<'tcx> {
2557         self.mk_ty(Infer(it))
2558     }
2559
2560     #[inline]
2561     pub fn mk_const_infer(
2562         self,
2563         ic: InferConst<'tcx>,
2564         ty: Ty<'tcx>,
2565     ) -> &'tcx ty::Const<'tcx> {
2566         self.mk_const(ty::Const {
2567             val: ty::ConstKind::Infer(ic),
2568             ty,
2569         })
2570     }
2571
2572     #[inline]
2573     pub fn mk_ty_param(self, index: u32, name: Symbol) -> Ty<'tcx> {
2574         self.mk_ty(Param(ParamTy { index, name: name }))
2575     }
2576
2577     #[inline]
2578     pub fn mk_const_param(
2579         self,
2580         index: u32,
2581         name: Symbol,
2582         ty: Ty<'tcx>
2583     ) -> &'tcx Const<'tcx> {
2584         self.mk_const(ty::Const {
2585             val: ty::ConstKind::Param(ParamConst { index, name }),
2586             ty,
2587         })
2588     }
2589
2590
2591     pub fn mk_param_from_def(self, param: &ty::GenericParamDef) -> GenericArg<'tcx> {
2592         match param.kind {
2593             GenericParamDefKind::Lifetime => {
2594                 self.mk_region(ty::ReEarlyBound(param.to_early_bound_region_data())).into()
2595             }
2596             GenericParamDefKind::Type { .. } => self.mk_ty_param(param.index, param.name).into(),
2597             GenericParamDefKind::Const => {
2598                 self.mk_const_param(param.index, param.name, self.type_of(param.def_id)).into()
2599             }
2600         }
2601     }
2602
2603     #[inline]
2604     pub fn mk_opaque(self, def_id: DefId, substs: SubstsRef<'tcx>) -> Ty<'tcx> {
2605         self.mk_ty(Opaque(def_id, substs))
2606     }
2607
2608     pub fn mk_place_field(self, place: Place<'tcx>, f: Field, ty: Ty<'tcx>) -> Place<'tcx> {
2609         self.mk_place_elem(place, PlaceElem::Field(f, ty))
2610     }
2611
2612     pub fn mk_place_deref(self, place: Place<'tcx>) -> Place<'tcx> {
2613         self.mk_place_elem(place, PlaceElem::Deref)
2614     }
2615
2616     pub fn mk_place_downcast(
2617         self,
2618         place: Place<'tcx>,
2619         adt_def: &'tcx AdtDef,
2620         variant_index: VariantIdx,
2621     ) -> Place<'tcx> {
2622         self.mk_place_elem(
2623             place,
2624             PlaceElem::Downcast(Some(adt_def.variants[variant_index].ident.name), variant_index),
2625         )
2626     }
2627
2628     pub fn mk_place_downcast_unnamed(
2629         self,
2630         place: Place<'tcx>,
2631         variant_index: VariantIdx,
2632     ) -> Place<'tcx> {
2633         self.mk_place_elem(place, PlaceElem::Downcast(None, variant_index))
2634     }
2635
2636     pub fn mk_place_index(self, place: Place<'tcx>, index: Local) -> Place<'tcx> {
2637         self.mk_place_elem(place, PlaceElem::Index(index))
2638     }
2639
2640     /// This method copies `Place`'s projection, add an element and reintern it. Should not be used
2641     /// to build a full `Place` it's just a convenient way to grab a projection and modify it in
2642     /// flight.
2643     pub fn mk_place_elem(self, place: Place<'tcx>, elem: PlaceElem<'tcx>) -> Place<'tcx> {
2644         let mut projection = place.projection.to_vec();
2645         projection.push(elem);
2646
2647         Place { base: place.base, projection: self.intern_place_elems(&projection) }
2648     }
2649
2650     pub fn intern_existential_predicates(self, eps: &[ExistentialPredicate<'tcx>])
2651         -> &'tcx List<ExistentialPredicate<'tcx>> {
2652         assert!(!eps.is_empty());
2653         assert!(eps.windows(2).all(|w| w[0].stable_cmp(self, &w[1]) != Ordering::Greater));
2654         self._intern_existential_predicates(eps)
2655     }
2656
2657     pub fn intern_predicates(self, preds: &[Predicate<'tcx>])
2658         -> &'tcx List<Predicate<'tcx>> {
2659         // FIXME consider asking the input slice to be sorted to avoid
2660         // re-interning permutations, in which case that would be asserted
2661         // here.
2662         if preds.len() == 0 {
2663             // The macro-generated method below asserts we don't intern an empty slice.
2664             List::empty()
2665         } else {
2666             self._intern_predicates(preds)
2667         }
2668     }
2669
2670     pub fn intern_type_list(self, ts: &[Ty<'tcx>]) -> &'tcx List<Ty<'tcx>> {
2671         if ts.len() == 0 {
2672             List::empty()
2673         } else {
2674             self._intern_type_list(ts)
2675         }
2676     }
2677
2678     pub fn intern_substs(self, ts: &[GenericArg<'tcx>]) -> &'tcx List<GenericArg<'tcx>> {
2679         if ts.len() == 0 {
2680             List::empty()
2681         } else {
2682             self._intern_substs(ts)
2683         }
2684     }
2685
2686     pub fn intern_projs(self, ps: &[ProjectionKind]) -> &'tcx List<ProjectionKind> {
2687         if ps.len() == 0 {
2688             List::empty()
2689         } else {
2690             self._intern_projs(ps)
2691         }
2692     }
2693
2694     pub fn intern_place_elems(self, ts: &[PlaceElem<'tcx>]) -> &'tcx List<PlaceElem<'tcx>> {
2695         if ts.len() == 0 {
2696             List::empty()
2697         } else {
2698             self._intern_place_elems(ts)
2699         }
2700     }
2701
2702     pub fn intern_canonical_var_infos(self, ts: &[CanonicalVarInfo]) -> CanonicalVarInfos<'tcx> {
2703         if ts.len() == 0 {
2704             List::empty()
2705         } else {
2706             self._intern_canonical_var_infos(ts)
2707         }
2708     }
2709
2710     pub fn intern_clauses(self, ts: &[Clause<'tcx>]) -> Clauses<'tcx> {
2711         if ts.len() == 0 {
2712             List::empty()
2713         } else {
2714             self._intern_clauses(ts)
2715         }
2716     }
2717
2718     pub fn intern_goals(self, ts: &[Goal<'tcx>]) -> Goals<'tcx> {
2719         if ts.len() == 0 {
2720             List::empty()
2721         } else {
2722             self._intern_goals(ts)
2723         }
2724     }
2725
2726     pub fn mk_fn_sig<I>(self,
2727                         inputs: I,
2728                         output: I::Item,
2729                         c_variadic: bool,
2730                         unsafety: hir::Unsafety,
2731                         abi: abi::Abi)
2732         -> <I::Item as InternIteratorElement<Ty<'tcx>, ty::FnSig<'tcx>>>::Output
2733     where
2734         I: Iterator<Item: InternIteratorElement<Ty<'tcx>, ty::FnSig<'tcx>>>,
2735     {
2736         inputs.chain(iter::once(output)).intern_with(|xs| ty::FnSig {
2737             inputs_and_output: self.intern_type_list(xs),
2738             c_variadic, unsafety, abi
2739         })
2740     }
2741
2742     pub fn mk_existential_predicates<I: InternAs<[ExistentialPredicate<'tcx>],
2743                                      &'tcx List<ExistentialPredicate<'tcx>>>>(self, iter: I)
2744                                      -> I::Output {
2745         iter.intern_with(|xs| self.intern_existential_predicates(xs))
2746     }
2747
2748     pub fn mk_predicates<I: InternAs<[Predicate<'tcx>],
2749                                      &'tcx List<Predicate<'tcx>>>>(self, iter: I)
2750                                      -> I::Output {
2751         iter.intern_with(|xs| self.intern_predicates(xs))
2752     }
2753
2754     pub fn mk_type_list<I: InternAs<[Ty<'tcx>],
2755                         &'tcx List<Ty<'tcx>>>>(self, iter: I) -> I::Output {
2756         iter.intern_with(|xs| self.intern_type_list(xs))
2757     }
2758
2759     pub fn mk_substs<I: InternAs<[GenericArg<'tcx>],
2760                      &'tcx List<GenericArg<'tcx>>>>(self, iter: I) -> I::Output {
2761         iter.intern_with(|xs| self.intern_substs(xs))
2762     }
2763
2764     pub fn mk_place_elems<I: InternAs<[PlaceElem<'tcx>],
2765                           &'tcx List<PlaceElem<'tcx>>>>(self, iter: I) -> I::Output {
2766         iter.intern_with(|xs| self.intern_place_elems(xs))
2767     }
2768
2769     pub fn mk_substs_trait(self,
2770                      self_ty: Ty<'tcx>,
2771                      rest: &[GenericArg<'tcx>])
2772                     -> SubstsRef<'tcx>
2773     {
2774         self.mk_substs(iter::once(self_ty.into()).chain(rest.iter().cloned()))
2775     }
2776
2777     pub fn mk_clauses<I: InternAs<[Clause<'tcx>], Clauses<'tcx>>>(self, iter: I) -> I::Output {
2778         iter.intern_with(|xs| self.intern_clauses(xs))
2779     }
2780
2781     pub fn mk_goals<I: InternAs<[Goal<'tcx>], Goals<'tcx>>>(self, iter: I) -> I::Output {
2782         iter.intern_with(|xs| self.intern_goals(xs))
2783     }
2784
2785     pub fn lint_hir<S: Into<MultiSpan>>(self,
2786                                         lint: &'static Lint,
2787                                         hir_id: HirId,
2788                                         span: S,
2789                                         msg: &str) {
2790         self.struct_span_lint_hir(lint, hir_id, span.into(), msg).emit()
2791     }
2792
2793     pub fn lint_hir_note<S: Into<MultiSpan>>(self,
2794                                              lint: &'static Lint,
2795                                              hir_id: HirId,
2796                                              span: S,
2797                                              msg: &str,
2798                                              note: &str) {
2799         let mut err = self.struct_span_lint_hir(lint, hir_id, span.into(), msg);
2800         err.note(note);
2801         err.emit()
2802     }
2803
2804     pub fn lint_node_note<S: Into<MultiSpan>>(self,
2805                                               lint: &'static Lint,
2806                                               id: hir::HirId,
2807                                               span: S,
2808                                               msg: &str,
2809                                               note: &str) {
2810         let mut err = self.struct_span_lint_hir(lint, id, span.into(), msg);
2811         err.note(note);
2812         err.emit()
2813     }
2814
2815     /// Walks upwards from `id` to find a node which might change lint levels with attributes.
2816     /// It stops at `bound` and just returns it if reached.
2817     pub fn maybe_lint_level_root_bounded(
2818         self,
2819         mut id: hir::HirId,
2820         bound: hir::HirId,
2821     ) -> hir::HirId {
2822         loop {
2823             if id == bound {
2824                 return bound;
2825             }
2826             if lint::maybe_lint_level_root(self, id) {
2827                 return id;
2828             }
2829             let next = self.hir().get_parent_node(id);
2830             if next == id {
2831                 bug!("lint traversal reached the root of the crate");
2832             }
2833             id = next;
2834         }
2835     }
2836
2837     pub fn lint_level_at_node(
2838         self,
2839         lint: &'static Lint,
2840         mut id: hir::HirId
2841     ) -> (lint::Level, lint::LintSource) {
2842         let sets = self.lint_levels(LOCAL_CRATE);
2843         loop {
2844             if let Some(pair) = sets.level_and_source(lint, id, self.sess) {
2845                 return pair
2846             }
2847             let next = self.hir().get_parent_node(id);
2848             if next == id {
2849                 bug!("lint traversal reached the root of the crate");
2850             }
2851             id = next;
2852         }
2853     }
2854
2855     pub fn struct_span_lint_hir<S: Into<MultiSpan>>(self,
2856                                                     lint: &'static Lint,
2857                                                     hir_id: HirId,
2858                                                     span: S,
2859                                                     msg: &str)
2860         -> DiagnosticBuilder<'tcx>
2861     {
2862         let (level, src) = self.lint_level_at_node(lint, hir_id);
2863         lint::struct_lint_level(self.sess, lint, level, src, Some(span.into()), msg)
2864     }
2865
2866     pub fn struct_lint_node(self, lint: &'static Lint, id: HirId, msg: &str)
2867         -> DiagnosticBuilder<'tcx>
2868     {
2869         let (level, src) = self.lint_level_at_node(lint, id);
2870         lint::struct_lint_level(self.sess, lint, level, src, None, msg)
2871     }
2872
2873     pub fn in_scope_traits(self, id: HirId) -> Option<&'tcx StableVec<TraitCandidate>> {
2874         self.in_scope_traits_map(id.owner)
2875             .and_then(|map| map.get(&id.local_id))
2876     }
2877
2878     pub fn named_region(self, id: HirId) -> Option<resolve_lifetime::Region> {
2879         self.named_region_map(id.owner)
2880             .and_then(|map| map.get(&id.local_id).cloned())
2881     }
2882
2883     pub fn is_late_bound(self, id: HirId) -> bool {
2884         self.is_late_bound_map(id.owner)
2885             .map(|set| set.contains(&id.local_id))
2886             .unwrap_or(false)
2887     }
2888
2889     pub fn object_lifetime_defaults(self, id: HirId) -> Option<&'tcx [ObjectLifetimeDefault]> {
2890         self.object_lifetime_defaults_map(id.owner)
2891             .and_then(|map| map.get(&id.local_id).map(|v| &**v))
2892     }
2893 }
2894
2895 pub trait InternAs<T: ?Sized, R> {
2896     type Output;
2897     fn intern_with<F>(self, f: F) -> Self::Output
2898         where F: FnOnce(&T) -> R;
2899 }
2900
2901 impl<I, T, R, E> InternAs<[T], R> for I
2902     where E: InternIteratorElement<T, R>,
2903           I: Iterator<Item=E> {
2904     type Output = E::Output;
2905     fn intern_with<F>(self, f: F) -> Self::Output
2906         where F: FnOnce(&[T]) -> R {
2907         E::intern_with(self, f)
2908     }
2909 }
2910
2911 pub trait InternIteratorElement<T, R>: Sized {
2912     type Output;
2913     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output;
2914 }
2915
2916 impl<T, R> InternIteratorElement<T, R> for T {
2917     type Output = R;
2918     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
2919         f(&iter.collect::<SmallVec<[_; 8]>>())
2920     }
2921 }
2922
2923 impl<'a, T, R> InternIteratorElement<T, R> for &'a T
2924     where T: Clone + 'a
2925 {
2926     type Output = R;
2927     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(iter: I, f: F) -> Self::Output {
2928         f(&iter.cloned().collect::<SmallVec<[_; 8]>>())
2929     }
2930 }
2931
2932 impl<T, R, E> InternIteratorElement<T, R> for Result<T, E> {
2933     type Output = Result<R, E>;
2934     fn intern_with<I: Iterator<Item=Self>, F: FnOnce(&[T]) -> R>(mut iter: I, f: F)
2935             -> Self::Output {
2936         // This code is hot enough that it's worth specializing for the most
2937         // common length lists, to avoid the overhead of `SmallVec` creation.
2938         // The match arms are in order of frequency. The 1, 2, and 0 cases are
2939         // typically hit in ~95% of cases. We assume that if the upper and
2940         // lower bounds from `size_hint` agree they are correct.
2941         Ok(match iter.size_hint() {
2942             (1, Some(1)) => {
2943                 let t0 = iter.next().unwrap()?;
2944                 assert!(iter.next().is_none());
2945                 f(&[t0])
2946             }
2947             (2, Some(2)) => {
2948                 let t0 = iter.next().unwrap()?;
2949                 let t1 = iter.next().unwrap()?;
2950                 assert!(iter.next().is_none());
2951                 f(&[t0, t1])
2952             }
2953             (0, Some(0)) => {
2954                 assert!(iter.next().is_none());
2955                 f(&[])
2956             }
2957             _ => {
2958                 f(&iter.collect::<Result<SmallVec<[_; 8]>, _>>()?)
2959             }
2960         })
2961     }
2962 }
2963
2964 // We are comparing types with different invariant lifetimes, so `ptr::eq`
2965 // won't work for us.
2966 fn ptr_eq<T, U>(t: *const T, u: *const U) -> bool {
2967     t as *const () == u as *const ()
2968 }
2969
2970 pub fn provide(providers: &mut ty::query::Providers<'_>) {
2971     providers.in_scope_traits_map = |tcx, id| tcx.gcx.trait_map.get(&id);
2972     providers.module_exports = |tcx, id| tcx.gcx.export_map.get(&id).map(|v| &v[..]);
2973     providers.crate_name = |tcx, id| {
2974         assert_eq!(id, LOCAL_CRATE);
2975         tcx.crate_name
2976     };
2977     providers.get_lib_features = |tcx, id| {
2978         assert_eq!(id, LOCAL_CRATE);
2979         tcx.arena.alloc(middle::lib_features::collect(tcx))
2980     };
2981     providers.get_lang_items = |tcx, id| {
2982         assert_eq!(id, LOCAL_CRATE);
2983         tcx.arena.alloc(middle::lang_items::collect(tcx))
2984     };
2985     providers.diagnostic_items = |tcx, id| {
2986         assert_eq!(id, LOCAL_CRATE);
2987         middle::diagnostic_items::collect(tcx)
2988     };
2989     providers.all_diagnostic_items = |tcx, id| {
2990         assert_eq!(id, LOCAL_CRATE);
2991         middle::diagnostic_items::collect_all(tcx)
2992     };
2993     providers.maybe_unused_trait_import = |tcx, id| {
2994         tcx.maybe_unused_trait_imports.contains(&id)
2995     };
2996     providers.maybe_unused_extern_crates = |tcx, cnum| {
2997         assert_eq!(cnum, LOCAL_CRATE);
2998         &tcx.maybe_unused_extern_crates[..]
2999     };
3000     providers.names_imported_by_glob_use = |tcx, id| {
3001         assert_eq!(id.krate, LOCAL_CRATE);
3002         Lrc::new(tcx.glob_map.get(&id).cloned().unwrap_or_default())
3003     };
3004
3005     providers.stability_index = |tcx, cnum| {
3006         assert_eq!(cnum, LOCAL_CRATE);
3007         tcx.arena.alloc(stability::Index::new(tcx))
3008     };
3009     providers.lookup_stability = |tcx, id| {
3010         assert_eq!(id.krate, LOCAL_CRATE);
3011         let id = tcx.hir().definitions().def_index_to_hir_id(id.index);
3012         tcx.stability().local_stability(id)
3013     };
3014     providers.lookup_const_stability = |tcx, id| {
3015         assert_eq!(id.krate, LOCAL_CRATE);
3016         let id = tcx.hir().definitions().def_index_to_hir_id(id.index);
3017         tcx.stability().local_const_stability(id)
3018     };
3019     providers.lookup_deprecation_entry = |tcx, id| {
3020         assert_eq!(id.krate, LOCAL_CRATE);
3021         let id = tcx.hir().definitions().def_index_to_hir_id(id.index);
3022         tcx.stability().local_deprecation_entry(id)
3023     };
3024     providers.extern_mod_stmt_cnum = |tcx, id| {
3025         let id = tcx.hir().as_local_node_id(id).unwrap();
3026         tcx.extern_crate_map.get(&id).cloned()
3027     };
3028     providers.all_crate_nums = |tcx, cnum| {
3029         assert_eq!(cnum, LOCAL_CRATE);
3030         tcx.arena.alloc_slice(&tcx.cstore.crates_untracked())
3031     };
3032     providers.output_filenames = |tcx, cnum| {
3033         assert_eq!(cnum, LOCAL_CRATE);
3034         tcx.output_filenames.clone()
3035     };
3036     providers.features_query = |tcx, cnum| {
3037         assert_eq!(cnum, LOCAL_CRATE);
3038         tcx.arena.alloc(tcx.sess.features_untracked().clone())
3039     };
3040     providers.is_panic_runtime = |tcx, cnum| {
3041         assert_eq!(cnum, LOCAL_CRATE);
3042         attr::contains_name(tcx.hir().krate_attrs(), sym::panic_runtime)
3043     };
3044     providers.is_compiler_builtins = |tcx, cnum| {
3045         assert_eq!(cnum, LOCAL_CRATE);
3046         attr::contains_name(tcx.hir().krate_attrs(), sym::compiler_builtins)
3047     };
3048     providers.has_panic_handler = |tcx, cnum| {
3049         assert_eq!(cnum, LOCAL_CRATE);
3050         // We want to check if the panic handler was defined in this crate
3051         tcx.lang_items().panic_impl().map_or(false, |did| did.is_local())
3052     };
3053 }