compiler/rustc_ty_utils/src/ty.rs

   1 use rustc_data_structures::fx::FxIndexSet;
   2 use rustc_hir as hir;
   3 use rustc_hir::def_id::{DefId, LocalDefId};
   4 use rustc_middle::hir::map as hir_map;
   5 use rustc_middle::ty::subst::Subst;
   6 use rustc_middle::ty::{
   7     self, Binder, Predicate, PredicateKind, ToPredicate, Ty, TyCtxt, WithConstness,
   8 };
   9 use rustc_span::Span;
  10 use rustc_trait_selection::traits;
  11
  12 fn sized_constraint_for_ty<'tcx>(
  13     tcx: TyCtxt<'tcx>,
  14     adtdef: &ty::AdtDef,
  15     ty: Ty<'tcx>,
  16 ) -> Vec<Ty<'tcx>> {
  17     use ty::TyKind::*;
  18
  19     let result = match ty.kind() {
  20         Bool | Char | Int(..) | Uint(..) | Float(..) | RawPtr(..) | Ref(..) | FnDef(..)
  21         | FnPtr(_) | Array(..) | Closure(..) | Generator(..) | Never => vec![],
  22
  23         Str | Dynamic(..) | Slice(_) | Foreign(..) | Error(_) | GeneratorWitness(..) => {
  24             // these are never sized - return the target type
  25             vec![ty]
  26         }
  27
  28         Tuple(ref tys) => match tys.last() {
  29             None => vec![],
  30             Some(ty) => sized_constraint_for_ty(tcx, adtdef, ty.expect_ty()),
  31         },
  32
  33         Adt(adt, substs) => {
  34             // recursive case
  35             let adt_tys = adt.sized_constraint(tcx);
  36             debug!("sized_constraint_for_ty({:?}) intermediate = {:?}", ty, adt_tys);
  37             adt_tys
  38                 .iter()
  39                 .map(|ty| ty.subst(tcx, substs))
  40                 .flat_map(|ty| sized_constraint_for_ty(tcx, adtdef, ty))
  41                 .collect()
  42         }
  43
  44         Projection(..) | Opaque(..) => {
  45             // must calculate explicitly.
  46             // FIXME: consider special-casing always-Sized projections
  47             vec![ty]
  48         }
  49
  50         Param(..) => {
  51             // perf hack: if there is a `T: Sized` bound, then
  52             // we know that `T` is Sized and do not need to check
  53             // it on the impl.
  54
  55             let sized_trait = match tcx.lang_items().sized_trait() {
  56                 Some(x) => x,
  57                 _ => return vec![ty],
  58             };
  59             let sized_predicate = ty::Binder::dummy(ty::TraitRef {
  60                 def_id: sized_trait,
  61                 substs: tcx.mk_substs_trait(ty, &[]),
  62             })
  63             .without_const()
  64             .to_predicate(tcx);
  65             let predicates = tcx.predicates_of(adtdef.did).predicates;
  66             if predicates.iter().any(|(p, _)| *p == sized_predicate) { vec![] } else { vec![ty] }
  67         }
  68
  69         Placeholder(..) | Bound(..) | Infer(..) => {
  70             bug!("unexpected type `{:?}` in sized_constraint_for_ty", ty)
  71         }
  72     };
  73     debug!("sized_constraint_for_ty({:?}) = {:?}", ty, result);
  74     result
  75 }
  76
  77 fn associated_item_from_trait_item_ref(
  78     tcx: TyCtxt<'_>,
  79     parent_def_id: LocalDefId,
  80     trait_item_ref: &hir::TraitItemRef,
  81 ) -> ty::AssocItem {
  82     let def_id = trait_item_ref.id.def_id;
  83     let (kind, has_self) = match trait_item_ref.kind {
  84         hir::AssocItemKind::Const => (ty::AssocKind::Const, false),
  85         hir::AssocItemKind::Fn { has_self } => (ty::AssocKind::Fn, has_self),
  86         hir::AssocItemKind::Type => (ty::AssocKind::Type, false),
  87     };
  88
  89     ty::AssocItem {
  90         ident: trait_item_ref.ident,
  91         kind,
  92         vis: tcx.visibility(def_id),
  93         defaultness: trait_item_ref.defaultness,
  94         def_id: def_id.to_def_id(),
  95         container: ty::TraitContainer(parent_def_id.to_def_id()),
  96         fn_has_self_parameter: has_self,
  97     }
  98 }
  99
 100 fn associated_item_from_impl_item_ref(
 101     tcx: TyCtxt<'_>,
 102     parent_def_id: LocalDefId,
 103     impl_item_ref: &hir::ImplItemRef,
 104 ) -> ty::AssocItem {
 105     let def_id = impl_item_ref.id.def_id;
 106     let (kind, has_self) = match impl_item_ref.kind {
 107         hir::AssocItemKind::Const => (ty::AssocKind::Const, false),
 108         hir::AssocItemKind::Fn { has_self } => (ty::AssocKind::Fn, has_self),
 109         hir::AssocItemKind::Type => (ty::AssocKind::Type, false),
 110     };
 111
 112     ty::AssocItem {
 113         ident: impl_item_ref.ident,
 114         kind,
 115         vis: tcx.visibility(def_id),
 116         defaultness: impl_item_ref.defaultness,
 117         def_id: def_id.to_def_id(),
 118         container: ty::ImplContainer(parent_def_id.to_def_id()),
 119         fn_has_self_parameter: has_self,
 120     }
 121 }
 122
 123 fn associated_item(tcx: TyCtxt<'_>, def_id: DefId) -> ty::AssocItem {
 124     let id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
 125     let parent_id = tcx.hir().get_parent_item(id);
 126     let parent_def_id = tcx.hir().local_def_id(parent_id);
 127     let parent_item = tcx.hir().expect_item(parent_id);
 128     match parent_item.kind {
 129         hir::ItemKind::Impl(ref impl_) => {
 130             if let Some(impl_item_ref) =
 131                 impl_.items.iter().find(|i| i.id.def_id.to_def_id() == def_id)
 132             {
 133                 let assoc_item =
 134                     associated_item_from_impl_item_ref(tcx, parent_def_id, impl_item_ref);
 135                 debug_assert_eq!(assoc_item.def_id, def_id);
 136                 return assoc_item;
 137             }
 138         }
 139
 140         hir::ItemKind::Trait(.., ref trait_item_refs) => {
 141             if let Some(trait_item_ref) =
 142                 trait_item_refs.iter().find(|i| i.id.def_id.to_def_id() == def_id)
 143             {
 144                 let assoc_item =
 145                     associated_item_from_trait_item_ref(tcx, parent_def_id, trait_item_ref);
 146                 debug_assert_eq!(assoc_item.def_id, def_id);
 147                 return assoc_item;
 148             }
 149         }
 150
 151         _ => {}
 152     }
 153
 154     span_bug!(
 155         parent_item.span,
 156         "unexpected parent of trait or impl item or item not found: {:?}",
 157         parent_item.kind
 158     )
 159 }
 160
 161 fn impl_defaultness(tcx: TyCtxt<'_>, def_id: DefId) -> hir::Defaultness {
 162     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
 163     let item = tcx.hir().expect_item(hir_id);
 164     if let hir::ItemKind::Impl(impl_) = &item.kind {
 165         impl_.defaultness
 166     } else {
 167         bug!("`impl_defaultness` called on {:?}", item);
 168     }
 169 }
 170
 171 fn impl_constness(tcx: TyCtxt<'_>, def_id: DefId) -> hir::Constness {
 172     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
 173     let item = tcx.hir().expect_item(hir_id);
 174     if let hir::ItemKind::Impl(impl_) = &item.kind {
 175         impl_.constness
 176     } else {
 177         bug!("`impl_constness` called on {:?}", item);
 178     }
 179 }
 180
 181 /// Calculates the `Sized` constraint.
 182 ///
 183 /// In fact, there are only a few options for the types in the constraint:
 184 ///     - an obviously-unsized type
 185 ///     - a type parameter or projection whose Sizedness can't be known
 186 ///     - a tuple of type parameters or projections, if there are multiple
 187 ///       such.
 188 ///     - an Error, if a type contained itself. The representability
 189 ///       check should catch this case.
 190 fn adt_sized_constraint(tcx: TyCtxt<'_>, def_id: DefId) -> ty::AdtSizedConstraint<'_> {
 191     let def = tcx.adt_def(def_id);
 192
 193     let result = tcx.mk_type_list(
 194         def.variants
 195             .iter()
 196             .flat_map(|v| v.fields.last())
 197             .flat_map(|f| sized_constraint_for_ty(tcx, def, tcx.type_of(f.did))),
 198     );
 199
 200     debug!("adt_sized_constraint: {:?} => {:?}", def, result);
 201
 202     ty::AdtSizedConstraint(result)
 203 }
 204
 205 fn associated_item_def_ids(tcx: TyCtxt<'_>, def_id: DefId) -> &[DefId] {
 206     let id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
 207     let item = tcx.hir().expect_item(id);
 208     match item.kind {
 209         hir::ItemKind::Trait(.., ref trait_item_refs) => tcx.arena.alloc_from_iter(
 210             trait_item_refs.iter().map(|trait_item_ref| trait_item_ref.id.def_id.to_def_id()),
 211         ),
 212         hir::ItemKind::Impl(ref impl_) => tcx.arena.alloc_from_iter(
 213             impl_.items.iter().map(|impl_item_ref| impl_item_ref.id.def_id.to_def_id()),
 214         ),
 215         hir::ItemKind::TraitAlias(..) => &[],
 216         _ => span_bug!(item.span, "associated_item_def_ids: not impl or trait"),
 217     }
 218 }
 219
 220 fn associated_items(tcx: TyCtxt<'_>, def_id: DefId) -> ty::AssocItems<'_> {
 221     let items = tcx.associated_item_def_ids(def_id).iter().map(|did| tcx.associated_item(*did));
 222     ty::AssocItems::new(items)
 223 }
 224
 225 fn def_ident_span(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Span> {
 226     tcx.hir()
 227         .get_if_local(def_id)
 228         .and_then(|node| match node {
 229             // A `Ctor` doesn't have an identifier itself, but its parent
 230             // struct/variant does. Compare with `hir::Map::opt_span`.
 231             hir::Node::Ctor(ctor) => ctor
 232                 .ctor_hir_id()
 233                 .and_then(|ctor_id| tcx.hir().find(tcx.hir().get_parent_node(ctor_id)))
 234                 .and_then(|parent| parent.ident()),
 235             _ => node.ident(),
 236         })
 237         .map(|ident| ident.span)
 238 }
 239
 240 /// If the given `DefId` describes an item belonging to a trait,
 241 /// returns the `DefId` of the trait that the trait item belongs to;
 242 /// otherwise, returns `None`.
 243 fn trait_of_item(tcx: TyCtxt<'_>, def_id: DefId) -> Option<DefId> {
 244     tcx.opt_associated_item(def_id).and_then(|associated_item| match associated_item.container {
 245         ty::TraitContainer(def_id) => Some(def_id),
 246         ty::ImplContainer(_) => None,
 247     })
 248 }
 249
 250 /// See `ParamEnv` struct definition for details.
 251 fn param_env(tcx: TyCtxt<'_>, def_id: DefId) -> ty::ParamEnv<'_> {
 252     // The param_env of an impl Trait type is its defining function's param_env
 253     if let Some(parent) = ty::is_impl_trait_defn(tcx, def_id) {
 254         return param_env(tcx, parent);
 255     }
 256     // Compute the bounds on Self and the type parameters.
 257
 258     let ty::InstantiatedPredicates { mut predicates, .. } =
 259         tcx.predicates_of(def_id).instantiate_identity(tcx);
 260
 261     // Finally, we have to normalize the bounds in the environment, in
 262     // case they contain any associated type projections. This process
 263     // can yield errors if the put in illegal associated types, like
 264     // `<i32 as Foo>::Bar` where `i32` does not implement `Foo`. We
 265     // report these errors right here; this doesn't actually feel
 266     // right to me, because constructing the environment feels like a
 267     // kind of an "idempotent" action, but I'm not sure where would be
 268     // a better place. In practice, we construct environments for
 269     // every fn once during type checking, and we'll abort if there
 270     // are any errors at that point, so after type checking you can be
 271     // sure that this will succeed without errors anyway.
 272
 273     if tcx.sess.opts.debugging_opts.chalk {
 274         let environment = well_formed_types_in_env(tcx, def_id);
 275         predicates.extend(environment);
 276     }
 277
 278     let unnormalized_env =
 279         ty::ParamEnv::new(tcx.intern_predicates(&predicates), traits::Reveal::UserFacing);
 280
 281     let body_id = def_id
 282         .as_local()
 283         .map(|def_id| tcx.hir().local_def_id_to_hir_id(def_id))
 284         .map_or(hir::CRATE_HIR_ID, |id| {
 285             tcx.hir().maybe_body_owned_by(id).map_or(id, |body| body.hir_id)
 286         });
 287     let cause = traits::ObligationCause::misc(tcx.def_span(def_id), body_id);
 288     traits::normalize_param_env_or_error(tcx, def_id, unnormalized_env, cause)
 289 }
 290
 291 /// Elaborate the environment.
 292 ///
 293 /// Collect a list of `Predicate`'s used for building the `ParamEnv`. Adds `TypeWellFormedFromEnv`'s
 294 /// that are assumed to be well-formed (because they come from the environment).
 295 ///
 296 /// Used only in chalk mode.
 297 fn well_formed_types_in_env<'tcx>(
 298     tcx: TyCtxt<'tcx>,
 299     def_id: DefId,
 300 ) -> &'tcx ty::List<Predicate<'tcx>> {
 301     use rustc_hir::{ForeignItemKind, ImplItemKind, ItemKind, Node, TraitItemKind};
 302     use rustc_middle::ty::subst::GenericArgKind;
 303
 304     debug!("environment(def_id = {:?})", def_id);
 305
 306     // The environment of an impl Trait type is its defining function's environment.
 307     if let Some(parent) = ty::is_impl_trait_defn(tcx, def_id) {
 308         return well_formed_types_in_env(tcx, parent);
 309     }
 310
 311     // Compute the bounds on `Self` and the type parameters.
 312     let ty::InstantiatedPredicates { predicates, .. } =
 313         tcx.predicates_of(def_id).instantiate_identity(tcx);
 314
 315     let clauses = predicates.into_iter();
 316
 317     if !def_id.is_local() {
 318         return ty::List::empty();
 319     }
 320     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
 321     let node = tcx.hir().get(hir_id);
 322
 323     enum NodeKind {
 324         TraitImpl,
 325         InherentImpl,
 326         Fn,
 327         Other,
 328     }
 329
 330     let node_kind = match node {
 331         Node::TraitItem(item) => match item.kind {
 332             TraitItemKind::Fn(..) => NodeKind::Fn,
 333             _ => NodeKind::Other,
 334         },
 335
 336         Node::ImplItem(item) => match item.kind {
 337             ImplItemKind::Fn(..) => NodeKind::Fn,
 338             _ => NodeKind::Other,
 339         },
 340
 341         Node::Item(item) => match item.kind {
 342             ItemKind::Impl(hir::Impl { of_trait: Some(_), .. }) => NodeKind::TraitImpl,
 343             ItemKind::Impl(hir::Impl { of_trait: None, .. }) => NodeKind::InherentImpl,
 344             ItemKind::Fn(..) => NodeKind::Fn,
 345             _ => NodeKind::Other,
 346         },
 347
 348         Node::ForeignItem(item) => match item.kind {
 349             ForeignItemKind::Fn(..) => NodeKind::Fn,
 350             _ => NodeKind::Other,
 351         },
 352
 353         // FIXME: closures?
 354         _ => NodeKind::Other,
 355     };
 356
 357     // FIXME(eddyb) isn't the unordered nature of this a hazard?
 358     let mut inputs = FxIndexSet::default();
 359
 360     match node_kind {
 361         // In a trait impl, we assume that the header trait ref and all its
 362         // constituents are well-formed.
 363         NodeKind::TraitImpl => {
 364             let trait_ref = tcx.impl_trait_ref(def_id).expect("not an impl");
 365
 366             // FIXME(chalk): this has problems because of late-bound regions
 367             //inputs.extend(trait_ref.substs.iter().flat_map(|arg| arg.walk()));
 368             inputs.extend(trait_ref.substs.iter());
 369         }
 370
 371         // In an inherent impl, we assume that the receiver type and all its
 372         // constituents are well-formed.
 373         NodeKind::InherentImpl => {
 374             let self_ty = tcx.type_of(def_id);
 375             inputs.extend(self_ty.walk(tcx));
 376         }
 377
 378         // In an fn, we assume that the arguments and all their constituents are
 379         // well-formed.
 380         NodeKind::Fn => {
 381             let fn_sig = tcx.fn_sig(def_id);
 382             let fn_sig = tcx.liberate_late_bound_regions(def_id, fn_sig);
 383
 384             inputs.extend(fn_sig.inputs().iter().flat_map(|ty| ty.walk(tcx)));
 385         }
 386
 387         NodeKind::Other => (),
 388     }
 389     let input_clauses = inputs.into_iter().filter_map(|arg| {
 390         match arg.unpack() {
 391             GenericArgKind::Type(ty) => {
 392                 let binder = Binder::dummy(PredicateKind::TypeWellFormedFromEnv(ty));
 393                 Some(tcx.mk_predicate(binder))
 394             }
 395
 396             // FIXME(eddyb) no WF conditions from lifetimes?
 397             GenericArgKind::Lifetime(_) => None,
 398
 399             // FIXME(eddyb) support const generics in Chalk
 400             GenericArgKind::Const(_) => None,
 401         }
 402     });
 403
 404     tcx.mk_predicates(clauses.chain(input_clauses))
 405 }
 406
 407 fn param_env_reveal_all_normalized(tcx: TyCtxt<'_>, def_id: DefId) -> ty::ParamEnv<'_> {
 408     tcx.param_env(def_id).with_reveal_all_normalized(tcx)
 409 }
 410
 411 fn instance_def_size_estimate<'tcx>(
 412     tcx: TyCtxt<'tcx>,
 413     instance_def: ty::InstanceDef<'tcx>,
 414 ) -> usize {
 415     use ty::InstanceDef;
 416
 417     match instance_def {
 418         InstanceDef::Item(..) | InstanceDef::DropGlue(..) => {
 419             let mir = tcx.instance_mir(instance_def);
 420             mir.basic_blocks().iter().map(|bb| bb.statements.len() + 1).sum()
 421         }
 422         // Estimate the size of other compiler-generated shims to be 1.
 423         _ => 1,
 424     }
 425 }
 426
 427 /// If `def_id` is an issue 33140 hack impl, returns its self type; otherwise, returns `None`.
 428 ///
 429 /// See [`ty::ImplOverlapKind::Issue33140`] for more details.
 430 fn issue33140_self_ty(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Ty<'_>> {
 431     debug!("issue33140_self_ty({:?})", def_id);
 432
 433     let trait_ref = tcx
 434         .impl_trait_ref(def_id)
 435         .unwrap_or_else(|| bug!("issue33140_self_ty called on inherent impl {:?}", def_id));
 436
 437     debug!("issue33140_self_ty({:?}), trait-ref={:?}", def_id, trait_ref);
 438
 439     let is_marker_like = tcx.impl_polarity(def_id) == ty::ImplPolarity::Positive
 440         && tcx.associated_item_def_ids(trait_ref.def_id).is_empty();
 441
 442     // Check whether these impls would be ok for a marker trait.
 443     if !is_marker_like {
 444         debug!("issue33140_self_ty - not marker-like!");
 445         return None;
 446     }
 447
 448     // impl must be `impl Trait for dyn Marker1 + Marker2 + ...`
 449     if trait_ref.substs.len() != 1 {
 450         debug!("issue33140_self_ty - impl has substs!");
 451         return None;
 452     }
 453
 454     let predicates = tcx.predicates_of(def_id);
 455     if predicates.parent.is_some() || !predicates.predicates.is_empty() {
 456         debug!("issue33140_self_ty - impl has predicates {:?}!", predicates);
 457         return None;
 458     }
 459
 460     let self_ty = trait_ref.self_ty();
 461     let self_ty_matches = match self_ty.kind() {
 462         ty::Dynamic(ref data, ty::ReStatic) => data.principal().is_none(),
 463         _ => false,
 464     };
 465
 466     if self_ty_matches {
 467         debug!("issue33140_self_ty - MATCHES!");
 468         Some(self_ty)
 469     } else {
 470         debug!("issue33140_self_ty - non-matching self type");
 471         None
 472     }
 473 }
 474
 475 /// Check if a function is async.
 476 fn asyncness(tcx: TyCtxt<'_>, def_id: DefId) -> hir::IsAsync {
 477     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
 478
 479     let node = tcx.hir().get(hir_id);
 480
 481     let fn_like = hir_map::blocks::FnLikeNode::from_node(node).unwrap_or_else(|| {
 482         bug!("asyncness: expected fn-like node but got `{:?}`", def_id);
 483     });
 484
 485     fn_like.asyncness()
 486 }
 487
 488 /// Don't call this directly: use ``tcx.conservative_is_privately_uninhabited`` instead.
 489 #[instrument(level = "debug", skip(tcx))]
 490 pub fn conservative_is_privately_uninhabited_raw<'tcx>(
 491     tcx: TyCtxt<'tcx>,
 492     param_env_and: ty::ParamEnvAnd<'tcx, Ty<'tcx>>,
 493 ) -> bool {
 494     let (param_env, ty) = param_env_and.into_parts();
 495     match ty.kind() {
 496         ty::Never => {
 497             debug!("ty::Never =>");
 498             true
 499         }
 500         ty::Adt(def, _) if def.is_union() => {
 501             debug!("ty::Adt(def, _) if def.is_union() =>");
 502             // For now, `union`s are never considered uninhabited.
 503             false
 504         }
 505         ty::Adt(def, substs) => {
 506             debug!("ty::Adt(def, _) if def.is_not_union() =>");
 507             // Any ADT is uninhabited if either:
 508             // (a) It has no variants (i.e. an empty `enum`);
 509             // (b) Each of its variants (a single one in the case of a `struct`) has at least
 510             //     one uninhabited field.
 511             def.variants.iter().all(|var| {
 512                 var.fields.iter().any(|field| {
 513                     let ty = tcx.type_of(field.did).subst(tcx, substs);
 514                     tcx.conservative_is_privately_uninhabited(param_env.and(ty))
 515                 })
 516             })
 517         }
 518         ty::Tuple(..) => {
 519             debug!("ty::Tuple(..) =>");
 520             ty.tuple_fields().any(|ty| tcx.conservative_is_privately_uninhabited(param_env.and(ty)))
 521         }
 522         ty::Array(ty, len) => {
 523             debug!("ty::Array(ty, len) =>");
 524             match len.try_eval_usize(tcx, param_env) {
 525                 Some(0) | None => false,
 526                 // If the array is definitely non-empty, it's uninhabited if
 527                 // the type of its elements is uninhabited.
 528                 Some(1..) => tcx.conservative_is_privately_uninhabited(param_env.and(ty)),
 529             }
 530         }
 531         ty::Ref(..) => {
 532             debug!("ty::Ref(..) =>");
 533             // References to uninitialised memory is valid for any type, including
 534             // uninhabited types, in unsafe code, so we treat all references as
 535             // inhabited.
 536             false
 537         }
 538         _ => {
 539             debug!("_ =>");
 540             false
 541         }
 542     }
 543 }
 544
 545 pub fn provide(providers: &mut ty::query::Providers) {
 546     *providers = ty::query::Providers {
 547         asyncness,
 548         associated_item,
 549         associated_item_def_ids,
 550         associated_items,
 551         adt_sized_constraint,
 552         def_ident_span,
 553         param_env,
 554         param_env_reveal_all_normalized,
 555         trait_of_item,
 556         instance_def_size_estimate,
 557         issue33140_self_ty,
 558         impl_defaultness,
 559         impl_constness,
 560         conservative_is_privately_uninhabited: conservative_is_privately_uninhabited_raw,
 561         ..*providers
 562     };
 563 }