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 struct OnlySelfBounds(bool);
52 ///////////////////////////////////////////////////////////////////////////
55 fn collect_mod_item_types(tcx: TyCtxt<'_>, module_def_id: DefId) {
56 tcx.hir().visit_item_likes_in_module(
58 &mut CollectItemTypesVisitor { tcx }.as_deep_visitor(),
62 pub fn provide(providers: &mut Providers<'_>) {
63 *providers = Providers {
67 predicates_defined_on,
68 explicit_predicates_of,
70 type_param_predicates,
79 collect_mod_item_types,
84 ///////////////////////////////////////////////////////////////////////////
86 /// Context specific to some particular item. This is what implements
87 /// `AstConv`. It has information about the predicates that are defined
88 /// on the trait. Unfortunately, this predicate information is
89 /// available in various different forms at various points in the
90 /// process. So we can't just store a pointer to e.g., the AST or the
91 /// parsed ty form, we have to be more flexible. To this end, the
92 /// `ItemCtxt` is parameterized by a `DefId` that it uses to satisfy
93 /// `get_type_parameter_bounds` requests, drawing the information from
94 /// the AST (`hir::Generics`), recursively.
95 pub struct ItemCtxt<'tcx> {
100 ///////////////////////////////////////////////////////////////////////////
103 crate struct PlaceholderHirTyCollector(crate Vec<Span>);
105 impl<'v> Visitor<'v> for PlaceholderHirTyCollector {
108 fn nested_visit_map(&mut self) -> NestedVisitorMap<'_, Self::Map> {
109 NestedVisitorMap::None
111 fn visit_ty(&mut self, t: &'v hir::Ty<'v>) {
112 if let hir::TyKind::Infer = t.kind {
115 intravisit::walk_ty(self, t)
119 struct CollectItemTypesVisitor<'tcx> {
123 /// If there are any placeholder types (`_`), emit an error explaining that this is not allowed
124 /// and suggest adding type parameters in the appropriate place, taking into consideration any and
125 /// all already existing generic type parameters to avoid suggesting a name that is already in use.
126 crate fn placeholder_type_error(
129 generics: &[hir::GenericParam<'_>],
130 placeholder_types: Vec<Span>,
133 if placeholder_types.is_empty() {
136 // This is the whitelist of possible parameter names that we might suggest.
137 let possible_names = ["T", "K", "L", "A", "B", "C"];
138 let used_names = generics
140 .filter_map(|p| match p.name {
141 hir::ParamName::Plain(ident) => Some(ident.name),
144 .collect::<Vec<_>>();
146 let type_name = possible_names
148 .find(|n| !used_names.contains(&Symbol::intern(n)))
149 .unwrap_or(&"ParamName");
151 let mut sugg: Vec<_> =
152 placeholder_types.iter().map(|sp| (*sp, type_name.to_string())).collect();
153 if generics.is_empty() {
154 sugg.push((span, format!("<{}>", type_name)));
155 } else if let Some(arg) = generics.iter().find(|arg| match arg.name {
156 hir::ParamName::Plain(Ident { name: kw::Underscore, .. }) => true,
159 // Account for `_` already present in cases like `struct S<_>(_);` and suggest
160 // `struct S<T>(T);` instead of `struct S<_, T>(T);`.
161 sugg.push((arg.span, format!("{}", type_name)));
164 generics.iter().last().unwrap().span.shrink_to_hi(),
165 format!(", {}", type_name),
168 let mut err = bad_placeholder_type(tcx, placeholder_types);
170 err.multipart_suggestion(
171 "use type parameters instead",
173 Applicability::HasPlaceholders,
179 fn reject_placeholder_type_signatures_in_item(tcx: TyCtxt<'tcx>, item: &'tcx hir::Item<'tcx>) {
180 let (generics, suggest) = match &item.kind {
181 hir::ItemKind::Union(_, generics)
182 | hir::ItemKind::Enum(_, generics)
183 | hir::ItemKind::TraitAlias(generics, _)
184 | hir::ItemKind::Trait(_, _, generics, ..)
185 | hir::ItemKind::Impl { generics, .. }
186 | hir::ItemKind::Struct(_, generics) => (generics, true),
187 hir::ItemKind::OpaqueTy(hir::OpaqueTy { generics, .. })
188 | hir::ItemKind::TyAlias(_, generics) => (generics, false),
189 // `static`, `fn` and `const` are handled elsewhere to suggest appropriate type.
193 let mut visitor = PlaceholderHirTyCollector::default();
194 visitor.visit_item(item);
196 placeholder_type_error(tcx, generics.span, &generics.params[..], visitor.0, suggest);
199 impl Visitor<'tcx> for CollectItemTypesVisitor<'tcx> {
200 type Map = Map<'tcx>;
202 fn nested_visit_map(&mut self) -> NestedVisitorMap<'_, Self::Map> {
203 NestedVisitorMap::OnlyBodies(&self.tcx.hir())
206 fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
207 convert_item(self.tcx, item.hir_id);
208 reject_placeholder_type_signatures_in_item(self.tcx, item);
209 intravisit::walk_item(self, item);
212 fn visit_generics(&mut self, generics: &'tcx hir::Generics<'tcx>) {
213 for param in generics.params {
215 hir::GenericParamKind::Lifetime { .. } => {}
216 hir::GenericParamKind::Type { default: Some(_), .. } => {
217 let def_id = self.tcx.hir().local_def_id(param.hir_id);
218 self.tcx.type_of(def_id);
220 hir::GenericParamKind::Type { .. } => {}
221 hir::GenericParamKind::Const { .. } => {
222 let def_id = self.tcx.hir().local_def_id(param.hir_id);
223 self.tcx.type_of(def_id);
227 intravisit::walk_generics(self, generics);
230 fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
231 if let hir::ExprKind::Closure(..) = expr.kind {
232 let def_id = self.tcx.hir().local_def_id(expr.hir_id);
233 self.tcx.generics_of(def_id);
234 self.tcx.type_of(def_id);
236 intravisit::walk_expr(self, expr);
239 fn visit_trait_item(&mut self, trait_item: &'tcx hir::TraitItem<'tcx>) {
240 convert_trait_item(self.tcx, trait_item.hir_id);
241 intravisit::walk_trait_item(self, trait_item);
244 fn visit_impl_item(&mut self, impl_item: &'tcx hir::ImplItem<'tcx>) {
245 convert_impl_item(self.tcx, impl_item.hir_id);
246 intravisit::walk_impl_item(self, impl_item);
250 ///////////////////////////////////////////////////////////////////////////
251 // Utility types and common code for the above passes.
253 fn bad_placeholder_type(
255 mut spans: Vec<Span>,
256 ) -> rustc_errors::DiagnosticBuilder<'tcx> {
258 let mut err = struct_span_err!(
262 "the type placeholder `_` is not allowed within types on item signatures",
265 err.span_label(span, "not allowed in type signatures");
270 impl ItemCtxt<'tcx> {
271 pub fn new(tcx: TyCtxt<'tcx>, item_def_id: DefId) -> ItemCtxt<'tcx> {
272 ItemCtxt { tcx, item_def_id }
275 pub fn to_ty(&self, ast_ty: &'tcx hir::Ty<'tcx>) -> Ty<'tcx> {
276 AstConv::ast_ty_to_ty(self, ast_ty)
280 impl AstConv<'tcx> for ItemCtxt<'tcx> {
281 fn tcx(&self) -> TyCtxt<'tcx> {
285 fn item_def_id(&self) -> Option<DefId> {
286 Some(self.item_def_id)
289 fn get_type_parameter_bounds(&self, span: Span, def_id: DefId) -> ty::GenericPredicates<'tcx> {
290 self.tcx.at(span).type_param_predicates((self.item_def_id, def_id))
293 fn re_infer(&self, _: Option<&ty::GenericParamDef>, _: Span) -> Option<ty::Region<'tcx>> {
297 fn allow_ty_infer(&self) -> bool {
301 fn ty_infer(&self, _: Option<&ty::GenericParamDef>, span: Span) -> Ty<'tcx> {
302 self.tcx().sess.delay_span_bug(span, "bad placeholder type");
309 _: Option<&ty::GenericParamDef>,
311 ) -> &'tcx Const<'tcx> {
312 bad_placeholder_type(self.tcx(), vec![span]).emit();
314 self.tcx().consts.err
317 fn projected_ty_from_poly_trait_ref(
321 item_segment: &hir::PathSegment<'_>,
322 poly_trait_ref: ty::PolyTraitRef<'tcx>,
324 if let Some(trait_ref) = poly_trait_ref.no_bound_vars() {
325 let item_substs = <dyn AstConv<'tcx>>::create_substs_for_associated_item(
333 self.tcx().mk_projection(item_def_id, item_substs)
335 // There are no late-bound regions; we can just ignore the binder.
340 "cannot extract an associated type from a higher-ranked trait bound \
348 fn normalize_ty(&self, _span: Span, ty: Ty<'tcx>) -> Ty<'tcx> {
349 // Types in item signatures are not normalized to avoid undue dependencies.
353 fn set_tainted_by_errors(&self) {
354 // There's no obvious place to track this, so just let it go.
357 fn record_ty(&self, _hir_id: hir::HirId, _ty: Ty<'tcx>, _span: Span) {
358 // There's no place to record types from signatures?
362 /// Returns the predicates defined on `item_def_id` of the form
363 /// `X: Foo` where `X` is the type parameter `def_id`.
364 fn type_param_predicates(
366 (item_def_id, def_id): (DefId, DefId),
367 ) -> ty::GenericPredicates<'_> {
370 // In the AST, bounds can derive from two places. Either
371 // written inline like `<T: Foo>` or in a where-clause like
374 let param_id = tcx.hir().as_local_hir_id(def_id).unwrap();
375 let param_owner = tcx.hir().ty_param_owner(param_id);
376 let param_owner_def_id = tcx.hir().local_def_id(param_owner);
377 let generics = tcx.generics_of(param_owner_def_id);
378 let index = generics.param_def_id_to_index[&def_id];
379 let ty = tcx.mk_ty_param(index, tcx.hir().ty_param_name(param_id));
381 // Don't look for bounds where the type parameter isn't in scope.
383 if item_def_id == param_owner_def_id { None } else { tcx.generics_of(item_def_id).parent };
385 let mut result = parent
387 let icx = ItemCtxt::new(tcx, parent);
388 icx.get_type_parameter_bounds(DUMMY_SP, def_id)
390 .unwrap_or_default();
391 let mut extend = None;
393 let item_hir_id = tcx.hir().as_local_hir_id(item_def_id).unwrap();
394 let ast_generics = match tcx.hir().get(item_hir_id) {
395 Node::TraitItem(item) => &item.generics,
397 Node::ImplItem(item) => &item.generics,
399 Node::Item(item) => {
401 ItemKind::Fn(.., ref generics, _)
402 | ItemKind::Impl { ref generics, .. }
403 | ItemKind::TyAlias(_, ref generics)
404 | ItemKind::OpaqueTy(OpaqueTy { ref generics, impl_trait_fn: None, .. })
405 | ItemKind::Enum(_, ref generics)
406 | ItemKind::Struct(_, ref generics)
407 | ItemKind::Union(_, ref generics) => generics,
408 ItemKind::Trait(_, _, ref generics, ..) => {
409 // Implied `Self: Trait` and supertrait bounds.
410 if param_id == item_hir_id {
411 let identity_trait_ref = ty::TraitRef::identity(tcx, item_def_id);
412 extend = Some((identity_trait_ref.to_predicate(), item.span));
420 Node::ForeignItem(item) => match item.kind {
421 ForeignItemKind::Fn(_, _, ref generics) => generics,
428 let icx = ItemCtxt::new(tcx, item_def_id);
429 let extra_predicates = extend.into_iter().chain(
430 icx.type_parameter_bounds_in_generics(ast_generics, param_id, ty, OnlySelfBounds(true))
432 .filter(|(predicate, _)| match predicate {
433 ty::Predicate::Trait(ref data) => data.skip_binder().self_ty().is_param(index),
438 tcx.arena.alloc_from_iter(result.predicates.iter().copied().chain(extra_predicates));
442 impl ItemCtxt<'tcx> {
443 /// Finds bounds from `hir::Generics`. This requires scanning through the
444 /// AST. We do this to avoid having to convert *all* the bounds, which
445 /// would create artificial cycles. Instead, we can only convert the
446 /// bounds for a type parameter `X` if `X::Foo` is used.
447 fn type_parameter_bounds_in_generics(
449 ast_generics: &'tcx hir::Generics<'tcx>,
450 param_id: hir::HirId,
452 only_self_bounds: OnlySelfBounds,
453 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
454 let from_ty_params = ast_generics
457 .filter_map(|param| match param.kind {
458 GenericParamKind::Type { .. } if param.hir_id == param_id => Some(¶m.bounds),
461 .flat_map(|bounds| bounds.iter())
462 .flat_map(|b| predicates_from_bound(self, ty, b));
464 let from_where_clauses = ast_generics
468 .filter_map(|wp| match *wp {
469 hir::WherePredicate::BoundPredicate(ref bp) => Some(bp),
473 let bt = if is_param(self.tcx, &bp.bounded_ty, param_id) {
475 } else if !only_self_bounds.0 {
476 Some(self.to_ty(&bp.bounded_ty))
480 bp.bounds.iter().filter_map(move |b| bt.map(|bt| (bt, b)))
482 .flat_map(|(bt, b)| predicates_from_bound(self, bt, b));
484 from_ty_params.chain(from_where_clauses).collect()
488 /// Tests whether this is the AST for a reference to the type
489 /// parameter with ID `param_id`. We use this so as to avoid running
490 /// `ast_ty_to_ty`, because we want to avoid triggering an all-out
491 /// conversion of the type to avoid inducing unnecessary cycles.
492 fn is_param(tcx: TyCtxt<'_>, ast_ty: &hir::Ty<'_>, param_id: hir::HirId) -> bool {
493 if let hir::TyKind::Path(hir::QPath::Resolved(None, ref path)) = ast_ty.kind {
495 Res::SelfTy(Some(def_id), None) | Res::Def(DefKind::TyParam, def_id) => {
496 def_id == tcx.hir().local_def_id(param_id)
505 fn convert_item(tcx: TyCtxt<'_>, item_id: hir::HirId) {
506 let it = tcx.hir().expect_item(item_id);
507 debug!("convert: item {} with id {}", it.ident, it.hir_id);
508 let def_id = tcx.hir().local_def_id(item_id);
510 // These don't define types.
511 hir::ItemKind::ExternCrate(_)
512 | hir::ItemKind::Use(..)
513 | hir::ItemKind::Mod(_)
514 | hir::ItemKind::GlobalAsm(_) => {}
515 hir::ItemKind::ForeignMod(ref foreign_mod) => {
516 for item in foreign_mod.items {
517 let def_id = tcx.hir().local_def_id(item.hir_id);
518 tcx.generics_of(def_id);
520 tcx.predicates_of(def_id);
521 if let hir::ForeignItemKind::Fn(..) = item.kind {
526 hir::ItemKind::Enum(ref enum_definition, _) => {
527 tcx.generics_of(def_id);
529 tcx.predicates_of(def_id);
530 convert_enum_variant_types(tcx, def_id, &enum_definition.variants);
532 hir::ItemKind::Impl { .. } => {
533 tcx.generics_of(def_id);
535 tcx.impl_trait_ref(def_id);
536 tcx.predicates_of(def_id);
538 hir::ItemKind::Trait(..) => {
539 tcx.generics_of(def_id);
540 tcx.trait_def(def_id);
541 tcx.at(it.span).super_predicates_of(def_id);
542 tcx.predicates_of(def_id);
544 hir::ItemKind::TraitAlias(..) => {
545 tcx.generics_of(def_id);
546 tcx.at(it.span).super_predicates_of(def_id);
547 tcx.predicates_of(def_id);
549 hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
550 tcx.generics_of(def_id);
552 tcx.predicates_of(def_id);
554 for f in struct_def.fields() {
555 let def_id = tcx.hir().local_def_id(f.hir_id);
556 tcx.generics_of(def_id);
558 tcx.predicates_of(def_id);
561 if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
562 convert_variant_ctor(tcx, ctor_hir_id);
566 // Desugared from `impl Trait`, so visited by the function's return type.
567 hir::ItemKind::OpaqueTy(hir::OpaqueTy { impl_trait_fn: Some(_), .. }) => {}
569 hir::ItemKind::OpaqueTy(..)
570 | hir::ItemKind::TyAlias(..)
571 | hir::ItemKind::Static(..)
572 | hir::ItemKind::Const(..)
573 | hir::ItemKind::Fn(..) => {
574 tcx.generics_of(def_id);
576 tcx.predicates_of(def_id);
577 if let hir::ItemKind::Fn(..) = it.kind {
584 fn convert_trait_item(tcx: TyCtxt<'_>, trait_item_id: hir::HirId) {
585 let trait_item = tcx.hir().expect_trait_item(trait_item_id);
586 let def_id = tcx.hir().local_def_id(trait_item.hir_id);
587 tcx.generics_of(def_id);
589 match trait_item.kind {
590 hir::TraitItemKind::Const(..)
591 | hir::TraitItemKind::Type(_, Some(_))
592 | hir::TraitItemKind::Method(..) => {
594 if let hir::TraitItemKind::Method(..) = trait_item.kind {
599 hir::TraitItemKind::Type(_, None) => {}
602 tcx.predicates_of(def_id);
605 fn convert_impl_item(tcx: TyCtxt<'_>, impl_item_id: hir::HirId) {
606 let def_id = tcx.hir().local_def_id(impl_item_id);
607 tcx.generics_of(def_id);
609 tcx.predicates_of(def_id);
610 if let hir::ImplItemKind::Method(..) = tcx.hir().expect_impl_item(impl_item_id).kind {
615 fn convert_variant_ctor(tcx: TyCtxt<'_>, ctor_id: hir::HirId) {
616 let def_id = tcx.hir().local_def_id(ctor_id);
617 tcx.generics_of(def_id);
619 tcx.predicates_of(def_id);
622 fn convert_enum_variant_types(tcx: TyCtxt<'_>, def_id: DefId, variants: &[hir::Variant<'_>]) {
623 let def = tcx.adt_def(def_id);
624 let repr_type = def.repr.discr_type();
625 let initial = repr_type.initial_discriminant(tcx);
626 let mut prev_discr = None::<Discr<'_>>;
628 // fill the discriminant values and field types
629 for variant in variants {
630 let wrapped_discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
632 if let Some(ref e) = variant.disr_expr {
633 let expr_did = tcx.hir().local_def_id(e.hir_id);
634 def.eval_explicit_discr(tcx, expr_did)
635 } else if let Some(discr) = repr_type.disr_incr(tcx, prev_discr) {
638 struct_span_err!(tcx.sess, variant.span, E0370, "enum discriminant overflowed")
641 format!("overflowed on value after {}", prev_discr.unwrap()),
644 "explicitly set `{} = {}` if that is desired outcome",
645 variant.ident, wrapped_discr
650 .unwrap_or(wrapped_discr),
653 for f in variant.data.fields() {
654 let def_id = tcx.hir().local_def_id(f.hir_id);
655 tcx.generics_of(def_id);
657 tcx.predicates_of(def_id);
660 // Convert the ctor, if any. This also registers the variant as
662 if let Some(ctor_hir_id) = variant.data.ctor_hir_id() {
663 convert_variant_ctor(tcx, ctor_hir_id);
670 variant_did: Option<DefId>,
671 ctor_did: Option<DefId>,
673 discr: ty::VariantDiscr,
674 def: &hir::VariantData<'_>,
675 adt_kind: ty::AdtKind,
677 ) -> ty::VariantDef {
678 let mut seen_fields: FxHashMap<ast::Ident, Span> = Default::default();
679 let hir_id = tcx.hir().as_local_hir_id(variant_did.unwrap_or(parent_did)).unwrap();
684 let fid = tcx.hir().local_def_id(f.hir_id);
685 let dup_span = seen_fields.get(&f.ident.modern()).cloned();
686 if let Some(prev_span) = dup_span {
691 "field `{}` is already declared",
694 .span_label(f.span, "field already declared")
695 .span_label(prev_span, format!("`{}` first declared here", f.ident))
698 seen_fields.insert(f.ident.modern(), f.span);
704 vis: ty::Visibility::from_hir(&f.vis, hir_id, tcx),
708 let recovered = match def {
709 hir::VariantData::Struct(_, r) => *r,
719 CtorKind::from_hir(def),
726 fn adt_def(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::AdtDef {
729 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
730 let item = match tcx.hir().get(hir_id) {
731 Node::Item(item) => item,
735 let repr = ReprOptions::new(tcx, def_id);
736 let (kind, variants) = match item.kind {
737 ItemKind::Enum(ref def, _) => {
738 let mut distance_from_explicit = 0;
743 let variant_did = Some(tcx.hir().local_def_id(v.id));
745 v.data.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
747 let discr = if let Some(ref e) = v.disr_expr {
748 distance_from_explicit = 0;
749 ty::VariantDiscr::Explicit(tcx.hir().local_def_id(e.hir_id))
751 ty::VariantDiscr::Relative(distance_from_explicit)
753 distance_from_explicit += 1;
768 (AdtKind::Enum, variants)
770 ItemKind::Struct(ref def, _) => {
771 let variant_did = None;
772 let ctor_did = def.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
774 let variants = std::iter::once(convert_variant(
779 ty::VariantDiscr::Relative(0),
786 (AdtKind::Struct, variants)
788 ItemKind::Union(ref def, _) => {
789 let variant_did = None;
790 let ctor_did = def.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
792 let variants = std::iter::once(convert_variant(
797 ty::VariantDiscr::Relative(0),
804 (AdtKind::Union, variants)
808 tcx.alloc_adt_def(def_id, kind, variants, repr)
811 /// Ensures that the super-predicates of the trait with a `DefId`
812 /// of `trait_def_id` are converted and stored. This also ensures that
813 /// the transitive super-predicates are converted.
814 fn super_predicates_of(tcx: TyCtxt<'_>, trait_def_id: DefId) -> ty::GenericPredicates<'_> {
815 debug!("super_predicates(trait_def_id={:?})", trait_def_id);
816 let trait_hir_id = tcx.hir().as_local_hir_id(trait_def_id).unwrap();
818 let item = match tcx.hir().get(trait_hir_id) {
819 Node::Item(item) => item,
820 _ => bug!("trait_node_id {} is not an item", trait_hir_id),
823 let (generics, bounds) = match item.kind {
824 hir::ItemKind::Trait(.., ref generics, ref supertraits, _) => (generics, supertraits),
825 hir::ItemKind::TraitAlias(ref generics, ref supertraits) => (generics, supertraits),
826 _ => span_bug!(item.span, "super_predicates invoked on non-trait"),
829 let icx = ItemCtxt::new(tcx, trait_def_id);
831 // Convert the bounds that follow the colon, e.g., `Bar + Zed` in `trait Foo: Bar + Zed`.
832 let self_param_ty = tcx.types.self_param;
834 AstConv::compute_bounds(&icx, self_param_ty, bounds, SizedByDefault::No, item.span);
836 let superbounds1 = superbounds1.predicates(tcx, self_param_ty);
838 // Convert any explicit superbounds in the where-clause,
839 // e.g., `trait Foo where Self: Bar`.
840 // In the case of trait aliases, however, we include all bounds in the where-clause,
841 // so e.g., `trait Foo = where u32: PartialEq<Self>` would include `u32: PartialEq<Self>`
842 // as one of its "superpredicates".
843 let is_trait_alias = tcx.is_trait_alias(trait_def_id);
844 let superbounds2 = icx.type_parameter_bounds_in_generics(
848 OnlySelfBounds(!is_trait_alias),
851 // Combine the two lists to form the complete set of superbounds:
852 let superbounds = &*tcx.arena.alloc_from_iter(superbounds1.into_iter().chain(superbounds2));
854 // Now require that immediate supertraits are converted,
855 // which will, in turn, reach indirect supertraits.
856 for &(pred, span) in superbounds {
857 debug!("superbound: {:?}", pred);
858 if let ty::Predicate::Trait(bound) = pred {
859 tcx.at(span).super_predicates_of(bound.def_id());
863 ty::GenericPredicates { parent: None, predicates: superbounds }
866 fn trait_def(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::TraitDef {
867 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
868 let item = tcx.hir().expect_item(hir_id);
870 let (is_auto, unsafety) = match item.kind {
871 hir::ItemKind::Trait(is_auto, unsafety, ..) => (is_auto == hir::IsAuto::Yes, unsafety),
872 hir::ItemKind::TraitAlias(..) => (false, hir::Unsafety::Normal),
873 _ => span_bug!(item.span, "trait_def_of_item invoked on non-trait"),
876 let paren_sugar = tcx.has_attr(def_id, sym::rustc_paren_sugar);
877 if paren_sugar && !tcx.features().unboxed_closures {
881 "the `#[rustc_paren_sugar]` attribute is a temporary means of controlling \
882 which traits can use parenthetical notation",
884 .help("add `#![feature(unboxed_closures)]` to the crate attributes to use it")
888 let is_marker = tcx.has_attr(def_id, sym::marker);
889 let def_path_hash = tcx.def_path_hash(def_id);
890 let def = ty::TraitDef::new(def_id, unsafety, paren_sugar, is_auto, is_marker, def_path_hash);
894 fn has_late_bound_regions<'tcx>(tcx: TyCtxt<'tcx>, node: Node<'tcx>) -> Option<Span> {
895 struct LateBoundRegionsDetector<'tcx> {
897 outer_index: ty::DebruijnIndex,
898 has_late_bound_regions: Option<Span>,
901 impl Visitor<'tcx> for LateBoundRegionsDetector<'tcx> {
902 type Map = Map<'tcx>;
904 fn nested_visit_map(&mut self) -> NestedVisitorMap<'_, Self::Map> {
905 NestedVisitorMap::None
908 fn visit_ty(&mut self, ty: &'tcx hir::Ty<'tcx>) {
909 if self.has_late_bound_regions.is_some() {
913 hir::TyKind::BareFn(..) => {
914 self.outer_index.shift_in(1);
915 intravisit::walk_ty(self, ty);
916 self.outer_index.shift_out(1);
918 _ => intravisit::walk_ty(self, ty),
922 fn visit_poly_trait_ref(
924 tr: &'tcx hir::PolyTraitRef<'tcx>,
925 m: hir::TraitBoundModifier,
927 if self.has_late_bound_regions.is_some() {
930 self.outer_index.shift_in(1);
931 intravisit::walk_poly_trait_ref(self, tr, m);
932 self.outer_index.shift_out(1);
935 fn visit_lifetime(&mut self, lt: &'tcx hir::Lifetime) {
936 if self.has_late_bound_regions.is_some() {
940 match self.tcx.named_region(lt.hir_id) {
941 Some(rl::Region::Static) | Some(rl::Region::EarlyBound(..)) => {}
942 Some(rl::Region::LateBound(debruijn, _, _))
943 | Some(rl::Region::LateBoundAnon(debruijn, _))
944 if debruijn < self.outer_index => {}
945 Some(rl::Region::LateBound(..))
946 | Some(rl::Region::LateBoundAnon(..))
947 | Some(rl::Region::Free(..))
949 self.has_late_bound_regions = Some(lt.span);
955 fn has_late_bound_regions<'tcx>(
957 generics: &'tcx hir::Generics<'tcx>,
958 decl: &'tcx hir::FnDecl<'tcx>,
960 let mut visitor = LateBoundRegionsDetector {
962 outer_index: ty::INNERMOST,
963 has_late_bound_regions: None,
965 for param in generics.params {
966 if let GenericParamKind::Lifetime { .. } = param.kind {
967 if tcx.is_late_bound(param.hir_id) {
968 return Some(param.span);
972 visitor.visit_fn_decl(decl);
973 visitor.has_late_bound_regions
977 Node::TraitItem(item) => match item.kind {
978 hir::TraitItemKind::Method(ref sig, _) => {
979 has_late_bound_regions(tcx, &item.generics, &sig.decl)
983 Node::ImplItem(item) => match item.kind {
984 hir::ImplItemKind::Method(ref sig, _) => {
985 has_late_bound_regions(tcx, &item.generics, &sig.decl)
989 Node::ForeignItem(item) => match item.kind {
990 hir::ForeignItemKind::Fn(ref fn_decl, _, ref generics) => {
991 has_late_bound_regions(tcx, generics, fn_decl)
995 Node::Item(item) => match item.kind {
996 hir::ItemKind::Fn(ref sig, .., ref generics, _) => {
997 has_late_bound_regions(tcx, generics, &sig.decl)
1005 fn generics_of(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::Generics {
1008 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1010 let node = tcx.hir().get(hir_id);
1011 let parent_def_id = match node {
1013 | Node::TraitItem(_)
1016 | Node::Field(_) => {
1017 let parent_id = tcx.hir().get_parent_item(hir_id);
1018 Some(tcx.hir().local_def_id(parent_id))
1020 // FIXME(#43408) enable this always when we get lazy normalization.
1021 Node::AnonConst(_) => {
1022 // HACK(eddyb) this provides the correct generics when
1023 // `feature(const_generics)` is enabled, so that const expressions
1024 // used with const generics, e.g. `Foo<{N+1}>`, can work at all.
1025 if tcx.features().const_generics {
1026 let parent_id = tcx.hir().get_parent_item(hir_id);
1027 Some(tcx.hir().local_def_id(parent_id))
1032 Node::Expr(&hir::Expr { kind: hir::ExprKind::Closure(..), .. }) => {
1033 Some(tcx.closure_base_def_id(def_id))
1035 Node::Item(item) => match item.kind {
1036 ItemKind::OpaqueTy(hir::OpaqueTy { impl_trait_fn, .. }) => impl_trait_fn,
1042 let mut opt_self = None;
1043 let mut allow_defaults = false;
1045 let no_generics = hir::Generics::empty();
1046 let ast_generics = match node {
1047 Node::TraitItem(item) => &item.generics,
1049 Node::ImplItem(item) => &item.generics,
1051 Node::Item(item) => {
1053 ItemKind::Fn(.., ref generics, _) | ItemKind::Impl { ref generics, .. } => generics,
1055 ItemKind::TyAlias(_, ref generics)
1056 | ItemKind::Enum(_, ref generics)
1057 | ItemKind::Struct(_, ref generics)
1058 | ItemKind::OpaqueTy(hir::OpaqueTy { ref generics, .. })
1059 | ItemKind::Union(_, ref generics) => {
1060 allow_defaults = true;
1064 ItemKind::Trait(_, _, ref generics, ..)
1065 | ItemKind::TraitAlias(ref generics, ..) => {
1066 // Add in the self type parameter.
1068 // Something of a hack: use the node id for the trait, also as
1069 // the node id for the Self type parameter.
1070 let param_id = item.hir_id;
1072 opt_self = Some(ty::GenericParamDef {
1074 name: kw::SelfUpper,
1075 def_id: tcx.hir().local_def_id(param_id),
1076 pure_wrt_drop: false,
1077 kind: ty::GenericParamDefKind::Type {
1079 object_lifetime_default: rl::Set1::Empty,
1084 allow_defaults = true;
1092 Node::ForeignItem(item) => match item.kind {
1093 ForeignItemKind::Static(..) => &no_generics,
1094 ForeignItemKind::Fn(_, _, ref generics) => generics,
1095 ForeignItemKind::Type => &no_generics,
1101 let has_self = opt_self.is_some();
1102 let mut parent_has_self = false;
1103 let mut own_start = has_self as u32;
1104 let parent_count = parent_def_id.map_or(0, |def_id| {
1105 let generics = tcx.generics_of(def_id);
1106 assert_eq!(has_self, false);
1107 parent_has_self = generics.has_self;
1108 own_start = generics.count() as u32;
1109 generics.parent_count + generics.params.len()
1112 let mut params: Vec<_> = opt_self.into_iter().collect();
1114 let early_lifetimes = early_bound_lifetimes_from_generics(tcx, ast_generics);
1115 params.extend(early_lifetimes.enumerate().map(|(i, param)| ty::GenericParamDef {
1116 name: param.name.ident().name,
1117 index: own_start + i as u32,
1118 def_id: tcx.hir().local_def_id(param.hir_id),
1119 pure_wrt_drop: param.pure_wrt_drop,
1120 kind: ty::GenericParamDefKind::Lifetime,
1123 let object_lifetime_defaults = tcx.object_lifetime_defaults(hir_id);
1125 // Now create the real type parameters.
1126 let type_start = own_start - has_self as u32 + params.len() as u32;
1128 params.extend(ast_generics.params.iter().filter_map(|param| {
1129 let kind = match param.kind {
1130 GenericParamKind::Type { ref default, synthetic, .. } => {
1131 if !allow_defaults && default.is_some() {
1132 if !tcx.features().default_type_parameter_fallback {
1134 lint::builtin::INVALID_TYPE_PARAM_DEFAULT,
1138 "defaults for type parameters are only allowed in \
1139 `struct`, `enum`, `type`, or `trait` definitions."
1145 ty::GenericParamDefKind::Type {
1146 has_default: default.is_some(),
1147 object_lifetime_default: object_lifetime_defaults
1149 .map_or(rl::Set1::Empty, |o| o[i]),
1153 GenericParamKind::Const { .. } => ty::GenericParamDefKind::Const,
1157 let param_def = ty::GenericParamDef {
1158 index: type_start + i as u32,
1159 name: param.name.ident().name,
1160 def_id: tcx.hir().local_def_id(param.hir_id),
1161 pure_wrt_drop: param.pure_wrt_drop,
1168 // provide junk type parameter defs - the only place that
1169 // cares about anything but the length is instantiation,
1170 // and we don't do that for closures.
1171 if let Node::Expr(&hir::Expr { kind: hir::ExprKind::Closure(.., gen), .. }) = node {
1172 let dummy_args = if gen.is_some() {
1173 &["<yield_ty>", "<return_ty>", "<witness>"][..]
1175 &["<closure_kind>", "<closure_signature>"][..]
1178 params.extend(dummy_args.iter().enumerate().map(|(i, &arg)| ty::GenericParamDef {
1179 index: type_start + i as u32,
1180 name: Symbol::intern(arg),
1182 pure_wrt_drop: false,
1183 kind: ty::GenericParamDefKind::Type {
1185 object_lifetime_default: rl::Set1::Empty,
1190 if let Some(upvars) = tcx.upvars(def_id) {
1191 params.extend(upvars.iter().zip((dummy_args.len() as u32)..).map(|(_, i)| {
1192 ty::GenericParamDef {
1193 index: type_start + i,
1194 name: Symbol::intern("<upvar>"),
1196 pure_wrt_drop: false,
1197 kind: ty::GenericParamDefKind::Type {
1199 object_lifetime_default: rl::Set1::Empty,
1207 let param_def_id_to_index = params.iter().map(|param| (param.def_id, param.index)).collect();
1209 tcx.arena.alloc(ty::Generics {
1210 parent: parent_def_id,
1213 param_def_id_to_index,
1214 has_self: has_self || parent_has_self,
1215 has_late_bound_regions: has_late_bound_regions(tcx, node),
1219 fn report_assoc_ty_on_inherent_impl(tcx: TyCtxt<'_>, span: Span) {
1224 "associated types are not yet supported in inherent impls (see #8995)"
1229 fn infer_placeholder_type(
1232 body_id: hir::BodyId,
1236 let ty = tcx.diagnostic_only_typeck_tables_of(def_id).node_type(body_id.hir_id);
1238 // If this came from a free `const` or `static mut?` item,
1239 // then the user may have written e.g. `const A = 42;`.
1240 // In this case, the parser has stashed a diagnostic for
1241 // us to improve in typeck so we do that now.
1242 match tcx.sess.diagnostic().steal_diagnostic(span, StashKey::ItemNoType) {
1244 // The parser provided a sub-optimal `HasPlaceholders` suggestion for the type.
1245 // We are typeck and have the real type, so remove that and suggest the actual type.
1246 err.suggestions.clear();
1247 err.span_suggestion(
1249 "provide a type for the item",
1250 format!("{}: {}", item_ident, ty),
1251 Applicability::MachineApplicable,
1256 let mut diag = bad_placeholder_type(tcx, vec![span]);
1257 if ty != tcx.types.err {
1258 diag.span_suggestion(
1260 "replace `_` with the correct type",
1262 Applicability::MaybeIncorrect,
1272 fn type_of(tcx: TyCtxt<'_>, def_id: DefId) -> Ty<'_> {
1275 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1277 let icx = ItemCtxt::new(tcx, def_id);
1279 match tcx.hir().get(hir_id) {
1280 Node::TraitItem(item) => match item.kind {
1281 TraitItemKind::Method(..) => {
1282 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1283 tcx.mk_fn_def(def_id, substs)
1285 TraitItemKind::Const(ref ty, body_id) => body_id
1286 .and_then(|body_id| {
1287 if is_suggestable_infer_ty(ty) {
1288 Some(infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident))
1293 .unwrap_or_else(|| icx.to_ty(ty)),
1294 TraitItemKind::Type(_, Some(ref ty)) => icx.to_ty(ty),
1295 TraitItemKind::Type(_, None) => {
1296 span_bug!(item.span, "associated type missing default");
1300 Node::ImplItem(item) => match item.kind {
1301 ImplItemKind::Method(..) => {
1302 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1303 tcx.mk_fn_def(def_id, substs)
1305 ImplItemKind::Const(ref ty, body_id) => {
1306 if is_suggestable_infer_ty(ty) {
1307 infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident)
1312 ImplItemKind::OpaqueTy(_) => {
1313 if tcx.impl_trait_ref(tcx.hir().get_parent_did(hir_id)).is_none() {
1314 report_assoc_ty_on_inherent_impl(tcx, item.span);
1317 find_opaque_ty_constraints(tcx, def_id)
1319 ImplItemKind::TyAlias(ref ty) => {
1320 if tcx.impl_trait_ref(tcx.hir().get_parent_did(hir_id)).is_none() {
1321 report_assoc_ty_on_inherent_impl(tcx, item.span);
1328 Node::Item(item) => {
1330 ItemKind::Static(ref ty, .., body_id) | ItemKind::Const(ref ty, body_id) => {
1331 if is_suggestable_infer_ty(ty) {
1332 infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident)
1337 ItemKind::TyAlias(ref self_ty, _) | ItemKind::Impl { ref self_ty, .. } => {
1340 ItemKind::Fn(..) => {
1341 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1342 tcx.mk_fn_def(def_id, substs)
1344 ItemKind::Enum(..) | ItemKind::Struct(..) | ItemKind::Union(..) => {
1345 let def = tcx.adt_def(def_id);
1346 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1347 tcx.mk_adt(def, substs)
1349 ItemKind::OpaqueTy(hir::OpaqueTy { impl_trait_fn: None, .. }) => {
1350 find_opaque_ty_constraints(tcx, def_id)
1352 // Opaque types desugared from `impl Trait`.
1353 ItemKind::OpaqueTy(hir::OpaqueTy { impl_trait_fn: Some(owner), .. }) => {
1354 tcx.typeck_tables_of(owner)
1355 .concrete_opaque_types
1357 .map(|opaque| opaque.concrete_type)
1358 .unwrap_or_else(|| {
1359 // This can occur if some error in the
1360 // owner fn prevented us from populating
1361 // the `concrete_opaque_types` table.
1362 tcx.sess.delay_span_bug(
1365 "owner {:?} has no opaque type for {:?} in its tables",
1373 | ItemKind::TraitAlias(..)
1375 | ItemKind::ForeignMod(..)
1376 | ItemKind::GlobalAsm(..)
1377 | ItemKind::ExternCrate(..)
1378 | ItemKind::Use(..) => {
1381 "compute_type_of_item: unexpected item type: {:?}",
1388 Node::ForeignItem(foreign_item) => match foreign_item.kind {
1389 ForeignItemKind::Fn(..) => {
1390 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1391 tcx.mk_fn_def(def_id, substs)
1393 ForeignItemKind::Static(ref t, _) => icx.to_ty(t),
1394 ForeignItemKind::Type => tcx.mk_foreign(def_id),
1397 Node::Ctor(&ref def) | Node::Variant(hir::Variant { data: ref def, .. }) => match *def {
1398 VariantData::Unit(..) | VariantData::Struct(..) => {
1399 tcx.type_of(tcx.hir().get_parent_did(hir_id))
1401 VariantData::Tuple(..) => {
1402 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1403 tcx.mk_fn_def(def_id, substs)
1407 Node::Field(field) => icx.to_ty(&field.ty),
1409 Node::Expr(&hir::Expr { kind: hir::ExprKind::Closure(.., gen), .. }) => {
1411 return tcx.typeck_tables_of(def_id).node_type(hir_id);
1414 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1415 tcx.mk_closure(def_id, substs)
1418 Node::AnonConst(_) => {
1419 let parent_node = tcx.hir().get(tcx.hir().get_parent_node(hir_id));
1421 Node::Ty(&hir::Ty { kind: hir::TyKind::Array(_, ref constant), .. })
1422 | Node::Ty(&hir::Ty { kind: hir::TyKind::Typeof(ref constant), .. })
1423 | Node::Expr(&hir::Expr { kind: ExprKind::Repeat(_, ref constant), .. })
1424 if constant.hir_id == hir_id =>
1429 Node::Variant(Variant { disr_expr: Some(ref e), .. }) if e.hir_id == hir_id => {
1430 tcx.adt_def(tcx.hir().get_parent_did(hir_id)).repr.discr_type().to_ty(tcx)
1433 Node::Ty(&hir::Ty { kind: hir::TyKind::Path(_), .. })
1434 | Node::Expr(&hir::Expr { kind: ExprKind::Struct(..), .. })
1435 | Node::Expr(&hir::Expr { kind: ExprKind::Path(_), .. })
1436 | Node::TraitRef(..) => {
1437 let path = match parent_node {
1439 kind: hir::TyKind::Path(QPath::Resolved(_, ref path)),
1442 | Node::Expr(&hir::Expr {
1443 kind: ExprKind::Path(QPath::Resolved(_, ref path)),
1445 }) => Some(&**path),
1446 Node::Expr(&hir::Expr { kind: ExprKind::Struct(ref path, ..), .. }) => {
1447 if let QPath::Resolved(_, ref path) = **path {
1453 Node::TraitRef(&hir::TraitRef { ref path, .. }) => Some(&**path),
1457 if let Some(path) = path {
1458 let arg_index = path
1461 .filter_map(|seg| seg.args.as_ref())
1462 .map(|generic_args| generic_args.args.as_ref())
1465 .filter(|arg| arg.is_const())
1467 .filter(|(_, arg)| arg.id() == hir_id)
1468 .map(|(index, _)| index)
1471 .unwrap_or_else(|| {
1472 bug!("no arg matching AnonConst in path");
1475 // We've encountered an `AnonConst` in some path, so we need to
1476 // figure out which generic parameter it corresponds to and return
1477 // the relevant type.
1478 let generics = match path.res {
1479 Res::Def(DefKind::Ctor(..), def_id) => {
1480 tcx.generics_of(tcx.parent(def_id).unwrap())
1482 Res::Def(_, def_id) => tcx.generics_of(def_id),
1483 Res::Err => return tcx.types.err,
1485 tcx.sess.delay_span_bug(
1487 &format!("unexpected const parent path def {:?}", res,),
1489 return tcx.types.err;
1497 if let ty::GenericParamDefKind::Const = param.kind {
1504 .map(|param| tcx.type_of(param.def_id))
1505 // This is no generic parameter associated with the arg. This is
1506 // probably from an extra arg where one is not needed.
1507 .unwrap_or(tcx.types.err)
1509 tcx.sess.delay_span_bug(
1511 &format!("unexpected const parent path {:?}", parent_node,),
1513 return tcx.types.err;
1518 tcx.sess.delay_span_bug(
1520 &format!("unexpected const parent in type_of_def_id(): {:?}", x),
1527 Node::GenericParam(param) => match ¶m.kind {
1528 hir::GenericParamKind::Type { default: Some(ref ty), .. } => icx.to_ty(ty),
1529 hir::GenericParamKind::Const { ty: ref hir_ty, .. } => {
1530 let ty = icx.to_ty(hir_ty);
1531 if !tcx.features().const_compare_raw_pointers {
1532 let err = match ty.peel_refs().kind {
1533 ty::FnPtr(_) => Some("function pointers"),
1534 ty::RawPtr(_) => Some("raw pointers"),
1537 if let Some(unsupported_type) = err {
1539 &tcx.sess.parse_sess,
1540 sym::const_compare_raw_pointers,
1543 "using {} as const generic parameters is unstable",
1550 if traits::search_for_structural_match_violation(param.hir_id, param.span, tcx, ty)
1557 "the types of const generic parameters must derive `PartialEq` and `Eq`",
1561 format!("`{}` doesn't derive both `PartialEq` and `Eq`", ty),
1567 x => bug!("unexpected non-type Node::GenericParam: {:?}", x),
1571 bug!("unexpected sort of node in type_of_def_id(): {:?}", x);
1576 fn find_opaque_ty_constraints(tcx: TyCtxt<'_>, def_id: DefId) -> Ty<'_> {
1577 use rustc_hir::{ImplItem, Item, TraitItem};
1579 debug!("find_opaque_ty_constraints({:?})", def_id);
1581 struct ConstraintLocator<'tcx> {
1584 // (first found type span, actual type, mapping from the opaque type's generic
1585 // parameters to the concrete type's generic parameters)
1587 // The mapping is an index for each use site of a generic parameter in the concrete type
1589 // The indices index into the generic parameters on the opaque type.
1590 found: Option<(Span, Ty<'tcx>, Vec<usize>)>,
1593 impl ConstraintLocator<'tcx> {
1594 fn check(&mut self, def_id: DefId) {
1595 // Don't try to check items that cannot possibly constrain the type.
1596 if !self.tcx.has_typeck_tables(def_id) {
1598 "find_opaque_ty_constraints: no constraint for `{:?}` at `{:?}`: no tables",
1599 self.def_id, def_id,
1603 let ty = self.tcx.typeck_tables_of(def_id).concrete_opaque_types.get(&self.def_id);
1604 if let Some(ty::ResolvedOpaqueTy { concrete_type, substs }) = ty {
1606 "find_opaque_ty_constraints: found constraint for `{:?}` at `{:?}`: {:?}",
1607 self.def_id, def_id, ty,
1610 // FIXME(oli-obk): trace the actual span from inference to improve errors.
1611 let span = self.tcx.def_span(def_id);
1612 // used to quickly look up the position of a generic parameter
1613 let mut index_map: FxHashMap<ty::ParamTy, usize> = FxHashMap::default();
1614 // Skipping binder is ok, since we only use this to find generic parameters and
1616 for (idx, subst) in substs.iter().enumerate() {
1617 if let GenericArgKind::Type(ty) = subst.unpack() {
1618 if let ty::Param(p) = ty.kind {
1619 if index_map.insert(p, idx).is_some() {
1620 // There was already an entry for `p`, meaning a generic parameter
1622 self.tcx.sess.span_err(
1625 "defining opaque type use restricts opaque \
1626 type by using the generic parameter `{}` twice",
1633 self.tcx.sess.delay_span_bug(
1636 "non-defining opaque ty use in defining scope: {:?}, {:?}",
1637 concrete_type, substs,
1643 // Compute the index within the opaque type for each generic parameter used in
1644 // the concrete type.
1645 let indices = concrete_type
1646 .subst(self.tcx, substs)
1648 .filter_map(|t| match &t.kind {
1649 ty::Param(p) => Some(*index_map.get(p).unwrap()),
1653 let is_param = |ty: Ty<'_>| match ty.kind {
1654 ty::Param(_) => true,
1657 let bad_substs: Vec<_> =
1658 substs.types().enumerate().filter(|(_, ty)| !is_param(ty)).collect();
1659 if !bad_substs.is_empty() {
1660 let identity_substs = InternalSubsts::identity_for_item(self.tcx, self.def_id);
1661 for (i, bad_subst) in bad_substs {
1662 self.tcx.sess.span_err(
1665 "defining opaque type use does not fully define opaque type: \
1666 generic parameter `{}` is specified as concrete type `{}`",
1667 identity_substs.type_at(i),
1672 } else if let Some((prev_span, prev_ty, ref prev_indices)) = self.found {
1673 let mut ty = concrete_type.walk().fuse();
1674 let mut p_ty = prev_ty.walk().fuse();
1675 let iter_eq = (&mut ty).zip(&mut p_ty).all(|(t, p)| match (&t.kind, &p.kind) {
1676 // Type parameters are equal to any other type parameter for the purpose of
1677 // concrete type equality, as it is possible to obtain the same type just
1678 // by passing matching parameters to a function.
1679 (ty::Param(_), ty::Param(_)) => true,
1682 if !iter_eq || ty.next().is_some() || p_ty.next().is_some() {
1683 debug!("find_opaque_ty_constraints: span={:?}", span);
1684 // Found different concrete types for the opaque type.
1685 let mut err = self.tcx.sess.struct_span_err(
1687 "concrete type differs from previous defining opaque type use",
1691 format!("expected `{}`, got `{}`", prev_ty, concrete_type),
1693 err.span_note(prev_span, "previous use here");
1695 } else if indices != *prev_indices {
1696 // Found "same" concrete types, but the generic parameter order differs.
1697 let mut err = self.tcx.sess.struct_span_err(
1699 "concrete type's generic parameters differ from previous defining use",
1701 use std::fmt::Write;
1702 let mut s = String::new();
1703 write!(s, "expected [").unwrap();
1704 let list = |s: &mut String, indices: &Vec<usize>| {
1705 let mut indices = indices.iter().cloned();
1706 if let Some(first) = indices.next() {
1707 write!(s, "`{}`", substs[first]).unwrap();
1709 write!(s, ", `{}`", substs[i]).unwrap();
1713 list(&mut s, prev_indices);
1714 write!(s, "], got [").unwrap();
1715 list(&mut s, &indices);
1716 write!(s, "]").unwrap();
1717 err.span_label(span, s);
1718 err.span_note(prev_span, "previous use here");
1722 self.found = Some((span, concrete_type, indices));
1726 "find_opaque_ty_constraints: no constraint for `{:?}` at `{:?}`",
1727 self.def_id, def_id,
1733 impl<'tcx> intravisit::Visitor<'tcx> for ConstraintLocator<'tcx> {
1734 type Map = Map<'tcx>;
1736 fn nested_visit_map(&mut self) -> intravisit::NestedVisitorMap<'_, Self::Map> {
1737 intravisit::NestedVisitorMap::All(&self.tcx.hir())
1739 fn visit_item(&mut self, it: &'tcx Item<'tcx>) {
1740 debug!("find_existential_constraints: visiting {:?}", it);
1741 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1742 // The opaque type itself or its children are not within its reveal scope.
1743 if def_id != self.def_id {
1745 intravisit::walk_item(self, it);
1748 fn visit_impl_item(&mut self, it: &'tcx ImplItem<'tcx>) {
1749 debug!("find_existential_constraints: visiting {:?}", it);
1750 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1751 // The opaque type itself or its children are not within its reveal scope.
1752 if def_id != self.def_id {
1754 intravisit::walk_impl_item(self, it);
1757 fn visit_trait_item(&mut self, it: &'tcx TraitItem<'tcx>) {
1758 debug!("find_existential_constraints: visiting {:?}", it);
1759 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1761 intravisit::walk_trait_item(self, it);
1765 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1766 let scope = tcx.hir().get_defining_scope(hir_id);
1767 let mut locator = ConstraintLocator { def_id, tcx, found: None };
1769 debug!("find_opaque_ty_constraints: scope={:?}", scope);
1771 if scope == hir::CRATE_HIR_ID {
1772 intravisit::walk_crate(&mut locator, tcx.hir().krate());
1774 debug!("find_opaque_ty_constraints: scope={:?}", tcx.hir().get(scope));
1775 match tcx.hir().get(scope) {
1776 // We explicitly call `visit_*` methods, instead of using `intravisit::walk_*` methods
1777 // This allows our visitor to process the defining item itself, causing
1778 // it to pick up any 'sibling' defining uses.
1780 // For example, this code:
1783 // type Blah = impl Debug;
1784 // let my_closure = || -> Blah { true };
1788 // requires us to explicitly process `foo()` in order
1789 // to notice the defining usage of `Blah`.
1790 Node::Item(ref it) => locator.visit_item(it),
1791 Node::ImplItem(ref it) => locator.visit_impl_item(it),
1792 Node::TraitItem(ref it) => locator.visit_trait_item(it),
1793 other => bug!("{:?} is not a valid scope for an opaque type item", other),
1797 match locator.found {
1798 Some((_, ty, _)) => ty,
1800 let span = tcx.def_span(def_id);
1801 tcx.sess.span_err(span, "could not find defining uses");
1807 fn are_suggestable_generic_args(generic_args: &[hir::GenericArg<'_>]) -> bool {
1810 .filter_map(|arg| match arg {
1811 hir::GenericArg::Type(ty) => Some(ty),
1814 .any(is_suggestable_infer_ty)
1817 /// Whether `ty` is a type with `_` placeholders that can be infered. Used in diagnostics only to
1818 /// use inference to provide suggestions for the appropriate type if possible.
1819 fn is_suggestable_infer_ty(ty: &hir::Ty<'_>) -> bool {
1823 Slice(ty) | Array(ty, _) => is_suggestable_infer_ty(ty),
1824 Tup(tys) => tys.iter().any(is_suggestable_infer_ty),
1825 Ptr(mut_ty) | Rptr(_, mut_ty) => is_suggestable_infer_ty(mut_ty.ty),
1826 Def(_, generic_args) => are_suggestable_generic_args(generic_args),
1827 Path(hir::QPath::TypeRelative(ty, segment)) => {
1828 is_suggestable_infer_ty(ty) || are_suggestable_generic_args(segment.generic_args().args)
1830 Path(hir::QPath::Resolved(ty_opt, hir::Path { segments, .. })) => {
1831 ty_opt.map_or(false, is_suggestable_infer_ty)
1834 .any(|segment| are_suggestable_generic_args(segment.generic_args().args))
1840 pub fn get_infer_ret_ty(output: &'hir hir::FunctionRetTy<'hir>) -> Option<&'hir hir::Ty<'hir>> {
1841 if let hir::FunctionRetTy::Return(ref ty) = output {
1842 if is_suggestable_infer_ty(ty) {
1849 fn fn_sig(tcx: TyCtxt<'_>, def_id: DefId) -> ty::PolyFnSig<'_> {
1850 use rustc_hir::Node::*;
1853 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1855 let icx = ItemCtxt::new(tcx, def_id);
1857 match tcx.hir().get(hir_id) {
1858 TraitItem(hir::TraitItem {
1859 kind: TraitItemKind::Method(sig, TraitMethod::Provided(_)),
1864 | ImplItem(hir::ImplItem { kind: ImplItemKind::Method(sig, _), ident, generics, .. })
1865 | Item(hir::Item { kind: ItemKind::Fn(sig, generics, _), ident, .. }) => {
1866 match get_infer_ret_ty(&sig.decl.output) {
1868 let fn_sig = tcx.typeck_tables_of(def_id).liberated_fn_sigs()[hir_id];
1869 let mut visitor = PlaceholderHirTyCollector::default();
1870 visitor.visit_ty(ty);
1871 let mut diag = bad_placeholder_type(tcx, visitor.0);
1872 let ret_ty = fn_sig.output();
1873 if ret_ty != tcx.types.err {
1874 diag.span_suggestion(
1876 "replace with the correct return type",
1878 Applicability::MaybeIncorrect,
1882 ty::Binder::bind(fn_sig)
1884 None => AstConv::ty_of_fn(
1886 sig.header.unsafety,
1889 &generics.params[..],
1895 TraitItem(hir::TraitItem {
1896 kind: TraitItemKind::Method(FnSig { header, decl }, _),
1900 }) => AstConv::ty_of_fn(
1905 &generics.params[..],
1909 ForeignItem(&hir::ForeignItem { kind: ForeignItemKind::Fn(ref fn_decl, _, _), .. }) => {
1910 let abi = tcx.hir().get_foreign_abi(hir_id);
1911 compute_sig_of_foreign_fn_decl(tcx, def_id, fn_decl, abi)
1914 Ctor(data) | Variant(hir::Variant { data, .. }) if data.ctor_hir_id().is_some() => {
1915 let ty = tcx.type_of(tcx.hir().get_parent_did(hir_id));
1917 data.fields().iter().map(|f| tcx.type_of(tcx.hir().local_def_id(f.hir_id)));
1918 ty::Binder::bind(tcx.mk_fn_sig(
1922 hir::Unsafety::Normal,
1927 Expr(&hir::Expr { kind: hir::ExprKind::Closure(..), .. }) => {
1928 // Closure signatures are not like other function
1929 // signatures and cannot be accessed through `fn_sig`. For
1930 // example, a closure signature excludes the `self`
1931 // argument. In any case they are embedded within the
1932 // closure type as part of the `ClosureSubsts`.
1935 // the signature of a closure, you should use the
1936 // `closure_sig` method on the `ClosureSubsts`:
1938 // closure_substs.sig(def_id, tcx)
1940 // or, inside of an inference context, you can use
1942 // infcx.closure_sig(def_id, closure_substs)
1943 bug!("to get the signature of a closure, use `closure_sig()` not `fn_sig()`");
1947 bug!("unexpected sort of node in fn_sig(): {:?}", x);
1952 fn impl_trait_ref(tcx: TyCtxt<'_>, def_id: DefId) -> Option<ty::TraitRef<'_>> {
1953 let icx = ItemCtxt::new(tcx, def_id);
1955 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1956 match tcx.hir().expect_item(hir_id).kind {
1957 hir::ItemKind::Impl { ref of_trait, .. } => of_trait.as_ref().map(|ast_trait_ref| {
1958 let selfty = tcx.type_of(def_id);
1959 AstConv::instantiate_mono_trait_ref(&icx, ast_trait_ref, selfty)
1965 fn impl_polarity(tcx: TyCtxt<'_>, def_id: DefId) -> ty::ImplPolarity {
1966 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1967 let is_rustc_reservation = tcx.has_attr(def_id, sym::rustc_reservation_impl);
1968 let item = tcx.hir().expect_item(hir_id);
1970 hir::ItemKind::Impl { polarity: hir::ImplPolarity::Negative, .. } => {
1971 if is_rustc_reservation {
1972 tcx.sess.span_err(item.span, "reservation impls can't be negative");
1974 ty::ImplPolarity::Negative
1976 hir::ItemKind::Impl { polarity: hir::ImplPolarity::Positive, of_trait: None, .. } => {
1977 if is_rustc_reservation {
1978 tcx.sess.span_err(item.span, "reservation impls can't be inherent");
1980 ty::ImplPolarity::Positive
1982 hir::ItemKind::Impl {
1983 polarity: hir::ImplPolarity::Positive, of_trait: Some(_), ..
1985 if is_rustc_reservation {
1986 ty::ImplPolarity::Reservation
1988 ty::ImplPolarity::Positive
1991 ref item => bug!("impl_polarity: {:?} not an impl", item),
1995 /// Returns the early-bound lifetimes declared in this generics
1996 /// listing. For anything other than fns/methods, this is just all
1997 /// the lifetimes that are declared. For fns or methods, we have to
1998 /// screen out those that do not appear in any where-clauses etc using
1999 /// `resolve_lifetime::early_bound_lifetimes`.
2000 fn early_bound_lifetimes_from_generics<'a, 'tcx: 'a>(
2002 generics: &'a hir::Generics<'a>,
2003 ) -> impl Iterator<Item = &'a hir::GenericParam<'a>> + Captures<'tcx> {
2004 generics.params.iter().filter(move |param| match param.kind {
2005 GenericParamKind::Lifetime { .. } => !tcx.is_late_bound(param.hir_id),
2010 /// Returns a list of type predicates for the definition with ID `def_id`, including inferred
2011 /// lifetime constraints. This includes all predicates returned by `explicit_predicates_of`, plus
2012 /// inferred constraints concerning which regions outlive other regions.
2013 fn predicates_defined_on(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2014 debug!("predicates_defined_on({:?})", def_id);
2015 let mut result = tcx.explicit_predicates_of(def_id);
2016 debug!("predicates_defined_on: explicit_predicates_of({:?}) = {:?}", def_id, result,);
2017 let inferred_outlives = tcx.inferred_outlives_of(def_id);
2018 if !inferred_outlives.is_empty() {
2020 "predicates_defined_on: inferred_outlives_of({:?}) = {:?}",
2021 def_id, inferred_outlives,
2023 if result.predicates.is_empty() {
2024 result.predicates = inferred_outlives;
2026 result.predicates = tcx
2028 .alloc_from_iter(result.predicates.iter().chain(inferred_outlives).copied());
2031 debug!("predicates_defined_on({:?}) = {:?}", def_id, result);
2035 /// Returns a list of all type predicates (explicit and implicit) for the definition with
2036 /// ID `def_id`. This includes all predicates returned by `predicates_defined_on`, plus
2037 /// `Self: Trait` predicates for traits.
2038 fn predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2039 let mut result = tcx.predicates_defined_on(def_id);
2041 if tcx.is_trait(def_id) {
2042 // For traits, add `Self: Trait` predicate. This is
2043 // not part of the predicates that a user writes, but it
2044 // is something that one must prove in order to invoke a
2045 // method or project an associated type.
2047 // In the chalk setup, this predicate is not part of the
2048 // "predicates" for a trait item. But it is useful in
2049 // rustc because if you directly (e.g.) invoke a trait
2050 // method like `Trait::method(...)`, you must naturally
2051 // prove that the trait applies to the types that were
2052 // used, and adding the predicate into this list ensures
2053 // that this is done.
2054 let span = tcx.def_span(def_id);
2056 tcx.arena.alloc_from_iter(result.predicates.iter().copied().chain(std::iter::once((
2057 ty::TraitRef::identity(tcx, def_id).to_predicate(),
2061 debug!("predicates_of(def_id={:?}) = {:?}", def_id, result);
2065 /// Returns a list of user-specified type predicates for the definition with ID `def_id`.
2066 /// N.B., this does not include any implied/inferred constraints.
2067 fn explicit_predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2068 use rustc_data_structures::fx::FxHashSet;
2071 debug!("explicit_predicates_of(def_id={:?})", def_id);
2073 /// A data structure with unique elements, which preserves order of insertion.
2074 /// Preserving the order of insertion is important here so as not to break
2075 /// compile-fail UI tests.
2076 // FIXME(eddyb) just use `IndexSet` from `indexmap`.
2077 struct UniquePredicates<'tcx> {
2078 predicates: Vec<(ty::Predicate<'tcx>, Span)>,
2079 uniques: FxHashSet<(ty::Predicate<'tcx>, Span)>,
2082 impl<'tcx> UniquePredicates<'tcx> {
2084 UniquePredicates { predicates: vec![], uniques: FxHashSet::default() }
2087 fn push(&mut self, value: (ty::Predicate<'tcx>, Span)) {
2088 if self.uniques.insert(value) {
2089 self.predicates.push(value);
2093 fn extend<I: IntoIterator<Item = (ty::Predicate<'tcx>, Span)>>(&mut self, iter: I) {
2100 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
2101 let node = tcx.hir().get(hir_id);
2103 let mut is_trait = None;
2104 let mut is_default_impl_trait = None;
2106 let icx = ItemCtxt::new(tcx, def_id);
2108 const NO_GENERICS: &hir::Generics<'_> = &hir::Generics::empty();
2110 let mut predicates = UniquePredicates::new();
2112 let ast_generics = match node {
2113 Node::TraitItem(item) => &item.generics,
2115 Node::ImplItem(item) => match item.kind {
2116 ImplItemKind::OpaqueTy(ref bounds) => {
2117 ty::print::with_no_queries(|| {
2118 let substs = InternalSubsts::identity_for_item(tcx, def_id);
2119 let opaque_ty = tcx.mk_opaque(def_id, substs);
2121 "explicit_predicates_of({:?}): created opaque type {:?}",
2125 // Collect the bounds, i.e., the `A + B + 'c` in `impl A + B + 'c`.
2126 let bounds = AstConv::compute_bounds(
2130 SizedByDefault::Yes,
2131 tcx.def_span(def_id),
2134 predicates.extend(bounds.predicates(tcx, opaque_ty));
2138 _ => &item.generics,
2141 Node::Item(item) => {
2143 ItemKind::Impl { defaultness, ref generics, .. } => {
2144 if defaultness.is_default() {
2145 is_default_impl_trait = tcx.impl_trait_ref(def_id);
2149 ItemKind::Fn(.., ref generics, _)
2150 | ItemKind::TyAlias(_, ref generics)
2151 | ItemKind::Enum(_, ref generics)
2152 | ItemKind::Struct(_, ref generics)
2153 | ItemKind::Union(_, ref generics) => generics,
2155 ItemKind::Trait(_, _, ref generics, .., items) => {
2156 is_trait = Some((ty::TraitRef::identity(tcx, def_id), items));
2159 ItemKind::TraitAlias(ref generics, _) => {
2160 is_trait = Some((ty::TraitRef::identity(tcx, def_id), &[]));
2163 ItemKind::OpaqueTy(OpaqueTy {
2169 let bounds_predicates = ty::print::with_no_queries(|| {
2170 let substs = InternalSubsts::identity_for_item(tcx, def_id);
2171 let opaque_ty = tcx.mk_opaque(def_id, substs);
2173 // Collect the bounds, i.e., the `A + B + 'c` in `impl A + B + 'c`.
2174 let bounds = AstConv::compute_bounds(
2178 SizedByDefault::Yes,
2179 tcx.def_span(def_id),
2182 bounds.predicates(tcx, opaque_ty)
2184 if impl_trait_fn.is_some() {
2186 return ty::GenericPredicates {
2188 predicates: tcx.arena.alloc_from_iter(bounds_predicates),
2191 // named opaque types
2192 predicates.extend(bounds_predicates);
2201 Node::ForeignItem(item) => match item.kind {
2202 ForeignItemKind::Static(..) => NO_GENERICS,
2203 ForeignItemKind::Fn(_, _, ref generics) => generics,
2204 ForeignItemKind::Type => NO_GENERICS,
2210 let generics = tcx.generics_of(def_id);
2211 let parent_count = generics.parent_count as u32;
2212 let has_own_self = generics.has_self && parent_count == 0;
2214 // Below we'll consider the bounds on the type parameters (including `Self`)
2215 // and the explicit where-clauses, but to get the full set of predicates
2216 // on a trait we need to add in the supertrait bounds and bounds found on
2217 // associated types.
2218 if let Some((_trait_ref, _)) = is_trait {
2219 predicates.extend(tcx.super_predicates_of(def_id).predicates.iter().cloned());
2222 // In default impls, we can assume that the self type implements
2223 // the trait. So in:
2225 // default impl Foo for Bar { .. }
2227 // we add a default where clause `Foo: Bar`. We do a similar thing for traits
2228 // (see below). Recall that a default impl is not itself an impl, but rather a
2229 // set of defaults that can be incorporated into another impl.
2230 if let Some(trait_ref) = is_default_impl_trait {
2231 predicates.push((trait_ref.to_poly_trait_ref().to_predicate(), tcx.def_span(def_id)));
2234 // Collect the region predicates that were declared inline as
2235 // well. In the case of parameters declared on a fn or method, we
2236 // have to be careful to only iterate over early-bound regions.
2237 let mut index = parent_count + has_own_self as u32;
2238 for param in early_bound_lifetimes_from_generics(tcx, ast_generics) {
2239 let region = tcx.mk_region(ty::ReEarlyBound(ty::EarlyBoundRegion {
2240 def_id: tcx.hir().local_def_id(param.hir_id),
2242 name: param.name.ident().name,
2247 GenericParamKind::Lifetime { .. } => {
2248 param.bounds.iter().for_each(|bound| match bound {
2249 hir::GenericBound::Outlives(lt) => {
2250 let bound = AstConv::ast_region_to_region(&icx, <, None);
2251 let outlives = ty::Binder::bind(ty::OutlivesPredicate(region, bound));
2252 predicates.push((outlives.to_predicate(), lt.span));
2261 // Collect the predicates that were written inline by the user on each
2262 // type parameter (e.g., `<T: Foo>`).
2263 for param in ast_generics.params {
2264 if let GenericParamKind::Type { .. } = param.kind {
2265 let name = param.name.ident().name;
2266 let param_ty = ty::ParamTy::new(index, name).to_ty(tcx);
2269 let sized = SizedByDefault::Yes;
2270 let bounds = AstConv::compute_bounds(&icx, param_ty, ¶m.bounds, sized, param.span);
2271 predicates.extend(bounds.predicates(tcx, param_ty));
2275 // Add in the bounds that appear in the where-clause.
2276 let where_clause = &ast_generics.where_clause;
2277 for predicate in where_clause.predicates {
2279 &hir::WherePredicate::BoundPredicate(ref bound_pred) => {
2280 let ty = icx.to_ty(&bound_pred.bounded_ty);
2282 // Keep the type around in a dummy predicate, in case of no bounds.
2283 // That way, `where Ty:` is not a complete noop (see #53696) and `Ty`
2284 // is still checked for WF.
2285 if bound_pred.bounds.is_empty() {
2286 if let ty::Param(_) = ty.kind {
2287 // This is a `where T:`, which can be in the HIR from the
2288 // transformation that moves `?Sized` to `T`'s declaration.
2289 // We can skip the predicate because type parameters are
2290 // trivially WF, but also we *should*, to avoid exposing
2291 // users who never wrote `where Type:,` themselves, to
2292 // compiler/tooling bugs from not handling WF predicates.
2294 let span = bound_pred.bounded_ty.span;
2295 let predicate = ty::OutlivesPredicate(ty, tcx.mk_region(ty::ReEmpty));
2297 ty::Predicate::TypeOutlives(ty::Binder::dummy(predicate)),
2303 for bound in bound_pred.bounds.iter() {
2305 &hir::GenericBound::Trait(ref poly_trait_ref, _) => {
2306 let mut bounds = Bounds::default();
2307 let _ = AstConv::instantiate_poly_trait_ref(
2313 predicates.extend(bounds.predicates(tcx, ty));
2316 &hir::GenericBound::Outlives(ref lifetime) => {
2317 let region = AstConv::ast_region_to_region(&icx, lifetime, None);
2318 let pred = ty::Binder::bind(ty::OutlivesPredicate(ty, region));
2319 predicates.push((ty::Predicate::TypeOutlives(pred), lifetime.span))
2325 &hir::WherePredicate::RegionPredicate(ref region_pred) => {
2326 let r1 = AstConv::ast_region_to_region(&icx, ®ion_pred.lifetime, None);
2327 predicates.extend(region_pred.bounds.iter().map(|bound| {
2328 let (r2, span) = match bound {
2329 hir::GenericBound::Outlives(lt) => {
2330 (AstConv::ast_region_to_region(&icx, lt, None), lt.span)
2334 let pred = ty::Binder::bind(ty::OutlivesPredicate(r1, r2));
2336 (ty::Predicate::RegionOutlives(pred), span)
2340 &hir::WherePredicate::EqPredicate(..) => {
2346 // Add predicates from associated type bounds.
2347 if let Some((self_trait_ref, trait_items)) = is_trait {
2348 predicates.extend(trait_items.iter().flat_map(|trait_item_ref| {
2349 associated_item_predicates(tcx, def_id, self_trait_ref, trait_item_ref)
2353 let mut predicates = predicates.predicates;
2355 // Subtle: before we store the predicates into the tcx, we
2356 // sort them so that predicates like `T: Foo<Item=U>` come
2357 // before uses of `U`. This avoids false ambiguity errors
2358 // in trait checking. See `setup_constraining_predicates`
2360 if let Node::Item(&Item { kind: ItemKind::Impl { .. }, .. }) = node {
2361 let self_ty = tcx.type_of(def_id);
2362 let trait_ref = tcx.impl_trait_ref(def_id);
2363 cgp::setup_constraining_predicates(
2367 &mut cgp::parameters_for_impl(self_ty, trait_ref),
2371 let result = ty::GenericPredicates {
2372 parent: generics.parent,
2373 predicates: tcx.arena.alloc_from_iter(predicates),
2375 debug!("explicit_predicates_of(def_id={:?}) = {:?}", def_id, result);
2379 fn associated_item_predicates(
2382 self_trait_ref: ty::TraitRef<'tcx>,
2383 trait_item_ref: &hir::TraitItemRef,
2384 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
2385 let trait_item = tcx.hir().trait_item(trait_item_ref.id);
2386 let item_def_id = tcx.hir().local_def_id(trait_item_ref.id.hir_id);
2387 let bounds = match trait_item.kind {
2388 hir::TraitItemKind::Type(ref bounds, _) => bounds,
2389 _ => return Vec::new(),
2392 let is_gat = !tcx.generics_of(item_def_id).params.is_empty();
2394 let mut had_error = false;
2396 let mut unimplemented_error = |arg_kind: &str| {
2401 &format!("{}-generic associated types are not yet implemented", arg_kind),
2403 .note("for more information, see https://github.com/rust-lang/rust/issues/44265")
2409 let mk_bound_param = |param: &ty::GenericParamDef, _: &_| {
2411 ty::GenericParamDefKind::Lifetime => tcx
2412 .mk_region(ty::RegionKind::ReLateBound(
2414 ty::BoundRegion::BrNamed(param.def_id, param.name),
2417 // FIXME(generic_associated_types): Use bound types and constants
2418 // once they are handled by the trait system.
2419 ty::GenericParamDefKind::Type { .. } => {
2420 unimplemented_error("type");
2421 tcx.types.err.into()
2423 ty::GenericParamDefKind::Const => {
2424 unimplemented_error("const");
2425 tcx.consts.err.into()
2430 let bound_substs = if is_gat {
2433 // trait X<'a, B, const C: usize> {
2434 // type T<'d, E, const F: usize>: Default;
2437 // We need to create predicates on the trait:
2439 // for<'d, E, const F: usize>
2440 // <Self as X<'a, B, const C: usize>>::T<'d, E, const F: usize>: Sized + Default
2442 // We substitute escaping bound parameters for the generic
2443 // arguments to the associated type which are then bound by
2444 // the `Binder` around the the predicate.
2446 // FIXME(generic_associated_types): Currently only lifetimes are handled.
2447 self_trait_ref.substs.extend_to(tcx, item_def_id, mk_bound_param)
2449 self_trait_ref.substs
2452 let assoc_ty = tcx.mk_projection(tcx.hir().local_def_id(trait_item.hir_id), bound_substs);
2454 let bounds = AstConv::compute_bounds(
2455 &ItemCtxt::new(tcx, def_id),
2458 SizedByDefault::Yes,
2462 let predicates = bounds.predicates(tcx, assoc_ty);
2465 // We use shifts to get the regions that we're substituting to
2466 // be bound by the binders in the `Predicate`s rather that
2468 let shifted_in = ty::fold::shift_vars(tcx, &predicates, 1);
2469 let substituted = shifted_in.subst(tcx, bound_substs);
2470 ty::fold::shift_out_vars(tcx, &substituted, 1)
2476 /// Converts a specific `GenericBound` from the AST into a set of
2477 /// predicates that apply to the self type. A vector is returned
2478 /// because this can be anywhere from zero predicates (`T: ?Sized` adds no
2479 /// predicates) to one (`T: Foo`) to many (`T: Bar<X = i32>` adds `T: Bar`
2480 /// and `<T as Bar>::X == i32`).
2481 fn predicates_from_bound<'tcx>(
2482 astconv: &dyn AstConv<'tcx>,
2484 bound: &'tcx hir::GenericBound<'tcx>,
2485 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
2487 hir::GenericBound::Trait(ref tr, hir::TraitBoundModifier::None) => {
2488 let mut bounds = Bounds::default();
2489 let _ = astconv.instantiate_poly_trait_ref(tr, param_ty, &mut bounds);
2490 bounds.predicates(astconv.tcx(), param_ty)
2492 hir::GenericBound::Outlives(ref lifetime) => {
2493 let region = astconv.ast_region_to_region(lifetime, None);
2494 let pred = ty::Binder::bind(ty::OutlivesPredicate(param_ty, region));
2495 vec![(ty::Predicate::TypeOutlives(pred), lifetime.span)]
2497 hir::GenericBound::Trait(_, hir::TraitBoundModifier::Maybe) => vec![],
2501 fn compute_sig_of_foreign_fn_decl<'tcx>(
2504 decl: &'tcx hir::FnDecl<'tcx>,
2506 ) -> ty::PolyFnSig<'tcx> {
2507 let unsafety = if abi == abi::Abi::RustIntrinsic {
2508 intrinsic_operation_unsafety(&tcx.item_name(def_id).as_str())
2510 hir::Unsafety::Unsafe
2512 let fty = AstConv::ty_of_fn(&ItemCtxt::new(tcx, def_id), unsafety, abi, decl, &[], None);
2514 // Feature gate SIMD types in FFI, since I am not sure that the
2515 // ABIs are handled at all correctly. -huonw
2516 if abi != abi::Abi::RustIntrinsic
2517 && abi != abi::Abi::PlatformIntrinsic
2518 && !tcx.features().simd_ffi
2520 let check = |ast_ty: &hir::Ty<'_>, ty: Ty<'_>| {
2526 "use of SIMD type `{}` in FFI is highly experimental and \
2527 may result in invalid code",
2528 tcx.hir().hir_to_pretty_string(ast_ty.hir_id)
2531 .help("add `#![feature(simd_ffi)]` to the crate attributes to enable")
2535 for (input, ty) in decl.inputs.iter().zip(*fty.inputs().skip_binder()) {
2538 if let hir::FunctionRetTy::Return(ref ty) = decl.output {
2539 check(&ty, *fty.output().skip_binder())
2546 fn is_foreign_item(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
2547 match tcx.hir().get_if_local(def_id) {
2548 Some(Node::ForeignItem(..)) => true,
2550 _ => bug!("is_foreign_item applied to non-local def-id {:?}", def_id),
2554 fn static_mutability(tcx: TyCtxt<'_>, def_id: DefId) -> Option<hir::Mutability> {
2555 match tcx.hir().get_if_local(def_id) {
2556 Some(Node::Item(&hir::Item { kind: hir::ItemKind::Static(_, mutbl, _), .. }))
2557 | Some(Node::ForeignItem(&hir::ForeignItem {
2558 kind: hir::ForeignItemKind::Static(_, mutbl),
2562 _ => bug!("static_mutability applied to non-local def-id {:?}", def_id),
2566 fn from_target_feature(
2569 attr: &ast::Attribute,
2570 whitelist: &FxHashMap<String, Option<Symbol>>,
2571 target_features: &mut Vec<Symbol>,
2573 let list = match attr.meta_item_list() {
2577 let bad_item = |span| {
2578 let msg = "malformed `target_feature` attribute input";
2579 let code = "enable = \"..\"".to_owned();
2581 .struct_span_err(span, &msg)
2582 .span_suggestion(span, "must be of the form", code, Applicability::HasPlaceholders)
2585 let rust_features = tcx.features();
2587 // Only `enable = ...` is accepted in the meta-item list.
2588 if !item.check_name(sym::enable) {
2589 bad_item(item.span());
2593 // Must be of the form `enable = "..."` (a string).
2594 let value = match item.value_str() {
2595 Some(value) => value,
2597 bad_item(item.span());
2602 // We allow comma separation to enable multiple features.
2603 target_features.extend(value.as_str().split(',').filter_map(|feature| {
2604 // Only allow whitelisted features per platform.
2605 let feature_gate = match whitelist.get(feature) {
2609 format!("the feature named `{}` is not valid for this target", feature);
2610 let mut err = tcx.sess.struct_span_err(item.span(), &msg);
2613 format!("`{}` is not valid for this target", feature),
2615 if feature.starts_with("+") {
2616 let valid = whitelist.contains_key(&feature[1..]);
2618 err.help("consider removing the leading `+` in the feature name");
2626 // Only allow features whose feature gates have been enabled.
2627 let allowed = match feature_gate.as_ref().map(|s| *s) {
2628 Some(sym::arm_target_feature) => rust_features.arm_target_feature,
2629 Some(sym::aarch64_target_feature) => rust_features.aarch64_target_feature,
2630 Some(sym::hexagon_target_feature) => rust_features.hexagon_target_feature,
2631 Some(sym::powerpc_target_feature) => rust_features.powerpc_target_feature,
2632 Some(sym::mips_target_feature) => rust_features.mips_target_feature,
2633 Some(sym::avx512_target_feature) => rust_features.avx512_target_feature,
2634 Some(sym::mmx_target_feature) => rust_features.mmx_target_feature,
2635 Some(sym::sse4a_target_feature) => rust_features.sse4a_target_feature,
2636 Some(sym::tbm_target_feature) => rust_features.tbm_target_feature,
2637 Some(sym::wasm_target_feature) => rust_features.wasm_target_feature,
2638 Some(sym::cmpxchg16b_target_feature) => rust_features.cmpxchg16b_target_feature,
2639 Some(sym::adx_target_feature) => rust_features.adx_target_feature,
2640 Some(sym::movbe_target_feature) => rust_features.movbe_target_feature,
2641 Some(sym::rtm_target_feature) => rust_features.rtm_target_feature,
2642 Some(sym::f16c_target_feature) => rust_features.f16c_target_feature,
2643 Some(name) => bug!("unknown target feature gate {}", name),
2646 if !allowed && id.is_local() {
2648 &tcx.sess.parse_sess,
2649 feature_gate.unwrap(),
2651 &format!("the target feature `{}` is currently unstable", feature),
2655 Some(Symbol::intern(feature))
2660 fn linkage_by_name(tcx: TyCtxt<'_>, def_id: DefId, name: &str) -> Linkage {
2661 use rustc::mir::mono::Linkage::*;
2663 // Use the names from src/llvm/docs/LangRef.rst here. Most types are only
2664 // applicable to variable declarations and may not really make sense for
2665 // Rust code in the first place but whitelist them anyway and trust that
2666 // the user knows what s/he's doing. Who knows, unanticipated use cases
2667 // may pop up in the future.
2669 // ghost, dllimport, dllexport and linkonce_odr_autohide are not supported
2670 // and don't have to be, LLVM treats them as no-ops.
2672 "appending" => Appending,
2673 "available_externally" => AvailableExternally,
2675 "extern_weak" => ExternalWeak,
2676 "external" => External,
2677 "internal" => Internal,
2678 "linkonce" => LinkOnceAny,
2679 "linkonce_odr" => LinkOnceODR,
2680 "private" => Private,
2682 "weak_odr" => WeakODR,
2684 let span = tcx.hir().span_if_local(def_id);
2685 if let Some(span) = span {
2686 tcx.sess.span_fatal(span, "invalid linkage specified")
2688 tcx.sess.fatal(&format!("invalid linkage specified: {}", name))
2694 fn codegen_fn_attrs(tcx: TyCtxt<'_>, id: DefId) -> CodegenFnAttrs {
2695 let attrs = tcx.get_attrs(id);
2697 let mut codegen_fn_attrs = CodegenFnAttrs::new();
2699 let whitelist = tcx.target_features_whitelist(LOCAL_CRATE);
2701 let mut inline_span = None;
2702 let mut link_ordinal_span = None;
2703 for attr in attrs.iter() {
2704 if attr.check_name(sym::cold) {
2705 codegen_fn_attrs.flags |= CodegenFnAttrFlags::COLD;
2706 } else if attr.check_name(sym::rustc_allocator) {
2707 codegen_fn_attrs.flags |= CodegenFnAttrFlags::ALLOCATOR;
2708 } else if attr.check_name(sym::unwind) {
2709 codegen_fn_attrs.flags |= CodegenFnAttrFlags::UNWIND;
2710 } else if attr.check_name(sym::ffi_returns_twice) {
2711 if tcx.is_foreign_item(id) {
2712 codegen_fn_attrs.flags |= CodegenFnAttrFlags::FFI_RETURNS_TWICE;
2714 // `#[ffi_returns_twice]` is only allowed `extern fn`s.
2719 "`#[ffi_returns_twice]` may only be used on foreign functions"
2723 } else if attr.check_name(sym::rustc_allocator_nounwind) {
2724 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_ALLOCATOR_NOUNWIND;
2725 } else if attr.check_name(sym::naked) {
2726 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NAKED;
2727 } else if attr.check_name(sym::no_mangle) {
2728 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
2729 } else if attr.check_name(sym::rustc_std_internal_symbol) {
2730 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2731 } else if attr.check_name(sym::no_debug) {
2732 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_DEBUG;
2733 } else if attr.check_name(sym::used) {
2734 codegen_fn_attrs.flags |= CodegenFnAttrFlags::USED;
2735 } else if attr.check_name(sym::thread_local) {
2736 codegen_fn_attrs.flags |= CodegenFnAttrFlags::THREAD_LOCAL;
2737 } else if attr.check_name(sym::track_caller) {
2738 if tcx.fn_sig(id).abi() != abi::Abi::Rust {
2739 struct_span_err!(tcx.sess, attr.span, E0737, "`#[track_caller]` requires Rust ABI")
2742 codegen_fn_attrs.flags |= CodegenFnAttrFlags::TRACK_CALLER;
2743 } else if attr.check_name(sym::export_name) {
2744 if let Some(s) = attr.value_str() {
2745 if s.as_str().contains("\0") {
2746 // `#[export_name = ...]` will be converted to a null-terminated string,
2747 // so it may not contain any null characters.
2752 "`export_name` may not contain null characters"
2756 codegen_fn_attrs.export_name = Some(s);
2758 } else if attr.check_name(sym::target_feature) {
2759 if tcx.fn_sig(id).unsafety() == Unsafety::Normal {
2760 let msg = "`#[target_feature(..)]` can only be applied to `unsafe` functions";
2762 .struct_span_err(attr.span, msg)
2763 .span_label(attr.span, "can only be applied to `unsafe` functions")
2764 .span_label(tcx.def_span(id), "not an `unsafe` function")
2767 from_target_feature(tcx, id, attr, &whitelist, &mut codegen_fn_attrs.target_features);
2768 } else if attr.check_name(sym::linkage) {
2769 if let Some(val) = attr.value_str() {
2770 codegen_fn_attrs.linkage = Some(linkage_by_name(tcx, id, &val.as_str()));
2772 } else if attr.check_name(sym::link_section) {
2773 if let Some(val) = attr.value_str() {
2774 if val.as_str().bytes().any(|b| b == 0) {
2776 "illegal null byte in link_section \
2780 tcx.sess.span_err(attr.span, &msg);
2782 codegen_fn_attrs.link_section = Some(val);
2785 } else if attr.check_name(sym::link_name) {
2786 codegen_fn_attrs.link_name = attr.value_str();
2787 } else if attr.check_name(sym::link_ordinal) {
2788 link_ordinal_span = Some(attr.span);
2789 if let ordinal @ Some(_) = check_link_ordinal(tcx, attr) {
2790 codegen_fn_attrs.link_ordinal = ordinal;
2795 codegen_fn_attrs.inline = attrs.iter().fold(InlineAttr::None, |ia, attr| {
2796 if !attr.has_name(sym::inline) {
2799 match attr.meta().map(|i| i.kind) {
2800 Some(MetaItemKind::Word) => {
2804 Some(MetaItemKind::List(ref items)) => {
2806 inline_span = Some(attr.span);
2807 if items.len() != 1 {
2809 tcx.sess.diagnostic(),
2812 "expected one argument"
2816 } else if list_contains_name(&items[..], sym::always) {
2818 } else if list_contains_name(&items[..], sym::never) {
2822 tcx.sess.diagnostic(),
2832 Some(MetaItemKind::NameValue(_)) => ia,
2837 codegen_fn_attrs.optimize = attrs.iter().fold(OptimizeAttr::None, |ia, attr| {
2838 if !attr.has_name(sym::optimize) {
2841 let err = |sp, s| struct_span_err!(tcx.sess.diagnostic(), sp, E0722, "{}", s).emit();
2842 match attr.meta().map(|i| i.kind) {
2843 Some(MetaItemKind::Word) => {
2844 err(attr.span, "expected one argument");
2847 Some(MetaItemKind::List(ref items)) => {
2849 inline_span = Some(attr.span);
2850 if items.len() != 1 {
2851 err(attr.span, "expected one argument");
2853 } else if list_contains_name(&items[..], sym::size) {
2855 } else if list_contains_name(&items[..], sym::speed) {
2858 err(items[0].span(), "invalid argument");
2862 Some(MetaItemKind::NameValue(_)) => ia,
2867 // If a function uses #[target_feature] it can't be inlined into general
2868 // purpose functions as they wouldn't have the right target features
2869 // enabled. For that reason we also forbid #[inline(always)] as it can't be
2872 if codegen_fn_attrs.target_features.len() > 0 {
2873 if codegen_fn_attrs.inline == InlineAttr::Always {
2874 if let Some(span) = inline_span {
2877 "cannot use `#[inline(always)]` with \
2878 `#[target_feature]`",
2884 // Weak lang items have the same semantics as "std internal" symbols in the
2885 // sense that they're preserved through all our LTO passes and only
2886 // strippable by the linker.
2888 // Additionally weak lang items have predetermined symbol names.
2889 if tcx.is_weak_lang_item(id) {
2890 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2892 if let Some(name) = weak_lang_items::link_name(&attrs) {
2893 codegen_fn_attrs.export_name = Some(name);
2894 codegen_fn_attrs.link_name = Some(name);
2896 check_link_name_xor_ordinal(tcx, &codegen_fn_attrs, link_ordinal_span);
2898 // Internal symbols to the standard library all have no_mangle semantics in
2899 // that they have defined symbol names present in the function name. This
2900 // also applies to weak symbols where they all have known symbol names.
2901 if codegen_fn_attrs.flags.contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL) {
2902 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
2908 fn check_link_ordinal(tcx: TyCtxt<'_>, attr: &ast::Attribute) -> Option<usize> {
2909 use syntax::ast::{Lit, LitIntType, LitKind};
2910 let meta_item_list = attr.meta_item_list();
2911 let meta_item_list: Option<&[ast::NestedMetaItem]> = meta_item_list.as_ref().map(Vec::as_ref);
2912 let sole_meta_list = match meta_item_list {
2913 Some([item]) => item.literal(),
2916 if let Some(Lit { kind: LitKind::Int(ordinal, LitIntType::Unsuffixed), .. }) = sole_meta_list {
2917 if *ordinal <= std::usize::MAX as u128 {
2918 Some(*ordinal as usize)
2920 let msg = format!("ordinal value in `link_ordinal` is too large: `{}`", &ordinal);
2922 .struct_span_err(attr.span, &msg)
2923 .note("the value may not exceed `std::usize::MAX`")
2929 .struct_span_err(attr.span, "illegal ordinal format in `link_ordinal`")
2930 .note("an unsuffixed integer value, e.g., `1`, is expected")
2936 fn check_link_name_xor_ordinal(
2938 codegen_fn_attrs: &CodegenFnAttrs,
2939 inline_span: Option<Span>,
2941 if codegen_fn_attrs.link_name.is_none() || codegen_fn_attrs.link_ordinal.is_none() {
2944 let msg = "cannot use `#[link_name]` with `#[link_ordinal]`";
2945 if let Some(span) = inline_span {
2946 tcx.sess.span_err(span, msg);