1 use rustc_data_structures::fx::FxIndexSet;
3 use rustc_hir::def_id::DefId;
4 use rustc_middle::ty::{self, Binder, Predicate, PredicateKind, ToPredicate, Ty, TyCtxt};
5 use rustc_trait_selection::traits;
7 fn sized_constraint_for_ty<'tcx>(
9 adtdef: ty::AdtDef<'tcx>,
12 use rustc_type_ir::sty::TyKind::*;
14 let result = match ty.kind() {
15 Bool | Char | Int(..) | Uint(..) | Float(..) | RawPtr(..) | Ref(..) | FnDef(..)
16 | FnPtr(_) | Array(..) | Closure(..) | Generator(..) | Never => vec![],
18 Str | Dynamic(..) | Slice(_) | Foreign(..) | Error(_) | GeneratorWitness(..) => {
19 // these are never sized - return the target type
23 Tuple(ref tys) => match tys.last() {
25 Some(&ty) => sized_constraint_for_ty(tcx, adtdef, ty),
30 let adt_tys = adt.sized_constraint(tcx);
31 debug!("sized_constraint_for_ty({:?}) intermediate = {:?}", ty, adt_tys);
35 .map(|ty| adt_tys.rebind(*ty).subst(tcx, substs))
36 .flat_map(|ty| sized_constraint_for_ty(tcx, adtdef, ty))
40 Projection(..) | Opaque(..) => {
41 // must calculate explicitly.
42 // FIXME: consider special-casing always-Sized projections
47 // perf hack: if there is a `T: Sized` bound, then
48 // we know that `T` is Sized and do not need to check
51 let Some(sized_trait) = tcx.lang_items().sized_trait() else { return vec![ty] };
52 let sized_predicate = ty::Binder::dummy(ty::TraitRef {
54 substs: tcx.mk_substs_trait(ty, &[]),
58 let predicates = tcx.predicates_of(adtdef.did()).predicates;
59 if predicates.iter().any(|(p, _)| *p == sized_predicate) { vec![] } else { vec![ty] }
62 Placeholder(..) | Bound(..) | Infer(..) => {
63 bug!("unexpected type `{:?}` in sized_constraint_for_ty", ty)
66 debug!("sized_constraint_for_ty({:?}) = {:?}", ty, result);
70 fn impl_defaultness(tcx: TyCtxt<'_>, def_id: DefId) -> hir::Defaultness {
71 match tcx.hir().get_by_def_id(def_id.expect_local()) {
72 hir::Node::Item(hir::Item { kind: hir::ItemKind::Impl(impl_), .. }) => impl_.defaultness,
73 hir::Node::ImplItem(hir::ImplItem { defaultness, .. })
74 | hir::Node::TraitItem(hir::TraitItem { defaultness, .. }) => *defaultness,
76 bug!("`impl_defaultness` called on {:?}", node);
81 /// Calculates the `Sized` constraint.
83 /// In fact, there are only a few options for the types in the constraint:
84 /// - an obviously-unsized type
85 /// - a type parameter or projection whose Sizedness can't be known
86 /// - a tuple of type parameters or projections, if there are multiple
88 /// - an Error, if a type is infinitely sized
89 fn adt_sized_constraint(tcx: TyCtxt<'_>, def_id: DefId) -> &[Ty<'_>] {
90 if let Some(def_id) = def_id.as_local() {
91 if matches!(tcx.representability(def_id), ty::Representability::Infinite) {
92 return tcx.intern_type_list(&[tcx.ty_error()]);
95 let def = tcx.adt_def(def_id);
97 let result = tcx.mk_type_list(
100 .flat_map(|v| v.fields.last())
101 .flat_map(|f| sized_constraint_for_ty(tcx, def, tcx.type_of(f.did))),
104 debug!("adt_sized_constraint: {:?} => {:?}", def, result);
109 /// See `ParamEnv` struct definition for details.
110 fn param_env(tcx: TyCtxt<'_>, def_id: DefId) -> ty::ParamEnv<'_> {
111 // The param_env of an impl Trait type is its defining function's param_env
112 if let Some(parent) = ty::is_impl_trait_defn(tcx, def_id) {
113 return param_env(tcx, parent.to_def_id());
115 // Compute the bounds on Self and the type parameters.
117 let ty::InstantiatedPredicates { mut predicates, .. } =
118 tcx.predicates_of(def_id).instantiate_identity(tcx);
120 // Finally, we have to normalize the bounds in the environment, in
121 // case they contain any associated type projections. This process
122 // can yield errors if the put in illegal associated types, like
123 // `<i32 as Foo>::Bar` where `i32` does not implement `Foo`. We
124 // report these errors right here; this doesn't actually feel
125 // right to me, because constructing the environment feels like a
126 // kind of an "idempotent" action, but I'm not sure where would be
127 // a better place. In practice, we construct environments for
128 // every fn once during type checking, and we'll abort if there
129 // are any errors at that point, so outside of type inference you can be
130 // sure that this will succeed without errors anyway.
132 if tcx.sess.opts.unstable_opts.chalk {
133 let environment = well_formed_types_in_env(tcx, def_id);
134 predicates.extend(environment);
137 let local_did = def_id.as_local();
138 let hir_id = local_did.map(|def_id| tcx.hir().local_def_id_to_hir_id(def_id));
140 // FIXME(consts): This is not exactly in line with the constness query.
141 let constness = match hir_id {
142 Some(hir_id) => match tcx.hir().get(hir_id) {
143 hir::Node::TraitItem(hir::TraitItem { kind: hir::TraitItemKind::Fn(..), .. })
144 if tcx.is_const_default_method(def_id) =>
146 hir::Constness::Const
149 hir::Node::Item(hir::Item { kind: hir::ItemKind::Const(..), .. })
150 | hir::Node::Item(hir::Item { kind: hir::ItemKind::Static(..), .. })
151 | hir::Node::TraitItem(hir::TraitItem {
152 kind: hir::TraitItemKind::Const(..), ..
154 | hir::Node::AnonConst(_)
155 | hir::Node::ImplItem(hir::ImplItem { kind: hir::ImplItemKind::Const(..), .. })
156 | hir::Node::ImplItem(hir::ImplItem {
158 hir::ImplItemKind::Fn(
160 header: hir::FnHeader { constness: hir::Constness::Const, .. },
166 }) => hir::Constness::Const,
168 hir::Node::ImplItem(hir::ImplItem {
169 kind: hir::ImplItemKind::Type(..) | hir::ImplItemKind::Fn(..),
172 let parent_hir_id = tcx.hir().get_parent_node(hir_id);
173 match tcx.hir().get(parent_hir_id) {
174 hir::Node::Item(hir::Item {
175 kind: hir::ItemKind::Impl(hir::Impl { constness, .. }),
179 tcx.def_span(parent_hir_id.owner),
180 "impl item's parent node is not an impl",
185 hir::Node::Item(hir::Item {
187 hir::ItemKind::Fn(hir::FnSig { header: hir::FnHeader { constness, .. }, .. }, ..),
190 | hir::Node::TraitItem(hir::TraitItem {
192 hir::TraitItemKind::Fn(
193 hir::FnSig { header: hir::FnHeader { constness, .. }, .. },
198 | hir::Node::Item(hir::Item {
199 kind: hir::ItemKind::Impl(hir::Impl { constness, .. }),
203 _ => hir::Constness::NotConst,
205 // FIXME(consts): It's suspicious that a param-env for a foreign item
206 // will always have NotConst param-env, though we don't typically use
207 // that param-env for anything meaningful right now, so it's likely
209 None => hir::Constness::NotConst,
212 let unnormalized_env = ty::ParamEnv::new(
213 tcx.intern_predicates(&predicates),
214 traits::Reveal::UserFacing,
219 local_did.and_then(|id| tcx.hir().maybe_body_owned_by(id).map(|body| body.hir_id));
220 let body_id = match body_id {
222 None if hir_id.is_some() => hir_id.unwrap(),
223 _ => hir::CRATE_HIR_ID,
226 let cause = traits::ObligationCause::misc(tcx.def_span(def_id), body_id);
227 traits::normalize_param_env_or_error(tcx, unnormalized_env, cause)
230 /// Elaborate the environment.
232 /// Collect a list of `Predicate`'s used for building the `ParamEnv`. Adds `TypeWellFormedFromEnv`'s
233 /// that are assumed to be well-formed (because they come from the environment).
235 /// Used only in chalk mode.
236 fn well_formed_types_in_env<'tcx>(
239 ) -> &'tcx ty::List<Predicate<'tcx>> {
240 use rustc_hir::{ForeignItemKind, ImplItemKind, ItemKind, Node, TraitItemKind};
241 use rustc_middle::ty::subst::GenericArgKind;
243 debug!("environment(def_id = {:?})", def_id);
245 // The environment of an impl Trait type is its defining function's environment.
246 if let Some(parent) = ty::is_impl_trait_defn(tcx, def_id) {
247 return well_formed_types_in_env(tcx, parent.to_def_id());
250 // Compute the bounds on `Self` and the type parameters.
251 let ty::InstantiatedPredicates { predicates, .. } =
252 tcx.predicates_of(def_id).instantiate_identity(tcx);
254 let clauses = predicates.into_iter();
256 if !def_id.is_local() {
257 return ty::List::empty();
259 let node = tcx.hir().get_by_def_id(def_id.expect_local());
268 let node_kind = match node {
269 Node::TraitItem(item) => match item.kind {
270 TraitItemKind::Fn(..) => NodeKind::Fn,
271 _ => NodeKind::Other,
274 Node::ImplItem(item) => match item.kind {
275 ImplItemKind::Fn(..) => NodeKind::Fn,
276 _ => NodeKind::Other,
279 Node::Item(item) => match item.kind {
280 ItemKind::Impl(hir::Impl { of_trait: Some(_), .. }) => NodeKind::TraitImpl,
281 ItemKind::Impl(hir::Impl { of_trait: None, .. }) => NodeKind::InherentImpl,
282 ItemKind::Fn(..) => NodeKind::Fn,
283 _ => NodeKind::Other,
286 Node::ForeignItem(item) => match item.kind {
287 ForeignItemKind::Fn(..) => NodeKind::Fn,
288 _ => NodeKind::Other,
292 _ => NodeKind::Other,
295 // FIXME(eddyb) isn't the unordered nature of this a hazard?
296 let mut inputs = FxIndexSet::default();
299 // In a trait impl, we assume that the header trait ref and all its
300 // constituents are well-formed.
301 NodeKind::TraitImpl => {
302 let trait_ref = tcx.impl_trait_ref(def_id).expect("not an impl");
304 // FIXME(chalk): this has problems because of late-bound regions
305 //inputs.extend(trait_ref.substs.iter().flat_map(|arg| arg.walk()));
306 inputs.extend(trait_ref.substs.iter());
309 // In an inherent impl, we assume that the receiver type and all its
310 // constituents are well-formed.
311 NodeKind::InherentImpl => {
312 let self_ty = tcx.type_of(def_id);
313 inputs.extend(self_ty.walk());
316 // In an fn, we assume that the arguments and all their constituents are
319 let fn_sig = tcx.fn_sig(def_id);
320 let fn_sig = tcx.liberate_late_bound_regions(def_id, fn_sig);
322 inputs.extend(fn_sig.inputs().iter().flat_map(|ty| ty.walk()));
325 NodeKind::Other => (),
327 let input_clauses = inputs.into_iter().filter_map(|arg| {
329 GenericArgKind::Type(ty) => {
330 let binder = Binder::dummy(PredicateKind::TypeWellFormedFromEnv(ty));
331 Some(tcx.mk_predicate(binder))
334 // FIXME(eddyb) no WF conditions from lifetimes?
335 GenericArgKind::Lifetime(_) => None,
337 // FIXME(eddyb) support const generics in Chalk
338 GenericArgKind::Const(_) => None,
342 tcx.mk_predicates(clauses.chain(input_clauses))
345 fn param_env_reveal_all_normalized(tcx: TyCtxt<'_>, def_id: DefId) -> ty::ParamEnv<'_> {
346 tcx.param_env(def_id).with_reveal_all_normalized(tcx)
349 fn instance_def_size_estimate<'tcx>(
351 instance_def: ty::InstanceDef<'tcx>,
356 InstanceDef::Item(..) | InstanceDef::DropGlue(..) => {
357 let mir = tcx.instance_mir(instance_def);
358 mir.basic_blocks.iter().map(|bb| bb.statements.len() + 1).sum()
360 // Estimate the size of other compiler-generated shims to be 1.
365 /// If `def_id` is an issue 33140 hack impl, returns its self type; otherwise, returns `None`.
367 /// See [`ty::ImplOverlapKind::Issue33140`] for more details.
368 fn issue33140_self_ty(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Ty<'_>> {
369 debug!("issue33140_self_ty({:?})", def_id);
372 .impl_trait_ref(def_id)
373 .unwrap_or_else(|| bug!("issue33140_self_ty called on inherent impl {:?}", def_id));
375 debug!("issue33140_self_ty({:?}), trait-ref={:?}", def_id, trait_ref);
377 let is_marker_like = tcx.impl_polarity(def_id) == ty::ImplPolarity::Positive
378 && tcx.associated_item_def_ids(trait_ref.def_id).is_empty();
380 // Check whether these impls would be ok for a marker trait.
382 debug!("issue33140_self_ty - not marker-like!");
386 // impl must be `impl Trait for dyn Marker1 + Marker2 + ...`
387 if trait_ref.substs.len() != 1 {
388 debug!("issue33140_self_ty - impl has substs!");
392 let predicates = tcx.predicates_of(def_id);
393 if predicates.parent.is_some() || !predicates.predicates.is_empty() {
394 debug!("issue33140_self_ty - impl has predicates {:?}!", predicates);
398 let self_ty = trait_ref.self_ty();
399 let self_ty_matches = match self_ty.kind() {
400 ty::Dynamic(ref data, re, _) if re.is_static() => data.principal().is_none(),
405 debug!("issue33140_self_ty - MATCHES!");
408 debug!("issue33140_self_ty - non-matching self type");
413 /// Check if a function is async.
414 fn asyncness(tcx: TyCtxt<'_>, def_id: DefId) -> hir::IsAsync {
415 let node = tcx.hir().get_by_def_id(def_id.expect_local());
416 node.fn_sig().map_or(hir::IsAsync::NotAsync, |sig| sig.header.asyncness)
419 /// Don't call this directly: use ``tcx.conservative_is_privately_uninhabited`` instead.
420 pub fn conservative_is_privately_uninhabited_raw<'tcx>(
422 param_env_and: ty::ParamEnvAnd<'tcx, Ty<'tcx>>,
424 let (param_env, ty) = param_env_and.into_parts();
427 debug!("ty::Never =>");
430 ty::Adt(def, _) if def.is_union() => {
431 debug!("ty::Adt(def, _) if def.is_union() =>");
432 // For now, `union`s are never considered uninhabited.
435 ty::Adt(def, substs) => {
436 debug!("ty::Adt(def, _) if def.is_not_union() =>");
437 // Any ADT is uninhabited if either:
438 // (a) It has no variants (i.e. an empty `enum`);
439 // (b) Each of its variants (a single one in the case of a `struct`) has at least
440 // one uninhabited field.
441 def.variants().iter().all(|var| {
442 var.fields.iter().any(|field| {
443 let ty = tcx.bound_type_of(field.did).subst(tcx, substs);
444 tcx.conservative_is_privately_uninhabited(param_env.and(ty))
448 ty::Tuple(fields) => {
449 debug!("ty::Tuple(..) =>");
450 fields.iter().any(|ty| tcx.conservative_is_privately_uninhabited(param_env.and(ty)))
452 ty::Array(ty, len) => {
453 debug!("ty::Array(ty, len) =>");
454 match len.try_eval_usize(tcx, param_env) {
455 Some(0) | None => false,
456 // If the array is definitely non-empty, it's uninhabited if
457 // the type of its elements is uninhabited.
458 Some(1..) => tcx.conservative_is_privately_uninhabited(param_env.and(*ty)),
462 debug!("ty::Ref(..) =>");
463 // References to uninitialised memory is valid for any type, including
464 // uninhabited types, in unsafe code, so we treat all references as
475 pub fn provide(providers: &mut ty::query::Providers) {
476 *providers = ty::query::Providers {
478 adt_sized_constraint,
480 param_env_reveal_all_normalized,
481 instance_def_size_estimate,
484 conservative_is_privately_uninhabited: conservative_is_privately_uninhabited_raw,