1 //! "Collection" is the process of determining the type and other external
2 //! details of each item in Rust. Collection is specifically concerned
3 //! with *inter-procedural* things -- for example, for a function
4 //! definition, collection will figure out the type and signature of the
5 //! function, but it will not visit the *body* of the function in any way,
6 //! nor examine type annotations on local variables (that's the job of
9 //! Collecting is ultimately defined by a bundle of queries that
10 //! inquire after various facts about the items in the crate (e.g.,
11 //! `type_of`, `generics_of`, `predicates_of`, etc). See the `provide` function
14 //! At present, however, we do run collection across all items in the
15 //! crate as a kind of pass. This should eventually be factored away.
17 use crate::astconv::{AstConv, Bounds, SizedByDefault};
18 use crate::check::intrinsic::intrinsic_operation_unsafety;
19 use crate::constrained_generic_params as cgp;
21 use crate::middle::resolve_lifetime as rl;
22 use crate::middle::weak_lang_items;
23 use rustc::hir::map::Map;
24 use rustc::middle::codegen_fn_attrs::{CodegenFnAttrFlags, CodegenFnAttrs};
25 use rustc::mir::mono::Linkage;
26 use rustc::session::parse::feature_err;
28 use rustc::ty::query::Providers;
29 use rustc::ty::subst::GenericArgKind;
30 use rustc::ty::subst::{InternalSubsts, Subst};
31 use rustc::ty::util::Discr;
32 use rustc::ty::util::IntTypeExt;
33 use rustc::ty::{self, AdtKind, Const, DefIdTree, ToPolyTraitRef, Ty, TyCtxt};
34 use rustc::ty::{ReprOptions, ToPredicate};
35 use rustc_data_structures::captures::Captures;
36 use rustc_data_structures::fx::FxHashMap;
37 use rustc_errors::{struct_span_err, Applicability, StashKey};
39 use rustc_hir::def::{CtorKind, DefKind, Res};
40 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
41 use rustc_hir::intravisit::{self, NestedVisitorMap, Visitor};
42 use rustc_hir::{GenericParamKind, Node, Unsafety};
43 use rustc_span::symbol::{kw, sym, Symbol};
44 use rustc_span::{Span, DUMMY_SP};
45 use rustc_target::spec::abi;
47 use syntax::ast::{Ident, MetaItemKind};
48 use syntax::attr::{list_contains_name, mark_used, InlineAttr, OptimizeAttr};
50 use rustc_error_codes::*;
52 struct OnlySelfBounds(bool);
54 ///////////////////////////////////////////////////////////////////////////
57 fn collect_mod_item_types(tcx: TyCtxt<'_>, module_def_id: DefId) {
58 tcx.hir().visit_item_likes_in_module(
60 &mut CollectItemTypesVisitor { tcx }.as_deep_visitor(),
64 pub fn provide(providers: &mut Providers<'_>) {
65 *providers = Providers {
69 predicates_defined_on,
70 explicit_predicates_of,
72 type_param_predicates,
81 collect_mod_item_types,
86 ///////////////////////////////////////////////////////////////////////////
88 /// Context specific to some particular item. This is what implements
89 /// `AstConv`. It has information about the predicates that are defined
90 /// on the trait. Unfortunately, this predicate information is
91 /// available in various different forms at various points in the
92 /// process. So we can't just store a pointer to e.g., the AST or the
93 /// parsed ty form, we have to be more flexible. To this end, the
94 /// `ItemCtxt` is parameterized by a `DefId` that it uses to satisfy
95 /// `get_type_parameter_bounds` requests, drawing the information from
96 /// the AST (`hir::Generics`), recursively.
97 pub struct ItemCtxt<'tcx> {
102 ///////////////////////////////////////////////////////////////////////////
105 crate struct PlaceholderHirTyCollector(crate Vec<Span>);
107 impl<'v> Visitor<'v> for PlaceholderHirTyCollector {
110 fn nested_visit_map(&mut self) -> NestedVisitorMap<'_, Self::Map> {
111 NestedVisitorMap::None
113 fn visit_ty(&mut self, t: &'v hir::Ty<'v>) {
114 if let hir::TyKind::Infer = t.kind {
117 intravisit::walk_ty(self, t)
121 struct CollectItemTypesVisitor<'tcx> {
125 /// If there are any placeholder types (`_`), emit an error explaining that this is not allowed
126 /// and suggest adding type parameters in the appropriate place, taking into consideration any and
127 /// all already existing generic type parameters to avoid suggesting a name that is already in use.
128 crate fn placeholder_type_error(
131 generics: &[hir::GenericParam<'_>],
132 placeholder_types: Vec<Span>,
135 if placeholder_types.is_empty() {
138 // This is the whitelist of possible parameter names that we might suggest.
139 let possible_names = ["T", "K", "L", "A", "B", "C"];
140 let used_names = generics
142 .filter_map(|p| match p.name {
143 hir::ParamName::Plain(ident) => Some(ident.name),
146 .collect::<Vec<_>>();
148 let type_name = possible_names
150 .find(|n| !used_names.contains(&Symbol::intern(n)))
151 .unwrap_or(&"ParamName");
153 let mut sugg: Vec<_> =
154 placeholder_types.iter().map(|sp| (*sp, type_name.to_string())).collect();
155 if generics.is_empty() {
156 sugg.push((span, format!("<{}>", type_name)));
157 } else if let Some(arg) = generics.iter().find(|arg| match arg.name {
158 hir::ParamName::Plain(Ident { name: kw::Underscore, .. }) => true,
161 // Account for `_` already present in cases like `struct S<_>(_);` and suggest
162 // `struct S<T>(T);` instead of `struct S<_, T>(T);`.
163 sugg.push((arg.span, format!("{}", type_name)));
166 generics.iter().last().unwrap().span.shrink_to_hi(),
167 format!(", {}", type_name),
170 let mut err = bad_placeholder_type(tcx, placeholder_types);
172 err.multipart_suggestion(
173 "use type parameters instead",
175 Applicability::HasPlaceholders,
181 fn reject_placeholder_type_signatures_in_item(tcx: TyCtxt<'tcx>, item: &'tcx hir::Item<'tcx>) {
182 let (generics, suggest) = match &item.kind {
183 hir::ItemKind::Union(_, generics)
184 | hir::ItemKind::Enum(_, generics)
185 | hir::ItemKind::TraitAlias(generics, _)
186 | hir::ItemKind::Trait(_, _, generics, ..)
187 | hir::ItemKind::Impl { generics, .. }
188 | hir::ItemKind::Struct(_, generics) => (generics, true),
189 hir::ItemKind::OpaqueTy(hir::OpaqueTy { generics, .. })
190 | hir::ItemKind::TyAlias(_, generics) => (generics, false),
191 // `static`, `fn` and `const` are handled elsewhere to suggest appropriate type.
195 let mut visitor = PlaceholderHirTyCollector::default();
196 visitor.visit_item(item);
198 placeholder_type_error(tcx, generics.span, &generics.params[..], visitor.0, suggest);
201 impl Visitor<'tcx> for CollectItemTypesVisitor<'tcx> {
202 type Map = Map<'tcx>;
204 fn nested_visit_map(&mut self) -> NestedVisitorMap<'_, Self::Map> {
205 NestedVisitorMap::OnlyBodies(&self.tcx.hir())
208 fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
209 convert_item(self.tcx, item.hir_id);
210 reject_placeholder_type_signatures_in_item(self.tcx, item);
211 intravisit::walk_item(self, item);
214 fn visit_generics(&mut self, generics: &'tcx hir::Generics<'tcx>) {
215 for param in generics.params {
217 hir::GenericParamKind::Lifetime { .. } => {}
218 hir::GenericParamKind::Type { default: Some(_), .. } => {
219 let def_id = self.tcx.hir().local_def_id(param.hir_id);
220 self.tcx.type_of(def_id);
222 hir::GenericParamKind::Type { .. } => {}
223 hir::GenericParamKind::Const { .. } => {
224 let def_id = self.tcx.hir().local_def_id(param.hir_id);
225 self.tcx.type_of(def_id);
229 intravisit::walk_generics(self, generics);
232 fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
233 if let hir::ExprKind::Closure(..) = expr.kind {
234 let def_id = self.tcx.hir().local_def_id(expr.hir_id);
235 self.tcx.generics_of(def_id);
236 self.tcx.type_of(def_id);
238 intravisit::walk_expr(self, expr);
241 fn visit_trait_item(&mut self, trait_item: &'tcx hir::TraitItem<'tcx>) {
242 convert_trait_item(self.tcx, trait_item.hir_id);
243 intravisit::walk_trait_item(self, trait_item);
246 fn visit_impl_item(&mut self, impl_item: &'tcx hir::ImplItem<'tcx>) {
247 convert_impl_item(self.tcx, impl_item.hir_id);
248 intravisit::walk_impl_item(self, impl_item);
252 ///////////////////////////////////////////////////////////////////////////
253 // Utility types and common code for the above passes.
255 fn bad_placeholder_type(
257 mut spans: Vec<Span>,
258 ) -> rustc_errors::DiagnosticBuilder<'tcx> {
260 let mut err = struct_span_err!(
264 "the type placeholder `_` is not allowed within types on item signatures",
267 err.span_label(span, "not allowed in type signatures");
272 impl ItemCtxt<'tcx> {
273 pub fn new(tcx: TyCtxt<'tcx>, item_def_id: DefId) -> ItemCtxt<'tcx> {
274 ItemCtxt { tcx, item_def_id }
277 pub fn to_ty(&self, ast_ty: &'tcx hir::Ty<'tcx>) -> Ty<'tcx> {
278 AstConv::ast_ty_to_ty(self, ast_ty)
282 impl AstConv<'tcx> for ItemCtxt<'tcx> {
283 fn tcx(&self) -> TyCtxt<'tcx> {
287 fn item_def_id(&self) -> Option<DefId> {
288 Some(self.item_def_id)
291 fn get_type_parameter_bounds(&self, span: Span, def_id: DefId) -> ty::GenericPredicates<'tcx> {
292 self.tcx.at(span).type_param_predicates((self.item_def_id, def_id))
295 fn re_infer(&self, _: Option<&ty::GenericParamDef>, _: Span) -> Option<ty::Region<'tcx>> {
299 fn allow_ty_infer(&self) -> bool {
303 fn ty_infer(&self, _: Option<&ty::GenericParamDef>, span: Span) -> Ty<'tcx> {
304 self.tcx().sess.delay_span_bug(span, "bad placeholder type");
311 _: Option<&ty::GenericParamDef>,
313 ) -> &'tcx Const<'tcx> {
314 bad_placeholder_type(self.tcx(), vec![span]).emit();
316 self.tcx().consts.err
319 fn projected_ty_from_poly_trait_ref(
323 item_segment: &hir::PathSegment<'_>,
324 poly_trait_ref: ty::PolyTraitRef<'tcx>,
326 if let Some(trait_ref) = poly_trait_ref.no_bound_vars() {
327 let item_substs = <dyn AstConv<'tcx>>::create_substs_for_associated_item(
335 self.tcx().mk_projection(item_def_id, item_substs)
337 // There are no late-bound regions; we can just ignore the binder.
342 "cannot extract an associated type from a higher-ranked trait bound \
350 fn normalize_ty(&self, _span: Span, ty: Ty<'tcx>) -> Ty<'tcx> {
351 // Types in item signatures are not normalized to avoid undue dependencies.
355 fn set_tainted_by_errors(&self) {
356 // There's no obvious place to track this, so just let it go.
359 fn record_ty(&self, _hir_id: hir::HirId, _ty: Ty<'tcx>, _span: Span) {
360 // There's no place to record types from signatures?
364 /// Returns the predicates defined on `item_def_id` of the form
365 /// `X: Foo` where `X` is the type parameter `def_id`.
366 fn type_param_predicates(
368 (item_def_id, def_id): (DefId, DefId),
369 ) -> ty::GenericPredicates<'_> {
372 // In the AST, bounds can derive from two places. Either
373 // written inline like `<T: Foo>` or in a where-clause like
376 let param_id = tcx.hir().as_local_hir_id(def_id).unwrap();
377 let param_owner = tcx.hir().ty_param_owner(param_id);
378 let param_owner_def_id = tcx.hir().local_def_id(param_owner);
379 let generics = tcx.generics_of(param_owner_def_id);
380 let index = generics.param_def_id_to_index[&def_id];
381 let ty = tcx.mk_ty_param(index, tcx.hir().ty_param_name(param_id));
383 // Don't look for bounds where the type parameter isn't in scope.
385 if item_def_id == param_owner_def_id { None } else { tcx.generics_of(item_def_id).parent };
387 let mut result = parent
389 let icx = ItemCtxt::new(tcx, parent);
390 icx.get_type_parameter_bounds(DUMMY_SP, def_id)
392 .unwrap_or_default();
393 let mut extend = None;
395 let item_hir_id = tcx.hir().as_local_hir_id(item_def_id).unwrap();
396 let ast_generics = match tcx.hir().get(item_hir_id) {
397 Node::TraitItem(item) => &item.generics,
399 Node::ImplItem(item) => &item.generics,
401 Node::Item(item) => {
403 ItemKind::Fn(.., ref generics, _)
404 | ItemKind::Impl { ref generics, .. }
405 | ItemKind::TyAlias(_, ref generics)
406 | ItemKind::OpaqueTy(OpaqueTy { ref generics, impl_trait_fn: None, .. })
407 | ItemKind::Enum(_, ref generics)
408 | ItemKind::Struct(_, ref generics)
409 | ItemKind::Union(_, ref generics) => generics,
410 ItemKind::Trait(_, _, ref generics, ..) => {
411 // Implied `Self: Trait` and supertrait bounds.
412 if param_id == item_hir_id {
413 let identity_trait_ref = ty::TraitRef::identity(tcx, item_def_id);
414 extend = Some((identity_trait_ref.to_predicate(), item.span));
422 Node::ForeignItem(item) => match item.kind {
423 ForeignItemKind::Fn(_, _, ref generics) => generics,
430 let icx = ItemCtxt::new(tcx, item_def_id);
431 let extra_predicates = extend.into_iter().chain(
432 icx.type_parameter_bounds_in_generics(ast_generics, param_id, ty, OnlySelfBounds(true))
434 .filter(|(predicate, _)| match predicate {
435 ty::Predicate::Trait(ref data) => data.skip_binder().self_ty().is_param(index),
440 tcx.arena.alloc_from_iter(result.predicates.iter().copied().chain(extra_predicates));
444 impl ItemCtxt<'tcx> {
445 /// Finds bounds from `hir::Generics`. This requires scanning through the
446 /// AST. We do this to avoid having to convert *all* the bounds, which
447 /// would create artificial cycles. Instead, we can only convert the
448 /// bounds for a type parameter `X` if `X::Foo` is used.
449 fn type_parameter_bounds_in_generics(
451 ast_generics: &'tcx hir::Generics<'tcx>,
452 param_id: hir::HirId,
454 only_self_bounds: OnlySelfBounds,
455 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
456 let from_ty_params = ast_generics
459 .filter_map(|param| match param.kind {
460 GenericParamKind::Type { .. } if param.hir_id == param_id => Some(¶m.bounds),
463 .flat_map(|bounds| bounds.iter())
464 .flat_map(|b| predicates_from_bound(self, ty, b));
466 let from_where_clauses = ast_generics
470 .filter_map(|wp| match *wp {
471 hir::WherePredicate::BoundPredicate(ref bp) => Some(bp),
475 let bt = if is_param(self.tcx, &bp.bounded_ty, param_id) {
477 } else if !only_self_bounds.0 {
478 Some(self.to_ty(&bp.bounded_ty))
482 bp.bounds.iter().filter_map(move |b| bt.map(|bt| (bt, b)))
484 .flat_map(|(bt, b)| predicates_from_bound(self, bt, b));
486 from_ty_params.chain(from_where_clauses).collect()
490 /// Tests whether this is the AST for a reference to the type
491 /// parameter with ID `param_id`. We use this so as to avoid running
492 /// `ast_ty_to_ty`, because we want to avoid triggering an all-out
493 /// conversion of the type to avoid inducing unnecessary cycles.
494 fn is_param(tcx: TyCtxt<'_>, ast_ty: &hir::Ty<'_>, param_id: hir::HirId) -> bool {
495 if let hir::TyKind::Path(hir::QPath::Resolved(None, ref path)) = ast_ty.kind {
497 Res::SelfTy(Some(def_id), None) | Res::Def(DefKind::TyParam, def_id) => {
498 def_id == tcx.hir().local_def_id(param_id)
507 fn convert_item(tcx: TyCtxt<'_>, item_id: hir::HirId) {
508 let it = tcx.hir().expect_item(item_id);
509 debug!("convert: item {} with id {}", it.ident, it.hir_id);
510 let def_id = tcx.hir().local_def_id(item_id);
512 // These don't define types.
513 hir::ItemKind::ExternCrate(_)
514 | hir::ItemKind::Use(..)
515 | hir::ItemKind::Mod(_)
516 | hir::ItemKind::GlobalAsm(_) => {}
517 hir::ItemKind::ForeignMod(ref foreign_mod) => {
518 for item in foreign_mod.items {
519 let def_id = tcx.hir().local_def_id(item.hir_id);
520 tcx.generics_of(def_id);
522 tcx.predicates_of(def_id);
523 if let hir::ForeignItemKind::Fn(..) = item.kind {
528 hir::ItemKind::Enum(ref enum_definition, _) => {
529 tcx.generics_of(def_id);
531 tcx.predicates_of(def_id);
532 convert_enum_variant_types(tcx, def_id, &enum_definition.variants);
534 hir::ItemKind::Impl { .. } => {
535 tcx.generics_of(def_id);
537 tcx.impl_trait_ref(def_id);
538 tcx.predicates_of(def_id);
540 hir::ItemKind::Trait(..) => {
541 tcx.generics_of(def_id);
542 tcx.trait_def(def_id);
543 tcx.at(it.span).super_predicates_of(def_id);
544 tcx.predicates_of(def_id);
546 hir::ItemKind::TraitAlias(..) => {
547 tcx.generics_of(def_id);
548 tcx.at(it.span).super_predicates_of(def_id);
549 tcx.predicates_of(def_id);
551 hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
552 tcx.generics_of(def_id);
554 tcx.predicates_of(def_id);
556 for f in struct_def.fields() {
557 let def_id = tcx.hir().local_def_id(f.hir_id);
558 tcx.generics_of(def_id);
560 tcx.predicates_of(def_id);
563 if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
564 convert_variant_ctor(tcx, ctor_hir_id);
568 // Desugared from `impl Trait`, so visited by the function's return type.
569 hir::ItemKind::OpaqueTy(hir::OpaqueTy { impl_trait_fn: Some(_), .. }) => {}
571 hir::ItemKind::OpaqueTy(..)
572 | hir::ItemKind::TyAlias(..)
573 | hir::ItemKind::Static(..)
574 | hir::ItemKind::Const(..)
575 | hir::ItemKind::Fn(..) => {
576 tcx.generics_of(def_id);
578 tcx.predicates_of(def_id);
579 if let hir::ItemKind::Fn(..) = it.kind {
586 fn convert_trait_item(tcx: TyCtxt<'_>, trait_item_id: hir::HirId) {
587 let trait_item = tcx.hir().expect_trait_item(trait_item_id);
588 let def_id = tcx.hir().local_def_id(trait_item.hir_id);
589 tcx.generics_of(def_id);
591 match trait_item.kind {
592 hir::TraitItemKind::Const(..)
593 | hir::TraitItemKind::Type(_, Some(_))
594 | hir::TraitItemKind::Method(..) => {
596 if let hir::TraitItemKind::Method(..) = trait_item.kind {
601 hir::TraitItemKind::Type(_, None) => {}
604 tcx.predicates_of(def_id);
607 fn convert_impl_item(tcx: TyCtxt<'_>, impl_item_id: hir::HirId) {
608 let def_id = tcx.hir().local_def_id(impl_item_id);
609 tcx.generics_of(def_id);
611 tcx.predicates_of(def_id);
612 if let hir::ImplItemKind::Method(..) = tcx.hir().expect_impl_item(impl_item_id).kind {
617 fn convert_variant_ctor(tcx: TyCtxt<'_>, ctor_id: hir::HirId) {
618 let def_id = tcx.hir().local_def_id(ctor_id);
619 tcx.generics_of(def_id);
621 tcx.predicates_of(def_id);
624 fn convert_enum_variant_types(tcx: TyCtxt<'_>, def_id: DefId, variants: &[hir::Variant<'_>]) {
625 let def = tcx.adt_def(def_id);
626 let repr_type = def.repr.discr_type();
627 let initial = repr_type.initial_discriminant(tcx);
628 let mut prev_discr = None::<Discr<'_>>;
630 // fill the discriminant values and field types
631 for variant in variants {
632 let wrapped_discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
634 if let Some(ref e) = variant.disr_expr {
635 let expr_did = tcx.hir().local_def_id(e.hir_id);
636 def.eval_explicit_discr(tcx, expr_did)
637 } else if let Some(discr) = repr_type.disr_incr(tcx, prev_discr) {
640 struct_span_err!(tcx.sess, variant.span, E0370, "enum discriminant overflowed")
643 format!("overflowed on value after {}", prev_discr.unwrap()),
646 "explicitly set `{} = {}` if that is desired outcome",
647 variant.ident, wrapped_discr
652 .unwrap_or(wrapped_discr),
655 for f in variant.data.fields() {
656 let def_id = tcx.hir().local_def_id(f.hir_id);
657 tcx.generics_of(def_id);
659 tcx.predicates_of(def_id);
662 // Convert the ctor, if any. This also registers the variant as
664 if let Some(ctor_hir_id) = variant.data.ctor_hir_id() {
665 convert_variant_ctor(tcx, ctor_hir_id);
672 variant_did: Option<DefId>,
673 ctor_did: Option<DefId>,
675 discr: ty::VariantDiscr,
676 def: &hir::VariantData<'_>,
677 adt_kind: ty::AdtKind,
679 ) -> ty::VariantDef {
680 let mut seen_fields: FxHashMap<ast::Ident, Span> = Default::default();
681 let hir_id = tcx.hir().as_local_hir_id(variant_did.unwrap_or(parent_did)).unwrap();
686 let fid = tcx.hir().local_def_id(f.hir_id);
687 let dup_span = seen_fields.get(&f.ident.modern()).cloned();
688 if let Some(prev_span) = dup_span {
693 "field `{}` is already declared",
696 .span_label(f.span, "field already declared")
697 .span_label(prev_span, format!("`{}` first declared here", f.ident))
700 seen_fields.insert(f.ident.modern(), f.span);
706 vis: ty::Visibility::from_hir(&f.vis, hir_id, tcx),
710 let recovered = match def {
711 hir::VariantData::Struct(_, r) => *r,
721 CtorKind::from_hir(def),
728 fn adt_def(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::AdtDef {
731 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
732 let item = match tcx.hir().get(hir_id) {
733 Node::Item(item) => item,
737 let repr = ReprOptions::new(tcx, def_id);
738 let (kind, variants) = match item.kind {
739 ItemKind::Enum(ref def, _) => {
740 let mut distance_from_explicit = 0;
745 let variant_did = Some(tcx.hir().local_def_id(v.id));
747 v.data.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
749 let discr = if let Some(ref e) = v.disr_expr {
750 distance_from_explicit = 0;
751 ty::VariantDiscr::Explicit(tcx.hir().local_def_id(e.hir_id))
753 ty::VariantDiscr::Relative(distance_from_explicit)
755 distance_from_explicit += 1;
770 (AdtKind::Enum, variants)
772 ItemKind::Struct(ref def, _) => {
773 let variant_did = None;
774 let ctor_did = def.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
776 let variants = std::iter::once(convert_variant(
781 ty::VariantDiscr::Relative(0),
788 (AdtKind::Struct, variants)
790 ItemKind::Union(ref def, _) => {
791 let variant_did = None;
792 let ctor_did = def.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
794 let variants = std::iter::once(convert_variant(
799 ty::VariantDiscr::Relative(0),
806 (AdtKind::Union, variants)
810 tcx.alloc_adt_def(def_id, kind, variants, repr)
813 /// Ensures that the super-predicates of the trait with a `DefId`
814 /// of `trait_def_id` are converted and stored. This also ensures that
815 /// the transitive super-predicates are converted.
816 fn super_predicates_of(tcx: TyCtxt<'_>, trait_def_id: DefId) -> ty::GenericPredicates<'_> {
817 debug!("super_predicates(trait_def_id={:?})", trait_def_id);
818 let trait_hir_id = tcx.hir().as_local_hir_id(trait_def_id).unwrap();
820 let item = match tcx.hir().get(trait_hir_id) {
821 Node::Item(item) => item,
822 _ => bug!("trait_node_id {} is not an item", trait_hir_id),
825 let (generics, bounds) = match item.kind {
826 hir::ItemKind::Trait(.., ref generics, ref supertraits, _) => (generics, supertraits),
827 hir::ItemKind::TraitAlias(ref generics, ref supertraits) => (generics, supertraits),
828 _ => span_bug!(item.span, "super_predicates invoked on non-trait"),
831 let icx = ItemCtxt::new(tcx, trait_def_id);
833 // Convert the bounds that follow the colon, e.g., `Bar + Zed` in `trait Foo: Bar + Zed`.
834 let self_param_ty = tcx.types.self_param;
836 AstConv::compute_bounds(&icx, self_param_ty, bounds, SizedByDefault::No, item.span);
838 let superbounds1 = superbounds1.predicates(tcx, self_param_ty);
840 // Convert any explicit superbounds in the where-clause,
841 // e.g., `trait Foo where Self: Bar`.
842 // In the case of trait aliases, however, we include all bounds in the where-clause,
843 // so e.g., `trait Foo = where u32: PartialEq<Self>` would include `u32: PartialEq<Self>`
844 // as one of its "superpredicates".
845 let is_trait_alias = tcx.is_trait_alias(trait_def_id);
846 let superbounds2 = icx.type_parameter_bounds_in_generics(
850 OnlySelfBounds(!is_trait_alias),
853 // Combine the two lists to form the complete set of superbounds:
854 let superbounds = &*tcx.arena.alloc_from_iter(superbounds1.into_iter().chain(superbounds2));
856 // Now require that immediate supertraits are converted,
857 // which will, in turn, reach indirect supertraits.
858 for &(pred, span) in superbounds {
859 debug!("superbound: {:?}", pred);
860 if let ty::Predicate::Trait(bound) = pred {
861 tcx.at(span).super_predicates_of(bound.def_id());
865 ty::GenericPredicates { parent: None, predicates: superbounds }
868 fn trait_def(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::TraitDef {
869 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
870 let item = tcx.hir().expect_item(hir_id);
872 let (is_auto, unsafety) = match item.kind {
873 hir::ItemKind::Trait(is_auto, unsafety, ..) => (is_auto == hir::IsAuto::Yes, unsafety),
874 hir::ItemKind::TraitAlias(..) => (false, hir::Unsafety::Normal),
875 _ => span_bug!(item.span, "trait_def_of_item invoked on non-trait"),
878 let paren_sugar = tcx.has_attr(def_id, sym::rustc_paren_sugar);
879 if paren_sugar && !tcx.features().unboxed_closures {
883 "the `#[rustc_paren_sugar]` attribute is a temporary means of controlling \
884 which traits can use parenthetical notation",
886 .help("add `#![feature(unboxed_closures)]` to the crate attributes to use it")
890 let is_marker = tcx.has_attr(def_id, sym::marker);
891 let def_path_hash = tcx.def_path_hash(def_id);
892 let def = ty::TraitDef::new(def_id, unsafety, paren_sugar, is_auto, is_marker, def_path_hash);
896 fn has_late_bound_regions<'tcx>(tcx: TyCtxt<'tcx>, node: Node<'tcx>) -> Option<Span> {
897 struct LateBoundRegionsDetector<'tcx> {
899 outer_index: ty::DebruijnIndex,
900 has_late_bound_regions: Option<Span>,
903 impl Visitor<'tcx> for LateBoundRegionsDetector<'tcx> {
904 type Map = Map<'tcx>;
906 fn nested_visit_map(&mut self) -> NestedVisitorMap<'_, Self::Map> {
907 NestedVisitorMap::None
910 fn visit_ty(&mut self, ty: &'tcx hir::Ty<'tcx>) {
911 if self.has_late_bound_regions.is_some() {
915 hir::TyKind::BareFn(..) => {
916 self.outer_index.shift_in(1);
917 intravisit::walk_ty(self, ty);
918 self.outer_index.shift_out(1);
920 _ => intravisit::walk_ty(self, ty),
924 fn visit_poly_trait_ref(
926 tr: &'tcx hir::PolyTraitRef<'tcx>,
927 m: hir::TraitBoundModifier,
929 if self.has_late_bound_regions.is_some() {
932 self.outer_index.shift_in(1);
933 intravisit::walk_poly_trait_ref(self, tr, m);
934 self.outer_index.shift_out(1);
937 fn visit_lifetime(&mut self, lt: &'tcx hir::Lifetime) {
938 if self.has_late_bound_regions.is_some() {
942 match self.tcx.named_region(lt.hir_id) {
943 Some(rl::Region::Static) | Some(rl::Region::EarlyBound(..)) => {}
944 Some(rl::Region::LateBound(debruijn, _, _))
945 | Some(rl::Region::LateBoundAnon(debruijn, _))
946 if debruijn < self.outer_index => {}
947 Some(rl::Region::LateBound(..))
948 | Some(rl::Region::LateBoundAnon(..))
949 | Some(rl::Region::Free(..))
951 self.has_late_bound_regions = Some(lt.span);
957 fn has_late_bound_regions<'tcx>(
959 generics: &'tcx hir::Generics<'tcx>,
960 decl: &'tcx hir::FnDecl<'tcx>,
962 let mut visitor = LateBoundRegionsDetector {
964 outer_index: ty::INNERMOST,
965 has_late_bound_regions: None,
967 for param in generics.params {
968 if let GenericParamKind::Lifetime { .. } = param.kind {
969 if tcx.is_late_bound(param.hir_id) {
970 return Some(param.span);
974 visitor.visit_fn_decl(decl);
975 visitor.has_late_bound_regions
979 Node::TraitItem(item) => match item.kind {
980 hir::TraitItemKind::Method(ref sig, _) => {
981 has_late_bound_regions(tcx, &item.generics, &sig.decl)
985 Node::ImplItem(item) => match item.kind {
986 hir::ImplItemKind::Method(ref sig, _) => {
987 has_late_bound_regions(tcx, &item.generics, &sig.decl)
991 Node::ForeignItem(item) => match item.kind {
992 hir::ForeignItemKind::Fn(ref fn_decl, _, ref generics) => {
993 has_late_bound_regions(tcx, generics, fn_decl)
997 Node::Item(item) => match item.kind {
998 hir::ItemKind::Fn(ref sig, .., ref generics, _) => {
999 has_late_bound_regions(tcx, generics, &sig.decl)
1007 fn generics_of(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::Generics {
1010 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1012 let node = tcx.hir().get(hir_id);
1013 let parent_def_id = match node {
1015 | Node::TraitItem(_)
1018 | Node::Field(_) => {
1019 let parent_id = tcx.hir().get_parent_item(hir_id);
1020 Some(tcx.hir().local_def_id(parent_id))
1022 // FIXME(#43408) enable this always when we get lazy normalization.
1023 Node::AnonConst(_) => {
1024 // HACK(eddyb) this provides the correct generics when
1025 // `feature(const_generics)` is enabled, so that const expressions
1026 // used with const generics, e.g. `Foo<{N+1}>`, can work at all.
1027 if tcx.features().const_generics {
1028 let parent_id = tcx.hir().get_parent_item(hir_id);
1029 Some(tcx.hir().local_def_id(parent_id))
1034 Node::Expr(&hir::Expr { kind: hir::ExprKind::Closure(..), .. }) => {
1035 Some(tcx.closure_base_def_id(def_id))
1037 Node::Item(item) => match item.kind {
1038 ItemKind::OpaqueTy(hir::OpaqueTy { impl_trait_fn, .. }) => impl_trait_fn,
1044 let mut opt_self = None;
1045 let mut allow_defaults = false;
1047 let no_generics = hir::Generics::empty();
1048 let ast_generics = match node {
1049 Node::TraitItem(item) => &item.generics,
1051 Node::ImplItem(item) => &item.generics,
1053 Node::Item(item) => {
1055 ItemKind::Fn(.., ref generics, _) | ItemKind::Impl { ref generics, .. } => generics,
1057 ItemKind::TyAlias(_, ref generics)
1058 | ItemKind::Enum(_, ref generics)
1059 | ItemKind::Struct(_, ref generics)
1060 | ItemKind::OpaqueTy(hir::OpaqueTy { ref generics, .. })
1061 | ItemKind::Union(_, ref generics) => {
1062 allow_defaults = true;
1066 ItemKind::Trait(_, _, ref generics, ..)
1067 | ItemKind::TraitAlias(ref generics, ..) => {
1068 // Add in the self type parameter.
1070 // Something of a hack: use the node id for the trait, also as
1071 // the node id for the Self type parameter.
1072 let param_id = item.hir_id;
1074 opt_self = Some(ty::GenericParamDef {
1076 name: kw::SelfUpper,
1077 def_id: tcx.hir().local_def_id(param_id),
1078 pure_wrt_drop: false,
1079 kind: ty::GenericParamDefKind::Type {
1081 object_lifetime_default: rl::Set1::Empty,
1086 allow_defaults = true;
1094 Node::ForeignItem(item) => match item.kind {
1095 ForeignItemKind::Static(..) => &no_generics,
1096 ForeignItemKind::Fn(_, _, ref generics) => generics,
1097 ForeignItemKind::Type => &no_generics,
1103 let has_self = opt_self.is_some();
1104 let mut parent_has_self = false;
1105 let mut own_start = has_self as u32;
1106 let parent_count = parent_def_id.map_or(0, |def_id| {
1107 let generics = tcx.generics_of(def_id);
1108 assert_eq!(has_self, false);
1109 parent_has_self = generics.has_self;
1110 own_start = generics.count() as u32;
1111 generics.parent_count + generics.params.len()
1114 let mut params: Vec<_> = opt_self.into_iter().collect();
1116 let early_lifetimes = early_bound_lifetimes_from_generics(tcx, ast_generics);
1117 params.extend(early_lifetimes.enumerate().map(|(i, param)| ty::GenericParamDef {
1118 name: param.name.ident().name,
1119 index: own_start + i as u32,
1120 def_id: tcx.hir().local_def_id(param.hir_id),
1121 pure_wrt_drop: param.pure_wrt_drop,
1122 kind: ty::GenericParamDefKind::Lifetime,
1125 let object_lifetime_defaults = tcx.object_lifetime_defaults(hir_id);
1127 // Now create the real type parameters.
1128 let type_start = own_start - has_self as u32 + params.len() as u32;
1130 params.extend(ast_generics.params.iter().filter_map(|param| {
1131 let kind = match param.kind {
1132 GenericParamKind::Type { ref default, synthetic, .. } => {
1133 if !allow_defaults && default.is_some() {
1134 if !tcx.features().default_type_parameter_fallback {
1136 lint::builtin::INVALID_TYPE_PARAM_DEFAULT,
1140 "defaults for type parameters are only allowed in \
1141 `struct`, `enum`, `type`, or `trait` definitions."
1147 ty::GenericParamDefKind::Type {
1148 has_default: default.is_some(),
1149 object_lifetime_default: object_lifetime_defaults
1151 .map_or(rl::Set1::Empty, |o| o[i]),
1155 GenericParamKind::Const { .. } => ty::GenericParamDefKind::Const,
1159 let param_def = ty::GenericParamDef {
1160 index: type_start + i as u32,
1161 name: param.name.ident().name,
1162 def_id: tcx.hir().local_def_id(param.hir_id),
1163 pure_wrt_drop: param.pure_wrt_drop,
1170 // provide junk type parameter defs - the only place that
1171 // cares about anything but the length is instantiation,
1172 // and we don't do that for closures.
1173 if let Node::Expr(&hir::Expr { kind: hir::ExprKind::Closure(.., gen), .. }) = node {
1174 let dummy_args = if gen.is_some() {
1175 &["<yield_ty>", "<return_ty>", "<witness>"][..]
1177 &["<closure_kind>", "<closure_signature>"][..]
1180 params.extend(dummy_args.iter().enumerate().map(|(i, &arg)| ty::GenericParamDef {
1181 index: type_start + i as u32,
1182 name: Symbol::intern(arg),
1184 pure_wrt_drop: false,
1185 kind: ty::GenericParamDefKind::Type {
1187 object_lifetime_default: rl::Set1::Empty,
1192 if let Some(upvars) = tcx.upvars(def_id) {
1193 params.extend(upvars.iter().zip((dummy_args.len() as u32)..).map(|(_, i)| {
1194 ty::GenericParamDef {
1195 index: type_start + i,
1196 name: Symbol::intern("<upvar>"),
1198 pure_wrt_drop: false,
1199 kind: ty::GenericParamDefKind::Type {
1201 object_lifetime_default: rl::Set1::Empty,
1209 let param_def_id_to_index = params.iter().map(|param| (param.def_id, param.index)).collect();
1211 tcx.arena.alloc(ty::Generics {
1212 parent: parent_def_id,
1215 param_def_id_to_index,
1216 has_self: has_self || parent_has_self,
1217 has_late_bound_regions: has_late_bound_regions(tcx, node),
1221 fn report_assoc_ty_on_inherent_impl(tcx: TyCtxt<'_>, span: Span) {
1226 "associated types are not yet supported in inherent impls (see #8995)"
1231 fn infer_placeholder_type(
1234 body_id: hir::BodyId,
1238 let ty = tcx.diagnostic_only_typeck_tables_of(def_id).node_type(body_id.hir_id);
1240 // If this came from a free `const` or `static mut?` item,
1241 // then the user may have written e.g. `const A = 42;`.
1242 // In this case, the parser has stashed a diagnostic for
1243 // us to improve in typeck so we do that now.
1244 match tcx.sess.diagnostic().steal_diagnostic(span, StashKey::ItemNoType) {
1246 // The parser provided a sub-optimal `HasPlaceholders` suggestion for the type.
1247 // We are typeck and have the real type, so remove that and suggest the actual type.
1248 err.suggestions.clear();
1249 err.span_suggestion(
1251 "provide a type for the item",
1252 format!("{}: {}", item_ident, ty),
1253 Applicability::MachineApplicable,
1258 let mut diag = bad_placeholder_type(tcx, vec![span]);
1259 if ty != tcx.types.err {
1260 diag.span_suggestion(
1262 "replace `_` with the correct type",
1264 Applicability::MaybeIncorrect,
1274 fn type_of(tcx: TyCtxt<'_>, def_id: DefId) -> Ty<'_> {
1277 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1279 let icx = ItemCtxt::new(tcx, def_id);
1281 match tcx.hir().get(hir_id) {
1282 Node::TraitItem(item) => match item.kind {
1283 TraitItemKind::Method(..) => {
1284 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1285 tcx.mk_fn_def(def_id, substs)
1287 TraitItemKind::Const(ref ty, body_id) => body_id
1288 .and_then(|body_id| {
1289 if is_suggestable_infer_ty(ty) {
1290 Some(infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident))
1295 .unwrap_or_else(|| icx.to_ty(ty)),
1296 TraitItemKind::Type(_, Some(ref ty)) => icx.to_ty(ty),
1297 TraitItemKind::Type(_, None) => {
1298 span_bug!(item.span, "associated type missing default");
1302 Node::ImplItem(item) => match item.kind {
1303 ImplItemKind::Method(..) => {
1304 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1305 tcx.mk_fn_def(def_id, substs)
1307 ImplItemKind::Const(ref ty, body_id) => {
1308 if is_suggestable_infer_ty(ty) {
1309 infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident)
1314 ImplItemKind::OpaqueTy(_) => {
1315 if tcx.impl_trait_ref(tcx.hir().get_parent_did(hir_id)).is_none() {
1316 report_assoc_ty_on_inherent_impl(tcx, item.span);
1319 find_opaque_ty_constraints(tcx, def_id)
1321 ImplItemKind::TyAlias(ref ty) => {
1322 if tcx.impl_trait_ref(tcx.hir().get_parent_did(hir_id)).is_none() {
1323 report_assoc_ty_on_inherent_impl(tcx, item.span);
1330 Node::Item(item) => {
1332 ItemKind::Static(ref ty, .., body_id) | ItemKind::Const(ref ty, body_id) => {
1333 if is_suggestable_infer_ty(ty) {
1334 infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident)
1339 ItemKind::TyAlias(ref self_ty, _) | ItemKind::Impl { ref self_ty, .. } => {
1342 ItemKind::Fn(..) => {
1343 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1344 tcx.mk_fn_def(def_id, substs)
1346 ItemKind::Enum(..) | ItemKind::Struct(..) | ItemKind::Union(..) => {
1347 let def = tcx.adt_def(def_id);
1348 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1349 tcx.mk_adt(def, substs)
1351 ItemKind::OpaqueTy(hir::OpaqueTy { impl_trait_fn: None, .. }) => {
1352 find_opaque_ty_constraints(tcx, def_id)
1354 // Opaque types desugared from `impl Trait`.
1355 ItemKind::OpaqueTy(hir::OpaqueTy { impl_trait_fn: Some(owner), .. }) => {
1356 tcx.typeck_tables_of(owner)
1357 .concrete_opaque_types
1359 .map(|opaque| opaque.concrete_type)
1360 .unwrap_or_else(|| {
1361 // This can occur if some error in the
1362 // owner fn prevented us from populating
1363 // the `concrete_opaque_types` table.
1364 tcx.sess.delay_span_bug(
1367 "owner {:?} has no opaque type for {:?} in its tables",
1375 | ItemKind::TraitAlias(..)
1377 | ItemKind::ForeignMod(..)
1378 | ItemKind::GlobalAsm(..)
1379 | ItemKind::ExternCrate(..)
1380 | ItemKind::Use(..) => {
1383 "compute_type_of_item: unexpected item type: {:?}",
1390 Node::ForeignItem(foreign_item) => match foreign_item.kind {
1391 ForeignItemKind::Fn(..) => {
1392 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1393 tcx.mk_fn_def(def_id, substs)
1395 ForeignItemKind::Static(ref t, _) => icx.to_ty(t),
1396 ForeignItemKind::Type => tcx.mk_foreign(def_id),
1399 Node::Ctor(&ref def) | Node::Variant(hir::Variant { data: ref def, .. }) => match *def {
1400 VariantData::Unit(..) | VariantData::Struct(..) => {
1401 tcx.type_of(tcx.hir().get_parent_did(hir_id))
1403 VariantData::Tuple(..) => {
1404 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1405 tcx.mk_fn_def(def_id, substs)
1409 Node::Field(field) => icx.to_ty(&field.ty),
1411 Node::Expr(&hir::Expr { kind: hir::ExprKind::Closure(.., gen), .. }) => {
1413 return tcx.typeck_tables_of(def_id).node_type(hir_id);
1416 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1417 tcx.mk_closure(def_id, substs)
1420 Node::AnonConst(_) => {
1421 let parent_node = tcx.hir().get(tcx.hir().get_parent_node(hir_id));
1423 Node::Ty(&hir::Ty { kind: hir::TyKind::Array(_, ref constant), .. })
1424 | Node::Ty(&hir::Ty { kind: hir::TyKind::Typeof(ref constant), .. })
1425 | Node::Expr(&hir::Expr { kind: ExprKind::Repeat(_, ref constant), .. })
1426 if constant.hir_id == hir_id =>
1431 Node::Variant(Variant { disr_expr: Some(ref e), .. }) if e.hir_id == hir_id => {
1432 tcx.adt_def(tcx.hir().get_parent_did(hir_id)).repr.discr_type().to_ty(tcx)
1435 Node::Ty(&hir::Ty { kind: hir::TyKind::Path(_), .. })
1436 | Node::Expr(&hir::Expr { kind: ExprKind::Struct(..), .. })
1437 | Node::Expr(&hir::Expr { kind: ExprKind::Path(_), .. })
1438 | Node::TraitRef(..) => {
1439 let path = match parent_node {
1441 kind: hir::TyKind::Path(QPath::Resolved(_, ref path)),
1444 | Node::Expr(&hir::Expr {
1445 kind: ExprKind::Path(QPath::Resolved(_, ref path)),
1447 }) => Some(&**path),
1448 Node::Expr(&hir::Expr { kind: ExprKind::Struct(ref path, ..), .. }) => {
1449 if let QPath::Resolved(_, ref path) = **path {
1455 Node::TraitRef(&hir::TraitRef { ref path, .. }) => Some(&**path),
1459 if let Some(path) = path {
1460 let arg_index = path
1463 .filter_map(|seg| seg.args.as_ref())
1464 .map(|generic_args| generic_args.args.as_ref())
1467 .filter(|arg| arg.is_const())
1469 .filter(|(_, arg)| arg.id() == hir_id)
1470 .map(|(index, _)| index)
1473 .unwrap_or_else(|| {
1474 bug!("no arg matching AnonConst in path");
1477 // We've encountered an `AnonConst` in some path, so we need to
1478 // figure out which generic parameter it corresponds to and return
1479 // the relevant type.
1480 let generics = match path.res {
1481 Res::Def(DefKind::Ctor(..), def_id) => {
1482 tcx.generics_of(tcx.parent(def_id).unwrap())
1484 Res::Def(_, def_id) => tcx.generics_of(def_id),
1485 Res::Err => return tcx.types.err,
1487 tcx.sess.delay_span_bug(
1489 &format!("unexpected const parent path def {:?}", res,),
1491 return tcx.types.err;
1499 if let ty::GenericParamDefKind::Const = param.kind {
1506 .map(|param| tcx.type_of(param.def_id))
1507 // This is no generic parameter associated with the arg. This is
1508 // probably from an extra arg where one is not needed.
1509 .unwrap_or(tcx.types.err)
1511 tcx.sess.delay_span_bug(
1513 &format!("unexpected const parent path {:?}", parent_node,),
1515 return tcx.types.err;
1520 tcx.sess.delay_span_bug(
1522 &format!("unexpected const parent in type_of_def_id(): {:?}", x),
1529 Node::GenericParam(param) => match ¶m.kind {
1530 hir::GenericParamKind::Type { default: Some(ref ty), .. } => icx.to_ty(ty),
1531 hir::GenericParamKind::Const { ty: ref hir_ty, .. } => {
1532 let ty = icx.to_ty(hir_ty);
1533 if !tcx.features().const_compare_raw_pointers {
1534 let err = match ty.peel_refs().kind {
1535 ty::FnPtr(_) => Some("function pointers"),
1536 ty::RawPtr(_) => Some("raw pointers"),
1539 if let Some(unsupported_type) = err {
1541 &tcx.sess.parse_sess,
1542 sym::const_compare_raw_pointers,
1545 "using {} as const generic parameters is unstable",
1552 if traits::search_for_structural_match_violation(param.hir_id, param.span, tcx, ty)
1559 "the types of const generic parameters must derive `PartialEq` and `Eq`",
1563 format!("`{}` doesn't derive both `PartialEq` and `Eq`", ty),
1569 x => bug!("unexpected non-type Node::GenericParam: {:?}", x),
1573 bug!("unexpected sort of node in type_of_def_id(): {:?}", x);
1578 fn find_opaque_ty_constraints(tcx: TyCtxt<'_>, def_id: DefId) -> Ty<'_> {
1579 use rustc_hir::{ImplItem, Item, TraitItem};
1581 debug!("find_opaque_ty_constraints({:?})", def_id);
1583 struct ConstraintLocator<'tcx> {
1586 // (first found type span, actual type, mapping from the opaque type's generic
1587 // parameters to the concrete type's generic parameters)
1589 // The mapping is an index for each use site of a generic parameter in the concrete type
1591 // The indices index into the generic parameters on the opaque type.
1592 found: Option<(Span, Ty<'tcx>, Vec<usize>)>,
1595 impl ConstraintLocator<'tcx> {
1596 fn check(&mut self, def_id: DefId) {
1597 // Don't try to check items that cannot possibly constrain the type.
1598 if !self.tcx.has_typeck_tables(def_id) {
1600 "find_opaque_ty_constraints: no constraint for `{:?}` at `{:?}`: no tables",
1601 self.def_id, def_id,
1605 let ty = self.tcx.typeck_tables_of(def_id).concrete_opaque_types.get(&self.def_id);
1606 if let Some(ty::ResolvedOpaqueTy { concrete_type, substs }) = ty {
1608 "find_opaque_ty_constraints: found constraint for `{:?}` at `{:?}`: {:?}",
1609 self.def_id, def_id, ty,
1612 // FIXME(oli-obk): trace the actual span from inference to improve errors.
1613 let span = self.tcx.def_span(def_id);
1614 // used to quickly look up the position of a generic parameter
1615 let mut index_map: FxHashMap<ty::ParamTy, usize> = FxHashMap::default();
1616 // Skipping binder is ok, since we only use this to find generic parameters and
1618 for (idx, subst) in substs.iter().enumerate() {
1619 if let GenericArgKind::Type(ty) = subst.unpack() {
1620 if let ty::Param(p) = ty.kind {
1621 if index_map.insert(p, idx).is_some() {
1622 // There was already an entry for `p`, meaning a generic parameter
1624 self.tcx.sess.span_err(
1627 "defining opaque type use restricts opaque \
1628 type by using the generic parameter `{}` twice",
1635 self.tcx.sess.delay_span_bug(
1638 "non-defining opaque ty use in defining scope: {:?}, {:?}",
1639 concrete_type, substs,
1645 // Compute the index within the opaque type for each generic parameter used in
1646 // the concrete type.
1647 let indices = concrete_type
1648 .subst(self.tcx, substs)
1650 .filter_map(|t| match &t.kind {
1651 ty::Param(p) => Some(*index_map.get(p).unwrap()),
1655 let is_param = |ty: Ty<'_>| match ty.kind {
1656 ty::Param(_) => true,
1659 let bad_substs: Vec<_> =
1660 substs.types().enumerate().filter(|(_, ty)| !is_param(ty)).collect();
1661 if !bad_substs.is_empty() {
1662 let identity_substs = InternalSubsts::identity_for_item(self.tcx, self.def_id);
1663 for (i, bad_subst) in bad_substs {
1664 self.tcx.sess.span_err(
1667 "defining opaque type use does not fully define opaque type: \
1668 generic parameter `{}` is specified as concrete type `{}`",
1669 identity_substs.type_at(i),
1674 } else if let Some((prev_span, prev_ty, ref prev_indices)) = self.found {
1675 let mut ty = concrete_type.walk().fuse();
1676 let mut p_ty = prev_ty.walk().fuse();
1677 let iter_eq = (&mut ty).zip(&mut p_ty).all(|(t, p)| match (&t.kind, &p.kind) {
1678 // Type parameters are equal to any other type parameter for the purpose of
1679 // concrete type equality, as it is possible to obtain the same type just
1680 // by passing matching parameters to a function.
1681 (ty::Param(_), ty::Param(_)) => true,
1684 if !iter_eq || ty.next().is_some() || p_ty.next().is_some() {
1685 debug!("find_opaque_ty_constraints: span={:?}", span);
1686 // Found different concrete types for the opaque type.
1687 let mut err = self.tcx.sess.struct_span_err(
1689 "concrete type differs from previous defining opaque type use",
1693 format!("expected `{}`, got `{}`", prev_ty, concrete_type),
1695 err.span_note(prev_span, "previous use here");
1697 } else if indices != *prev_indices {
1698 // Found "same" concrete types, but the generic parameter order differs.
1699 let mut err = self.tcx.sess.struct_span_err(
1701 "concrete type's generic parameters differ from previous defining use",
1703 use std::fmt::Write;
1704 let mut s = String::new();
1705 write!(s, "expected [").unwrap();
1706 let list = |s: &mut String, indices: &Vec<usize>| {
1707 let mut indices = indices.iter().cloned();
1708 if let Some(first) = indices.next() {
1709 write!(s, "`{}`", substs[first]).unwrap();
1711 write!(s, ", `{}`", substs[i]).unwrap();
1715 list(&mut s, prev_indices);
1716 write!(s, "], got [").unwrap();
1717 list(&mut s, &indices);
1718 write!(s, "]").unwrap();
1719 err.span_label(span, s);
1720 err.span_note(prev_span, "previous use here");
1724 self.found = Some((span, concrete_type, indices));
1728 "find_opaque_ty_constraints: no constraint for `{:?}` at `{:?}`",
1729 self.def_id, def_id,
1735 impl<'tcx> intravisit::Visitor<'tcx> for ConstraintLocator<'tcx> {
1736 type Map = Map<'tcx>;
1738 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<'_, Self::Map> {
1739 intravisit::NestedVisitorMap::All(&self.tcx.hir())
1741 fn visit_item(&mut self, it: &'tcx Item<'tcx>) {
1742 debug!("find_existential_constraints: visiting {:?}", it);
1743 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1744 // The opaque type itself or its children are not within its reveal scope.
1745 if def_id != self.def_id {
1747 intravisit::walk_item(self, it);
1750 fn visit_impl_item(&mut self, it: &'tcx ImplItem<'tcx>) {
1751 debug!("find_existential_constraints: visiting {:?}", it);
1752 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1753 // The opaque type itself or its children are not within its reveal scope.
1754 if def_id != self.def_id {
1756 intravisit::walk_impl_item(self, it);
1759 fn visit_trait_item(&mut self, it: &'tcx TraitItem<'tcx>) {
1760 debug!("find_existential_constraints: visiting {:?}", it);
1761 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1763 intravisit::walk_trait_item(self, it);
1767 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1768 let scope = tcx.hir().get_defining_scope(hir_id);
1769 let mut locator = ConstraintLocator { def_id, tcx, found: None };
1771 debug!("find_opaque_ty_constraints: scope={:?}", scope);
1773 if scope == hir::CRATE_HIR_ID {
1774 intravisit::walk_crate(&mut locator, tcx.hir().krate());
1776 debug!("find_opaque_ty_constraints: scope={:?}", tcx.hir().get(scope));
1777 match tcx.hir().get(scope) {
1778 // We explicitly call `visit_*` methods, instead of using `intravisit::walk_*` methods
1779 // This allows our visitor to process the defining item itself, causing
1780 // it to pick up any 'sibling' defining uses.
1782 // For example, this code:
1785 // type Blah = impl Debug;
1786 // let my_closure = || -> Blah { true };
1790 // requires us to explicitly process `foo()` in order
1791 // to notice the defining usage of `Blah`.
1792 Node::Item(ref it) => locator.visit_item(it),
1793 Node::ImplItem(ref it) => locator.visit_impl_item(it),
1794 Node::TraitItem(ref it) => locator.visit_trait_item(it),
1795 other => bug!("{:?} is not a valid scope for an opaque type item", other),
1799 match locator.found {
1800 Some((_, ty, _)) => ty,
1802 let span = tcx.def_span(def_id);
1803 tcx.sess.span_err(span, "could not find defining uses");
1809 fn are_suggestable_generic_args(generic_args: &[hir::GenericArg<'_>]) -> bool {
1812 .filter_map(|arg| match arg {
1813 hir::GenericArg::Type(ty) => Some(ty),
1816 .any(is_suggestable_infer_ty)
1819 /// Whether `ty` is a type with `_` placeholders that can be infered. Used in diagnostics only to
1820 /// use inference to provide suggestions for the appropriate type if possible.
1821 fn is_suggestable_infer_ty(ty: &hir::Ty<'_>) -> bool {
1825 Slice(ty) | Array(ty, _) => is_suggestable_infer_ty(ty),
1826 Tup(tys) => tys.iter().any(is_suggestable_infer_ty),
1827 Ptr(mut_ty) | Rptr(_, mut_ty) => is_suggestable_infer_ty(mut_ty.ty),
1828 Def(_, generic_args) => are_suggestable_generic_args(generic_args),
1829 Path(hir::QPath::TypeRelative(ty, segment)) => {
1830 is_suggestable_infer_ty(ty) || are_suggestable_generic_args(segment.generic_args().args)
1832 Path(hir::QPath::Resolved(ty_opt, hir::Path { segments, .. })) => {
1833 ty_opt.map_or(false, is_suggestable_infer_ty)
1836 .any(|segment| are_suggestable_generic_args(segment.generic_args().args))
1842 pub fn get_infer_ret_ty(output: &'hir hir::FunctionRetTy<'hir>) -> Option<&'hir hir::Ty<'hir>> {
1843 if let hir::FunctionRetTy::Return(ref ty) = output {
1844 if is_suggestable_infer_ty(ty) {
1851 fn fn_sig(tcx: TyCtxt<'_>, def_id: DefId) -> ty::PolyFnSig<'_> {
1852 use rustc_hir::Node::*;
1855 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1857 let icx = ItemCtxt::new(tcx, def_id);
1859 match tcx.hir().get(hir_id) {
1860 TraitItem(hir::TraitItem {
1861 kind: TraitItemKind::Method(sig, TraitMethod::Provided(_)),
1866 | ImplItem(hir::ImplItem { kind: ImplItemKind::Method(sig, _), ident, generics, .. })
1867 | Item(hir::Item { kind: ItemKind::Fn(sig, generics, _), ident, .. }) => {
1868 match get_infer_ret_ty(&sig.decl.output) {
1870 let fn_sig = tcx.typeck_tables_of(def_id).liberated_fn_sigs()[hir_id];
1871 let mut visitor = PlaceholderHirTyCollector::default();
1872 visitor.visit_ty(ty);
1873 let mut diag = bad_placeholder_type(tcx, visitor.0);
1874 let ret_ty = fn_sig.output();
1875 if ret_ty != tcx.types.err {
1876 diag.span_suggestion(
1878 "replace with the correct return type",
1880 Applicability::MaybeIncorrect,
1884 ty::Binder::bind(fn_sig)
1886 None => AstConv::ty_of_fn(
1888 sig.header.unsafety,
1891 &generics.params[..],
1897 TraitItem(hir::TraitItem {
1898 kind: TraitItemKind::Method(FnSig { header, decl }, _),
1902 }) => AstConv::ty_of_fn(
1907 &generics.params[..],
1911 ForeignItem(&hir::ForeignItem { kind: ForeignItemKind::Fn(ref fn_decl, _, _), .. }) => {
1912 let abi = tcx.hir().get_foreign_abi(hir_id);
1913 compute_sig_of_foreign_fn_decl(tcx, def_id, fn_decl, abi)
1916 Ctor(data) | Variant(hir::Variant { data, .. }) if data.ctor_hir_id().is_some() => {
1917 let ty = tcx.type_of(tcx.hir().get_parent_did(hir_id));
1919 data.fields().iter().map(|f| tcx.type_of(tcx.hir().local_def_id(f.hir_id)));
1920 ty::Binder::bind(tcx.mk_fn_sig(
1924 hir::Unsafety::Normal,
1929 Expr(&hir::Expr { kind: hir::ExprKind::Closure(..), .. }) => {
1930 // Closure signatures are not like other function
1931 // signatures and cannot be accessed through `fn_sig`. For
1932 // example, a closure signature excludes the `self`
1933 // argument. In any case they are embedded within the
1934 // closure type as part of the `ClosureSubsts`.
1937 // the signature of a closure, you should use the
1938 // `closure_sig` method on the `ClosureSubsts`:
1940 // closure_substs.sig(def_id, tcx)
1942 // or, inside of an inference context, you can use
1944 // infcx.closure_sig(def_id, closure_substs)
1945 bug!("to get the signature of a closure, use `closure_sig()` not `fn_sig()`");
1949 bug!("unexpected sort of node in fn_sig(): {:?}", x);
1954 fn impl_trait_ref(tcx: TyCtxt<'_>, def_id: DefId) -> Option<ty::TraitRef<'_>> {
1955 let icx = ItemCtxt::new(tcx, def_id);
1957 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1958 match tcx.hir().expect_item(hir_id).kind {
1959 hir::ItemKind::Impl { ref of_trait, .. } => of_trait.as_ref().map(|ast_trait_ref| {
1960 let selfty = tcx.type_of(def_id);
1961 AstConv::instantiate_mono_trait_ref(&icx, ast_trait_ref, selfty)
1967 fn impl_polarity(tcx: TyCtxt<'_>, def_id: DefId) -> ty::ImplPolarity {
1968 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1969 let is_rustc_reservation = tcx.has_attr(def_id, sym::rustc_reservation_impl);
1970 let item = tcx.hir().expect_item(hir_id);
1972 hir::ItemKind::Impl { polarity: hir::ImplPolarity::Negative, .. } => {
1973 if is_rustc_reservation {
1974 tcx.sess.span_err(item.span, "reservation impls can't be negative");
1976 ty::ImplPolarity::Negative
1978 hir::ItemKind::Impl { polarity: hir::ImplPolarity::Positive, of_trait: None, .. } => {
1979 if is_rustc_reservation {
1980 tcx.sess.span_err(item.span, "reservation impls can't be inherent");
1982 ty::ImplPolarity::Positive
1984 hir::ItemKind::Impl {
1985 polarity: hir::ImplPolarity::Positive, of_trait: Some(_), ..
1987 if is_rustc_reservation {
1988 ty::ImplPolarity::Reservation
1990 ty::ImplPolarity::Positive
1993 ref item => bug!("impl_polarity: {:?} not an impl", item),
1997 /// Returns the early-bound lifetimes declared in this generics
1998 /// listing. For anything other than fns/methods, this is just all
1999 /// the lifetimes that are declared. For fns or methods, we have to
2000 /// screen out those that do not appear in any where-clauses etc using
2001 /// `resolve_lifetime::early_bound_lifetimes`.
2002 fn early_bound_lifetimes_from_generics<'a, 'tcx: 'a>(
2004 generics: &'a hir::Generics<'a>,
2005 ) -> impl Iterator<Item = &'a hir::GenericParam<'a>> + Captures<'tcx> {
2006 generics.params.iter().filter(move |param| match param.kind {
2007 GenericParamKind::Lifetime { .. } => !tcx.is_late_bound(param.hir_id),
2012 /// Returns a list of type predicates for the definition with ID `def_id`, including inferred
2013 /// lifetime constraints. This includes all predicates returned by `explicit_predicates_of`, plus
2014 /// inferred constraints concerning which regions outlive other regions.
2015 fn predicates_defined_on(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2016 debug!("predicates_defined_on({:?})", def_id);
2017 let mut result = tcx.explicit_predicates_of(def_id);
2018 debug!("predicates_defined_on: explicit_predicates_of({:?}) = {:?}", def_id, result,);
2019 let inferred_outlives = tcx.inferred_outlives_of(def_id);
2020 if !inferred_outlives.is_empty() {
2022 "predicates_defined_on: inferred_outlives_of({:?}) = {:?}",
2023 def_id, inferred_outlives,
2025 if result.predicates.is_empty() {
2026 result.predicates = inferred_outlives;
2028 result.predicates = tcx
2030 .alloc_from_iter(result.predicates.iter().chain(inferred_outlives).copied());
2033 debug!("predicates_defined_on({:?}) = {:?}", def_id, result);
2037 /// Returns a list of all type predicates (explicit and implicit) for the definition with
2038 /// ID `def_id`. This includes all predicates returned by `predicates_defined_on`, plus
2039 /// `Self: Trait` predicates for traits.
2040 fn predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2041 let mut result = tcx.predicates_defined_on(def_id);
2043 if tcx.is_trait(def_id) {
2044 // For traits, add `Self: Trait` predicate. This is
2045 // not part of the predicates that a user writes, but it
2046 // is something that one must prove in order to invoke a
2047 // method or project an associated type.
2049 // In the chalk setup, this predicate is not part of the
2050 // "predicates" for a trait item. But it is useful in
2051 // rustc because if you directly (e.g.) invoke a trait
2052 // method like `Trait::method(...)`, you must naturally
2053 // prove that the trait applies to the types that were
2054 // used, and adding the predicate into this list ensures
2055 // that this is done.
2056 let span = tcx.def_span(def_id);
2058 tcx.arena.alloc_from_iter(result.predicates.iter().copied().chain(std::iter::once((
2059 ty::TraitRef::identity(tcx, def_id).to_predicate(),
2063 debug!("predicates_of(def_id={:?}) = {:?}", def_id, result);
2067 /// Returns a list of user-specified type predicates for the definition with ID `def_id`.
2068 /// N.B., this does not include any implied/inferred constraints.
2069 fn explicit_predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2070 use rustc_data_structures::fx::FxHashSet;
2073 debug!("explicit_predicates_of(def_id={:?})", def_id);
2075 /// A data structure with unique elements, which preserves order of insertion.
2076 /// Preserving the order of insertion is important here so as not to break
2077 /// compile-fail UI tests.
2078 // FIXME(eddyb) just use `IndexSet` from `indexmap`.
2079 struct UniquePredicates<'tcx> {
2080 predicates: Vec<(ty::Predicate<'tcx>, Span)>,
2081 uniques: FxHashSet<(ty::Predicate<'tcx>, Span)>,
2084 impl<'tcx> UniquePredicates<'tcx> {
2086 UniquePredicates { predicates: vec![], uniques: FxHashSet::default() }
2089 fn push(&mut self, value: (ty::Predicate<'tcx>, Span)) {
2090 if self.uniques.insert(value) {
2091 self.predicates.push(value);
2095 fn extend<I: IntoIterator<Item = (ty::Predicate<'tcx>, Span)>>(&mut self, iter: I) {
2102 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
2103 let node = tcx.hir().get(hir_id);
2105 let mut is_trait = None;
2106 let mut is_default_impl_trait = None;
2108 let icx = ItemCtxt::new(tcx, def_id);
2110 const NO_GENERICS: &hir::Generics<'_> = &hir::Generics::empty();
2112 let mut predicates = UniquePredicates::new();
2114 let ast_generics = match node {
2115 Node::TraitItem(item) => &item.generics,
2117 Node::ImplItem(item) => match item.kind {
2118 ImplItemKind::OpaqueTy(ref bounds) => {
2119 ty::print::with_no_queries(|| {
2120 let substs = InternalSubsts::identity_for_item(tcx, def_id);
2121 let opaque_ty = tcx.mk_opaque(def_id, substs);
2123 "explicit_predicates_of({:?}): created opaque type {:?}",
2127 // Collect the bounds, i.e., the `A + B + 'c` in `impl A + B + 'c`.
2128 let bounds = AstConv::compute_bounds(
2132 SizedByDefault::Yes,
2133 tcx.def_span(def_id),
2136 predicates.extend(bounds.predicates(tcx, opaque_ty));
2140 _ => &item.generics,
2143 Node::Item(item) => {
2145 ItemKind::Impl { defaultness, ref generics, .. } => {
2146 if defaultness.is_default() {
2147 is_default_impl_trait = tcx.impl_trait_ref(def_id);
2151 ItemKind::Fn(.., ref generics, _)
2152 | ItemKind::TyAlias(_, ref generics)
2153 | ItemKind::Enum(_, ref generics)
2154 | ItemKind::Struct(_, ref generics)
2155 | ItemKind::Union(_, ref generics) => generics,
2157 ItemKind::Trait(_, _, ref generics, .., items) => {
2158 is_trait = Some((ty::TraitRef::identity(tcx, def_id), items));
2161 ItemKind::TraitAlias(ref generics, _) => {
2162 is_trait = Some((ty::TraitRef::identity(tcx, def_id), &[]));
2165 ItemKind::OpaqueTy(OpaqueTy {
2171 let bounds_predicates = ty::print::with_no_queries(|| {
2172 let substs = InternalSubsts::identity_for_item(tcx, def_id);
2173 let opaque_ty = tcx.mk_opaque(def_id, substs);
2175 // Collect the bounds, i.e., the `A + B + 'c` in `impl A + B + 'c`.
2176 let bounds = AstConv::compute_bounds(
2180 SizedByDefault::Yes,
2181 tcx.def_span(def_id),
2184 bounds.predicates(tcx, opaque_ty)
2186 if impl_trait_fn.is_some() {
2188 return ty::GenericPredicates {
2190 predicates: tcx.arena.alloc_from_iter(bounds_predicates),
2193 // named opaque types
2194 predicates.extend(bounds_predicates);
2203 Node::ForeignItem(item) => match item.kind {
2204 ForeignItemKind::Static(..) => NO_GENERICS,
2205 ForeignItemKind::Fn(_, _, ref generics) => generics,
2206 ForeignItemKind::Type => NO_GENERICS,
2212 let generics = tcx.generics_of(def_id);
2213 let parent_count = generics.parent_count as u32;
2214 let has_own_self = generics.has_self && parent_count == 0;
2216 // Below we'll consider the bounds on the type parameters (including `Self`)
2217 // and the explicit where-clauses, but to get the full set of predicates
2218 // on a trait we need to add in the supertrait bounds and bounds found on
2219 // associated types.
2220 if let Some((_trait_ref, _)) = is_trait {
2221 predicates.extend(tcx.super_predicates_of(def_id).predicates.iter().cloned());
2224 // In default impls, we can assume that the self type implements
2225 // the trait. So in:
2227 // default impl Foo for Bar { .. }
2229 // we add a default where clause `Foo: Bar`. We do a similar thing for traits
2230 // (see below). Recall that a default impl is not itself an impl, but rather a
2231 // set of defaults that can be incorporated into another impl.
2232 if let Some(trait_ref) = is_default_impl_trait {
2233 predicates.push((trait_ref.to_poly_trait_ref().to_predicate(), tcx.def_span(def_id)));
2236 // Collect the region predicates that were declared inline as
2237 // well. In the case of parameters declared on a fn or method, we
2238 // have to be careful to only iterate over early-bound regions.
2239 let mut index = parent_count + has_own_self as u32;
2240 for param in early_bound_lifetimes_from_generics(tcx, ast_generics) {
2241 let region = tcx.mk_region(ty::ReEarlyBound(ty::EarlyBoundRegion {
2242 def_id: tcx.hir().local_def_id(param.hir_id),
2244 name: param.name.ident().name,
2249 GenericParamKind::Lifetime { .. } => {
2250 param.bounds.iter().for_each(|bound| match bound {
2251 hir::GenericBound::Outlives(lt) => {
2252 let bound = AstConv::ast_region_to_region(&icx, <, None);
2253 let outlives = ty::Binder::bind(ty::OutlivesPredicate(region, bound));
2254 predicates.push((outlives.to_predicate(), lt.span));
2263 // Collect the predicates that were written inline by the user on each
2264 // type parameter (e.g., `<T: Foo>`).
2265 for param in ast_generics.params {
2266 if let GenericParamKind::Type { .. } = param.kind {
2267 let name = param.name.ident().name;
2268 let param_ty = ty::ParamTy::new(index, name).to_ty(tcx);
2271 let sized = SizedByDefault::Yes;
2272 let bounds = AstConv::compute_bounds(&icx, param_ty, ¶m.bounds, sized, param.span);
2273 predicates.extend(bounds.predicates(tcx, param_ty));
2277 // Add in the bounds that appear in the where-clause.
2278 let where_clause = &ast_generics.where_clause;
2279 for predicate in where_clause.predicates {
2281 &hir::WherePredicate::BoundPredicate(ref bound_pred) => {
2282 let ty = icx.to_ty(&bound_pred.bounded_ty);
2284 // Keep the type around in a dummy predicate, in case of no bounds.
2285 // That way, `where Ty:` is not a complete noop (see #53696) and `Ty`
2286 // is still checked for WF.
2287 if bound_pred.bounds.is_empty() {
2288 if let ty::Param(_) = ty.kind {
2289 // This is a `where T:`, which can be in the HIR from the
2290 // transformation that moves `?Sized` to `T`'s declaration.
2291 // We can skip the predicate because type parameters are
2292 // trivially WF, but also we *should*, to avoid exposing
2293 // users who never wrote `where Type:,` themselves, to
2294 // compiler/tooling bugs from not handling WF predicates.
2296 let span = bound_pred.bounded_ty.span;
2297 let predicate = ty::OutlivesPredicate(ty, tcx.mk_region(ty::ReEmpty));
2299 ty::Predicate::TypeOutlives(ty::Binder::dummy(predicate)),
2305 for bound in bound_pred.bounds.iter() {
2307 &hir::GenericBound::Trait(ref poly_trait_ref, _) => {
2308 let mut bounds = Bounds::default();
2309 let _ = AstConv::instantiate_poly_trait_ref(
2315 predicates.extend(bounds.predicates(tcx, ty));
2318 &hir::GenericBound::Outlives(ref lifetime) => {
2319 let region = AstConv::ast_region_to_region(&icx, lifetime, None);
2320 let pred = ty::Binder::bind(ty::OutlivesPredicate(ty, region));
2321 predicates.push((ty::Predicate::TypeOutlives(pred), lifetime.span))
2327 &hir::WherePredicate::RegionPredicate(ref region_pred) => {
2328 let r1 = AstConv::ast_region_to_region(&icx, ®ion_pred.lifetime, None);
2329 predicates.extend(region_pred.bounds.iter().map(|bound| {
2330 let (r2, span) = match bound {
2331 hir::GenericBound::Outlives(lt) => {
2332 (AstConv::ast_region_to_region(&icx, lt, None), lt.span)
2336 let pred = ty::Binder::bind(ty::OutlivesPredicate(r1, r2));
2338 (ty::Predicate::RegionOutlives(pred), span)
2342 &hir::WherePredicate::EqPredicate(..) => {
2348 // Add predicates from associated type bounds.
2349 if let Some((self_trait_ref, trait_items)) = is_trait {
2350 predicates.extend(trait_items.iter().flat_map(|trait_item_ref| {
2351 associated_item_predicates(tcx, def_id, self_trait_ref, trait_item_ref)
2355 let mut predicates = predicates.predicates;
2357 // Subtle: before we store the predicates into the tcx, we
2358 // sort them so that predicates like `T: Foo<Item=U>` come
2359 // before uses of `U`. This avoids false ambiguity errors
2360 // in trait checking. See `setup_constraining_predicates`
2362 if let Node::Item(&Item { kind: ItemKind::Impl { .. }, .. }) = node {
2363 let self_ty = tcx.type_of(def_id);
2364 let trait_ref = tcx.impl_trait_ref(def_id);
2365 cgp::setup_constraining_predicates(
2369 &mut cgp::parameters_for_impl(self_ty, trait_ref),
2373 let result = ty::GenericPredicates {
2374 parent: generics.parent,
2375 predicates: tcx.arena.alloc_from_iter(predicates),
2377 debug!("explicit_predicates_of(def_id={:?}) = {:?}", def_id, result);
2381 fn associated_item_predicates(
2384 self_trait_ref: ty::TraitRef<'tcx>,
2385 trait_item_ref: &hir::TraitItemRef,
2386 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
2387 let trait_item = tcx.hir().trait_item(trait_item_ref.id);
2388 let item_def_id = tcx.hir().local_def_id(trait_item_ref.id.hir_id);
2389 let bounds = match trait_item.kind {
2390 hir::TraitItemKind::Type(ref bounds, _) => bounds,
2391 _ => return Vec::new(),
2394 let is_gat = !tcx.generics_of(item_def_id).params.is_empty();
2396 let mut had_error = false;
2398 let mut unimplemented_error = |arg_kind: &str| {
2403 &format!("{}-generic associated types are not yet implemented", arg_kind),
2405 .note("for more information, see https://github.com/rust-lang/rust/issues/44265")
2411 let mk_bound_param = |param: &ty::GenericParamDef, _: &_| {
2413 ty::GenericParamDefKind::Lifetime => tcx
2414 .mk_region(ty::RegionKind::ReLateBound(
2416 ty::BoundRegion::BrNamed(param.def_id, param.name),
2419 // FIXME(generic_associated_types): Use bound types and constants
2420 // once they are handled by the trait system.
2421 ty::GenericParamDefKind::Type { .. } => {
2422 unimplemented_error("type");
2423 tcx.types.err.into()
2425 ty::GenericParamDefKind::Const => {
2426 unimplemented_error("const");
2427 tcx.consts.err.into()
2432 let bound_substs = if is_gat {
2435 // trait X<'a, B, const C: usize> {
2436 // type T<'d, E, const F: usize>: Default;
2439 // We need to create predicates on the trait:
2441 // for<'d, E, const F: usize>
2442 // <Self as X<'a, B, const C: usize>>::T<'d, E, const F: usize>: Sized + Default
2444 // We substitute escaping bound parameters for the generic
2445 // arguments to the associated type which are then bound by
2446 // the `Binder` around the the predicate.
2448 // FIXME(generic_associated_types): Currently only lifetimes are handled.
2449 self_trait_ref.substs.extend_to(tcx, item_def_id, mk_bound_param)
2451 self_trait_ref.substs
2454 let assoc_ty = tcx.mk_projection(tcx.hir().local_def_id(trait_item.hir_id), bound_substs);
2456 let bounds = AstConv::compute_bounds(
2457 &ItemCtxt::new(tcx, def_id),
2460 SizedByDefault::Yes,
2464 let predicates = bounds.predicates(tcx, assoc_ty);
2467 // We use shifts to get the regions that we're substituting to
2468 // be bound by the binders in the `Predicate`s rather that
2470 let shifted_in = ty::fold::shift_vars(tcx, &predicates, 1);
2471 let substituted = shifted_in.subst(tcx, bound_substs);
2472 ty::fold::shift_out_vars(tcx, &substituted, 1)
2478 /// Converts a specific `GenericBound` from the AST into a set of
2479 /// predicates that apply to the self type. A vector is returned
2480 /// because this can be anywhere from zero predicates (`T: ?Sized` adds no
2481 /// predicates) to one (`T: Foo`) to many (`T: Bar<X = i32>` adds `T: Bar`
2482 /// and `<T as Bar>::X == i32`).
2483 fn predicates_from_bound<'tcx>(
2484 astconv: &dyn AstConv<'tcx>,
2486 bound: &'tcx hir::GenericBound<'tcx>,
2487 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
2489 hir::GenericBound::Trait(ref tr, hir::TraitBoundModifier::None) => {
2490 let mut bounds = Bounds::default();
2491 let _ = astconv.instantiate_poly_trait_ref(tr, param_ty, &mut bounds);
2492 bounds.predicates(astconv.tcx(), param_ty)
2494 hir::GenericBound::Outlives(ref lifetime) => {
2495 let region = astconv.ast_region_to_region(lifetime, None);
2496 let pred = ty::Binder::bind(ty::OutlivesPredicate(param_ty, region));
2497 vec![(ty::Predicate::TypeOutlives(pred), lifetime.span)]
2499 hir::GenericBound::Trait(_, hir::TraitBoundModifier::Maybe) => vec![],
2503 fn compute_sig_of_foreign_fn_decl<'tcx>(
2506 decl: &'tcx hir::FnDecl<'tcx>,
2508 ) -> ty::PolyFnSig<'tcx> {
2509 let unsafety = if abi == abi::Abi::RustIntrinsic {
2510 intrinsic_operation_unsafety(&tcx.item_name(def_id).as_str())
2512 hir::Unsafety::Unsafe
2514 let fty = AstConv::ty_of_fn(&ItemCtxt::new(tcx, def_id), unsafety, abi, decl, &[], None);
2516 // Feature gate SIMD types in FFI, since I am not sure that the
2517 // ABIs are handled at all correctly. -huonw
2518 if abi != abi::Abi::RustIntrinsic
2519 && abi != abi::Abi::PlatformIntrinsic
2520 && !tcx.features().simd_ffi
2522 let check = |ast_ty: &hir::Ty<'_>, ty: Ty<'_>| {
2528 "use of SIMD type `{}` in FFI is highly experimental and \
2529 may result in invalid code",
2530 tcx.hir().hir_to_pretty_string(ast_ty.hir_id)
2533 .help("add `#![feature(simd_ffi)]` to the crate attributes to enable")
2537 for (input, ty) in decl.inputs.iter().zip(*fty.inputs().skip_binder()) {
2540 if let hir::FunctionRetTy::Return(ref ty) = decl.output {
2541 check(&ty, *fty.output().skip_binder())
2548 fn is_foreign_item(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
2549 match tcx.hir().get_if_local(def_id) {
2550 Some(Node::ForeignItem(..)) => true,
2552 _ => bug!("is_foreign_item applied to non-local def-id {:?}", def_id),
2556 fn static_mutability(tcx: TyCtxt<'_>, def_id: DefId) -> Option<hir::Mutability> {
2557 match tcx.hir().get_if_local(def_id) {
2558 Some(Node::Item(&hir::Item { kind: hir::ItemKind::Static(_, mutbl, _), .. }))
2559 | Some(Node::ForeignItem(&hir::ForeignItem {
2560 kind: hir::ForeignItemKind::Static(_, mutbl),
2564 _ => bug!("static_mutability applied to non-local def-id {:?}", def_id),
2568 fn from_target_feature(
2571 attr: &ast::Attribute,
2572 whitelist: &FxHashMap<String, Option<Symbol>>,
2573 target_features: &mut Vec<Symbol>,
2575 let list = match attr.meta_item_list() {
2579 let bad_item = |span| {
2580 let msg = "malformed `target_feature` attribute input";
2581 let code = "enable = \"..\"".to_owned();
2583 .struct_span_err(span, &msg)
2584 .span_suggestion(span, "must be of the form", code, Applicability::HasPlaceholders)
2587 let rust_features = tcx.features();
2589 // Only `enable = ...` is accepted in the meta-item list.
2590 if !item.check_name(sym::enable) {
2591 bad_item(item.span());
2595 // Must be of the form `enable = "..."` (a string).
2596 let value = match item.value_str() {
2597 Some(value) => value,
2599 bad_item(item.span());
2604 // We allow comma separation to enable multiple features.
2605 target_features.extend(value.as_str().split(',').filter_map(|feature| {
2606 // Only allow whitelisted features per platform.
2607 let feature_gate = match whitelist.get(feature) {
2611 format!("the feature named `{}` is not valid for this target", feature);
2612 let mut err = tcx.sess.struct_span_err(item.span(), &msg);
2615 format!("`{}` is not valid for this target", feature),
2617 if feature.starts_with("+") {
2618 let valid = whitelist.contains_key(&feature[1..]);
2620 err.help("consider removing the leading `+` in the feature name");
2628 // Only allow features whose feature gates have been enabled.
2629 let allowed = match feature_gate.as_ref().map(|s| *s) {
2630 Some(sym::arm_target_feature) => rust_features.arm_target_feature,
2631 Some(sym::aarch64_target_feature) => rust_features.aarch64_target_feature,
2632 Some(sym::hexagon_target_feature) => rust_features.hexagon_target_feature,
2633 Some(sym::powerpc_target_feature) => rust_features.powerpc_target_feature,
2634 Some(sym::mips_target_feature) => rust_features.mips_target_feature,
2635 Some(sym::avx512_target_feature) => rust_features.avx512_target_feature,
2636 Some(sym::mmx_target_feature) => rust_features.mmx_target_feature,
2637 Some(sym::sse4a_target_feature) => rust_features.sse4a_target_feature,
2638 Some(sym::tbm_target_feature) => rust_features.tbm_target_feature,
2639 Some(sym::wasm_target_feature) => rust_features.wasm_target_feature,
2640 Some(sym::cmpxchg16b_target_feature) => rust_features.cmpxchg16b_target_feature,
2641 Some(sym::adx_target_feature) => rust_features.adx_target_feature,
2642 Some(sym::movbe_target_feature) => rust_features.movbe_target_feature,
2643 Some(sym::rtm_target_feature) => rust_features.rtm_target_feature,
2644 Some(sym::f16c_target_feature) => rust_features.f16c_target_feature,
2645 Some(name) => bug!("unknown target feature gate {}", name),
2648 if !allowed && id.is_local() {
2650 &tcx.sess.parse_sess,
2651 feature_gate.unwrap(),
2653 &format!("the target feature `{}` is currently unstable", feature),
2657 Some(Symbol::intern(feature))
2662 fn linkage_by_name(tcx: TyCtxt<'_>, def_id: DefId, name: &str) -> Linkage {
2663 use rustc::mir::mono::Linkage::*;
2665 // Use the names from src/llvm/docs/LangRef.rst here. Most types are only
2666 // applicable to variable declarations and may not really make sense for
2667 // Rust code in the first place but whitelist them anyway and trust that
2668 // the user knows what s/he's doing. Who knows, unanticipated use cases
2669 // may pop up in the future.
2671 // ghost, dllimport, dllexport and linkonce_odr_autohide are not supported
2672 // and don't have to be, LLVM treats them as no-ops.
2674 "appending" => Appending,
2675 "available_externally" => AvailableExternally,
2677 "extern_weak" => ExternalWeak,
2678 "external" => External,
2679 "internal" => Internal,
2680 "linkonce" => LinkOnceAny,
2681 "linkonce_odr" => LinkOnceODR,
2682 "private" => Private,
2684 "weak_odr" => WeakODR,
2686 let span = tcx.hir().span_if_local(def_id);
2687 if let Some(span) = span {
2688 tcx.sess.span_fatal(span, "invalid linkage specified")
2690 tcx.sess.fatal(&format!("invalid linkage specified: {}", name))
2696 fn codegen_fn_attrs(tcx: TyCtxt<'_>, id: DefId) -> CodegenFnAttrs {
2697 let attrs = tcx.get_attrs(id);
2699 let mut codegen_fn_attrs = CodegenFnAttrs::new();
2701 let whitelist = tcx.target_features_whitelist(LOCAL_CRATE);
2703 let mut inline_span = None;
2704 let mut link_ordinal_span = None;
2705 for attr in attrs.iter() {
2706 if attr.check_name(sym::cold) {
2707 codegen_fn_attrs.flags |= CodegenFnAttrFlags::COLD;
2708 } else if attr.check_name(sym::rustc_allocator) {
2709 codegen_fn_attrs.flags |= CodegenFnAttrFlags::ALLOCATOR;
2710 } else if attr.check_name(sym::unwind) {
2711 codegen_fn_attrs.flags |= CodegenFnAttrFlags::UNWIND;
2712 } else if attr.check_name(sym::ffi_returns_twice) {
2713 if tcx.is_foreign_item(id) {
2714 codegen_fn_attrs.flags |= CodegenFnAttrFlags::FFI_RETURNS_TWICE;
2716 // `#[ffi_returns_twice]` is only allowed `extern fn`s.
2721 "`#[ffi_returns_twice]` may only be used on foreign functions"
2725 } else if attr.check_name(sym::rustc_allocator_nounwind) {
2726 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_ALLOCATOR_NOUNWIND;
2727 } else if attr.check_name(sym::naked) {
2728 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NAKED;
2729 } else if attr.check_name(sym::no_mangle) {
2730 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
2731 } else if attr.check_name(sym::rustc_std_internal_symbol) {
2732 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2733 } else if attr.check_name(sym::no_debug) {
2734 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_DEBUG;
2735 } else if attr.check_name(sym::used) {
2736 codegen_fn_attrs.flags |= CodegenFnAttrFlags::USED;
2737 } else if attr.check_name(sym::thread_local) {
2738 codegen_fn_attrs.flags |= CodegenFnAttrFlags::THREAD_LOCAL;
2739 } else if attr.check_name(sym::track_caller) {
2740 if tcx.fn_sig(id).abi() != abi::Abi::Rust {
2741 struct_span_err!(tcx.sess, attr.span, E0737, "`#[track_caller]` requires Rust ABI")
2744 codegen_fn_attrs.flags |= CodegenFnAttrFlags::TRACK_CALLER;
2745 } else if attr.check_name(sym::export_name) {
2746 if let Some(s) = attr.value_str() {
2747 if s.as_str().contains("\0") {
2748 // `#[export_name = ...]` will be converted to a null-terminated string,
2749 // so it may not contain any null characters.
2754 "`export_name` may not contain null characters"
2758 codegen_fn_attrs.export_name = Some(s);
2760 } else if attr.check_name(sym::target_feature) {
2761 if tcx.fn_sig(id).unsafety() == Unsafety::Normal {
2762 let msg = "`#[target_feature(..)]` can only be applied to `unsafe` functions";
2764 .struct_span_err(attr.span, msg)
2765 .span_label(attr.span, "can only be applied to `unsafe` functions")
2766 .span_label(tcx.def_span(id), "not an `unsafe` function")
2769 from_target_feature(tcx, id, attr, &whitelist, &mut codegen_fn_attrs.target_features);
2770 } else if attr.check_name(sym::linkage) {
2771 if let Some(val) = attr.value_str() {
2772 codegen_fn_attrs.linkage = Some(linkage_by_name(tcx, id, &val.as_str()));
2774 } else if attr.check_name(sym::link_section) {
2775 if let Some(val) = attr.value_str() {
2776 if val.as_str().bytes().any(|b| b == 0) {
2778 "illegal null byte in link_section \
2782 tcx.sess.span_err(attr.span, &msg);
2784 codegen_fn_attrs.link_section = Some(val);
2787 } else if attr.check_name(sym::link_name) {
2788 codegen_fn_attrs.link_name = attr.value_str();
2789 } else if attr.check_name(sym::link_ordinal) {
2790 link_ordinal_span = Some(attr.span);
2791 if let ordinal @ Some(_) = check_link_ordinal(tcx, attr) {
2792 codegen_fn_attrs.link_ordinal = ordinal;
2797 codegen_fn_attrs.inline = attrs.iter().fold(InlineAttr::None, |ia, attr| {
2798 if !attr.has_name(sym::inline) {
2801 match attr.meta().map(|i| i.kind) {
2802 Some(MetaItemKind::Word) => {
2806 Some(MetaItemKind::List(ref items)) => {
2808 inline_span = Some(attr.span);
2809 if items.len() != 1 {
2811 tcx.sess.diagnostic(),
2814 "expected one argument"
2818 } else if list_contains_name(&items[..], sym::always) {
2820 } else if list_contains_name(&items[..], sym::never) {
2824 tcx.sess.diagnostic(),
2834 Some(MetaItemKind::NameValue(_)) => ia,
2839 codegen_fn_attrs.optimize = attrs.iter().fold(OptimizeAttr::None, |ia, attr| {
2840 if !attr.has_name(sym::optimize) {
2843 let err = |sp, s| struct_span_err!(tcx.sess.diagnostic(), sp, E0722, "{}", s).emit();
2844 match attr.meta().map(|i| i.kind) {
2845 Some(MetaItemKind::Word) => {
2846 err(attr.span, "expected one argument");
2849 Some(MetaItemKind::List(ref items)) => {
2851 inline_span = Some(attr.span);
2852 if items.len() != 1 {
2853 err(attr.span, "expected one argument");
2855 } else if list_contains_name(&items[..], sym::size) {
2857 } else if list_contains_name(&items[..], sym::speed) {
2860 err(items[0].span(), "invalid argument");
2864 Some(MetaItemKind::NameValue(_)) => ia,
2869 // If a function uses #[target_feature] it can't be inlined into general
2870 // purpose functions as they wouldn't have the right target features
2871 // enabled. For that reason we also forbid #[inline(always)] as it can't be
2874 if codegen_fn_attrs.target_features.len() > 0 {
2875 if codegen_fn_attrs.inline == InlineAttr::Always {
2876 if let Some(span) = inline_span {
2879 "cannot use `#[inline(always)]` with \
2880 `#[target_feature]`",
2886 // Weak lang items have the same semantics as "std internal" symbols in the
2887 // sense that they're preserved through all our LTO passes and only
2888 // strippable by the linker.
2890 // Additionally weak lang items have predetermined symbol names.
2891 if tcx.is_weak_lang_item(id) {
2892 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2894 if let Some(name) = weak_lang_items::link_name(&attrs) {
2895 codegen_fn_attrs.export_name = Some(name);
2896 codegen_fn_attrs.link_name = Some(name);
2898 check_link_name_xor_ordinal(tcx, &codegen_fn_attrs, link_ordinal_span);
2900 // Internal symbols to the standard library all have no_mangle semantics in
2901 // that they have defined symbol names present in the function name. This
2902 // also applies to weak symbols where they all have known symbol names.
2903 if codegen_fn_attrs.flags.contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL) {
2904 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
2910 fn check_link_ordinal(tcx: TyCtxt<'_>, attr: &ast::Attribute) -> Option<usize> {
2911 use syntax::ast::{Lit, LitIntType, LitKind};
2912 let meta_item_list = attr.meta_item_list();
2913 let meta_item_list: Option<&[ast::NestedMetaItem]> = meta_item_list.as_ref().map(Vec::as_ref);
2914 let sole_meta_list = match meta_item_list {
2915 Some([item]) => item.literal(),
2918 if let Some(Lit { kind: LitKind::Int(ordinal, LitIntType::Unsuffixed), .. }) = sole_meta_list {
2919 if *ordinal <= std::usize::MAX as u128 {
2920 Some(*ordinal as usize)
2922 let msg = format!("ordinal value in `link_ordinal` is too large: `{}`", &ordinal);
2924 .struct_span_err(attr.span, &msg)
2925 .note("the value may not exceed `std::usize::MAX`")
2931 .struct_span_err(attr.span, "illegal ordinal format in `link_ordinal`")
2932 .note("an unsuffixed integer value, e.g., `1`, is expected")
2938 fn check_link_name_xor_ordinal(
2940 codegen_fn_attrs: &CodegenFnAttrs,
2941 inline_span: Option<Span>,
2943 if codegen_fn_attrs.link_name.is_none() || codegen_fn_attrs.link_ordinal.is_none() {
2946 let msg = "cannot use `#[link_name]` with `#[link_ordinal]`";
2947 if let Some(span) = inline_span {
2948 tcx.sess.span_err(span, msg);