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::intrisic_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::UnpackedKind;
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::source_map::Spanned;
39 use syntax::feature_gate;
40 use syntax::symbol::{InternedString, kw, Symbol, sym};
41 use syntax_pos::{Span, DUMMY_SP};
43 use rustc::hir::def::{CtorKind, Res, DefKind};
45 use rustc::hir::def_id::{DefId, LOCAL_CRATE};
46 use rustc::hir::intravisit::{self, NestedVisitorMap, Visitor};
47 use rustc::hir::GenericParamKind;
48 use rustc::hir::{self, CodegenFnAttrFlags, CodegenFnAttrs, Unsafety};
50 use errors::{Applicability, DiagnosticId};
52 struct OnlySelfBounds(bool);
54 ///////////////////////////////////////////////////////////////////////////
57 fn collect_mod_item_types(tcx: TyCtxt<'_>, module_def_id: DefId) {
58 tcx.hir().visit_item_likes_in_module(
60 &mut CollectItemTypesVisitor { tcx }.as_deep_visitor()
64 pub fn provide(providers: &mut Providers<'_>) {
65 *providers = Providers {
69 predicates_defined_on,
70 explicit_predicates_of,
72 type_param_predicates,
81 collect_mod_item_types,
86 ///////////////////////////////////////////////////////////////////////////
88 /// Context specific to some particular item. This is what implements
89 /// `AstConv`. It has information about the predicates that are defined
90 /// on the trait. Unfortunately, this predicate information is
91 /// available in various different forms at various points in the
92 /// process. So we can't just store a pointer to e.g., the AST or the
93 /// parsed ty form, we have to be more flexible. To this end, the
94 /// `ItemCtxt` is parameterized by a `DefId` that it uses to satisfy
95 /// `get_type_parameter_bounds` requests, drawing the information from
96 /// the AST (`hir::Generics`), recursively.
97 pub struct ItemCtxt<'tcx> {
102 ///////////////////////////////////////////////////////////////////////////
104 struct CollectItemTypesVisitor<'tcx> {
108 impl Visitor<'tcx> for CollectItemTypesVisitor<'tcx> {
109 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
110 NestedVisitorMap::OnlyBodies(&self.tcx.hir())
113 fn visit_item(&mut self, item: &'tcx hir::Item) {
114 convert_item(self.tcx, item.hir_id);
115 intravisit::walk_item(self, item);
118 fn visit_generics(&mut self, generics: &'tcx hir::Generics) {
119 for param in &generics.params {
121 hir::GenericParamKind::Lifetime { .. } => {}
122 hir::GenericParamKind::Type {
125 let def_id = self.tcx.hir().local_def_id(param.hir_id);
126 self.tcx.type_of(def_id);
128 hir::GenericParamKind::Type { .. } => {}
129 hir::GenericParamKind::Const { .. } => {
130 let def_id = self.tcx.hir().local_def_id(param.hir_id);
131 self.tcx.type_of(def_id);
135 intravisit::walk_generics(self, generics);
138 fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
139 if let hir::ExprKind::Closure(..) = expr.node {
140 let def_id = self.tcx.hir().local_def_id(expr.hir_id);
141 self.tcx.generics_of(def_id);
142 self.tcx.type_of(def_id);
144 intravisit::walk_expr(self, expr);
147 fn visit_trait_item(&mut self, trait_item: &'tcx hir::TraitItem) {
148 convert_trait_item(self.tcx, trait_item.hir_id);
149 intravisit::walk_trait_item(self, trait_item);
152 fn visit_impl_item(&mut self, impl_item: &'tcx hir::ImplItem) {
153 convert_impl_item(self.tcx, impl_item.hir_id);
154 intravisit::walk_impl_item(self, impl_item);
158 ///////////////////////////////////////////////////////////////////////////
159 // Utility types and common code for the above passes.
161 fn bad_placeholder_type(tcx: TyCtxt<'tcx>, span: Span) -> errors::DiagnosticBuilder<'tcx> {
162 let mut diag = tcx.sess.struct_span_err_with_code(
164 "the type placeholder `_` is not allowed within types on item signatures",
165 DiagnosticId::Error("E0121".into()),
167 diag.span_label(span, "not allowed in type signatures");
171 impl ItemCtxt<'tcx> {
172 pub fn new(tcx: TyCtxt<'tcx>, item_def_id: DefId) -> ItemCtxt<'tcx> {
173 ItemCtxt { tcx, item_def_id }
176 pub fn to_ty(&self, ast_ty: &'tcx hir::Ty) -> Ty<'tcx> {
177 AstConv::ast_ty_to_ty(self, ast_ty)
181 impl AstConv<'tcx> for ItemCtxt<'tcx> {
182 fn tcx(&self) -> TyCtxt<'tcx> {
186 fn get_type_parameter_bounds(&self, span: Span, def_id: DefId)
187 -> &'tcx ty::GenericPredicates<'tcx> {
190 .type_param_predicates((self.item_def_id, def_id))
195 _: Option<&ty::GenericParamDef>,
197 ) -> Option<ty::Region<'tcx>> {
201 fn ty_infer(&self, _: Option<&ty::GenericParamDef>, span: Span) -> Ty<'tcx> {
202 bad_placeholder_type(self.tcx(), span).emit();
210 _: Option<&ty::GenericParamDef>,
212 ) -> &'tcx Const<'tcx> {
213 bad_placeholder_type(self.tcx(), span).emit();
215 self.tcx().consts.err
218 fn projected_ty_from_poly_trait_ref(
222 poly_trait_ref: ty::PolyTraitRef<'tcx>,
224 if let Some(trait_ref) = poly_trait_ref.no_bound_vars() {
225 self.tcx().mk_projection(item_def_id, trait_ref.substs)
227 // There are no late-bound regions; we can just ignore the binder.
232 "cannot extract an associated type from a higher-ranked trait bound \
239 fn normalize_ty(&self, _span: Span, ty: Ty<'tcx>) -> Ty<'tcx> {
240 // Types in item signatures are not normalized to avoid undue dependencies.
244 fn set_tainted_by_errors(&self) {
245 // There's no obvious place to track this, so just let it go.
248 fn record_ty(&self, _hir_id: hir::HirId, _ty: Ty<'tcx>, _span: Span) {
249 // There's no place to record types from signatures?
253 /// Returns the predicates defined on `item_def_id` of the form
254 /// `X: Foo` where `X` is the type parameter `def_id`.
255 fn type_param_predicates(
257 (item_def_id, def_id): (DefId, DefId),
258 ) -> &ty::GenericPredicates<'_> {
261 // In the AST, bounds can derive from two places. Either
262 // written inline like `<T: Foo>` or in a where-clause like
265 let param_id = tcx.hir().as_local_hir_id(def_id).unwrap();
266 let param_owner = tcx.hir().ty_param_owner(param_id);
267 let param_owner_def_id = tcx.hir().local_def_id(param_owner);
268 let generics = tcx.generics_of(param_owner_def_id);
269 let index = generics.param_def_id_to_index[&def_id];
270 let ty = tcx.mk_ty_param(index, tcx.hir().ty_param_name(param_id).as_interned_str());
272 // Don't look for bounds where the type parameter isn't in scope.
273 let parent = if item_def_id == param_owner_def_id {
276 tcx.generics_of(item_def_id).parent
279 let result = parent.map_or(&tcx.common.empty_predicates, |parent| {
280 let icx = ItemCtxt::new(tcx, parent);
281 icx.get_type_parameter_bounds(DUMMY_SP, def_id)
283 let mut extend = None;
285 let item_hir_id = tcx.hir().as_local_hir_id(item_def_id).unwrap();
286 let ast_generics = match tcx.hir().get(item_hir_id) {
287 Node::TraitItem(item) => &item.generics,
289 Node::ImplItem(item) => &item.generics,
291 Node::Item(item) => {
293 ItemKind::Fn(.., ref generics, _)
294 | ItemKind::Impl(_, _, _, ref generics, ..)
295 | ItemKind::TyAlias(_, ref generics)
296 | ItemKind::OpaqueTy(OpaqueTy {
301 | ItemKind::Enum(_, ref generics)
302 | ItemKind::Struct(_, ref generics)
303 | ItemKind::Union(_, ref generics) => generics,
304 ItemKind::Trait(_, _, ref generics, ..) => {
305 // Implied `Self: Trait` and supertrait bounds.
306 if param_id == item_hir_id {
307 let identity_trait_ref = ty::TraitRef::identity(tcx, item_def_id);
308 extend = Some((identity_trait_ref.to_predicate(), item.span));
316 Node::ForeignItem(item) => match item.node {
317 ForeignItemKind::Fn(_, _, ref generics) => generics,
324 let icx = ItemCtxt::new(tcx, item_def_id);
325 let mut result = (*result).clone();
326 result.predicates.extend(extend.into_iter());
327 result.predicates.extend(
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 tcx.arena.alloc(result)
340 impl ItemCtxt<'tcx> {
341 /// Finds bounds from `hir::Generics`. This requires scanning through the
342 /// AST. We do this to avoid having to convert *all* the bounds, which
343 /// would create artificial cycles. Instead, we can only convert the
344 /// bounds for a type parameter `X` if `X::Foo` is used.
345 fn type_parameter_bounds_in_generics(
347 ast_generics: &'tcx hir::Generics,
348 param_id: hir::HirId,
350 only_self_bounds: OnlySelfBounds,
351 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
352 let from_ty_params = ast_generics
355 .filter_map(|param| match param.kind {
356 GenericParamKind::Type { .. } if param.hir_id == param_id => Some(¶m.bounds),
359 .flat_map(|bounds| bounds.iter())
360 .flat_map(|b| predicates_from_bound(self, ty, b));
362 let from_where_clauses = ast_generics
366 .filter_map(|wp| match *wp {
367 hir::WherePredicate::BoundPredicate(ref bp) => Some(bp),
371 let bt = if is_param(self.tcx, &bp.bounded_ty, param_id) {
373 } else if !only_self_bounds.0 {
374 Some(self.to_ty(&bp.bounded_ty))
378 bp.bounds.iter().filter_map(move |b| bt.map(|bt| (bt, b)))
380 .flat_map(|(bt, b)| predicates_from_bound(self, bt, b));
382 from_ty_params.chain(from_where_clauses).collect()
386 /// Tests whether this is the AST for a reference to the type
387 /// parameter with ID `param_id`. We use this so as to avoid running
388 /// `ast_ty_to_ty`, because we want to avoid triggering an all-out
389 /// conversion of the type to avoid inducing unnecessary cycles.
390 fn is_param(tcx: TyCtxt<'_>, ast_ty: &hir::Ty, param_id: hir::HirId) -> bool {
391 if let hir::TyKind::Path(hir::QPath::Resolved(None, ref path)) = ast_ty.node {
393 Res::SelfTy(Some(def_id), None) | Res::Def(DefKind::TyParam, def_id) => {
394 def_id == tcx.hir().local_def_id(param_id)
403 fn convert_item(tcx: TyCtxt<'_>, item_id: hir::HirId) {
404 let it = tcx.hir().expect_item(item_id);
405 debug!("convert: item {} with id {}", it.ident, it.hir_id);
406 let def_id = tcx.hir().local_def_id(item_id);
408 // These don't define types.
409 hir::ItemKind::ExternCrate(_)
410 | hir::ItemKind::Use(..)
411 | hir::ItemKind::Mod(_)
412 | hir::ItemKind::GlobalAsm(_) => {}
413 hir::ItemKind::ForeignMod(ref foreign_mod) => {
414 for item in &foreign_mod.items {
415 let def_id = tcx.hir().local_def_id(item.hir_id);
416 tcx.generics_of(def_id);
418 tcx.predicates_of(def_id);
419 if let hir::ForeignItemKind::Fn(..) = item.node {
424 hir::ItemKind::Enum(ref enum_definition, _) => {
425 tcx.generics_of(def_id);
427 tcx.predicates_of(def_id);
428 convert_enum_variant_types(tcx, def_id, &enum_definition.variants);
430 hir::ItemKind::Impl(..) => {
431 tcx.generics_of(def_id);
433 tcx.impl_trait_ref(def_id);
434 tcx.predicates_of(def_id);
436 hir::ItemKind::Trait(..) => {
437 tcx.generics_of(def_id);
438 tcx.trait_def(def_id);
439 tcx.at(it.span).super_predicates_of(def_id);
440 tcx.predicates_of(def_id);
442 hir::ItemKind::TraitAlias(..) => {
443 tcx.generics_of(def_id);
444 tcx.at(it.span).super_predicates_of(def_id);
445 tcx.predicates_of(def_id);
447 hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
448 tcx.generics_of(def_id);
450 tcx.predicates_of(def_id);
452 for f in struct_def.fields() {
453 let def_id = tcx.hir().local_def_id(f.hir_id);
454 tcx.generics_of(def_id);
456 tcx.predicates_of(def_id);
459 if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
460 convert_variant_ctor(tcx, ctor_hir_id);
464 // Desugared from `impl Trait`, so visited by the function's return type.
465 hir::ItemKind::OpaqueTy(hir::OpaqueTy {
466 impl_trait_fn: Some(_),
470 hir::ItemKind::OpaqueTy(..)
471 | hir::ItemKind::TyAlias(..)
472 | hir::ItemKind::Static(..)
473 | hir::ItemKind::Const(..)
474 | hir::ItemKind::Fn(..) => {
475 tcx.generics_of(def_id);
477 tcx.predicates_of(def_id);
478 if let hir::ItemKind::Fn(..) = it.node {
485 fn convert_trait_item(tcx: TyCtxt<'_>, trait_item_id: hir::HirId) {
486 let trait_item = tcx.hir().expect_trait_item(trait_item_id);
487 let def_id = tcx.hir().local_def_id(trait_item.hir_id);
488 tcx.generics_of(def_id);
490 match trait_item.node {
491 hir::TraitItemKind::Const(..)
492 | hir::TraitItemKind::Type(_, Some(_))
493 | hir::TraitItemKind::Method(..) => {
495 if let hir::TraitItemKind::Method(..) = trait_item.node {
500 hir::TraitItemKind::Type(_, None) => {}
503 tcx.predicates_of(def_id);
506 fn convert_impl_item(tcx: TyCtxt<'_>, impl_item_id: hir::HirId) {
507 let def_id = tcx.hir().local_def_id(impl_item_id);
508 tcx.generics_of(def_id);
510 tcx.predicates_of(def_id);
511 if let hir::ImplItemKind::Method(..) = tcx.hir().expect_impl_item(impl_item_id).node {
516 fn convert_variant_ctor(tcx: TyCtxt<'_>, ctor_id: hir::HirId) {
517 let def_id = tcx.hir().local_def_id(ctor_id);
518 tcx.generics_of(def_id);
520 tcx.predicates_of(def_id);
523 fn convert_enum_variant_types<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId, variants: &[hir::Variant]) {
524 let def = tcx.adt_def(def_id);
525 let repr_type = def.repr.discr_type();
526 let initial = repr_type.initial_discriminant(tcx);
527 let mut prev_discr = None::<Discr<'tcx>>;
529 // fill the discriminant values and field types
530 for variant in variants {
531 let wrapped_discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
533 if let Some(ref e) = variant.node.disr_expr {
534 let expr_did = tcx.hir().local_def_id(e.hir_id);
535 def.eval_explicit_discr(tcx, expr_did)
536 } else if let Some(discr) = repr_type.disr_incr(tcx, prev_discr) {
543 "enum discriminant overflowed"
546 format!("overflowed on value after {}", prev_discr.unwrap()),
548 "explicitly set `{} = {}` if that is desired outcome",
549 variant.node.ident, wrapped_discr
553 }.unwrap_or(wrapped_discr),
556 for f in variant.node.data.fields() {
557 let def_id = tcx.hir().local_def_id(f.hir_id);
558 tcx.generics_of(def_id);
560 tcx.predicates_of(def_id);
563 // Convert the ctor, if any. This also registers the variant as
565 if let Some(ctor_hir_id) = variant.node.data.ctor_hir_id() {
566 convert_variant_ctor(tcx, ctor_hir_id);
573 variant_did: Option<DefId>,
574 ctor_did: Option<DefId>,
576 discr: ty::VariantDiscr,
577 def: &hir::VariantData,
578 adt_kind: ty::AdtKind,
580 ) -> ty::VariantDef {
581 let mut seen_fields: FxHashMap<ast::Ident, Span> = Default::default();
582 let hir_id = tcx.hir().as_local_hir_id(variant_did.unwrap_or(parent_did)).unwrap();
587 let fid = tcx.hir().local_def_id(f.hir_id);
588 let dup_span = seen_fields.get(&f.ident.modern()).cloned();
589 if let Some(prev_span) = dup_span {
594 "field `{}` is already declared",
596 ).span_label(f.span, "field already declared")
597 .span_label(prev_span, format!("`{}` first declared here", f.ident))
600 seen_fields.insert(f.ident.modern(), f.span);
606 vis: ty::Visibility::from_hir(&f.vis, hir_id, tcx),
610 let recovered = match def {
611 hir::VariantData::Struct(_, r) => *r,
621 CtorKind::from_hir(def),
628 fn adt_def(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::AdtDef {
631 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
632 let item = match tcx.hir().get(hir_id) {
633 Node::Item(item) => item,
637 let repr = ReprOptions::new(tcx, def_id);
638 let (kind, variants) = match item.node {
639 ItemKind::Enum(ref def, _) => {
640 let mut distance_from_explicit = 0;
641 let variants = def.variants
644 let variant_did = Some(tcx.hir().local_def_id(v.node.id));
645 let ctor_did = v.node.data.ctor_hir_id()
646 .map(|hir_id| tcx.hir().local_def_id(hir_id));
648 let discr = if let Some(ref e) = v.node.disr_expr {
649 distance_from_explicit = 0;
650 ty::VariantDiscr::Explicit(tcx.hir().local_def_id(e.hir_id))
652 ty::VariantDiscr::Relative(distance_from_explicit)
654 distance_from_explicit += 1;
656 convert_variant(tcx, variant_did, ctor_did, v.node.ident, discr,
657 &v.node.data, AdtKind::Enum, def_id)
661 (AdtKind::Enum, variants)
663 ItemKind::Struct(ref def, _) => {
664 let variant_did = None;
665 let ctor_did = def.ctor_hir_id()
666 .map(|hir_id| tcx.hir().local_def_id(hir_id));
668 let variants = std::iter::once(convert_variant(
669 tcx, variant_did, ctor_did, item.ident, ty::VariantDiscr::Relative(0), def,
670 AdtKind::Struct, def_id,
673 (AdtKind::Struct, variants)
675 ItemKind::Union(ref def, _) => {
676 let variant_did = None;
677 let ctor_did = def.ctor_hir_id()
678 .map(|hir_id| tcx.hir().local_def_id(hir_id));
680 let variants = std::iter::once(convert_variant(
681 tcx, variant_did, ctor_did, item.ident, ty::VariantDiscr::Relative(0), def,
682 AdtKind::Union, def_id,
685 (AdtKind::Union, variants)
689 tcx.alloc_adt_def(def_id, kind, variants, repr)
692 /// Ensures that the super-predicates of the trait with a `DefId`
693 /// of `trait_def_id` are converted and stored. This also ensures that
694 /// the transitive super-predicates are converted.
695 fn super_predicates_of(
698 ) -> &ty::GenericPredicates<'_> {
699 debug!("super_predicates(trait_def_id={:?})", trait_def_id);
700 let trait_hir_id = tcx.hir().as_local_hir_id(trait_def_id).unwrap();
702 let item = match tcx.hir().get(trait_hir_id) {
703 Node::Item(item) => item,
704 _ => bug!("trait_node_id {} is not an item", trait_hir_id),
707 let (generics, bounds) = match item.node {
708 hir::ItemKind::Trait(.., ref generics, ref supertraits, _) => (generics, supertraits),
709 hir::ItemKind::TraitAlias(ref generics, ref supertraits) => (generics, supertraits),
710 _ => span_bug!(item.span, "super_predicates invoked on non-trait"),
713 let icx = ItemCtxt::new(tcx, trait_def_id);
715 // Convert the bounds that follow the colon, e.g., `Bar + Zed` in `trait Foo: Bar + Zed`.
716 let self_param_ty = tcx.mk_self_type();
717 let superbounds1 = AstConv::compute_bounds(&icx, self_param_ty, bounds, SizedByDefault::No,
720 let superbounds1 = superbounds1.predicates(tcx, self_param_ty);
722 // Convert any explicit superbounds in the where-clause,
723 // e.g., `trait Foo where Self: Bar`.
724 // In the case of trait aliases, however, we include all bounds in the where-clause,
725 // so e.g., `trait Foo = where u32: PartialEq<Self>` would include `u32: PartialEq<Self>`
726 // as one of its "superpredicates".
727 let is_trait_alias = tcx.is_trait_alias(trait_def_id);
728 let superbounds2 = icx.type_parameter_bounds_in_generics(
729 generics, item.hir_id, self_param_ty, OnlySelfBounds(!is_trait_alias));
731 // Combine the two lists to form the complete set of superbounds:
732 let superbounds: Vec<_> = superbounds1.into_iter().chain(superbounds2).collect();
734 // Now require that immediate supertraits are converted,
735 // which will, in turn, reach indirect supertraits.
736 for &(pred, span) in &superbounds {
737 debug!("superbound: {:?}", pred);
738 if let ty::Predicate::Trait(bound) = pred {
739 tcx.at(span).super_predicates_of(bound.def_id());
743 tcx.arena.alloc(ty::GenericPredicates {
745 predicates: superbounds,
749 fn trait_def(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::TraitDef {
750 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
751 let item = tcx.hir().expect_item(hir_id);
753 let (is_auto, unsafety) = match item.node {
754 hir::ItemKind::Trait(is_auto, unsafety, ..) => (is_auto == hir::IsAuto::Yes, unsafety),
755 hir::ItemKind::TraitAlias(..) => (false, hir::Unsafety::Normal),
756 _ => span_bug!(item.span, "trait_def_of_item invoked on non-trait"),
759 let paren_sugar = tcx.has_attr(def_id, sym::rustc_paren_sugar);
760 if paren_sugar && !tcx.features().unboxed_closures {
761 let mut err = tcx.sess.struct_span_err(
763 "the `#[rustc_paren_sugar]` attribute is a temporary means of controlling \
764 which traits can use parenthetical notation",
768 "add `#![feature(unboxed_closures)]` to \
769 the crate attributes to use it"
774 let is_marker = tcx.has_attr(def_id, sym::marker);
775 let def_path_hash = tcx.def_path_hash(def_id);
776 let def = ty::TraitDef::new(def_id, unsafety, paren_sugar, is_auto, is_marker, def_path_hash);
780 fn has_late_bound_regions<'tcx>(tcx: TyCtxt<'tcx>, node: Node<'tcx>) -> Option<Span> {
781 struct LateBoundRegionsDetector<'tcx> {
783 outer_index: ty::DebruijnIndex,
784 has_late_bound_regions: Option<Span>,
787 impl Visitor<'tcx> for LateBoundRegionsDetector<'tcx> {
788 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
789 NestedVisitorMap::None
792 fn visit_ty(&mut self, ty: &'tcx hir::Ty) {
793 if self.has_late_bound_regions.is_some() {
797 hir::TyKind::BareFn(..) => {
798 self.outer_index.shift_in(1);
799 intravisit::walk_ty(self, ty);
800 self.outer_index.shift_out(1);
802 _ => intravisit::walk_ty(self, ty),
806 fn visit_poly_trait_ref(
808 tr: &'tcx hir::PolyTraitRef,
809 m: hir::TraitBoundModifier,
811 if self.has_late_bound_regions.is_some() {
814 self.outer_index.shift_in(1);
815 intravisit::walk_poly_trait_ref(self, tr, m);
816 self.outer_index.shift_out(1);
819 fn visit_lifetime(&mut self, lt: &'tcx hir::Lifetime) {
820 if self.has_late_bound_regions.is_some() {
824 match self.tcx.named_region(lt.hir_id) {
825 Some(rl::Region::Static) | Some(rl::Region::EarlyBound(..)) => {}
826 Some(rl::Region::LateBound(debruijn, _, _))
827 | Some(rl::Region::LateBoundAnon(debruijn, _)) if debruijn < self.outer_index => {}
828 Some(rl::Region::LateBound(..))
829 | Some(rl::Region::LateBoundAnon(..))
830 | Some(rl::Region::Free(..))
832 self.has_late_bound_regions = Some(lt.span);
838 fn has_late_bound_regions<'tcx>(
840 generics: &'tcx hir::Generics,
841 decl: &'tcx hir::FnDecl,
843 let mut visitor = LateBoundRegionsDetector {
845 outer_index: ty::INNERMOST,
846 has_late_bound_regions: None,
848 for param in &generics.params {
849 if let GenericParamKind::Lifetime { .. } = param.kind {
850 if tcx.is_late_bound(param.hir_id) {
851 return Some(param.span);
855 visitor.visit_fn_decl(decl);
856 visitor.has_late_bound_regions
860 Node::TraitItem(item) => match item.node {
861 hir::TraitItemKind::Method(ref sig, _) => {
862 has_late_bound_regions(tcx, &item.generics, &sig.decl)
866 Node::ImplItem(item) => match item.node {
867 hir::ImplItemKind::Method(ref sig, _) => {
868 has_late_bound_regions(tcx, &item.generics, &sig.decl)
872 Node::ForeignItem(item) => match item.node {
873 hir::ForeignItemKind::Fn(ref fn_decl, _, ref generics) => {
874 has_late_bound_regions(tcx, generics, fn_decl)
878 Node::Item(item) => match item.node {
879 hir::ItemKind::Fn(ref fn_decl, .., ref generics, _) => {
880 has_late_bound_regions(tcx, generics, fn_decl)
888 fn generics_of(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::Generics {
891 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
893 let node = tcx.hir().get(hir_id);
894 let parent_def_id = match node {
895 Node::ImplItem(_) | Node::TraitItem(_) | Node::Variant(_) |
896 Node::Ctor(..) | Node::Field(_) => {
897 let parent_id = tcx.hir().get_parent_item(hir_id);
898 Some(tcx.hir().local_def_id(parent_id))
900 Node::Expr(&hir::Expr {
901 node: hir::ExprKind::Closure(..),
903 }) => Some(tcx.closure_base_def_id(def_id)),
904 Node::Item(item) => match item.node {
905 ItemKind::OpaqueTy(hir::OpaqueTy { impl_trait_fn, .. }) => impl_trait_fn,
911 let mut opt_self = None;
912 let mut allow_defaults = false;
914 let no_generics = hir::Generics::empty();
915 let ast_generics = match node {
916 Node::TraitItem(item) => &item.generics,
918 Node::ImplItem(item) => &item.generics,
920 Node::Item(item) => {
922 ItemKind::Fn(.., ref generics, _) | ItemKind::Impl(_, _, _, ref generics, ..) => {
926 ItemKind::TyAlias(_, ref generics)
927 | ItemKind::Enum(_, ref generics)
928 | ItemKind::Struct(_, ref generics)
929 | ItemKind::OpaqueTy(hir::OpaqueTy { ref generics, .. })
930 | ItemKind::Union(_, ref generics) => {
931 allow_defaults = true;
935 ItemKind::Trait(_, _, ref generics, ..)
936 | ItemKind::TraitAlias(ref generics, ..) => {
937 // Add in the self type parameter.
939 // Something of a hack: use the node id for the trait, also as
940 // the node id for the Self type parameter.
941 let param_id = item.hir_id;
943 opt_self = Some(ty::GenericParamDef {
945 name: kw::SelfUpper.as_interned_str(),
946 def_id: tcx.hir().local_def_id(param_id),
947 pure_wrt_drop: false,
948 kind: ty::GenericParamDefKind::Type {
950 object_lifetime_default: rl::Set1::Empty,
955 allow_defaults = true;
963 Node::ForeignItem(item) => match item.node {
964 ForeignItemKind::Static(..) => &no_generics,
965 ForeignItemKind::Fn(_, _, ref generics) => generics,
966 ForeignItemKind::Type => &no_generics,
972 let has_self = opt_self.is_some();
973 let mut parent_has_self = false;
974 let mut own_start = has_self as u32;
975 let parent_count = parent_def_id.map_or(0, |def_id| {
976 let generics = tcx.generics_of(def_id);
977 assert_eq!(has_self, false);
978 parent_has_self = generics.has_self;
979 own_start = generics.count() as u32;
980 generics.parent_count + generics.params.len()
983 let mut params: Vec<_> = opt_self.into_iter().collect();
985 let early_lifetimes = early_bound_lifetimes_from_generics(tcx, ast_generics);
989 .map(|(i, param)| ty::GenericParamDef {
990 name: param.name.ident().as_interned_str(),
991 index: own_start + i as u32,
992 def_id: tcx.hir().local_def_id(param.hir_id),
993 pure_wrt_drop: param.pure_wrt_drop,
994 kind: ty::GenericParamDefKind::Lifetime,
998 let object_lifetime_defaults = tcx.object_lifetime_defaults(hir_id);
1000 // Now create the real type parameters.
1001 let type_start = own_start - has_self as u32 + params.len() as u32;
1007 .filter_map(|param| {
1008 let kind = match param.kind {
1009 GenericParamKind::Type {
1014 if !allow_defaults && default.is_some() {
1015 if !tcx.features().default_type_parameter_fallback {
1017 lint::builtin::INVALID_TYPE_PARAM_DEFAULT,
1021 "defaults for type parameters are only allowed in \
1022 `struct`, `enum`, `type`, or `trait` definitions."
1028 ty::GenericParamDefKind::Type {
1029 has_default: default.is_some(),
1030 object_lifetime_default: object_lifetime_defaults
1032 .map_or(rl::Set1::Empty, |o| o[i]),
1036 GenericParamKind::Const { .. } => {
1037 ty::GenericParamDefKind::Const
1042 let param_def = ty::GenericParamDef {
1043 index: type_start + i as u32,
1044 name: param.name.ident().as_interned_str(),
1045 def_id: tcx.hir().local_def_id(param.hir_id),
1046 pure_wrt_drop: param.pure_wrt_drop,
1054 // provide junk type parameter defs - the only place that
1055 // cares about anything but the length is instantiation,
1056 // and we don't do that for closures.
1057 if let Node::Expr(&hir::Expr {
1058 node: hir::ExprKind::Closure(.., gen),
1062 let dummy_args = if gen.is_some() {
1063 &["<yield_ty>", "<return_ty>", "<witness>"][..]
1065 &["<closure_kind>", "<closure_signature>"][..]
1072 .map(|(i, &arg)| ty::GenericParamDef {
1073 index: type_start + i as u32,
1074 name: InternedString::intern(arg),
1076 pure_wrt_drop: false,
1077 kind: ty::GenericParamDefKind::Type {
1079 object_lifetime_default: rl::Set1::Empty,
1085 if let Some(upvars) = tcx.upvars(def_id) {
1086 params.extend(upvars.iter().zip((dummy_args.len() as u32)..).map(|(_, i)| {
1087 ty::GenericParamDef {
1088 index: type_start + i,
1089 name: InternedString::intern("<upvar>"),
1091 pure_wrt_drop: false,
1092 kind: ty::GenericParamDefKind::Type {
1094 object_lifetime_default: rl::Set1::Empty,
1102 let param_def_id_to_index = params
1104 .map(|param| (param.def_id, param.index))
1107 tcx.arena.alloc(ty::Generics {
1108 parent: parent_def_id,
1111 param_def_id_to_index,
1112 has_self: has_self || parent_has_self,
1113 has_late_bound_regions: has_late_bound_regions(tcx, node),
1117 fn report_assoc_ty_on_inherent_impl(tcx: TyCtxt<'_>, span: Span) {
1122 "associated types are not yet supported in inherent impls (see #8995)"
1126 fn type_of(tcx: TyCtxt<'_>, def_id: DefId) -> Ty<'_> {
1127 checked_type_of(tcx, def_id, true).unwrap()
1130 fn infer_placeholder_type(
1133 body_id: hir::BodyId,
1136 let ty = tcx.typeck_tables_of(def_id).node_type(body_id.hir_id);
1137 let mut diag = bad_placeholder_type(tcx, span);
1138 if ty != tcx.types.err {
1139 diag.span_suggestion(
1141 "replace `_` with the correct type",
1143 Applicability::MaybeIncorrect,
1150 /// Same as [`type_of`] but returns [`Option`] instead of failing.
1152 /// If you want to fail anyway, you can set the `fail` parameter to true, but in this case,
1153 /// you'd better just call [`type_of`] directly.
1154 pub fn checked_type_of(tcx: TyCtxt<'_>, def_id: DefId, fail: bool) -> Option<Ty<'_>> {
1157 let hir_id = match tcx.hir().as_local_hir_id(def_id) {
1158 Some(hir_id) => hir_id,
1163 bug!("invalid node");
1167 let icx = ItemCtxt::new(tcx, def_id);
1169 Some(match tcx.hir().get(hir_id) {
1170 Node::TraitItem(item) => match item.node {
1171 TraitItemKind::Method(..) => {
1172 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1173 tcx.mk_fn_def(def_id, substs)
1175 TraitItemKind::Const(ref ty, body_id) => {
1176 body_id.and_then(|body_id| {
1177 if let hir::TyKind::Infer = ty.node {
1178 Some(infer_placeholder_type(tcx, def_id, body_id, ty.span))
1182 }).unwrap_or_else(|| icx.to_ty(ty))
1184 TraitItemKind::Type(_, Some(ref ty)) => icx.to_ty(ty),
1185 TraitItemKind::Type(_, None) => {
1189 span_bug!(item.span, "associated type missing default");
1193 Node::ImplItem(item) => match item.node {
1194 ImplItemKind::Method(..) => {
1195 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1196 tcx.mk_fn_def(def_id, substs)
1198 ImplItemKind::Const(ref ty, body_id) => {
1199 if let hir::TyKind::Infer = ty.node {
1200 infer_placeholder_type(tcx, def_id, body_id, ty.span)
1205 ImplItemKind::OpaqueTy(_) => {
1207 .impl_trait_ref(tcx.hir().get_parent_did(hir_id))
1210 report_assoc_ty_on_inherent_impl(tcx, item.span);
1213 find_opaque_ty_constraints(tcx, def_id)
1215 ImplItemKind::TyAlias(ref ty) => {
1217 .impl_trait_ref(tcx.hir().get_parent_did(hir_id))
1220 report_assoc_ty_on_inherent_impl(tcx, item.span);
1227 Node::Item(item) => {
1229 ItemKind::Static(ref ty, .., body_id)
1230 | ItemKind::Const(ref ty, body_id) => {
1231 if let hir::TyKind::Infer = ty.node {
1232 infer_placeholder_type(tcx, def_id, body_id, ty.span)
1237 ItemKind::TyAlias(ref ty, _)
1238 | ItemKind::Impl(.., ref ty, _) => icx.to_ty(ty),
1239 ItemKind::Fn(..) => {
1240 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1241 tcx.mk_fn_def(def_id, substs)
1243 ItemKind::Enum(..) | ItemKind::Struct(..) | ItemKind::Union(..) => {
1244 let def = tcx.adt_def(def_id);
1245 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1246 tcx.mk_adt(def, substs)
1248 ItemKind::OpaqueTy(hir::OpaqueTy {
1249 impl_trait_fn: None,
1251 }) => find_opaque_ty_constraints(tcx, def_id),
1252 // Opaque types desugared from `impl Trait`.
1253 ItemKind::OpaqueTy(hir::OpaqueTy {
1254 impl_trait_fn: Some(owner),
1257 tcx.typeck_tables_of(owner)
1258 .concrete_opaque_types
1260 .map(|opaque| opaque.concrete_type)
1261 .unwrap_or_else(|| {
1262 // This can occur if some error in the
1263 // owner fn prevented us from populating
1264 // the `concrete_opaque_types` table.
1265 tcx.sess.delay_span_bug(
1268 "owner {:?} has no opaque type for {:?} in its tables",
1276 | ItemKind::TraitAlias(..)
1278 | ItemKind::ForeignMod(..)
1279 | ItemKind::GlobalAsm(..)
1280 | ItemKind::ExternCrate(..)
1281 | ItemKind::Use(..) => {
1287 "compute_type_of_item: unexpected item type: {:?}",
1294 Node::ForeignItem(foreign_item) => match foreign_item.node {
1295 ForeignItemKind::Fn(..) => {
1296 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1297 tcx.mk_fn_def(def_id, substs)
1299 ForeignItemKind::Static(ref t, _) => icx.to_ty(t),
1300 ForeignItemKind::Type => tcx.mk_foreign(def_id),
1303 Node::Ctor(&ref def) | Node::Variant(&Spanned {
1304 node: hir::VariantKind { data: ref def, .. },
1307 VariantData::Unit(..) | VariantData::Struct(..) => {
1308 tcx.type_of(tcx.hir().get_parent_did(hir_id))
1310 VariantData::Tuple(..) => {
1311 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1312 tcx.mk_fn_def(def_id, substs)
1316 Node::Field(field) => icx.to_ty(&field.ty),
1318 Node::Expr(&hir::Expr {
1319 node: hir::ExprKind::Closure(.., gen),
1323 return Some(tcx.typeck_tables_of(def_id).node_type(hir_id));
1326 let substs = ty::ClosureSubsts {
1327 substs: InternalSubsts::identity_for_item(tcx, def_id),
1330 tcx.mk_closure(def_id, substs)
1333 Node::AnonConst(_) => {
1334 let parent_node = tcx.hir().get(tcx.hir().get_parent_node(hir_id));
1337 node: hir::TyKind::Array(_, ref constant),
1340 | Node::Ty(&hir::Ty {
1341 node: hir::TyKind::Typeof(ref constant),
1344 | Node::Expr(&hir::Expr {
1345 node: ExprKind::Repeat(_, ref constant),
1347 }) if constant.hir_id == hir_id =>
1352 Node::Variant(&Spanned {
1355 disr_expr: Some(ref e),
1359 }) if e.hir_id == hir_id =>
1361 tcx.adt_def(tcx.hir().get_parent_did(hir_id))
1367 Node::Ty(&hir::Ty { node: hir::TyKind::Path(_), .. }) |
1368 Node::Expr(&hir::Expr { node: ExprKind::Struct(..), .. }) |
1369 Node::Expr(&hir::Expr { node: ExprKind::Path(_), .. }) |
1370 Node::TraitRef(..) => {
1371 let path = match parent_node {
1373 node: hir::TyKind::Path(QPath::Resolved(_, ref path)),
1376 | Node::Expr(&hir::Expr {
1377 node: ExprKind::Path(QPath::Resolved(_, ref path)),
1382 Node::Expr(&hir::Expr { node: ExprKind::Struct(ref path, ..), .. }) => {
1383 if let QPath::Resolved(_, ref path) = **path {
1389 Node::TraitRef(&hir::TraitRef { ref path, .. }) => Some(&**path),
1393 if let Some(path) = path {
1394 let arg_index = path.segments.iter()
1395 .filter_map(|seg| seg.args.as_ref())
1396 .map(|generic_args| generic_args.args.as_ref())
1399 .filter(|arg| arg.is_const())
1401 .filter(|(_, arg)| arg.id() == hir_id)
1402 .map(|(index, _)| index)
1409 bug!("no arg matching AnonConst in path")
1413 // We've encountered an `AnonConst` in some path, so we need to
1414 // figure out which generic parameter it corresponds to and return
1415 // the relevant type.
1416 let generics = match path.res {
1417 Res::Def(DefKind::Ctor(..), def_id) => {
1418 tcx.generics_of(tcx.parent(def_id).unwrap())
1420 Res::Def(_, def_id) => tcx.generics_of(def_id),
1421 Res::Err => return Some(tcx.types.err),
1422 _ if !fail => return None,
1424 tcx.sess.delay_span_bug(
1427 "unexpected const parent path def {:?}",
1431 return Some(tcx.types.err);
1435 generics.params.iter()
1437 if let ty::GenericParamDefKind::Const = param.kind {
1444 .map(|param| tcx.type_of(param.def_id))
1445 // This is no generic parameter associated with the arg. This is
1446 // probably from an extra arg where one is not needed.
1447 .unwrap_or(tcx.types.err)
1452 tcx.sess.delay_span_bug(
1455 "unexpected const parent path {:?}",
1459 return Some(tcx.types.err);
1467 tcx.sess.delay_span_bug(
1470 "unexpected const parent in type_of_def_id(): {:?}", x
1478 Node::GenericParam(param) => match ¶m.kind {
1479 hir::GenericParamKind::Type { default: Some(ref ty), .. } |
1480 hir::GenericParamKind::Const { ref ty, .. } => {
1487 bug!("unexpected non-type Node::GenericParam: {:?}", x)
1495 bug!("unexpected sort of node in type_of_def_id(): {:?}", x);
1500 fn find_opaque_ty_constraints(tcx: TyCtxt<'_>, def_id: DefId) -> Ty<'_> {
1501 use rustc::hir::{ImplItem, Item, TraitItem};
1503 debug!("find_opaque_ty_constraints({:?})", def_id);
1505 struct ConstraintLocator<'tcx> {
1508 // (first found type span, actual type, mapping from the opaque type's generic
1509 // parameters to the concrete type's generic parameters)
1511 // The mapping is an index for each use site of a generic parameter in the concrete type
1513 // The indices index into the generic parameters on the opaque type.
1514 found: Option<(Span, Ty<'tcx>, Vec<usize>)>,
1517 impl ConstraintLocator<'tcx> {
1518 fn check(&mut self, def_id: DefId) {
1519 // Don't try to check items that cannot possibly constrain the type.
1520 if !self.tcx.has_typeck_tables(def_id) {
1522 "find_opaque_ty_constraints: no constraint for `{:?}` at `{:?}`: no tables",
1530 .typeck_tables_of(def_id)
1531 .concrete_opaque_types
1533 if let Some(ty::ResolvedOpaqueTy { concrete_type, substs }) = ty {
1535 "find_opaque_ty_constraints: found constraint for `{:?}` at `{:?}`: {:?}",
1541 // FIXME(oli-obk): trace the actual span from inference to improve errors.
1542 let span = self.tcx.def_span(def_id);
1543 // used to quickly look up the position of a generic parameter
1544 let mut index_map: FxHashMap<ty::ParamTy, usize> = FxHashMap::default();
1545 // Skipping binder is ok, since we only use this to find generic parameters and
1547 for (idx, subst) in substs.iter().enumerate() {
1548 if let UnpackedKind::Type(ty) = subst.unpack() {
1549 if let ty::Param(p) = ty.sty {
1550 if index_map.insert(p, idx).is_some() {
1551 // There was already an entry for `p`, meaning a generic parameter
1553 self.tcx.sess.span_err(
1556 "defining opaque type use restricts opaque \
1557 type by using the generic parameter `{}` twice",
1564 self.tcx.sess.delay_span_bug(
1567 "non-defining opaque ty use in defining scope: {:?}, {:?}",
1568 concrete_type, substs,
1574 // Compute the index within the opaque type for each generic parameter used in
1575 // the concrete type.
1576 let indices = concrete_type
1577 .subst(self.tcx, substs)
1579 .filter_map(|t| match &t.sty {
1580 ty::Param(p) => Some(*index_map.get(p).unwrap()),
1583 let is_param = |ty: Ty<'_>| match ty.sty {
1584 ty::Param(_) => true,
1587 if !substs.types().all(is_param) {
1588 self.tcx.sess.span_err(
1590 "defining opaque type use does not fully define opaque type",
1592 } else if let Some((prev_span, prev_ty, ref prev_indices)) = self.found {
1593 let mut ty = concrete_type.walk().fuse();
1594 let mut p_ty = prev_ty.walk().fuse();
1595 let iter_eq = (&mut ty).zip(&mut p_ty).all(|(t, p)| match (&t.sty, &p.sty) {
1596 // Type parameters are equal to any other type parameter for the purpose of
1597 // concrete type equality, as it is possible to obtain the same type just
1598 // by passing matching parameters to a function.
1599 (ty::Param(_), ty::Param(_)) => true,
1602 if !iter_eq || ty.next().is_some() || p_ty.next().is_some() {
1603 debug!("find_opaque_ty_constraints: span={:?}", span);
1604 // Found different concrete types for the opaque type.
1605 let mut err = self.tcx.sess.struct_span_err(
1607 "concrete type differs from previous defining opaque type use",
1611 format!("expected `{}`, got `{}`", prev_ty, concrete_type),
1613 err.span_note(prev_span, "previous use here");
1615 } else if indices != *prev_indices {
1616 // Found "same" concrete types, but the generic parameter order differs.
1617 let mut err = self.tcx.sess.struct_span_err(
1619 "concrete type's generic parameters differ from previous defining use",
1621 use std::fmt::Write;
1622 let mut s = String::new();
1623 write!(s, "expected [").unwrap();
1624 let list = |s: &mut String, indices: &Vec<usize>| {
1625 let mut indices = indices.iter().cloned();
1626 if let Some(first) = indices.next() {
1627 write!(s, "`{}`", substs[first]).unwrap();
1629 write!(s, ", `{}`", substs[i]).unwrap();
1633 list(&mut s, prev_indices);
1634 write!(s, "], got [").unwrap();
1635 list(&mut s, &indices);
1636 write!(s, "]").unwrap();
1637 err.span_label(span, s);
1638 err.span_note(prev_span, "previous use here");
1642 self.found = Some((span, concrete_type, indices));
1646 "find_opaque_ty_constraints: no constraint for `{:?}` at `{:?}`",
1654 impl<'tcx> intravisit::Visitor<'tcx> for ConstraintLocator<'tcx> {
1655 fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
1656 intravisit::NestedVisitorMap::All(&self.tcx.hir())
1658 fn visit_item(&mut self, it: &'tcx Item) {
1659 debug!("find_existential_constraints: visiting {:?}", it);
1660 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1661 // The opaque type itself or its children are not within its reveal scope.
1662 if def_id != self.def_id {
1664 intravisit::walk_item(self, it);
1667 fn visit_impl_item(&mut self, it: &'tcx ImplItem) {
1668 debug!("find_existential_constraints: visiting {:?}", it);
1669 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1670 // The opaque type itself or its children are not within its reveal scope.
1671 if def_id != self.def_id {
1673 intravisit::walk_impl_item(self, it);
1676 fn visit_trait_item(&mut self, it: &'tcx TraitItem) {
1677 debug!("find_existential_constraints: visiting {:?}", it);
1678 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1680 intravisit::walk_trait_item(self, it);
1684 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1685 let scope = tcx.hir()
1686 .get_defining_scope(hir_id)
1687 .expect("could not get defining scope");
1688 let mut locator = ConstraintLocator {
1694 debug!("find_opaque_ty_constraints: scope={:?}", scope);
1696 if scope == hir::CRATE_HIR_ID {
1697 intravisit::walk_crate(&mut locator, tcx.hir().krate());
1699 debug!("find_opaque_ty_constraints: scope={:?}", tcx.hir().get(scope));
1700 match tcx.hir().get(scope) {
1701 // We explicitly call `visit_*` methods, instead of using `intravisit::walk_*` methods
1702 // This allows our visitor to process the defining item itself, causing
1703 // it to pick up any 'sibling' defining uses.
1705 // For example, this code:
1708 // type Blah = impl Debug;
1709 // let my_closure = || -> Blah { true };
1713 // requires us to explicitly process `foo()` in order
1714 // to notice the defining usage of `Blah`.
1715 Node::Item(ref it) => locator.visit_item(it),
1716 Node::ImplItem(ref it) => locator.visit_impl_item(it),
1717 Node::TraitItem(ref it) => locator.visit_trait_item(it),
1719 "{:?} is not a valid scope for an opaque type item",
1725 match locator.found {
1726 Some((_, ty, _)) => ty,
1728 let span = tcx.def_span(def_id);
1729 tcx.sess.span_err(span, "could not find defining uses");
1735 pub fn get_infer_ret_ty(output: &'_ hir::FunctionRetTy) -> Option<&hir::Ty> {
1736 if let hir::FunctionRetTy::Return(ref ty) = output {
1737 if let hir::TyKind::Infer = ty.node {
1744 fn fn_sig(tcx: TyCtxt<'_>, def_id: DefId) -> ty::PolyFnSig<'_> {
1746 use rustc::hir::Node::*;
1748 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1750 let icx = ItemCtxt::new(tcx, def_id);
1752 match tcx.hir().get(hir_id) {
1753 TraitItem(hir::TraitItem {
1754 node: TraitItemKind::Method(MethodSig { header, decl }, TraitMethod::Provided(_)),
1757 | ImplItem(hir::ImplItem {
1758 node: ImplItemKind::Method(MethodSig { header, decl }, _),
1762 node: ItemKind::Fn(decl, header, _, _),
1764 }) => match get_infer_ret_ty(&decl.output) {
1766 let fn_sig = tcx.typeck_tables_of(def_id).liberated_fn_sigs()[hir_id];
1767 let mut diag = bad_placeholder_type(tcx, ty.span);
1768 let ret_ty = fn_sig.output();
1769 if ret_ty != tcx.types.err {
1770 diag.span_suggestion(
1772 "replace `_` with the correct return type",
1774 Applicability::MaybeIncorrect,
1778 ty::Binder::bind(fn_sig)
1780 None => AstConv::ty_of_fn(&icx, header.unsafety, header.abi, decl)
1783 TraitItem(hir::TraitItem {
1784 node: TraitItemKind::Method(MethodSig { header, decl }, _),
1787 AstConv::ty_of_fn(&icx, header.unsafety, header.abi, decl)
1790 ForeignItem(&hir::ForeignItem {
1791 node: ForeignItemKind::Fn(ref fn_decl, _, _),
1794 let abi = tcx.hir().get_foreign_abi(hir_id);
1795 compute_sig_of_foreign_fn_decl(tcx, def_id, fn_decl, abi)
1798 Ctor(data) | Variant(Spanned {
1799 node: hir::VariantKind { data, .. },
1801 }) if data.ctor_hir_id().is_some() => {
1802 let ty = tcx.type_of(tcx.hir().get_parent_did(hir_id));
1803 let inputs = data.fields()
1805 .map(|f| tcx.type_of(tcx.hir().local_def_id(f.hir_id)));
1806 ty::Binder::bind(tcx.mk_fn_sig(
1810 hir::Unsafety::Normal,
1816 node: hir::ExprKind::Closure(..),
1819 // Closure signatures are not like other function
1820 // signatures and cannot be accessed through `fn_sig`. For
1821 // example, a closure signature excludes the `self`
1822 // argument. In any case they are embedded within the
1823 // closure type as part of the `ClosureSubsts`.
1826 // the signature of a closure, you should use the
1827 // `closure_sig` method on the `ClosureSubsts`:
1829 // closure_substs.closure_sig(def_id, tcx)
1831 // or, inside of an inference context, you can use
1833 // infcx.closure_sig(def_id, closure_substs)
1834 bug!("to get the signature of a closure, use `closure_sig()` not `fn_sig()`");
1838 bug!("unexpected sort of node in fn_sig(): {:?}", x);
1843 fn impl_trait_ref(tcx: TyCtxt<'_>, def_id: DefId) -> Option<ty::TraitRef<'_>> {
1844 let icx = ItemCtxt::new(tcx, def_id);
1846 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1847 match tcx.hir().expect_item(hir_id).node {
1848 hir::ItemKind::Impl(.., ref opt_trait_ref, _, _) => {
1849 opt_trait_ref.as_ref().map(|ast_trait_ref| {
1850 let selfty = tcx.type_of(def_id);
1851 AstConv::instantiate_mono_trait_ref(&icx, ast_trait_ref, selfty)
1858 fn impl_polarity(tcx: TyCtxt<'_>, def_id: DefId) -> hir::ImplPolarity {
1859 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1860 match tcx.hir().expect_item(hir_id).node {
1861 hir::ItemKind::Impl(_, polarity, ..) => polarity,
1862 ref item => bug!("impl_polarity: {:?} not an impl", item),
1866 /// Returns the early-bound lifetimes declared in this generics
1867 /// listing. For anything other than fns/methods, this is just all
1868 /// the lifetimes that are declared. For fns or methods, we have to
1869 /// screen out those that do not appear in any where-clauses etc using
1870 /// `resolve_lifetime::early_bound_lifetimes`.
1871 fn early_bound_lifetimes_from_generics<'a, 'tcx: 'a>(
1873 generics: &'a hir::Generics,
1874 ) -> impl Iterator<Item = &'a hir::GenericParam> + Captures<'tcx> {
1878 .filter(move |param| match param.kind {
1879 GenericParamKind::Lifetime { .. } => {
1880 !tcx.is_late_bound(param.hir_id)
1886 /// Returns a list of type predicates for the definition with ID `def_id`, including inferred
1887 /// lifetime constraints. This includes all predicates returned by `explicit_predicates_of`, plus
1888 /// inferred constraints concerning which regions outlive other regions.
1889 fn predicates_defined_on(
1892 ) -> &ty::GenericPredicates<'_> {
1893 debug!("predicates_defined_on({:?})", def_id);
1894 let mut result = tcx.explicit_predicates_of(def_id);
1896 "predicates_defined_on: explicit_predicates_of({:?}) = {:?}",
1900 let inferred_outlives = tcx.inferred_outlives_of(def_id);
1901 if !inferred_outlives.is_empty() {
1902 let span = tcx.def_span(def_id);
1904 "predicates_defined_on: inferred_outlives_of({:?}) = {:?}",
1908 let mut predicates = (*result).clone();
1909 predicates.predicates.extend(inferred_outlives.iter().map(|&p| (p, span)));
1910 result = tcx.arena.alloc(predicates);
1912 debug!("predicates_defined_on({:?}) = {:?}", def_id, result);
1916 /// Returns a list of all type predicates (explicit and implicit) for the definition with
1917 /// ID `def_id`. This includes all predicates returned by `predicates_defined_on`, plus
1918 /// `Self: Trait` predicates for traits.
1919 fn predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::GenericPredicates<'_> {
1920 let mut result = tcx.predicates_defined_on(def_id);
1922 if tcx.is_trait(def_id) {
1923 // For traits, add `Self: Trait` predicate. This is
1924 // not part of the predicates that a user writes, but it
1925 // is something that one must prove in order to invoke a
1926 // method or project an associated type.
1928 // In the chalk setup, this predicate is not part of the
1929 // "predicates" for a trait item. But it is useful in
1930 // rustc because if you directly (e.g.) invoke a trait
1931 // method like `Trait::method(...)`, you must naturally
1932 // prove that the trait applies to the types that were
1933 // used, and adding the predicate into this list ensures
1934 // that this is done.
1935 let span = tcx.def_span(def_id);
1936 let mut predicates = (*result).clone();
1937 predicates.predicates.push((ty::TraitRef::identity(tcx, def_id).to_predicate(), span));
1938 result = tcx.arena.alloc(predicates);
1940 debug!("predicates_of(def_id={:?}) = {:?}", def_id, result);
1944 /// Returns a list of user-specified type predicates for the definition with ID `def_id`.
1945 /// N.B., this does not include any implied/inferred constraints.
1946 fn explicit_predicates_of(
1949 ) -> &ty::GenericPredicates<'_> {
1951 use rustc_data_structures::fx::FxHashSet;
1953 debug!("explicit_predicates_of(def_id={:?})", def_id);
1955 /// A data structure with unique elements, which preserves order of insertion.
1956 /// Preserving the order of insertion is important here so as not to break
1957 /// compile-fail UI tests.
1958 struct UniquePredicates<'tcx> {
1959 predicates: Vec<(ty::Predicate<'tcx>, Span)>,
1960 uniques: FxHashSet<(ty::Predicate<'tcx>, Span)>,
1963 impl<'tcx> UniquePredicates<'tcx> {
1967 uniques: FxHashSet::default(),
1971 fn push(&mut self, value: (ty::Predicate<'tcx>, Span)) {
1972 if self.uniques.insert(value) {
1973 self.predicates.push(value);
1977 fn extend<I: IntoIterator<Item = (ty::Predicate<'tcx>, Span)>>(&mut self, iter: I) {
1984 let hir_id = match tcx.hir().as_local_hir_id(def_id) {
1985 Some(hir_id) => hir_id,
1986 None => return tcx.predicates_of(def_id),
1988 let node = tcx.hir().get(hir_id);
1990 let mut is_trait = None;
1991 let mut is_default_impl_trait = None;
1993 let icx = ItemCtxt::new(tcx, def_id);
1995 const NO_GENERICS: &hir::Generics = &hir::Generics::empty();
1997 let empty_trait_items = HirVec::new();
1999 let mut predicates = UniquePredicates::new();
2001 let ast_generics = match node {
2002 Node::TraitItem(item) => &item.generics,
2004 Node::ImplItem(item) => match item.node {
2005 ImplItemKind::OpaqueTy(ref bounds) => {
2006 let substs = InternalSubsts::identity_for_item(tcx, def_id);
2007 let opaque_ty = tcx.mk_opaque(def_id, substs);
2009 // Collect the bounds, i.e., the `A + B + 'c` in `impl A + B + 'c`.
2010 let bounds = AstConv::compute_bounds(
2014 SizedByDefault::Yes,
2015 tcx.def_span(def_id),
2018 predicates.extend(bounds.predicates(tcx, opaque_ty));
2021 _ => &item.generics,
2024 Node::Item(item) => {
2026 ItemKind::Impl(_, _, defaultness, ref generics, ..) => {
2027 if defaultness.is_default() {
2028 is_default_impl_trait = tcx.impl_trait_ref(def_id);
2032 ItemKind::Fn(.., ref generics, _)
2033 | ItemKind::TyAlias(_, ref generics)
2034 | ItemKind::Enum(_, ref generics)
2035 | ItemKind::Struct(_, ref generics)
2036 | ItemKind::Union(_, ref generics) => generics,
2038 ItemKind::Trait(_, _, ref generics, .., ref items) => {
2039 is_trait = Some((ty::TraitRef::identity(tcx, def_id), items));
2042 ItemKind::TraitAlias(ref generics, _) => {
2043 is_trait = Some((ty::TraitRef::identity(tcx, def_id), &empty_trait_items));
2046 ItemKind::OpaqueTy(OpaqueTy {
2052 let substs = InternalSubsts::identity_for_item(tcx, def_id);
2053 let opaque_ty = tcx.mk_opaque(def_id, substs);
2055 // Collect the bounds, i.e., the `A + B + 'c` in `impl A + B + 'c`.
2056 let bounds = AstConv::compute_bounds(
2060 SizedByDefault::Yes,
2061 tcx.def_span(def_id),
2064 let bounds_predicates = bounds.predicates(tcx, opaque_ty);
2065 if impl_trait_fn.is_some() {
2067 return tcx.arena.alloc(ty::GenericPredicates {
2069 predicates: bounds_predicates,
2072 // named opaque types
2073 predicates.extend(bounds_predicates);
2082 Node::ForeignItem(item) => match item.node {
2083 ForeignItemKind::Static(..) => NO_GENERICS,
2084 ForeignItemKind::Fn(_, _, ref generics) => generics,
2085 ForeignItemKind::Type => NO_GENERICS,
2091 let generics = tcx.generics_of(def_id);
2092 let parent_count = generics.parent_count as u32;
2093 let has_own_self = generics.has_self && parent_count == 0;
2095 // Below we'll consider the bounds on the type parameters (including `Self`)
2096 // and the explicit where-clauses, but to get the full set of predicates
2097 // on a trait we need to add in the supertrait bounds and bounds found on
2098 // associated types.
2099 if let Some((_trait_ref, _)) = is_trait {
2100 predicates.extend(tcx.super_predicates_of(def_id).predicates.iter().cloned());
2103 // In default impls, we can assume that the self type implements
2104 // the trait. So in:
2106 // default impl Foo for Bar { .. }
2108 // we add a default where clause `Foo: Bar`. We do a similar thing for traits
2109 // (see below). Recall that a default impl is not itself an impl, but rather a
2110 // set of defaults that can be incorporated into another impl.
2111 if let Some(trait_ref) = is_default_impl_trait {
2112 predicates.push((trait_ref.to_poly_trait_ref().to_predicate(), tcx.def_span(def_id)));
2115 // Collect the region predicates that were declared inline as
2116 // well. In the case of parameters declared on a fn or method, we
2117 // have to be careful to only iterate over early-bound regions.
2118 let mut index = parent_count + has_own_self as u32;
2119 for param in early_bound_lifetimes_from_generics(tcx, ast_generics) {
2120 let region = tcx.mk_region(ty::ReEarlyBound(ty::EarlyBoundRegion {
2121 def_id: tcx.hir().local_def_id(param.hir_id),
2123 name: param.name.ident().as_interned_str(),
2128 GenericParamKind::Lifetime { .. } => {
2129 param.bounds.iter().for_each(|bound| match bound {
2130 hir::GenericBound::Outlives(lt) => {
2131 let bound = AstConv::ast_region_to_region(&icx, <, None);
2132 let outlives = ty::Binder::bind(ty::OutlivesPredicate(region, bound));
2133 predicates.push((outlives.to_predicate(), lt.span));
2142 // Collect the predicates that were written inline by the user on each
2143 // type parameter (e.g., `<T: Foo>`).
2144 for param in &ast_generics.params {
2145 if let GenericParamKind::Type { .. } = param.kind {
2146 let name = param.name.ident().as_interned_str();
2147 let param_ty = ty::ParamTy::new(index, name).to_ty(tcx);
2150 let sized = SizedByDefault::Yes;
2151 let bounds = AstConv::compute_bounds(&icx, param_ty, ¶m.bounds, sized, param.span);
2152 predicates.extend(bounds.predicates(tcx, param_ty));
2156 // Add in the bounds that appear in the where-clause.
2157 let where_clause = &ast_generics.where_clause;
2158 for predicate in &where_clause.predicates {
2160 &hir::WherePredicate::BoundPredicate(ref bound_pred) => {
2161 let ty = icx.to_ty(&bound_pred.bounded_ty);
2163 // Keep the type around in a dummy predicate, in case of no bounds.
2164 // That way, `where Ty:` is not a complete noop (see #53696) and `Ty`
2165 // is still checked for WF.
2166 if bound_pred.bounds.is_empty() {
2167 if let ty::Param(_) = ty.sty {
2168 // This is a `where T:`, which can be in the HIR from the
2169 // transformation that moves `?Sized` to `T`'s declaration.
2170 // We can skip the predicate because type parameters are
2171 // trivially WF, but also we *should*, to avoid exposing
2172 // users who never wrote `where Type:,` themselves, to
2173 // compiler/tooling bugs from not handling WF predicates.
2175 let span = bound_pred.bounded_ty.span;
2176 let predicate = ty::OutlivesPredicate(ty, tcx.mk_region(ty::ReEmpty));
2178 (ty::Predicate::TypeOutlives(ty::Binder::dummy(predicate)), span)
2183 for bound in bound_pred.bounds.iter() {
2185 &hir::GenericBound::Trait(ref poly_trait_ref, _) => {
2186 let mut bounds = Bounds::default();
2187 let _ = AstConv::instantiate_poly_trait_ref(
2193 predicates.extend(bounds.predicates(tcx, ty));
2196 &hir::GenericBound::Outlives(ref lifetime) => {
2197 let region = AstConv::ast_region_to_region(&icx, lifetime, None);
2198 let pred = ty::Binder::bind(ty::OutlivesPredicate(ty, region));
2199 predicates.push((ty::Predicate::TypeOutlives(pred), lifetime.span))
2205 &hir::WherePredicate::RegionPredicate(ref region_pred) => {
2206 let r1 = AstConv::ast_region_to_region(&icx, ®ion_pred.lifetime, None);
2207 predicates.extend(region_pred.bounds.iter().map(|bound| {
2208 let (r2, span) = match bound {
2209 hir::GenericBound::Outlives(lt) => {
2210 (AstConv::ast_region_to_region(&icx, lt, None), lt.span)
2214 let pred = ty::Binder::bind(ty::OutlivesPredicate(r1, r2));
2216 (ty::Predicate::RegionOutlives(pred), span)
2220 &hir::WherePredicate::EqPredicate(..) => {
2226 // Add predicates from associated type bounds.
2227 if let Some((self_trait_ref, trait_items)) = is_trait {
2228 predicates.extend(trait_items.iter().flat_map(|trait_item_ref| {
2229 let trait_item = tcx.hir().trait_item(trait_item_ref.id);
2230 let bounds = match trait_item.node {
2231 hir::TraitItemKind::Type(ref bounds, _) => bounds,
2232 _ => return Vec::new().into_iter()
2236 tcx.mk_projection(tcx.hir().local_def_id(trait_item.hir_id),
2237 self_trait_ref.substs);
2239 let bounds = AstConv::compute_bounds(
2240 &ItemCtxt::new(tcx, def_id),
2243 SizedByDefault::Yes,
2247 bounds.predicates(tcx, assoc_ty).into_iter()
2251 let mut predicates = predicates.predicates;
2253 // Subtle: before we store the predicates into the tcx, we
2254 // sort them so that predicates like `T: Foo<Item=U>` come
2255 // before uses of `U`. This avoids false ambiguity errors
2256 // in trait checking. See `setup_constraining_predicates`
2258 if let Node::Item(&Item {
2259 node: ItemKind::Impl(..),
2263 let self_ty = tcx.type_of(def_id);
2264 let trait_ref = tcx.impl_trait_ref(def_id);
2265 cgp::setup_constraining_predicates(
2269 &mut cgp::parameters_for_impl(self_ty, trait_ref),
2273 let result = tcx.arena.alloc(ty::GenericPredicates {
2274 parent: generics.parent,
2277 debug!("explicit_predicates_of(def_id={:?}) = {:?}", def_id, result);
2281 /// Converts a specific `GenericBound` from the AST into a set of
2282 /// predicates that apply to the self type. A vector is returned
2283 /// because this can be anywhere from zero predicates (`T: ?Sized` adds no
2284 /// predicates) to one (`T: Foo`) to many (`T: Bar<X = i32>` adds `T: Bar`
2285 /// and `<T as Bar>::X == i32`).
2286 fn predicates_from_bound<'tcx>(
2287 astconv: &dyn AstConv<'tcx>,
2289 bound: &'tcx hir::GenericBound,
2290 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
2292 hir::GenericBound::Trait(ref tr, hir::TraitBoundModifier::None) => {
2293 let mut bounds = Bounds::default();
2294 let _ = astconv.instantiate_poly_trait_ref(
2299 bounds.predicates(astconv.tcx(), param_ty)
2301 hir::GenericBound::Outlives(ref lifetime) => {
2302 let region = astconv.ast_region_to_region(lifetime, None);
2303 let pred = ty::Binder::bind(ty::OutlivesPredicate(param_ty, region));
2304 vec![(ty::Predicate::TypeOutlives(pred), lifetime.span)]
2306 hir::GenericBound::Trait(_, hir::TraitBoundModifier::Maybe) => vec![],
2310 fn compute_sig_of_foreign_fn_decl<'tcx>(
2313 decl: &'tcx hir::FnDecl,
2315 ) -> ty::PolyFnSig<'tcx> {
2316 let unsafety = if abi == abi::Abi::RustIntrinsic {
2317 intrisic_operation_unsafety(&*tcx.item_name(def_id).as_str())
2319 hir::Unsafety::Unsafe
2321 let fty = AstConv::ty_of_fn(&ItemCtxt::new(tcx, def_id), unsafety, abi, decl);
2323 // Feature gate SIMD types in FFI, since I am not sure that the
2324 // ABIs are handled at all correctly. -huonw
2325 if abi != abi::Abi::RustIntrinsic
2326 && abi != abi::Abi::PlatformIntrinsic
2327 && !tcx.features().simd_ffi
2329 let check = |ast_ty: &hir::Ty, ty: Ty<'_>| {
2335 "use of SIMD type `{}` in FFI is highly experimental and \
2336 may result in invalid code",
2337 tcx.hir().hir_to_pretty_string(ast_ty.hir_id)
2340 .help("add `#![feature(simd_ffi)]` to the crate attributes to enable")
2344 for (input, ty) in decl.inputs.iter().zip(*fty.inputs().skip_binder()) {
2347 if let hir::Return(ref ty) = decl.output {
2348 check(&ty, *fty.output().skip_binder())
2355 fn is_foreign_item(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
2356 match tcx.hir().get_if_local(def_id) {
2357 Some(Node::ForeignItem(..)) => true,
2359 _ => bug!("is_foreign_item applied to non-local def-id {:?}", def_id),
2363 fn static_mutability(tcx: TyCtxt<'_>, def_id: DefId) -> Option<hir::Mutability> {
2364 match tcx.hir().get_if_local(def_id) {
2365 Some(Node::Item(&hir::Item {
2366 node: hir::ItemKind::Static(_, mutbl, _), ..
2368 Some(Node::ForeignItem( &hir::ForeignItem {
2369 node: hir::ForeignItemKind::Static(_, mutbl), ..
2372 _ => bug!("static_mutability applied to non-local def-id {:?}", def_id),
2376 fn from_target_feature(
2379 attr: &ast::Attribute,
2380 whitelist: &FxHashMap<String, Option<Symbol>>,
2381 target_features: &mut Vec<Symbol>,
2383 let list = match attr.meta_item_list() {
2387 let bad_item = |span| {
2388 let msg = "malformed `target_feature` attribute input";
2389 let code = "enable = \"..\"".to_owned();
2390 tcx.sess.struct_span_err(span, &msg)
2391 .span_suggestion(span, "must be of the form", code, Applicability::HasPlaceholders)
2394 let rust_features = tcx.features();
2396 // Only `enable = ...` is accepted in the meta-item list.
2397 if !item.check_name(sym::enable) {
2398 bad_item(item.span());
2402 // Must be of the form `enable = "..."` (a string).
2403 let value = match item.value_str() {
2404 Some(value) => value,
2406 bad_item(item.span());
2411 // We allow comma separation to enable multiple features.
2412 target_features.extend(value.as_str().split(',').filter_map(|feature| {
2413 // Only allow whitelisted features per platform.
2414 let feature_gate = match whitelist.get(feature) {
2418 "the feature named `{}` is not valid for this target",
2421 let mut err = tcx.sess.struct_span_err(item.span(), &msg);
2424 format!("`{}` is not valid for this target", feature),
2426 if feature.starts_with("+") {
2427 let valid = whitelist.contains_key(&feature[1..]);
2429 err.help("consider removing the leading `+` in the feature name");
2437 // Only allow features whose feature gates have been enabled.
2438 let allowed = match feature_gate.as_ref().map(|s| *s) {
2439 Some(sym::arm_target_feature) => rust_features.arm_target_feature,
2440 Some(sym::aarch64_target_feature) => rust_features.aarch64_target_feature,
2441 Some(sym::hexagon_target_feature) => rust_features.hexagon_target_feature,
2442 Some(sym::powerpc_target_feature) => rust_features.powerpc_target_feature,
2443 Some(sym::mips_target_feature) => rust_features.mips_target_feature,
2444 Some(sym::avx512_target_feature) => rust_features.avx512_target_feature,
2445 Some(sym::mmx_target_feature) => rust_features.mmx_target_feature,
2446 Some(sym::sse4a_target_feature) => rust_features.sse4a_target_feature,
2447 Some(sym::tbm_target_feature) => rust_features.tbm_target_feature,
2448 Some(sym::wasm_target_feature) => rust_features.wasm_target_feature,
2449 Some(sym::cmpxchg16b_target_feature) => rust_features.cmpxchg16b_target_feature,
2450 Some(sym::adx_target_feature) => rust_features.adx_target_feature,
2451 Some(sym::movbe_target_feature) => rust_features.movbe_target_feature,
2452 Some(sym::rtm_target_feature) => rust_features.rtm_target_feature,
2453 Some(sym::f16c_target_feature) => rust_features.f16c_target_feature,
2454 Some(name) => bug!("unknown target feature gate {}", name),
2457 if !allowed && id.is_local() {
2458 feature_gate::emit_feature_err(
2459 &tcx.sess.parse_sess,
2460 feature_gate.unwrap(),
2462 feature_gate::GateIssue::Language,
2463 &format!("the target feature `{}` is currently unstable", feature),
2466 Some(Symbol::intern(feature))
2471 fn linkage_by_name(tcx: TyCtxt<'_>, def_id: DefId, name: &str) -> Linkage {
2472 use rustc::mir::mono::Linkage::*;
2474 // Use the names from src/llvm/docs/LangRef.rst here. Most types are only
2475 // applicable to variable declarations and may not really make sense for
2476 // Rust code in the first place but whitelist them anyway and trust that
2477 // the user knows what s/he's doing. Who knows, unanticipated use cases
2478 // may pop up in the future.
2480 // ghost, dllimport, dllexport and linkonce_odr_autohide are not supported
2481 // and don't have to be, LLVM treats them as no-ops.
2483 "appending" => Appending,
2484 "available_externally" => AvailableExternally,
2486 "extern_weak" => ExternalWeak,
2487 "external" => External,
2488 "internal" => Internal,
2489 "linkonce" => LinkOnceAny,
2490 "linkonce_odr" => LinkOnceODR,
2491 "private" => Private,
2493 "weak_odr" => WeakODR,
2495 let span = tcx.hir().span_if_local(def_id);
2496 if let Some(span) = span {
2497 tcx.sess.span_fatal(span, "invalid linkage specified")
2500 .fatal(&format!("invalid linkage specified: {}", name))
2506 fn codegen_fn_attrs(tcx: TyCtxt<'_>, id: DefId) -> CodegenFnAttrs {
2507 let attrs = tcx.get_attrs(id);
2509 let mut codegen_fn_attrs = CodegenFnAttrs::new();
2511 let whitelist = tcx.target_features_whitelist(LOCAL_CRATE);
2513 let mut inline_span = None;
2514 for attr in attrs.iter() {
2515 if attr.check_name(sym::cold) {
2516 codegen_fn_attrs.flags |= CodegenFnAttrFlags::COLD;
2517 } else if attr.check_name(sym::rustc_allocator) {
2518 codegen_fn_attrs.flags |= CodegenFnAttrFlags::ALLOCATOR;
2519 } else if attr.check_name(sym::unwind) {
2520 codegen_fn_attrs.flags |= CodegenFnAttrFlags::UNWIND;
2521 } else if attr.check_name(sym::ffi_returns_twice) {
2522 if tcx.is_foreign_item(id) {
2523 codegen_fn_attrs.flags |= CodegenFnAttrFlags::FFI_RETURNS_TWICE;
2525 // `#[ffi_returns_twice]` is only allowed `extern fn`s.
2530 "`#[ffi_returns_twice]` may only be used on foreign functions"
2533 } else if attr.check_name(sym::rustc_allocator_nounwind) {
2534 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_ALLOCATOR_NOUNWIND;
2535 } else if attr.check_name(sym::naked) {
2536 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NAKED;
2537 } else if attr.check_name(sym::no_mangle) {
2538 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
2539 } else if attr.check_name(sym::rustc_std_internal_symbol) {
2540 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2541 } else if attr.check_name(sym::no_debug) {
2542 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_DEBUG;
2543 } else if attr.check_name(sym::used) {
2544 codegen_fn_attrs.flags |= CodegenFnAttrFlags::USED;
2545 } else if attr.check_name(sym::thread_local) {
2546 codegen_fn_attrs.flags |= CodegenFnAttrFlags::THREAD_LOCAL;
2547 } else if attr.check_name(sym::export_name) {
2548 if let Some(s) = attr.value_str() {
2549 if s.as_str().contains("\0") {
2550 // `#[export_name = ...]` will be converted to a null-terminated string,
2551 // so it may not contain any null characters.
2556 "`export_name` may not contain null characters"
2559 codegen_fn_attrs.export_name = Some(s);
2561 } else if attr.check_name(sym::target_feature) {
2562 if tcx.fn_sig(id).unsafety() == Unsafety::Normal {
2563 let msg = "`#[target_feature(..)]` can only be applied to `unsafe` functions";
2564 tcx.sess.struct_span_err(attr.span, msg)
2565 .span_label(attr.span, "can only be applied to `unsafe` functions")
2566 .span_label(tcx.def_span(id), "not an `unsafe` function")
2569 from_target_feature(
2574 &mut codegen_fn_attrs.target_features,
2576 } else if attr.check_name(sym::linkage) {
2577 if let Some(val) = attr.value_str() {
2578 codegen_fn_attrs.linkage = Some(linkage_by_name(tcx, id, &val.as_str()));
2580 } else if attr.check_name(sym::link_section) {
2581 if let Some(val) = attr.value_str() {
2582 if val.as_str().bytes().any(|b| b == 0) {
2584 "illegal null byte in link_section \
2588 tcx.sess.span_err(attr.span, &msg);
2590 codegen_fn_attrs.link_section = Some(val);
2593 } else if attr.check_name(sym::link_name) {
2594 codegen_fn_attrs.link_name = attr.value_str();
2598 codegen_fn_attrs.inline = attrs.iter().fold(InlineAttr::None, |ia, attr| {
2599 if attr.path != sym::inline {
2602 match attr.meta().map(|i| i.node) {
2603 Some(MetaItemKind::Word) => {
2607 Some(MetaItemKind::List(ref items)) => {
2609 inline_span = Some(attr.span);
2610 if items.len() != 1 {
2612 tcx.sess.diagnostic(),
2615 "expected one argument"
2618 } else if list_contains_name(&items[..], sym::always) {
2620 } else if list_contains_name(&items[..], sym::never) {
2624 tcx.sess.diagnostic(),
2633 Some(MetaItemKind::NameValue(_)) => ia,
2638 codegen_fn_attrs.optimize = attrs.iter().fold(OptimizeAttr::None, |ia, attr| {
2639 if attr.path != sym::optimize {
2642 let err = |sp, s| span_err!(tcx.sess.diagnostic(), sp, E0722, "{}", s);
2643 match attr.meta().map(|i| i.node) {
2644 Some(MetaItemKind::Word) => {
2645 err(attr.span, "expected one argument");
2648 Some(MetaItemKind::List(ref items)) => {
2650 inline_span = Some(attr.span);
2651 if items.len() != 1 {
2652 err(attr.span, "expected one argument");
2654 } else if list_contains_name(&items[..], sym::size) {
2656 } else if list_contains_name(&items[..], sym::speed) {
2659 err(items[0].span(), "invalid argument");
2663 Some(MetaItemKind::NameValue(_)) => ia,
2668 // If a function uses #[target_feature] it can't be inlined into general
2669 // purpose functions as they wouldn't have the right target features
2670 // enabled. For that reason we also forbid #[inline(always)] as it can't be
2672 if codegen_fn_attrs.target_features.len() > 0 {
2673 if codegen_fn_attrs.inline == InlineAttr::Always {
2674 if let Some(span) = inline_span {
2677 "cannot use `#[inline(always)]` with \
2678 `#[target_feature]`",
2684 // Weak lang items have the same semantics as "std internal" symbols in the
2685 // sense that they're preserved through all our LTO passes and only
2686 // strippable by the linker.
2688 // Additionally weak lang items have predetermined symbol names.
2689 if tcx.is_weak_lang_item(id) {
2690 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2692 if let Some(name) = weak_lang_items::link_name(&attrs) {
2693 codegen_fn_attrs.export_name = Some(name);
2694 codegen_fn_attrs.link_name = Some(name);
2697 // Internal symbols to the standard library all have no_mangle semantics in
2698 // that they have defined symbol names present in the function name. This
2699 // also applies to weak symbols where they all have known symbol names.
2700 if codegen_fn_attrs.flags.contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL) {
2701 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;