src/librustc/ty/util.rs

   1 //! Miscellaneous type-system utilities that are too small to deserve their own modules.
   2
   3 use crate::hir;
   4 use crate::hir::def::DefKind;
   5 use crate::hir::def_id::DefId;
   6 use crate::hir::map::DefPathData;
   7 use crate::mir::interpret::{sign_extend, truncate};
   8 use crate::ich::NodeIdHashingMode;
   9 use crate::traits::{self, ObligationCause};
  10 use crate::ty::{self, DefIdTree, Ty, TyCtxt, GenericParamDefKind, TypeFoldable};
  11 use crate::ty::subst::{Subst, InternalSubsts, SubstsRef, UnpackedKind};
  12 use crate::ty::query::TyCtxtAt;
  13 use crate::ty::TyKind::*;
  14 use crate::ty::layout::{Integer, IntegerExt};
  15 use crate::mir::interpret::ConstValue;
  16 use crate::util::common::ErrorReported;
  17 use crate::middle::lang_items;
  18
  19 use rustc_data_structures::stable_hasher::{StableHasher, HashStable};
  20 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  21 use rustc_macros::HashStable;
  22 use std::{cmp, fmt};
  23 use syntax::ast;
  24 use syntax::attr::{self, SignedInt, UnsignedInt};
  25 use syntax_pos::{Span, DUMMY_SP};
  26
  27 #[derive(Copy, Clone, Debug)]
  28 pub struct Discr<'tcx> {
  29     /// Bit representation of the discriminant (e.g., `-128i8` is `0xFF_u128`).
  30     pub val: u128,
  31     pub ty: Ty<'tcx>
  32 }
  33
  34 impl<'tcx> fmt::Display for Discr<'tcx> {
  35     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
  36         match self.ty.sty {
  37             ty::Int(ity) => {
  38                 let size = ty::tls::with(|tcx| {
  39                     Integer::from_attr(&tcx, SignedInt(ity)).size()
  40                 });
  41                 let x = self.val;
  42                 // sign extend the raw representation to be an i128
  43                 let x = sign_extend(x, size) as i128;
  44                 write!(fmt, "{}", x)
  45             },
  46             _ => write!(fmt, "{}", self.val),
  47         }
  48     }
  49 }
  50
  51 impl<'tcx> Discr<'tcx> {
  52     /// Adds `1` to the value and wraps around if the maximum for the type is reached.
  53     pub fn wrap_incr<'a, 'gcx>(self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Self {
  54         self.checked_add(tcx, 1).0
  55     }
  56     pub fn checked_add<'a, 'gcx>(self, tcx: TyCtxt<'a, 'gcx, 'tcx>, n: u128) -> (Self, bool) {
  57         let (int, signed) = match self.ty.sty {
  58             Int(ity) => (Integer::from_attr(&tcx, SignedInt(ity)), true),
  59             Uint(uty) => (Integer::from_attr(&tcx, UnsignedInt(uty)), false),
  60             _ => bug!("non integer discriminant"),
  61         };
  62
  63         let size = int.size();
  64         let bit_size = int.size().bits();
  65         let shift = 128 - bit_size;
  66         if signed {
  67             let sext = |u| {
  68                 sign_extend(u, size) as i128
  69             };
  70             let min = sext(1_u128 << (bit_size - 1));
  71             let max = i128::max_value() >> shift;
  72             let val = sext(self.val);
  73             assert!(n < (i128::max_value() as u128));
  74             let n = n as i128;
  75             let oflo = val > max - n;
  76             let val = if oflo {
  77                 min + (n - (max - val) - 1)
  78             } else {
  79                 val + n
  80             };
  81             // zero the upper bits
  82             let val = val as u128;
  83             let val = truncate(val, size);
  84             (Self {
  85                 val: val as u128,
  86                 ty: self.ty,
  87             }, oflo)
  88         } else {
  89             let max = u128::max_value() >> shift;
  90             let val = self.val;
  91             let oflo = val > max - n;
  92             let val = if oflo {
  93                 n - (max - val) - 1
  94             } else {
  95                 val + n
  96             };
  97             (Self {
  98                 val: val,
  99                 ty: self.ty,
 100             }, oflo)
 101         }
 102     }
 103 }
 104
 105 pub trait IntTypeExt {
 106     fn to_ty<'a, 'gcx, 'tcx>(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Ty<'tcx>;
 107     fn disr_incr<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>, val: Option<Discr<'tcx>>)
 108                            -> Option<Discr<'tcx>>;
 109     fn initial_discriminant<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Discr<'tcx>;
 110 }
 111
 112 impl IntTypeExt for attr::IntType {
 113     fn to_ty<'a, 'gcx, 'tcx>(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Ty<'tcx> {
 114         match *self {
 115             SignedInt(ast::IntTy::I8)       => tcx.types.i8,
 116             SignedInt(ast::IntTy::I16)      => tcx.types.i16,
 117             SignedInt(ast::IntTy::I32)      => tcx.types.i32,
 118             SignedInt(ast::IntTy::I64)      => tcx.types.i64,
 119             SignedInt(ast::IntTy::I128)     => tcx.types.i128,
 120             SignedInt(ast::IntTy::Isize)    => tcx.types.isize,
 121             UnsignedInt(ast::UintTy::U8)    => tcx.types.u8,
 122             UnsignedInt(ast::UintTy::U16)   => tcx.types.u16,
 123             UnsignedInt(ast::UintTy::U32)   => tcx.types.u32,
 124             UnsignedInt(ast::UintTy::U64)   => tcx.types.u64,
 125             UnsignedInt(ast::UintTy::U128)  => tcx.types.u128,
 126             UnsignedInt(ast::UintTy::Usize) => tcx.types.usize,
 127         }
 128     }
 129
 130     fn initial_discriminant<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Discr<'tcx> {
 131         Discr {
 132             val: 0,
 133             ty: self.to_ty(tcx)
 134         }
 135     }
 136
 137     fn disr_incr<'a, 'tcx>(
 138         &self,
 139         tcx: TyCtxt<'a, 'tcx, 'tcx>,
 140         val: Option<Discr<'tcx>>,
 141     ) -> Option<Discr<'tcx>> {
 142         if let Some(val) = val {
 143             assert_eq!(self.to_ty(tcx), val.ty);
 144             let (new, oflo) = val.checked_add(tcx, 1);
 145             if oflo {
 146                 None
 147             } else {
 148                 Some(new)
 149             }
 150         } else {
 151             Some(self.initial_discriminant(tcx))
 152         }
 153     }
 154 }
 155
 156
 157 #[derive(Clone)]
 158 pub enum CopyImplementationError<'tcx> {
 159     InfrigingFields(Vec<&'tcx ty::FieldDef>),
 160     NotAnAdt,
 161     HasDestructor,
 162 }
 163
 164 /// Describes whether a type is representable. For types that are not
 165 /// representable, 'SelfRecursive' and 'ContainsRecursive' are used to
 166 /// distinguish between types that are recursive with themselves and types that
 167 /// contain a different recursive type. These cases can therefore be treated
 168 /// differently when reporting errors.
 169 ///
 170 /// The ordering of the cases is significant. They are sorted so that cmp::max
 171 /// will keep the "more erroneous" of two values.
 172 #[derive(Clone, PartialOrd, Ord, Eq, PartialEq, Debug)]
 173 pub enum Representability {
 174     Representable,
 175     ContainsRecursive,
 176     SelfRecursive(Vec<Span>),
 177 }
 178
 179 impl<'tcx> ty::ParamEnv<'tcx> {
 180     pub fn can_type_implement_copy<'a>(self,
 181                                        tcx: TyCtxt<'a, 'tcx, 'tcx>,
 182                                        self_type: Ty<'tcx>)
 183                                        -> Result<(), CopyImplementationError<'tcx>> {
 184         // FIXME: (@jroesch) float this code up
 185         tcx.infer_ctxt().enter(|infcx| {
 186             let (adt, substs) = match self_type.sty {
 187                 // These types used to have a builtin impl.
 188                 // Now libcore provides that impl.
 189                 ty::Uint(_) | ty::Int(_) | ty::Bool | ty::Float(_) |
 190                 ty::Char | ty::RawPtr(..) | ty::Never |
 191                 ty::Ref(_, _, hir::MutImmutable) => return Ok(()),
 192
 193                 ty::Adt(adt, substs) => (adt, substs),
 194
 195                 _ => return Err(CopyImplementationError::NotAnAdt),
 196             };
 197
 198             let mut infringing = Vec::new();
 199             for variant in &adt.variants {
 200                 for field in &variant.fields {
 201                     let ty = field.ty(tcx, substs);
 202                     if ty.references_error() {
 203                         continue;
 204                     }
 205                     let span = tcx.def_span(field.did);
 206                     let cause = ObligationCause { span, ..ObligationCause::dummy() };
 207                     let ctx = traits::FulfillmentContext::new();
 208                     match traits::fully_normalize(&infcx, ctx, cause, self, &ty) {
 209                         Ok(ty) => if !infcx.type_is_copy_modulo_regions(self, ty, span) {
 210                             infringing.push(field);
 211                         }
 212                         Err(errors) => {
 213                             infcx.report_fulfillment_errors(&errors, None, false);
 214                         }
 215                     };
 216                 }
 217             }
 218             if !infringing.is_empty() {
 219                 return Err(CopyImplementationError::InfrigingFields(infringing));
 220             }
 221             if adt.has_dtor(tcx) {
 222                 return Err(CopyImplementationError::HasDestructor);
 223             }
 224
 225             Ok(())
 226         })
 227     }
 228 }
 229
 230 impl<'a, 'tcx> TyCtxt<'a, 'tcx, 'tcx> {
 231     /// Creates a hash of the type `Ty` which will be the same no matter what crate
 232     /// context it's calculated within. This is used by the `type_id` intrinsic.
 233     pub fn type_id_hash(self, ty: Ty<'tcx>) -> u64 {
 234         let mut hasher = StableHasher::new();
 235         let mut hcx = self.create_stable_hashing_context();
 236
 237         // We want the type_id be independent of the types free regions, so we
 238         // erase them. The erase_regions() call will also anonymize bound
 239         // regions, which is desirable too.
 240         let ty = self.erase_regions(&ty);
 241
 242         hcx.while_hashing_spans(false, |hcx| {
 243             hcx.with_node_id_hashing_mode(NodeIdHashingMode::HashDefPath, |hcx| {
 244                 ty.hash_stable(hcx, &mut hasher);
 245             });
 246         });
 247         hasher.finish()
 248     }
 249 }
 250
 251 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
 252     pub fn has_error_field(self, ty: Ty<'tcx>) -> bool {
 253         if let ty::Adt(def, substs) = ty.sty {
 254             for field in def.all_fields() {
 255                 let field_ty = field.ty(self, substs);
 256                 if let Error = field_ty.sty {
 257                     return true;
 258                 }
 259             }
 260         }
 261         false
 262     }
 263
 264     /// Returns the deeply last field of nested structures, or the same type,
 265     /// if not a structure at all. Corresponds to the only possible unsized
 266     /// field, and its type can be used to determine unsizing strategy.
 267     pub fn struct_tail(self, mut ty: Ty<'tcx>) -> Ty<'tcx> {
 268         loop {
 269             match ty.sty {
 270                 ty::Adt(def, substs) => {
 271                     if !def.is_struct() {
 272                         break;
 273                     }
 274                     match def.non_enum_variant().fields.last() {
 275                         Some(f) => ty = f.ty(self, substs),
 276                         None => break,
 277                     }
 278                 }
 279
 280                 ty::Tuple(tys) => {
 281                     if let Some((&last_ty, _)) = tys.split_last() {
 282                         ty = last_ty.expect_ty();
 283                     } else {
 284                         break;
 285                     }
 286                 }
 287
 288                 _ => {
 289                     break;
 290                 }
 291             }
 292         }
 293         ty
 294     }
 295
 296     /// Same as applying struct_tail on `source` and `target`, but only
 297     /// keeps going as long as the two types are instances of the same
 298     /// structure definitions.
 299     /// For `(Foo<Foo<T>>, Foo<dyn Trait>)`, the result will be `(Foo<T>, Trait)`,
 300     /// whereas struct_tail produces `T`, and `Trait`, respectively.
 301     pub fn struct_lockstep_tails(self,
 302                                  source: Ty<'tcx>,
 303                                  target: Ty<'tcx>)
 304                                  -> (Ty<'tcx>, Ty<'tcx>) {
 305         let (mut a, mut b) = (source, target);
 306         loop {
 307             match (&a.sty, &b.sty) {
 308                 (&Adt(a_def, a_substs), &Adt(b_def, b_substs))
 309                         if a_def == b_def && a_def.is_struct() => {
 310                     if let Some(f) = a_def.non_enum_variant().fields.last() {
 311                         a = f.ty(self, a_substs);
 312                         b = f.ty(self, b_substs);
 313                     } else {
 314                         break;
 315                     }
 316                 },
 317                 (&Tuple(a_tys), &Tuple(b_tys))
 318                         if a_tys.len() == b_tys.len() => {
 319                     if let Some(a_last) = a_tys.last() {
 320                         a = a_last.expect_ty();
 321                         b = b_tys.last().unwrap().expect_ty();
 322                     } else {
 323                         break;
 324                     }
 325                 },
 326                 _ => break,
 327             }
 328         }
 329         (a, b)
 330     }
 331
 332     /// Given a set of predicates that apply to an object type, returns
 333     /// the region bounds that the (erased) `Self` type must
 334     /// outlive. Precisely *because* the `Self` type is erased, the
 335     /// parameter `erased_self_ty` must be supplied to indicate what type
 336     /// has been used to represent `Self` in the predicates
 337     /// themselves. This should really be a unique type; `FreshTy(0)` is a
 338     /// popular choice.
 339     ///
 340     /// N.B., in some cases, particularly around higher-ranked bounds,
 341     /// this function returns a kind of conservative approximation.
 342     /// That is, all regions returned by this function are definitely
 343     /// required, but there may be other region bounds that are not
 344     /// returned, as well as requirements like `for<'a> T: 'a`.
 345     ///
 346     /// Requires that trait definitions have been processed so that we can
 347     /// elaborate predicates and walk supertraits.
 348     //
 349     // FIXME: callers may only have a `&[Predicate]`, not a `Vec`, so that's
 350     // what this code should accept.
 351     pub fn required_region_bounds(self,
 352                                   erased_self_ty: Ty<'tcx>,
 353                                   predicates: Vec<ty::Predicate<'tcx>>)
 354                                   -> Vec<ty::Region<'tcx>>    {
 355         debug!("required_region_bounds(erased_self_ty={:?}, predicates={:?})",
 356                erased_self_ty,
 357                predicates);
 358
 359         assert!(!erased_self_ty.has_escaping_bound_vars());
 360
 361         traits::elaborate_predicates(self, predicates)
 362             .filter_map(|predicate| {
 363                 match predicate {
 364                     ty::Predicate::Projection(..) |
 365                     ty::Predicate::Trait(..) |
 366                     ty::Predicate::Subtype(..) |
 367                     ty::Predicate::WellFormed(..) |
 368                     ty::Predicate::ObjectSafe(..) |
 369                     ty::Predicate::ClosureKind(..) |
 370                     ty::Predicate::RegionOutlives(..) |
 371                     ty::Predicate::ConstEvaluatable(..) => {
 372                         None
 373                     }
 374                     ty::Predicate::TypeOutlives(predicate) => {
 375                         // Search for a bound of the form `erased_self_ty
 376                         // : 'a`, but be wary of something like `for<'a>
 377                         // erased_self_ty : 'a` (we interpret a
 378                         // higher-ranked bound like that as 'static,
 379                         // though at present the code in `fulfill.rs`
 380                         // considers such bounds to be unsatisfiable, so
 381                         // it's kind of a moot point since you could never
 382                         // construct such an object, but this seems
 383                         // correct even if that code changes).
 384                         let ty::OutlivesPredicate(ref t, ref r) = predicate.skip_binder();
 385                         if t == &erased_self_ty && !r.has_escaping_bound_vars() {
 386                             Some(*r)
 387                         } else {
 388                             None
 389                         }
 390                     }
 391                 }
 392             })
 393             .collect()
 394     }
 395
 396     /// Calculate the destructor of a given type.
 397     pub fn calculate_dtor(
 398         self,
 399         adt_did: DefId,
 400         validate: &mut dyn FnMut(Self, DefId) -> Result<(), ErrorReported>
 401     ) -> Option<ty::Destructor> {
 402         let drop_trait = if let Some(def_id) = self.lang_items().drop_trait() {
 403             def_id
 404         } else {
 405             return None;
 406         };
 407
 408         self.ensure().coherent_trait(drop_trait);
 409
 410         let mut dtor_did = None;
 411         let ty = self.type_of(adt_did);
 412         self.for_each_relevant_impl(drop_trait, ty, |impl_did| {
 413             if let Some(item) = self.associated_items(impl_did).next() {
 414                 if validate(self, impl_did).is_ok() {
 415                     dtor_did = Some(item.def_id);
 416                 }
 417             }
 418         });
 419
 420         Some(ty::Destructor { did: dtor_did? })
 421     }
 422
 423     /// Returns the set of types that are required to be alive in
 424     /// order to run the destructor of `def` (see RFCs 769 and
 425     /// 1238).
 426     ///
 427     /// Note that this returns only the constraints for the
 428     /// destructor of `def` itself. For the destructors of the
 429     /// contents, you need `adt_dtorck_constraint`.
 430     pub fn destructor_constraints(self, def: &'tcx ty::AdtDef)
 431                                   -> Vec<ty::subst::Kind<'tcx>>
 432     {
 433         let dtor = match def.destructor(self) {
 434             None => {
 435                 debug!("destructor_constraints({:?}) - no dtor", def.did);
 436                 return vec![]
 437             }
 438             Some(dtor) => dtor.did
 439         };
 440
 441         // RFC 1238: if the destructor method is tagged with the
 442         // attribute `unsafe_destructor_blind_to_params`, then the
 443         // compiler is being instructed to *assume* that the
 444         // destructor will not access borrowed data,
 445         // even if such data is otherwise reachable.
 446         //
 447         // Such access can be in plain sight (e.g., dereferencing
 448         // `*foo.0` of `Foo<'a>(&'a u32)`) or indirectly hidden
 449         // (e.g., calling `foo.0.clone()` of `Foo<T:Clone>`).
 450         if self.has_attr(dtor, "unsafe_destructor_blind_to_params") {
 451             debug!("destructor_constraint({:?}) - blind", def.did);
 452             return vec![];
 453         }
 454
 455         let impl_def_id = self.associated_item(dtor).container.id();
 456         let impl_generics = self.generics_of(impl_def_id);
 457
 458         // We have a destructor - all the parameters that are not
 459         // pure_wrt_drop (i.e, don't have a #[may_dangle] attribute)
 460         // must be live.
 461
 462         // We need to return the list of parameters from the ADTs
 463         // generics/substs that correspond to impure parameters on the
 464         // impl's generics. This is a bit ugly, but conceptually simple:
 465         //
 466         // Suppose our ADT looks like the following
 467         //
 468         //     struct S<X, Y, Z>(X, Y, Z);
 469         //
 470         // and the impl is
 471         //
 472         //     impl<#[may_dangle] P0, P1, P2> Drop for S<P1, P2, P0>
 473         //
 474         // We want to return the parameters (X, Y). For that, we match
 475         // up the item-substs <X, Y, Z> with the substs on the impl ADT,
 476         // <P1, P2, P0>, and then look up which of the impl substs refer to
 477         // parameters marked as pure.
 478
 479         let impl_substs = match self.type_of(impl_def_id).sty {
 480             ty::Adt(def_, substs) if def_ == def => substs,
 481             _ => bug!()
 482         };
 483
 484         let item_substs = match self.type_of(def.did).sty {
 485             ty::Adt(def_, substs) if def_ == def => substs,
 486             _ => bug!()
 487         };
 488
 489         let result = item_substs.iter().zip(impl_substs.iter())
 490             .filter(|&(_, &k)| {
 491                 match k.unpack() {
 492                     UnpackedKind::Lifetime(&ty::RegionKind::ReEarlyBound(ref ebr)) => {
 493                         !impl_generics.region_param(ebr, self).pure_wrt_drop
 494                     }
 495                     UnpackedKind::Type(&ty::TyS {
 496                         sty: ty::Param(ref pt), ..
 497                     }) => {
 498                         !impl_generics.type_param(pt, self).pure_wrt_drop
 499                     }
 500                     UnpackedKind::Const(&ty::Const {
 501                         val: ConstValue::Param(ref pc),
 502                         ..
 503                     }) => {
 504                         !impl_generics.const_param(pc, self).pure_wrt_drop
 505                     }
 506                     UnpackedKind::Lifetime(_) |
 507                     UnpackedKind::Type(_) |
 508                     UnpackedKind::Const(_) => {
 509                         // Not a type, const or region param: this should be reported
 510                         // as an error.
 511                         false
 512                     }
 513                 }
 514             })
 515             .map(|(&item_param, _)| item_param)
 516             .collect();
 517         debug!("destructor_constraint({:?}) = {:?}", def.did, result);
 518         result
 519     }
 520
 521     /// Returns `true` if `def_id` refers to a closure (e.g., `|x| x * 2`). Note
 522     /// that closures have a `DefId`, 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     /// `DefId` 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
 529     }
 530
 531     /// Returns `true` if `def_id` refers to a trait (i.e., `trait Foo { ... }`).
 532     pub fn is_trait(self, def_id: DefId) -> bool {
 533         self.def_kind(def_id) == Some(DefKind::Trait)
 534     }
 535
 536     /// Returns `true` if `def_id` refers to a trait alias (i.e., `trait Foo = ...;`),
 537     /// and `false` otherwise.
 538     pub fn is_trait_alias(self, def_id: DefId) -> bool {
 539         self.def_kind(def_id) == Some(DefKind::TraitAlias)
 540     }
 541
 542     /// Returns `true` if this `DefId` refers to the implicit constructor for
 543     /// a tuple struct like `struct Foo(u32)`, and `false` otherwise.
 544     pub fn is_constructor(self, def_id: DefId) -> bool {
 545         self.def_key(def_id).disambiguated_data.data == DefPathData::Ctor
 546     }
 547
 548     /// Given the `DefId` of a fn or closure, returns the `DefId` of
 549     /// the innermost fn item that the closure is contained within.
 550     /// This is a significant `DefId` because, when we do
 551     /// type-checking, we type-check this fn item and all of its
 552     /// (transitive) closures together. Therefore, when we fetch the
 553     /// `typeck_tables_of` the closure, for example, we really wind up
 554     /// fetching the `typeck_tables_of` the enclosing fn item.
 555     pub fn closure_base_def_id(self, def_id: DefId) -> DefId {
 556         let mut def_id = def_id;
 557         while self.is_closure(def_id) {
 558             def_id = self.parent(def_id).unwrap_or_else(|| {
 559                 bug!("closure {:?} has no parent", def_id);
 560             });
 561         }
 562         def_id
 563     }
 564
 565     /// Given the `DefId` and substs a closure, creates the type of
 566     /// `self` argument that the closure expects. For example, for a
 567     /// `Fn` closure, this would return a reference type `&T` where
 568     /// `T = closure_ty`.
 569     ///
 570     /// Returns `None` if this closure's kind has not yet been inferred.
 571     /// This should only be possible during type checking.
 572     ///
 573     /// Note that the return value is a late-bound region and hence
 574     /// wrapped in a binder.
 575     pub fn closure_env_ty(self,
 576                           closure_def_id: DefId,
 577                           closure_substs: ty::ClosureSubsts<'tcx>)
 578                           -> Option<ty::Binder<Ty<'tcx>>>
 579     {
 580         let closure_ty = self.mk_closure(closure_def_id, closure_substs);
 581         let env_region = ty::ReLateBound(ty::INNERMOST, ty::BrEnv);
 582         let closure_kind_ty = closure_substs.closure_kind_ty(closure_def_id, self);
 583         let closure_kind = closure_kind_ty.to_opt_closure_kind()?;
 584         let env_ty = match closure_kind {
 585             ty::ClosureKind::Fn => self.mk_imm_ref(self.mk_region(env_region), closure_ty),
 586             ty::ClosureKind::FnMut => self.mk_mut_ref(self.mk_region(env_region), closure_ty),
 587             ty::ClosureKind::FnOnce => closure_ty,
 588         };
 589         Some(ty::Binder::bind(env_ty))
 590     }
 591
 592     /// Given the `DefId` of some item that has no type or const parameters, make
 593     /// a suitable "empty substs" for it.
 594     pub fn empty_substs_for_def_id(self, item_def_id: DefId) -> SubstsRef<'tcx> {
 595         InternalSubsts::for_item(self, item_def_id, |param, _| {
 596             match param.kind {
 597                 GenericParamDefKind::Lifetime => self.lifetimes.re_erased.into(),
 598                 GenericParamDefKind::Type { .. } => {
 599                     bug!("empty_substs_for_def_id: {:?} has type parameters", item_def_id)
 600                 }
 601                 GenericParamDefKind::Const { .. } => {
 602                     bug!("empty_substs_for_def_id: {:?} has const parameters", item_def_id)
 603                 }
 604             }
 605         })
 606     }
 607
 608     /// Returns `true` if the node pointed to by `def_id` is a `static` item.
 609     pub fn is_static(&self, def_id: DefId) -> bool {
 610         self.static_mutability(def_id).is_some()
 611     }
 612
 613     /// Returns `true` if the node pointed to by `def_id` is a mutable `static` item.
 614     pub fn is_mutable_static(&self, def_id: DefId) -> bool {
 615         self.static_mutability(def_id) == Some(hir::MutMutable)
 616     }
 617
 618     /// Expands the given impl trait type, stopping if the type is recursive.
 619     pub fn try_expand_impl_trait_type(
 620         self,
 621         def_id: DefId,
 622         substs: SubstsRef<'tcx>,
 623     ) -> Result<Ty<'tcx>, Ty<'tcx>> {
 624         use crate::ty::fold::TypeFolder;
 625
 626         struct OpaqueTypeExpander<'a, 'gcx, 'tcx> {
 627             // Contains the DefIds of the opaque types that are currently being
 628             // expanded. When we expand an opaque type we insert the DefId of
 629             // that type, and when we finish expanding that type we remove the
 630             // its DefId.
 631             seen_opaque_tys: FxHashSet<DefId>,
 632             primary_def_id: DefId,
 633             found_recursion: bool,
 634             tcx: TyCtxt<'a, 'gcx, 'tcx>,
 635         }
 636
 637         impl<'a, 'gcx, 'tcx> OpaqueTypeExpander<'a, 'gcx, 'tcx> {
 638             fn expand_opaque_ty(
 639                 &mut self,
 640                 def_id: DefId,
 641                 substs: SubstsRef<'tcx>,
 642             ) -> Option<Ty<'tcx>> {
 643                 if self.found_recursion {
 644                     None
 645                 } else if self.seen_opaque_tys.insert(def_id) {
 646                     let generic_ty = self.tcx.type_of(def_id);
 647                     let concrete_ty = generic_ty.subst(self.tcx, substs);
 648                     let expanded_ty = self.fold_ty(concrete_ty);
 649                     self.seen_opaque_tys.remove(&def_id);
 650                     Some(expanded_ty)
 651                 } else {
 652                     // If another opaque type that we contain is recursive, then it
 653                     // will report the error, so we don't have to.
 654                     self.found_recursion = def_id == self.primary_def_id;
 655                     None
 656                 }
 657             }
 658         }
 659
 660         impl<'a, 'gcx, 'tcx> TypeFolder<'gcx, 'tcx> for OpaqueTypeExpander<'a, 'gcx, 'tcx> {
 661             fn tcx(&self) -> TyCtxt<'_, 'gcx, 'tcx> {
 662                 self.tcx
 663             }
 664
 665             fn fold_ty(&mut self, t: Ty<'tcx>) -> Ty<'tcx> {
 666                 if let ty::Opaque(def_id, substs) = t.sty {
 667                     self.expand_opaque_ty(def_id, substs).unwrap_or(t)
 668                 } else {
 669                     t.super_fold_with(self)
 670                 }
 671             }
 672         }
 673
 674         let mut visitor = OpaqueTypeExpander {
 675             seen_opaque_tys: FxHashSet::default(),
 676             primary_def_id: def_id,
 677             found_recursion: false,
 678             tcx: self,
 679         };
 680         let expanded_type = visitor.expand_opaque_ty(def_id, substs).unwrap();
 681         if visitor.found_recursion {
 682             Err(expanded_type)
 683         } else {
 684             Ok(expanded_type)
 685         }
 686     }
 687 }
 688
 689 impl<'a, 'tcx> ty::TyS<'tcx> {
 690     /// Checks whether values of this type `T` are *moved* or *copied*
 691     /// when referenced -- this amounts to a check for whether `T:
 692     /// Copy`, but note that we **don't** consider lifetimes when
 693     /// doing this check. This means that we may generate MIR which
 694     /// does copies even when the type actually doesn't satisfy the
 695     /// full requirements for the `Copy` trait (cc #29149) -- this
 696     /// winds up being reported as an error during NLL borrow check.
 697     pub fn is_copy_modulo_regions(&'tcx self,
 698                                   tcx: TyCtxt<'a, 'tcx, 'tcx>,
 699                                   param_env: ty::ParamEnv<'tcx>,
 700                                   span: Span)
 701                                   -> bool {
 702         tcx.at(span).is_copy_raw(param_env.and(self))
 703     }
 704
 705     /// Checks whether values of this type `T` have a size known at
 706     /// compile time (i.e., whether `T: Sized`). Lifetimes are ignored
 707     /// for the purposes of this check, so it can be an
 708     /// over-approximation in generic contexts, where one can have
 709     /// strange rules like `<T as Foo<'static>>::Bar: Sized` that
 710     /// actually carry lifetime requirements.
 711     pub fn is_sized(&'tcx self,
 712                     tcx_at: TyCtxtAt<'a, 'tcx, 'tcx>,
 713                     param_env: ty::ParamEnv<'tcx>)-> bool
 714     {
 715         tcx_at.is_sized_raw(param_env.and(self))
 716     }
 717
 718     /// Checks whether values of this type `T` implement the `Freeze`
 719     /// trait -- frozen types are those that do not contain a
 720     /// `UnsafeCell` anywhere. This is a language concept used to
 721     /// distinguish "true immutability", which is relevant to
 722     /// optimization as well as the rules around static values. Note
 723     /// that the `Freeze` trait is not exposed to end users and is
 724     /// effectively an implementation detail.
 725     pub fn is_freeze(&'tcx self,
 726                      tcx: TyCtxt<'a, 'tcx, 'tcx>,
 727                      param_env: ty::ParamEnv<'tcx>,
 728                      span: Span)-> bool
 729     {
 730         tcx.at(span).is_freeze_raw(param_env.and(self))
 731     }
 732
 733     /// If `ty.needs_drop(...)` returns `true`, then `ty` is definitely
 734     /// non-copy and *might* have a destructor attached; if it returns
 735     /// `false`, then `ty` definitely has no destructor (i.e., no drop glue).
 736     ///
 737     /// (Note that this implies that if `ty` has a destructor attached,
 738     /// then `needs_drop` will definitely return `true` for `ty`.)
 739     #[inline]
 740     pub fn needs_drop(&'tcx self,
 741                       tcx: TyCtxt<'a, 'tcx, 'tcx>,
 742                       param_env: ty::ParamEnv<'tcx>)
 743                       -> bool {
 744         tcx.needs_drop_raw(param_env.and(self)).0
 745     }
 746
 747     pub fn same_type(a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
 748         match (&a.sty, &b.sty) {
 749             (&Adt(did_a, substs_a), &Adt(did_b, substs_b)) => {
 750                 if did_a != did_b {
 751                     return false;
 752                 }
 753
 754                 substs_a.types().zip(substs_b.types()).all(|(a, b)| Self::same_type(a, b))
 755             }
 756             _ => a == b,
 757         }
 758     }
 759
 760     /// Check whether a type is representable. This means it cannot contain unboxed
 761     /// structural recursion. This check is needed for structs and enums.
 762     pub fn is_representable(&'tcx self,
 763                             tcx: TyCtxt<'a, 'tcx, 'tcx>,
 764                             sp: Span)
 765                             -> Representability
 766     {
 767         // Iterate until something non-representable is found
 768         fn fold_repr<It: Iterator<Item=Representability>>(iter: It) -> Representability {
 769             iter.fold(Representability::Representable, |r1, r2| {
 770                 match (r1, r2) {
 771                     (Representability::SelfRecursive(v1),
 772                      Representability::SelfRecursive(v2)) => {
 773                         Representability::SelfRecursive(v1.into_iter().chain(v2).collect())
 774                     }
 775                     (r1, r2) => cmp::max(r1, r2)
 776                 }
 777             })
 778         }
 779
 780         fn are_inner_types_recursive<'a, 'tcx>(
 781             tcx: TyCtxt<'a, 'tcx, 'tcx>, sp: Span,
 782             seen: &mut Vec<Ty<'tcx>>,
 783             representable_cache: &mut FxHashMap<Ty<'tcx>, Representability>,
 784             ty: Ty<'tcx>)
 785             -> Representability
 786         {
 787             match ty.sty {
 788                 Tuple(ref ts) => {
 789                     // Find non representable
 790                     fold_repr(ts.iter().map(|ty| {
 791                         is_type_structurally_recursive(
 792                             tcx,
 793                             sp,
 794                             seen,
 795                             representable_cache,
 796                             ty.expect_ty(),
 797                         )
 798                     }))
 799                 }
 800                 // Fixed-length vectors.
 801                 // FIXME(#11924) Behavior undecided for zero-length vectors.
 802                 Array(ty, _) => {
 803                     is_type_structurally_recursive(tcx, sp, seen, representable_cache, ty)
 804                 }
 805                 Adt(def, substs) => {
 806                     // Find non representable fields with their spans
 807                     fold_repr(def.all_fields().map(|field| {
 808                         let ty = field.ty(tcx, substs);
 809                         let span = tcx.hir().span_if_local(field.did).unwrap_or(sp);
 810                         match is_type_structurally_recursive(tcx, span, seen,
 811                                                              representable_cache, ty)
 812                         {
 813                             Representability::SelfRecursive(_) => {
 814                                 Representability::SelfRecursive(vec![span])
 815                             }
 816                             x => x,
 817                         }
 818                     }))
 819                 }
 820                 Closure(..) => {
 821                     // this check is run on type definitions, so we don't expect
 822                     // to see closure types
 823                     bug!("requires check invoked on inapplicable type: {:?}", ty)
 824                 }
 825                 _ => Representability::Representable,
 826             }
 827         }
 828
 829         fn same_struct_or_enum<'tcx>(ty: Ty<'tcx>, def: &'tcx ty::AdtDef) -> bool {
 830             match ty.sty {
 831                 Adt(ty_def, _) => {
 832                      ty_def == def
 833                 }
 834                 _ => false
 835             }
 836         }
 837
 838         // Does the type `ty` directly (without indirection through a pointer)
 839         // contain any types on stack `seen`?
 840         fn is_type_structurally_recursive<'a, 'tcx>(
 841             tcx: TyCtxt<'a, 'tcx, 'tcx>,
 842             sp: Span,
 843             seen: &mut Vec<Ty<'tcx>>,
 844             representable_cache: &mut FxHashMap<Ty<'tcx>, Representability>,
 845             ty: Ty<'tcx>) -> Representability
 846         {
 847             debug!("is_type_structurally_recursive: {:?} {:?}", ty, sp);
 848             if let Some(representability) = representable_cache.get(ty) {
 849                 debug!("is_type_structurally_recursive: {:?} {:?} - (cached) {:?}",
 850                        ty, sp, representability);
 851                 return representability.clone();
 852             }
 853
 854             let representability = is_type_structurally_recursive_inner(
 855                 tcx, sp, seen, representable_cache, ty);
 856
 857             representable_cache.insert(ty, representability.clone());
 858             representability
 859         }
 860
 861         fn is_type_structurally_recursive_inner<'a, 'tcx>(
 862             tcx: TyCtxt<'a, 'tcx, 'tcx>,
 863             sp: Span,
 864             seen: &mut Vec<Ty<'tcx>>,
 865             representable_cache: &mut FxHashMap<Ty<'tcx>, Representability>,
 866             ty: Ty<'tcx>) -> Representability
 867         {
 868             match ty.sty {
 869                 Adt(def, _) => {
 870                     {
 871                         // Iterate through stack of previously seen types.
 872                         let mut iter = seen.iter();
 873
 874                         // The first item in `seen` is the type we are actually curious about.
 875                         // We want to return SelfRecursive if this type contains itself.
 876                         // It is important that we DON'T take generic parameters into account
 877                         // for this check, so that Bar<T> in this example counts as SelfRecursive:
 878                         //
 879                         // struct Foo;
 880                         // struct Bar<T> { x: Bar<Foo> }
 881
 882                         if let Some(&seen_type) = iter.next() {
 883                             if same_struct_or_enum(seen_type, def) {
 884                                 debug!("SelfRecursive: {:?} contains {:?}",
 885                                        seen_type,
 886                                        ty);
 887                                 return Representability::SelfRecursive(vec![sp]);
 888                             }
 889                         }
 890
 891                         // We also need to know whether the first item contains other types
 892                         // that are structurally recursive. If we don't catch this case, we
 893                         // will recurse infinitely for some inputs.
 894                         //
 895                         // It is important that we DO take generic parameters into account
 896                         // here, so that code like this is considered SelfRecursive, not
 897                         // ContainsRecursive:
 898                         //
 899                         // struct Foo { Option<Option<Foo>> }
 900
 901                         for &seen_type in iter {
 902                             if ty::TyS::same_type(ty, seen_type) {
 903                                 debug!("ContainsRecursive: {:?} contains {:?}",
 904                                        seen_type,
 905                                        ty);
 906                                 return Representability::ContainsRecursive;
 907                             }
 908                         }
 909                     }
 910
 911                     // For structs and enums, track all previously seen types by pushing them
 912                     // onto the 'seen' stack.
 913                     seen.push(ty);
 914                     let out = are_inner_types_recursive(tcx, sp, seen, representable_cache, ty);
 915                     seen.pop();
 916                     out
 917                 }
 918                 _ => {
 919                     // No need to push in other cases.
 920                     are_inner_types_recursive(tcx, sp, seen, representable_cache, ty)
 921                 }
 922             }
 923         }
 924
 925         debug!("is_type_representable: {:?}", self);
 926
 927         // To avoid a stack overflow when checking an enum variant or struct that
 928         // contains a different, structurally recursive type, maintain a stack
 929         // of seen types and check recursion for each of them (issues #3008, #3779).
 930         let mut seen: Vec<Ty<'_>> = Vec::new();
 931         let mut representable_cache = FxHashMap::default();
 932         let r = is_type_structurally_recursive(
 933             tcx, sp, &mut seen, &mut representable_cache, self);
 934         debug!("is_type_representable: {:?} is {:?}", self, r);
 935         r
 936     }
 937 }
 938
 939 fn is_copy_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
 940                          query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
 941                          -> bool
 942 {
 943     let (param_env, ty) = query.into_parts();
 944     let trait_def_id = tcx.require_lang_item(lang_items::CopyTraitLangItem);
 945     tcx.infer_ctxt()
 946         .enter(|infcx| traits::type_known_to_meet_bound_modulo_regions(
 947             &infcx,
 948             param_env,
 949             ty,
 950             trait_def_id,
 951             DUMMY_SP,
 952         ))
 953 }
 954
 955 fn is_sized_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
 956                           query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
 957                           -> bool
 958 {
 959     let (param_env, ty) = query.into_parts();
 960     let trait_def_id = tcx.require_lang_item(lang_items::SizedTraitLangItem);
 961     tcx.infer_ctxt()
 962         .enter(|infcx| traits::type_known_to_meet_bound_modulo_regions(
 963             &infcx,
 964             param_env,
 965             ty,
 966             trait_def_id,
 967             DUMMY_SP,
 968         ))
 969 }
 970
 971 fn is_freeze_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
 972                            query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
 973                            -> bool
 974 {
 975     let (param_env, ty) = query.into_parts();
 976     let trait_def_id = tcx.require_lang_item(lang_items::FreezeTraitLangItem);
 977     tcx.infer_ctxt()
 978         .enter(|infcx| traits::type_known_to_meet_bound_modulo_regions(
 979             &infcx,
 980             param_env,
 981             ty,
 982             trait_def_id,
 983             DUMMY_SP,
 984         ))
 985 }
 986
 987 #[derive(Clone, HashStable)]
 988 pub struct NeedsDrop(pub bool);
 989
 990 fn needs_drop_raw<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
 991                             query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>)
 992                             -> NeedsDrop
 993 {
 994     let (param_env, ty) = query.into_parts();
 995
 996     let needs_drop = |ty: Ty<'tcx>| -> bool {
 997         tcx.needs_drop_raw(param_env.and(ty)).0
 998     };
 999
1000     assert!(!ty.needs_infer());
1001
1002     NeedsDrop(match ty.sty {
1003         // Fast-path for primitive types
1004         ty::Infer(ty::FreshIntTy(_)) | ty::Infer(ty::FreshFloatTy(_)) |
1005         ty::Bool | ty::Int(_) | ty::Uint(_) | ty::Float(_) | ty::Never |
1006         ty::FnDef(..) | ty::FnPtr(_) | ty::Char | ty::GeneratorWitness(..) |
1007         ty::RawPtr(_) | ty::Ref(..) | ty::Str => false,
1008
1009         // Foreign types can never have destructors
1010         ty::Foreign(..) => false,
1011
1012         // `ManuallyDrop` doesn't have a destructor regardless of field types.
1013         ty::Adt(def, _) if Some(def.did) == tcx.lang_items().manually_drop() => false,
1014
1015         // Issue #22536: We first query `is_copy_modulo_regions`.  It sees a
1016         // normalized version of the type, and therefore will definitely
1017         // know whether the type implements Copy (and thus needs no
1018         // cleanup/drop/zeroing) ...
1019         _ if ty.is_copy_modulo_regions(tcx, param_env, DUMMY_SP) => false,
1020
1021         // ... (issue #22536 continued) but as an optimization, still use
1022         // prior logic of asking for the structural "may drop".
1023
1024         // FIXME(#22815): Note that this is a conservative heuristic;
1025         // it may report that the type "may drop" when actual type does
1026         // not actually have a destructor associated with it. But since
1027         // the type absolutely did not have the `Copy` bound attached
1028         // (see above), it is sound to treat it as having a destructor.
1029
1030         // User destructors are the only way to have concrete drop types.
1031         ty::Adt(def, _) if def.has_dtor(tcx) => true,
1032
1033         // Can refer to a type which may drop.
1034         // FIXME(eddyb) check this against a ParamEnv.
1035         ty::Dynamic(..) | ty::Projection(..) | ty::Param(_) | ty::Bound(..) |
1036         ty::Placeholder(..) | ty::Opaque(..) | ty::Infer(_) | ty::Error => true,
1037
1038         ty::UnnormalizedProjection(..) => bug!("only used with chalk-engine"),
1039
1040         // Structural recursion.
1041         ty::Array(ty, _) | ty::Slice(ty) => needs_drop(ty),
1042
1043         ty::Closure(def_id, ref substs) => substs.upvar_tys(def_id, tcx).any(needs_drop),
1044
1045         // Pessimistically assume that all generators will require destructors
1046         // as we don't know if a destructor is a noop or not until after the MIR
1047         // state transformation pass
1048         ty::Generator(..) => true,
1049
1050         ty::Tuple(ref tys) => tys.iter().map(|k| k.expect_ty()).any(needs_drop),
1051
1052         // unions don't have destructors because of the child types,
1053         // only if they manually implement `Drop` (handled above).
1054         ty::Adt(def, _) if def.is_union() => false,
1055
1056         ty::Adt(def, substs) =>
1057             def.variants.iter().any(
1058                 |variant| variant.fields.iter().any(
1059                     |field| needs_drop(field.ty(tcx, substs)))),
1060     })
1061 }
1062
1063 pub enum ExplicitSelf<'tcx> {
1064     ByValue,
1065     ByReference(ty::Region<'tcx>, hir::Mutability),
1066     ByRawPointer(hir::Mutability),
1067     ByBox,
1068     Other
1069 }
1070
1071 impl<'tcx> ExplicitSelf<'tcx> {
1072     /// Categorizes an explicit self declaration like `self: SomeType`
1073     /// into either `self`, `&self`, `&mut self`, `Box<self>`, or
1074     /// `Other`.
1075     /// This is mainly used to require the arbitrary_self_types feature
1076     /// in the case of `Other`, to improve error messages in the common cases,
1077     /// and to make `Other` non-object-safe.
1078     ///
1079     /// Examples:
1080     ///
1081     /// ```
1082     /// impl<'a> Foo for &'a T {
1083     ///     // Legal declarations:
1084     ///     fn method1(self: &&'a T); // ExplicitSelf::ByReference
1085     ///     fn method2(self: &'a T); // ExplicitSelf::ByValue
1086     ///     fn method3(self: Box<&'a T>); // ExplicitSelf::ByBox
1087     ///     fn method4(self: Rc<&'a T>); // ExplicitSelf::Other
1088     ///
1089     ///     // Invalid cases will be caught by `check_method_receiver`:
1090     ///     fn method_err1(self: &'a mut T); // ExplicitSelf::Other
1091     ///     fn method_err2(self: &'static T) // ExplicitSelf::ByValue
1092     ///     fn method_err3(self: &&T) // ExplicitSelf::ByReference
1093     /// }
1094     /// ```
1095     ///
1096     pub fn determine<P>(
1097         self_arg_ty: Ty<'tcx>,
1098         is_self_ty: P
1099     ) -> ExplicitSelf<'tcx>
1100     where
1101         P: Fn(Ty<'tcx>) -> bool
1102     {
1103         use self::ExplicitSelf::*;
1104
1105         match self_arg_ty.sty {
1106             _ if is_self_ty(self_arg_ty) => ByValue,
1107             ty::Ref(region, ty, mutbl) if is_self_ty(ty) => {
1108                 ByReference(region, mutbl)
1109             }
1110             ty::RawPtr(ty::TypeAndMut { ty, mutbl }) if is_self_ty(ty) => {
1111                 ByRawPointer(mutbl)
1112             }
1113             ty::Adt(def, _) if def.is_box() && is_self_ty(self_arg_ty.boxed_ty()) => {
1114                 ByBox
1115             }
1116             _ => Other
1117         }
1118     }
1119 }
1120
1121 pub fn provide(providers: &mut ty::query::Providers<'_>) {
1122     *providers = ty::query::Providers {
1123         is_copy_raw,
1124         is_sized_raw,
1125         is_freeze_raw,
1126         needs_drop_raw,
1127         ..*providers
1128     };
1129 }