1 use rustc_data_structures::svh::Svh;
3 use rustc_hir::def::DefKind;
4 use rustc_hir::def_id::{CrateNum, DefId, LocalDefId, LOCAL_CRATE};
5 use rustc_infer::traits::util;
6 use rustc_middle::hir::map as hir_map;
7 use rustc_middle::ty::subst::{InternalSubsts, Subst};
8 use rustc_middle::ty::{self, ToPredicate, Ty, TyCtxt, WithConstness};
9 use rustc_session::CrateDisambiguator;
10 use rustc_span::symbol::Symbol;
12 use rustc_trait_selection::traits;
14 fn sized_constraint_for_ty<'tcx>(
21 let result = match ty.kind {
22 Bool | Char | Int(..) | Uint(..) | Float(..) | RawPtr(..) | Ref(..) | FnDef(..)
23 | FnPtr(_) | Array(..) | Closure(..) | Generator(..) | Never => vec![],
25 Str | Dynamic(..) | Slice(_) | Foreign(..) | Error(_) | GeneratorWitness(..) => {
26 // these are never sized - return the target type
30 Tuple(ref tys) => match tys.last() {
32 Some(ty) => sized_constraint_for_ty(tcx, adtdef, ty.expect_ty()),
37 let adt_tys = adt.sized_constraint(tcx);
38 debug!("sized_constraint_for_ty({:?}) intermediate = {:?}", ty, adt_tys);
41 .map(|ty| ty.subst(tcx, substs))
42 .flat_map(|ty| sized_constraint_for_ty(tcx, adtdef, ty))
46 Projection(..) | Opaque(..) => {
47 // must calculate explicitly.
48 // FIXME: consider special-casing always-Sized projections
53 // perf hack: if there is a `T: Sized` bound, then
54 // we know that `T` is Sized and do not need to check
57 let sized_trait = match tcx.lang_items().sized_trait() {
61 let sized_predicate = ty::Binder::dummy(ty::TraitRef {
63 substs: tcx.mk_substs_trait(ty, &[]),
67 let predicates = tcx.predicates_of(adtdef.did).predicates;
68 if predicates.iter().any(|(p, _)| *p == sized_predicate) { vec![] } else { vec![ty] }
71 Placeholder(..) | Bound(..) | Infer(..) => {
72 bug!("unexpected type `{:?}` in sized_constraint_for_ty", ty)
75 debug!("sized_constraint_for_ty({:?}) = {:?}", ty, result);
79 fn associated_item_from_trait_item_ref(
81 parent_def_id: LocalDefId,
82 parent_vis: &hir::Visibility<'_>,
83 trait_item_ref: &hir::TraitItemRef,
85 let def_id = tcx.hir().local_def_id(trait_item_ref.id.hir_id);
86 let (kind, has_self) = match trait_item_ref.kind {
87 hir::AssocItemKind::Const => (ty::AssocKind::Const, false),
88 hir::AssocItemKind::Fn { has_self } => (ty::AssocKind::Fn, has_self),
89 hir::AssocItemKind::Type => (ty::AssocKind::Type, false),
93 ident: trait_item_ref.ident,
95 // Visibility of trait items is inherited from their traits.
96 vis: ty::Visibility::from_hir(parent_vis, trait_item_ref.id.hir_id, tcx),
97 defaultness: trait_item_ref.defaultness,
98 def_id: def_id.to_def_id(),
99 container: ty::TraitContainer(parent_def_id.to_def_id()),
100 fn_has_self_parameter: has_self,
104 fn associated_item_from_impl_item_ref(
106 parent_def_id: LocalDefId,
107 impl_item_ref: &hir::ImplItemRef<'_>,
109 let def_id = tcx.hir().local_def_id(impl_item_ref.id.hir_id);
110 let (kind, has_self) = match impl_item_ref.kind {
111 hir::AssocItemKind::Const => (ty::AssocKind::Const, false),
112 hir::AssocItemKind::Fn { has_self } => (ty::AssocKind::Fn, has_self),
113 hir::AssocItemKind::Type => (ty::AssocKind::Type, false),
117 ident: impl_item_ref.ident,
119 // Visibility of trait impl items doesn't matter.
120 vis: ty::Visibility::from_hir(&impl_item_ref.vis, impl_item_ref.id.hir_id, tcx),
121 defaultness: impl_item_ref.defaultness,
122 def_id: def_id.to_def_id(),
123 container: ty::ImplContainer(parent_def_id.to_def_id()),
124 fn_has_self_parameter: has_self,
128 fn associated_item(tcx: TyCtxt<'_>, def_id: DefId) -> ty::AssocItem {
129 let id = tcx.hir().as_local_hir_id(def_id.expect_local());
130 let parent_id = tcx.hir().get_parent_item(id);
131 let parent_def_id = tcx.hir().local_def_id(parent_id);
132 let parent_item = tcx.hir().expect_item(parent_id);
133 match parent_item.kind {
134 hir::ItemKind::Impl { ref items, .. } => {
135 if let Some(impl_item_ref) = items.iter().find(|i| i.id.hir_id == id) {
137 associated_item_from_impl_item_ref(tcx, parent_def_id, impl_item_ref);
138 debug_assert_eq!(assoc_item.def_id, def_id);
143 hir::ItemKind::Trait(.., ref trait_item_refs) => {
144 if let Some(trait_item_ref) = trait_item_refs.iter().find(|i| i.id.hir_id == id) {
145 let assoc_item = associated_item_from_trait_item_ref(
151 debug_assert_eq!(assoc_item.def_id, def_id);
161 "unexpected parent of trait or impl item or item not found: {:?}",
166 fn impl_defaultness(tcx: TyCtxt<'_>, def_id: DefId) -> hir::Defaultness {
167 let hir_id = tcx.hir().as_local_hir_id(def_id.expect_local());
168 let item = tcx.hir().expect_item(hir_id);
169 if let hir::ItemKind::Impl { defaultness, .. } = item.kind {
172 bug!("`impl_defaultness` called on {:?}", item);
176 /// Calculates the `Sized` constraint.
178 /// In fact, there are only a few options for the types in the constraint:
179 /// - an obviously-unsized type
180 /// - a type parameter or projection whose Sizedness can't be known
181 /// - a tuple of type parameters or projections, if there are multiple
183 /// - a Error, if a type contained itself. The representability
184 /// check should catch this case.
185 fn adt_sized_constraint(tcx: TyCtxt<'_>, def_id: DefId) -> ty::AdtSizedConstraint<'_> {
186 let def = tcx.adt_def(def_id);
188 let result = tcx.mk_type_list(
191 .flat_map(|v| v.fields.last())
192 .flat_map(|f| sized_constraint_for_ty(tcx, def, tcx.type_of(f.did))),
195 debug!("adt_sized_constraint: {:?} => {:?}", def, result);
197 ty::AdtSizedConstraint(result)
200 fn associated_item_def_ids(tcx: TyCtxt<'_>, def_id: DefId) -> &[DefId] {
201 let id = tcx.hir().as_local_hir_id(def_id.expect_local());
202 let item = tcx.hir().expect_item(id);
204 hir::ItemKind::Trait(.., ref trait_item_refs) => tcx.arena.alloc_from_iter(
207 .map(|trait_item_ref| trait_item_ref.id)
208 .map(|id| tcx.hir().local_def_id(id.hir_id).to_def_id()),
210 hir::ItemKind::Impl { ref items, .. } => tcx.arena.alloc_from_iter(
213 .map(|impl_item_ref| impl_item_ref.id)
214 .map(|id| tcx.hir().local_def_id(id.hir_id).to_def_id()),
216 hir::ItemKind::TraitAlias(..) => &[],
217 _ => span_bug!(item.span, "associated_item_def_ids: not impl or trait"),
221 fn associated_items(tcx: TyCtxt<'_>, def_id: DefId) -> ty::AssociatedItems<'_> {
222 let items = tcx.associated_item_def_ids(def_id).iter().map(|did| tcx.associated_item(*did));
223 ty::AssociatedItems::new(items)
226 fn def_span(tcx: TyCtxt<'_>, def_id: DefId) -> Span {
227 tcx.hir().span_if_local(def_id).unwrap()
230 /// If the given `DefId` describes an item belonging to a trait,
231 /// returns the `DefId` of the trait that the trait item belongs to;
232 /// otherwise, returns `None`.
233 fn trait_of_item(tcx: TyCtxt<'_>, def_id: DefId) -> Option<DefId> {
234 tcx.opt_associated_item(def_id).and_then(|associated_item| match associated_item.container {
235 ty::TraitContainer(def_id) => Some(def_id),
236 ty::ImplContainer(_) => None,
240 /// See `ParamEnv` struct definition for details.
241 fn param_env(tcx: TyCtxt<'_>, def_id: DefId) -> ty::ParamEnv<'_> {
242 // The param_env of an impl Trait type is its defining function's param_env
243 if let Some(parent) = ty::is_impl_trait_defn(tcx, def_id) {
244 return param_env(tcx, parent);
246 // Compute the bounds on Self and the type parameters.
248 let ty::InstantiatedPredicates { predicates, .. } =
249 tcx.predicates_of(def_id).instantiate_identity(tcx);
251 // Finally, we have to normalize the bounds in the environment, in
252 // case they contain any associated type projections. This process
253 // can yield errors if the put in illegal associated types, like
254 // `<i32 as Foo>::Bar` where `i32` does not implement `Foo`. We
255 // report these errors right here; this doesn't actually feel
256 // right to me, because constructing the environment feels like a
257 // kind of a "idempotent" action, but I'm not sure where would be
258 // a better place. In practice, we construct environments for
259 // every fn once during type checking, and we'll abort if there
260 // are any errors at that point, so after type checking you can be
261 // sure that this will succeed without errors anyway.
263 let unnormalized_env = ty::ParamEnv::new(
264 tcx.intern_predicates(&predicates),
265 traits::Reveal::UserFacing,
266 tcx.sess.opts.debugging_opts.chalk.then_some(def_id),
271 .map(|def_id| tcx.hir().as_local_hir_id(def_id))
272 .map_or(hir::CRATE_HIR_ID, |id| {
273 tcx.hir().maybe_body_owned_by(id).map_or(id, |body| body.hir_id)
275 let cause = traits::ObligationCause::misc(tcx.def_span(def_id), body_id);
276 traits::normalize_param_env_or_error(tcx, def_id, unnormalized_env, cause)
279 fn crate_disambiguator(tcx: TyCtxt<'_>, crate_num: CrateNum) -> CrateDisambiguator {
280 assert_eq!(crate_num, LOCAL_CRATE);
281 tcx.sess.local_crate_disambiguator()
284 fn original_crate_name(tcx: TyCtxt<'_>, crate_num: CrateNum) -> Symbol {
285 assert_eq!(crate_num, LOCAL_CRATE);
289 fn crate_hash(tcx: TyCtxt<'_>, crate_num: CrateNum) -> Svh {
290 tcx.index_hir(crate_num).crate_hash
293 fn instance_def_size_estimate<'tcx>(
295 instance_def: ty::InstanceDef<'tcx>,
300 InstanceDef::Item(..) | InstanceDef::DropGlue(..) => {
301 let mir = tcx.instance_mir(instance_def);
302 mir.basic_blocks().iter().map(|bb| bb.statements.len()).sum()
304 // Estimate the size of other compiler-generated shims to be 1.
309 /// If `def_id` is an issue 33140 hack impl, returns its self type; otherwise, returns `None`.
311 /// See [`ty::ImplOverlapKind::Issue33140`] for more details.
312 fn issue33140_self_ty(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Ty<'_>> {
313 debug!("issue33140_self_ty({:?})", def_id);
316 .impl_trait_ref(def_id)
317 .unwrap_or_else(|| bug!("issue33140_self_ty called on inherent impl {:?}", def_id));
319 debug!("issue33140_self_ty({:?}), trait-ref={:?}", def_id, trait_ref);
321 let is_marker_like = tcx.impl_polarity(def_id) == ty::ImplPolarity::Positive
322 && tcx.associated_item_def_ids(trait_ref.def_id).is_empty();
324 // Check whether these impls would be ok for a marker trait.
326 debug!("issue33140_self_ty - not marker-like!");
330 // impl must be `impl Trait for dyn Marker1 + Marker2 + ...`
331 if trait_ref.substs.len() != 1 {
332 debug!("issue33140_self_ty - impl has substs!");
336 let predicates = tcx.predicates_of(def_id);
337 if predicates.parent.is_some() || !predicates.predicates.is_empty() {
338 debug!("issue33140_self_ty - impl has predicates {:?}!", predicates);
342 let self_ty = trait_ref.self_ty();
343 let self_ty_matches = match self_ty.kind {
344 ty::Dynamic(ref data, ty::ReStatic) => data.principal().is_none(),
349 debug!("issue33140_self_ty - MATCHES!");
352 debug!("issue33140_self_ty - non-matching self type");
357 /// Check if a function is async.
358 fn asyncness(tcx: TyCtxt<'_>, def_id: DefId) -> hir::IsAsync {
359 let hir_id = tcx.hir().as_local_hir_id(def_id.expect_local());
361 let node = tcx.hir().get(hir_id);
363 let fn_like = hir_map::blocks::FnLikeNode::from_node(node).unwrap_or_else(|| {
364 bug!("asyncness: expected fn-like node but got `{:?}`", def_id);
370 /// For associated types we allow bounds written on the associated type
371 /// (`type X: Trait`) to be used as candidates. We also allow the same bounds
372 /// when desugared as bounds on the trait `where Self::X: Trait`.
374 /// Note that this filtering is done with the items identity substs to
375 /// simplify checking that these bounds are met in impls. This means that
376 /// a bound such as `for<'b> <Self as X<'b>>::U: Clone` can't be used, as in
377 /// `hr-associated-type-bound-1.rs`.
378 fn associated_type_projection_predicates(
380 assoc_item_def_id: DefId,
381 ) -> &'_ ty::List<ty::Predicate<'_>> {
382 let generic_trait_bounds = tcx.predicates_of(assoc_item_def_id);
383 // We include predicates from the trait as well to handle
384 // `where Self::X: Trait`.
385 let item_bounds = generic_trait_bounds.instantiate_identity(tcx);
386 let item_predicates = util::elaborate_predicates(tcx, item_bounds.predicates.into_iter());
388 let assoc_item_ty = ty::ProjectionTy {
389 item_def_id: assoc_item_def_id,
390 substs: InternalSubsts::identity_for_item(tcx, assoc_item_def_id),
393 let predicates = item_predicates.filter_map(|obligation| {
394 let pred = obligation.predicate;
396 ty::PredicateKind::Trait(tr, _) => {
397 if let ty::Projection(p) = tr.skip_binder().self_ty().kind {
398 if p == assoc_item_ty {
403 ty::PredicateKind::Projection(proj) => {
404 if let ty::Projection(p) = proj.skip_binder().projection_ty.self_ty().kind {
405 if p == assoc_item_ty {
410 ty::PredicateKind::TypeOutlives(outlives) => {
411 if let ty::Projection(p) = outlives.skip_binder().0.kind {
412 if p == assoc_item_ty {
422 let result = tcx.mk_predicates(predicates);
424 "associated_type_projection_predicates({}) = {:?}",
425 tcx.def_path_str(assoc_item_def_id),
431 /// Opaque types don't have the same issues as associated types: the only
432 /// predicates on an opaque type (excluding those it inherits from its parent
433 /// item) should be of the form we're expecting.
434 fn opaque_type_projection_predicates(
437 ) -> &'_ ty::List<ty::Predicate<'_>> {
438 let substs = InternalSubsts::identity_for_item(tcx, def_id);
440 let bounds = tcx.predicates_of(def_id);
442 util::elaborate_predicates(tcx, bounds.predicates.into_iter().map(|&(pred, _)| pred));
444 let filtered_predicates = predicates.filter_map(|obligation| {
445 let pred = obligation.predicate;
447 ty::PredicateKind::Trait(tr, _) => {
448 if let ty::Opaque(opaque_def_id, opaque_substs) = tr.skip_binder().self_ty().kind {
449 if opaque_def_id == def_id && opaque_substs == substs {
454 ty::PredicateKind::Projection(proj) => {
455 if let ty::Opaque(opaque_def_id, opaque_substs) =
456 proj.skip_binder().projection_ty.self_ty().kind
458 if opaque_def_id == def_id && opaque_substs == substs {
463 ty::PredicateKind::TypeOutlives(outlives) => {
464 if let ty::Opaque(opaque_def_id, opaque_substs) = outlives.skip_binder().0.kind {
465 if opaque_def_id == def_id && opaque_substs == substs {
469 // These can come from elaborating other predicates
473 // These can come from elaborating other predicates
474 ty::PredicateKind::RegionOutlives(_) => return None,
477 tcx.sess.delay_span_bug(
478 obligation.cause.span(tcx),
479 &format!("unexpected predicate {:?} on opaque type", pred),
484 let result = tcx.mk_predicates(filtered_predicates);
485 debug!("opaque_type_projection_predicates({}) = {:?}", tcx.def_path_str(def_id), result);
489 fn projection_predicates(tcx: TyCtxt<'_>, def_id: DefId) -> &'_ ty::List<ty::Predicate<'_>> {
490 match tcx.def_kind(def_id) {
491 DefKind::AssocTy => associated_type_projection_predicates(tcx, def_id),
492 DefKind::OpaqueTy => opaque_type_projection_predicates(tcx, def_id),
493 k => bug!("projection_predicates called on {}", k.descr(def_id)),
497 pub fn provide(providers: &mut ty::query::Providers<'_>) {
498 *providers = ty::query::Providers {
501 associated_item_def_ids,
503 adt_sized_constraint,
510 instance_def_size_estimate,
513 projection_predicates,