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::constrained_generic_params as cgp;
19 use crate::check::intrinsic::intrinsic_operation_unsafety;
21 use crate::middle::resolve_lifetime as rl;
22 use crate::middle::weak_lang_items;
23 use rustc::mir::mono::Linkage;
24 use rustc::ty::query::Providers;
25 use rustc::ty::subst::{Subst, InternalSubsts};
26 use rustc::ty::util::Discr;
27 use rustc::ty::util::IntTypeExt;
28 use rustc::ty::subst::GenericArgKind;
29 use rustc::ty::{self, AdtKind, DefIdTree, ToPolyTraitRef, Ty, TyCtxt, Const};
30 use rustc::ty::{ReprOptions, ToPredicate};
31 use rustc::util::captures::Captures;
32 use rustc::util::nodemap::FxHashMap;
33 use rustc_target::spec::abi;
36 use syntax::ast::{Ident, MetaItemKind};
37 use syntax::attr::{InlineAttr, OptimizeAttr, list_contains_name, mark_used};
38 use syntax::feature_gate;
39 use syntax::symbol::{kw, Symbol, sym};
40 use syntax_pos::{Span, DUMMY_SP};
42 use rustc::hir::def::{CtorKind, Res, DefKind};
44 use rustc::hir::def_id::{DefId, LOCAL_CRATE};
45 use rustc::hir::intravisit::{self, NestedVisitorMap, Visitor};
46 use rustc::hir::GenericParamKind;
47 use rustc::hir::{self, CodegenFnAttrFlags, CodegenFnAttrs, Unsafety};
49 use errors::{Applicability, DiagnosticId, StashKey};
51 struct OnlySelfBounds(bool);
53 ///////////////////////////////////////////////////////////////////////////
56 fn collect_mod_item_types(tcx: TyCtxt<'_>, module_def_id: DefId) {
57 tcx.hir().visit_item_likes_in_module(
59 &mut CollectItemTypesVisitor { tcx }.as_deep_visitor()
63 pub fn provide(providers: &mut Providers<'_>) {
64 *providers = Providers {
68 predicates_defined_on,
69 explicit_predicates_of,
71 type_param_predicates,
80 collect_mod_item_types,
85 ///////////////////////////////////////////////////////////////////////////
87 /// Context specific to some particular item. This is what implements
88 /// `AstConv`. It has information about the predicates that are defined
89 /// on the trait. Unfortunately, this predicate information is
90 /// available in various different forms at various points in the
91 /// process. So we can't just store a pointer to e.g., the AST or the
92 /// parsed ty form, we have to be more flexible. To this end, the
93 /// `ItemCtxt` is parameterized by a `DefId` that it uses to satisfy
94 /// `get_type_parameter_bounds` requests, drawing the information from
95 /// the AST (`hir::Generics`), recursively.
96 pub struct ItemCtxt<'tcx> {
101 ///////////////////////////////////////////////////////////////////////////
103 struct CollectItemTypesVisitor<'tcx> {
107 impl Visitor<'tcx> for CollectItemTypesVisitor<'tcx> {
108 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
109 NestedVisitorMap::OnlyBodies(&self.tcx.hir())
112 fn visit_item(&mut self, item: &'tcx hir::Item) {
113 convert_item(self.tcx, item.hir_id);
114 intravisit::walk_item(self, item);
117 fn visit_generics(&mut self, generics: &'tcx hir::Generics) {
118 for param in &generics.params {
120 hir::GenericParamKind::Lifetime { .. } => {}
121 hir::GenericParamKind::Type {
124 let def_id = self.tcx.hir().local_def_id(param.hir_id);
125 self.tcx.type_of(def_id);
127 hir::GenericParamKind::Type { .. } => {}
128 hir::GenericParamKind::Const { .. } => {
129 let def_id = self.tcx.hir().local_def_id(param.hir_id);
130 self.tcx.type_of(def_id);
134 intravisit::walk_generics(self, generics);
137 fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
138 if let hir::ExprKind::Closure(..) = expr.kind {
139 let def_id = self.tcx.hir().local_def_id(expr.hir_id);
140 self.tcx.generics_of(def_id);
141 self.tcx.type_of(def_id);
143 intravisit::walk_expr(self, expr);
146 fn visit_trait_item(&mut self, trait_item: &'tcx hir::TraitItem) {
147 convert_trait_item(self.tcx, trait_item.hir_id);
148 intravisit::walk_trait_item(self, trait_item);
151 fn visit_impl_item(&mut self, impl_item: &'tcx hir::ImplItem) {
152 convert_impl_item(self.tcx, impl_item.hir_id);
153 intravisit::walk_impl_item(self, impl_item);
157 ///////////////////////////////////////////////////////////////////////////
158 // Utility types and common code for the above passes.
160 fn bad_placeholder_type(tcx: TyCtxt<'tcx>, span: Span) -> errors::DiagnosticBuilder<'tcx> {
161 let mut diag = tcx.sess.struct_span_err_with_code(
163 "the type placeholder `_` is not allowed within types on item signatures",
164 DiagnosticId::Error("E0121".into()),
166 diag.span_label(span, "not allowed in type signatures");
170 impl ItemCtxt<'tcx> {
171 pub fn new(tcx: TyCtxt<'tcx>, item_def_id: DefId) -> ItemCtxt<'tcx> {
172 ItemCtxt { tcx, item_def_id }
175 pub fn to_ty(&self, ast_ty: &'tcx hir::Ty) -> Ty<'tcx> {
176 AstConv::ast_ty_to_ty(self, ast_ty)
180 impl AstConv<'tcx> for ItemCtxt<'tcx> {
181 fn tcx(&self) -> TyCtxt<'tcx> {
185 fn item_def_id(&self) -> Option<DefId> {
186 Some(self.item_def_id)
189 fn get_type_parameter_bounds(&self, span: Span, def_id: DefId) -> ty::GenericPredicates<'tcx> {
192 .type_param_predicates((self.item_def_id, def_id))
197 _: Option<&ty::GenericParamDef>,
199 ) -> Option<ty::Region<'tcx>> {
203 fn ty_infer(&self, _: Option<&ty::GenericParamDef>, span: Span) -> Ty<'tcx> {
204 bad_placeholder_type(self.tcx(), span).emit();
212 _: Option<&ty::GenericParamDef>,
214 ) -> &'tcx Const<'tcx> {
215 bad_placeholder_type(self.tcx(), span).emit();
217 self.tcx().consts.err
220 fn projected_ty_from_poly_trait_ref(
224 poly_trait_ref: ty::PolyTraitRef<'tcx>,
226 if let Some(trait_ref) = poly_trait_ref.no_bound_vars() {
227 self.tcx().mk_projection(item_def_id, trait_ref.substs)
229 // There are no late-bound regions; we can just ignore the binder.
234 "cannot extract an associated type from a higher-ranked trait bound \
241 fn normalize_ty(&self, _span: Span, ty: Ty<'tcx>) -> Ty<'tcx> {
242 // Types in item signatures are not normalized to avoid undue dependencies.
246 fn set_tainted_by_errors(&self) {
247 // There's no obvious place to track this, so just let it go.
250 fn record_ty(&self, _hir_id: hir::HirId, _ty: Ty<'tcx>, _span: Span) {
251 // There's no place to record types from signatures?
255 /// Returns the predicates defined on `item_def_id` of the form
256 /// `X: Foo` where `X` is the type parameter `def_id`.
257 fn type_param_predicates(
259 (item_def_id, def_id): (DefId, DefId),
260 ) -> ty::GenericPredicates<'_> {
263 // In the AST, bounds can derive from two places. Either
264 // written inline like `<T: Foo>` or in a where-clause like
267 let param_id = tcx.hir().as_local_hir_id(def_id).unwrap();
268 let param_owner = tcx.hir().ty_param_owner(param_id);
269 let param_owner_def_id = tcx.hir().local_def_id(param_owner);
270 let generics = tcx.generics_of(param_owner_def_id);
271 let index = generics.param_def_id_to_index[&def_id];
272 let ty = tcx.mk_ty_param(index, tcx.hir().ty_param_name(param_id));
274 // Don't look for bounds where the type parameter isn't in scope.
275 let parent = if item_def_id == param_owner_def_id {
278 tcx.generics_of(item_def_id).parent
281 let mut result = parent.map(|parent| {
282 let icx = ItemCtxt::new(tcx, parent);
283 icx.get_type_parameter_bounds(DUMMY_SP, def_id)
284 }).unwrap_or_default();
285 let mut extend = None;
287 let item_hir_id = tcx.hir().as_local_hir_id(item_def_id).unwrap();
288 let ast_generics = match tcx.hir().get(item_hir_id) {
289 Node::TraitItem(item) => &item.generics,
291 Node::ImplItem(item) => &item.generics,
293 Node::Item(item) => {
295 ItemKind::Fn(.., ref generics, _)
296 | ItemKind::Impl(_, _, _, ref generics, ..)
297 | ItemKind::TyAlias(_, ref generics)
298 | ItemKind::OpaqueTy(OpaqueTy {
303 | ItemKind::Enum(_, ref generics)
304 | ItemKind::Struct(_, ref generics)
305 | ItemKind::Union(_, ref generics) => generics,
306 ItemKind::Trait(_, _, ref generics, ..) => {
307 // Implied `Self: Trait` and supertrait bounds.
308 if param_id == item_hir_id {
309 let identity_trait_ref = ty::TraitRef::identity(tcx, item_def_id);
310 extend = Some((identity_trait_ref.to_predicate(), item.span));
318 Node::ForeignItem(item) => match item.kind {
319 ForeignItemKind::Fn(_, _, ref generics) => generics,
326 let icx = ItemCtxt::new(tcx, item_def_id);
327 let extra_predicates = extend.into_iter().chain(
328 icx.type_parameter_bounds_in_generics(ast_generics, param_id, ty, OnlySelfBounds(true))
330 .filter(|(predicate, _)| {
332 ty::Predicate::Trait(ref data) => data.skip_binder().self_ty().is_param(index),
337 result.predicates = tcx.arena.alloc_from_iter(
338 result.predicates.iter().copied().chain(extra_predicates),
343 impl ItemCtxt<'tcx> {
344 /// Finds bounds from `hir::Generics`. This requires scanning through the
345 /// AST. We do this to avoid having to convert *all* the bounds, which
346 /// would create artificial cycles. Instead, we can only convert the
347 /// bounds for a type parameter `X` if `X::Foo` is used.
348 fn type_parameter_bounds_in_generics(
350 ast_generics: &'tcx hir::Generics,
351 param_id: hir::HirId,
353 only_self_bounds: OnlySelfBounds,
354 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
355 let from_ty_params = ast_generics
358 .filter_map(|param| match param.kind {
359 GenericParamKind::Type { .. } if param.hir_id == param_id => Some(¶m.bounds),
362 .flat_map(|bounds| bounds.iter())
363 .flat_map(|b| predicates_from_bound(self, ty, b));
365 let from_where_clauses = ast_generics
369 .filter_map(|wp| match *wp {
370 hir::WherePredicate::BoundPredicate(ref bp) => Some(bp),
374 let bt = if is_param(self.tcx, &bp.bounded_ty, param_id) {
376 } else if !only_self_bounds.0 {
377 Some(self.to_ty(&bp.bounded_ty))
381 bp.bounds.iter().filter_map(move |b| bt.map(|bt| (bt, b)))
383 .flat_map(|(bt, b)| predicates_from_bound(self, bt, b));
385 from_ty_params.chain(from_where_clauses).collect()
389 /// Tests whether this is the AST for a reference to the type
390 /// parameter with ID `param_id`. We use this so as to avoid running
391 /// `ast_ty_to_ty`, because we want to avoid triggering an all-out
392 /// conversion of the type to avoid inducing unnecessary cycles.
393 fn is_param(tcx: TyCtxt<'_>, ast_ty: &hir::Ty, param_id: hir::HirId) -> bool {
394 if let hir::TyKind::Path(hir::QPath::Resolved(None, ref path)) = ast_ty.kind {
396 Res::SelfTy(Some(def_id), None) | Res::Def(DefKind::TyParam, def_id) => {
397 def_id == tcx.hir().local_def_id(param_id)
406 fn convert_item(tcx: TyCtxt<'_>, item_id: hir::HirId) {
407 let it = tcx.hir().expect_item(item_id);
408 debug!("convert: item {} with id {}", it.ident, it.hir_id);
409 let def_id = tcx.hir().local_def_id(item_id);
411 // These don't define types.
412 hir::ItemKind::ExternCrate(_)
413 | hir::ItemKind::Use(..)
414 | hir::ItemKind::Mod(_)
415 | hir::ItemKind::GlobalAsm(_) => {}
416 hir::ItemKind::ForeignMod(ref foreign_mod) => {
417 for item in &foreign_mod.items {
418 let def_id = tcx.hir().local_def_id(item.hir_id);
419 tcx.generics_of(def_id);
421 tcx.predicates_of(def_id);
422 if let hir::ForeignItemKind::Fn(..) = item.kind {
427 hir::ItemKind::Enum(ref enum_definition, _) => {
428 tcx.generics_of(def_id);
430 tcx.predicates_of(def_id);
431 convert_enum_variant_types(tcx, def_id, &enum_definition.variants);
433 hir::ItemKind::Impl(..) => {
434 tcx.generics_of(def_id);
436 tcx.impl_trait_ref(def_id);
437 tcx.predicates_of(def_id);
439 hir::ItemKind::Trait(..) => {
440 tcx.generics_of(def_id);
441 tcx.trait_def(def_id);
442 tcx.at(it.span).super_predicates_of(def_id);
443 tcx.predicates_of(def_id);
445 hir::ItemKind::TraitAlias(..) => {
446 tcx.generics_of(def_id);
447 tcx.at(it.span).super_predicates_of(def_id);
448 tcx.predicates_of(def_id);
450 hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
451 tcx.generics_of(def_id);
453 tcx.predicates_of(def_id);
455 for f in struct_def.fields() {
456 let def_id = tcx.hir().local_def_id(f.hir_id);
457 tcx.generics_of(def_id);
459 tcx.predicates_of(def_id);
462 if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
463 convert_variant_ctor(tcx, ctor_hir_id);
467 // Desugared from `impl Trait`, so visited by the function's return type.
468 hir::ItemKind::OpaqueTy(hir::OpaqueTy {
469 impl_trait_fn: Some(_),
473 hir::ItemKind::OpaqueTy(..)
474 | hir::ItemKind::TyAlias(..)
475 | hir::ItemKind::Static(..)
476 | hir::ItemKind::Const(..)
477 | hir::ItemKind::Fn(..) => {
478 tcx.generics_of(def_id);
480 tcx.predicates_of(def_id);
481 if let hir::ItemKind::Fn(..) = it.kind {
488 fn convert_trait_item(tcx: TyCtxt<'_>, trait_item_id: hir::HirId) {
489 let trait_item = tcx.hir().expect_trait_item(trait_item_id);
490 let def_id = tcx.hir().local_def_id(trait_item.hir_id);
491 tcx.generics_of(def_id);
493 match trait_item.kind {
494 hir::TraitItemKind::Const(..)
495 | hir::TraitItemKind::Type(_, Some(_))
496 | hir::TraitItemKind::Method(..) => {
498 if let hir::TraitItemKind::Method(..) = trait_item.kind {
503 hir::TraitItemKind::Type(_, None) => {}
506 tcx.predicates_of(def_id);
509 fn convert_impl_item(tcx: TyCtxt<'_>, impl_item_id: hir::HirId) {
510 let def_id = tcx.hir().local_def_id(impl_item_id);
511 tcx.generics_of(def_id);
513 tcx.predicates_of(def_id);
514 if let hir::ImplItemKind::Method(..) = tcx.hir().expect_impl_item(impl_item_id).kind {
519 fn convert_variant_ctor(tcx: TyCtxt<'_>, ctor_id: hir::HirId) {
520 let def_id = tcx.hir().local_def_id(ctor_id);
521 tcx.generics_of(def_id);
523 tcx.predicates_of(def_id);
526 fn convert_enum_variant_types(
529 variants: &[hir::Variant]
531 let def = tcx.adt_def(def_id);
532 let repr_type = def.repr.discr_type();
533 let initial = repr_type.initial_discriminant(tcx);
534 let mut prev_discr = None::<Discr<'_>>;
536 // fill the discriminant values and field types
537 for variant in variants {
538 let wrapped_discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
540 if let Some(ref e) = variant.disr_expr {
541 let expr_did = tcx.hir().local_def_id(e.hir_id);
542 def.eval_explicit_discr(tcx, expr_did)
543 } else if let Some(discr) = repr_type.disr_incr(tcx, prev_discr) {
550 "enum discriminant overflowed"
553 format!("overflowed on value after {}", prev_discr.unwrap()),
555 "explicitly set `{} = {}` if that is desired outcome",
556 variant.ident, wrapped_discr
560 }.unwrap_or(wrapped_discr),
563 for f in variant.data.fields() {
564 let def_id = tcx.hir().local_def_id(f.hir_id);
565 tcx.generics_of(def_id);
567 tcx.predicates_of(def_id);
570 // Convert the ctor, if any. This also registers the variant as
572 if let Some(ctor_hir_id) = variant.data.ctor_hir_id() {
573 convert_variant_ctor(tcx, ctor_hir_id);
580 variant_did: Option<DefId>,
581 ctor_did: Option<DefId>,
583 discr: ty::VariantDiscr,
584 def: &hir::VariantData,
585 adt_kind: ty::AdtKind,
587 ) -> ty::VariantDef {
588 let mut seen_fields: FxHashMap<ast::Ident, Span> = Default::default();
589 let hir_id = tcx.hir().as_local_hir_id(variant_did.unwrap_or(parent_did)).unwrap();
594 let fid = tcx.hir().local_def_id(f.hir_id);
595 let dup_span = seen_fields.get(&f.ident.modern()).cloned();
596 if let Some(prev_span) = dup_span {
601 "field `{}` is already declared",
603 ).span_label(f.span, "field already declared")
604 .span_label(prev_span, format!("`{}` first declared here", f.ident))
607 seen_fields.insert(f.ident.modern(), f.span);
613 vis: ty::Visibility::from_hir(&f.vis, hir_id, tcx),
617 let recovered = match def {
618 hir::VariantData::Struct(_, r) => *r,
628 CtorKind::from_hir(def),
635 fn adt_def(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::AdtDef {
638 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
639 let item = match tcx.hir().get(hir_id) {
640 Node::Item(item) => item,
644 let repr = ReprOptions::new(tcx, def_id);
645 let (kind, variants) = match item.kind {
646 ItemKind::Enum(ref def, _) => {
647 let mut distance_from_explicit = 0;
648 let variants = def.variants
651 let variant_did = Some(tcx.hir().local_def_id(v.id));
652 let ctor_did = v.data.ctor_hir_id()
653 .map(|hir_id| tcx.hir().local_def_id(hir_id));
655 let discr = if let Some(ref e) = v.disr_expr {
656 distance_from_explicit = 0;
657 ty::VariantDiscr::Explicit(tcx.hir().local_def_id(e.hir_id))
659 ty::VariantDiscr::Relative(distance_from_explicit)
661 distance_from_explicit += 1;
663 convert_variant(tcx, variant_did, ctor_did, v.ident, discr,
664 &v.data, AdtKind::Enum, def_id)
668 (AdtKind::Enum, variants)
670 ItemKind::Struct(ref def, _) => {
671 let variant_did = None;
672 let ctor_did = def.ctor_hir_id()
673 .map(|hir_id| tcx.hir().local_def_id(hir_id));
675 let variants = std::iter::once(convert_variant(
676 tcx, variant_did, ctor_did, item.ident, ty::VariantDiscr::Relative(0), def,
677 AdtKind::Struct, def_id,
680 (AdtKind::Struct, variants)
682 ItemKind::Union(ref def, _) => {
683 let variant_did = None;
684 let ctor_did = def.ctor_hir_id()
685 .map(|hir_id| tcx.hir().local_def_id(hir_id));
687 let variants = std::iter::once(convert_variant(
688 tcx, variant_did, ctor_did, item.ident, ty::VariantDiscr::Relative(0), def,
689 AdtKind::Union, def_id,
692 (AdtKind::Union, variants)
696 tcx.alloc_adt_def(def_id, kind, variants, repr)
699 /// Ensures that the super-predicates of the trait with a `DefId`
700 /// of `trait_def_id` are converted and stored. This also ensures that
701 /// the transitive super-predicates are converted.
702 fn super_predicates_of(
705 ) -> ty::GenericPredicates<'_> {
706 debug!("super_predicates(trait_def_id={:?})", trait_def_id);
707 let trait_hir_id = tcx.hir().as_local_hir_id(trait_def_id).unwrap();
709 let item = match tcx.hir().get(trait_hir_id) {
710 Node::Item(item) => item,
711 _ => bug!("trait_node_id {} is not an item", trait_hir_id),
714 let (generics, bounds) = match item.kind {
715 hir::ItemKind::Trait(.., ref generics, ref supertraits, _) => (generics, supertraits),
716 hir::ItemKind::TraitAlias(ref generics, ref supertraits) => (generics, supertraits),
717 _ => span_bug!(item.span, "super_predicates invoked on non-trait"),
720 let icx = ItemCtxt::new(tcx, trait_def_id);
722 // Convert the bounds that follow the colon, e.g., `Bar + Zed` in `trait Foo: Bar + Zed`.
723 let self_param_ty = tcx.types.self_param;
724 let superbounds1 = AstConv::compute_bounds(&icx, self_param_ty, bounds, SizedByDefault::No,
727 let superbounds1 = superbounds1.predicates(tcx, self_param_ty);
729 // Convert any explicit superbounds in the where-clause,
730 // e.g., `trait Foo where Self: Bar`.
731 // In the case of trait aliases, however, we include all bounds in the where-clause,
732 // so e.g., `trait Foo = where u32: PartialEq<Self>` would include `u32: PartialEq<Self>`
733 // as one of its "superpredicates".
734 let is_trait_alias = tcx.is_trait_alias(trait_def_id);
735 let superbounds2 = icx.type_parameter_bounds_in_generics(
736 generics, item.hir_id, self_param_ty, OnlySelfBounds(!is_trait_alias));
738 // Combine the two lists to form the complete set of superbounds:
739 let superbounds = &*tcx.arena.alloc_from_iter(
740 superbounds1.into_iter().chain(superbounds2)
743 // Now require that immediate supertraits are converted,
744 // which will, in turn, reach indirect supertraits.
745 for &(pred, span) in superbounds {
746 debug!("superbound: {:?}", pred);
747 if let ty::Predicate::Trait(bound) = pred {
748 tcx.at(span).super_predicates_of(bound.def_id());
752 ty::GenericPredicates {
754 predicates: superbounds,
758 fn trait_def(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::TraitDef {
759 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
760 let item = tcx.hir().expect_item(hir_id);
762 let (is_auto, unsafety) = match item.kind {
763 hir::ItemKind::Trait(is_auto, unsafety, ..) => (is_auto == hir::IsAuto::Yes, unsafety),
764 hir::ItemKind::TraitAlias(..) => (false, hir::Unsafety::Normal),
765 _ => span_bug!(item.span, "trait_def_of_item invoked on non-trait"),
768 let paren_sugar = tcx.has_attr(def_id, sym::rustc_paren_sugar);
769 if paren_sugar && !tcx.features().unboxed_closures {
770 let mut err = tcx.sess.struct_span_err(
772 "the `#[rustc_paren_sugar]` attribute is a temporary means of controlling \
773 which traits can use parenthetical notation",
777 "add `#![feature(unboxed_closures)]` to \
778 the crate attributes to use it"
783 let is_marker = tcx.has_attr(def_id, sym::marker);
784 let def_path_hash = tcx.def_path_hash(def_id);
785 let def = ty::TraitDef::new(def_id, unsafety, paren_sugar, is_auto, is_marker, def_path_hash);
789 fn has_late_bound_regions<'tcx>(tcx: TyCtxt<'tcx>, node: Node<'tcx>) -> Option<Span> {
790 struct LateBoundRegionsDetector<'tcx> {
792 outer_index: ty::DebruijnIndex,
793 has_late_bound_regions: Option<Span>,
796 impl Visitor<'tcx> for LateBoundRegionsDetector<'tcx> {
797 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
798 NestedVisitorMap::None
801 fn visit_ty(&mut self, ty: &'tcx hir::Ty) {
802 if self.has_late_bound_regions.is_some() {
806 hir::TyKind::BareFn(..) => {
807 self.outer_index.shift_in(1);
808 intravisit::walk_ty(self, ty);
809 self.outer_index.shift_out(1);
811 _ => intravisit::walk_ty(self, ty),
815 fn visit_poly_trait_ref(
817 tr: &'tcx hir::PolyTraitRef,
818 m: hir::TraitBoundModifier,
820 if self.has_late_bound_regions.is_some() {
823 self.outer_index.shift_in(1);
824 intravisit::walk_poly_trait_ref(self, tr, m);
825 self.outer_index.shift_out(1);
828 fn visit_lifetime(&mut self, lt: &'tcx hir::Lifetime) {
829 if self.has_late_bound_regions.is_some() {
833 match self.tcx.named_region(lt.hir_id) {
834 Some(rl::Region::Static) | Some(rl::Region::EarlyBound(..)) => {}
835 Some(rl::Region::LateBound(debruijn, _, _))
836 | Some(rl::Region::LateBoundAnon(debruijn, _)) if debruijn < self.outer_index => {}
837 Some(rl::Region::LateBound(..))
838 | Some(rl::Region::LateBoundAnon(..))
839 | Some(rl::Region::Free(..))
841 self.has_late_bound_regions = Some(lt.span);
847 fn has_late_bound_regions<'tcx>(
849 generics: &'tcx hir::Generics,
850 decl: &'tcx hir::FnDecl,
852 let mut visitor = LateBoundRegionsDetector {
854 outer_index: ty::INNERMOST,
855 has_late_bound_regions: None,
857 for param in &generics.params {
858 if let GenericParamKind::Lifetime { .. } = param.kind {
859 if tcx.is_late_bound(param.hir_id) {
860 return Some(param.span);
864 visitor.visit_fn_decl(decl);
865 visitor.has_late_bound_regions
869 Node::TraitItem(item) => match item.kind {
870 hir::TraitItemKind::Method(ref sig, _) => {
871 has_late_bound_regions(tcx, &item.generics, &sig.decl)
875 Node::ImplItem(item) => match item.kind {
876 hir::ImplItemKind::Method(ref sig, _) => {
877 has_late_bound_regions(tcx, &item.generics, &sig.decl)
881 Node::ForeignItem(item) => match item.kind {
882 hir::ForeignItemKind::Fn(ref fn_decl, _, ref generics) => {
883 has_late_bound_regions(tcx, generics, fn_decl)
887 Node::Item(item) => match item.kind {
888 hir::ItemKind::Fn(ref fn_decl, .., ref generics, _) => {
889 has_late_bound_regions(tcx, generics, fn_decl)
897 fn generics_of(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::Generics {
900 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
902 let node = tcx.hir().get(hir_id);
903 let parent_def_id = match node {
904 Node::ImplItem(_) | Node::TraitItem(_) | Node::Variant(_) |
905 Node::Ctor(..) | Node::Field(_) => {
906 let parent_id = tcx.hir().get_parent_item(hir_id);
907 Some(tcx.hir().local_def_id(parent_id))
909 // FIXME(#43408) enable this in all cases when we get lazy normalization.
910 Node::AnonConst(&anon_const) => {
911 // HACK(eddyb) this provides the correct generics when the workaround
912 // for a const parameter `AnonConst` is being used elsewhere, as then
913 // there won't be the kind of cyclic dependency blocking #43408.
914 let expr = &tcx.hir().body(anon_const.body).value;
915 let icx = ItemCtxt::new(tcx, def_id);
916 if AstConv::const_param_def_id(&icx, expr).is_some() {
917 let parent_id = tcx.hir().get_parent_item(hir_id);
918 Some(tcx.hir().local_def_id(parent_id))
923 Node::Expr(&hir::Expr {
924 kind: hir::ExprKind::Closure(..),
926 }) => Some(tcx.closure_base_def_id(def_id)),
927 Node::Item(item) => match item.kind {
928 ItemKind::OpaqueTy(hir::OpaqueTy { impl_trait_fn, .. }) => impl_trait_fn,
934 let mut opt_self = None;
935 let mut allow_defaults = false;
937 let no_generics = hir::Generics::empty();
938 let ast_generics = match node {
939 Node::TraitItem(item) => &item.generics,
941 Node::ImplItem(item) => &item.generics,
943 Node::Item(item) => {
945 ItemKind::Fn(.., ref generics, _) | ItemKind::Impl(_, _, _, ref generics, ..) => {
949 ItemKind::TyAlias(_, ref generics)
950 | ItemKind::Enum(_, ref generics)
951 | ItemKind::Struct(_, ref generics)
952 | ItemKind::OpaqueTy(hir::OpaqueTy { ref generics, .. })
953 | ItemKind::Union(_, ref generics) => {
954 allow_defaults = true;
958 ItemKind::Trait(_, _, ref generics, ..)
959 | ItemKind::TraitAlias(ref generics, ..) => {
960 // Add in the self type parameter.
962 // Something of a hack: use the node id for the trait, also as
963 // the node id for the Self type parameter.
964 let param_id = item.hir_id;
966 opt_self = Some(ty::GenericParamDef {
969 def_id: tcx.hir().local_def_id(param_id),
970 pure_wrt_drop: false,
971 kind: ty::GenericParamDefKind::Type {
973 object_lifetime_default: rl::Set1::Empty,
978 allow_defaults = true;
986 Node::ForeignItem(item) => match item.kind {
987 ForeignItemKind::Static(..) => &no_generics,
988 ForeignItemKind::Fn(_, _, ref generics) => generics,
989 ForeignItemKind::Type => &no_generics,
995 let has_self = opt_self.is_some();
996 let mut parent_has_self = false;
997 let mut own_start = has_self as u32;
998 let parent_count = parent_def_id.map_or(0, |def_id| {
999 let generics = tcx.generics_of(def_id);
1000 assert_eq!(has_self, false);
1001 parent_has_self = generics.has_self;
1002 own_start = generics.count() as u32;
1003 generics.parent_count + generics.params.len()
1006 let mut params: Vec<_> = opt_self.into_iter().collect();
1008 let early_lifetimes = early_bound_lifetimes_from_generics(tcx, ast_generics);
1012 .map(|(i, param)| ty::GenericParamDef {
1013 name: param.name.ident().name,
1014 index: own_start + i as u32,
1015 def_id: tcx.hir().local_def_id(param.hir_id),
1016 pure_wrt_drop: param.pure_wrt_drop,
1017 kind: ty::GenericParamDefKind::Lifetime,
1021 let object_lifetime_defaults = tcx.object_lifetime_defaults(hir_id);
1023 // Now create the real type parameters.
1024 let type_start = own_start - has_self as u32 + params.len() as u32;
1030 .filter_map(|param| {
1031 let kind = match param.kind {
1032 GenericParamKind::Type {
1037 if !allow_defaults && default.is_some() {
1038 if !tcx.features().default_type_parameter_fallback {
1040 lint::builtin::INVALID_TYPE_PARAM_DEFAULT,
1044 "defaults for type parameters are only allowed in \
1045 `struct`, `enum`, `type`, or `trait` definitions."
1051 ty::GenericParamDefKind::Type {
1052 has_default: default.is_some(),
1053 object_lifetime_default: object_lifetime_defaults
1055 .map_or(rl::Set1::Empty, |o| o[i]),
1059 GenericParamKind::Const { .. } => {
1060 ty::GenericParamDefKind::Const
1065 let param_def = ty::GenericParamDef {
1066 index: type_start + i as u32,
1067 name: param.name.ident().name,
1068 def_id: tcx.hir().local_def_id(param.hir_id),
1069 pure_wrt_drop: param.pure_wrt_drop,
1077 // provide junk type parameter defs - the only place that
1078 // cares about anything but the length is instantiation,
1079 // and we don't do that for closures.
1080 if let Node::Expr(&hir::Expr {
1081 kind: hir::ExprKind::Closure(.., gen),
1085 let dummy_args = if gen.is_some() {
1086 &["<yield_ty>", "<return_ty>", "<witness>"][..]
1088 &["<closure_kind>", "<closure_signature>"][..]
1095 .map(|(i, &arg)| ty::GenericParamDef {
1096 index: type_start + i as u32,
1097 name: Symbol::intern(arg),
1099 pure_wrt_drop: false,
1100 kind: ty::GenericParamDefKind::Type {
1102 object_lifetime_default: rl::Set1::Empty,
1108 if let Some(upvars) = tcx.upvars(def_id) {
1109 params.extend(upvars.iter().zip((dummy_args.len() as u32)..).map(|(_, i)| {
1110 ty::GenericParamDef {
1111 index: type_start + i,
1112 name: Symbol::intern("<upvar>"),
1114 pure_wrt_drop: false,
1115 kind: ty::GenericParamDefKind::Type {
1117 object_lifetime_default: rl::Set1::Empty,
1125 let param_def_id_to_index = params
1127 .map(|param| (param.def_id, param.index))
1130 tcx.arena.alloc(ty::Generics {
1131 parent: parent_def_id,
1134 param_def_id_to_index,
1135 has_self: has_self || parent_has_self,
1136 has_late_bound_regions: has_late_bound_regions(tcx, node),
1140 fn report_assoc_ty_on_inherent_impl(tcx: TyCtxt<'_>, span: Span) {
1145 "associated types are not yet supported in inherent impls (see #8995)"
1149 fn type_of(tcx: TyCtxt<'_>, def_id: DefId) -> Ty<'_> {
1150 checked_type_of(tcx, def_id, true).unwrap()
1153 fn infer_placeholder_type(
1156 body_id: hir::BodyId,
1160 let ty = tcx.typeck_tables_of(def_id).node_type(body_id.hir_id);
1162 // If this came from a free `const` or `static mut?` item,
1163 // then the user may have written e.g. `const A = 42;`.
1164 // In this case, the parser has stashed a diagnostic for
1165 // us to improve in typeck so we do that now.
1166 match tcx.sess.diagnostic().steal_diagnostic(span, StashKey::ItemNoType) {
1168 // The parser provided a sub-optimal `HasPlaceholders` suggestion for the type.
1169 // We are typeck and have the real type, so remove that and suggest the actual type.
1170 err.suggestions.clear();
1171 err.span_suggestion(
1173 "provide a type for the item",
1174 format!("{}: {}", item_ident, ty),
1175 Applicability::MachineApplicable,
1180 let mut diag = bad_placeholder_type(tcx, span);
1181 if ty != tcx.types.err {
1182 diag.span_suggestion(
1184 "replace `_` with the correct type",
1186 Applicability::MaybeIncorrect,
1196 /// Same as [`type_of`] but returns [`Option`] instead of failing.
1198 /// If you want to fail anyway, you can set the `fail` parameter to true, but in this case,
1199 /// you'd better just call [`type_of`] directly.
1200 pub fn checked_type_of(tcx: TyCtxt<'_>, def_id: DefId, fail: bool) -> Option<Ty<'_>> {
1203 let hir_id = match tcx.hir().as_local_hir_id(def_id) {
1204 Some(hir_id) => hir_id,
1209 bug!("invalid node");
1213 let icx = ItemCtxt::new(tcx, def_id);
1215 Some(match tcx.hir().get(hir_id) {
1216 Node::TraitItem(item) => match item.kind {
1217 TraitItemKind::Method(..) => {
1218 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1219 tcx.mk_fn_def(def_id, substs)
1221 TraitItemKind::Const(ref ty, body_id) => {
1222 body_id.and_then(|body_id| {
1223 if let hir::TyKind::Infer = ty.kind {
1224 Some(infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident))
1228 }).unwrap_or_else(|| icx.to_ty(ty))
1230 TraitItemKind::Type(_, Some(ref ty)) => icx.to_ty(ty),
1231 TraitItemKind::Type(_, None) => {
1235 span_bug!(item.span, "associated type missing default");
1239 Node::ImplItem(item) => match item.kind {
1240 ImplItemKind::Method(..) => {
1241 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1242 tcx.mk_fn_def(def_id, substs)
1244 ImplItemKind::Const(ref ty, body_id) => {
1245 if let hir::TyKind::Infer = ty.kind {
1246 infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident)
1251 ImplItemKind::OpaqueTy(_) => {
1253 .impl_trait_ref(tcx.hir().get_parent_did(hir_id))
1256 report_assoc_ty_on_inherent_impl(tcx, item.span);
1259 find_opaque_ty_constraints(tcx, def_id)
1261 ImplItemKind::TyAlias(ref ty) => {
1263 .impl_trait_ref(tcx.hir().get_parent_did(hir_id))
1266 report_assoc_ty_on_inherent_impl(tcx, item.span);
1273 Node::Item(item) => {
1275 ItemKind::Static(ref ty, .., body_id)
1276 | ItemKind::Const(ref ty, body_id) => {
1277 if let hir::TyKind::Infer = ty.kind {
1278 infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident)
1283 ItemKind::TyAlias(ref ty, _)
1284 | ItemKind::Impl(.., ref ty, _) => icx.to_ty(ty),
1285 ItemKind::Fn(..) => {
1286 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1287 tcx.mk_fn_def(def_id, substs)
1289 ItemKind::Enum(..) | ItemKind::Struct(..) | ItemKind::Union(..) => {
1290 let def = tcx.adt_def(def_id);
1291 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1292 tcx.mk_adt(def, substs)
1294 ItemKind::OpaqueTy(hir::OpaqueTy {
1295 impl_trait_fn: None,
1297 }) => find_opaque_ty_constraints(tcx, def_id),
1298 // Opaque types desugared from `impl Trait`.
1299 ItemKind::OpaqueTy(hir::OpaqueTy {
1300 impl_trait_fn: Some(owner),
1303 tcx.typeck_tables_of(owner)
1304 .concrete_opaque_types
1306 .map(|opaque| opaque.concrete_type)
1307 .unwrap_or_else(|| {
1308 // This can occur if some error in the
1309 // owner fn prevented us from populating
1310 // the `concrete_opaque_types` table.
1311 tcx.sess.delay_span_bug(
1314 "owner {:?} has no opaque type for {:?} in its tables",
1322 | ItemKind::TraitAlias(..)
1324 | ItemKind::ForeignMod(..)
1325 | ItemKind::GlobalAsm(..)
1326 | ItemKind::ExternCrate(..)
1327 | ItemKind::Use(..) => {
1333 "compute_type_of_item: unexpected item type: {:?}",
1340 Node::ForeignItem(foreign_item) => match foreign_item.kind {
1341 ForeignItemKind::Fn(..) => {
1342 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1343 tcx.mk_fn_def(def_id, substs)
1345 ForeignItemKind::Static(ref t, _) => icx.to_ty(t),
1346 ForeignItemKind::Type => tcx.mk_foreign(def_id),
1349 Node::Ctor(&ref def) | Node::Variant(
1350 hir::Variant { data: ref def, .. }
1352 VariantData::Unit(..) | VariantData::Struct(..) => {
1353 tcx.type_of(tcx.hir().get_parent_did(hir_id))
1355 VariantData::Tuple(..) => {
1356 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1357 tcx.mk_fn_def(def_id, substs)
1361 Node::Field(field) => icx.to_ty(&field.ty),
1363 Node::Expr(&hir::Expr {
1364 kind: hir::ExprKind::Closure(.., gen),
1368 return Some(tcx.typeck_tables_of(def_id).node_type(hir_id));
1371 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1372 tcx.mk_closure(def_id, substs)
1375 Node::AnonConst(_) => {
1376 let parent_node = tcx.hir().get(tcx.hir().get_parent_node(hir_id));
1379 kind: hir::TyKind::Array(_, ref constant),
1382 | Node::Ty(&hir::Ty {
1383 kind: hir::TyKind::Typeof(ref constant),
1386 | Node::Expr(&hir::Expr {
1387 kind: ExprKind::Repeat(_, ref constant),
1389 }) if constant.hir_id == hir_id =>
1394 Node::Variant(Variant {
1395 disr_expr: Some(ref e),
1397 }) if e.hir_id == hir_id =>
1399 tcx.adt_def(tcx.hir().get_parent_did(hir_id))
1405 Node::Ty(&hir::Ty { kind: hir::TyKind::Path(_), .. }) |
1406 Node::Expr(&hir::Expr { kind: ExprKind::Struct(..), .. }) |
1407 Node::Expr(&hir::Expr { kind: ExprKind::Path(_), .. }) |
1408 Node::TraitRef(..) => {
1409 let path = match parent_node {
1411 kind: hir::TyKind::Path(QPath::Resolved(_, ref path)),
1414 | Node::Expr(&hir::Expr {
1415 kind: ExprKind::Path(QPath::Resolved(_, ref path)),
1420 Node::Expr(&hir::Expr { kind: ExprKind::Struct(ref path, ..), .. }) => {
1421 if let QPath::Resolved(_, ref path) = **path {
1427 Node::TraitRef(&hir::TraitRef { ref path, .. }) => Some(&**path),
1431 if let Some(path) = path {
1432 let arg_index = path.segments.iter()
1433 .filter_map(|seg| seg.args.as_ref())
1434 .map(|generic_args| generic_args.args.as_ref())
1437 .filter(|arg| arg.is_const())
1439 .filter(|(_, arg)| arg.id() == hir_id)
1440 .map(|(index, _)| index)
1447 bug!("no arg matching AnonConst in path")
1451 // We've encountered an `AnonConst` in some path, so we need to
1452 // figure out which generic parameter it corresponds to and return
1453 // the relevant type.
1454 let generics = match path.res {
1455 Res::Def(DefKind::Ctor(..), def_id) => {
1456 tcx.generics_of(tcx.parent(def_id).unwrap())
1458 Res::Def(_, def_id) => tcx.generics_of(def_id),
1459 Res::Err => return Some(tcx.types.err),
1460 _ if !fail => return None,
1462 tcx.sess.delay_span_bug(
1465 "unexpected const parent path def {:?}",
1469 return Some(tcx.types.err);
1473 generics.params.iter()
1475 if let ty::GenericParamDefKind::Const = param.kind {
1482 .map(|param| tcx.type_of(param.def_id))
1483 // This is no generic parameter associated with the arg. This is
1484 // probably from an extra arg where one is not needed.
1485 .unwrap_or(tcx.types.err)
1490 tcx.sess.delay_span_bug(
1493 "unexpected const parent path {:?}",
1497 return Some(tcx.types.err);
1505 tcx.sess.delay_span_bug(
1508 "unexpected const parent in type_of_def_id(): {:?}", x
1516 Node::GenericParam(param) => match ¶m.kind {
1517 hir::GenericParamKind::Type { default: Some(ref ty), .. } => icx.to_ty(ty),
1518 hir::GenericParamKind::Const { ty: ref hir_ty, .. } => {
1519 let ty = icx.to_ty(hir_ty);
1520 if !tcx.features().const_compare_raw_pointers {
1521 let err = match ty.peel_refs().kind {
1522 ty::FnPtr(_) => Some("function pointers"),
1523 ty::RawPtr(_) => Some("raw pointers"),
1526 if let Some(unsupported_type) = err {
1527 feature_gate::emit_feature_err(
1528 &tcx.sess.parse_sess,
1529 sym::const_compare_raw_pointers,
1531 feature_gate::GateIssue::Language,
1533 "using {} as const generic parameters is unstable",
1539 if ty::search_for_structural_match_violation(
1540 param.hir_id, param.span, tcx, ty).is_some()
1546 "the types of const generic parameters must derive `PartialEq` and `Eq`",
1549 format!("`{}` doesn't derive both `PartialEq` and `Eq`", ty),
1558 bug!("unexpected non-type Node::GenericParam: {:?}", x)
1566 bug!("unexpected sort of node in type_of_def_id(): {:?}", x);
1571 fn find_opaque_ty_constraints(tcx: TyCtxt<'_>, def_id: DefId) -> Ty<'_> {
1572 use rustc::hir::{ImplItem, Item, TraitItem};
1574 debug!("find_opaque_ty_constraints({:?})", def_id);
1576 struct ConstraintLocator<'tcx> {
1579 // (first found type span, actual type, mapping from the opaque type's generic
1580 // parameters to the concrete type's generic parameters)
1582 // The mapping is an index for each use site of a generic parameter in the concrete type
1584 // The indices index into the generic parameters on the opaque type.
1585 found: Option<(Span, Ty<'tcx>, Vec<usize>)>,
1588 impl ConstraintLocator<'tcx> {
1589 fn check(&mut self, def_id: DefId) {
1590 // Don't try to check items that cannot possibly constrain the type.
1591 if !self.tcx.has_typeck_tables(def_id) {
1593 "find_opaque_ty_constraints: no constraint for `{:?}` at `{:?}`: no tables",
1601 .typeck_tables_of(def_id)
1602 .concrete_opaque_types
1604 if let Some(ty::ResolvedOpaqueTy { concrete_type, substs }) = ty {
1606 "find_opaque_ty_constraints: found constraint for `{:?}` at `{:?}`: {:?}",
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()),
1654 let is_param = |ty: Ty<'_>| match ty.kind {
1655 ty::Param(_) => true,
1658 if !substs.types().all(is_param) {
1659 self.tcx.sess.span_err(
1661 "defining opaque type use does not fully define opaque type",
1663 } else if let Some((prev_span, prev_ty, ref prev_indices)) = self.found {
1664 let mut ty = concrete_type.walk().fuse();
1665 let mut p_ty = prev_ty.walk().fuse();
1666 let iter_eq = (&mut ty).zip(&mut p_ty).all(|(t, p)| match (&t.kind, &p.kind) {
1667 // Type parameters are equal to any other type parameter for the purpose of
1668 // concrete type equality, as it is possible to obtain the same type just
1669 // by passing matching parameters to a function.
1670 (ty::Param(_), ty::Param(_)) => true,
1673 if !iter_eq || ty.next().is_some() || p_ty.next().is_some() {
1674 debug!("find_opaque_ty_constraints: span={:?}", span);
1675 // Found different concrete types for the opaque type.
1676 let mut err = self.tcx.sess.struct_span_err(
1678 "concrete type differs from previous defining opaque type use",
1682 format!("expected `{}`, got `{}`", prev_ty, concrete_type),
1684 err.span_note(prev_span, "previous use here");
1686 } else if indices != *prev_indices {
1687 // Found "same" concrete types, but the generic parameter order differs.
1688 let mut err = self.tcx.sess.struct_span_err(
1690 "concrete type's generic parameters differ from previous defining use",
1692 use std::fmt::Write;
1693 let mut s = String::new();
1694 write!(s, "expected [").unwrap();
1695 let list = |s: &mut String, indices: &Vec<usize>| {
1696 let mut indices = indices.iter().cloned();
1697 if let Some(first) = indices.next() {
1698 write!(s, "`{}`", substs[first]).unwrap();
1700 write!(s, ", `{}`", substs[i]).unwrap();
1704 list(&mut s, prev_indices);
1705 write!(s, "], got [").unwrap();
1706 list(&mut s, &indices);
1707 write!(s, "]").unwrap();
1708 err.span_label(span, s);
1709 err.span_note(prev_span, "previous use here");
1713 self.found = Some((span, concrete_type, indices));
1717 "find_opaque_ty_constraints: no constraint for `{:?}` at `{:?}`",
1725 impl<'tcx> intravisit::Visitor<'tcx> for ConstraintLocator<'tcx> {
1726 fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
1727 intravisit::NestedVisitorMap::All(&self.tcx.hir())
1729 fn visit_item(&mut self, it: &'tcx Item) {
1730 debug!("find_existential_constraints: visiting {:?}", it);
1731 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1732 // The opaque type itself or its children are not within its reveal scope.
1733 if def_id != self.def_id {
1735 intravisit::walk_item(self, it);
1738 fn visit_impl_item(&mut self, it: &'tcx ImplItem) {
1739 debug!("find_existential_constraints: visiting {:?}", it);
1740 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1741 // The opaque type itself or its children are not within its reveal scope.
1742 if def_id != self.def_id {
1744 intravisit::walk_impl_item(self, it);
1747 fn visit_trait_item(&mut self, it: &'tcx TraitItem) {
1748 debug!("find_existential_constraints: visiting {:?}", it);
1749 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1751 intravisit::walk_trait_item(self, it);
1755 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1756 let scope = tcx.hir().get_defining_scope(hir_id);
1757 let mut locator = ConstraintLocator {
1763 debug!("find_opaque_ty_constraints: scope={:?}", scope);
1765 if scope == hir::CRATE_HIR_ID {
1766 intravisit::walk_crate(&mut locator, tcx.hir().krate());
1768 debug!("find_opaque_ty_constraints: scope={:?}", tcx.hir().get(scope));
1769 match tcx.hir().get(scope) {
1770 // We explicitly call `visit_*` methods, instead of using `intravisit::walk_*` methods
1771 // This allows our visitor to process the defining item itself, causing
1772 // it to pick up any 'sibling' defining uses.
1774 // For example, this code:
1777 // type Blah = impl Debug;
1778 // let my_closure = || -> Blah { true };
1782 // requires us to explicitly process `foo()` in order
1783 // to notice the defining usage of `Blah`.
1784 Node::Item(ref it) => locator.visit_item(it),
1785 Node::ImplItem(ref it) => locator.visit_impl_item(it),
1786 Node::TraitItem(ref it) => locator.visit_trait_item(it),
1788 "{:?} is not a valid scope for an opaque type item",
1794 match locator.found {
1795 Some((_, ty, _)) => ty,
1797 let span = tcx.def_span(def_id);
1798 tcx.sess.span_err(span, "could not find defining uses");
1804 pub fn get_infer_ret_ty(output: &'_ hir::FunctionRetTy) -> Option<&hir::Ty> {
1805 if let hir::FunctionRetTy::Return(ref ty) = output {
1806 if let hir::TyKind::Infer = ty.kind {
1813 fn fn_sig(tcx: TyCtxt<'_>, def_id: DefId) -> ty::PolyFnSig<'_> {
1815 use rustc::hir::Node::*;
1817 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1819 let icx = ItemCtxt::new(tcx, def_id);
1821 match tcx.hir().get(hir_id) {
1822 TraitItem(hir::TraitItem {
1823 kind: TraitItemKind::Method(MethodSig { header, decl }, TraitMethod::Provided(_)),
1826 | ImplItem(hir::ImplItem {
1827 kind: ImplItemKind::Method(MethodSig { header, decl }, _),
1831 kind: ItemKind::Fn(decl, header, _, _),
1833 }) => match get_infer_ret_ty(&decl.output) {
1835 let fn_sig = tcx.typeck_tables_of(def_id).liberated_fn_sigs()[hir_id];
1836 let mut diag = bad_placeholder_type(tcx, ty.span);
1837 let ret_ty = fn_sig.output();
1838 if ret_ty != tcx.types.err {
1839 diag.span_suggestion(
1841 "replace `_` with the correct return type",
1843 Applicability::MaybeIncorrect,
1847 ty::Binder::bind(fn_sig)
1849 None => AstConv::ty_of_fn(&icx, header.unsafety, header.abi, decl)
1852 TraitItem(hir::TraitItem {
1853 kind: TraitItemKind::Method(MethodSig { header, decl }, _),
1856 AstConv::ty_of_fn(&icx, header.unsafety, header.abi, decl)
1859 ForeignItem(&hir::ForeignItem {
1860 kind: ForeignItemKind::Fn(ref fn_decl, _, _),
1863 let abi = tcx.hir().get_foreign_abi(hir_id);
1864 compute_sig_of_foreign_fn_decl(tcx, def_id, fn_decl, abi)
1867 Ctor(data) | Variant(
1868 hir::Variant { data, .. }
1869 ) if data.ctor_hir_id().is_some() => {
1870 let ty = tcx.type_of(tcx.hir().get_parent_did(hir_id));
1871 let inputs = data.fields()
1873 .map(|f| tcx.type_of(tcx.hir().local_def_id(f.hir_id)));
1874 ty::Binder::bind(tcx.mk_fn_sig(
1878 hir::Unsafety::Normal,
1884 kind: hir::ExprKind::Closure(..),
1887 // Closure signatures are not like other function
1888 // signatures and cannot be accessed through `fn_sig`. For
1889 // example, a closure signature excludes the `self`
1890 // argument. In any case they are embedded within the
1891 // closure type as part of the `ClosureSubsts`.
1894 // the signature of a closure, you should use the
1895 // `closure_sig` method on the `ClosureSubsts`:
1897 // closure_substs.sig(def_id, tcx)
1899 // or, inside of an inference context, you can use
1901 // infcx.closure_sig(def_id, closure_substs)
1902 bug!("to get the signature of a closure, use `closure_sig()` not `fn_sig()`");
1906 bug!("unexpected sort of node in fn_sig(): {:?}", x);
1911 fn impl_trait_ref(tcx: TyCtxt<'_>, def_id: DefId) -> Option<ty::TraitRef<'_>> {
1912 let icx = ItemCtxt::new(tcx, def_id);
1914 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1915 match tcx.hir().expect_item(hir_id).kind {
1916 hir::ItemKind::Impl(.., ref opt_trait_ref, _, _) => {
1917 opt_trait_ref.as_ref().map(|ast_trait_ref| {
1918 let selfty = tcx.type_of(def_id);
1919 AstConv::instantiate_mono_trait_ref(&icx, ast_trait_ref, selfty)
1926 fn impl_polarity(tcx: TyCtxt<'_>, def_id: DefId) -> ty::ImplPolarity {
1927 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1928 let is_rustc_reservation = tcx.has_attr(def_id, sym::rustc_reservation_impl);
1929 let item = tcx.hir().expect_item(hir_id);
1931 hir::ItemKind::Impl(_, hir::ImplPolarity::Negative, ..) => {
1932 if is_rustc_reservation {
1933 tcx.sess.span_err(item.span, "reservation impls can't be negative");
1935 ty::ImplPolarity::Negative
1937 hir::ItemKind::Impl(_, hir::ImplPolarity::Positive, _, _, None, _, _) => {
1938 if is_rustc_reservation {
1939 tcx.sess.span_err(item.span, "reservation impls can't be inherent");
1941 ty::ImplPolarity::Positive
1943 hir::ItemKind::Impl(_, hir::ImplPolarity::Positive, _, _, Some(_tr), _, _) => {
1944 if is_rustc_reservation {
1945 ty::ImplPolarity::Reservation
1947 ty::ImplPolarity::Positive
1950 ref item => bug!("impl_polarity: {:?} not an impl", item),
1954 /// Returns the early-bound lifetimes declared in this generics
1955 /// listing. For anything other than fns/methods, this is just all
1956 /// the lifetimes that are declared. For fns or methods, we have to
1957 /// screen out those that do not appear in any where-clauses etc using
1958 /// `resolve_lifetime::early_bound_lifetimes`.
1959 fn early_bound_lifetimes_from_generics<'a, 'tcx: 'a>(
1961 generics: &'a hir::Generics,
1962 ) -> impl Iterator<Item = &'a hir::GenericParam> + Captures<'tcx> {
1966 .filter(move |param| match param.kind {
1967 GenericParamKind::Lifetime { .. } => {
1968 !tcx.is_late_bound(param.hir_id)
1974 /// Returns a list of type predicates for the definition with ID `def_id`, including inferred
1975 /// lifetime constraints. This includes all predicates returned by `explicit_predicates_of`, plus
1976 /// inferred constraints concerning which regions outlive other regions.
1977 fn predicates_defined_on(
1980 ) -> ty::GenericPredicates<'_> {
1981 debug!("predicates_defined_on({:?})", def_id);
1982 let mut result = tcx.explicit_predicates_of(def_id);
1984 "predicates_defined_on: explicit_predicates_of({:?}) = {:?}",
1988 let inferred_outlives = tcx.inferred_outlives_of(def_id);
1989 if !inferred_outlives.is_empty() {
1991 "predicates_defined_on: inferred_outlives_of({:?}) = {:?}",
1995 if result.predicates.is_empty() {
1996 result.predicates = inferred_outlives;
1998 result.predicates = tcx.arena.alloc_from_iter(
1999 result.predicates.iter().chain(inferred_outlives).copied(),
2003 debug!("predicates_defined_on({:?}) = {:?}", def_id, result);
2007 /// Returns a list of all type predicates (explicit and implicit) for the definition with
2008 /// ID `def_id`. This includes all predicates returned by `predicates_defined_on`, plus
2009 /// `Self: Trait` predicates for traits.
2010 fn predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2011 let mut result = tcx.predicates_defined_on(def_id);
2013 if tcx.is_trait(def_id) {
2014 // For traits, add `Self: Trait` predicate. This is
2015 // not part of the predicates that a user writes, but it
2016 // is something that one must prove in order to invoke a
2017 // method or project an associated type.
2019 // In the chalk setup, this predicate is not part of the
2020 // "predicates" for a trait item. But it is useful in
2021 // rustc because if you directly (e.g.) invoke a trait
2022 // method like `Trait::method(...)`, you must naturally
2023 // prove that the trait applies to the types that were
2024 // used, and adding the predicate into this list ensures
2025 // that this is done.
2026 let span = tcx.def_span(def_id);
2027 result.predicates = tcx.arena.alloc_from_iter(
2028 result.predicates.iter().copied().chain(
2029 std::iter::once((ty::TraitRef::identity(tcx, def_id).to_predicate(), span))
2033 debug!("predicates_of(def_id={:?}) = {:?}", def_id, result);
2037 /// Returns a list of user-specified type predicates for the definition with ID `def_id`.
2038 /// N.B., this does not include any implied/inferred constraints.
2039 fn explicit_predicates_of(
2042 ) -> ty::GenericPredicates<'_> {
2044 use rustc_data_structures::fx::FxHashSet;
2046 debug!("explicit_predicates_of(def_id={:?})", def_id);
2048 /// A data structure with unique elements, which preserves order of insertion.
2049 /// Preserving the order of insertion is important here so as not to break
2050 /// compile-fail UI tests.
2051 // FIXME(eddyb) just use `IndexSet` from `indexmap`.
2052 struct UniquePredicates<'tcx> {
2053 predicates: Vec<(ty::Predicate<'tcx>, Span)>,
2054 uniques: FxHashSet<(ty::Predicate<'tcx>, Span)>,
2057 impl<'tcx> UniquePredicates<'tcx> {
2061 uniques: FxHashSet::default(),
2065 fn push(&mut self, value: (ty::Predicate<'tcx>, Span)) {
2066 if self.uniques.insert(value) {
2067 self.predicates.push(value);
2071 fn extend<I: IntoIterator<Item = (ty::Predicate<'tcx>, Span)>>(&mut self, iter: I) {
2078 let hir_id = match tcx.hir().as_local_hir_id(def_id) {
2079 Some(hir_id) => hir_id,
2080 None => return tcx.predicates_of(def_id),
2082 let node = tcx.hir().get(hir_id);
2084 let mut is_trait = None;
2085 let mut is_default_impl_trait = None;
2087 let icx = ItemCtxt::new(tcx, def_id);
2089 const NO_GENERICS: &hir::Generics = &hir::Generics::empty();
2091 let empty_trait_items = HirVec::new();
2093 let mut predicates = UniquePredicates::new();
2095 let ast_generics = match node {
2096 Node::TraitItem(item) => &item.generics,
2098 Node::ImplItem(item) => match item.kind {
2099 ImplItemKind::OpaqueTy(ref bounds) => {
2100 let substs = InternalSubsts::identity_for_item(tcx, def_id);
2101 let opaque_ty = tcx.mk_opaque(def_id, substs);
2103 // Collect the bounds, i.e., the `A + B + 'c` in `impl A + B + 'c`.
2104 let bounds = AstConv::compute_bounds(
2108 SizedByDefault::Yes,
2109 tcx.def_span(def_id),
2112 predicates.extend(bounds.predicates(tcx, opaque_ty));
2115 _ => &item.generics,
2118 Node::Item(item) => {
2120 ItemKind::Impl(_, _, defaultness, ref generics, ..) => {
2121 if defaultness.is_default() {
2122 is_default_impl_trait = tcx.impl_trait_ref(def_id);
2126 ItemKind::Fn(.., ref generics, _)
2127 | ItemKind::TyAlias(_, ref generics)
2128 | ItemKind::Enum(_, ref generics)
2129 | ItemKind::Struct(_, ref generics)
2130 | ItemKind::Union(_, ref generics) => generics,
2132 ItemKind::Trait(_, _, ref generics, .., ref items) => {
2133 is_trait = Some((ty::TraitRef::identity(tcx, def_id), items));
2136 ItemKind::TraitAlias(ref generics, _) => {
2137 is_trait = Some((ty::TraitRef::identity(tcx, def_id), &empty_trait_items));
2140 ItemKind::OpaqueTy(OpaqueTy {
2146 let substs = InternalSubsts::identity_for_item(tcx, def_id);
2147 let opaque_ty = tcx.mk_opaque(def_id, substs);
2149 // Collect the bounds, i.e., the `A + B + 'c` in `impl A + B + 'c`.
2150 let bounds = AstConv::compute_bounds(
2154 SizedByDefault::Yes,
2155 tcx.def_span(def_id),
2158 let bounds_predicates = bounds.predicates(tcx, opaque_ty);
2159 if impl_trait_fn.is_some() {
2161 return ty::GenericPredicates {
2163 predicates: tcx.arena.alloc_from_iter(bounds_predicates),
2166 // named opaque types
2167 predicates.extend(bounds_predicates);
2176 Node::ForeignItem(item) => match item.kind {
2177 ForeignItemKind::Static(..) => NO_GENERICS,
2178 ForeignItemKind::Fn(_, _, ref generics) => generics,
2179 ForeignItemKind::Type => NO_GENERICS,
2185 let generics = tcx.generics_of(def_id);
2186 let parent_count = generics.parent_count as u32;
2187 let has_own_self = generics.has_self && parent_count == 0;
2189 // Below we'll consider the bounds on the type parameters (including `Self`)
2190 // and the explicit where-clauses, but to get the full set of predicates
2191 // on a trait we need to add in the supertrait bounds and bounds found on
2192 // associated types.
2193 if let Some((_trait_ref, _)) = is_trait {
2194 predicates.extend(tcx.super_predicates_of(def_id).predicates.iter().cloned());
2197 // In default impls, we can assume that the self type implements
2198 // the trait. So in:
2200 // default impl Foo for Bar { .. }
2202 // we add a default where clause `Foo: Bar`. We do a similar thing for traits
2203 // (see below). Recall that a default impl is not itself an impl, but rather a
2204 // set of defaults that can be incorporated into another impl.
2205 if let Some(trait_ref) = is_default_impl_trait {
2206 predicates.push((trait_ref.to_poly_trait_ref().to_predicate(), tcx.def_span(def_id)));
2209 // Collect the region predicates that were declared inline as
2210 // well. In the case of parameters declared on a fn or method, we
2211 // have to be careful to only iterate over early-bound regions.
2212 let mut index = parent_count + has_own_self as u32;
2213 for param in early_bound_lifetimes_from_generics(tcx, ast_generics) {
2214 let region = tcx.mk_region(ty::ReEarlyBound(ty::EarlyBoundRegion {
2215 def_id: tcx.hir().local_def_id(param.hir_id),
2217 name: param.name.ident().name,
2222 GenericParamKind::Lifetime { .. } => {
2223 param.bounds.iter().for_each(|bound| match bound {
2224 hir::GenericBound::Outlives(lt) => {
2225 let bound = AstConv::ast_region_to_region(&icx, <, None);
2226 let outlives = ty::Binder::bind(ty::OutlivesPredicate(region, bound));
2227 predicates.push((outlives.to_predicate(), lt.span));
2236 // Collect the predicates that were written inline by the user on each
2237 // type parameter (e.g., `<T: Foo>`).
2238 for param in &ast_generics.params {
2239 if let GenericParamKind::Type { .. } = param.kind {
2240 let name = param.name.ident().name;
2241 let param_ty = ty::ParamTy::new(index, name).to_ty(tcx);
2244 let sized = SizedByDefault::Yes;
2245 let bounds = AstConv::compute_bounds(&icx, param_ty, ¶m.bounds, sized, param.span);
2246 predicates.extend(bounds.predicates(tcx, param_ty));
2250 // Add in the bounds that appear in the where-clause.
2251 let where_clause = &ast_generics.where_clause;
2252 for predicate in &where_clause.predicates {
2254 &hir::WherePredicate::BoundPredicate(ref bound_pred) => {
2255 let ty = icx.to_ty(&bound_pred.bounded_ty);
2257 // Keep the type around in a dummy predicate, in case of no bounds.
2258 // That way, `where Ty:` is not a complete noop (see #53696) and `Ty`
2259 // is still checked for WF.
2260 if bound_pred.bounds.is_empty() {
2261 if let ty::Param(_) = ty.kind {
2262 // This is a `where T:`, which can be in the HIR from the
2263 // transformation that moves `?Sized` to `T`'s declaration.
2264 // We can skip the predicate because type parameters are
2265 // trivially WF, but also we *should*, to avoid exposing
2266 // users who never wrote `where Type:,` themselves, to
2267 // compiler/tooling bugs from not handling WF predicates.
2269 let span = bound_pred.bounded_ty.span;
2270 let predicate = ty::OutlivesPredicate(ty, tcx.mk_region(ty::ReEmpty));
2272 (ty::Predicate::TypeOutlives(ty::Binder::dummy(predicate)), span)
2277 for bound in bound_pred.bounds.iter() {
2279 &hir::GenericBound::Trait(ref poly_trait_ref, _) => {
2280 let mut bounds = Bounds::default();
2281 let _ = AstConv::instantiate_poly_trait_ref(
2287 predicates.extend(bounds.predicates(tcx, ty));
2290 &hir::GenericBound::Outlives(ref lifetime) => {
2291 let region = AstConv::ast_region_to_region(&icx, lifetime, None);
2292 let pred = ty::Binder::bind(ty::OutlivesPredicate(ty, region));
2293 predicates.push((ty::Predicate::TypeOutlives(pred), lifetime.span))
2299 &hir::WherePredicate::RegionPredicate(ref region_pred) => {
2300 let r1 = AstConv::ast_region_to_region(&icx, ®ion_pred.lifetime, None);
2301 predicates.extend(region_pred.bounds.iter().map(|bound| {
2302 let (r2, span) = match bound {
2303 hir::GenericBound::Outlives(lt) => {
2304 (AstConv::ast_region_to_region(&icx, lt, None), lt.span)
2308 let pred = ty::Binder::bind(ty::OutlivesPredicate(r1, r2));
2310 (ty::Predicate::RegionOutlives(pred), span)
2314 &hir::WherePredicate::EqPredicate(..) => {
2320 // Add predicates from associated type bounds.
2321 if let Some((self_trait_ref, trait_items)) = is_trait {
2322 predicates.extend(trait_items.iter().flat_map(|trait_item_ref| {
2323 let trait_item = tcx.hir().trait_item(trait_item_ref.id);
2324 let bounds = match trait_item.kind {
2325 hir::TraitItemKind::Type(ref bounds, _) => bounds,
2326 _ => return Vec::new().into_iter()
2330 tcx.mk_projection(tcx.hir().local_def_id(trait_item.hir_id),
2331 self_trait_ref.substs);
2333 let bounds = AstConv::compute_bounds(
2334 &ItemCtxt::new(tcx, def_id),
2337 SizedByDefault::Yes,
2341 bounds.predicates(tcx, assoc_ty).into_iter()
2345 let mut predicates = predicates.predicates;
2347 // Subtle: before we store the predicates into the tcx, we
2348 // sort them so that predicates like `T: Foo<Item=U>` come
2349 // before uses of `U`. This avoids false ambiguity errors
2350 // in trait checking. See `setup_constraining_predicates`
2352 if let Node::Item(&Item {
2353 kind: ItemKind::Impl(..),
2357 let self_ty = tcx.type_of(def_id);
2358 let trait_ref = tcx.impl_trait_ref(def_id);
2359 cgp::setup_constraining_predicates(
2363 &mut cgp::parameters_for_impl(self_ty, trait_ref),
2367 let result = ty::GenericPredicates {
2368 parent: generics.parent,
2369 predicates: tcx.arena.alloc_from_iter(predicates),
2371 debug!("explicit_predicates_of(def_id={:?}) = {:?}", def_id, result);
2375 /// Converts a specific `GenericBound` from the AST into a set of
2376 /// predicates that apply to the self type. A vector is returned
2377 /// because this can be anywhere from zero predicates (`T: ?Sized` adds no
2378 /// predicates) to one (`T: Foo`) to many (`T: Bar<X = i32>` adds `T: Bar`
2379 /// and `<T as Bar>::X == i32`).
2380 fn predicates_from_bound<'tcx>(
2381 astconv: &dyn AstConv<'tcx>,
2383 bound: &'tcx hir::GenericBound,
2384 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
2386 hir::GenericBound::Trait(ref tr, hir::TraitBoundModifier::None) => {
2387 let mut bounds = Bounds::default();
2388 let _ = astconv.instantiate_poly_trait_ref(
2393 bounds.predicates(astconv.tcx(), param_ty)
2395 hir::GenericBound::Outlives(ref lifetime) => {
2396 let region = astconv.ast_region_to_region(lifetime, None);
2397 let pred = ty::Binder::bind(ty::OutlivesPredicate(param_ty, region));
2398 vec![(ty::Predicate::TypeOutlives(pred), lifetime.span)]
2400 hir::GenericBound::Trait(_, hir::TraitBoundModifier::Maybe) => vec![],
2404 fn compute_sig_of_foreign_fn_decl<'tcx>(
2407 decl: &'tcx hir::FnDecl,
2409 ) -> ty::PolyFnSig<'tcx> {
2410 let unsafety = if abi == abi::Abi::RustIntrinsic {
2411 intrinsic_operation_unsafety(&tcx.item_name(def_id).as_str())
2413 hir::Unsafety::Unsafe
2415 let fty = AstConv::ty_of_fn(&ItemCtxt::new(tcx, def_id), unsafety, abi, decl);
2417 // Feature gate SIMD types in FFI, since I am not sure that the
2418 // ABIs are handled at all correctly. -huonw
2419 if abi != abi::Abi::RustIntrinsic
2420 && abi != abi::Abi::PlatformIntrinsic
2421 && !tcx.features().simd_ffi
2423 let check = |ast_ty: &hir::Ty, ty: Ty<'_>| {
2429 "use of SIMD type `{}` in FFI is highly experimental and \
2430 may result in invalid code",
2431 tcx.hir().hir_to_pretty_string(ast_ty.hir_id)
2434 .help("add `#![feature(simd_ffi)]` to the crate attributes to enable")
2438 for (input, ty) in decl.inputs.iter().zip(*fty.inputs().skip_binder()) {
2441 if let hir::Return(ref ty) = decl.output {
2442 check(&ty, *fty.output().skip_binder())
2449 fn is_foreign_item(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
2450 match tcx.hir().get_if_local(def_id) {
2451 Some(Node::ForeignItem(..)) => true,
2453 _ => bug!("is_foreign_item applied to non-local def-id {:?}", def_id),
2457 fn static_mutability(tcx: TyCtxt<'_>, def_id: DefId) -> Option<hir::Mutability> {
2458 match tcx.hir().get_if_local(def_id) {
2459 Some(Node::Item(&hir::Item {
2460 kind: hir::ItemKind::Static(_, mutbl, _), ..
2462 Some(Node::ForeignItem( &hir::ForeignItem {
2463 kind: hir::ForeignItemKind::Static(_, mutbl), ..
2466 _ => bug!("static_mutability applied to non-local def-id {:?}", def_id),
2470 fn from_target_feature(
2473 attr: &ast::Attribute,
2474 whitelist: &FxHashMap<String, Option<Symbol>>,
2475 target_features: &mut Vec<Symbol>,
2477 let list = match attr.meta_item_list() {
2481 let bad_item = |span| {
2482 let msg = "malformed `target_feature` attribute input";
2483 let code = "enable = \"..\"".to_owned();
2484 tcx.sess.struct_span_err(span, &msg)
2485 .span_suggestion(span, "must be of the form", code, Applicability::HasPlaceholders)
2488 let rust_features = tcx.features();
2490 // Only `enable = ...` is accepted in the meta-item list.
2491 if !item.check_name(sym::enable) {
2492 bad_item(item.span());
2496 // Must be of the form `enable = "..."` (a string).
2497 let value = match item.value_str() {
2498 Some(value) => value,
2500 bad_item(item.span());
2505 // We allow comma separation to enable multiple features.
2506 target_features.extend(value.as_str().split(',').filter_map(|feature| {
2507 // Only allow whitelisted features per platform.
2508 let feature_gate = match whitelist.get(feature) {
2512 "the feature named `{}` is not valid for this target",
2515 let mut err = tcx.sess.struct_span_err(item.span(), &msg);
2518 format!("`{}` is not valid for this target", feature),
2520 if feature.starts_with("+") {
2521 let valid = whitelist.contains_key(&feature[1..]);
2523 err.help("consider removing the leading `+` in the feature name");
2531 // Only allow features whose feature gates have been enabled.
2532 let allowed = match feature_gate.as_ref().map(|s| *s) {
2533 Some(sym::arm_target_feature) => rust_features.arm_target_feature,
2534 Some(sym::aarch64_target_feature) => rust_features.aarch64_target_feature,
2535 Some(sym::hexagon_target_feature) => rust_features.hexagon_target_feature,
2536 Some(sym::powerpc_target_feature) => rust_features.powerpc_target_feature,
2537 Some(sym::mips_target_feature) => rust_features.mips_target_feature,
2538 Some(sym::avx512_target_feature) => rust_features.avx512_target_feature,
2539 Some(sym::mmx_target_feature) => rust_features.mmx_target_feature,
2540 Some(sym::sse4a_target_feature) => rust_features.sse4a_target_feature,
2541 Some(sym::tbm_target_feature) => rust_features.tbm_target_feature,
2542 Some(sym::wasm_target_feature) => rust_features.wasm_target_feature,
2543 Some(sym::cmpxchg16b_target_feature) => rust_features.cmpxchg16b_target_feature,
2544 Some(sym::adx_target_feature) => rust_features.adx_target_feature,
2545 Some(sym::movbe_target_feature) => rust_features.movbe_target_feature,
2546 Some(sym::rtm_target_feature) => rust_features.rtm_target_feature,
2547 Some(sym::f16c_target_feature) => rust_features.f16c_target_feature,
2548 Some(name) => bug!("unknown target feature gate {}", name),
2551 if !allowed && id.is_local() {
2552 feature_gate::emit_feature_err(
2553 &tcx.sess.parse_sess,
2554 feature_gate.unwrap(),
2556 feature_gate::GateIssue::Language,
2557 &format!("the target feature `{}` is currently unstable", feature),
2560 Some(Symbol::intern(feature))
2565 fn linkage_by_name(tcx: TyCtxt<'_>, def_id: DefId, name: &str) -> Linkage {
2566 use rustc::mir::mono::Linkage::*;
2568 // Use the names from src/llvm/docs/LangRef.rst here. Most types are only
2569 // applicable to variable declarations and may not really make sense for
2570 // Rust code in the first place but whitelist them anyway and trust that
2571 // the user knows what s/he's doing. Who knows, unanticipated use cases
2572 // may pop up in the future.
2574 // ghost, dllimport, dllexport and linkonce_odr_autohide are not supported
2575 // and don't have to be, LLVM treats them as no-ops.
2577 "appending" => Appending,
2578 "available_externally" => AvailableExternally,
2580 "extern_weak" => ExternalWeak,
2581 "external" => External,
2582 "internal" => Internal,
2583 "linkonce" => LinkOnceAny,
2584 "linkonce_odr" => LinkOnceODR,
2585 "private" => Private,
2587 "weak_odr" => WeakODR,
2589 let span = tcx.hir().span_if_local(def_id);
2590 if let Some(span) = span {
2591 tcx.sess.span_fatal(span, "invalid linkage specified")
2594 .fatal(&format!("invalid linkage specified: {}", name))
2600 fn codegen_fn_attrs(tcx: TyCtxt<'_>, id: DefId) -> CodegenFnAttrs {
2601 let attrs = tcx.get_attrs(id);
2603 let mut codegen_fn_attrs = CodegenFnAttrs::new();
2605 let whitelist = tcx.target_features_whitelist(LOCAL_CRATE);
2607 let mut inline_span = None;
2608 let mut link_ordinal_span = None;
2609 for attr in attrs.iter() {
2610 if attr.check_name(sym::cold) {
2611 codegen_fn_attrs.flags |= CodegenFnAttrFlags::COLD;
2612 } else if attr.check_name(sym::rustc_allocator) {
2613 codegen_fn_attrs.flags |= CodegenFnAttrFlags::ALLOCATOR;
2614 } else if attr.check_name(sym::unwind) {
2615 codegen_fn_attrs.flags |= CodegenFnAttrFlags::UNWIND;
2616 } else if attr.check_name(sym::ffi_returns_twice) {
2617 if tcx.is_foreign_item(id) {
2618 codegen_fn_attrs.flags |= CodegenFnAttrFlags::FFI_RETURNS_TWICE;
2620 // `#[ffi_returns_twice]` is only allowed `extern fn`s.
2625 "`#[ffi_returns_twice]` may only be used on foreign functions"
2628 } else if attr.check_name(sym::rustc_allocator_nounwind) {
2629 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_ALLOCATOR_NOUNWIND;
2630 } else if attr.check_name(sym::naked) {
2631 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NAKED;
2632 } else if attr.check_name(sym::no_mangle) {
2633 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
2634 } else if attr.check_name(sym::rustc_std_internal_symbol) {
2635 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2636 } else if attr.check_name(sym::no_debug) {
2637 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_DEBUG;
2638 } else if attr.check_name(sym::used) {
2639 codegen_fn_attrs.flags |= CodegenFnAttrFlags::USED;
2640 } else if attr.check_name(sym::thread_local) {
2641 codegen_fn_attrs.flags |= CodegenFnAttrFlags::THREAD_LOCAL;
2642 } else if attr.check_name(sym::track_caller) {
2643 if tcx.fn_sig(id).abi() != abi::Abi::Rust {
2648 "Rust ABI is required to use `#[track_caller]`"
2651 codegen_fn_attrs.flags |= CodegenFnAttrFlags::TRACK_CALLER;
2652 } else if attr.check_name(sym::export_name) {
2653 if let Some(s) = attr.value_str() {
2654 if s.as_str().contains("\0") {
2655 // `#[export_name = ...]` will be converted to a null-terminated string,
2656 // so it may not contain any null characters.
2661 "`export_name` may not contain null characters"
2664 codegen_fn_attrs.export_name = Some(s);
2666 } else if attr.check_name(sym::target_feature) {
2667 if tcx.fn_sig(id).unsafety() == Unsafety::Normal {
2668 let msg = "`#[target_feature(..)]` can only be applied to `unsafe` functions";
2669 tcx.sess.struct_span_err(attr.span, msg)
2670 .span_label(attr.span, "can only be applied to `unsafe` functions")
2671 .span_label(tcx.def_span(id), "not an `unsafe` function")
2674 from_target_feature(
2679 &mut codegen_fn_attrs.target_features,
2681 } else if attr.check_name(sym::linkage) {
2682 if let Some(val) = attr.value_str() {
2683 codegen_fn_attrs.linkage = Some(linkage_by_name(tcx, id, &val.as_str()));
2685 } else if attr.check_name(sym::link_section) {
2686 if let Some(val) = attr.value_str() {
2687 if val.as_str().bytes().any(|b| b == 0) {
2689 "illegal null byte in link_section \
2693 tcx.sess.span_err(attr.span, &msg);
2695 codegen_fn_attrs.link_section = Some(val);
2698 } else if attr.check_name(sym::link_name) {
2699 codegen_fn_attrs.link_name = attr.value_str();
2700 } else if attr.check_name(sym::link_ordinal) {
2701 link_ordinal_span = Some(attr.span);
2702 if let ordinal @ Some(_) = check_link_ordinal(tcx, attr) {
2703 codegen_fn_attrs.link_ordinal = ordinal;
2708 codegen_fn_attrs.inline = attrs.iter().fold(InlineAttr::None, |ia, attr| {
2709 if attr.path != sym::inline {
2712 match attr.meta().map(|i| i.kind) {
2713 Some(MetaItemKind::Word) => {
2717 Some(MetaItemKind::List(ref items)) => {
2719 inline_span = Some(attr.span);
2720 if items.len() != 1 {
2722 tcx.sess.diagnostic(),
2725 "expected one argument"
2728 } else if list_contains_name(&items[..], sym::always) {
2730 } else if list_contains_name(&items[..], sym::never) {
2734 tcx.sess.diagnostic(),
2743 Some(MetaItemKind::NameValue(_)) => ia,
2748 codegen_fn_attrs.optimize = attrs.iter().fold(OptimizeAttr::None, |ia, attr| {
2749 if attr.path != sym::optimize {
2752 let err = |sp, s| span_err!(tcx.sess.diagnostic(), sp, E0722, "{}", s);
2753 match attr.meta().map(|i| i.kind) {
2754 Some(MetaItemKind::Word) => {
2755 err(attr.span, "expected one argument");
2758 Some(MetaItemKind::List(ref items)) => {
2760 inline_span = Some(attr.span);
2761 if items.len() != 1 {
2762 err(attr.span, "expected one argument");
2764 } else if list_contains_name(&items[..], sym::size) {
2766 } else if list_contains_name(&items[..], sym::speed) {
2769 err(items[0].span(), "invalid argument");
2773 Some(MetaItemKind::NameValue(_)) => ia,
2778 // If a function uses #[target_feature] it can't be inlined into general
2779 // purpose functions as they wouldn't have the right target features
2780 // enabled. For that reason we also forbid #[inline(always)] as it can't be
2783 if codegen_fn_attrs.target_features.len() > 0 {
2784 if codegen_fn_attrs.inline == InlineAttr::Always {
2785 if let Some(span) = inline_span {
2788 "cannot use `#[inline(always)]` with \
2789 `#[target_feature]`",
2795 // Weak lang items have the same semantics as "std internal" symbols in the
2796 // sense that they're preserved through all our LTO passes and only
2797 // strippable by the linker.
2799 // Additionally weak lang items have predetermined symbol names.
2800 if tcx.is_weak_lang_item(id) {
2801 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2803 if let Some(name) = weak_lang_items::link_name(&attrs) {
2804 codegen_fn_attrs.export_name = Some(name);
2805 codegen_fn_attrs.link_name = Some(name);
2807 check_link_name_xor_ordinal(tcx, &codegen_fn_attrs, link_ordinal_span);
2809 // Internal symbols to the standard library all have no_mangle semantics in
2810 // that they have defined symbol names present in the function name. This
2811 // also applies to weak symbols where they all have known symbol names.
2812 if codegen_fn_attrs.flags.contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL) {
2813 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
2819 fn check_link_ordinal(tcx: TyCtxt<'_>, attr: &ast::Attribute) -> Option<usize> {
2820 use syntax::ast::{Lit, LitIntType, LitKind};
2821 let meta_item_list = attr.meta_item_list();
2822 let meta_item_list: Option<&[ast::NestedMetaItem]> = meta_item_list.as_ref().map(Vec::as_ref);
2823 let sole_meta_list = match meta_item_list {
2824 Some([item]) => item.literal(),
2827 if let Some(Lit { kind: LitKind::Int(ordinal, LitIntType::Unsuffixed), .. }) = sole_meta_list {
2828 if *ordinal <= std::usize::MAX as u128 {
2829 Some(*ordinal as usize)
2832 "ordinal value in `link_ordinal` is too large: `{}`",
2835 tcx.sess.struct_span_err(attr.span, &msg)
2836 .note("the value may not exceed `std::usize::MAX`")
2841 tcx.sess.struct_span_err(attr.span, "illegal ordinal format in `link_ordinal`")
2842 .note("an unsuffixed integer value, e.g., `1`, is expected")
2848 fn check_link_name_xor_ordinal(
2850 codegen_fn_attrs: &CodegenFnAttrs,
2851 inline_span: Option<Span>,
2853 if codegen_fn_attrs.link_name.is_none() || codegen_fn_attrs.link_ordinal.is_none() {
2856 let msg = "cannot use `#[link_name]` with `#[link_ordinal]`";
2857 if let Some(span) = inline_span {
2858 tcx.sess.span_err(span, msg);