1 // ignore-tidy-filelength
3 #![allow(usage_of_ty_tykind)]
5 pub use self::Variance::*;
6 pub use self::AssociatedItemContainer::*;
7 pub use self::BorrowKind::*;
8 pub use self::IntVarValue::*;
9 pub use self::fold::TypeFoldable;
11 use crate::hir::{map as hir_map, FreevarMap, GlobMap, TraitMap};
12 use crate::hir::{HirId, Node};
13 use crate::hir::def::{Def, CtorOf, CtorKind, ExportMap};
14 use crate::hir::def_id::{CrateNum, DefId, LocalDefId, CRATE_DEF_INDEX, LOCAL_CRATE};
15 use rustc_data_structures::svh::Svh;
16 use rustc_macros::HashStable;
17 use crate::ich::Fingerprint;
18 use crate::ich::StableHashingContext;
19 use crate::infer::canonical::Canonical;
20 use crate::middle::lang_items::{FnTraitLangItem, FnMutTraitLangItem, FnOnceTraitLangItem};
21 use crate::middle::resolve_lifetime::ObjectLifetimeDefault;
23 use crate::mir::interpret::{GlobalId, ErrorHandled};
24 use crate::mir::GeneratorLayout;
25 use crate::session::CrateDisambiguator;
26 use crate::traits::{self, Reveal};
28 use crate::ty::layout::VariantIdx;
29 use crate::ty::subst::{Subst, InternalSubsts, SubstsRef};
30 use crate::ty::util::{IntTypeExt, Discr};
31 use crate::ty::walk::TypeWalker;
32 use crate::util::captures::Captures;
33 use crate::util::nodemap::{NodeSet, DefIdMap, FxHashMap};
34 use arena::SyncDroplessArena;
35 use crate::session::DataTypeKind;
37 use serialize::{self, Encodable, Encoder};
38 use std::cell::RefCell;
39 use std::cmp::{self, Ordering};
41 use std::hash::{Hash, Hasher};
43 use rustc_data_structures::sync::{self, Lrc, ParallelIterator, par_iter};
46 use syntax::ast::{self, Name, Ident, NodeId};
48 use syntax::ext::hygiene::Mark;
49 use syntax::symbol::{keywords, Symbol, LocalInternedString, InternedString};
53 use rustc_data_structures::indexed_vec::{Idx, IndexVec};
54 use rustc_data_structures::stable_hasher::{StableHasher, StableHasherResult,
59 pub use self::sty::{Binder, BoundTy, BoundTyKind, BoundVar, DebruijnIndex, INNERMOST};
60 pub use self::sty::{FnSig, GenSig, CanonicalPolyFnSig, PolyFnSig, PolyGenSig};
61 pub use self::sty::{InferTy, ParamTy, ParamConst, InferConst, ProjectionTy, ExistentialPredicate};
62 pub use self::sty::{ClosureSubsts, GeneratorSubsts, UpvarSubsts, TypeAndMut};
63 pub use self::sty::{TraitRef, TyKind, PolyTraitRef};
64 pub use self::sty::{ExistentialTraitRef, PolyExistentialTraitRef};
65 pub use self::sty::{ExistentialProjection, PolyExistentialProjection, Const};
66 pub use self::sty::{BoundRegion, EarlyBoundRegion, FreeRegion, Region};
67 pub use self::sty::RegionKind;
68 pub use self::sty::{TyVid, IntVid, FloatVid, ConstVid, RegionVid};
69 pub use self::sty::BoundRegion::*;
70 pub use self::sty::InferTy::*;
71 pub use self::sty::RegionKind::*;
72 pub use self::sty::TyKind::*;
74 pub use self::binding::BindingMode;
75 pub use self::binding::BindingMode::*;
77 pub use self::context::{TyCtxt, FreeRegionInfo, GlobalArenas, AllArenas, tls, keep_local};
78 pub use self::context::{Lift, TypeckTables, CtxtInterners, GlobalCtxt};
79 pub use self::context::{
80 UserTypeAnnotationIndex, UserType, CanonicalUserType,
81 CanonicalUserTypeAnnotation, CanonicalUserTypeAnnotations, ResolvedOpaqueTy,
84 pub use self::instance::{Instance, InstanceDef};
86 pub use self::trait_def::TraitDef;
88 pub use self::query::queries;
100 pub mod inhabitedness;
117 mod structural_impls;
123 pub struct Resolutions {
124 pub freevars: FreevarMap,
125 pub trait_map: TraitMap,
126 pub maybe_unused_trait_imports: NodeSet,
127 pub maybe_unused_extern_crates: Vec<(NodeId, Span)>,
128 pub export_map: ExportMap<NodeId>,
129 pub glob_map: GlobMap,
130 /// Extern prelude entries. The value is `true` if the entry was introduced
131 /// via `extern crate` item and not `--extern` option or compiler built-in.
132 pub extern_prelude: FxHashMap<Name, bool>,
135 #[derive(Clone, Copy, PartialEq, Eq, Debug, HashStable)]
136 pub enum AssociatedItemContainer {
137 TraitContainer(DefId),
138 ImplContainer(DefId),
141 impl AssociatedItemContainer {
142 /// Asserts that this is the `DefId` of an associated item declared
143 /// in a trait, and returns the trait `DefId`.
144 pub fn assert_trait(&self) -> DefId {
146 TraitContainer(id) => id,
147 _ => bug!("associated item has wrong container type: {:?}", self)
151 pub fn id(&self) -> DefId {
153 TraitContainer(id) => id,
154 ImplContainer(id) => id,
159 /// The "header" of an impl is everything outside the body: a Self type, a trait
160 /// ref (in the case of a trait impl), and a set of predicates (from the
161 /// bounds / where-clauses).
162 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
163 pub struct ImplHeader<'tcx> {
164 pub impl_def_id: DefId,
165 pub self_ty: Ty<'tcx>,
166 pub trait_ref: Option<TraitRef<'tcx>>,
167 pub predicates: Vec<Predicate<'tcx>>,
170 #[derive(Copy, Clone, Debug, PartialEq, HashStable)]
171 pub struct AssociatedItem {
173 #[stable_hasher(project(name))]
175 pub kind: AssociatedKind,
177 pub defaultness: hir::Defaultness,
178 pub container: AssociatedItemContainer,
180 /// Whether this is a method with an explicit self
181 /// as its first argument, allowing method calls.
182 pub method_has_self_argument: bool,
185 #[derive(Copy, Clone, PartialEq, Eq, Debug, Hash, RustcEncodable, RustcDecodable, HashStable)]
186 pub enum AssociatedKind {
193 impl AssociatedItem {
194 pub fn def(&self) -> Def {
196 AssociatedKind::Const => Def::AssociatedConst(self.def_id),
197 AssociatedKind::Method => Def::Method(self.def_id),
198 AssociatedKind::Type => Def::AssociatedTy(self.def_id),
199 AssociatedKind::Existential => Def::AssociatedExistential(self.def_id),
203 /// Tests whether the associated item admits a non-trivial implementation
205 pub fn relevant_for_never<'tcx>(&self) -> bool {
207 AssociatedKind::Existential |
208 AssociatedKind::Const |
209 AssociatedKind::Type => true,
210 // FIXME(canndrew): Be more thorough here, check if any argument is uninhabited.
211 AssociatedKind::Method => !self.method_has_self_argument,
215 pub fn signature<'a, 'tcx>(&self, tcx: &TyCtxt<'a, 'tcx, 'tcx>) -> String {
217 ty::AssociatedKind::Method => {
218 // We skip the binder here because the binder would deanonymize all
219 // late-bound regions, and we don't want method signatures to show up
220 // `as for<'r> fn(&'r MyType)`. Pretty-printing handles late-bound
221 // regions just fine, showing `fn(&MyType)`.
222 tcx.fn_sig(self.def_id).skip_binder().to_string()
224 ty::AssociatedKind::Type => format!("type {};", self.ident),
225 ty::AssociatedKind::Existential => format!("existential type {};", self.ident),
226 ty::AssociatedKind::Const => {
227 format!("const {}: {:?};", self.ident, tcx.type_of(self.def_id))
233 #[derive(Clone, Debug, PartialEq, Eq, Copy, RustcEncodable, RustcDecodable, HashStable)]
234 pub enum Visibility {
235 /// Visible everywhere (including in other crates).
237 /// Visible only in the given crate-local module.
239 /// Not visible anywhere in the local crate. This is the visibility of private external items.
243 pub trait DefIdTree: Copy {
244 fn parent(self, id: DefId) -> Option<DefId>;
246 fn is_descendant_of(self, mut descendant: DefId, ancestor: DefId) -> bool {
247 if descendant.krate != ancestor.krate {
251 while descendant != ancestor {
252 match self.parent(descendant) {
253 Some(parent) => descendant = parent,
254 None => return false,
261 impl<'a, 'gcx, 'tcx> DefIdTree for TyCtxt<'a, 'gcx, 'tcx> {
262 fn parent(self, id: DefId) -> Option<DefId> {
263 self.def_key(id).parent.map(|index| DefId { index: index, ..id })
268 pub fn from_hir(visibility: &hir::Visibility, id: hir::HirId, tcx: TyCtxt<'_, '_, '_>) -> Self {
269 match visibility.node {
270 hir::VisibilityKind::Public => Visibility::Public,
271 hir::VisibilityKind::Crate(_) => Visibility::Restricted(DefId::local(CRATE_DEF_INDEX)),
272 hir::VisibilityKind::Restricted { ref path, .. } => match path.def {
273 // If there is no resolution, `resolve` will have already reported an error, so
274 // assume that the visibility is public to avoid reporting more privacy errors.
275 Def::Err => Visibility::Public,
276 def => Visibility::Restricted(def.def_id()),
278 hir::VisibilityKind::Inherited => {
279 Visibility::Restricted(tcx.hir().get_module_parent_by_hir_id(id))
284 /// Returns `true` if an item with this visibility is accessible from the given block.
285 pub fn is_accessible_from<T: DefIdTree>(self, module: DefId, tree: T) -> bool {
286 let restriction = match self {
287 // Public items are visible everywhere.
288 Visibility::Public => return true,
289 // Private items from other crates are visible nowhere.
290 Visibility::Invisible => return false,
291 // Restricted items are visible in an arbitrary local module.
292 Visibility::Restricted(other) if other.krate != module.krate => return false,
293 Visibility::Restricted(module) => module,
296 tree.is_descendant_of(module, restriction)
299 /// Returns `true` if this visibility is at least as accessible as the given visibility
300 pub fn is_at_least<T: DefIdTree>(self, vis: Visibility, tree: T) -> bool {
301 let vis_restriction = match vis {
302 Visibility::Public => return self == Visibility::Public,
303 Visibility::Invisible => return true,
304 Visibility::Restricted(module) => module,
307 self.is_accessible_from(vis_restriction, tree)
310 // Returns `true` if this item is visible anywhere in the local crate.
311 pub fn is_visible_locally(self) -> bool {
313 Visibility::Public => true,
314 Visibility::Restricted(def_id) => def_id.is_local(),
315 Visibility::Invisible => false,
320 #[derive(Copy, Clone, PartialEq, Eq, RustcDecodable, RustcEncodable, Hash, HashStable)]
322 Covariant, // T<A> <: T<B> iff A <: B -- e.g., function return type
323 Invariant, // T<A> <: T<B> iff B == A -- e.g., type of mutable cell
324 Contravariant, // T<A> <: T<B> iff B <: A -- e.g., function param type
325 Bivariant, // T<A> <: T<B> -- e.g., unused type parameter
328 /// The crate variances map is computed during typeck and contains the
329 /// variance of every item in the local crate. You should not use it
330 /// directly, because to do so will make your pass dependent on the
331 /// HIR of every item in the local crate. Instead, use
332 /// `tcx.variances_of()` to get the variance for a *particular*
334 #[derive(HashStable)]
335 pub struct CrateVariancesMap {
336 /// For each item with generics, maps to a vector of the variance
337 /// of its generics. If an item has no generics, it will have no
339 pub variances: FxHashMap<DefId, Lrc<Vec<ty::Variance>>>,
341 /// An empty vector, useful for cloning.
342 #[stable_hasher(ignore)]
343 pub empty_variance: Lrc<Vec<ty::Variance>>,
347 /// `a.xform(b)` combines the variance of a context with the
348 /// variance of a type with the following meaning. If we are in a
349 /// context with variance `a`, and we encounter a type argument in
350 /// a position with variance `b`, then `a.xform(b)` is the new
351 /// variance with which the argument appears.
357 /// Here, the "ambient" variance starts as covariant. `*mut T` is
358 /// invariant with respect to `T`, so the variance in which the
359 /// `Vec<i32>` appears is `Covariant.xform(Invariant)`, which
360 /// yields `Invariant`. Now, the type `Vec<T>` is covariant with
361 /// respect to its type argument `T`, and hence the variance of
362 /// the `i32` here is `Invariant.xform(Covariant)`, which results
363 /// (again) in `Invariant`.
367 /// fn(*const Vec<i32>, *mut Vec<i32)
369 /// The ambient variance is covariant. A `fn` type is
370 /// contravariant with respect to its parameters, so the variance
371 /// within which both pointer types appear is
372 /// `Covariant.xform(Contravariant)`, or `Contravariant`. `*const
373 /// T` is covariant with respect to `T`, so the variance within
374 /// which the first `Vec<i32>` appears is
375 /// `Contravariant.xform(Covariant)` or `Contravariant`. The same
376 /// is true for its `i32` argument. In the `*mut T` case, the
377 /// variance of `Vec<i32>` is `Contravariant.xform(Invariant)`,
378 /// and hence the outermost type is `Invariant` with respect to
379 /// `Vec<i32>` (and its `i32` argument).
381 /// Source: Figure 1 of "Taming the Wildcards:
382 /// Combining Definition- and Use-Site Variance" published in PLDI'11.
383 pub fn xform(self, v: ty::Variance) -> ty::Variance {
385 // Figure 1, column 1.
386 (ty::Covariant, ty::Covariant) => ty::Covariant,
387 (ty::Covariant, ty::Contravariant) => ty::Contravariant,
388 (ty::Covariant, ty::Invariant) => ty::Invariant,
389 (ty::Covariant, ty::Bivariant) => ty::Bivariant,
391 // Figure 1, column 2.
392 (ty::Contravariant, ty::Covariant) => ty::Contravariant,
393 (ty::Contravariant, ty::Contravariant) => ty::Covariant,
394 (ty::Contravariant, ty::Invariant) => ty::Invariant,
395 (ty::Contravariant, ty::Bivariant) => ty::Bivariant,
397 // Figure 1, column 3.
398 (ty::Invariant, _) => ty::Invariant,
400 // Figure 1, column 4.
401 (ty::Bivariant, _) => ty::Bivariant,
406 // Contains information needed to resolve types and (in the future) look up
407 // the types of AST nodes.
408 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
409 pub struct CReaderCacheKey {
414 // Flags that we track on types. These flags are propagated upwards
415 // through the type during type construction, so that we can quickly
416 // check whether the type has various kinds of types in it without
417 // recursing over the type itself.
419 pub struct TypeFlags: u32 {
420 const HAS_PARAMS = 1 << 0;
421 const HAS_SELF = 1 << 1;
422 const HAS_TY_INFER = 1 << 2;
423 const HAS_RE_INFER = 1 << 3;
424 const HAS_RE_PLACEHOLDER = 1 << 4;
426 /// Does this have any `ReEarlyBound` regions? Used to
427 /// determine whether substitition is required, since those
428 /// represent regions that are bound in a `ty::Generics` and
429 /// hence may be substituted.
430 const HAS_RE_EARLY_BOUND = 1 << 5;
432 /// Does this have any region that "appears free" in the type?
433 /// Basically anything but `ReLateBound` and `ReErased`.
434 const HAS_FREE_REGIONS = 1 << 6;
436 /// Is an error type reachable?
437 const HAS_TY_ERR = 1 << 7;
438 const HAS_PROJECTION = 1 << 8;
440 // FIXME: Rename this to the actual property since it's used for generators too
441 const HAS_TY_CLOSURE = 1 << 9;
443 /// `true` if there are "names" of types and regions and so forth
444 /// that are local to a particular fn
445 const HAS_FREE_LOCAL_NAMES = 1 << 10;
447 /// Present if the type belongs in a local type context.
448 /// Only set for Infer other than Fresh.
449 const KEEP_IN_LOCAL_TCX = 1 << 11;
451 // Is there a projection that does not involve a bound region?
452 // Currently we can't normalize projections w/ bound regions.
453 const HAS_NORMALIZABLE_PROJECTION = 1 << 12;
455 /// Does this have any `ReLateBound` regions? Used to check
456 /// if a global bound is safe to evaluate.
457 const HAS_RE_LATE_BOUND = 1 << 13;
459 const HAS_TY_PLACEHOLDER = 1 << 14;
461 const HAS_CT_INFER = 1 << 15;
463 const NEEDS_SUBST = TypeFlags::HAS_PARAMS.bits |
464 TypeFlags::HAS_SELF.bits |
465 TypeFlags::HAS_RE_EARLY_BOUND.bits;
467 /// Flags representing the nominal content of a type,
468 /// computed by FlagsComputation. If you add a new nominal
469 /// flag, it should be added here too.
470 const NOMINAL_FLAGS = TypeFlags::HAS_PARAMS.bits |
471 TypeFlags::HAS_SELF.bits |
472 TypeFlags::HAS_TY_INFER.bits |
473 TypeFlags::HAS_RE_INFER.bits |
474 TypeFlags::HAS_CT_INFER.bits |
475 TypeFlags::HAS_RE_PLACEHOLDER.bits |
476 TypeFlags::HAS_RE_EARLY_BOUND.bits |
477 TypeFlags::HAS_FREE_REGIONS.bits |
478 TypeFlags::HAS_TY_ERR.bits |
479 TypeFlags::HAS_PROJECTION.bits |
480 TypeFlags::HAS_TY_CLOSURE.bits |
481 TypeFlags::HAS_FREE_LOCAL_NAMES.bits |
482 TypeFlags::KEEP_IN_LOCAL_TCX.bits |
483 TypeFlags::HAS_RE_LATE_BOUND.bits |
484 TypeFlags::HAS_TY_PLACEHOLDER.bits;
488 pub struct TyS<'tcx> {
489 pub sty: TyKind<'tcx>,
490 pub flags: TypeFlags,
492 /// This is a kind of confusing thing: it stores the smallest
495 /// (a) the binder itself captures nothing but
496 /// (b) all the late-bound things within the type are captured
497 /// by some sub-binder.
499 /// So, for a type without any late-bound things, like `u32`, this
500 /// will be *innermost*, because that is the innermost binder that
501 /// captures nothing. But for a type `&'D u32`, where `'D` is a
502 /// late-bound region with De Bruijn index `D`, this would be `D + 1`
503 /// -- the binder itself does not capture `D`, but `D` is captured
504 /// by an inner binder.
506 /// We call this concept an "exclusive" binder `D` because all
507 /// De Bruijn indices within the type are contained within `0..D`
509 outer_exclusive_binder: ty::DebruijnIndex,
512 // `TyS` is used a lot. Make sure it doesn't unintentionally get bigger.
513 #[cfg(target_arch = "x86_64")]
514 static_assert!(MEM_SIZE_OF_TY_S: ::std::mem::size_of::<TyS<'_>>() == 32);
516 impl<'tcx> Ord for TyS<'tcx> {
517 fn cmp(&self, other: &TyS<'tcx>) -> Ordering {
518 self.sty.cmp(&other.sty)
522 impl<'tcx> PartialOrd for TyS<'tcx> {
523 fn partial_cmp(&self, other: &TyS<'tcx>) -> Option<Ordering> {
524 Some(self.sty.cmp(&other.sty))
528 impl<'tcx> PartialEq for TyS<'tcx> {
530 fn eq(&self, other: &TyS<'tcx>) -> bool {
534 impl<'tcx> Eq for TyS<'tcx> {}
536 impl<'tcx> Hash for TyS<'tcx> {
537 fn hash<H: Hasher>(&self, s: &mut H) {
538 (self as *const TyS<'_>).hash(s)
542 impl<'tcx> TyS<'tcx> {
543 pub fn is_primitive_ty(&self) -> bool {
550 TyKind::Infer(InferTy::IntVar(_)) |
551 TyKind::Infer(InferTy::FloatVar(_)) |
552 TyKind::Infer(InferTy::FreshIntTy(_)) |
553 TyKind::Infer(InferTy::FreshFloatTy(_)) => true,
554 TyKind::Ref(_, x, _) => x.is_primitive_ty(),
559 pub fn is_suggestable(&self) -> bool {
564 TyKind::Dynamic(..) |
565 TyKind::Closure(..) |
567 TyKind::Projection(..) => false,
573 impl<'a, 'gcx> HashStable<StableHashingContext<'a>> for ty::TyS<'gcx> {
574 fn hash_stable<W: StableHasherResult>(&self,
575 hcx: &mut StableHashingContext<'a>,
576 hasher: &mut StableHasher<W>) {
580 // The other fields just provide fast access to information that is
581 // also contained in `sty`, so no need to hash them.
584 outer_exclusive_binder: _,
587 sty.hash_stable(hcx, hasher);
591 pub type Ty<'tcx> = &'tcx TyS<'tcx>;
593 impl<'tcx> serialize::UseSpecializedEncodable for Ty<'tcx> {}
594 impl<'tcx> serialize::UseSpecializedDecodable for Ty<'tcx> {}
596 pub type CanonicalTy<'gcx> = Canonical<'gcx, Ty<'gcx>>;
599 /// A dummy type used to force List to by unsized without requiring fat pointers
600 type OpaqueListContents;
603 /// A wrapper for slices with the additional invariant
604 /// that the slice is interned and no other slice with
605 /// the same contents can exist in the same context.
606 /// This means we can use pointer for both
607 /// equality comparisons and hashing.
608 /// Note: `Slice` was already taken by the `Ty`.
613 opaque: OpaqueListContents,
616 unsafe impl<T: Sync> Sync for List<T> {}
618 impl<T: Copy> List<T> {
620 fn from_arena<'tcx>(arena: &'tcx SyncDroplessArena, slice: &[T]) -> &'tcx List<T> {
621 assert!(!mem::needs_drop::<T>());
622 assert!(mem::size_of::<T>() != 0);
623 assert!(slice.len() != 0);
625 // Align up the size of the len (usize) field
626 let align = mem::align_of::<T>();
627 let align_mask = align - 1;
628 let offset = mem::size_of::<usize>();
629 let offset = (offset + align_mask) & !align_mask;
631 let size = offset + slice.len() * mem::size_of::<T>();
633 let mem = arena.alloc_raw(
635 cmp::max(mem::align_of::<T>(), mem::align_of::<usize>()));
637 let result = &mut *(mem.as_mut_ptr() as *mut List<T>);
639 result.len = slice.len();
641 // Write the elements
642 let arena_slice = slice::from_raw_parts_mut(result.data.as_mut_ptr(), result.len);
643 arena_slice.copy_from_slice(slice);
650 impl<T: fmt::Debug> fmt::Debug for List<T> {
651 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
656 impl<T: Encodable> Encodable for List<T> {
658 fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
663 impl<T> Ord for List<T> where T: Ord {
664 fn cmp(&self, other: &List<T>) -> Ordering {
665 if self == other { Ordering::Equal } else {
666 <[T] as Ord>::cmp(&**self, &**other)
671 impl<T> PartialOrd for List<T> where T: PartialOrd {
672 fn partial_cmp(&self, other: &List<T>) -> Option<Ordering> {
673 if self == other { Some(Ordering::Equal) } else {
674 <[T] as PartialOrd>::partial_cmp(&**self, &**other)
679 impl<T: PartialEq> PartialEq for List<T> {
681 fn eq(&self, other: &List<T>) -> bool {
685 impl<T: Eq> Eq for List<T> {}
687 impl<T> Hash for List<T> {
689 fn hash<H: Hasher>(&self, s: &mut H) {
690 (self as *const List<T>).hash(s)
694 impl<T> Deref for List<T> {
697 fn deref(&self) -> &[T] {
699 slice::from_raw_parts(self.data.as_ptr(), self.len)
704 impl<'a, T> IntoIterator for &'a List<T> {
706 type IntoIter = <&'a [T] as IntoIterator>::IntoIter;
708 fn into_iter(self) -> Self::IntoIter {
713 impl<'tcx> serialize::UseSpecializedDecodable for &'tcx List<Ty<'tcx>> {}
717 pub fn empty<'a>() -> &'a List<T> {
718 #[repr(align(64), C)]
719 struct EmptySlice([u8; 64]);
720 static EMPTY_SLICE: EmptySlice = EmptySlice([0; 64]);
721 assert!(mem::align_of::<T>() <= 64);
723 &*(&EMPTY_SLICE as *const _ as *const List<T>)
728 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
729 pub struct UpvarPath {
730 pub hir_id: hir::HirId,
733 /// Upvars do not get their own `NodeId`. Instead, we use the pair of
734 /// the original var ID (that is, the root variable that is referenced
735 /// by the upvar) and the ID of the closure expression.
736 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
738 pub var_path: UpvarPath,
739 pub closure_expr_id: LocalDefId,
742 #[derive(Clone, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable, Copy, HashStable)]
743 pub enum BorrowKind {
744 /// Data must be immutable and is aliasable.
747 /// Data must be immutable but not aliasable. This kind of borrow
748 /// cannot currently be expressed by the user and is used only in
749 /// implicit closure bindings. It is needed when the closure
750 /// is borrowing or mutating a mutable referent, e.g.:
752 /// let x: &mut isize = ...;
753 /// let y = || *x += 5;
755 /// If we were to try to translate this closure into a more explicit
756 /// form, we'd encounter an error with the code as written:
758 /// struct Env { x: & &mut isize }
759 /// let x: &mut isize = ...;
760 /// let y = (&mut Env { &x }, fn_ptr); // Closure is pair of env and fn
761 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
763 /// This is then illegal because you cannot mutate a `&mut` found
764 /// in an aliasable location. To solve, you'd have to translate with
765 /// an `&mut` borrow:
767 /// struct Env { x: & &mut isize }
768 /// let x: &mut isize = ...;
769 /// let y = (&mut Env { &mut x }, fn_ptr); // changed from &x to &mut x
770 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
772 /// Now the assignment to `**env.x` is legal, but creating a
773 /// mutable pointer to `x` is not because `x` is not mutable. We
774 /// could fix this by declaring `x` as `let mut x`. This is ok in
775 /// user code, if awkward, but extra weird for closures, since the
776 /// borrow is hidden.
778 /// So we introduce a "unique imm" borrow -- the referent is
779 /// immutable, but not aliasable. This solves the problem. For
780 /// simplicity, we don't give users the way to express this
781 /// borrow, it's just used when translating closures.
784 /// Data is mutable and not aliasable.
788 /// Information describing the capture of an upvar. This is computed
789 /// during `typeck`, specifically by `regionck`.
790 #[derive(PartialEq, Clone, Debug, Copy, RustcEncodable, RustcDecodable, HashStable)]
791 pub enum UpvarCapture<'tcx> {
792 /// Upvar is captured by value. This is always true when the
793 /// closure is labeled `move`, but can also be true in other cases
794 /// depending on inference.
797 /// Upvar is captured by reference.
798 ByRef(UpvarBorrow<'tcx>),
801 #[derive(PartialEq, Clone, Copy, RustcEncodable, RustcDecodable, HashStable)]
802 pub struct UpvarBorrow<'tcx> {
803 /// The kind of borrow: by-ref upvars have access to shared
804 /// immutable borrows, which are not part of the normal language
806 pub kind: BorrowKind,
808 /// Region of the resulting reference.
809 pub region: ty::Region<'tcx>,
812 pub type UpvarListMap = FxHashMap<DefId, Vec<UpvarId>>;
813 pub type UpvarCaptureMap<'tcx> = FxHashMap<UpvarId, UpvarCapture<'tcx>>;
815 #[derive(Copy, Clone)]
816 pub struct ClosureUpvar<'tcx> {
822 #[derive(Clone, Copy, PartialEq, Eq)]
823 pub enum IntVarValue {
825 UintType(ast::UintTy),
828 #[derive(Clone, Copy, PartialEq, Eq)]
829 pub struct FloatVarValue(pub ast::FloatTy);
831 impl ty::EarlyBoundRegion {
832 pub fn to_bound_region(&self) -> ty::BoundRegion {
833 ty::BoundRegion::BrNamed(self.def_id, self.name)
836 /// Does this early bound region have a name? Early bound regions normally
837 /// always have names except when using anonymous lifetimes (`'_`).
838 pub fn has_name(&self) -> bool {
839 self.name != keywords::UnderscoreLifetime.name().as_interned_str()
843 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
844 pub enum GenericParamDefKind {
848 object_lifetime_default: ObjectLifetimeDefault,
849 synthetic: Option<hir::SyntheticTyParamKind>,
854 #[derive(Clone, RustcEncodable, RustcDecodable, HashStable)]
855 pub struct GenericParamDef {
856 pub name: InternedString,
860 /// `pure_wrt_drop`, set by the (unsafe) `#[may_dangle]` attribute
861 /// on generic parameter `'a`/`T`, asserts data behind the parameter
862 /// `'a`/`T` won't be accessed during the parent type's `Drop` impl.
863 pub pure_wrt_drop: bool,
865 pub kind: GenericParamDefKind,
868 impl GenericParamDef {
869 pub fn to_early_bound_region_data(&self) -> ty::EarlyBoundRegion {
870 if let GenericParamDefKind::Lifetime = self.kind {
871 ty::EarlyBoundRegion {
877 bug!("cannot convert a non-lifetime parameter def to an early bound region")
881 pub fn to_bound_region(&self) -> ty::BoundRegion {
882 if let GenericParamDefKind::Lifetime = self.kind {
883 self.to_early_bound_region_data().to_bound_region()
885 bug!("cannot convert a non-lifetime parameter def to an early bound region")
891 pub struct GenericParamCount {
892 pub lifetimes: usize,
897 /// Information about the formal type/lifetime parameters associated
898 /// with an item or method. Analogous to `hir::Generics`.
900 /// The ordering of parameters is the same as in `Subst` (excluding child generics):
901 /// `Self` (optionally), `Lifetime` params..., `Type` params...
902 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
903 pub struct Generics {
904 pub parent: Option<DefId>,
905 pub parent_count: usize,
906 pub params: Vec<GenericParamDef>,
908 /// Reverse map to the `index` field of each `GenericParamDef`
909 #[stable_hasher(ignore)]
910 pub param_def_id_to_index: FxHashMap<DefId, u32>,
913 pub has_late_bound_regions: Option<Span>,
916 impl<'a, 'gcx, 'tcx> Generics {
917 pub fn count(&self) -> usize {
918 self.parent_count + self.params.len()
921 pub fn own_counts(&self) -> GenericParamCount {
922 // We could cache this as a property of `GenericParamCount`, but
923 // the aim is to refactor this away entirely eventually and the
924 // presence of this method will be a constant reminder.
925 let mut own_counts: GenericParamCount = Default::default();
927 for param in &self.params {
929 GenericParamDefKind::Lifetime => own_counts.lifetimes += 1,
930 GenericParamDefKind::Type { .. } => own_counts.types += 1,
931 GenericParamDefKind::Const => own_counts.consts += 1,
938 pub fn requires_monomorphization(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> bool {
939 if self.own_requires_monomorphization() {
943 if let Some(parent_def_id) = self.parent {
944 let parent = tcx.generics_of(parent_def_id);
945 parent.requires_monomorphization(tcx)
951 pub fn own_requires_monomorphization(&self) -> bool {
952 for param in &self.params {
954 GenericParamDefKind::Type { .. } | GenericParamDefKind::Const => return true,
955 GenericParamDefKind::Lifetime => {}
961 pub fn region_param(&'tcx self,
962 param: &EarlyBoundRegion,
963 tcx: TyCtxt<'a, 'gcx, 'tcx>)
964 -> &'tcx GenericParamDef
966 if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
967 let param = &self.params[index as usize];
969 GenericParamDefKind::Lifetime => param,
970 _ => bug!("expected lifetime parameter, but found another generic parameter")
973 tcx.generics_of(self.parent.expect("parent_count > 0 but no parent?"))
974 .region_param(param, tcx)
978 /// Returns the `GenericParamDef` associated with this `ParamTy`.
979 pub fn type_param(&'tcx self,
981 tcx: TyCtxt<'a, 'gcx, 'tcx>)
982 -> &'tcx GenericParamDef {
983 if let Some(index) = param.idx.checked_sub(self.parent_count as u32) {
984 let param = &self.params[index as usize];
986 GenericParamDefKind::Type { .. } => param,
987 _ => bug!("expected type parameter, but found another generic parameter")
990 tcx.generics_of(self.parent.expect("parent_count > 0 but no parent?"))
991 .type_param(param, tcx)
995 /// Returns the `ConstParameterDef` associated with this `ParamConst`.
996 pub fn const_param(&'tcx self,
998 tcx: TyCtxt<'a, 'gcx, 'tcx>)
999 -> &GenericParamDef {
1000 if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
1001 let param = &self.params[index as usize];
1003 GenericParamDefKind::Const => param,
1004 _ => bug!("expected const parameter, but found another generic parameter")
1007 tcx.generics_of(self.parent.expect("parent_count>0 but no parent?"))
1008 .const_param(param, tcx)
1013 /// Bounds on generics.
1014 #[derive(Clone, Default, Debug, HashStable)]
1015 pub struct GenericPredicates<'tcx> {
1016 pub parent: Option<DefId>,
1017 pub predicates: Vec<(Predicate<'tcx>, Span)>,
1020 impl<'tcx> serialize::UseSpecializedEncodable for GenericPredicates<'tcx> {}
1021 impl<'tcx> serialize::UseSpecializedDecodable for GenericPredicates<'tcx> {}
1023 impl<'a, 'gcx, 'tcx> GenericPredicates<'tcx> {
1024 pub fn instantiate(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, substs: SubstsRef<'tcx>)
1025 -> InstantiatedPredicates<'tcx> {
1026 let mut instantiated = InstantiatedPredicates::empty();
1027 self.instantiate_into(tcx, &mut instantiated, substs);
1031 pub fn instantiate_own(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, substs: SubstsRef<'tcx>)
1032 -> InstantiatedPredicates<'tcx> {
1033 InstantiatedPredicates {
1034 predicates: self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)).collect(),
1038 fn instantiate_into(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1039 instantiated: &mut InstantiatedPredicates<'tcx>,
1040 substs: SubstsRef<'tcx>) {
1041 if let Some(def_id) = self.parent {
1042 tcx.predicates_of(def_id).instantiate_into(tcx, instantiated, substs);
1044 instantiated.predicates.extend(
1045 self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)),
1049 pub fn instantiate_identity(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>)
1050 -> InstantiatedPredicates<'tcx> {
1051 let mut instantiated = InstantiatedPredicates::empty();
1052 self.instantiate_identity_into(tcx, &mut instantiated);
1056 fn instantiate_identity_into(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1057 instantiated: &mut InstantiatedPredicates<'tcx>) {
1058 if let Some(def_id) = self.parent {
1059 tcx.predicates_of(def_id).instantiate_identity_into(tcx, instantiated);
1061 instantiated.predicates.extend(self.predicates.iter().map(|&(p, _)| p))
1064 pub fn instantiate_supertrait(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1065 poly_trait_ref: &ty::PolyTraitRef<'tcx>)
1066 -> InstantiatedPredicates<'tcx>
1068 assert_eq!(self.parent, None);
1069 InstantiatedPredicates {
1070 predicates: self.predicates.iter().map(|(pred, _)| {
1071 pred.subst_supertrait(tcx, poly_trait_ref)
1077 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
1078 pub enum Predicate<'tcx> {
1079 /// Corresponds to `where Foo: Bar<A,B,C>`. `Foo` here would be
1080 /// the `Self` type of the trait reference and `A`, `B`, and `C`
1081 /// would be the type parameters.
1082 Trait(PolyTraitPredicate<'tcx>),
1085 RegionOutlives(PolyRegionOutlivesPredicate<'tcx>),
1088 TypeOutlives(PolyTypeOutlivesPredicate<'tcx>),
1090 /// where `<T as TraitRef>::Name == X`, approximately.
1091 /// See the `ProjectionPredicate` struct for details.
1092 Projection(PolyProjectionPredicate<'tcx>),
1094 /// no syntax: `T` well-formed
1095 WellFormed(Ty<'tcx>),
1097 /// trait must be object-safe
1100 /// No direct syntax. May be thought of as `where T: FnFoo<...>`
1101 /// for some substitutions `...` and `T` being a closure type.
1102 /// Satisfied (or refuted) once we know the closure's kind.
1103 ClosureKind(DefId, ClosureSubsts<'tcx>, ClosureKind),
1106 Subtype(PolySubtypePredicate<'tcx>),
1108 /// Constant initializer must evaluate successfully.
1109 ConstEvaluatable(DefId, SubstsRef<'tcx>),
1112 /// The crate outlives map is computed during typeck and contains the
1113 /// outlives of every item in the local crate. You should not use it
1114 /// directly, because to do so will make your pass dependent on the
1115 /// HIR of every item in the local crate. Instead, use
1116 /// `tcx.inferred_outlives_of()` to get the outlives for a *particular*
1118 #[derive(HashStable)]
1119 pub struct CratePredicatesMap<'tcx> {
1120 /// For each struct with outlive bounds, maps to a vector of the
1121 /// predicate of its outlive bounds. If an item has no outlives
1122 /// bounds, it will have no entry.
1123 pub predicates: FxHashMap<DefId, Lrc<Vec<ty::Predicate<'tcx>>>>,
1125 /// An empty vector, useful for cloning.
1126 #[stable_hasher(ignore)]
1127 pub empty_predicate: Lrc<Vec<ty::Predicate<'tcx>>>,
1130 impl<'tcx> AsRef<Predicate<'tcx>> for Predicate<'tcx> {
1131 fn as_ref(&self) -> &Predicate<'tcx> {
1136 impl<'a, 'gcx, 'tcx> Predicate<'tcx> {
1137 /// Performs a substitution suitable for going from a
1138 /// poly-trait-ref to supertraits that must hold if that
1139 /// poly-trait-ref holds. This is slightly different from a normal
1140 /// substitution in terms of what happens with bound regions. See
1141 /// lengthy comment below for details.
1142 pub fn subst_supertrait(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1143 trait_ref: &ty::PolyTraitRef<'tcx>)
1144 -> ty::Predicate<'tcx>
1146 // The interaction between HRTB and supertraits is not entirely
1147 // obvious. Let me walk you (and myself) through an example.
1149 // Let's start with an easy case. Consider two traits:
1151 // trait Foo<'a>: Bar<'a,'a> { }
1152 // trait Bar<'b,'c> { }
1154 // Now, if we have a trait reference `for<'x> T: Foo<'x>`, then
1155 // we can deduce that `for<'x> T: Bar<'x,'x>`. Basically, if we
1156 // knew that `Foo<'x>` (for any 'x) then we also know that
1157 // `Bar<'x,'x>` (for any 'x). This more-or-less falls out from
1158 // normal substitution.
1160 // In terms of why this is sound, the idea is that whenever there
1161 // is an impl of `T:Foo<'a>`, it must show that `T:Bar<'a,'a>`
1162 // holds. So if there is an impl of `T:Foo<'a>` that applies to
1163 // all `'a`, then we must know that `T:Bar<'a,'a>` holds for all
1166 // Another example to be careful of is this:
1168 // trait Foo1<'a>: for<'b> Bar1<'a,'b> { }
1169 // trait Bar1<'b,'c> { }
1171 // Here, if we have `for<'x> T: Foo1<'x>`, then what do we know?
1172 // The answer is that we know `for<'x,'b> T: Bar1<'x,'b>`. The
1173 // reason is similar to the previous example: any impl of
1174 // `T:Foo1<'x>` must show that `for<'b> T: Bar1<'x, 'b>`. So
1175 // basically we would want to collapse the bound lifetimes from
1176 // the input (`trait_ref`) and the supertraits.
1178 // To achieve this in practice is fairly straightforward. Let's
1179 // consider the more complicated scenario:
1181 // - We start out with `for<'x> T: Foo1<'x>`. In this case, `'x`
1182 // has a De Bruijn index of 1. We want to produce `for<'x,'b> T: Bar1<'x,'b>`,
1183 // where both `'x` and `'b` would have a DB index of 1.
1184 // The substitution from the input trait-ref is therefore going to be
1185 // `'a => 'x` (where `'x` has a DB index of 1).
1186 // - The super-trait-ref is `for<'b> Bar1<'a,'b>`, where `'a` is an
1187 // early-bound parameter and `'b' is a late-bound parameter with a
1189 // - If we replace `'a` with `'x` from the input, it too will have
1190 // a DB index of 1, and thus we'll have `for<'x,'b> Bar1<'x,'b>`
1191 // just as we wanted.
1193 // There is only one catch. If we just apply the substitution `'a
1194 // => 'x` to `for<'b> Bar1<'a,'b>`, the substitution code will
1195 // adjust the DB index because we substituting into a binder (it
1196 // tries to be so smart...) resulting in `for<'x> for<'b>
1197 // Bar1<'x,'b>` (we have no syntax for this, so use your
1198 // imagination). Basically the 'x will have DB index of 2 and 'b
1199 // will have DB index of 1. Not quite what we want. So we apply
1200 // the substitution to the *contents* of the trait reference,
1201 // rather than the trait reference itself (put another way, the
1202 // substitution code expects equal binding levels in the values
1203 // from the substitution and the value being substituted into, and
1204 // this trick achieves that).
1206 let substs = &trait_ref.skip_binder().substs;
1208 Predicate::Trait(ref binder) =>
1209 Predicate::Trait(binder.map_bound(|data| data.subst(tcx, substs))),
1210 Predicate::Subtype(ref binder) =>
1211 Predicate::Subtype(binder.map_bound(|data| data.subst(tcx, substs))),
1212 Predicate::RegionOutlives(ref binder) =>
1213 Predicate::RegionOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1214 Predicate::TypeOutlives(ref binder) =>
1215 Predicate::TypeOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1216 Predicate::Projection(ref binder) =>
1217 Predicate::Projection(binder.map_bound(|data| data.subst(tcx, substs))),
1218 Predicate::WellFormed(data) =>
1219 Predicate::WellFormed(data.subst(tcx, substs)),
1220 Predicate::ObjectSafe(trait_def_id) =>
1221 Predicate::ObjectSafe(trait_def_id),
1222 Predicate::ClosureKind(closure_def_id, closure_substs, kind) =>
1223 Predicate::ClosureKind(closure_def_id, closure_substs.subst(tcx, substs), kind),
1224 Predicate::ConstEvaluatable(def_id, const_substs) =>
1225 Predicate::ConstEvaluatable(def_id, const_substs.subst(tcx, substs)),
1230 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
1231 pub struct TraitPredicate<'tcx> {
1232 pub trait_ref: TraitRef<'tcx>
1235 pub type PolyTraitPredicate<'tcx> = ty::Binder<TraitPredicate<'tcx>>;
1237 impl<'tcx> TraitPredicate<'tcx> {
1238 pub fn def_id(&self) -> DefId {
1239 self.trait_ref.def_id
1242 pub fn input_types<'a>(&'a self) -> impl DoubleEndedIterator<Item=Ty<'tcx>> + 'a {
1243 self.trait_ref.input_types()
1246 pub fn self_ty(&self) -> Ty<'tcx> {
1247 self.trait_ref.self_ty()
1251 impl<'tcx> PolyTraitPredicate<'tcx> {
1252 pub fn def_id(&self) -> DefId {
1253 // ok to skip binder since trait def-id does not care about regions
1254 self.skip_binder().def_id()
1258 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord,
1259 Hash, Debug, RustcEncodable, RustcDecodable, HashStable)]
1260 pub struct OutlivesPredicate<A,B>(pub A, pub B); // `A: B`
1261 pub type PolyOutlivesPredicate<A,B> = ty::Binder<OutlivesPredicate<A,B>>;
1262 pub type RegionOutlivesPredicate<'tcx> = OutlivesPredicate<ty::Region<'tcx>,
1264 pub type TypeOutlivesPredicate<'tcx> = OutlivesPredicate<Ty<'tcx>,
1266 pub type PolyRegionOutlivesPredicate<'tcx> = ty::Binder<RegionOutlivesPredicate<'tcx>>;
1267 pub type PolyTypeOutlivesPredicate<'tcx> = ty::Binder<TypeOutlivesPredicate<'tcx>>;
1269 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable, HashStable)]
1270 pub struct SubtypePredicate<'tcx> {
1271 pub a_is_expected: bool,
1275 pub type PolySubtypePredicate<'tcx> = ty::Binder<SubtypePredicate<'tcx>>;
1277 /// This kind of predicate has no *direct* correspondent in the
1278 /// syntax, but it roughly corresponds to the syntactic forms:
1280 /// 1. `T: TraitRef<..., Item = Type>`
1281 /// 2. `<T as TraitRef<...>>::Item == Type` (NYI)
1283 /// In particular, form #1 is "desugared" to the combination of a
1284 /// normal trait predicate (`T: TraitRef<...>`) and one of these
1285 /// predicates. Form #2 is a broader form in that it also permits
1286 /// equality between arbitrary types. Processing an instance of
1287 /// Form #2 eventually yields one of these `ProjectionPredicate`
1288 /// instances to normalize the LHS.
1289 #[derive(Copy, Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
1290 pub struct ProjectionPredicate<'tcx> {
1291 pub projection_ty: ProjectionTy<'tcx>,
1295 pub type PolyProjectionPredicate<'tcx> = Binder<ProjectionPredicate<'tcx>>;
1297 impl<'tcx> PolyProjectionPredicate<'tcx> {
1298 /// Returns the `DefId` of the associated item being projected.
1299 pub fn item_def_id(&self) -> DefId {
1300 self.skip_binder().projection_ty.item_def_id
1304 pub fn to_poly_trait_ref(&self, tcx: TyCtxt<'_, '_, '_>) -> PolyTraitRef<'tcx> {
1305 // Note: unlike with `TraitRef::to_poly_trait_ref()`,
1306 // `self.0.trait_ref` is permitted to have escaping regions.
1307 // This is because here `self` has a `Binder` and so does our
1308 // return value, so we are preserving the number of binding
1310 self.map_bound(|predicate| predicate.projection_ty.trait_ref(tcx))
1313 pub fn ty(&self) -> Binder<Ty<'tcx>> {
1314 self.map_bound(|predicate| predicate.ty)
1317 /// The `DefId` of the `TraitItem` for the associated type.
1319 /// Note that this is not the `DefId` of the `TraitRef` containing this
1320 /// associated type, which is in `tcx.associated_item(projection_def_id()).container`.
1321 pub fn projection_def_id(&self) -> DefId {
1322 // okay to skip binder since trait def-id does not care about regions
1323 self.skip_binder().projection_ty.item_def_id
1327 pub trait ToPolyTraitRef<'tcx> {
1328 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx>;
1331 impl<'tcx> ToPolyTraitRef<'tcx> for TraitRef<'tcx> {
1332 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1333 ty::Binder::dummy(self.clone())
1337 impl<'tcx> ToPolyTraitRef<'tcx> for PolyTraitPredicate<'tcx> {
1338 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1339 self.map_bound_ref(|trait_pred| trait_pred.trait_ref)
1343 pub trait ToPredicate<'tcx> {
1344 fn to_predicate(&self) -> Predicate<'tcx>;
1347 impl<'tcx> ToPredicate<'tcx> for TraitRef<'tcx> {
1348 fn to_predicate(&self) -> Predicate<'tcx> {
1349 ty::Predicate::Trait(ty::Binder::dummy(ty::TraitPredicate {
1350 trait_ref: self.clone()
1355 impl<'tcx> ToPredicate<'tcx> for PolyTraitRef<'tcx> {
1356 fn to_predicate(&self) -> Predicate<'tcx> {
1357 ty::Predicate::Trait(self.to_poly_trait_predicate())
1361 impl<'tcx> ToPredicate<'tcx> for PolyRegionOutlivesPredicate<'tcx> {
1362 fn to_predicate(&self) -> Predicate<'tcx> {
1363 Predicate::RegionOutlives(self.clone())
1367 impl<'tcx> ToPredicate<'tcx> for PolyTypeOutlivesPredicate<'tcx> {
1368 fn to_predicate(&self) -> Predicate<'tcx> {
1369 Predicate::TypeOutlives(self.clone())
1373 impl<'tcx> ToPredicate<'tcx> for PolyProjectionPredicate<'tcx> {
1374 fn to_predicate(&self) -> Predicate<'tcx> {
1375 Predicate::Projection(self.clone())
1379 // A custom iterator used by Predicate::walk_tys.
1380 enum WalkTysIter<'tcx, I, J, K>
1381 where I: Iterator<Item = Ty<'tcx>>,
1382 J: Iterator<Item = Ty<'tcx>>,
1383 K: Iterator<Item = Ty<'tcx>>
1387 Two(Ty<'tcx>, Ty<'tcx>),
1393 impl<'tcx, I, J, K> Iterator for WalkTysIter<'tcx, I, J, K>
1394 where I: Iterator<Item = Ty<'tcx>>,
1395 J: Iterator<Item = Ty<'tcx>>,
1396 K: Iterator<Item = Ty<'tcx>>
1398 type Item = Ty<'tcx>;
1400 fn next(&mut self) -> Option<Ty<'tcx>> {
1402 WalkTysIter::None => None,
1403 WalkTysIter::One(item) => {
1404 *self = WalkTysIter::None;
1407 WalkTysIter::Two(item1, item2) => {
1408 *self = WalkTysIter::One(item2);
1411 WalkTysIter::Types(ref mut iter) => {
1414 WalkTysIter::InputTypes(ref mut iter) => {
1417 WalkTysIter::ProjectionTypes(ref mut iter) => {
1424 impl<'tcx> Predicate<'tcx> {
1425 /// Iterates over the types in this predicate. Note that in all
1426 /// cases this is skipping over a binder, so late-bound regions
1427 /// with depth 0 are bound by the predicate.
1428 pub fn walk_tys(&'a self) -> impl Iterator<Item = Ty<'tcx>> + 'a {
1430 ty::Predicate::Trait(ref data) => {
1431 WalkTysIter::InputTypes(data.skip_binder().input_types())
1433 ty::Predicate::Subtype(binder) => {
1434 let SubtypePredicate { a, b, a_is_expected: _ } = binder.skip_binder();
1435 WalkTysIter::Two(a, b)
1437 ty::Predicate::TypeOutlives(binder) => {
1438 WalkTysIter::One(binder.skip_binder().0)
1440 ty::Predicate::RegionOutlives(..) => {
1443 ty::Predicate::Projection(ref data) => {
1444 let inner = data.skip_binder();
1445 WalkTysIter::ProjectionTypes(
1446 inner.projection_ty.substs.types().chain(Some(inner.ty)))
1448 ty::Predicate::WellFormed(data) => {
1449 WalkTysIter::One(data)
1451 ty::Predicate::ObjectSafe(_trait_def_id) => {
1454 ty::Predicate::ClosureKind(_closure_def_id, closure_substs, _kind) => {
1455 WalkTysIter::Types(closure_substs.substs.types())
1457 ty::Predicate::ConstEvaluatable(_, substs) => {
1458 WalkTysIter::Types(substs.types())
1463 pub fn to_opt_poly_trait_ref(&self) -> Option<PolyTraitRef<'tcx>> {
1465 Predicate::Trait(ref t) => {
1466 Some(t.to_poly_trait_ref())
1468 Predicate::Projection(..) |
1469 Predicate::Subtype(..) |
1470 Predicate::RegionOutlives(..) |
1471 Predicate::WellFormed(..) |
1472 Predicate::ObjectSafe(..) |
1473 Predicate::ClosureKind(..) |
1474 Predicate::TypeOutlives(..) |
1475 Predicate::ConstEvaluatable(..) => {
1481 pub fn to_opt_type_outlives(&self) -> Option<PolyTypeOutlivesPredicate<'tcx>> {
1483 Predicate::TypeOutlives(data) => {
1486 Predicate::Trait(..) |
1487 Predicate::Projection(..) |
1488 Predicate::Subtype(..) |
1489 Predicate::RegionOutlives(..) |
1490 Predicate::WellFormed(..) |
1491 Predicate::ObjectSafe(..) |
1492 Predicate::ClosureKind(..) |
1493 Predicate::ConstEvaluatable(..) => {
1500 /// Represents the bounds declared on a particular set of type
1501 /// parameters. Should eventually be generalized into a flag list of
1502 /// where-clauses. You can obtain a `InstantiatedPredicates` list from a
1503 /// `GenericPredicates` by using the `instantiate` method. Note that this method
1504 /// reflects an important semantic invariant of `InstantiatedPredicates`: while
1505 /// the `GenericPredicates` are expressed in terms of the bound type
1506 /// parameters of the impl/trait/whatever, an `InstantiatedPredicates` instance
1507 /// represented a set of bounds for some particular instantiation,
1508 /// meaning that the generic parameters have been substituted with
1513 /// struct Foo<T,U:Bar<T>> { ... }
1515 /// Here, the `GenericPredicates` for `Foo` would contain a list of bounds like
1516 /// `[[], [U:Bar<T>]]`. Now if there were some particular reference
1517 /// like `Foo<isize,usize>`, then the `InstantiatedPredicates` would be `[[],
1518 /// [usize:Bar<isize>]]`.
1519 #[derive(Clone, Debug)]
1520 pub struct InstantiatedPredicates<'tcx> {
1521 pub predicates: Vec<Predicate<'tcx>>,
1524 impl<'tcx> InstantiatedPredicates<'tcx> {
1525 pub fn empty() -> InstantiatedPredicates<'tcx> {
1526 InstantiatedPredicates { predicates: vec![] }
1529 pub fn is_empty(&self) -> bool {
1530 self.predicates.is_empty()
1535 /// "Universes" are used during type- and trait-checking in the
1536 /// presence of `for<..>` binders to control what sets of names are
1537 /// visible. Universes are arranged into a tree: the root universe
1538 /// contains names that are always visible. Each child then adds a new
1539 /// set of names that are visible, in addition to those of its parent.
1540 /// We say that the child universe "extends" the parent universe with
1543 /// To make this more concrete, consider this program:
1547 /// fn bar<T>(x: T) {
1548 /// let y: for<'a> fn(&'a u8, Foo) = ...;
1552 /// The struct name `Foo` is in the root universe U0. But the type
1553 /// parameter `T`, introduced on `bar`, is in an extended universe U1
1554 /// -- i.e., within `bar`, we can name both `T` and `Foo`, but outside
1555 /// of `bar`, we cannot name `T`. Then, within the type of `y`, the
1556 /// region `'a` is in a universe U2 that extends U1, because we can
1557 /// name it inside the fn type but not outside.
1559 /// Universes are used to do type- and trait-checking around these
1560 /// "forall" binders (also called **universal quantification**). The
1561 /// idea is that when, in the body of `bar`, we refer to `T` as a
1562 /// type, we aren't referring to any type in particular, but rather a
1563 /// kind of "fresh" type that is distinct from all other types we have
1564 /// actually declared. This is called a **placeholder** type, and we
1565 /// use universes to talk about this. In other words, a type name in
1566 /// universe 0 always corresponds to some "ground" type that the user
1567 /// declared, but a type name in a non-zero universe is a placeholder
1568 /// type -- an idealized representative of "types in general" that we
1569 /// use for checking generic functions.
1570 pub struct UniverseIndex {
1571 DEBUG_FORMAT = "U{}",
1575 impl_stable_hash_for!(struct UniverseIndex { private });
1577 impl UniverseIndex {
1578 pub const ROOT: UniverseIndex = UniverseIndex::from_u32_const(0);
1580 /// Returns the "next" universe index in order -- this new index
1581 /// is considered to extend all previous universes. This
1582 /// corresponds to entering a `forall` quantifier. So, for
1583 /// example, suppose we have this type in universe `U`:
1586 /// for<'a> fn(&'a u32)
1589 /// Once we "enter" into this `for<'a>` quantifier, we are in a
1590 /// new universe that extends `U` -- in this new universe, we can
1591 /// name the region `'a`, but that region was not nameable from
1592 /// `U` because it was not in scope there.
1593 pub fn next_universe(self) -> UniverseIndex {
1594 UniverseIndex::from_u32(self.private.checked_add(1).unwrap())
1597 /// Returns `true` if `self` can name a name from `other` -- in other words,
1598 /// if the set of names in `self` is a superset of those in
1599 /// `other` (`self >= other`).
1600 pub fn can_name(self, other: UniverseIndex) -> bool {
1601 self.private >= other.private
1604 /// Returns `true` if `self` cannot name some names from `other` -- in other
1605 /// words, if the set of names in `self` is a strict subset of
1606 /// those in `other` (`self < other`).
1607 pub fn cannot_name(self, other: UniverseIndex) -> bool {
1608 self.private < other.private
1612 /// The "placeholder index" fully defines a placeholder region.
1613 /// Placeholder regions are identified by both a **universe** as well
1614 /// as a "bound-region" within that universe. The `bound_region` is
1615 /// basically a name -- distinct bound regions within the same
1616 /// universe are just two regions with an unknown relationship to one
1618 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, PartialOrd, Ord)]
1619 pub struct Placeholder<T> {
1620 pub universe: UniverseIndex,
1624 impl<'a, 'gcx, T> HashStable<StableHashingContext<'a>> for Placeholder<T>
1625 where T: HashStable<StableHashingContext<'a>>
1627 fn hash_stable<W: StableHasherResult>(
1629 hcx: &mut StableHashingContext<'a>,
1630 hasher: &mut StableHasher<W>
1632 self.universe.hash_stable(hcx, hasher);
1633 self.name.hash_stable(hcx, hasher);
1637 pub type PlaceholderRegion = Placeholder<BoundRegion>;
1639 pub type PlaceholderType = Placeholder<BoundVar>;
1641 /// When type checking, we use the `ParamEnv` to track
1642 /// details about the set of where-clauses that are in scope at this
1643 /// particular point.
1644 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable)]
1645 pub struct ParamEnv<'tcx> {
1646 /// Obligations that the caller must satisfy. This is basically
1647 /// the set of bounds on the in-scope type parameters, translated
1648 /// into Obligations, and elaborated and normalized.
1649 pub caller_bounds: &'tcx List<ty::Predicate<'tcx>>,
1651 /// Typically, this is `Reveal::UserFacing`, but during codegen we
1652 /// want `Reveal::All` -- note that this is always paired with an
1653 /// empty environment. To get that, use `ParamEnv::reveal()`.
1654 pub reveal: traits::Reveal,
1656 /// If this `ParamEnv` comes from a call to `tcx.param_env(def_id)`,
1657 /// register that `def_id` (useful for transitioning to the chalk trait
1659 pub def_id: Option<DefId>,
1662 impl<'tcx> ParamEnv<'tcx> {
1663 /// Construct a trait environment suitable for contexts where
1664 /// there are no where-clauses in scope. Hidden types (like `impl
1665 /// Trait`) are left hidden, so this is suitable for ordinary
1668 pub fn empty() -> Self {
1669 Self::new(List::empty(), Reveal::UserFacing, None)
1672 /// Construct a trait environment with no where-clauses in scope
1673 /// where the values of all `impl Trait` and other hidden types
1674 /// are revealed. This is suitable for monomorphized, post-typeck
1675 /// environments like codegen or doing optimizations.
1677 /// N.B., if you want to have predicates in scope, use `ParamEnv::new`,
1678 /// or invoke `param_env.with_reveal_all()`.
1680 pub fn reveal_all() -> Self {
1681 Self::new(List::empty(), Reveal::All, None)
1684 /// Construct a trait environment with the given set of predicates.
1687 caller_bounds: &'tcx List<ty::Predicate<'tcx>>,
1689 def_id: Option<DefId>
1691 ty::ParamEnv { caller_bounds, reveal, def_id }
1694 /// Returns a new parameter environment with the same clauses, but
1695 /// which "reveals" the true results of projections in all cases
1696 /// (even for associated types that are specializable). This is
1697 /// the desired behavior during codegen and certain other special
1698 /// contexts; normally though we want to use `Reveal::UserFacing`,
1699 /// which is the default.
1700 pub fn with_reveal_all(self) -> Self {
1701 ty::ParamEnv { reveal: Reveal::All, ..self }
1704 /// Returns this same environment but with no caller bounds.
1705 pub fn without_caller_bounds(self) -> Self {
1706 ty::ParamEnv { caller_bounds: List::empty(), ..self }
1709 /// Creates a suitable environment in which to perform trait
1710 /// queries on the given value. When type-checking, this is simply
1711 /// the pair of the environment plus value. But when reveal is set to
1712 /// All, then if `value` does not reference any type parameters, we will
1713 /// pair it with the empty environment. This improves caching and is generally
1716 /// N.B., we preserve the environment when type-checking because it
1717 /// is possible for the user to have wacky where-clauses like
1718 /// `where Box<u32>: Copy`, which are clearly never
1719 /// satisfiable. We generally want to behave as if they were true,
1720 /// although the surrounding function is never reachable.
1721 pub fn and<T: TypeFoldable<'tcx>>(self, value: T) -> ParamEnvAnd<'tcx, T> {
1723 Reveal::UserFacing => {
1731 if value.has_placeholders()
1732 || value.needs_infer()
1733 || value.has_param_types()
1734 || value.has_self_ty()
1742 param_env: self.without_caller_bounds(),
1751 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
1752 pub struct ParamEnvAnd<'tcx, T> {
1753 pub param_env: ParamEnv<'tcx>,
1757 impl<'tcx, T> ParamEnvAnd<'tcx, T> {
1758 pub fn into_parts(self) -> (ParamEnv<'tcx>, T) {
1759 (self.param_env, self.value)
1763 impl<'a, 'gcx, T> HashStable<StableHashingContext<'a>> for ParamEnvAnd<'gcx, T>
1764 where T: HashStable<StableHashingContext<'a>>
1766 fn hash_stable<W: StableHasherResult>(&self,
1767 hcx: &mut StableHashingContext<'a>,
1768 hasher: &mut StableHasher<W>) {
1774 param_env.hash_stable(hcx, hasher);
1775 value.hash_stable(hcx, hasher);
1779 #[derive(Copy, Clone, Debug, HashStable)]
1780 pub struct Destructor {
1781 /// The `DefId` of the destructor method
1786 #[derive(HashStable)]
1787 pub struct AdtFlags: u32 {
1788 const NO_ADT_FLAGS = 0;
1789 /// Indicates whether the ADT is an enum.
1790 const IS_ENUM = 1 << 0;
1791 /// Indicates whether the ADT is a union.
1792 const IS_UNION = 1 << 1;
1793 /// Indicates whether the ADT is a struct.
1794 const IS_STRUCT = 1 << 2;
1795 /// Indicates whether the ADT is a struct and has a constructor.
1796 const HAS_CTOR = 1 << 3;
1797 /// Indicates whether the type is a `PhantomData`.
1798 const IS_PHANTOM_DATA = 1 << 4;
1799 /// Indicates whether the type has a `#[fundamental]` attribute.
1800 const IS_FUNDAMENTAL = 1 << 5;
1801 /// Indicates whether the type is a `Box`.
1802 const IS_BOX = 1 << 6;
1803 /// Indicates whether the type is an `Arc`.
1804 const IS_ARC = 1 << 7;
1805 /// Indicates whether the type is an `Rc`.
1806 const IS_RC = 1 << 8;
1807 /// Indicates whether the variant list of this ADT is `#[non_exhaustive]`.
1808 /// (i.e., this flag is never set unless this ADT is an enum).
1809 const IS_VARIANT_LIST_NON_EXHAUSTIVE = 1 << 9;
1814 #[derive(HashStable)]
1815 pub struct VariantFlags: u32 {
1816 const NO_VARIANT_FLAGS = 0;
1817 /// Indicates whether the field list of this variant is `#[non_exhaustive]`.
1818 const IS_FIELD_LIST_NON_EXHAUSTIVE = 1 << 0;
1822 /// Definition of a variant -- a struct's fields or a enum variant.
1824 pub struct VariantDef {
1825 /// `DefId` that identifies the variant itself.
1826 /// If this variant belongs to a struct or union, then this is a copy of its `DefId`.
1828 /// `DefId` that identifies the variant's constructor.
1829 /// If this variant is a struct variant, then this is `None`.
1830 pub ctor_def_id: Option<DefId>,
1831 /// Variant or struct name.
1833 /// Discriminant of this variant.
1834 pub discr: VariantDiscr,
1835 /// Fields of this variant.
1836 pub fields: Vec<FieldDef>,
1837 /// Type of constructor of variant.
1838 pub ctor_kind: CtorKind,
1839 /// Flags of the variant (e.g. is field list non-exhaustive)?
1840 flags: VariantFlags,
1842 pub recovered: bool,
1845 impl<'a, 'gcx, 'tcx> VariantDef {
1846 /// Creates a new `VariantDef`.
1848 /// `variant_did` is the `DefId` that identifies the enum variant (if this `VariantDef`
1849 /// represents an enum variant).
1851 /// `ctor_did` is the `DefId` that identifies the constructor of unit or
1852 /// tuple-variants/structs. If this is a `struct`-variant then this should be `None`.
1854 /// `parent_did` is the `DefId` of the `AdtDef` representing the enum or struct that
1855 /// owns this variant. It is used for checking if a struct has `#[non_exhaustive]` w/out having
1856 /// to go through the redirect of checking the ctor's attributes - but compiling a small crate
1857 /// requires loading the `AdtDef`s for all the structs in the universe (e.g., coherence for any
1858 /// built-in trait), and we do not want to load attributes twice.
1860 /// If someone speeds up attribute loading to not be a performance concern, they can
1861 /// remove this hack and use the constructor `DefId` everywhere.
1863 tcx: TyCtxt<'a, 'gcx, 'tcx>,
1865 variant_did: Option<DefId>,
1866 ctor_def_id: Option<DefId>,
1867 discr: VariantDiscr,
1868 fields: Vec<FieldDef>,
1869 ctor_kind: CtorKind,
1875 "VariantDef::new(ident = {:?}, variant_did = {:?}, ctor_def_id = {:?}, discr = {:?},
1876 fields = {:?}, ctor_kind = {:?}, adt_kind = {:?}, parent_did = {:?})",
1877 ident, variant_did, ctor_def_id, discr, fields, ctor_kind, adt_kind, parent_did,
1880 let mut flags = VariantFlags::NO_VARIANT_FLAGS;
1881 if adt_kind == AdtKind::Struct && tcx.has_attr(parent_did, "non_exhaustive") {
1882 debug!("found non-exhaustive field list for {:?}", parent_did);
1883 flags = flags | VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
1884 } else if let Some(variant_did) = variant_did {
1885 if tcx.has_attr(variant_did, "non_exhaustive") {
1886 debug!("found non-exhaustive field list for {:?}", variant_did);
1887 flags = flags | VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
1892 def_id: variant_did.unwrap_or(parent_did),
1903 /// Is this field list non-exhaustive?
1905 pub fn is_field_list_non_exhaustive(&self) -> bool {
1906 self.flags.intersects(VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE)
1910 impl_stable_hash_for!(struct VariantDef {
1913 ident -> (ident.name),
1921 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable, HashStable)]
1922 pub enum VariantDiscr {
1923 /// Explicit value for this variant, i.e., `X = 123`.
1924 /// The `DefId` corresponds to the embedded constant.
1927 /// The previous variant's discriminant plus one.
1928 /// For efficiency reasons, the distance from the
1929 /// last `Explicit` discriminant is being stored,
1930 /// or `0` for the first variant, if it has none.
1934 #[derive(Debug, HashStable)]
1935 pub struct FieldDef {
1937 #[stable_hasher(project(name))]
1939 pub vis: Visibility,
1942 /// The definition of an abstract data type -- a struct or enum.
1944 /// These are all interned (by `intern_adt_def`) into the `adt_defs` table.
1946 /// `DefId` of the struct, enum or union item.
1948 /// Variants of the ADT. If this is a struct or enum, then there will be a single variant.
1949 pub variants: IndexVec<self::layout::VariantIdx, VariantDef>,
1950 /// Flags of the ADT (e.g. is this a struct? is this non-exhaustive?)
1952 /// Repr options provided by the user.
1953 pub repr: ReprOptions,
1956 impl PartialOrd for AdtDef {
1957 fn partial_cmp(&self, other: &AdtDef) -> Option<Ordering> {
1958 Some(self.cmp(&other))
1962 /// There should be only one AdtDef for each `did`, therefore
1963 /// it is fine to implement `Ord` only based on `did`.
1964 impl Ord for AdtDef {
1965 fn cmp(&self, other: &AdtDef) -> Ordering {
1966 self.did.cmp(&other.did)
1970 impl PartialEq for AdtDef {
1971 // AdtDef are always interned and this is part of TyS equality
1973 fn eq(&self, other: &Self) -> bool { ptr::eq(self, other) }
1976 impl Eq for AdtDef {}
1978 impl Hash for AdtDef {
1980 fn hash<H: Hasher>(&self, s: &mut H) {
1981 (self as *const AdtDef).hash(s)
1985 impl<'tcx> serialize::UseSpecializedEncodable for &'tcx AdtDef {
1986 fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
1991 impl<'tcx> serialize::UseSpecializedDecodable for &'tcx AdtDef {}
1994 impl<'a> HashStable<StableHashingContext<'a>> for AdtDef {
1995 fn hash_stable<W: StableHasherResult>(&self,
1996 hcx: &mut StableHashingContext<'a>,
1997 hasher: &mut StableHasher<W>) {
1999 static CACHE: RefCell<FxHashMap<usize, Fingerprint>> = Default::default();
2002 let hash: Fingerprint = CACHE.with(|cache| {
2003 let addr = self as *const AdtDef as usize;
2004 *cache.borrow_mut().entry(addr).or_insert_with(|| {
2012 let mut hasher = StableHasher::new();
2013 did.hash_stable(hcx, &mut hasher);
2014 variants.hash_stable(hcx, &mut hasher);
2015 flags.hash_stable(hcx, &mut hasher);
2016 repr.hash_stable(hcx, &mut hasher);
2022 hash.hash_stable(hcx, hasher);
2026 #[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
2027 pub enum AdtKind { Struct, Union, Enum }
2029 impl Into<DataTypeKind> for AdtKind {
2030 fn into(self) -> DataTypeKind {
2032 AdtKind::Struct => DataTypeKind::Struct,
2033 AdtKind::Union => DataTypeKind::Union,
2034 AdtKind::Enum => DataTypeKind::Enum,
2040 #[derive(RustcEncodable, RustcDecodable, Default)]
2041 pub struct ReprFlags: u8 {
2042 const IS_C = 1 << 0;
2043 const IS_SIMD = 1 << 1;
2044 const IS_TRANSPARENT = 1 << 2;
2045 // Internal only for now. If true, don't reorder fields.
2046 const IS_LINEAR = 1 << 3;
2048 // Any of these flags being set prevent field reordering optimisation.
2049 const IS_UNOPTIMISABLE = ReprFlags::IS_C.bits |
2050 ReprFlags::IS_SIMD.bits |
2051 ReprFlags::IS_LINEAR.bits;
2055 impl_stable_hash_for!(struct ReprFlags {
2059 /// Represents the repr options provided by the user,
2060 #[derive(Copy, Clone, Debug, Eq, PartialEq, RustcEncodable, RustcDecodable, Default)]
2061 pub struct ReprOptions {
2062 pub int: Option<attr::IntType>,
2065 pub flags: ReprFlags,
2068 impl_stable_hash_for!(struct ReprOptions {
2076 pub fn new(tcx: TyCtxt<'_, '_, '_>, did: DefId) -> ReprOptions {
2077 let mut flags = ReprFlags::empty();
2078 let mut size = None;
2079 let mut max_align = 0;
2080 let mut min_pack = 0;
2081 for attr in tcx.get_attrs(did).iter() {
2082 for r in attr::find_repr_attrs(&tcx.sess.parse_sess, attr) {
2083 flags.insert(match r {
2084 attr::ReprC => ReprFlags::IS_C,
2085 attr::ReprPacked(pack) => {
2086 min_pack = if min_pack > 0 {
2087 cmp::min(pack, min_pack)
2093 attr::ReprTransparent => ReprFlags::IS_TRANSPARENT,
2094 attr::ReprSimd => ReprFlags::IS_SIMD,
2095 attr::ReprInt(i) => {
2099 attr::ReprAlign(align) => {
2100 max_align = cmp::max(align, max_align);
2107 // This is here instead of layout because the choice must make it into metadata.
2108 if !tcx.consider_optimizing(|| format!("Reorder fields of {:?}", tcx.def_path_str(did))) {
2109 flags.insert(ReprFlags::IS_LINEAR);
2111 ReprOptions { int: size, align: max_align, pack: min_pack, flags: flags }
2115 pub fn simd(&self) -> bool { self.flags.contains(ReprFlags::IS_SIMD) }
2117 pub fn c(&self) -> bool { self.flags.contains(ReprFlags::IS_C) }
2119 pub fn packed(&self) -> bool { self.pack > 0 }
2121 pub fn transparent(&self) -> bool { self.flags.contains(ReprFlags::IS_TRANSPARENT) }
2123 pub fn linear(&self) -> bool { self.flags.contains(ReprFlags::IS_LINEAR) }
2125 pub fn discr_type(&self) -> attr::IntType {
2126 self.int.unwrap_or(attr::SignedInt(ast::IntTy::Isize))
2129 /// Returns `true` if this `#[repr()]` should inhabit "smart enum
2130 /// layout" optimizations, such as representing `Foo<&T>` as a
2132 pub fn inhibit_enum_layout_opt(&self) -> bool {
2133 self.c() || self.int.is_some()
2136 /// Returns `true` if this `#[repr()]` should inhibit struct field reordering
2137 /// optimizations, such as with `repr(C)`, `repr(packed(1))`, or `repr(<int>)`.
2138 pub fn inhibit_struct_field_reordering_opt(&self) -> bool {
2139 self.flags.intersects(ReprFlags::IS_UNOPTIMISABLE) || self.pack == 1 ||
2143 /// Returns `true` if this `#[repr()]` should inhibit union ABI optimisations.
2144 pub fn inhibit_union_abi_opt(&self) -> bool {
2150 impl<'a, 'gcx, 'tcx> AdtDef {
2151 /// Creates a new `AdtDef`.
2153 tcx: TyCtxt<'_, '_, '_>,
2156 variants: IndexVec<VariantIdx, VariantDef>,
2159 debug!("AdtDef::new({:?}, {:?}, {:?}, {:?})", did, kind, variants, repr);
2160 let mut flags = AdtFlags::NO_ADT_FLAGS;
2162 if kind == AdtKind::Enum && tcx.has_attr(did, "non_exhaustive") {
2163 debug!("found non-exhaustive variant list for {:?}", did);
2164 flags = flags | AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE;
2167 flags |= match kind {
2168 AdtKind::Enum => AdtFlags::IS_ENUM,
2169 AdtKind::Union => AdtFlags::IS_UNION,
2170 AdtKind::Struct => AdtFlags::IS_STRUCT,
2173 if kind == AdtKind::Struct && variants[VariantIdx::new(0)].ctor_def_id.is_some() {
2174 flags |= AdtFlags::HAS_CTOR;
2177 let attrs = tcx.get_attrs(did);
2178 if attr::contains_name(&attrs, "fundamental") {
2179 flags |= AdtFlags::IS_FUNDAMENTAL;
2181 if Some(did) == tcx.lang_items().phantom_data() {
2182 flags |= AdtFlags::IS_PHANTOM_DATA;
2184 if Some(did) == tcx.lang_items().owned_box() {
2185 flags |= AdtFlags::IS_BOX;
2187 if Some(did) == tcx.lang_items().arc() {
2188 flags |= AdtFlags::IS_ARC;
2190 if Some(did) == tcx.lang_items().rc() {
2191 flags |= AdtFlags::IS_RC;
2202 /// Returns `true` if this is a struct.
2204 pub fn is_struct(&self) -> bool {
2205 self.flags.contains(AdtFlags::IS_STRUCT)
2208 /// Returns `true` if this is a union.
2210 pub fn is_union(&self) -> bool {
2211 self.flags.contains(AdtFlags::IS_UNION)
2214 /// Returns `true` if this is a enum.
2216 pub fn is_enum(&self) -> bool {
2217 self.flags.contains(AdtFlags::IS_ENUM)
2220 /// Returns `true` if the variant list of this ADT is `#[non_exhaustive]`.
2222 pub fn is_variant_list_non_exhaustive(&self) -> bool {
2223 self.flags.contains(AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE)
2226 /// Returns the kind of the ADT.
2228 pub fn adt_kind(&self) -> AdtKind {
2231 } else if self.is_union() {
2238 /// Returns a description of this abstract data type.
2239 pub fn descr(&self) -> &'static str {
2240 match self.adt_kind() {
2241 AdtKind::Struct => "struct",
2242 AdtKind::Union => "union",
2243 AdtKind::Enum => "enum",
2247 /// Returns a description of a variant of this abstract data type.
2249 pub fn variant_descr(&self) -> &'static str {
2250 match self.adt_kind() {
2251 AdtKind::Struct => "struct",
2252 AdtKind::Union => "union",
2253 AdtKind::Enum => "variant",
2257 /// If this function returns `true`, it implies that `is_struct` must return `true`.
2259 pub fn has_ctor(&self) -> bool {
2260 self.flags.contains(AdtFlags::HAS_CTOR)
2263 /// Returns `true` if this type is `#[fundamental]` for the purposes
2264 /// of coherence checking.
2266 pub fn is_fundamental(&self) -> bool {
2267 self.flags.contains(AdtFlags::IS_FUNDAMENTAL)
2270 /// Returns `true` if this is `PhantomData<T>`.
2272 pub fn is_phantom_data(&self) -> bool {
2273 self.flags.contains(AdtFlags::IS_PHANTOM_DATA)
2276 /// Returns `true` if this is `Arc<T>`.
2277 pub fn is_arc(&self) -> bool {
2278 self.flags.contains(AdtFlags::IS_ARC)
2281 /// Returns `true` if this is `Rc<T>`.
2282 pub fn is_rc(&self) -> bool {
2283 self.flags.contains(AdtFlags::IS_RC)
2286 /// Returns `true` if this is Box<T>.
2288 pub fn is_box(&self) -> bool {
2289 self.flags.contains(AdtFlags::IS_BOX)
2292 /// Returns `true` if this type has a destructor.
2293 pub fn has_dtor(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> bool {
2294 self.destructor(tcx).is_some()
2297 /// Asserts this is a struct or union and returns its unique variant.
2298 pub fn non_enum_variant(&self) -> &VariantDef {
2299 assert!(self.is_struct() || self.is_union());
2300 &self.variants[VariantIdx::new(0)]
2304 pub fn predicates(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Lrc<GenericPredicates<'gcx>> {
2305 tcx.predicates_of(self.did)
2308 /// Returns an iterator over all fields contained
2311 pub fn all_fields<'s>(&'s self) -> impl Iterator<Item = &'s FieldDef> {
2312 self.variants.iter().flat_map(|v| v.fields.iter())
2315 pub fn is_payloadfree(&self) -> bool {
2316 !self.variants.is_empty() &&
2317 self.variants.iter().all(|v| v.fields.is_empty())
2320 /// Return a `VariantDef` given a variant id.
2321 pub fn variant_with_id(&self, vid: DefId) -> &VariantDef {
2322 self.variants.iter().find(|v| v.def_id == vid)
2323 .expect("variant_with_id: unknown variant")
2326 /// Return a `VariantDef` given a constructor id.
2327 pub fn variant_with_ctor_id(&self, cid: DefId) -> &VariantDef {
2328 self.variants.iter().find(|v| v.ctor_def_id == Some(cid))
2329 .expect("variant_with_ctor_id: unknown variant")
2332 /// Return the index of `VariantDef` given a variant id.
2333 pub fn variant_index_with_id(&self, vid: DefId) -> VariantIdx {
2334 self.variants.iter_enumerated().find(|(_, v)| v.def_id == vid)
2335 .expect("variant_index_with_id: unknown variant").0
2338 /// Return the index of `VariantDef` given a constructor id.
2339 pub fn variant_index_with_ctor_id(&self, cid: DefId) -> VariantIdx {
2340 self.variants.iter_enumerated().find(|(_, v)| v.ctor_def_id == Some(cid))
2341 .expect("variant_index_with_ctor_id: unknown variant").0
2344 pub fn variant_of_def(&self, def: Def) -> &VariantDef {
2346 Def::Variant(vid) => self.variant_with_id(vid),
2347 Def::Ctor(cid, ..) => self.variant_with_ctor_id(cid),
2348 Def::Struct(..) | Def::Union(..) |
2349 Def::TyAlias(..) | Def::AssociatedTy(..) | Def::SelfTy(..) |
2350 Def::SelfCtor(..) => self.non_enum_variant(),
2351 _ => bug!("unexpected def {:?} in variant_of_def", def)
2356 pub fn eval_explicit_discr(
2358 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2360 ) -> Option<Discr<'tcx>> {
2361 let param_env = ParamEnv::empty();
2362 let repr_type = self.repr.discr_type();
2363 let substs = InternalSubsts::identity_for_item(tcx.global_tcx(), expr_did);
2364 let instance = ty::Instance::new(expr_did, substs);
2365 let cid = GlobalId {
2369 match tcx.const_eval(param_env.and(cid)) {
2371 // FIXME: Find the right type and use it instead of `val.ty` here
2372 if let Some(b) = val.assert_bits(tcx.global_tcx(), param_env.and(val.ty)) {
2373 trace!("discriminants: {} ({:?})", b, repr_type);
2379 info!("invalid enum discriminant: {:#?}", val);
2380 crate::mir::interpret::struct_error(
2381 tcx.at(tcx.def_span(expr_did)),
2382 "constant evaluation of enum discriminant resulted in non-integer",
2387 Err(ErrorHandled::Reported) => {
2388 if !expr_did.is_local() {
2389 span_bug!(tcx.def_span(expr_did),
2390 "variant discriminant evaluation succeeded \
2391 in its crate but failed locally");
2395 Err(ErrorHandled::TooGeneric) => span_bug!(
2396 tcx.def_span(expr_did),
2397 "enum discriminant depends on generic arguments",
2403 pub fn discriminants(
2405 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2406 ) -> impl Iterator<Item=(VariantIdx, Discr<'tcx>)> + Captures<'gcx> + 'a {
2407 let repr_type = self.repr.discr_type();
2408 let initial = repr_type.initial_discriminant(tcx.global_tcx());
2409 let mut prev_discr = None::<Discr<'tcx>>;
2410 self.variants.iter_enumerated().map(move |(i, v)| {
2411 let mut discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
2412 if let VariantDiscr::Explicit(expr_did) = v.discr {
2413 if let Some(new_discr) = self.eval_explicit_discr(tcx, expr_did) {
2417 prev_discr = Some(discr);
2423 /// Computes the discriminant value used by a specific variant.
2424 /// Unlike `discriminants`, this is (amortized) constant-time,
2425 /// only doing at most one query for evaluating an explicit
2426 /// discriminant (the last one before the requested variant),
2427 /// assuming there are no constant-evaluation errors there.
2428 pub fn discriminant_for_variant(&self,
2429 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2430 variant_index: VariantIdx)
2432 let (val, offset) = self.discriminant_def_for_variant(variant_index);
2433 let explicit_value = val
2434 .and_then(|expr_did| self.eval_explicit_discr(tcx, expr_did))
2435 .unwrap_or_else(|| self.repr.discr_type().initial_discriminant(tcx.global_tcx()));
2436 explicit_value.checked_add(tcx, offset as u128).0
2439 /// Yields a `DefId` for the discriminant and an offset to add to it
2440 /// Alternatively, if there is no explicit discriminant, returns the
2441 /// inferred discriminant directly.
2442 pub fn discriminant_def_for_variant(
2444 variant_index: VariantIdx,
2445 ) -> (Option<DefId>, u32) {
2446 let mut explicit_index = variant_index.as_u32();
2449 match self.variants[VariantIdx::from_u32(explicit_index)].discr {
2450 ty::VariantDiscr::Relative(0) => {
2454 ty::VariantDiscr::Relative(distance) => {
2455 explicit_index -= distance;
2457 ty::VariantDiscr::Explicit(did) => {
2458 expr_did = Some(did);
2463 (expr_did, variant_index.as_u32() - explicit_index)
2466 pub fn destructor(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Option<Destructor> {
2467 tcx.adt_destructor(self.did)
2470 /// Returns a list of types such that `Self: Sized` if and only
2471 /// if that type is `Sized`, or `TyErr` if this type is recursive.
2473 /// Oddly enough, checking that the sized-constraint is `Sized` is
2474 /// actually more expressive than checking all members:
2475 /// the `Sized` trait is inductive, so an associated type that references
2476 /// `Self` would prevent its containing ADT from being `Sized`.
2478 /// Due to normalization being eager, this applies even if
2479 /// the associated type is behind a pointer (e.g., issue #31299).
2480 pub fn sized_constraint(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> &'tcx [Ty<'tcx>] {
2481 tcx.adt_sized_constraint(self.did).0
2484 fn sized_constraint_for_ty(&self,
2485 tcx: TyCtxt<'a, 'tcx, 'tcx>,
2488 let result = match ty.sty {
2489 Bool | Char | Int(..) | Uint(..) | Float(..) |
2490 RawPtr(..) | Ref(..) | FnDef(..) | FnPtr(_) |
2491 Array(..) | Closure(..) | Generator(..) | Never => {
2500 GeneratorWitness(..) => {
2501 // these are never sized - return the target type
2508 Some(ty) => self.sized_constraint_for_ty(tcx, ty)
2512 Adt(adt, substs) => {
2514 let adt_tys = adt.sized_constraint(tcx);
2515 debug!("sized_constraint_for_ty({:?}) intermediate = {:?}",
2518 .map(|ty| ty.subst(tcx, substs))
2519 .flat_map(|ty| self.sized_constraint_for_ty(tcx, ty))
2523 Projection(..) | Opaque(..) => {
2524 // must calculate explicitly.
2525 // FIXME: consider special-casing always-Sized projections
2529 UnnormalizedProjection(..) => bug!("only used with chalk-engine"),
2532 // perf hack: if there is a `T: Sized` bound, then
2533 // we know that `T` is Sized and do not need to check
2536 let sized_trait = match tcx.lang_items().sized_trait() {
2538 _ => return vec![ty]
2540 let sized_predicate = Binder::dummy(TraitRef {
2541 def_id: sized_trait,
2542 substs: tcx.mk_substs_trait(ty, &[])
2544 let predicates = &tcx.predicates_of(self.did).predicates;
2545 if predicates.iter().any(|(p, _)| *p == sized_predicate) {
2555 bug!("unexpected type `{:?}` in sized_constraint_for_ty",
2559 debug!("sized_constraint_for_ty({:?}) = {:?}", ty, result);
2564 impl<'a, 'gcx, 'tcx> FieldDef {
2565 pub fn ty(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, subst: SubstsRef<'tcx>) -> Ty<'tcx> {
2566 tcx.type_of(self.did).subst(tcx, subst)
2570 /// Represents the various closure traits in the language. This
2571 /// will determine the type of the environment (`self`, in the
2572 /// desugaring) argument that the closure expects.
2574 /// You can get the environment type of a closure using
2575 /// `tcx.closure_env_ty()`.
2576 #[derive(Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Hash, Debug,
2577 RustcEncodable, RustcDecodable, HashStable)]
2578 pub enum ClosureKind {
2579 // Warning: Ordering is significant here! The ordering is chosen
2580 // because the trait Fn is a subtrait of FnMut and so in turn, and
2581 // hence we order it so that Fn < FnMut < FnOnce.
2587 impl<'a, 'tcx> ClosureKind {
2588 // This is the initial value used when doing upvar inference.
2589 pub const LATTICE_BOTTOM: ClosureKind = ClosureKind::Fn;
2591 pub fn trait_did(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> DefId {
2593 ClosureKind::Fn => tcx.require_lang_item(FnTraitLangItem),
2594 ClosureKind::FnMut => {
2595 tcx.require_lang_item(FnMutTraitLangItem)
2597 ClosureKind::FnOnce => {
2598 tcx.require_lang_item(FnOnceTraitLangItem)
2603 /// Returns `true` if this a type that impls this closure kind
2604 /// must also implement `other`.
2605 pub fn extends(self, other: ty::ClosureKind) -> bool {
2606 match (self, other) {
2607 (ClosureKind::Fn, ClosureKind::Fn) => true,
2608 (ClosureKind::Fn, ClosureKind::FnMut) => true,
2609 (ClosureKind::Fn, ClosureKind::FnOnce) => true,
2610 (ClosureKind::FnMut, ClosureKind::FnMut) => true,
2611 (ClosureKind::FnMut, ClosureKind::FnOnce) => true,
2612 (ClosureKind::FnOnce, ClosureKind::FnOnce) => true,
2617 /// Returns the representative scalar type for this closure kind.
2618 /// See `TyS::to_opt_closure_kind` for more details.
2619 pub fn to_ty(self, tcx: TyCtxt<'_, '_, 'tcx>) -> Ty<'tcx> {
2621 ty::ClosureKind::Fn => tcx.types.i8,
2622 ty::ClosureKind::FnMut => tcx.types.i16,
2623 ty::ClosureKind::FnOnce => tcx.types.i32,
2628 impl<'tcx> TyS<'tcx> {
2629 /// Iterator that walks `self` and any types reachable from
2630 /// `self`, in depth-first order. Note that just walks the types
2631 /// that appear in `self`, it does not descend into the fields of
2632 /// structs or variants. For example:
2635 /// isize => { isize }
2636 /// Foo<Bar<isize>> => { Foo<Bar<isize>>, Bar<isize>, isize }
2637 /// [isize] => { [isize], isize }
2639 pub fn walk(&'tcx self) -> TypeWalker<'tcx> {
2640 TypeWalker::new(self)
2643 /// Iterator that walks the immediate children of `self`. Hence
2644 /// `Foo<Bar<i32>, u32>` yields the sequence `[Bar<i32>, u32]`
2645 /// (but not `i32`, like `walk`).
2646 pub fn walk_shallow(&'tcx self) -> smallvec::IntoIter<walk::TypeWalkerArray<'tcx>> {
2647 walk::walk_shallow(self)
2650 /// Walks `ty` and any types appearing within `ty`, invoking the
2651 /// callback `f` on each type. If the callback returns `false`, then the
2652 /// children of the current type are ignored.
2654 /// Note: prefer `ty.walk()` where possible.
2655 pub fn maybe_walk<F>(&'tcx self, mut f: F)
2656 where F: FnMut(Ty<'tcx>) -> bool
2658 let mut walker = self.walk();
2659 while let Some(ty) = walker.next() {
2661 walker.skip_current_subtree();
2668 pub fn from_mutbl(m: hir::Mutability) -> BorrowKind {
2670 hir::MutMutable => MutBorrow,
2671 hir::MutImmutable => ImmBorrow,
2675 /// Returns a mutability `m` such that an `&m T` pointer could be used to obtain this borrow
2676 /// kind. Because borrow kinds are richer than mutabilities, we sometimes have to pick a
2677 /// mutability that is stronger than necessary so that it at least *would permit* the borrow in
2679 pub fn to_mutbl_lossy(self) -> hir::Mutability {
2681 MutBorrow => hir::MutMutable,
2682 ImmBorrow => hir::MutImmutable,
2684 // We have no type corresponding to a unique imm borrow, so
2685 // use `&mut`. It gives all the capabilities of an `&uniq`
2686 // and hence is a safe "over approximation".
2687 UniqueImmBorrow => hir::MutMutable,
2691 pub fn to_user_str(&self) -> &'static str {
2693 MutBorrow => "mutable",
2694 ImmBorrow => "immutable",
2695 UniqueImmBorrow => "uniquely immutable",
2700 #[derive(Debug, Clone)]
2701 pub enum Attributes<'gcx> {
2702 Owned(Lrc<[ast::Attribute]>),
2703 Borrowed(&'gcx [ast::Attribute])
2706 impl<'gcx> ::std::ops::Deref for Attributes<'gcx> {
2707 type Target = [ast::Attribute];
2709 fn deref(&self) -> &[ast::Attribute] {
2711 &Attributes::Owned(ref data) => &data,
2712 &Attributes::Borrowed(data) => data
2717 #[derive(Debug, PartialEq, Eq)]
2718 pub enum ImplOverlapKind {
2719 /// These impls are always allowed to overlap.
2721 /// These impls are allowed to overlap, but that raises
2722 /// an issue #33140 future-compatibility warning.
2724 /// Some background: in Rust 1.0, the trait-object types `Send + Sync` (today's
2725 /// `dyn Send + Sync`) and `Sync + Send` (now `dyn Sync + Send`) were different.
2727 /// The widely-used version 0.1.0 of the crate `traitobject` had accidentally relied
2728 /// that difference, making what reduces to the following set of impls:
2732 /// impl Trait for dyn Send + Sync {}
2733 /// impl Trait for dyn Sync + Send {}
2736 /// Obviously, once we made these types be identical, that code causes a coherence
2737 /// error and a fairly big headache for us. However, luckily for us, the trait
2738 /// `Trait` used in this case is basically a marker trait, and therefore having
2739 /// overlapping impls for it is sound.
2741 /// To handle this, we basically regard the trait as a marker trait, with an additional
2742 /// future-compatibility warning. To avoid accidentally "stabilizing" this feature,
2743 /// it has the following restrictions:
2745 /// 1. The trait must indeed be a marker-like trait (i.e., no items), and must be
2747 /// 2. The trait-ref of both impls must be equal.
2748 /// 3. The trait-ref of both impls must be a trait object type consisting only of
2750 /// 4. Neither of the impls can have any where-clauses.
2752 /// Once `traitobject` 0.1.0 is no longer an active concern, this hack can be removed.
2756 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
2757 pub fn body_tables(self, body: hir::BodyId) -> &'gcx TypeckTables<'gcx> {
2758 self.typeck_tables_of(self.hir().body_owner_def_id(body))
2761 /// Returns an iterator of the `DefId`s for all body-owners in this
2762 /// crate. If you would prefer to iterate over the bodies
2763 /// themselves, you can do `self.hir().krate().body_ids.iter()`.
2766 ) -> impl Iterator<Item = DefId> + Captures<'tcx> + Captures<'gcx> + 'a {
2770 .map(move |&body_id| self.hir().body_owner_def_id(body_id))
2773 pub fn par_body_owners<F: Fn(DefId) + sync::Sync + sync::Send>(self, f: F) {
2774 par_iter(&self.hir().krate().body_ids).for_each(|&body_id| {
2775 f(self.hir().body_owner_def_id(body_id))
2779 pub fn expr_span(self, id: NodeId) -> Span {
2780 match self.hir().find(id) {
2781 Some(Node::Expr(e)) => {
2785 bug!("Node id {} is not an expr: {:?}", id, f);
2788 bug!("Node id {} is not present in the node map", id);
2793 pub fn provided_trait_methods(self, id: DefId) -> Vec<AssociatedItem> {
2794 self.associated_items(id)
2795 .filter(|item| item.kind == AssociatedKind::Method && item.defaultness.has_value())
2799 pub fn trait_relevant_for_never(self, did: DefId) -> bool {
2800 self.associated_items(did).any(|item| {
2801 item.relevant_for_never()
2805 pub fn opt_associated_item(self, def_id: DefId) -> Option<AssociatedItem> {
2806 let is_associated_item = if let Some(hir_id) = self.hir().as_local_hir_id(def_id) {
2807 match self.hir().get_by_hir_id(hir_id) {
2808 Node::TraitItem(_) | Node::ImplItem(_) => true,
2812 match self.describe_def(def_id).expect("no def for def-id") {
2813 Def::AssociatedConst(_) | Def::Method(_) | Def::AssociatedTy(_) => true,
2818 if is_associated_item {
2819 Some(self.associated_item(def_id))
2825 fn associated_item_from_trait_item_ref(self,
2826 parent_def_id: DefId,
2827 parent_vis: &hir::Visibility,
2828 trait_item_ref: &hir::TraitItemRef)
2830 let def_id = self.hir().local_def_id_from_hir_id(trait_item_ref.id.hir_id);
2831 let (kind, has_self) = match trait_item_ref.kind {
2832 hir::AssociatedItemKind::Const => (ty::AssociatedKind::Const, false),
2833 hir::AssociatedItemKind::Method { has_self } => {
2834 (ty::AssociatedKind::Method, has_self)
2836 hir::AssociatedItemKind::Type => (ty::AssociatedKind::Type, false),
2837 hir::AssociatedItemKind::Existential => bug!("only impls can have existentials"),
2841 ident: trait_item_ref.ident,
2843 // Visibility of trait items is inherited from their traits.
2844 vis: Visibility::from_hir(parent_vis, trait_item_ref.id.hir_id, self),
2845 defaultness: trait_item_ref.defaultness,
2847 container: TraitContainer(parent_def_id),
2848 method_has_self_argument: has_self
2852 fn associated_item_from_impl_item_ref(self,
2853 parent_def_id: DefId,
2854 impl_item_ref: &hir::ImplItemRef)
2856 let def_id = self.hir().local_def_id_from_hir_id(impl_item_ref.id.hir_id);
2857 let (kind, has_self) = match impl_item_ref.kind {
2858 hir::AssociatedItemKind::Const => (ty::AssociatedKind::Const, false),
2859 hir::AssociatedItemKind::Method { has_self } => {
2860 (ty::AssociatedKind::Method, has_self)
2862 hir::AssociatedItemKind::Type => (ty::AssociatedKind::Type, false),
2863 hir::AssociatedItemKind::Existential => (ty::AssociatedKind::Existential, false),
2867 ident: impl_item_ref.ident,
2869 // Visibility of trait impl items doesn't matter.
2870 vis: ty::Visibility::from_hir(&impl_item_ref.vis, impl_item_ref.id.hir_id, self),
2871 defaultness: impl_item_ref.defaultness,
2873 container: ImplContainer(parent_def_id),
2874 method_has_self_argument: has_self
2878 pub fn field_index(self, hir_id: hir::HirId, tables: &TypeckTables<'_>) -> usize {
2879 tables.field_indices().get(hir_id).cloned().expect("no index for a field")
2882 pub fn find_field_index(self, ident: Ident, variant: &VariantDef) -> Option<usize> {
2883 variant.fields.iter().position(|field| {
2884 self.adjust_ident(ident, variant.def_id, hir::DUMMY_HIR_ID).0 == field.ident.modern()
2888 pub fn associated_items(
2891 ) -> AssociatedItemsIterator<'a, 'gcx, 'tcx> {
2892 // Ideally, we would use `-> impl Iterator` here, but it falls
2893 // afoul of the conservative "capture [restrictions]" we put
2894 // in place, so we use a hand-written iterator.
2896 // [restrictions]: https://github.com/rust-lang/rust/issues/34511#issuecomment-373423999
2897 AssociatedItemsIterator {
2899 def_ids: self.associated_item_def_ids(def_id),
2904 /// Returns `true` if the impls are the same polarity and the trait either
2905 /// has no items or is annotated #[marker] and prevents item overrides.
2906 pub fn impls_are_allowed_to_overlap(self, def_id1: DefId, def_id2: DefId)
2907 -> Option<ImplOverlapKind>
2909 let is_legit = if self.features().overlapping_marker_traits {
2910 let trait1_is_empty = self.impl_trait_ref(def_id1)
2911 .map_or(false, |trait_ref| {
2912 self.associated_item_def_ids(trait_ref.def_id).is_empty()
2914 let trait2_is_empty = self.impl_trait_ref(def_id2)
2915 .map_or(false, |trait_ref| {
2916 self.associated_item_def_ids(trait_ref.def_id).is_empty()
2918 self.impl_polarity(def_id1) == self.impl_polarity(def_id2)
2922 let is_marker_impl = |def_id: DefId| -> bool {
2923 let trait_ref = self.impl_trait_ref(def_id);
2924 trait_ref.map_or(false, |tr| self.trait_def(tr.def_id).is_marker)
2926 self.impl_polarity(def_id1) == self.impl_polarity(def_id2)
2927 && is_marker_impl(def_id1)
2928 && is_marker_impl(def_id2)
2932 debug!("impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted)",
2934 Some(ImplOverlapKind::Permitted)
2936 if let Some(self_ty1) = self.issue33140_self_ty(def_id1) {
2937 if let Some(self_ty2) = self.issue33140_self_ty(def_id2) {
2938 if self_ty1 == self_ty2 {
2939 debug!("impls_are_allowed_to_overlap({:?}, {:?}) - issue #33140 HACK",
2941 return Some(ImplOverlapKind::Issue33140);
2943 debug!("impls_are_allowed_to_overlap({:?}, {:?}) - found {:?} != {:?}",
2944 def_id1, def_id2, self_ty1, self_ty2);
2949 debug!("impls_are_allowed_to_overlap({:?}, {:?}) = None",
2955 /// Returns `ty::VariantDef` if `def` refers to a struct,
2956 /// or variant or their constructors, panics otherwise.
2957 pub fn expect_variant_def(self, def: Def) -> &'tcx VariantDef {
2959 Def::Variant(did) => {
2960 let enum_did = self.parent(did).unwrap();
2961 self.adt_def(enum_did).variant_with_id(did)
2963 Def::Struct(did) | Def::Union(did) => {
2964 self.adt_def(did).non_enum_variant()
2966 Def::Ctor(variant_ctor_did, CtorOf::Variant, ..) => {
2967 let variant_did = self.parent(variant_ctor_did).unwrap();
2968 let enum_did = self.parent(variant_did).unwrap();
2969 self.adt_def(enum_did).variant_with_ctor_id(variant_ctor_did)
2971 Def::Ctor(ctor_did, CtorOf::Struct, ..) => {
2972 let struct_did = self.parent(ctor_did).expect("struct ctor has no parent");
2973 self.adt_def(struct_did).non_enum_variant()
2975 _ => bug!("expect_variant_def used with unexpected def {:?}", def)
2979 pub fn item_name(self, id: DefId) -> InternedString {
2980 if id.index == CRATE_DEF_INDEX {
2981 self.original_crate_name(id.krate).as_interned_str()
2983 let def_key = self.def_key(id);
2984 match def_key.disambiguated_data.data {
2985 // The name of a constructor is that of its parent.
2986 hir_map::DefPathData::Ctor =>
2987 self.item_name(DefId {
2989 index: def_key.parent.unwrap()
2991 _ => def_key.disambiguated_data.data.get_opt_name().unwrap_or_else(|| {
2992 bug!("item_name: no name for {:?}", self.def_path(id));
2998 /// Returns the possibly-auto-generated MIR of a `(DefId, Subst)` pair.
2999 pub fn instance_mir(self, instance: ty::InstanceDef<'gcx>)
3003 ty::InstanceDef::Item(did) => {
3004 self.optimized_mir(did)
3006 ty::InstanceDef::VtableShim(..) |
3007 ty::InstanceDef::Intrinsic(..) |
3008 ty::InstanceDef::FnPtrShim(..) |
3009 ty::InstanceDef::Virtual(..) |
3010 ty::InstanceDef::ClosureOnceShim { .. } |
3011 ty::InstanceDef::DropGlue(..) |
3012 ty::InstanceDef::CloneShim(..) => {
3013 self.mir_shims(instance)
3018 /// Gets the attributes of a definition.
3019 pub fn get_attrs(self, did: DefId) -> Attributes<'gcx> {
3020 if let Some(id) = self.hir().as_local_hir_id(did) {
3021 Attributes::Borrowed(self.hir().attrs_by_hir_id(id))
3023 Attributes::Owned(self.item_attrs(did))
3027 /// Determines whether an item is annotated with an attribute.
3028 pub fn has_attr(self, did: DefId, attr: &str) -> bool {
3029 attr::contains_name(&self.get_attrs(did), attr)
3032 /// Returns `true` if this is an `auto trait`.
3033 pub fn trait_is_auto(self, trait_def_id: DefId) -> bool {
3034 self.trait_def(trait_def_id).has_auto_impl
3037 pub fn generator_layout(self, def_id: DefId) -> &'tcx GeneratorLayout<'tcx> {
3038 self.optimized_mir(def_id).generator_layout.as_ref().unwrap()
3041 /// Given the `DefId` of an impl, returns the `DefId` of the trait it implements.
3042 /// If it implements no trait, returns `None`.
3043 pub fn trait_id_of_impl(self, def_id: DefId) -> Option<DefId> {
3044 self.impl_trait_ref(def_id).map(|tr| tr.def_id)
3047 /// If the given defid describes a method belonging to an impl, returns the
3048 /// `DefId` of the impl that the method belongs to; otherwise, returns `None`.
3049 pub fn impl_of_method(self, def_id: DefId) -> Option<DefId> {
3050 let item = if def_id.krate != LOCAL_CRATE {
3051 if let Some(Def::Method(_)) = self.describe_def(def_id) {
3052 Some(self.associated_item(def_id))
3057 self.opt_associated_item(def_id)
3060 item.and_then(|trait_item|
3061 match trait_item.container {
3062 TraitContainer(_) => None,
3063 ImplContainer(def_id) => Some(def_id),
3068 /// Looks up the span of `impl_did` if the impl is local; otherwise returns `Err`
3069 /// with the name of the crate containing the impl.
3070 pub fn span_of_impl(self, impl_did: DefId) -> Result<Span, Symbol> {
3071 if impl_did.is_local() {
3072 let hir_id = self.hir().as_local_hir_id(impl_did).unwrap();
3073 Ok(self.hir().span_by_hir_id(hir_id))
3075 Err(self.crate_name(impl_did.krate))
3079 /// Hygienically compares a use-site name (`use_name`) for a field or an associated item with
3080 /// its supposed definition name (`def_name`). The method also needs `DefId` of the supposed
3081 /// definition's parent/scope to perform comparison.
3082 pub fn hygienic_eq(self, use_name: Ident, def_name: Ident, def_parent_def_id: DefId) -> bool {
3083 self.adjust_ident(use_name, def_parent_def_id, hir::DUMMY_HIR_ID).0 == def_name.modern()
3086 pub fn adjust_ident(self, mut ident: Ident, scope: DefId, block: hir::HirId) -> (Ident, DefId) {
3087 ident = ident.modern();
3088 let target_expansion = match scope.krate {
3089 LOCAL_CRATE => self.hir().definitions().expansion_that_defined(scope.index),
3092 let scope = match ident.span.adjust(target_expansion) {
3093 Some(actual_expansion) =>
3094 self.hir().definitions().parent_module_of_macro_def(actual_expansion),
3095 None if block == hir::DUMMY_HIR_ID => DefId::local(CRATE_DEF_INDEX), // Dummy DefId
3096 None => self.hir().get_module_parent_by_hir_id(block),
3102 pub struct AssociatedItemsIterator<'a, 'gcx: 'tcx, 'tcx: 'a> {
3103 tcx: TyCtxt<'a, 'gcx, 'tcx>,
3104 def_ids: Lrc<Vec<DefId>>,
3108 impl Iterator for AssociatedItemsIterator<'_, '_, '_> {
3109 type Item = AssociatedItem;
3111 fn next(&mut self) -> Option<AssociatedItem> {
3112 let def_id = self.def_ids.get(self.next_index)?;
3113 self.next_index += 1;
3114 Some(self.tcx.associated_item(*def_id))
3118 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
3119 pub fn with_freevars<T, F>(self, fid: HirId, f: F) -> T where
3120 F: FnOnce(&[hir::Freevar]) -> T,
3122 let def_id = self.hir().local_def_id_from_hir_id(fid);
3123 match self.freevars(def_id) {
3130 fn associated_item<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> AssociatedItem {
3131 let id = tcx.hir().as_local_hir_id(def_id).unwrap();
3132 let parent_id = tcx.hir().get_parent_item(id);
3133 let parent_def_id = tcx.hir().local_def_id_from_hir_id(parent_id);
3134 let parent_item = tcx.hir().expect_item_by_hir_id(parent_id);
3135 match parent_item.node {
3136 hir::ItemKind::Impl(.., ref impl_item_refs) => {
3137 if let Some(impl_item_ref) = impl_item_refs.iter().find(|i| i.id.hir_id == id) {
3138 let assoc_item = tcx.associated_item_from_impl_item_ref(parent_def_id,
3140 debug_assert_eq!(assoc_item.def_id, def_id);
3145 hir::ItemKind::Trait(.., ref trait_item_refs) => {
3146 if let Some(trait_item_ref) = trait_item_refs.iter().find(|i| i.id.hir_id == id) {
3147 let assoc_item = tcx.associated_item_from_trait_item_ref(parent_def_id,
3150 debug_assert_eq!(assoc_item.def_id, def_id);
3158 span_bug!(parent_item.span,
3159 "unexpected parent of trait or impl item or item not found: {:?}",
3163 #[derive(Clone, HashStable)]
3164 pub struct AdtSizedConstraint<'tcx>(pub &'tcx [Ty<'tcx>]);
3166 /// Calculates the `Sized` constraint.
3168 /// In fact, there are only a few options for the types in the constraint:
3169 /// - an obviously-unsized type
3170 /// - a type parameter or projection whose Sizedness can't be known
3171 /// - a tuple of type parameters or projections, if there are multiple
3173 /// - a Error, if a type contained itself. The representability
3174 /// check should catch this case.
3175 fn adt_sized_constraint<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3177 -> AdtSizedConstraint<'tcx> {
3178 let def = tcx.adt_def(def_id);
3180 let result = tcx.mk_type_list(def.variants.iter().flat_map(|v| {
3183 def.sized_constraint_for_ty(tcx, tcx.type_of(f.did))
3186 debug!("adt_sized_constraint: {:?} => {:?}", def, result);
3188 AdtSizedConstraint(result)
3191 fn associated_item_def_ids<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3193 -> Lrc<Vec<DefId>> {
3194 let id = tcx.hir().as_local_hir_id(def_id).unwrap();
3195 let item = tcx.hir().expect_item_by_hir_id(id);
3196 let vec: Vec<_> = match item.node {
3197 hir::ItemKind::Trait(.., ref trait_item_refs) => {
3198 trait_item_refs.iter()
3199 .map(|trait_item_ref| trait_item_ref.id)
3200 .map(|id| tcx.hir().local_def_id_from_hir_id(id.hir_id))
3203 hir::ItemKind::Impl(.., ref impl_item_refs) => {
3204 impl_item_refs.iter()
3205 .map(|impl_item_ref| impl_item_ref.id)
3206 .map(|id| tcx.hir().local_def_id_from_hir_id(id.hir_id))
3209 hir::ItemKind::TraitAlias(..) => vec![],
3210 _ => span_bug!(item.span, "associated_item_def_ids: not impl or trait")
3215 fn def_span<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> Span {
3216 tcx.hir().span_if_local(def_id).unwrap()
3219 /// If the given `DefId` describes an item belonging to a trait,
3220 /// returns the `DefId` of the trait that the trait item belongs to;
3221 /// otherwise, returns `None`.
3222 fn trait_of_item<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> Option<DefId> {
3223 tcx.opt_associated_item(def_id)
3224 .and_then(|associated_item| {
3225 match associated_item.container {
3226 TraitContainer(def_id) => Some(def_id),
3227 ImplContainer(_) => None
3232 /// Yields the parent function's `DefId` if `def_id` is an `impl Trait` definition.
3233 pub fn is_impl_trait_defn(tcx: TyCtxt<'_, '_, '_>, def_id: DefId) -> Option<DefId> {
3234 if let Some(hir_id) = tcx.hir().as_local_hir_id(def_id) {
3235 if let Node::Item(item) = tcx.hir().get_by_hir_id(hir_id) {
3236 if let hir::ItemKind::Existential(ref exist_ty) = item.node {
3237 return exist_ty.impl_trait_fn;
3244 /// See `ParamEnv` struct definition for details.
3245 fn param_env<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3249 // The param_env of an impl Trait type is its defining function's param_env
3250 if let Some(parent) = is_impl_trait_defn(tcx, def_id) {
3251 return param_env(tcx, parent);
3253 // Compute the bounds on Self and the type parameters.
3255 let InstantiatedPredicates { predicates } =
3256 tcx.predicates_of(def_id).instantiate_identity(tcx);
3258 // Finally, we have to normalize the bounds in the environment, in
3259 // case they contain any associated type projections. This process
3260 // can yield errors if the put in illegal associated types, like
3261 // `<i32 as Foo>::Bar` where `i32` does not implement `Foo`. We
3262 // report these errors right here; this doesn't actually feel
3263 // right to me, because constructing the environment feels like a
3264 // kind of a "idempotent" action, but I'm not sure where would be
3265 // a better place. In practice, we construct environments for
3266 // every fn once during type checking, and we'll abort if there
3267 // are any errors at that point, so after type checking you can be
3268 // sure that this will succeed without errors anyway.
3270 let unnormalized_env = ty::ParamEnv::new(
3271 tcx.intern_predicates(&predicates),
3272 traits::Reveal::UserFacing,
3273 if tcx.sess.opts.debugging_opts.chalk { Some(def_id) } else { None }
3276 let body_id = tcx.hir().as_local_hir_id(def_id).map_or(hir::DUMMY_HIR_ID, |id| {
3277 tcx.hir().maybe_body_owned_by_by_hir_id(id).map_or(id, |body| body.hir_id)
3279 let cause = traits::ObligationCause::misc(tcx.def_span(def_id), body_id);
3280 traits::normalize_param_env_or_error(tcx, def_id, unnormalized_env, cause)
3283 fn crate_disambiguator<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3284 crate_num: CrateNum) -> CrateDisambiguator {
3285 assert_eq!(crate_num, LOCAL_CRATE);
3286 tcx.sess.local_crate_disambiguator()
3289 fn original_crate_name<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3290 crate_num: CrateNum) -> Symbol {
3291 assert_eq!(crate_num, LOCAL_CRATE);
3292 tcx.crate_name.clone()
3295 fn crate_hash<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3296 crate_num: CrateNum)
3298 assert_eq!(crate_num, LOCAL_CRATE);
3299 tcx.hir().crate_hash
3302 fn instance_def_size_estimate<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3303 instance_def: InstanceDef<'tcx>)
3305 match instance_def {
3306 InstanceDef::Item(..) |
3307 InstanceDef::DropGlue(..) => {
3308 let mir = tcx.instance_mir(instance_def);
3309 mir.basic_blocks().iter().map(|bb| bb.statements.len()).sum()
3311 // Estimate the size of other compiler-generated shims to be 1.
3316 /// If `def_id` is an issue 33140 hack impl, returns its self type; otherwise, returns `None`.
3318 /// See [`ImplOverlapKind::Issue33140`] for more details.
3319 fn issue33140_self_ty<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3323 debug!("issue33140_self_ty({:?})", def_id);
3325 let trait_ref = tcx.impl_trait_ref(def_id).unwrap_or_else(|| {
3326 bug!("issue33140_self_ty called on inherent impl {:?}", def_id)
3329 debug!("issue33140_self_ty({:?}), trait-ref={:?}", def_id, trait_ref);
3331 let is_marker_like =
3332 tcx.impl_polarity(def_id) == hir::ImplPolarity::Positive &&
3333 tcx.associated_item_def_ids(trait_ref.def_id).is_empty();
3335 // Check whether these impls would be ok for a marker trait.
3336 if !is_marker_like {
3337 debug!("issue33140_self_ty - not marker-like!");
3341 // impl must be `impl Trait for dyn Marker1 + Marker2 + ...`
3342 if trait_ref.substs.len() != 1 {
3343 debug!("issue33140_self_ty - impl has substs!");
3347 let predicates = tcx.predicates_of(def_id);
3348 if predicates.parent.is_some() || !predicates.predicates.is_empty() {
3349 debug!("issue33140_self_ty - impl has predicates {:?}!", predicates);
3353 let self_ty = trait_ref.self_ty();
3354 let self_ty_matches = match self_ty.sty {
3355 ty::Dynamic(ref data, ty::ReStatic) => data.principal().is_none(),
3359 if self_ty_matches {
3360 debug!("issue33140_self_ty - MATCHES!");
3363 debug!("issue33140_self_ty - non-matching self type");
3368 pub fn provide(providers: &mut ty::query::Providers<'_>) {
3369 context::provide(providers);
3370 erase_regions::provide(providers);
3371 layout::provide(providers);
3372 util::provide(providers);
3373 constness::provide(providers);
3374 *providers = ty::query::Providers {
3376 associated_item_def_ids,
3377 adt_sized_constraint,
3381 crate_disambiguator,
3382 original_crate_name,
3384 trait_impls_of: trait_def::trait_impls_of_provider,
3385 instance_def_size_estimate,
3391 /// A map for the local crate mapping each type to a vector of its
3392 /// inherent impls. This is not meant to be used outside of coherence;
3393 /// rather, you should request the vector for a specific type via
3394 /// `tcx.inherent_impls(def_id)` so as to minimize your dependencies
3395 /// (constructing this map requires touching the entire crate).
3396 #[derive(Clone, Debug, Default, HashStable)]
3397 pub struct CrateInherentImpls {
3398 pub inherent_impls: DefIdMap<Lrc<Vec<DefId>>>,
3401 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable)]
3402 pub struct SymbolName {
3403 // FIXME: we don't rely on interning or equality here - better have
3404 // this be a `&'tcx str`.
3405 pub name: InternedString
3408 impl_stable_hash_for!(struct self::SymbolName {
3413 pub fn new(name: &str) -> SymbolName {
3415 name: Symbol::intern(name).as_interned_str()
3419 pub fn as_str(&self) -> LocalInternedString {
3424 impl fmt::Display for SymbolName {
3425 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3426 fmt::Display::fmt(&self.name, fmt)
3430 impl fmt::Debug for SymbolName {
3431 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3432 fmt::Display::fmt(&self.name, fmt)