1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! misc. type-system utilities too small to deserve their own file
14 use hir::def_id::DefId;
15 use hir::map::{DefPathData, Node};
17 use ich::NodeIdHashingMode;
18 use traits::{self, ObligationCause};
19 use ty::{self, Ty, TyCtxt, GenericParamDefKind, TypeFoldable};
20 use ty::subst::{Substs, UnpackedKind};
21 use ty::query::TyCtxtAt;
22 use ty::TypeVariants::*;
23 use ty::layout::{Integer, IntegerExt};
24 use util::common::ErrorReported;
25 use middle::lang_items;
27 use rustc_data_structures::stable_hasher::{StableHasher, HashStable};
28 use rustc_data_structures::fx::FxHashMap;
31 use syntax::attr::{self, SignedInt, UnsignedInt};
32 use syntax_pos::{Span, DUMMY_SP};
34 #[derive(Copy, Clone, Debug)]
35 pub struct Discr<'tcx> {
36 /// bit representation of the discriminant, so `-128i8` is `0xFF_u128`
41 impl<'tcx> fmt::Display for Discr<'tcx> {
42 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
45 let bits = ty::tls::with(|tcx| {
46 Integer::from_attr(tcx, SignedInt(ity)).size().bits()
48 let x = self.val as i128;
49 // sign extend the raw representation to be an i128
50 let x = (x << (128 - bits)) >> (128 - bits);
53 _ => write!(fmt, "{}", self.val),
58 impl<'tcx> Discr<'tcx> {
59 /// Adds 1 to the value and wraps around if the maximum for the type is reached
60 pub fn wrap_incr<'a, 'gcx>(self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Self {
61 self.checked_add(tcx, 1).0
63 pub fn checked_add<'a, 'gcx>(self, tcx: TyCtxt<'a, 'gcx, 'tcx>, n: u128) -> (Self, bool) {
64 let (int, signed) = match self.ty.sty {
65 TyInt(ity) => (Integer::from_attr(tcx, SignedInt(ity)), true),
66 TyUint(uty) => (Integer::from_attr(tcx, UnsignedInt(uty)), false),
67 _ => bug!("non integer discriminant"),
70 let bit_size = int.size().bits();
71 let shift = 128 - bit_size;
77 let min = sext(1_u128 << (bit_size - 1));
78 let max = i128::max_value() >> shift;
79 let val = sext(self.val);
80 assert!(n < (i128::max_value() as u128));
82 let oflo = val > max - n;
84 min + (n - (max - val) - 1)
88 // zero the upper bits
89 let val = val as u128;
90 let val = (val << shift) >> shift;
96 let max = u128::max_value() >> shift;
98 let oflo = val > max - n;
112 pub trait IntTypeExt {
113 fn to_ty<'a, 'gcx, 'tcx>(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Ty<'tcx>;
114 fn disr_incr<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, val: Option<Discr<'tcx>>)
115 -> Option<Discr<'tcx>>;
116 fn initial_discriminant<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Discr<'tcx>;
119 impl IntTypeExt for attr::IntType {
120 fn to_ty<'a, 'gcx, 'tcx>(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Ty<'tcx> {
122 SignedInt(ast::IntTy::I8) => tcx.types.i8,
123 SignedInt(ast::IntTy::I16) => tcx.types.i16,
124 SignedInt(ast::IntTy::I32) => tcx.types.i32,
125 SignedInt(ast::IntTy::I64) => tcx.types.i64,
126 SignedInt(ast::IntTy::I128) => tcx.types.i128,
127 SignedInt(ast::IntTy::Isize) => tcx.types.isize,
128 UnsignedInt(ast::UintTy::U8) => tcx.types.u8,
129 UnsignedInt(ast::UintTy::U16) => tcx.types.u16,
130 UnsignedInt(ast::UintTy::U32) => tcx.types.u32,
131 UnsignedInt(ast::UintTy::U64) => tcx.types.u64,
132 UnsignedInt(ast::UintTy::U128) => tcx.types.u128,
133 UnsignedInt(ast::UintTy::Usize) => tcx.types.usize,
137 fn initial_discriminant<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Discr<'tcx> {
144 fn disr_incr<'a, 'tcx>(
146 tcx: TyCtxt<'a, 'tcx, 'tcx>,
147 val: Option<Discr<'tcx>>,
148 ) -> Option<Discr<'tcx>> {
149 if let Some(val) = val {
150 assert_eq!(self.to_ty(tcx), val.ty);
151 let (new, oflo) = val.checked_add(tcx, 1);
158 Some(self.initial_discriminant(tcx))
165 pub enum CopyImplementationError<'tcx> {
166 InfrigingFields(Vec<&'tcx ty::FieldDef>),
171 /// Describes whether a type is representable. For types that are not
172 /// representable, 'SelfRecursive' and 'ContainsRecursive' are used to
173 /// distinguish between types that are recursive with themselves and types that
174 /// contain a different recursive type. These cases can therefore be treated
175 /// differently when reporting errors.
177 /// The ordering of the cases is significant. They are sorted so that cmp::max
178 /// will keep the "more erroneous" of two values.
179 #[derive(Clone, PartialOrd, Ord, Eq, PartialEq, Debug)]
180 pub enum Representability {
183 SelfRecursive(Vec<Span>),
186 impl<'tcx> ty::ParamEnv<'tcx> {
187 pub fn can_type_implement_copy<'a>(self,
188 tcx: TyCtxt<'a, 'tcx, 'tcx>,
190 -> Result<(), CopyImplementationError<'tcx>> {
191 // FIXME: (@jroesch) float this code up
192 tcx.infer_ctxt().enter(|infcx| {
193 let (adt, substs) = match self_type.sty {
194 // These types used to have a builtin impl.
195 // Now libcore provides that impl.
196 ty::TyUint(_) | ty::TyInt(_) | ty::TyBool | ty::TyFloat(_) |
197 ty::TyChar | ty::TyRawPtr(..) | ty::TyNever |
198 ty::TyRef(_, _, hir::MutImmutable) => return Ok(()),
200 ty::TyAdt(adt, substs) => (adt, substs),
202 _ => return Err(CopyImplementationError::NotAnAdt),
205 let mut infringing = Vec::new();
206 for variant in &adt.variants {
207 for field in &variant.fields {
208 let span = tcx.def_span(field.did);
209 let ty = field.ty(tcx, substs);
210 if ty.references_error() {
213 let cause = ObligationCause { span, ..ObligationCause::dummy() };
214 let ctx = traits::FulfillmentContext::new();
215 match traits::fully_normalize(&infcx, ctx, cause, self, &ty) {
216 Ok(ty) => if infcx.type_moves_by_default(self, ty, span) {
217 infringing.push(field);
220 infcx.report_fulfillment_errors(&errors, None, false);
225 if !infringing.is_empty() {
226 return Err(CopyImplementationError::InfrigingFields(infringing));
228 if adt.has_dtor(tcx) {
229 return Err(CopyImplementationError::HasDestructor);
237 impl<'a, 'tcx> TyCtxt<'a, 'tcx, 'tcx> {
238 /// Creates a hash of the type `Ty` which will be the same no matter what crate
239 /// context it's calculated within. This is used by the `type_id` intrinsic.
240 pub fn type_id_hash(self, ty: Ty<'tcx>) -> u64 {
241 let mut hasher = StableHasher::new();
242 let mut hcx = self.create_stable_hashing_context();
244 // We want the type_id be independent of the types free regions, so we
245 // erase them. The erase_regions() call will also anonymize bound
246 // regions, which is desirable too.
247 let ty = self.erase_regions(&ty);
249 hcx.while_hashing_spans(false, |hcx| {
250 hcx.with_node_id_hashing_mode(NodeIdHashingMode::HashDefPath, |hcx| {
251 ty.hash_stable(hcx, &mut hasher);
258 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
259 pub fn has_error_field(self, ty: Ty<'tcx>) -> bool {
261 ty::TyAdt(def, substs) => {
262 for field in def.all_fields() {
263 let field_ty = field.ty(self, substs);
264 if let TyError = field_ty.sty {
274 /// Returns the deeply last field of nested structures, or the same type,
275 /// if not a structure at all. Corresponds to the only possible unsized
276 /// field, and its type can be used to determine unsizing strategy.
277 pub fn struct_tail(self, mut ty: Ty<'tcx>) -> Ty<'tcx> {
280 ty::TyAdt(def, substs) => {
281 if !def.is_struct() {
284 match def.non_enum_variant().fields.last() {
285 Some(f) => ty = f.ty(self, substs),
290 ty::TyTuple(tys) => {
291 if let Some((&last_ty, _)) = tys.split_last() {
306 /// Same as applying struct_tail on `source` and `target`, but only
307 /// keeps going as long as the two types are instances of the same
308 /// structure definitions.
309 /// For `(Foo<Foo<T>>, Foo<Trait>)`, the result will be `(Foo<T>, Trait)`,
310 /// whereas struct_tail produces `T`, and `Trait`, respectively.
311 pub fn struct_lockstep_tails(self,
314 -> (Ty<'tcx>, Ty<'tcx>) {
315 let (mut a, mut b) = (source, target);
317 match (&a.sty, &b.sty) {
318 (&TyAdt(a_def, a_substs), &TyAdt(b_def, b_substs))
319 if a_def == b_def && a_def.is_struct() => {
320 if let Some(f) = a_def.non_enum_variant().fields.last() {
321 a = f.ty(self, a_substs);
322 b = f.ty(self, b_substs);
327 (&TyTuple(a_tys), &TyTuple(b_tys))
328 if a_tys.len() == b_tys.len() => {
329 if let Some(a_last) = a_tys.last() {
331 b = b_tys.last().unwrap();
342 /// Given a set of predicates that apply to an object type, returns
343 /// the region bounds that the (erased) `Self` type must
344 /// outlive. Precisely *because* the `Self` type is erased, the
345 /// parameter `erased_self_ty` must be supplied to indicate what type
346 /// has been used to represent `Self` in the predicates
347 /// themselves. This should really be a unique type; `FreshTy(0)` is a
350 /// NB: in some cases, particularly around higher-ranked bounds,
351 /// this function returns a kind of conservative approximation.
352 /// That is, all regions returned by this function are definitely
353 /// required, but there may be other region bounds that are not
354 /// returned, as well as requirements like `for<'a> T: 'a`.
356 /// Requires that trait definitions have been processed so that we can
357 /// elaborate predicates and walk supertraits.
359 /// FIXME callers may only have a &[Predicate], not a Vec, so that's
360 /// what this code should accept.
361 pub fn required_region_bounds(self,
362 erased_self_ty: Ty<'tcx>,
363 predicates: Vec<ty::Predicate<'tcx>>)
364 -> Vec<ty::Region<'tcx>> {
365 debug!("required_region_bounds(erased_self_ty={:?}, predicates={:?})",
369 assert!(!erased_self_ty.has_escaping_regions());
371 traits::elaborate_predicates(self, predicates)
372 .filter_map(|predicate| {
374 ty::Predicate::Projection(..) |
375 ty::Predicate::Trait(..) |
376 ty::Predicate::Subtype(..) |
377 ty::Predicate::WellFormed(..) |
378 ty::Predicate::ObjectSafe(..) |
379 ty::Predicate::ClosureKind(..) |
380 ty::Predicate::RegionOutlives(..) |
381 ty::Predicate::ConstEvaluatable(..) => {
384 ty::Predicate::TypeOutlives(predicate) => {
385 // Search for a bound of the form `erased_self_ty
386 // : 'a`, but be wary of something like `for<'a>
387 // erased_self_ty : 'a` (we interpret a
388 // higher-ranked bound like that as 'static,
389 // though at present the code in `fulfill.rs`
390 // considers such bounds to be unsatisfiable, so
391 // it's kind of a moot point since you could never
392 // construct such an object, but this seems
393 // correct even if that code changes).
394 let ty::OutlivesPredicate(ref t, ref r) = predicate.skip_binder();
395 if t == &erased_self_ty && !r.has_escaping_regions() {
406 /// Calculate the destructor of a given type.
407 pub fn calculate_dtor(
410 validate: &mut dyn FnMut(Self, DefId) -> Result<(), ErrorReported>
411 ) -> Option<ty::Destructor> {
412 let drop_trait = if let Some(def_id) = self.lang_items().drop_trait() {
418 ty::query::queries::coherent_trait::ensure(self, drop_trait);
420 let mut dtor_did = None;
421 let ty = self.type_of(adt_did);
422 self.for_each_relevant_impl(drop_trait, ty, |impl_did| {
423 if let Some(item) = self.associated_items(impl_did).next() {
424 if let Ok(()) = validate(self, impl_did) {
425 dtor_did = Some(item.def_id);
430 Some(ty::Destructor { did: dtor_did? })
433 /// Return the set of types that are required to be alive in
434 /// order to run the destructor of `def` (see RFCs 769 and
437 /// Note that this returns only the constraints for the
438 /// destructor of `def` itself. For the destructors of the
439 /// contents, you need `adt_dtorck_constraint`.
440 pub fn destructor_constraints(self, def: &'tcx ty::AdtDef)
441 -> Vec<ty::subst::Kind<'tcx>>
443 let dtor = match def.destructor(self) {
445 debug!("destructor_constraints({:?}) - no dtor", def.did);
448 Some(dtor) => dtor.did
451 // RFC 1238: if the destructor method is tagged with the
452 // attribute `unsafe_destructor_blind_to_params`, then the
453 // compiler is being instructed to *assume* that the
454 // destructor will not access borrowed data,
455 // even if such data is otherwise reachable.
457 // Such access can be in plain sight (e.g. dereferencing
458 // `*foo.0` of `Foo<'a>(&'a u32)`) or indirectly hidden
459 // (e.g. calling `foo.0.clone()` of `Foo<T:Clone>`).
460 if self.has_attr(dtor, "unsafe_destructor_blind_to_params") {
461 debug!("destructor_constraint({:?}) - blind", def.did);
465 let impl_def_id = self.associated_item(dtor).container.id();
466 let impl_generics = self.generics_of(impl_def_id);
468 // We have a destructor - all the parameters that are not
469 // pure_wrt_drop (i.e, don't have a #[may_dangle] attribute)
472 // We need to return the list of parameters from the ADTs
473 // generics/substs that correspond to impure parameters on the
474 // impl's generics. This is a bit ugly, but conceptually simple:
476 // Suppose our ADT looks like the following
478 // struct S<X, Y, Z>(X, Y, Z);
482 // impl<#[may_dangle] P0, P1, P2> Drop for S<P1, P2, P0>
484 // We want to return the parameters (X, Y). For that, we match
485 // up the item-substs <X, Y, Z> with the substs on the impl ADT,
486 // <P1, P2, P0>, and then look up which of the impl substs refer to
487 // parameters marked as pure.
489 let impl_substs = match self.type_of(impl_def_id).sty {
490 ty::TyAdt(def_, substs) if def_ == def => substs,
494 let item_substs = match self.type_of(def.did).sty {
495 ty::TyAdt(def_, substs) if def_ == def => substs,
499 let result = item_substs.iter().zip(impl_substs.iter())
502 UnpackedKind::Lifetime(&ty::RegionKind::ReEarlyBound(ref ebr)) => {
503 !impl_generics.region_param(ebr, self).pure_wrt_drop
505 UnpackedKind::Type(&ty::TyS {
506 sty: ty::TypeVariants::TyParam(ref pt), ..
508 !impl_generics.type_param(pt, self).pure_wrt_drop
510 UnpackedKind::Lifetime(_) | UnpackedKind::Type(_) => {
511 // not a type or region param - this should be reported
516 }).map(|(&item_param, _)| item_param).collect();
517 debug!("destructor_constraint({:?}) = {:?}", def.did, result);
521 /// True if `def_id` refers to a closure (e.g., `|x| x * 2`). Note
522 /// that closures have a def-id, but the closure *expression* also
523 /// has a `HirId` that is located within the context where the
524 /// closure appears (and, sadly, a corresponding `NodeId`, since
525 /// those are not yet phased out). The parent of the closure's
526 /// def-id will also be the context where it appears.
527 pub fn is_closure(self, def_id: DefId) -> bool {
528 self.def_key(def_id).disambiguated_data.data == DefPathData::ClosureExpr
531 /// True if `def_id` refers to a trait (e.g., `trait Foo { ... }`).
532 pub fn is_trait(self, def_id: DefId) -> bool {
533 if let DefPathData::Trait(_) = self.def_key(def_id).disambiguated_data.data {
540 /// True if this def-id refers to the implicit constructor for
541 /// a tuple struct like `struct Foo(u32)`.
542 pub fn is_struct_constructor(self, def_id: DefId) -> bool {
543 self.def_key(def_id).disambiguated_data.data == DefPathData::StructCtor
546 /// Given the `DefId` of a fn or closure, returns the `DefId` of
547 /// the innermost fn item that the closure is contained within.
548 /// This is a significant def-id because, when we do
549 /// type-checking, we type-check this fn item and all of its
550 /// (transitive) closures together. Therefore, when we fetch the
551 /// `typeck_tables_of` the closure, for example, we really wind up
552 /// fetching the `typeck_tables_of` the enclosing fn item.
553 pub fn closure_base_def_id(self, def_id: DefId) -> DefId {
554 let mut def_id = def_id;
555 while self.is_closure(def_id) {
556 def_id = self.parent_def_id(def_id).unwrap_or_else(|| {
557 bug!("closure {:?} has no parent", def_id);
563 /// Given the def-id and substs a closure, creates the type of
564 /// `self` argument that the closure expects. For example, for a
565 /// `Fn` closure, this would return a reference type `&T` where
568 /// Returns `None` if this closure's kind has not yet been inferred.
569 /// This should only be possible during type checking.
571 /// Note that the return value is a late-bound region and hence
572 /// wrapped in a binder.
573 pub fn closure_env_ty(self,
574 closure_def_id: DefId,
575 closure_substs: ty::ClosureSubsts<'tcx>)
576 -> Option<ty::Binder<Ty<'tcx>>>
578 let closure_ty = self.mk_closure(closure_def_id, closure_substs);
579 let env_region = ty::ReLateBound(ty::INNERMOST, ty::BrEnv);
580 let closure_kind_ty = closure_substs.closure_kind_ty(closure_def_id, self);
581 let closure_kind = closure_kind_ty.to_opt_closure_kind()?;
582 let env_ty = match closure_kind {
583 ty::ClosureKind::Fn => self.mk_imm_ref(self.mk_region(env_region), closure_ty),
584 ty::ClosureKind::FnMut => self.mk_mut_ref(self.mk_region(env_region), closure_ty),
585 ty::ClosureKind::FnOnce => closure_ty,
587 Some(ty::Binder::bind(env_ty))
590 /// Given the def-id of some item that has no type parameters, make
591 /// a suitable "empty substs" for it.
592 pub fn empty_substs_for_def_id(self, item_def_id: DefId) -> &'tcx Substs<'tcx> {
593 Substs::for_item(self, item_def_id, |param, _| {
595 GenericParamDefKind::Lifetime => self.types.re_erased.into(),
596 GenericParamDefKind::Type {..} => {
597 bug!("empty_substs_for_def_id: {:?} has type parameters", item_def_id)
603 /// Return whether the node pointed to by def_id is a static item, and its mutability
604 pub fn is_static(&self, def_id: DefId) -> Option<hir::Mutability> {
605 if let Some(node) = self.hir.get_if_local(def_id) {
607 Node::NodeItem(&hir::Item {
608 node: hir::ItemKind::Static(_, mutbl, _), ..
610 Node::NodeForeignItem(&hir::ForeignItem {
611 node: hir::ForeignItemKind::Static(_, is_mutbl), ..
614 hir::Mutability::MutMutable
616 hir::Mutability::MutImmutable
621 match self.describe_def(def_id) {
622 Some(Def::Static(_, is_mutbl)) =>
624 hir::Mutability::MutMutable
626 hir::Mutability::MutImmutable
634 impl<'a, 'tcx> ty::TyS<'tcx> {
635 pub fn moves_by_default(&'tcx self,
636 tcx: TyCtxt<'a, 'tcx, 'tcx>,
637 param_env: ty::ParamEnv<'tcx>,
640 !tcx.at(span).is_copy_raw(param_env.and(self))
643 pub fn is_sized(&'tcx self,
644 tcx_at: TyCtxtAt<'a, 'tcx, 'tcx>,
645 param_env: ty::ParamEnv<'tcx>)-> bool
647 tcx_at.is_sized_raw(param_env.and(self))
650 pub fn is_freeze(&'tcx self,
651 tcx: TyCtxt<'a, 'tcx, 'tcx>,
652 param_env: ty::ParamEnv<'tcx>,
655 tcx.at(span).is_freeze_raw(param_env.and(self))
658 /// If `ty.needs_drop(...)` returns `true`, then `ty` is definitely
659 /// non-copy and *might* have a destructor attached; if it returns
660 /// `false`, then `ty` definitely has no destructor (i.e. no drop glue).
662 /// (Note that this implies that if `ty` has a destructor attached,
663 /// then `needs_drop` will definitely return `true` for `ty`.)
665 pub fn needs_drop(&'tcx self,
666 tcx: TyCtxt<'a, 'tcx, 'tcx>,
667 param_env: ty::ParamEnv<'tcx>)
669 tcx.needs_drop_raw(param_env.and(self))
672 /// Check whether a type is representable. This means it cannot contain unboxed
673 /// structural recursion. This check is needed for structs and enums.
674 pub fn is_representable(&'tcx self,
675 tcx: TyCtxt<'a, 'tcx, 'tcx>,
677 -> Representability {
679 // Iterate until something non-representable is found
680 fn fold_repr<It: Iterator<Item=Representability>>(iter: It) -> Representability {
681 iter.fold(Representability::Representable, |r1, r2| {
683 (Representability::SelfRecursive(v1),
684 Representability::SelfRecursive(v2)) => {
685 Representability::SelfRecursive(v1.iter().map(|s| *s).chain(v2).collect())
687 (r1, r2) => cmp::max(r1, r2)
692 fn are_inner_types_recursive<'a, 'tcx>(
693 tcx: TyCtxt<'a, 'tcx, 'tcx>, sp: Span,
694 seen: &mut Vec<Ty<'tcx>>,
695 representable_cache: &mut FxHashMap<Ty<'tcx>, Representability>,
701 // Find non representable
702 fold_repr(ts.iter().map(|ty| {
703 is_type_structurally_recursive(tcx, sp, seen, representable_cache, ty)
706 // Fixed-length vectors.
707 // FIXME(#11924) Behavior undecided for zero-length vectors.
709 is_type_structurally_recursive(tcx, sp, seen, representable_cache, ty)
711 TyAdt(def, substs) => {
712 // Find non representable fields with their spans
713 fold_repr(def.all_fields().map(|field| {
714 let ty = field.ty(tcx, substs);
715 let span = tcx.hir.span_if_local(field.did).unwrap_or(sp);
716 match is_type_structurally_recursive(tcx, span, seen,
717 representable_cache, ty)
719 Representability::SelfRecursive(_) => {
720 Representability::SelfRecursive(vec![span])
727 // this check is run on type definitions, so we don't expect
728 // to see closure types
729 bug!("requires check invoked on inapplicable type: {:?}", ty)
731 _ => Representability::Representable,
735 fn same_struct_or_enum<'tcx>(ty: Ty<'tcx>, def: &'tcx ty::AdtDef) -> bool {
737 TyAdt(ty_def, _) => {
744 fn same_type<'tcx>(a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
745 match (&a.sty, &b.sty) {
746 (&TyAdt(did_a, substs_a), &TyAdt(did_b, substs_b)) => {
751 substs_a.types().zip(substs_b.types()).all(|(a, b)| same_type(a, b))
757 // Does the type `ty` directly (without indirection through a pointer)
758 // contain any types on stack `seen`?
759 fn is_type_structurally_recursive<'a, 'tcx>(
760 tcx: TyCtxt<'a, 'tcx, 'tcx>,
762 seen: &mut Vec<Ty<'tcx>>,
763 representable_cache: &mut FxHashMap<Ty<'tcx>, Representability>,
764 ty: Ty<'tcx>) -> Representability
766 debug!("is_type_structurally_recursive: {:?} {:?}", ty, sp);
767 if let Some(representability) = representable_cache.get(ty) {
768 debug!("is_type_structurally_recursive: {:?} {:?} - (cached) {:?}",
769 ty, sp, representability);
770 return representability.clone();
773 let representability = is_type_structurally_recursive_inner(
774 tcx, sp, seen, representable_cache, ty);
776 representable_cache.insert(ty, representability.clone());
780 fn is_type_structurally_recursive_inner<'a, 'tcx>(
781 tcx: TyCtxt<'a, 'tcx, 'tcx>,
783 seen: &mut Vec<Ty<'tcx>>,
784 representable_cache: &mut FxHashMap<Ty<'tcx>, Representability>,
785 ty: Ty<'tcx>) -> Representability
790 // Iterate through stack of previously seen types.
791 let mut iter = seen.iter();
793 // The first item in `seen` is the type we are actually curious about.
794 // We want to return SelfRecursive if this type contains itself.
795 // It is important that we DON'T take generic parameters into account
796 // for this check, so that Bar<T> in this example counts as SelfRecursive:
799 // struct Bar<T> { x: Bar<Foo> }
801 if let Some(&seen_type) = iter.next() {
802 if same_struct_or_enum(seen_type, def) {
803 debug!("SelfRecursive: {:?} contains {:?}",
806 return Representability::SelfRecursive(vec![sp]);
810 // We also need to know whether the first item contains other types
811 // that are structurally recursive. If we don't catch this case, we
812 // will recurse infinitely for some inputs.
814 // It is important that we DO take generic parameters into account
815 // here, so that code like this is considered SelfRecursive, not
816 // ContainsRecursive:
818 // struct Foo { Option<Option<Foo>> }
820 for &seen_type in iter {
821 if same_type(ty, seen_type) {
822 debug!("ContainsRecursive: {:?} contains {:?}",
825 return Representability::ContainsRecursive;
830 // For structs and enums, track all previously seen types by pushing them
831 // onto the 'seen' stack.
833 let out = are_inner_types_recursive(tcx, sp, seen, representable_cache, ty);
838 // No need to push in other cases.
839 are_inner_types_recursive(tcx, sp, seen, representable_cache, ty)
844 debug!("is_type_representable: {:?}", self);
846 // To avoid a stack overflow when checking an enum variant or struct that
847 // contains a different, structurally recursive type, maintain a stack
848 // of seen types and check recursion for each of them (issues #3008, #3779).
849 let mut seen: Vec<Ty> = Vec::new();
850 let mut representable_cache = FxHashMap();
851 let r = is_type_structurally_recursive(
852 tcx, sp, &mut seen, &mut representable_cache, self);
853 debug!("is_type_representable: {:?} is {:?}", self, r);
858 fn is_copy_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
859 query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
862 let (param_env, ty) = query.into_parts();
863 let trait_def_id = tcx.require_lang_item(lang_items::CopyTraitLangItem);
865 .enter(|infcx| traits::type_known_to_meet_bound(&infcx,
872 fn is_sized_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
873 query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
876 let (param_env, ty) = query.into_parts();
877 let trait_def_id = tcx.require_lang_item(lang_items::SizedTraitLangItem);
879 .enter(|infcx| traits::type_known_to_meet_bound(&infcx,
886 fn is_freeze_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
887 query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
890 let (param_env, ty) = query.into_parts();
891 let trait_def_id = tcx.require_lang_item(lang_items::FreezeTraitLangItem);
893 .enter(|infcx| traits::type_known_to_meet_bound(&infcx,
900 fn needs_drop_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
901 query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
904 let (param_env, ty) = query.into_parts();
906 let needs_drop = |ty: Ty<'tcx>| -> bool {
907 match tcx.try_needs_drop_raw(DUMMY_SP, param_env.and(ty)) {
910 // Cycles should be reported as an error by `check_representable`.
912 // Consider the type as not needing drop in the meanwhile to
913 // avoid further errors.
915 // In case we forgot to emit a bug elsewhere, delay our
916 // diagnostic to get emitted as a compiler bug.
923 assert!(!ty.needs_infer());
926 // Fast-path for primitive types
927 ty::TyInfer(ty::FreshIntTy(_)) | ty::TyInfer(ty::FreshFloatTy(_)) |
928 ty::TyBool | ty::TyInt(_) | ty::TyUint(_) | ty::TyFloat(_) | ty::TyNever |
929 ty::TyFnDef(..) | ty::TyFnPtr(_) | ty::TyChar | ty::TyGeneratorWitness(..) |
930 ty::TyRawPtr(_) | ty::TyRef(..) | ty::TyStr => false,
932 // Foreign types can never have destructors
933 ty::TyForeign(..) => false,
935 // `ManuallyDrop` doesn't have a destructor regardless of field types.
936 ty::TyAdt(def, _) if Some(def.did) == tcx.lang_items().manually_drop() => false,
938 // Issue #22536: We first query type_moves_by_default. It sees a
939 // normalized version of the type, and therefore will definitely
940 // know whether the type implements Copy (and thus needs no
941 // cleanup/drop/zeroing) ...
942 _ if !ty.moves_by_default(tcx, param_env, DUMMY_SP) => false,
944 // ... (issue #22536 continued) but as an optimization, still use
945 // prior logic of asking for the structural "may drop".
947 // FIXME(#22815): Note that this is a conservative heuristic;
948 // it may report that the type "may drop" when actual type does
949 // not actually have a destructor associated with it. But since
950 // the type absolutely did not have the `Copy` bound attached
951 // (see above), it is sound to treat it as having a destructor.
953 // User destructors are the only way to have concrete drop types.
954 ty::TyAdt(def, _) if def.has_dtor(tcx) => true,
956 // Can refer to a type which may drop.
957 // FIXME(eddyb) check this against a ParamEnv.
958 ty::TyDynamic(..) | ty::TyProjection(..) | ty::TyParam(_) |
959 ty::TyAnon(..) | ty::TyInfer(_) | ty::TyError => true,
961 // Structural recursion.
962 ty::TyArray(ty, _) | ty::TySlice(ty) => needs_drop(ty),
964 ty::TyClosure(def_id, ref substs) => substs.upvar_tys(def_id, tcx).any(needs_drop),
966 // Pessimistically assume that all generators will require destructors
967 // as we don't know if a destructor is a noop or not until after the MIR
968 // state transformation pass
969 ty::TyGenerator(..) => true,
971 ty::TyTuple(ref tys) => tys.iter().cloned().any(needs_drop),
973 // unions don't have destructors because of the child types,
974 // only if they manually implement `Drop` (handled above).
975 ty::TyAdt(def, _) if def.is_union() => false,
977 ty::TyAdt(def, substs) =>
978 def.variants.iter().any(
979 |variant| variant.fields.iter().any(
980 |field| needs_drop(field.ty(tcx, substs)))),
984 pub enum ExplicitSelf<'tcx> {
986 ByReference(ty::Region<'tcx>, hir::Mutability),
987 ByRawPointer(hir::Mutability),
992 impl<'tcx> ExplicitSelf<'tcx> {
993 /// Categorizes an explicit self declaration like `self: SomeType`
994 /// into either `self`, `&self`, `&mut self`, `Box<self>`, or
996 /// This is mainly used to require the arbitrary_self_types feature
997 /// in the case of `Other`, to improve error messages in the common cases,
998 /// and to make `Other` non-object-safe.
1003 /// impl<'a> Foo for &'a T {
1004 /// // Legal declarations:
1005 /// fn method1(self: &&'a T); // ExplicitSelf::ByReference
1006 /// fn method2(self: &'a T); // ExplicitSelf::ByValue
1007 /// fn method3(self: Box<&'a T>); // ExplicitSelf::ByBox
1008 /// fn method4(self: Rc<&'a T>); // ExplicitSelf::Other
1010 /// // Invalid cases will be caught by `check_method_receiver`:
1011 /// fn method_err1(self: &'a mut T); // ExplicitSelf::Other
1012 /// fn method_err2(self: &'static T) // ExplicitSelf::ByValue
1013 /// fn method_err3(self: &&T) // ExplicitSelf::ByReference
1017 pub fn determine<P>(
1018 self_arg_ty: Ty<'tcx>,
1020 ) -> ExplicitSelf<'tcx>
1022 P: Fn(Ty<'tcx>) -> bool
1024 use self::ExplicitSelf::*;
1026 match self_arg_ty.sty {
1027 _ if is_self_ty(self_arg_ty) => ByValue,
1028 ty::TyRef(region, ty, mutbl) if is_self_ty(ty) => {
1029 ByReference(region, mutbl)
1031 ty::TyRawPtr(ty::TypeAndMut { ty, mutbl }) if is_self_ty(ty) => {
1034 ty::TyAdt(def, _) if def.is_box() && is_self_ty(self_arg_ty.boxed_ty()) => {
1042 pub fn provide(providers: &mut ty::query::Providers) {
1043 *providers = ty::query::Providers {