src/librustc/ty/util.rs

   1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! misc. type-system utilities too small to deserve their own file
  12
  13 use hir::def::Def;
  14 use hir::def_id::DefId;
  15 use hir::map::{DefPathData, Node};
  16 use hir;
  17 use ich::NodeIdHashingMode;
  18 use middle::const_val::ConstVal;
  19 use traits::{self, Reveal};
  20 use ty::{self, Ty, TyCtxt, TypeFoldable};
  21 use ty::fold::TypeVisitor;
  22 use ty::subst::{Subst, UnpackedKind};
  23 use ty::maps::TyCtxtAt;
  24 use ty::TypeVariants::*;
  25 use util::common::ErrorReported;
  26 use middle::lang_items;
  27
  28 use rustc_const_math::{ConstInt, ConstIsize, ConstUsize};
  29 use rustc_data_structures::stable_hasher::{StableHasher, StableHasherResult,
  30                                            HashStable};
  31 use rustc_data_structures::fx::FxHashMap;
  32 use std::cmp;
  33 use std::hash::Hash;
  34 use std::intrinsics;
  35 use syntax::ast::{self, Name};
  36 use syntax::attr::{self, SignedInt, UnsignedInt};
  37 use syntax_pos::{Span, DUMMY_SP};
  38
  39 type Disr = ConstInt;
  40
  41 pub trait IntTypeExt {
  42     fn to_ty<'a, 'gcx, 'tcx>(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Ty<'tcx>;
  43     fn disr_incr<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, val: Option<Disr>)
  44                            -> Option<Disr>;
  45     fn assert_ty_matches(&self, val: Disr);
  46     fn initial_discriminant<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Disr;
  47 }
  48
  49
  50 macro_rules! typed_literal {
  51     ($tcx:expr, $ty:expr, $lit:expr) => {
  52         match $ty {
  53             SignedInt(ast::IntTy::I8)    => ConstInt::I8($lit),
  54             SignedInt(ast::IntTy::I16)   => ConstInt::I16($lit),
  55             SignedInt(ast::IntTy::I32)   => ConstInt::I32($lit),
  56             SignedInt(ast::IntTy::I64)   => ConstInt::I64($lit),
  57             SignedInt(ast::IntTy::I128)   => ConstInt::I128($lit),
  58             SignedInt(ast::IntTy::Isize) => match $tcx.sess.target.isize_ty {
  59                 ast::IntTy::I16 => ConstInt::Isize(ConstIsize::Is16($lit)),
  60                 ast::IntTy::I32 => ConstInt::Isize(ConstIsize::Is32($lit)),
  61                 ast::IntTy::I64 => ConstInt::Isize(ConstIsize::Is64($lit)),
  62                 _ => bug!(),
  63             },
  64             UnsignedInt(ast::UintTy::U8)  => ConstInt::U8($lit),
  65             UnsignedInt(ast::UintTy::U16) => ConstInt::U16($lit),
  66             UnsignedInt(ast::UintTy::U32) => ConstInt::U32($lit),
  67             UnsignedInt(ast::UintTy::U64) => ConstInt::U64($lit),
  68             UnsignedInt(ast::UintTy::U128) => ConstInt::U128($lit),
  69             UnsignedInt(ast::UintTy::Usize) => match $tcx.sess.target.usize_ty {
  70                 ast::UintTy::U16 => ConstInt::Usize(ConstUsize::Us16($lit)),
  71                 ast::UintTy::U32 => ConstInt::Usize(ConstUsize::Us32($lit)),
  72                 ast::UintTy::U64 => ConstInt::Usize(ConstUsize::Us64($lit)),
  73                 _ => bug!(),
  74             },
  75         }
  76     }
  77 }
  78
  79 impl IntTypeExt for attr::IntType {
  80     fn to_ty<'a, 'gcx, 'tcx>(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Ty<'tcx> {
  81         match *self {
  82             SignedInt(ast::IntTy::I8)      => tcx.types.i8,
  83             SignedInt(ast::IntTy::I16)     => tcx.types.i16,
  84             SignedInt(ast::IntTy::I32)     => tcx.types.i32,
  85             SignedInt(ast::IntTy::I64)     => tcx.types.i64,
  86             SignedInt(ast::IntTy::I128)     => tcx.types.i128,
  87             SignedInt(ast::IntTy::Isize)   => tcx.types.isize,
  88             UnsignedInt(ast::UintTy::U8)    => tcx.types.u8,
  89             UnsignedInt(ast::UintTy::U16)   => tcx.types.u16,
  90             UnsignedInt(ast::UintTy::U32)   => tcx.types.u32,
  91             UnsignedInt(ast::UintTy::U64)   => tcx.types.u64,
  92             UnsignedInt(ast::UintTy::U128)   => tcx.types.u128,
  93             UnsignedInt(ast::UintTy::Usize) => tcx.types.usize,
  94         }
  95     }
  96
  97     fn initial_discriminant<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Disr {
  98         typed_literal!(tcx, *self, 0)
  99     }
 100
 101     fn assert_ty_matches(&self, val: Disr) {
 102         match (*self, val) {
 103             (SignedInt(ast::IntTy::I8), ConstInt::I8(_)) => {},
 104             (SignedInt(ast::IntTy::I16), ConstInt::I16(_)) => {},
 105             (SignedInt(ast::IntTy::I32), ConstInt::I32(_)) => {},
 106             (SignedInt(ast::IntTy::I64), ConstInt::I64(_)) => {},
 107             (SignedInt(ast::IntTy::I128), ConstInt::I128(_)) => {},
 108             (SignedInt(ast::IntTy::Isize), ConstInt::Isize(_)) => {},
 109             (UnsignedInt(ast::UintTy::U8), ConstInt::U8(_)) => {},
 110             (UnsignedInt(ast::UintTy::U16), ConstInt::U16(_)) => {},
 111             (UnsignedInt(ast::UintTy::U32), ConstInt::U32(_)) => {},
 112             (UnsignedInt(ast::UintTy::U64), ConstInt::U64(_)) => {},
 113             (UnsignedInt(ast::UintTy::U128), ConstInt::U128(_)) => {},
 114             (UnsignedInt(ast::UintTy::Usize), ConstInt::Usize(_)) => {},
 115             _ => bug!("disr type mismatch: {:?} vs {:?}", self, val),
 116         }
 117     }
 118
 119     fn disr_incr<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, val: Option<Disr>)
 120                            -> Option<Disr> {
 121         if let Some(val) = val {
 122             self.assert_ty_matches(val);
 123             (val + typed_literal!(tcx, *self, 1)).ok()
 124         } else {
 125             Some(self.initial_discriminant(tcx))
 126         }
 127     }
 128 }
 129
 130
 131 #[derive(Copy, Clone)]
 132 pub enum CopyImplementationError<'tcx> {
 133     InfrigingField(&'tcx ty::FieldDef),
 134     NotAnAdt,
 135     HasDestructor,
 136 }
 137
 138 /// Describes whether a type is representable. For types that are not
 139 /// representable, 'SelfRecursive' and 'ContainsRecursive' are used to
 140 /// distinguish between types that are recursive with themselves and types that
 141 /// contain a different recursive type. These cases can therefore be treated
 142 /// differently when reporting errors.
 143 ///
 144 /// The ordering of the cases is significant. They are sorted so that cmp::max
 145 /// will keep the "more erroneous" of two values.
 146 #[derive(Clone, PartialOrd, Ord, Eq, PartialEq, Debug)]
 147 pub enum Representability {
 148     Representable,
 149     ContainsRecursive,
 150     SelfRecursive(Vec<Span>),
 151 }
 152
 153 impl<'tcx> ty::ParamEnv<'tcx> {
 154     /// Construct a trait environment suitable for contexts where
 155     /// there are no where clauses in scope.
 156     pub fn empty(reveal: Reveal) -> Self {
 157         Self::new(ty::Slice::empty(), reveal, ty::UniverseIndex::ROOT)
 158     }
 159
 160     /// Construct a trait environment with the given set of predicates.
 161     pub fn new(caller_bounds: &'tcx ty::Slice<ty::Predicate<'tcx>>,
 162                reveal: Reveal,
 163                universe: ty::UniverseIndex)
 164                -> Self {
 165         ty::ParamEnv { caller_bounds, reveal, universe }
 166     }
 167
 168     /// Returns a new parameter environment with the same clauses, but
 169     /// which "reveals" the true results of projections in all cases
 170     /// (even for associated types that are specializable).  This is
 171     /// the desired behavior during trans and certain other special
 172     /// contexts; normally though we want to use `Reveal::UserFacing`,
 173     /// which is the default.
 174     pub fn reveal_all(self) -> Self {
 175         ty::ParamEnv { reveal: Reveal::All, ..self }
 176     }
 177
 178     pub fn can_type_implement_copy<'a>(self,
 179                                        tcx: TyCtxt<'a, 'tcx, 'tcx>,
 180                                        self_type: Ty<'tcx>, span: Span)
 181                                        -> Result<(), CopyImplementationError<'tcx>> {
 182         // FIXME: (@jroesch) float this code up
 183         tcx.infer_ctxt().enter(|infcx| {
 184             let (adt, substs) = match self_type.sty {
 185                 ty::TyAdt(adt, substs) => (adt, substs),
 186                 _ => return Err(CopyImplementationError::NotAnAdt),
 187             };
 188
 189             let field_implements_copy = |field: &ty::FieldDef| {
 190                 let cause = traits::ObligationCause::dummy();
 191                 match traits::fully_normalize(&infcx, cause, self, &field.ty(tcx, substs)) {
 192                     Ok(ty) => !infcx.type_moves_by_default(self, ty, span),
 193                     Err(..) => false,
 194                 }
 195             };
 196
 197             for variant in &adt.variants {
 198                 for field in &variant.fields {
 199                     if !field_implements_copy(field) {
 200                         return Err(CopyImplementationError::InfrigingField(field));
 201                     }
 202                 }
 203             }
 204
 205             if adt.has_dtor(tcx) {
 206                 return Err(CopyImplementationError::HasDestructor);
 207             }
 208
 209             Ok(())
 210         })
 211     }
 212 }
 213
 214 impl<'a, 'tcx> TyCtxt<'a, 'tcx, 'tcx> {
 215     /// Creates a hash of the type `Ty` which will be the same no matter what crate
 216     /// context it's calculated within. This is used by the `type_id` intrinsic.
 217     pub fn type_id_hash(self, ty: Ty<'tcx>) -> u64 {
 218         let mut hasher = StableHasher::new();
 219         let mut hcx = self.create_stable_hashing_context();
 220
 221         // We want the type_id be independent of the types free regions, so we
 222         // erase them. The erase_regions() call will also anonymize bound
 223         // regions, which is desirable too.
 224         let ty = self.erase_regions(&ty);
 225
 226         hcx.while_hashing_spans(false, |hcx| {
 227             hcx.with_node_id_hashing_mode(NodeIdHashingMode::HashDefPath, |hcx| {
 228                 ty.hash_stable(hcx, &mut hasher);
 229             });
 230         });
 231         hasher.finish()
 232     }
 233 }
 234
 235 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
 236     pub fn has_error_field(self, ty: Ty<'tcx>) -> bool {
 237         match ty.sty {
 238             ty::TyAdt(def, substs) => {
 239                 for field in def.all_fields() {
 240                     let field_ty = field.ty(self, substs);
 241                     if let TyError = field_ty.sty {
 242                         return true;
 243                     }
 244                 }
 245             }
 246             _ => (),
 247         }
 248         false
 249     }
 250
 251     /// Returns the type of element at index `i` in tuple or tuple-like type `t`.
 252     /// For an enum `t`, `variant` is None only if `t` is a univariant enum.
 253     pub fn positional_element_ty(self,
 254                                  ty: Ty<'tcx>,
 255                                  i: usize,
 256                                  variant: Option<DefId>) -> Option<Ty<'tcx>> {
 257         match (&ty.sty, variant) {
 258             (&TyAdt(adt, substs), Some(vid)) => {
 259                 adt.variant_with_id(vid).fields.get(i).map(|f| f.ty(self, substs))
 260             }
 261             (&TyAdt(adt, substs), None) => {
 262                 // Don't use `non_enum_variant`, this may be a univariant enum.
 263                 adt.variants[0].fields.get(i).map(|f| f.ty(self, substs))
 264             }
 265             (&TyTuple(ref v, _), None) => v.get(i).cloned(),
 266             _ => None,
 267         }
 268     }
 269
 270     /// Returns the type of element at field `n` in struct or struct-like type `t`.
 271     /// For an enum `t`, `variant` must be some def id.
 272     pub fn named_element_ty(self,
 273                             ty: Ty<'tcx>,
 274                             n: Name,
 275                             variant: Option<DefId>) -> Option<Ty<'tcx>> {
 276         match (&ty.sty, variant) {
 277             (&TyAdt(adt, substs), Some(vid)) => {
 278                 adt.variant_with_id(vid).find_field_named(n).map(|f| f.ty(self, substs))
 279             }
 280             (&TyAdt(adt, substs), None) => {
 281                 adt.non_enum_variant().find_field_named(n).map(|f| f.ty(self, substs))
 282             }
 283             _ => return None
 284         }
 285     }
 286
 287     /// Returns the deeply last field of nested structures, or the same type,
 288     /// if not a structure at all. Corresponds to the only possible unsized
 289     /// field, and its type can be used to determine unsizing strategy.
 290     pub fn struct_tail(self, mut ty: Ty<'tcx>) -> Ty<'tcx> {
 291         loop {
 292             match ty.sty {
 293                 ty::TyAdt(def, substs) => {
 294                     if !def.is_struct() {
 295                         break;
 296                     }
 297                     match def.non_enum_variant().fields.last() {
 298                         Some(f) => ty = f.ty(self, substs),
 299                         None => break,
 300                     }
 301                 }
 302
 303                 ty::TyTuple(tys, _) => {
 304                     if let Some((&last_ty, _)) = tys.split_last() {
 305                         ty = last_ty;
 306                     } else {
 307                         break;
 308                     }
 309                 }
 310
 311                 _ => {
 312                     break;
 313                 }
 314             }
 315         }
 316         ty
 317     }
 318
 319     /// Same as applying struct_tail on `source` and `target`, but only
 320     /// keeps going as long as the two types are instances of the same
 321     /// structure definitions.
 322     /// For `(Foo<Foo<T>>, Foo<Trait>)`, the result will be `(Foo<T>, Trait)`,
 323     /// whereas struct_tail produces `T`, and `Trait`, respectively.
 324     pub fn struct_lockstep_tails(self,
 325                                  source: Ty<'tcx>,
 326                                  target: Ty<'tcx>)
 327                                  -> (Ty<'tcx>, Ty<'tcx>) {
 328         let (mut a, mut b) = (source, target);
 329         loop {
 330             match (&a.sty, &b.sty) {
 331                 (&TyAdt(a_def, a_substs), &TyAdt(b_def, b_substs))
 332                         if a_def == b_def && a_def.is_struct() => {
 333                     if let Some(f) = a_def.non_enum_variant().fields.last() {
 334                         a = f.ty(self, a_substs);
 335                         b = f.ty(self, b_substs);
 336                     } else {
 337                         break;
 338                     }
 339                 },
 340                 (&TyTuple(a_tys, _), &TyTuple(b_tys, _))
 341                         if a_tys.len() == b_tys.len() => {
 342                     if let Some(a_last) = a_tys.last() {
 343                         a = a_last;
 344                         b = b_tys.last().unwrap();
 345                     } else {
 346                         break;
 347                     }
 348                 },
 349                 _ => break,
 350             }
 351         }
 352         (a, b)
 353     }
 354
 355     /// Given a set of predicates that apply to an object type, returns
 356     /// the region bounds that the (erased) `Self` type must
 357     /// outlive. Precisely *because* the `Self` type is erased, the
 358     /// parameter `erased_self_ty` must be supplied to indicate what type
 359     /// has been used to represent `Self` in the predicates
 360     /// themselves. This should really be a unique type; `FreshTy(0)` is a
 361     /// popular choice.
 362     ///
 363     /// NB: in some cases, particularly around higher-ranked bounds,
 364     /// this function returns a kind of conservative approximation.
 365     /// That is, all regions returned by this function are definitely
 366     /// required, but there may be other region bounds that are not
 367     /// returned, as well as requirements like `for<'a> T: 'a`.
 368     ///
 369     /// Requires that trait definitions have been processed so that we can
 370     /// elaborate predicates and walk supertraits.
 371     ///
 372     /// FIXME callers may only have a &[Predicate], not a Vec, so that's
 373     /// what this code should accept.
 374     pub fn required_region_bounds(self,
 375                                   erased_self_ty: Ty<'tcx>,
 376                                   predicates: Vec<ty::Predicate<'tcx>>)
 377                                   -> Vec<ty::Region<'tcx>>    {
 378         debug!("required_region_bounds(erased_self_ty={:?}, predicates={:?})",
 379                erased_self_ty,
 380                predicates);
 381
 382         assert!(!erased_self_ty.has_escaping_regions());
 383
 384         traits::elaborate_predicates(self, predicates)
 385             .filter_map(|predicate| {
 386                 match predicate {
 387                     ty::Predicate::Projection(..) |
 388                     ty::Predicate::Trait(..) |
 389                     ty::Predicate::Equate(..) |
 390                     ty::Predicate::Subtype(..) |
 391                     ty::Predicate::WellFormed(..) |
 392                     ty::Predicate::ObjectSafe(..) |
 393                     ty::Predicate::ClosureKind(..) |
 394                     ty::Predicate::RegionOutlives(..) |
 395                     ty::Predicate::ConstEvaluatable(..) => {
 396                         None
 397                     }
 398                     ty::Predicate::TypeOutlives(ty::Binder(ty::OutlivesPredicate(t, r))) => {
 399                         // Search for a bound of the form `erased_self_ty
 400                         // : 'a`, but be wary of something like `for<'a>
 401                         // erased_self_ty : 'a` (we interpret a
 402                         // higher-ranked bound like that as 'static,
 403                         // though at present the code in `fulfill.rs`
 404                         // considers such bounds to be unsatisfiable, so
 405                         // it's kind of a moot point since you could never
 406                         // construct such an object, but this seems
 407                         // correct even if that code changes).
 408                         if t == erased_self_ty && !r.has_escaping_regions() {
 409                             Some(r)
 410                         } else {
 411                             None
 412                         }
 413                     }
 414                 }
 415             })
 416             .collect()
 417     }
 418
 419     /// Calculate the destructor of a given type.
 420     pub fn calculate_dtor(
 421         self,
 422         adt_did: DefId,
 423         validate: &mut dyn FnMut(Self, DefId) -> Result<(), ErrorReported>
 424     ) -> Option<ty::Destructor> {
 425         let drop_trait = if let Some(def_id) = self.lang_items().drop_trait() {
 426             def_id
 427         } else {
 428             return None;
 429         };
 430
 431         ty::maps::queries::coherent_trait::ensure(self, drop_trait);
 432
 433         let mut dtor_did = None;
 434         let ty = self.type_of(adt_did);
 435         self.for_each_relevant_impl(drop_trait, ty, |impl_did| {
 436             if let Some(item) = self.associated_items(impl_did).next() {
 437                 if let Ok(()) = validate(self, impl_did) {
 438                     dtor_did = Some(item.def_id);
 439                 }
 440             }
 441         });
 442
 443         Some(ty::Destructor { did: dtor_did? })
 444     }
 445
 446     /// Return the set of types that are required to be alive in
 447     /// order to run the destructor of `def` (see RFCs 769 and
 448     /// 1238).
 449     ///
 450     /// Note that this returns only the constraints for the
 451     /// destructor of `def` itself. For the destructors of the
 452     /// contents, you need `adt_dtorck_constraint`.
 453     pub fn destructor_constraints(self, def: &'tcx ty::AdtDef)
 454                                   -> Vec<ty::subst::Kind<'tcx>>
 455     {
 456         let dtor = match def.destructor(self) {
 457             None => {
 458                 debug!("destructor_constraints({:?}) - no dtor", def.did);
 459                 return vec![]
 460             }
 461             Some(dtor) => dtor.did
 462         };
 463
 464         // RFC 1238: if the destructor method is tagged with the
 465         // attribute `unsafe_destructor_blind_to_params`, then the
 466         // compiler is being instructed to *assume* that the
 467         // destructor will not access borrowed data,
 468         // even if such data is otherwise reachable.
 469         //
 470         // Such access can be in plain sight (e.g. dereferencing
 471         // `*foo.0` of `Foo<'a>(&'a u32)`) or indirectly hidden
 472         // (e.g. calling `foo.0.clone()` of `Foo<T:Clone>`).
 473         if self.has_attr(dtor, "unsafe_destructor_blind_to_params") {
 474             debug!("destructor_constraint({:?}) - blind", def.did);
 475             return vec![];
 476         }
 477
 478         let impl_def_id = self.associated_item(dtor).container.id();
 479         let impl_generics = self.generics_of(impl_def_id);
 480
 481         // We have a destructor - all the parameters that are not
 482         // pure_wrt_drop (i.e, don't have a #[may_dangle] attribute)
 483         // must be live.
 484
 485         // We need to return the list of parameters from the ADTs
 486         // generics/substs that correspond to impure parameters on the
 487         // impl's generics. This is a bit ugly, but conceptually simple:
 488         //
 489         // Suppose our ADT looks like the following
 490         //
 491         //     struct S<X, Y, Z>(X, Y, Z);
 492         //
 493         // and the impl is
 494         //
 495         //     impl<#[may_dangle] P0, P1, P2> Drop for S<P1, P2, P0>
 496         //
 497         // We want to return the parameters (X, Y). For that, we match
 498         // up the item-substs <X, Y, Z> with the substs on the impl ADT,
 499         // <P1, P2, P0>, and then look up which of the impl substs refer to
 500         // parameters marked as pure.
 501
 502         let impl_substs = match self.type_of(impl_def_id).sty {
 503             ty::TyAdt(def_, substs) if def_ == def => substs,
 504             _ => bug!()
 505         };
 506
 507         let item_substs = match self.type_of(def.did).sty {
 508             ty::TyAdt(def_, substs) if def_ == def => substs,
 509             _ => bug!()
 510         };
 511
 512         let result = item_substs.iter().zip(impl_substs.iter())
 513             .filter(|&(_, &k)| {
 514                 match k.unpack() {
 515                     UnpackedKind::Lifetime(&ty::RegionKind::ReEarlyBound(ref ebr)) => {
 516                         !impl_generics.region_param(ebr, self).pure_wrt_drop
 517                     }
 518                     UnpackedKind::Type(&ty::TyS {
 519                         sty: ty::TypeVariants::TyParam(ref pt), ..
 520                     }) => {
 521                         !impl_generics.type_param(pt, self).pure_wrt_drop
 522                     }
 523                     UnpackedKind::Lifetime(_) | UnpackedKind::Type(_) => {
 524                         // not a type or region param - this should be reported
 525                         // as an error.
 526                         false
 527                     }
 528                 }
 529             }).map(|(&item_param, _)| item_param).collect();
 530         debug!("destructor_constraint({:?}) = {:?}", def.did, result);
 531         result
 532     }
 533
 534     /// Return a set of constraints that needs to be satisfied in
 535     /// order for `ty` to be valid for destruction.
 536     pub fn dtorck_constraint_for_ty(self,
 537                                     span: Span,
 538                                     for_ty: Ty<'tcx>,
 539                                     depth: usize,
 540                                     ty: Ty<'tcx>)
 541                                     -> Result<ty::DtorckConstraint<'tcx>, ErrorReported>
 542     {
 543         debug!("dtorck_constraint_for_ty({:?}, {:?}, {:?}, {:?})",
 544                span, for_ty, depth, ty);
 545
 546         if depth >= self.sess.recursion_limit.get() {
 547             let mut err = struct_span_err!(
 548                 self.sess, span, E0320,
 549                 "overflow while adding drop-check rules for {}", for_ty);
 550             err.note(&format!("overflowed on {}", ty));
 551             err.emit();
 552             return Err(ErrorReported);
 553         }
 554
 555         let result = match ty.sty {
 556             ty::TyBool | ty::TyChar | ty::TyInt(_) | ty::TyUint(_) |
 557             ty::TyFloat(_) | ty::TyStr | ty::TyNever | ty::TyForeign(..) |
 558             ty::TyRawPtr(..) | ty::TyRef(..) | ty::TyFnDef(..) | ty::TyFnPtr(_) |
 559             ty::TyGeneratorWitness(..) => {
 560                 // these types never have a destructor
 561                 Ok(ty::DtorckConstraint::empty())
 562             }
 563
 564             ty::TyArray(ety, _) | ty::TySlice(ety) => {
 565                 // single-element containers, behave like their element
 566                 self.dtorck_constraint_for_ty(span, for_ty, depth+1, ety)
 567             }
 568
 569             ty::TyTuple(tys, _) => {
 570                 tys.iter().map(|ty| {
 571                     self.dtorck_constraint_for_ty(span, for_ty, depth+1, ty)
 572                 }).collect()
 573             }
 574
 575             ty::TyClosure(def_id, substs) => {
 576                 substs.upvar_tys(def_id, self).map(|ty| {
 577                     self.dtorck_constraint_for_ty(span, for_ty, depth+1, ty)
 578                 }).collect()
 579             }
 580
 581             ty::TyGenerator(def_id, substs, _) => {
 582                 // Note that the interior types are ignored here.
 583                 // Any type reachable inside the interior must also be reachable
 584                 // through the upvars.
 585                 substs.upvar_tys(def_id, self).map(|ty| {
 586                     self.dtorck_constraint_for_ty(span, for_ty, depth+1, ty)
 587                 }).collect()
 588             }
 589
 590             ty::TyAdt(def, substs) => {
 591                 let ty::DtorckConstraint {
 592                     dtorck_types, outlives
 593                 } = self.at(span).adt_dtorck_constraint(def.did);
 594                 Ok(ty::DtorckConstraint {
 595                     // FIXME: we can try to recursively `dtorck_constraint_on_ty`
 596                     // there, but that needs some way to handle cycles.
 597                     dtorck_types: dtorck_types.subst(self, substs),
 598                     outlives: outlives.subst(self, substs)
 599                 })
 600             }
 601
 602             // Objects must be alive in order for their destructor
 603             // to be called.
 604             ty::TyDynamic(..) => Ok(ty::DtorckConstraint {
 605                 outlives: vec![ty.into()],
 606                 dtorck_types: vec![],
 607             }),
 608
 609             // Types that can't be resolved. Pass them forward.
 610             ty::TyProjection(..) | ty::TyAnon(..) | ty::TyParam(..) => {
 611                 Ok(ty::DtorckConstraint {
 612                     outlives: vec![],
 613                     dtorck_types: vec![ty],
 614                 })
 615             }
 616
 617             ty::TyInfer(..) | ty::TyError => {
 618                 self.sess.delay_span_bug(span, "unresolved type in dtorck");
 619                 Err(ErrorReported)
 620             }
 621         };
 622
 623         debug!("dtorck_constraint_for_ty({:?}) = {:?}", ty, result);
 624         result
 625     }
 626
 627     pub fn is_closure(self, def_id: DefId) -> bool {
 628         self.def_key(def_id).disambiguated_data.data == DefPathData::ClosureExpr
 629     }
 630
 631     /// Given the `DefId` of a fn or closure, returns the `DefId` of
 632     /// the innermost fn item that the closure is contained within.
 633     /// This is a significant def-id because, when we do
 634     /// type-checking, we type-check this fn item and all of its
 635     /// (transitive) closures together.  Therefore, when we fetch the
 636     /// `typeck_tables_of` the closure, for example, we really wind up
 637     /// fetching the `typeck_tables_of` the enclosing fn item.
 638     pub fn closure_base_def_id(self, def_id: DefId) -> DefId {
 639         let mut def_id = def_id;
 640         while self.is_closure(def_id) {
 641             def_id = self.parent_def_id(def_id).unwrap_or_else(|| {
 642                 bug!("closure {:?} has no parent", def_id);
 643             });
 644         }
 645         def_id
 646     }
 647
 648     /// Given the def-id and substs a closure, creates the type of
 649     /// `self` argument that the closure expects. For example, for a
 650     /// `Fn` closure, this would return a reference type `&T` where
 651     /// `T=closure_ty`.
 652     ///
 653     /// Returns `None` if this closure's kind has not yet been inferred.
 654     /// This should only be possible during type checking.
 655     ///
 656     /// Note that the return value is a late-bound region and hence
 657     /// wrapped in a binder.
 658     pub fn closure_env_ty(self,
 659                           closure_def_id: DefId,
 660                           closure_substs: ty::ClosureSubsts<'tcx>)
 661                           -> Option<ty::Binder<Ty<'tcx>>>
 662     {
 663         let closure_ty = self.mk_closure(closure_def_id, closure_substs);
 664         let env_region = ty::ReLateBound(ty::DebruijnIndex::new(1), ty::BrEnv);
 665         let closure_kind_ty = closure_substs.closure_kind_ty(closure_def_id, self);
 666         let closure_kind = closure_kind_ty.to_opt_closure_kind()?;
 667         let env_ty = match closure_kind {
 668             ty::ClosureKind::Fn => self.mk_imm_ref(self.mk_region(env_region), closure_ty),
 669             ty::ClosureKind::FnMut => self.mk_mut_ref(self.mk_region(env_region), closure_ty),
 670             ty::ClosureKind::FnOnce => closure_ty,
 671         };
 672         Some(ty::Binder(env_ty))
 673     }
 674
 675     /// Given the def-id of some item that has no type parameters, make
 676     /// a suitable "empty substs" for it.
 677     pub fn empty_substs_for_def_id(self, item_def_id: DefId) -> &'tcx ty::Substs<'tcx> {
 678         ty::Substs::for_item(self, item_def_id,
 679                              |_, _| self.types.re_erased,
 680                              |_, _| {
 681             bug!("empty_substs_for_def_id: {:?} has type parameters", item_def_id)
 682         })
 683     }
 684
 685     pub fn const_usize(&self, val: u16) -> ConstInt {
 686         match self.sess.target.usize_ty {
 687             ast::UintTy::U16 => ConstInt::Usize(ConstUsize::Us16(val as u16)),
 688             ast::UintTy::U32 => ConstInt::Usize(ConstUsize::Us32(val as u32)),
 689             ast::UintTy::U64 => ConstInt::Usize(ConstUsize::Us64(val as u64)),
 690             _ => bug!(),
 691         }
 692     }
 693
 694     /// Check if the node pointed to by def_id is a mutable static item
 695     pub fn is_static_mut(&self, def_id: DefId) -> bool {
 696         if let Some(node) = self.hir.get_if_local(def_id) {
 697             match node {
 698                 Node::NodeItem(&hir::Item {
 699                     node: hir::ItemStatic(_, hir::MutMutable, _), ..
 700                 }) => true,
 701                 Node::NodeForeignItem(&hir::ForeignItem {
 702                     node: hir::ForeignItemStatic(_, mutbl), ..
 703                 }) => mutbl,
 704                 _ => false
 705             }
 706         } else {
 707             match self.describe_def(def_id) {
 708                 Some(Def::Static(_, mutbl)) => mutbl,
 709                 _ => false
 710             }
 711         }
 712     }
 713 }
 714
 715 pub struct TypeIdHasher<'a, 'gcx: 'a+'tcx, 'tcx: 'a, W> {
 716     tcx: TyCtxt<'a, 'gcx, 'tcx>,
 717     state: StableHasher<W>,
 718 }
 719
 720 impl<'a, 'gcx, 'tcx, W> TypeIdHasher<'a, 'gcx, 'tcx, W>
 721     where W: StableHasherResult
 722 {
 723     pub fn new(tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Self {
 724         TypeIdHasher { tcx: tcx, state: StableHasher::new() }
 725     }
 726
 727     pub fn finish(self) -> W {
 728         self.state.finish()
 729     }
 730
 731     pub fn hash<T: Hash>(&mut self, x: T) {
 732         x.hash(&mut self.state);
 733     }
 734
 735     fn hash_discriminant_u8<T>(&mut self, x: &T) {
 736         let v = unsafe {
 737             intrinsics::discriminant_value(x)
 738         };
 739         let b = v as u8;
 740         assert_eq!(v, b as u64);
 741         self.hash(b)
 742     }
 743
 744     fn def_id(&mut self, did: DefId) {
 745         // Hash the DefPath corresponding to the DefId, which is independent
 746         // of compiler internal state. We already have a stable hash value of
 747         // all DefPaths available via tcx.def_path_hash(), so we just feed that
 748         // into the hasher.
 749         let hash = self.tcx.def_path_hash(did);
 750         self.hash(hash);
 751     }
 752 }
 753
 754 impl<'a, 'gcx, 'tcx, W> TypeVisitor<'tcx> for TypeIdHasher<'a, 'gcx, 'tcx, W>
 755     where W: StableHasherResult
 756 {
 757     fn visit_ty(&mut self, ty: Ty<'tcx>) -> bool {
 758         // Distinguish between the Ty variants uniformly.
 759         self.hash_discriminant_u8(&ty.sty);
 760
 761         match ty.sty {
 762             TyInt(i) => self.hash(i),
 763             TyUint(u) => self.hash(u),
 764             TyFloat(f) => self.hash(f),
 765             TyArray(_, n) => {
 766                 self.hash_discriminant_u8(&n.val);
 767                 match n.val {
 768                     ConstVal::Integral(x) => self.hash(x.to_u64().unwrap()),
 769                     ConstVal::Unevaluated(def_id, _) => self.def_id(def_id),
 770                     _ => bug!("arrays should not have {:?} as length", n)
 771                 }
 772             }
 773             TyRawPtr(m) |
 774             TyRef(_, m) => self.hash(m.mutbl),
 775             TyClosure(def_id, _) |
 776             TyGenerator(def_id, _, _) |
 777             TyAnon(def_id, _) |
 778             TyFnDef(def_id, _) => self.def_id(def_id),
 779             TyAdt(d, _) => self.def_id(d.did),
 780             TyForeign(def_id) => self.def_id(def_id),
 781             TyFnPtr(f) => {
 782                 self.hash(f.unsafety());
 783                 self.hash(f.abi());
 784                 self.hash(f.variadic());
 785                 self.hash(f.inputs().skip_binder().len());
 786             }
 787             TyDynamic(ref data, ..) => {
 788                 if let Some(p) = data.principal() {
 789                     self.def_id(p.def_id());
 790                 }
 791                 for d in data.auto_traits() {
 792                     self.def_id(d);
 793                 }
 794             }
 795             TyGeneratorWitness(tys) => {
 796                 self.hash(tys.skip_binder().len());
 797             }
 798             TyTuple(tys, defaulted) => {
 799                 self.hash(tys.len());
 800                 self.hash(defaulted);
 801             }
 802             TyParam(p) => {
 803                 self.hash(p.idx);
 804                 self.hash(p.name.as_str());
 805             }
 806             TyProjection(ref data) => {
 807                 self.def_id(data.item_def_id);
 808             }
 809             TyNever |
 810             TyBool |
 811             TyChar |
 812             TyStr |
 813             TySlice(_) => {}
 814
 815             TyError |
 816             TyInfer(_) => bug!("TypeIdHasher: unexpected type {}", ty)
 817         }
 818
 819         ty.super_visit_with(self)
 820     }
 821
 822     fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 823         self.hash_discriminant_u8(r);
 824         match *r {
 825             ty::ReErased |
 826             ty::ReStatic |
 827             ty::ReEmpty => {
 828                 // No variant fields to hash for these ...
 829             }
 830             ty::ReLateBound(db, ty::BrAnon(i)) => {
 831                 self.hash(db.depth);
 832                 self.hash(i);
 833             }
 834             ty::ReEarlyBound(ty::EarlyBoundRegion { def_id, .. }) => {
 835                 self.def_id(def_id);
 836             }
 837
 838             ty::ReClosureBound(..) |
 839             ty::ReLateBound(..) |
 840             ty::ReFree(..) |
 841             ty::ReScope(..) |
 842             ty::ReVar(..) |
 843             ty::ReSkolemized(..) => {
 844                 bug!("TypeIdHasher: unexpected region {:?}", r)
 845             }
 846         }
 847         false
 848     }
 849
 850     fn visit_binder<T: TypeFoldable<'tcx>>(&mut self, x: &ty::Binder<T>) -> bool {
 851         // Anonymize late-bound regions so that, for example:
 852         // `for<'a, b> fn(&'a &'b T)` and `for<'a, b> fn(&'b &'a T)`
 853         // result in the same TypeId (the two types are equivalent).
 854         self.tcx.anonymize_late_bound_regions(x).super_visit_with(self)
 855     }
 856 }
 857
 858 impl<'a, 'tcx> ty::TyS<'tcx> {
 859     pub fn moves_by_default(&'tcx self,
 860                             tcx: TyCtxt<'a, 'tcx, 'tcx>,
 861                             param_env: ty::ParamEnv<'tcx>,
 862                             span: Span)
 863                             -> bool {
 864         !tcx.at(span).is_copy_raw(param_env.and(self))
 865     }
 866
 867     pub fn is_sized(&'tcx self,
 868                     tcx_at: TyCtxtAt<'a, 'tcx, 'tcx>,
 869                     param_env: ty::ParamEnv<'tcx>)-> bool
 870     {
 871         tcx_at.is_sized_raw(param_env.and(self))
 872     }
 873
 874     pub fn is_freeze(&'tcx self,
 875                      tcx: TyCtxt<'a, 'tcx, 'tcx>,
 876                      param_env: ty::ParamEnv<'tcx>,
 877                      span: Span)-> bool
 878     {
 879         tcx.at(span).is_freeze_raw(param_env.and(self))
 880     }
 881
 882     /// If `ty.needs_drop(...)` returns `true`, then `ty` is definitely
 883     /// non-copy and *might* have a destructor attached; if it returns
 884     /// `false`, then `ty` definitely has no destructor (i.e. no drop glue).
 885     ///
 886     /// (Note that this implies that if `ty` has a destructor attached,
 887     /// then `needs_drop` will definitely return `true` for `ty`.)
 888     #[inline]
 889     pub fn needs_drop(&'tcx self,
 890                       tcx: TyCtxt<'a, 'tcx, 'tcx>,
 891                       param_env: ty::ParamEnv<'tcx>)
 892                       -> bool {
 893         tcx.needs_drop_raw(param_env.and(self))
 894     }
 895
 896     /// Check whether a type is representable. This means it cannot contain unboxed
 897     /// structural recursion. This check is needed for structs and enums.
 898     pub fn is_representable(&'tcx self,
 899                             tcx: TyCtxt<'a, 'tcx, 'tcx>,
 900                             sp: Span)
 901                             -> Representability {
 902
 903         // Iterate until something non-representable is found
 904         fn fold_repr<It: Iterator<Item=Representability>>(iter: It) -> Representability {
 905             iter.fold(Representability::Representable, |r1, r2| {
 906                 match (r1, r2) {
 907                     (Representability::SelfRecursive(v1),
 908                      Representability::SelfRecursive(v2)) => {
 909                         Representability::SelfRecursive(v1.iter().map(|s| *s).chain(v2).collect())
 910                     }
 911                     (r1, r2) => cmp::max(r1, r2)
 912                 }
 913             })
 914         }
 915
 916         fn are_inner_types_recursive<'a, 'tcx>(
 917             tcx: TyCtxt<'a, 'tcx, 'tcx>, sp: Span,
 918             seen: &mut Vec<Ty<'tcx>>,
 919             representable_cache: &mut FxHashMap<Ty<'tcx>, Representability>,
 920             ty: Ty<'tcx>)
 921             -> Representability
 922         {
 923             match ty.sty {
 924                 TyTuple(ref ts, _) => {
 925                     // Find non representable
 926                     fold_repr(ts.iter().map(|ty| {
 927                         is_type_structurally_recursive(tcx, sp, seen, representable_cache, ty)
 928                     }))
 929                 }
 930                 // Fixed-length vectors.
 931                 // FIXME(#11924) Behavior undecided for zero-length vectors.
 932                 TyArray(ty, _) => {
 933                     is_type_structurally_recursive(tcx, sp, seen, representable_cache, ty)
 934                 }
 935                 TyAdt(def, substs) => {
 936                     // Find non representable fields with their spans
 937                     fold_repr(def.all_fields().map(|field| {
 938                         let ty = field.ty(tcx, substs);
 939                         let span = tcx.hir.span_if_local(field.did).unwrap_or(sp);
 940                         match is_type_structurally_recursive(tcx, span, seen,
 941                                                              representable_cache, ty)
 942                         {
 943                             Representability::SelfRecursive(_) => {
 944                                 Representability::SelfRecursive(vec![span])
 945                             }
 946                             x => x,
 947                         }
 948                     }))
 949                 }
 950                 TyClosure(..) => {
 951                     // this check is run on type definitions, so we don't expect
 952                     // to see closure types
 953                     bug!("requires check invoked on inapplicable type: {:?}", ty)
 954                 }
 955                 _ => Representability::Representable,
 956             }
 957         }
 958
 959         fn same_struct_or_enum<'tcx>(ty: Ty<'tcx>, def: &'tcx ty::AdtDef) -> bool {
 960             match ty.sty {
 961                 TyAdt(ty_def, _) => {
 962                      ty_def == def
 963                 }
 964                 _ => false
 965             }
 966         }
 967
 968         fn same_type<'tcx>(a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
 969             match (&a.sty, &b.sty) {
 970                 (&TyAdt(did_a, substs_a), &TyAdt(did_b, substs_b)) => {
 971                     if did_a != did_b {
 972                         return false;
 973                     }
 974
 975                     substs_a.types().zip(substs_b.types()).all(|(a, b)| same_type(a, b))
 976                 }
 977                 _ => a == b,
 978             }
 979         }
 980
 981         // Does the type `ty` directly (without indirection through a pointer)
 982         // contain any types on stack `seen`?
 983         fn is_type_structurally_recursive<'a, 'tcx>(
 984             tcx: TyCtxt<'a, 'tcx, 'tcx>,
 985             sp: Span,
 986             seen: &mut Vec<Ty<'tcx>>,
 987             representable_cache: &mut FxHashMap<Ty<'tcx>, Representability>,
 988             ty: Ty<'tcx>) -> Representability
 989         {
 990             debug!("is_type_structurally_recursive: {:?} {:?}", ty, sp);
 991             if let Some(representability) = representable_cache.get(ty) {
 992                 debug!("is_type_structurally_recursive: {:?} {:?} - (cached) {:?}",
 993                        ty, sp, representability);
 994                 return representability.clone();
 995             }
 996
 997             let representability = is_type_structurally_recursive_inner(
 998                 tcx, sp, seen, representable_cache, ty);
 999
1000             representable_cache.insert(ty, representability.clone());
1001             representability
1002         }
1003
1004         fn is_type_structurally_recursive_inner<'a, 'tcx>(
1005             tcx: TyCtxt<'a, 'tcx, 'tcx>,
1006             sp: Span,
1007             seen: &mut Vec<Ty<'tcx>>,
1008             representable_cache: &mut FxHashMap<Ty<'tcx>, Representability>,
1009             ty: Ty<'tcx>) -> Representability
1010         {
1011             match ty.sty {
1012                 TyAdt(def, _) => {
1013                     {
1014                         // Iterate through stack of previously seen types.
1015                         let mut iter = seen.iter();
1016
1017                         // The first item in `seen` is the type we are actually curious about.
1018                         // We want to return SelfRecursive if this type contains itself.
1019                         // It is important that we DON'T take generic parameters into account
1020                         // for this check, so that Bar<T> in this example counts as SelfRecursive:
1021                         //
1022                         // struct Foo;
1023                         // struct Bar<T> { x: Bar<Foo> }
1024
1025                         if let Some(&seen_type) = iter.next() {
1026                             if same_struct_or_enum(seen_type, def) {
1027                                 debug!("SelfRecursive: {:?} contains {:?}",
1028                                        seen_type,
1029                                        ty);
1030                                 return Representability::SelfRecursive(vec![sp]);
1031                             }
1032                         }
1033
1034                         // We also need to know whether the first item contains other types
1035                         // that are structurally recursive. If we don't catch this case, we
1036                         // will recurse infinitely for some inputs.
1037                         //
1038                         // It is important that we DO take generic parameters into account
1039                         // here, so that code like this is considered SelfRecursive, not
1040                         // ContainsRecursive:
1041                         //
1042                         // struct Foo { Option<Option<Foo>> }
1043
1044                         for &seen_type in iter {
1045                             if same_type(ty, seen_type) {
1046                                 debug!("ContainsRecursive: {:?} contains {:?}",
1047                                        seen_type,
1048                                        ty);
1049                                 return Representability::ContainsRecursive;
1050                             }
1051                         }
1052                     }
1053
1054                     // For structs and enums, track all previously seen types by pushing them
1055                     // onto the 'seen' stack.
1056                     seen.push(ty);
1057                     let out = are_inner_types_recursive(tcx, sp, seen, representable_cache, ty);
1058                     seen.pop();
1059                     out
1060                 }
1061                 _ => {
1062                     // No need to push in other cases.
1063                     are_inner_types_recursive(tcx, sp, seen, representable_cache, ty)
1064                 }
1065             }
1066         }
1067
1068         debug!("is_type_representable: {:?}", self);
1069
1070         // To avoid a stack overflow when checking an enum variant or struct that
1071         // contains a different, structurally recursive type, maintain a stack
1072         // of seen types and check recursion for each of them (issues #3008, #3779).
1073         let mut seen: Vec<Ty> = Vec::new();
1074         let mut representable_cache = FxHashMap();
1075         let r = is_type_structurally_recursive(
1076             tcx, sp, &mut seen, &mut representable_cache, self);
1077         debug!("is_type_representable: {:?} is {:?}", self, r);
1078         r
1079     }
1080 }
1081
1082 fn is_copy_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1083                          query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
1084                          -> bool
1085 {
1086     let (param_env, ty) = query.into_parts();
1087     let trait_def_id = tcx.require_lang_item(lang_items::CopyTraitLangItem);
1088     tcx.infer_ctxt()
1089        .enter(|infcx| traits::type_known_to_meet_bound(&infcx,
1090                                                        param_env,
1091                                                        ty,
1092                                                        trait_def_id,
1093                                                        DUMMY_SP))
1094 }
1095
1096 fn is_sized_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1097                           query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
1098                           -> bool
1099 {
1100     let (param_env, ty) = query.into_parts();
1101     let trait_def_id = tcx.require_lang_item(lang_items::SizedTraitLangItem);
1102     tcx.infer_ctxt()
1103        .enter(|infcx| traits::type_known_to_meet_bound(&infcx,
1104                                                        param_env,
1105                                                        ty,
1106                                                        trait_def_id,
1107                                                        DUMMY_SP))
1108 }
1109
1110 fn is_freeze_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1111                            query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
1112                            -> bool
1113 {
1114     let (param_env, ty) = query.into_parts();
1115     let trait_def_id = tcx.require_lang_item(lang_items::FreezeTraitLangItem);
1116     tcx.infer_ctxt()
1117        .enter(|infcx| traits::type_known_to_meet_bound(&infcx,
1118                                                        param_env,
1119                                                        ty,
1120                                                        trait_def_id,
1121                                                        DUMMY_SP))
1122 }
1123
1124 fn needs_drop_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1125                             query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
1126                             -> bool
1127 {
1128     let (param_env, ty) = query.into_parts();
1129
1130     let needs_drop = |ty: Ty<'tcx>| -> bool {
1131         match ty::queries::needs_drop_raw::try_get(tcx, DUMMY_SP, param_env.and(ty)) {
1132             Ok(v) => v,
1133             Err(mut bug) => {
1134                 // Cycles should be reported as an error by `check_representable`.
1135                 //
1136                 // Consider the type as not needing drop in the meanwhile to
1137                 // avoid further errors.
1138                 //
1139                 // In case we forgot to emit a bug elsewhere, delay our
1140                 // diagnostic to get emitted as a compiler bug.
1141                 bug.delay_as_bug();
1142                 false
1143             }
1144         }
1145     };
1146
1147     assert!(!ty.needs_infer());
1148
1149     match ty.sty {
1150         // Fast-path for primitive types
1151         ty::TyInfer(ty::FreshIntTy(_)) | ty::TyInfer(ty::FreshFloatTy(_)) |
1152         ty::TyBool | ty::TyInt(_) | ty::TyUint(_) | ty::TyFloat(_) | ty::TyNever |
1153         ty::TyFnDef(..) | ty::TyFnPtr(_) | ty::TyChar | ty::TyGeneratorWitness(..) |
1154         ty::TyRawPtr(_) | ty::TyRef(..) | ty::TyStr => false,
1155
1156         // Foreign types can never have destructors
1157         ty::TyForeign(..) => false,
1158
1159         // Issue #22536: We first query type_moves_by_default.  It sees a
1160         // normalized version of the type, and therefore will definitely
1161         // know whether the type implements Copy (and thus needs no
1162         // cleanup/drop/zeroing) ...
1163         _ if !ty.moves_by_default(tcx, param_env, DUMMY_SP) => false,
1164
1165         // ... (issue #22536 continued) but as an optimization, still use
1166         // prior logic of asking for the structural "may drop".
1167
1168         // FIXME(#22815): Note that this is a conservative heuristic;
1169         // it may report that the type "may drop" when actual type does
1170         // not actually have a destructor associated with it. But since
1171         // the type absolutely did not have the `Copy` bound attached
1172         // (see above), it is sound to treat it as having a destructor.
1173
1174         // User destructors are the only way to have concrete drop types.
1175         ty::TyAdt(def, _) if def.has_dtor(tcx) => true,
1176
1177         // Can refer to a type which may drop.
1178         // FIXME(eddyb) check this against a ParamEnv.
1179         ty::TyDynamic(..) | ty::TyProjection(..) | ty::TyParam(_) |
1180         ty::TyAnon(..) | ty::TyInfer(_) | ty::TyError => true,
1181
1182         // Structural recursion.
1183         ty::TyArray(ty, _) | ty::TySlice(ty) => needs_drop(ty),
1184
1185         ty::TyClosure(def_id, ref substs) => substs.upvar_tys(def_id, tcx).any(needs_drop),
1186
1187         // Pessimistically assume that all generators will require destructors
1188         // as we don't know if a destructor is a noop or not until after the MIR
1189         // state transformation pass
1190         ty::TyGenerator(..) => true,
1191
1192         ty::TyTuple(ref tys, _) => tys.iter().cloned().any(needs_drop),
1193
1194         // unions don't have destructors regardless of the child types
1195         ty::TyAdt(def, _) if def.is_union() => false,
1196
1197         ty::TyAdt(def, substs) =>
1198             def.variants.iter().any(
1199                 |variant| variant.fields.iter().any(
1200                     |field| needs_drop(field.ty(tcx, substs)))),
1201     }
1202 }
1203
1204 pub enum ExplicitSelf<'tcx> {
1205     ByValue,
1206     ByReference(ty::Region<'tcx>, hir::Mutability),
1207     ByRawPointer(hir::Mutability),
1208     ByBox,
1209     Other
1210 }
1211
1212 impl<'tcx> ExplicitSelf<'tcx> {
1213     /// Categorizes an explicit self declaration like `self: SomeType`
1214     /// into either `self`, `&self`, `&mut self`, `Box<self>`, or
1215     /// `Other`.
1216     /// This is mainly used to require the arbitrary_self_types feature
1217     /// in the case of `Other`, to improve error messages in the common cases,
1218     /// and to make `Other` non-object-safe.
1219     ///
1220     /// Examples:
1221     ///
1222     /// ```
1223     /// impl<'a> Foo for &'a T {
1224     ///     // Legal declarations:
1225     ///     fn method1(self: &&'a T); // ExplicitSelf::ByReference
1226     ///     fn method2(self: &'a T); // ExplicitSelf::ByValue
1227     ///     fn method3(self: Box<&'a T>); // ExplicitSelf::ByBox
1228     ///     fn method4(self: Rc<&'a T>); // ExplicitSelf::Other
1229     ///
1230     ///     // Invalid cases will be caught by `check_method_receiver`:
1231     ///     fn method_err1(self: &'a mut T); // ExplicitSelf::Other
1232     ///     fn method_err2(self: &'static T) // ExplicitSelf::ByValue
1233     ///     fn method_err3(self: &&T) // ExplicitSelf::ByReference
1234     /// }
1235     /// ```
1236     ///
1237     pub fn determine<P>(
1238         self_arg_ty: Ty<'tcx>,
1239         is_self_ty: P
1240     ) -> ExplicitSelf<'tcx>
1241     where
1242         P: Fn(Ty<'tcx>) -> bool
1243     {
1244         use self::ExplicitSelf::*;
1245
1246         match self_arg_ty.sty {
1247             _ if is_self_ty(self_arg_ty) => ByValue,
1248             ty::TyRef(region, ty::TypeAndMut { ty, mutbl }) if is_self_ty(ty) => {
1249                 ByReference(region, mutbl)
1250             }
1251             ty::TyRawPtr(ty::TypeAndMut { ty, mutbl }) if is_self_ty(ty) => {
1252                 ByRawPointer(mutbl)
1253             }
1254             ty::TyAdt(def, _) if def.is_box() && is_self_ty(self_arg_ty.boxed_ty()) => {
1255                 ByBox
1256             }
1257             _ => Other
1258         }
1259     }
1260 }
1261
1262 pub fn provide(providers: &mut ty::maps::Providers) {
1263     *providers = ty::maps::Providers {
1264         is_copy_raw,
1265         is_sized_raw,
1266         is_freeze_raw,
1267         needs_drop_raw,
1268         ..*providers
1269     };
1270 }