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::{InternedString, 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 get_type_parameter_bounds(&self, span: Span, def_id: DefId)
186 -> &'tcx ty::GenericPredicates<'tcx> {
189 .type_param_predicates((self.item_def_id, def_id))
194 _: Option<&ty::GenericParamDef>,
196 ) -> Option<ty::Region<'tcx>> {
200 fn ty_infer(&self, _: Option<&ty::GenericParamDef>, span: Span) -> Ty<'tcx> {
201 bad_placeholder_type(self.tcx(), span).emit();
209 _: Option<&ty::GenericParamDef>,
211 ) -> &'tcx Const<'tcx> {
212 bad_placeholder_type(self.tcx(), span).emit();
214 self.tcx().consts.err
217 fn projected_ty_from_poly_trait_ref(
221 poly_trait_ref: ty::PolyTraitRef<'tcx>,
223 if let Some(trait_ref) = poly_trait_ref.no_bound_vars() {
224 self.tcx().mk_projection(item_def_id, trait_ref.substs)
226 // There are no late-bound regions; we can just ignore the binder.
231 "cannot extract an associated type from a higher-ranked trait bound \
238 fn normalize_ty(&self, _span: Span, ty: Ty<'tcx>) -> Ty<'tcx> {
239 // Types in item signatures are not normalized to avoid undue dependencies.
243 fn set_tainted_by_errors(&self) {
244 // There's no obvious place to track this, so just let it go.
247 fn record_ty(&self, _hir_id: hir::HirId, _ty: Ty<'tcx>, _span: Span) {
248 // There's no place to record types from signatures?
252 /// Returns the predicates defined on `item_def_id` of the form
253 /// `X: Foo` where `X` is the type parameter `def_id`.
254 fn type_param_predicates(
256 (item_def_id, def_id): (DefId, DefId),
257 ) -> &ty::GenericPredicates<'_> {
260 // In the AST, bounds can derive from two places. Either
261 // written inline like `<T: Foo>` or in a where-clause like
264 let param_id = tcx.hir().as_local_hir_id(def_id).unwrap();
265 let param_owner = tcx.hir().ty_param_owner(param_id);
266 let param_owner_def_id = tcx.hir().local_def_id(param_owner);
267 let generics = tcx.generics_of(param_owner_def_id);
268 let index = generics.param_def_id_to_index[&def_id];
269 let ty = tcx.mk_ty_param(index, tcx.hir().ty_param_name(param_id).as_interned_str());
271 // Don't look for bounds where the type parameter isn't in scope.
272 let parent = if item_def_id == param_owner_def_id {
275 tcx.generics_of(item_def_id).parent
278 let result = parent.map_or(&tcx.common.empty_predicates, |parent| {
279 let icx = ItemCtxt::new(tcx, parent);
280 icx.get_type_parameter_bounds(DUMMY_SP, def_id)
282 let mut extend = None;
284 let item_hir_id = tcx.hir().as_local_hir_id(item_def_id).unwrap();
285 let ast_generics = match tcx.hir().get(item_hir_id) {
286 Node::TraitItem(item) => &item.generics,
288 Node::ImplItem(item) => &item.generics,
290 Node::Item(item) => {
292 ItemKind::Fn(.., ref generics, _)
293 | ItemKind::Impl(_, _, _, ref generics, ..)
294 | ItemKind::TyAlias(_, ref generics)
295 | ItemKind::OpaqueTy(OpaqueTy {
300 | ItemKind::Enum(_, ref generics)
301 | ItemKind::Struct(_, ref generics)
302 | ItemKind::Union(_, ref generics) => generics,
303 ItemKind::Trait(_, _, ref generics, ..) => {
304 // Implied `Self: Trait` and supertrait bounds.
305 if param_id == item_hir_id {
306 let identity_trait_ref = ty::TraitRef::identity(tcx, item_def_id);
307 extend = Some((identity_trait_ref.to_predicate(), item.span));
315 Node::ForeignItem(item) => match item.kind {
316 ForeignItemKind::Fn(_, _, ref generics) => generics,
323 let icx = ItemCtxt::new(tcx, item_def_id);
324 let mut result = (*result).clone();
325 result.predicates.extend(extend.into_iter());
326 result.predicates.extend(
327 icx.type_parameter_bounds_in_generics(ast_generics, param_id, ty, OnlySelfBounds(true))
329 .filter(|(predicate, _)| {
331 ty::Predicate::Trait(ref data) => data.skip_binder().self_ty().is_param(index),
336 tcx.arena.alloc(result)
339 impl ItemCtxt<'tcx> {
340 /// Finds bounds from `hir::Generics`. This requires scanning through the
341 /// AST. We do this to avoid having to convert *all* the bounds, which
342 /// would create artificial cycles. Instead, we can only convert the
343 /// bounds for a type parameter `X` if `X::Foo` is used.
344 fn type_parameter_bounds_in_generics(
346 ast_generics: &'tcx hir::Generics,
347 param_id: hir::HirId,
349 only_self_bounds: OnlySelfBounds,
350 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
351 let from_ty_params = ast_generics
354 .filter_map(|param| match param.kind {
355 GenericParamKind::Type { .. } if param.hir_id == param_id => Some(¶m.bounds),
358 .flat_map(|bounds| bounds.iter())
359 .flat_map(|b| predicates_from_bound(self, ty, b));
361 let from_where_clauses = ast_generics
365 .filter_map(|wp| match *wp {
366 hir::WherePredicate::BoundPredicate(ref bp) => Some(bp),
370 let bt = if is_param(self.tcx, &bp.bounded_ty, param_id) {
372 } else if !only_self_bounds.0 {
373 Some(self.to_ty(&bp.bounded_ty))
377 bp.bounds.iter().filter_map(move |b| bt.map(|bt| (bt, b)))
379 .flat_map(|(bt, b)| predicates_from_bound(self, bt, b));
381 from_ty_params.chain(from_where_clauses).collect()
385 /// Tests whether this is the AST for a reference to the type
386 /// parameter with ID `param_id`. We use this so as to avoid running
387 /// `ast_ty_to_ty`, because we want to avoid triggering an all-out
388 /// conversion of the type to avoid inducing unnecessary cycles.
389 fn is_param(tcx: TyCtxt<'_>, ast_ty: &hir::Ty, param_id: hir::HirId) -> bool {
390 if let hir::TyKind::Path(hir::QPath::Resolved(None, ref path)) = ast_ty.kind {
392 Res::SelfTy(Some(def_id), None) | Res::Def(DefKind::TyParam, def_id) => {
393 def_id == tcx.hir().local_def_id(param_id)
402 fn convert_item(tcx: TyCtxt<'_>, item_id: hir::HirId) {
403 let it = tcx.hir().expect_item(item_id);
404 debug!("convert: item {} with id {}", it.ident, it.hir_id);
405 let def_id = tcx.hir().local_def_id(item_id);
407 // These don't define types.
408 hir::ItemKind::ExternCrate(_)
409 | hir::ItemKind::Use(..)
410 | hir::ItemKind::Mod(_)
411 | hir::ItemKind::GlobalAsm(_) => {}
412 hir::ItemKind::ForeignMod(ref foreign_mod) => {
413 for item in &foreign_mod.items {
414 let def_id = tcx.hir().local_def_id(item.hir_id);
415 tcx.generics_of(def_id);
417 tcx.predicates_of(def_id);
418 if let hir::ForeignItemKind::Fn(..) = item.kind {
423 hir::ItemKind::Enum(ref enum_definition, _) => {
424 tcx.generics_of(def_id);
426 tcx.predicates_of(def_id);
427 convert_enum_variant_types(tcx, def_id, &enum_definition.variants);
429 hir::ItemKind::Impl(..) => {
430 tcx.generics_of(def_id);
432 tcx.impl_trait_ref(def_id);
433 tcx.predicates_of(def_id);
435 hir::ItemKind::Trait(..) => {
436 tcx.generics_of(def_id);
437 tcx.trait_def(def_id);
438 tcx.at(it.span).super_predicates_of(def_id);
439 tcx.predicates_of(def_id);
441 hir::ItemKind::TraitAlias(..) => {
442 tcx.generics_of(def_id);
443 tcx.at(it.span).super_predicates_of(def_id);
444 tcx.predicates_of(def_id);
446 hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
447 tcx.generics_of(def_id);
449 tcx.predicates_of(def_id);
451 for f in struct_def.fields() {
452 let def_id = tcx.hir().local_def_id(f.hir_id);
453 tcx.generics_of(def_id);
455 tcx.predicates_of(def_id);
458 if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
459 convert_variant_ctor(tcx, ctor_hir_id);
463 // Desugared from `impl Trait`, so visited by the function's return type.
464 hir::ItemKind::OpaqueTy(hir::OpaqueTy {
465 impl_trait_fn: Some(_),
469 hir::ItemKind::OpaqueTy(..)
470 | hir::ItemKind::TyAlias(..)
471 | hir::ItemKind::Static(..)
472 | hir::ItemKind::Const(..)
473 | hir::ItemKind::Fn(..) => {
474 tcx.generics_of(def_id);
476 tcx.predicates_of(def_id);
477 if let hir::ItemKind::Fn(..) = it.kind {
484 fn convert_trait_item(tcx: TyCtxt<'_>, trait_item_id: hir::HirId) {
485 let trait_item = tcx.hir().expect_trait_item(trait_item_id);
486 let def_id = tcx.hir().local_def_id(trait_item.hir_id);
487 tcx.generics_of(def_id);
489 match trait_item.kind {
490 hir::TraitItemKind::Const(..)
491 | hir::TraitItemKind::Type(_, Some(_))
492 | hir::TraitItemKind::Method(..) => {
494 if let hir::TraitItemKind::Method(..) = trait_item.kind {
499 hir::TraitItemKind::Type(_, None) => {}
502 tcx.predicates_of(def_id);
505 fn convert_impl_item(tcx: TyCtxt<'_>, impl_item_id: hir::HirId) {
506 let def_id = tcx.hir().local_def_id(impl_item_id);
507 tcx.generics_of(def_id);
509 tcx.predicates_of(def_id);
510 if let hir::ImplItemKind::Method(..) = tcx.hir().expect_impl_item(impl_item_id).kind {
515 fn convert_variant_ctor(tcx: TyCtxt<'_>, ctor_id: hir::HirId) {
516 let def_id = tcx.hir().local_def_id(ctor_id);
517 tcx.generics_of(def_id);
519 tcx.predicates_of(def_id);
522 fn convert_enum_variant_types(
525 variants: &[hir::Variant]
527 let def = tcx.adt_def(def_id);
528 let repr_type = def.repr.discr_type();
529 let initial = repr_type.initial_discriminant(tcx);
530 let mut prev_discr = None::<Discr<'_>>;
532 // fill the discriminant values and field types
533 for variant in variants {
534 let wrapped_discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
536 if let Some(ref e) = variant.disr_expr {
537 let expr_did = tcx.hir().local_def_id(e.hir_id);
538 def.eval_explicit_discr(tcx, expr_did)
539 } else if let Some(discr) = repr_type.disr_incr(tcx, prev_discr) {
546 "enum discriminant overflowed"
549 format!("overflowed on value after {}", prev_discr.unwrap()),
551 "explicitly set `{} = {}` if that is desired outcome",
552 variant.ident, wrapped_discr
556 }.unwrap_or(wrapped_discr),
559 for f in variant.data.fields() {
560 let def_id = tcx.hir().local_def_id(f.hir_id);
561 tcx.generics_of(def_id);
563 tcx.predicates_of(def_id);
566 // Convert the ctor, if any. This also registers the variant as
568 if let Some(ctor_hir_id) = variant.data.ctor_hir_id() {
569 convert_variant_ctor(tcx, ctor_hir_id);
576 variant_did: Option<DefId>,
577 ctor_did: Option<DefId>,
579 discr: ty::VariantDiscr,
580 def: &hir::VariantData,
581 adt_kind: ty::AdtKind,
583 ) -> ty::VariantDef {
584 let mut seen_fields: FxHashMap<ast::Ident, Span> = Default::default();
585 let hir_id = tcx.hir().as_local_hir_id(variant_did.unwrap_or(parent_did)).unwrap();
590 let fid = tcx.hir().local_def_id(f.hir_id);
591 let dup_span = seen_fields.get(&f.ident.modern()).cloned();
592 if let Some(prev_span) = dup_span {
597 "field `{}` is already declared",
599 ).span_label(f.span, "field already declared")
600 .span_label(prev_span, format!("`{}` first declared here", f.ident))
603 seen_fields.insert(f.ident.modern(), f.span);
609 vis: ty::Visibility::from_hir(&f.vis, hir_id, tcx),
613 let recovered = match def {
614 hir::VariantData::Struct(_, r) => *r,
624 CtorKind::from_hir(def),
631 fn adt_def(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::AdtDef {
634 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
635 let item = match tcx.hir().get(hir_id) {
636 Node::Item(item) => item,
640 let repr = ReprOptions::new(tcx, def_id);
641 let (kind, variants) = match item.kind {
642 ItemKind::Enum(ref def, _) => {
643 let mut distance_from_explicit = 0;
644 let variants = def.variants
647 let variant_did = Some(tcx.hir().local_def_id(v.id));
648 let ctor_did = v.data.ctor_hir_id()
649 .map(|hir_id| tcx.hir().local_def_id(hir_id));
651 let discr = if let Some(ref e) = v.disr_expr {
652 distance_from_explicit = 0;
653 ty::VariantDiscr::Explicit(tcx.hir().local_def_id(e.hir_id))
655 ty::VariantDiscr::Relative(distance_from_explicit)
657 distance_from_explicit += 1;
659 convert_variant(tcx, variant_did, ctor_did, v.ident, discr,
660 &v.data, AdtKind::Enum, def_id)
664 (AdtKind::Enum, variants)
666 ItemKind::Struct(ref def, _) => {
667 let variant_did = None;
668 let ctor_did = def.ctor_hir_id()
669 .map(|hir_id| tcx.hir().local_def_id(hir_id));
671 let variants = std::iter::once(convert_variant(
672 tcx, variant_did, ctor_did, item.ident, ty::VariantDiscr::Relative(0), def,
673 AdtKind::Struct, def_id,
676 (AdtKind::Struct, variants)
678 ItemKind::Union(ref def, _) => {
679 let variant_did = None;
680 let ctor_did = def.ctor_hir_id()
681 .map(|hir_id| tcx.hir().local_def_id(hir_id));
683 let variants = std::iter::once(convert_variant(
684 tcx, variant_did, ctor_did, item.ident, ty::VariantDiscr::Relative(0), def,
685 AdtKind::Union, def_id,
688 (AdtKind::Union, variants)
692 tcx.alloc_adt_def(def_id, kind, variants, repr)
695 /// Ensures that the super-predicates of the trait with a `DefId`
696 /// of `trait_def_id` are converted and stored. This also ensures that
697 /// the transitive super-predicates are converted.
698 fn super_predicates_of(
701 ) -> &ty::GenericPredicates<'_> {
702 debug!("super_predicates(trait_def_id={:?})", trait_def_id);
703 let trait_hir_id = tcx.hir().as_local_hir_id(trait_def_id).unwrap();
705 let item = match tcx.hir().get(trait_hir_id) {
706 Node::Item(item) => item,
707 _ => bug!("trait_node_id {} is not an item", trait_hir_id),
710 let (generics, bounds) = match item.kind {
711 hir::ItemKind::Trait(.., ref generics, ref supertraits, _) => (generics, supertraits),
712 hir::ItemKind::TraitAlias(ref generics, ref supertraits) => (generics, supertraits),
713 _ => span_bug!(item.span, "super_predicates invoked on non-trait"),
716 let icx = ItemCtxt::new(tcx, trait_def_id);
718 // Convert the bounds that follow the colon, e.g., `Bar + Zed` in `trait Foo: Bar + Zed`.
719 let self_param_ty = tcx.types.self_param;
720 let superbounds1 = AstConv::compute_bounds(&icx, self_param_ty, bounds, SizedByDefault::No,
723 let superbounds1 = superbounds1.predicates(tcx, self_param_ty);
725 // Convert any explicit superbounds in the where-clause,
726 // e.g., `trait Foo where Self: Bar`.
727 // In the case of trait aliases, however, we include all bounds in the where-clause,
728 // so e.g., `trait Foo = where u32: PartialEq<Self>` would include `u32: PartialEq<Self>`
729 // as one of its "superpredicates".
730 let is_trait_alias = tcx.is_trait_alias(trait_def_id);
731 let superbounds2 = icx.type_parameter_bounds_in_generics(
732 generics, item.hir_id, self_param_ty, OnlySelfBounds(!is_trait_alias));
734 // Combine the two lists to form the complete set of superbounds:
735 let superbounds: Vec<_> = superbounds1.into_iter().chain(superbounds2).collect();
737 // Now require that immediate supertraits are converted,
738 // which will, in turn, reach indirect supertraits.
739 for &(pred, span) in &superbounds {
740 debug!("superbound: {:?}", pred);
741 if let ty::Predicate::Trait(bound) = pred {
742 tcx.at(span).super_predicates_of(bound.def_id());
746 tcx.arena.alloc(ty::GenericPredicates {
748 predicates: superbounds,
752 fn trait_def(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::TraitDef {
753 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
754 let item = tcx.hir().expect_item(hir_id);
756 let (is_auto, unsafety) = match item.kind {
757 hir::ItemKind::Trait(is_auto, unsafety, ..) => (is_auto == hir::IsAuto::Yes, unsafety),
758 hir::ItemKind::TraitAlias(..) => (false, hir::Unsafety::Normal),
759 _ => span_bug!(item.span, "trait_def_of_item invoked on non-trait"),
762 let paren_sugar = tcx.has_attr(def_id, sym::rustc_paren_sugar);
763 if paren_sugar && !tcx.features().unboxed_closures {
764 let mut err = tcx.sess.struct_span_err(
766 "the `#[rustc_paren_sugar]` attribute is a temporary means of controlling \
767 which traits can use parenthetical notation",
771 "add `#![feature(unboxed_closures)]` to \
772 the crate attributes to use it"
777 let is_marker = tcx.has_attr(def_id, sym::marker);
778 let def_path_hash = tcx.def_path_hash(def_id);
779 let def = ty::TraitDef::new(def_id, unsafety, paren_sugar, is_auto, is_marker, def_path_hash);
783 fn has_late_bound_regions<'tcx>(tcx: TyCtxt<'tcx>, node: Node<'tcx>) -> Option<Span> {
784 struct LateBoundRegionsDetector<'tcx> {
786 outer_index: ty::DebruijnIndex,
787 has_late_bound_regions: Option<Span>,
790 impl Visitor<'tcx> for LateBoundRegionsDetector<'tcx> {
791 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
792 NestedVisitorMap::None
795 fn visit_ty(&mut self, ty: &'tcx hir::Ty) {
796 if self.has_late_bound_regions.is_some() {
800 hir::TyKind::BareFn(..) => {
801 self.outer_index.shift_in(1);
802 intravisit::walk_ty(self, ty);
803 self.outer_index.shift_out(1);
805 _ => intravisit::walk_ty(self, ty),
809 fn visit_poly_trait_ref(
811 tr: &'tcx hir::PolyTraitRef,
812 m: hir::TraitBoundModifier,
814 if self.has_late_bound_regions.is_some() {
817 self.outer_index.shift_in(1);
818 intravisit::walk_poly_trait_ref(self, tr, m);
819 self.outer_index.shift_out(1);
822 fn visit_lifetime(&mut self, lt: &'tcx hir::Lifetime) {
823 if self.has_late_bound_regions.is_some() {
827 match self.tcx.named_region(lt.hir_id) {
828 Some(rl::Region::Static) | Some(rl::Region::EarlyBound(..)) => {}
829 Some(rl::Region::LateBound(debruijn, _, _))
830 | Some(rl::Region::LateBoundAnon(debruijn, _)) if debruijn < self.outer_index => {}
831 Some(rl::Region::LateBound(..))
832 | Some(rl::Region::LateBoundAnon(..))
833 | Some(rl::Region::Free(..))
835 self.has_late_bound_regions = Some(lt.span);
841 fn has_late_bound_regions<'tcx>(
843 generics: &'tcx hir::Generics,
844 decl: &'tcx hir::FnDecl,
846 let mut visitor = LateBoundRegionsDetector {
848 outer_index: ty::INNERMOST,
849 has_late_bound_regions: None,
851 for param in &generics.params {
852 if let GenericParamKind::Lifetime { .. } = param.kind {
853 if tcx.is_late_bound(param.hir_id) {
854 return Some(param.span);
858 visitor.visit_fn_decl(decl);
859 visitor.has_late_bound_regions
863 Node::TraitItem(item) => match item.kind {
864 hir::TraitItemKind::Method(ref sig, _) => {
865 has_late_bound_regions(tcx, &item.generics, &sig.decl)
869 Node::ImplItem(item) => match item.kind {
870 hir::ImplItemKind::Method(ref sig, _) => {
871 has_late_bound_regions(tcx, &item.generics, &sig.decl)
875 Node::ForeignItem(item) => match item.kind {
876 hir::ForeignItemKind::Fn(ref fn_decl, _, ref generics) => {
877 has_late_bound_regions(tcx, generics, fn_decl)
881 Node::Item(item) => match item.kind {
882 hir::ItemKind::Fn(ref fn_decl, .., ref generics, _) => {
883 has_late_bound_regions(tcx, generics, fn_decl)
891 fn generics_of(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::Generics {
894 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
896 let node = tcx.hir().get(hir_id);
897 let parent_def_id = match node {
898 Node::ImplItem(_) | Node::TraitItem(_) | Node::Variant(_) |
899 Node::Ctor(..) | Node::Field(_) => {
900 let parent_id = tcx.hir().get_parent_item(hir_id);
901 Some(tcx.hir().local_def_id(parent_id))
903 // FIXME(#43408) enable this in all cases when we get lazy normalization.
904 Node::AnonConst(&anon_const) => {
905 // HACK(eddyb) this provides the correct generics when the workaround
906 // for a const parameter `AnonConst` is being used elsewhere, as then
907 // there won't be the kind of cyclic dependency blocking #43408.
908 let expr = &tcx.hir().body(anon_const.body).value;
909 let icx = ItemCtxt::new(tcx, def_id);
910 if AstConv::const_param_def_id(&icx, expr).is_some() {
911 let parent_id = tcx.hir().get_parent_item(hir_id);
912 Some(tcx.hir().local_def_id(parent_id))
917 Node::Expr(&hir::Expr {
918 kind: hir::ExprKind::Closure(..),
920 }) => Some(tcx.closure_base_def_id(def_id)),
921 Node::Item(item) => match item.kind {
922 ItemKind::OpaqueTy(hir::OpaqueTy { impl_trait_fn, .. }) => impl_trait_fn,
928 let mut opt_self = None;
929 let mut allow_defaults = false;
931 let no_generics = hir::Generics::empty();
932 let ast_generics = match node {
933 Node::TraitItem(item) => &item.generics,
935 Node::ImplItem(item) => &item.generics,
937 Node::Item(item) => {
939 ItemKind::Fn(.., ref generics, _) | ItemKind::Impl(_, _, _, ref generics, ..) => {
943 ItemKind::TyAlias(_, ref generics)
944 | ItemKind::Enum(_, ref generics)
945 | ItemKind::Struct(_, ref generics)
946 | ItemKind::OpaqueTy(hir::OpaqueTy { ref generics, .. })
947 | ItemKind::Union(_, ref generics) => {
948 allow_defaults = true;
952 ItemKind::Trait(_, _, ref generics, ..)
953 | ItemKind::TraitAlias(ref generics, ..) => {
954 // Add in the self type parameter.
956 // Something of a hack: use the node id for the trait, also as
957 // the node id for the Self type parameter.
958 let param_id = item.hir_id;
960 opt_self = Some(ty::GenericParamDef {
962 name: kw::SelfUpper.as_interned_str(),
963 def_id: tcx.hir().local_def_id(param_id),
964 pure_wrt_drop: false,
965 kind: ty::GenericParamDefKind::Type {
967 object_lifetime_default: rl::Set1::Empty,
972 allow_defaults = true;
980 Node::ForeignItem(item) => match item.kind {
981 ForeignItemKind::Static(..) => &no_generics,
982 ForeignItemKind::Fn(_, _, ref generics) => generics,
983 ForeignItemKind::Type => &no_generics,
989 let has_self = opt_self.is_some();
990 let mut parent_has_self = false;
991 let mut own_start = has_self as u32;
992 let parent_count = parent_def_id.map_or(0, |def_id| {
993 let generics = tcx.generics_of(def_id);
994 assert_eq!(has_self, false);
995 parent_has_self = generics.has_self;
996 own_start = generics.count() as u32;
997 generics.parent_count + generics.params.len()
1000 let mut params: Vec<_> = opt_self.into_iter().collect();
1002 let early_lifetimes = early_bound_lifetimes_from_generics(tcx, ast_generics);
1006 .map(|(i, param)| ty::GenericParamDef {
1007 name: param.name.ident().as_interned_str(),
1008 index: own_start + i as u32,
1009 def_id: tcx.hir().local_def_id(param.hir_id),
1010 pure_wrt_drop: param.pure_wrt_drop,
1011 kind: ty::GenericParamDefKind::Lifetime,
1015 let object_lifetime_defaults = tcx.object_lifetime_defaults(hir_id);
1017 // Now create the real type parameters.
1018 let type_start = own_start - has_self as u32 + params.len() as u32;
1024 .filter_map(|param| {
1025 let kind = match param.kind {
1026 GenericParamKind::Type {
1031 if !allow_defaults && default.is_some() {
1032 if !tcx.features().default_type_parameter_fallback {
1034 lint::builtin::INVALID_TYPE_PARAM_DEFAULT,
1038 "defaults for type parameters are only allowed in \
1039 `struct`, `enum`, `type`, or `trait` definitions."
1045 ty::GenericParamDefKind::Type {
1046 has_default: default.is_some(),
1047 object_lifetime_default: object_lifetime_defaults
1049 .map_or(rl::Set1::Empty, |o| o[i]),
1053 GenericParamKind::Const { .. } => {
1054 ty::GenericParamDefKind::Const
1059 let param_def = ty::GenericParamDef {
1060 index: type_start + i as u32,
1061 name: param.name.ident().as_interned_str(),
1062 def_id: tcx.hir().local_def_id(param.hir_id),
1063 pure_wrt_drop: param.pure_wrt_drop,
1071 // provide junk type parameter defs - the only place that
1072 // cares about anything but the length is instantiation,
1073 // and we don't do that for closures.
1074 if let Node::Expr(&hir::Expr {
1075 kind: hir::ExprKind::Closure(.., gen),
1079 let dummy_args = if gen.is_some() {
1080 &["<yield_ty>", "<return_ty>", "<witness>"][..]
1082 &["<closure_kind>", "<closure_signature>"][..]
1089 .map(|(i, &arg)| ty::GenericParamDef {
1090 index: type_start + i as u32,
1091 name: InternedString::intern(arg),
1093 pure_wrt_drop: false,
1094 kind: ty::GenericParamDefKind::Type {
1096 object_lifetime_default: rl::Set1::Empty,
1102 if let Some(upvars) = tcx.upvars(def_id) {
1103 params.extend(upvars.iter().zip((dummy_args.len() as u32)..).map(|(_, i)| {
1104 ty::GenericParamDef {
1105 index: type_start + i,
1106 name: InternedString::intern("<upvar>"),
1108 pure_wrt_drop: false,
1109 kind: ty::GenericParamDefKind::Type {
1111 object_lifetime_default: rl::Set1::Empty,
1119 let param_def_id_to_index = params
1121 .map(|param| (param.def_id, param.index))
1124 tcx.arena.alloc(ty::Generics {
1125 parent: parent_def_id,
1128 param_def_id_to_index,
1129 has_self: has_self || parent_has_self,
1130 has_late_bound_regions: has_late_bound_regions(tcx, node),
1134 fn report_assoc_ty_on_inherent_impl(tcx: TyCtxt<'_>, span: Span) {
1139 "associated types are not yet supported in inherent impls (see #8995)"
1143 fn type_of(tcx: TyCtxt<'_>, def_id: DefId) -> Ty<'_> {
1144 checked_type_of(tcx, def_id, true).unwrap()
1147 fn infer_placeholder_type(
1150 body_id: hir::BodyId,
1154 let ty = tcx.typeck_tables_of(def_id).node_type(body_id.hir_id);
1156 // If this came from a free `const` or `static mut?` item,
1157 // then the user may have written e.g. `const A = 42;`.
1158 // In this case, the parser has stashed a diagnostic for
1159 // us to improve in typeck so we do that now.
1160 match tcx.sess.diagnostic().steal_diagnostic(span, StashKey::ItemNoType) {
1162 // The parser provided a sub-optimal `HasPlaceholders` suggestion for the type.
1163 // We are typeck and have the real type, so remove that and suggest the actual type.
1164 err.suggestions.clear();
1165 err.span_suggestion(
1167 "provide a type for the item",
1168 format!("{}: {}", item_ident, ty),
1169 Applicability::MachineApplicable,
1174 let mut diag = bad_placeholder_type(tcx, span);
1175 if ty != tcx.types.err {
1176 diag.span_suggestion(
1178 "replace `_` with the correct type",
1180 Applicability::MaybeIncorrect,
1190 /// Same as [`type_of`] but returns [`Option`] instead of failing.
1192 /// If you want to fail anyway, you can set the `fail` parameter to true, but in this case,
1193 /// you'd better just call [`type_of`] directly.
1194 pub fn checked_type_of(tcx: TyCtxt<'_>, def_id: DefId, fail: bool) -> Option<Ty<'_>> {
1197 let hir_id = match tcx.hir().as_local_hir_id(def_id) {
1198 Some(hir_id) => hir_id,
1203 bug!("invalid node");
1207 let icx = ItemCtxt::new(tcx, def_id);
1209 Some(match tcx.hir().get(hir_id) {
1210 Node::TraitItem(item) => match item.kind {
1211 TraitItemKind::Method(..) => {
1212 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1213 tcx.mk_fn_def(def_id, substs)
1215 TraitItemKind::Const(ref ty, body_id) => {
1216 body_id.and_then(|body_id| {
1217 if let hir::TyKind::Infer = ty.kind {
1218 Some(infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident))
1222 }).unwrap_or_else(|| icx.to_ty(ty))
1224 TraitItemKind::Type(_, Some(ref ty)) => icx.to_ty(ty),
1225 TraitItemKind::Type(_, None) => {
1229 span_bug!(item.span, "associated type missing default");
1233 Node::ImplItem(item) => match item.kind {
1234 ImplItemKind::Method(..) => {
1235 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1236 tcx.mk_fn_def(def_id, substs)
1238 ImplItemKind::Const(ref ty, body_id) => {
1239 if let hir::TyKind::Infer = ty.kind {
1240 infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident)
1245 ImplItemKind::OpaqueTy(_) => {
1247 .impl_trait_ref(tcx.hir().get_parent_did(hir_id))
1250 report_assoc_ty_on_inherent_impl(tcx, item.span);
1253 find_opaque_ty_constraints(tcx, def_id)
1255 ImplItemKind::TyAlias(ref ty) => {
1257 .impl_trait_ref(tcx.hir().get_parent_did(hir_id))
1260 report_assoc_ty_on_inherent_impl(tcx, item.span);
1267 Node::Item(item) => {
1269 ItemKind::Static(ref ty, .., body_id)
1270 | ItemKind::Const(ref ty, body_id) => {
1271 if let hir::TyKind::Infer = ty.kind {
1272 infer_placeholder_type(tcx, def_id, body_id, ty.span, item.ident)
1277 ItemKind::TyAlias(ref ty, _)
1278 | ItemKind::Impl(.., ref ty, _) => icx.to_ty(ty),
1279 ItemKind::Fn(..) => {
1280 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1281 tcx.mk_fn_def(def_id, substs)
1283 ItemKind::Enum(..) | ItemKind::Struct(..) | ItemKind::Union(..) => {
1284 let def = tcx.adt_def(def_id);
1285 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1286 tcx.mk_adt(def, substs)
1288 ItemKind::OpaqueTy(hir::OpaqueTy {
1289 impl_trait_fn: None,
1291 }) => find_opaque_ty_constraints(tcx, def_id),
1292 // Opaque types desugared from `impl Trait`.
1293 ItemKind::OpaqueTy(hir::OpaqueTy {
1294 impl_trait_fn: Some(owner),
1297 tcx.typeck_tables_of(owner)
1298 .concrete_opaque_types
1300 .map(|opaque| opaque.concrete_type)
1301 .unwrap_or_else(|| {
1302 // This can occur if some error in the
1303 // owner fn prevented us from populating
1304 // the `concrete_opaque_types` table.
1305 tcx.sess.delay_span_bug(
1308 "owner {:?} has no opaque type for {:?} in its tables",
1316 | ItemKind::TraitAlias(..)
1318 | ItemKind::ForeignMod(..)
1319 | ItemKind::GlobalAsm(..)
1320 | ItemKind::ExternCrate(..)
1321 | ItemKind::Use(..) => {
1327 "compute_type_of_item: unexpected item type: {:?}",
1334 Node::ForeignItem(foreign_item) => match foreign_item.kind {
1335 ForeignItemKind::Fn(..) => {
1336 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1337 tcx.mk_fn_def(def_id, substs)
1339 ForeignItemKind::Static(ref t, _) => icx.to_ty(t),
1340 ForeignItemKind::Type => tcx.mk_foreign(def_id),
1343 Node::Ctor(&ref def) | Node::Variant(
1344 hir::Variant { data: ref def, .. }
1346 VariantData::Unit(..) | VariantData::Struct(..) => {
1347 tcx.type_of(tcx.hir().get_parent_did(hir_id))
1349 VariantData::Tuple(..) => {
1350 let substs = InternalSubsts::identity_for_item(tcx, def_id);
1351 tcx.mk_fn_def(def_id, substs)
1355 Node::Field(field) => icx.to_ty(&field.ty),
1357 Node::Expr(&hir::Expr {
1358 kind: hir::ExprKind::Closure(.., gen),
1362 return Some(tcx.typeck_tables_of(def_id).node_type(hir_id));
1365 let substs = ty::ClosureSubsts {
1366 substs: InternalSubsts::identity_for_item(tcx, def_id),
1369 tcx.mk_closure(def_id, substs)
1372 Node::AnonConst(_) => {
1373 let parent_node = tcx.hir().get(tcx.hir().get_parent_node(hir_id));
1376 kind: hir::TyKind::Array(_, ref constant),
1379 | Node::Ty(&hir::Ty {
1380 kind: hir::TyKind::Typeof(ref constant),
1383 | Node::Expr(&hir::Expr {
1384 kind: ExprKind::Repeat(_, ref constant),
1386 }) if constant.hir_id == hir_id =>
1391 Node::Variant(Variant {
1392 disr_expr: Some(ref e),
1394 }) if e.hir_id == hir_id =>
1396 tcx.adt_def(tcx.hir().get_parent_did(hir_id))
1402 Node::Ty(&hir::Ty { kind: hir::TyKind::Path(_), .. }) |
1403 Node::Expr(&hir::Expr { kind: ExprKind::Struct(..), .. }) |
1404 Node::Expr(&hir::Expr { kind: ExprKind::Path(_), .. }) |
1405 Node::TraitRef(..) => {
1406 let path = match parent_node {
1408 kind: hir::TyKind::Path(QPath::Resolved(_, ref path)),
1411 | Node::Expr(&hir::Expr {
1412 kind: ExprKind::Path(QPath::Resolved(_, ref path)),
1417 Node::Expr(&hir::Expr { kind: ExprKind::Struct(ref path, ..), .. }) => {
1418 if let QPath::Resolved(_, ref path) = **path {
1424 Node::TraitRef(&hir::TraitRef { ref path, .. }) => Some(&**path),
1428 if let Some(path) = path {
1429 let arg_index = path.segments.iter()
1430 .filter_map(|seg| seg.args.as_ref())
1431 .map(|generic_args| generic_args.args.as_ref())
1434 .filter(|arg| arg.is_const())
1436 .filter(|(_, arg)| arg.id() == hir_id)
1437 .map(|(index, _)| index)
1444 bug!("no arg matching AnonConst in path")
1448 // We've encountered an `AnonConst` in some path, so we need to
1449 // figure out which generic parameter it corresponds to and return
1450 // the relevant type.
1451 let generics = match path.res {
1452 Res::Def(DefKind::Ctor(..), def_id) => {
1453 tcx.generics_of(tcx.parent(def_id).unwrap())
1455 Res::Def(_, def_id) => tcx.generics_of(def_id),
1456 Res::Err => return Some(tcx.types.err),
1457 _ if !fail => return None,
1459 tcx.sess.delay_span_bug(
1462 "unexpected const parent path def {:?}",
1466 return Some(tcx.types.err);
1470 generics.params.iter()
1472 if let ty::GenericParamDefKind::Const = param.kind {
1479 .map(|param| tcx.type_of(param.def_id))
1480 // This is no generic parameter associated with the arg. This is
1481 // probably from an extra arg where one is not needed.
1482 .unwrap_or(tcx.types.err)
1487 tcx.sess.delay_span_bug(
1490 "unexpected const parent path {:?}",
1494 return Some(tcx.types.err);
1502 tcx.sess.delay_span_bug(
1505 "unexpected const parent in type_of_def_id(): {:?}", x
1513 Node::GenericParam(param) => match ¶m.kind {
1514 hir::GenericParamKind::Type { default: Some(ref ty), .. } |
1515 hir::GenericParamKind::Const { ref ty, .. } => {
1522 bug!("unexpected non-type Node::GenericParam: {:?}", x)
1530 bug!("unexpected sort of node in type_of_def_id(): {:?}", x);
1535 fn find_opaque_ty_constraints(tcx: TyCtxt<'_>, def_id: DefId) -> Ty<'_> {
1536 use rustc::hir::{ImplItem, Item, TraitItem};
1538 debug!("find_opaque_ty_constraints({:?})", def_id);
1540 struct ConstraintLocator<'tcx> {
1543 // (first found type span, actual type, mapping from the opaque type's generic
1544 // parameters to the concrete type's generic parameters)
1546 // The mapping is an index for each use site of a generic parameter in the concrete type
1548 // The indices index into the generic parameters on the opaque type.
1549 found: Option<(Span, Ty<'tcx>, Vec<usize>)>,
1552 impl ConstraintLocator<'tcx> {
1553 fn check(&mut self, def_id: DefId) {
1554 // Don't try to check items that cannot possibly constrain the type.
1555 if !self.tcx.has_typeck_tables(def_id) {
1557 "find_opaque_ty_constraints: no constraint for `{:?}` at `{:?}`: no tables",
1565 .typeck_tables_of(def_id)
1566 .concrete_opaque_types
1568 if let Some(ty::ResolvedOpaqueTy { concrete_type, substs }) = ty {
1570 "find_opaque_ty_constraints: found constraint for `{:?}` at `{:?}`: {:?}",
1576 // FIXME(oli-obk): trace the actual span from inference to improve errors.
1577 let span = self.tcx.def_span(def_id);
1578 // used to quickly look up the position of a generic parameter
1579 let mut index_map: FxHashMap<ty::ParamTy, usize> = FxHashMap::default();
1580 // Skipping binder is ok, since we only use this to find generic parameters and
1582 for (idx, subst) in substs.iter().enumerate() {
1583 if let GenericArgKind::Type(ty) = subst.unpack() {
1584 if let ty::Param(p) = ty.kind {
1585 if index_map.insert(p, idx).is_some() {
1586 // There was already an entry for `p`, meaning a generic parameter
1588 self.tcx.sess.span_err(
1591 "defining opaque type use restricts opaque \
1592 type by using the generic parameter `{}` twice",
1599 self.tcx.sess.delay_span_bug(
1602 "non-defining opaque ty use in defining scope: {:?}, {:?}",
1603 concrete_type, substs,
1609 // Compute the index within the opaque type for each generic parameter used in
1610 // the concrete type.
1611 let indices = concrete_type
1612 .subst(self.tcx, substs)
1614 .filter_map(|t| match &t.kind {
1615 ty::Param(p) => Some(*index_map.get(p).unwrap()),
1618 let is_param = |ty: Ty<'_>| match ty.kind {
1619 ty::Param(_) => true,
1622 if !substs.types().all(is_param) {
1623 self.tcx.sess.span_err(
1625 "defining opaque type use does not fully define opaque type",
1627 } else if let Some((prev_span, prev_ty, ref prev_indices)) = self.found {
1628 let mut ty = concrete_type.walk().fuse();
1629 let mut p_ty = prev_ty.walk().fuse();
1630 let iter_eq = (&mut ty).zip(&mut p_ty).all(|(t, p)| match (&t.kind, &p.kind) {
1631 // Type parameters are equal to any other type parameter for the purpose of
1632 // concrete type equality, as it is possible to obtain the same type just
1633 // by passing matching parameters to a function.
1634 (ty::Param(_), ty::Param(_)) => true,
1637 if !iter_eq || ty.next().is_some() || p_ty.next().is_some() {
1638 debug!("find_opaque_ty_constraints: span={:?}", span);
1639 // Found different concrete types for the opaque type.
1640 let mut err = self.tcx.sess.struct_span_err(
1642 "concrete type differs from previous defining opaque type use",
1646 format!("expected `{}`, got `{}`", prev_ty, concrete_type),
1648 err.span_note(prev_span, "previous use here");
1650 } else if indices != *prev_indices {
1651 // Found "same" concrete types, but the generic parameter order differs.
1652 let mut err = self.tcx.sess.struct_span_err(
1654 "concrete type's generic parameters differ from previous defining use",
1656 use std::fmt::Write;
1657 let mut s = String::new();
1658 write!(s, "expected [").unwrap();
1659 let list = |s: &mut String, indices: &Vec<usize>| {
1660 let mut indices = indices.iter().cloned();
1661 if let Some(first) = indices.next() {
1662 write!(s, "`{}`", substs[first]).unwrap();
1664 write!(s, ", `{}`", substs[i]).unwrap();
1668 list(&mut s, prev_indices);
1669 write!(s, "], got [").unwrap();
1670 list(&mut s, &indices);
1671 write!(s, "]").unwrap();
1672 err.span_label(span, s);
1673 err.span_note(prev_span, "previous use here");
1677 self.found = Some((span, concrete_type, indices));
1681 "find_opaque_ty_constraints: no constraint for `{:?}` at `{:?}`",
1689 impl<'tcx> intravisit::Visitor<'tcx> for ConstraintLocator<'tcx> {
1690 fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
1691 intravisit::NestedVisitorMap::All(&self.tcx.hir())
1693 fn visit_item(&mut self, it: &'tcx Item) {
1694 debug!("find_existential_constraints: visiting {:?}", it);
1695 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1696 // The opaque type itself or its children are not within its reveal scope.
1697 if def_id != self.def_id {
1699 intravisit::walk_item(self, it);
1702 fn visit_impl_item(&mut self, it: &'tcx ImplItem) {
1703 debug!("find_existential_constraints: visiting {:?}", it);
1704 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1705 // The opaque type itself or its children are not within its reveal scope.
1706 if def_id != self.def_id {
1708 intravisit::walk_impl_item(self, it);
1711 fn visit_trait_item(&mut self, it: &'tcx TraitItem) {
1712 debug!("find_existential_constraints: visiting {:?}", it);
1713 let def_id = self.tcx.hir().local_def_id(it.hir_id);
1715 intravisit::walk_trait_item(self, it);
1719 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1720 let scope = tcx.hir().get_defining_scope(hir_id);
1721 let mut locator = ConstraintLocator {
1727 debug!("find_opaque_ty_constraints: scope={:?}", scope);
1729 if scope == hir::CRATE_HIR_ID {
1730 intravisit::walk_crate(&mut locator, tcx.hir().krate());
1732 debug!("find_opaque_ty_constraints: scope={:?}", tcx.hir().get(scope));
1733 match tcx.hir().get(scope) {
1734 // We explicitly call `visit_*` methods, instead of using `intravisit::walk_*` methods
1735 // This allows our visitor to process the defining item itself, causing
1736 // it to pick up any 'sibling' defining uses.
1738 // For example, this code:
1741 // type Blah = impl Debug;
1742 // let my_closure = || -> Blah { true };
1746 // requires us to explicitly process `foo()` in order
1747 // to notice the defining usage of `Blah`.
1748 Node::Item(ref it) => locator.visit_item(it),
1749 Node::ImplItem(ref it) => locator.visit_impl_item(it),
1750 Node::TraitItem(ref it) => locator.visit_trait_item(it),
1752 "{:?} is not a valid scope for an opaque type item",
1758 match locator.found {
1759 Some((_, ty, _)) => ty,
1761 let span = tcx.def_span(def_id);
1762 tcx.sess.span_err(span, "could not find defining uses");
1768 pub fn get_infer_ret_ty(output: &'_ hir::FunctionRetTy) -> Option<&hir::Ty> {
1769 if let hir::FunctionRetTy::Return(ref ty) = output {
1770 if let hir::TyKind::Infer = ty.kind {
1777 fn fn_sig(tcx: TyCtxt<'_>, def_id: DefId) -> ty::PolyFnSig<'_> {
1779 use rustc::hir::Node::*;
1781 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1783 let icx = ItemCtxt::new(tcx, def_id);
1785 match tcx.hir().get(hir_id) {
1786 TraitItem(hir::TraitItem {
1787 kind: TraitItemKind::Method(MethodSig { header, decl }, TraitMethod::Provided(_)),
1790 | ImplItem(hir::ImplItem {
1791 kind: ImplItemKind::Method(MethodSig { header, decl }, _),
1795 kind: ItemKind::Fn(decl, header, _, _),
1797 }) => match get_infer_ret_ty(&decl.output) {
1799 let fn_sig = tcx.typeck_tables_of(def_id).liberated_fn_sigs()[hir_id];
1800 let mut diag = bad_placeholder_type(tcx, ty.span);
1801 let ret_ty = fn_sig.output();
1802 if ret_ty != tcx.types.err {
1803 diag.span_suggestion(
1805 "replace `_` with the correct return type",
1807 Applicability::MaybeIncorrect,
1811 ty::Binder::bind(fn_sig)
1813 None => AstConv::ty_of_fn(&icx, header.unsafety, header.abi, decl)
1816 TraitItem(hir::TraitItem {
1817 kind: TraitItemKind::Method(MethodSig { header, decl }, _),
1820 AstConv::ty_of_fn(&icx, header.unsafety, header.abi, decl)
1823 ForeignItem(&hir::ForeignItem {
1824 kind: ForeignItemKind::Fn(ref fn_decl, _, _),
1827 let abi = tcx.hir().get_foreign_abi(hir_id);
1828 compute_sig_of_foreign_fn_decl(tcx, def_id, fn_decl, abi)
1831 Ctor(data) | Variant(
1832 hir::Variant { data, .. }
1833 ) if data.ctor_hir_id().is_some() => {
1834 let ty = tcx.type_of(tcx.hir().get_parent_did(hir_id));
1835 let inputs = data.fields()
1837 .map(|f| tcx.type_of(tcx.hir().local_def_id(f.hir_id)));
1838 ty::Binder::bind(tcx.mk_fn_sig(
1842 hir::Unsafety::Normal,
1848 kind: hir::ExprKind::Closure(..),
1851 // Closure signatures are not like other function
1852 // signatures and cannot be accessed through `fn_sig`. For
1853 // example, a closure signature excludes the `self`
1854 // argument. In any case they are embedded within the
1855 // closure type as part of the `ClosureSubsts`.
1858 // the signature of a closure, you should use the
1859 // `closure_sig` method on the `ClosureSubsts`:
1861 // closure_substs.closure_sig(def_id, tcx)
1863 // or, inside of an inference context, you can use
1865 // infcx.closure_sig(def_id, closure_substs)
1866 bug!("to get the signature of a closure, use `closure_sig()` not `fn_sig()`");
1870 bug!("unexpected sort of node in fn_sig(): {:?}", x);
1875 fn impl_trait_ref(tcx: TyCtxt<'_>, def_id: DefId) -> Option<ty::TraitRef<'_>> {
1876 let icx = ItemCtxt::new(tcx, def_id);
1878 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1879 match tcx.hir().expect_item(hir_id).kind {
1880 hir::ItemKind::Impl(.., ref opt_trait_ref, _, _) => {
1881 opt_trait_ref.as_ref().map(|ast_trait_ref| {
1882 let selfty = tcx.type_of(def_id);
1883 AstConv::instantiate_mono_trait_ref(&icx, ast_trait_ref, selfty)
1890 fn impl_polarity(tcx: TyCtxt<'_>, def_id: DefId) -> ty::ImplPolarity {
1891 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap();
1892 let is_rustc_reservation = tcx.has_attr(def_id, sym::rustc_reservation_impl);
1893 let item = tcx.hir().expect_item(hir_id);
1895 hir::ItemKind::Impl(_, hir::ImplPolarity::Negative, ..) => {
1896 if is_rustc_reservation {
1897 tcx.sess.span_err(item.span, "reservation impls can't be negative");
1899 ty::ImplPolarity::Negative
1901 hir::ItemKind::Impl(_, hir::ImplPolarity::Positive, _, _, None, _, _) => {
1902 if is_rustc_reservation {
1903 tcx.sess.span_err(item.span, "reservation impls can't be inherent");
1905 ty::ImplPolarity::Positive
1907 hir::ItemKind::Impl(_, hir::ImplPolarity::Positive, _, _, Some(_tr), _, _) => {
1908 if is_rustc_reservation {
1909 ty::ImplPolarity::Reservation
1911 ty::ImplPolarity::Positive
1914 ref item => bug!("impl_polarity: {:?} not an impl", item),
1918 /// Returns the early-bound lifetimes declared in this generics
1919 /// listing. For anything other than fns/methods, this is just all
1920 /// the lifetimes that are declared. For fns or methods, we have to
1921 /// screen out those that do not appear in any where-clauses etc using
1922 /// `resolve_lifetime::early_bound_lifetimes`.
1923 fn early_bound_lifetimes_from_generics<'a, 'tcx: 'a>(
1925 generics: &'a hir::Generics,
1926 ) -> impl Iterator<Item = &'a hir::GenericParam> + Captures<'tcx> {
1930 .filter(move |param| match param.kind {
1931 GenericParamKind::Lifetime { .. } => {
1932 !tcx.is_late_bound(param.hir_id)
1938 /// Returns a list of type predicates for the definition with ID `def_id`, including inferred
1939 /// lifetime constraints. This includes all predicates returned by `explicit_predicates_of`, plus
1940 /// inferred constraints concerning which regions outlive other regions.
1941 fn predicates_defined_on(
1944 ) -> &ty::GenericPredicates<'_> {
1945 debug!("predicates_defined_on({:?})", def_id);
1946 let mut result = tcx.explicit_predicates_of(def_id);
1948 "predicates_defined_on: explicit_predicates_of({:?}) = {:?}",
1952 let inferred_outlives = tcx.inferred_outlives_of(def_id);
1953 if !inferred_outlives.is_empty() {
1954 let span = tcx.def_span(def_id);
1956 "predicates_defined_on: inferred_outlives_of({:?}) = {:?}",
1960 let mut predicates = (*result).clone();
1961 predicates.predicates.extend(inferred_outlives.iter().map(|&p| (p, span)));
1962 result = tcx.arena.alloc(predicates);
1964 debug!("predicates_defined_on({:?}) = {:?}", def_id, result);
1968 /// Returns a list of all type predicates (explicit and implicit) for the definition with
1969 /// ID `def_id`. This includes all predicates returned by `predicates_defined_on`, plus
1970 /// `Self: Trait` predicates for traits.
1971 fn predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> &ty::GenericPredicates<'_> {
1972 let mut result = tcx.predicates_defined_on(def_id);
1974 if tcx.is_trait(def_id) {
1975 // For traits, add `Self: Trait` predicate. This is
1976 // not part of the predicates that a user writes, but it
1977 // is something that one must prove in order to invoke a
1978 // method or project an associated type.
1980 // In the chalk setup, this predicate is not part of the
1981 // "predicates" for a trait item. But it is useful in
1982 // rustc because if you directly (e.g.) invoke a trait
1983 // method like `Trait::method(...)`, you must naturally
1984 // prove that the trait applies to the types that were
1985 // used, and adding the predicate into this list ensures
1986 // that this is done.
1987 let span = tcx.def_span(def_id);
1988 let mut predicates = (*result).clone();
1989 predicates.predicates.push((ty::TraitRef::identity(tcx, def_id).to_predicate(), span));
1990 result = tcx.arena.alloc(predicates);
1992 debug!("predicates_of(def_id={:?}) = {:?}", def_id, result);
1996 /// Returns a list of user-specified type predicates for the definition with ID `def_id`.
1997 /// N.B., this does not include any implied/inferred constraints.
1998 fn explicit_predicates_of(
2001 ) -> &ty::GenericPredicates<'_> {
2003 use rustc_data_structures::fx::FxHashSet;
2005 debug!("explicit_predicates_of(def_id={:?})", def_id);
2007 /// A data structure with unique elements, which preserves order of insertion.
2008 /// Preserving the order of insertion is important here so as not to break
2009 /// compile-fail UI tests.
2010 struct UniquePredicates<'tcx> {
2011 predicates: Vec<(ty::Predicate<'tcx>, Span)>,
2012 uniques: FxHashSet<(ty::Predicate<'tcx>, Span)>,
2015 impl<'tcx> UniquePredicates<'tcx> {
2019 uniques: FxHashSet::default(),
2023 fn push(&mut self, value: (ty::Predicate<'tcx>, Span)) {
2024 if self.uniques.insert(value) {
2025 self.predicates.push(value);
2029 fn extend<I: IntoIterator<Item = (ty::Predicate<'tcx>, Span)>>(&mut self, iter: I) {
2036 let hir_id = match tcx.hir().as_local_hir_id(def_id) {
2037 Some(hir_id) => hir_id,
2038 None => return tcx.predicates_of(def_id),
2040 let node = tcx.hir().get(hir_id);
2042 let mut is_trait = None;
2043 let mut is_default_impl_trait = None;
2045 let icx = ItemCtxt::new(tcx, def_id);
2047 const NO_GENERICS: &hir::Generics = &hir::Generics::empty();
2049 let empty_trait_items = HirVec::new();
2051 let mut predicates = UniquePredicates::new();
2053 let ast_generics = match node {
2054 Node::TraitItem(item) => &item.generics,
2056 Node::ImplItem(item) => match item.kind {
2057 ImplItemKind::OpaqueTy(ref bounds) => {
2058 let substs = InternalSubsts::identity_for_item(tcx, def_id);
2059 let opaque_ty = tcx.mk_opaque(def_id, substs);
2061 // Collect the bounds, i.e., the `A + B + 'c` in `impl A + B + 'c`.
2062 let bounds = AstConv::compute_bounds(
2066 SizedByDefault::Yes,
2067 tcx.def_span(def_id),
2070 predicates.extend(bounds.predicates(tcx, opaque_ty));
2073 _ => &item.generics,
2076 Node::Item(item) => {
2078 ItemKind::Impl(_, _, defaultness, ref generics, ..) => {
2079 if defaultness.is_default() {
2080 is_default_impl_trait = tcx.impl_trait_ref(def_id);
2084 ItemKind::Fn(.., ref generics, _)
2085 | ItemKind::TyAlias(_, ref generics)
2086 | ItemKind::Enum(_, ref generics)
2087 | ItemKind::Struct(_, ref generics)
2088 | ItemKind::Union(_, ref generics) => generics,
2090 ItemKind::Trait(_, _, ref generics, .., ref items) => {
2091 is_trait = Some((ty::TraitRef::identity(tcx, def_id), items));
2094 ItemKind::TraitAlias(ref generics, _) => {
2095 is_trait = Some((ty::TraitRef::identity(tcx, def_id), &empty_trait_items));
2098 ItemKind::OpaqueTy(OpaqueTy {
2104 let substs = InternalSubsts::identity_for_item(tcx, def_id);
2105 let opaque_ty = tcx.mk_opaque(def_id, substs);
2107 // Collect the bounds, i.e., the `A + B + 'c` in `impl A + B + 'c`.
2108 let bounds = AstConv::compute_bounds(
2112 SizedByDefault::Yes,
2113 tcx.def_span(def_id),
2116 let bounds_predicates = bounds.predicates(tcx, opaque_ty);
2117 if impl_trait_fn.is_some() {
2119 return tcx.arena.alloc(ty::GenericPredicates {
2121 predicates: bounds_predicates,
2124 // named opaque types
2125 predicates.extend(bounds_predicates);
2134 Node::ForeignItem(item) => match item.kind {
2135 ForeignItemKind::Static(..) => NO_GENERICS,
2136 ForeignItemKind::Fn(_, _, ref generics) => generics,
2137 ForeignItemKind::Type => NO_GENERICS,
2143 let generics = tcx.generics_of(def_id);
2144 let parent_count = generics.parent_count as u32;
2145 let has_own_self = generics.has_self && parent_count == 0;
2147 // Below we'll consider the bounds on the type parameters (including `Self`)
2148 // and the explicit where-clauses, but to get the full set of predicates
2149 // on a trait we need to add in the supertrait bounds and bounds found on
2150 // associated types.
2151 if let Some((_trait_ref, _)) = is_trait {
2152 predicates.extend(tcx.super_predicates_of(def_id).predicates.iter().cloned());
2155 // In default impls, we can assume that the self type implements
2156 // the trait. So in:
2158 // default impl Foo for Bar { .. }
2160 // we add a default where clause `Foo: Bar`. We do a similar thing for traits
2161 // (see below). Recall that a default impl is not itself an impl, but rather a
2162 // set of defaults that can be incorporated into another impl.
2163 if let Some(trait_ref) = is_default_impl_trait {
2164 predicates.push((trait_ref.to_poly_trait_ref().to_predicate(), tcx.def_span(def_id)));
2167 // Collect the region predicates that were declared inline as
2168 // well. In the case of parameters declared on a fn or method, we
2169 // have to be careful to only iterate over early-bound regions.
2170 let mut index = parent_count + has_own_self as u32;
2171 for param in early_bound_lifetimes_from_generics(tcx, ast_generics) {
2172 let region = tcx.mk_region(ty::ReEarlyBound(ty::EarlyBoundRegion {
2173 def_id: tcx.hir().local_def_id(param.hir_id),
2175 name: param.name.ident().as_interned_str(),
2180 GenericParamKind::Lifetime { .. } => {
2181 param.bounds.iter().for_each(|bound| match bound {
2182 hir::GenericBound::Outlives(lt) => {
2183 let bound = AstConv::ast_region_to_region(&icx, <, None);
2184 let outlives = ty::Binder::bind(ty::OutlivesPredicate(region, bound));
2185 predicates.push((outlives.to_predicate(), lt.span));
2194 // Collect the predicates that were written inline by the user on each
2195 // type parameter (e.g., `<T: Foo>`).
2196 for param in &ast_generics.params {
2197 if let GenericParamKind::Type { .. } = param.kind {
2198 let name = param.name.ident().as_interned_str();
2199 let param_ty = ty::ParamTy::new(index, name).to_ty(tcx);
2202 let sized = SizedByDefault::Yes;
2203 let bounds = AstConv::compute_bounds(&icx, param_ty, ¶m.bounds, sized, param.span);
2204 predicates.extend(bounds.predicates(tcx, param_ty));
2208 // Add in the bounds that appear in the where-clause.
2209 let where_clause = &ast_generics.where_clause;
2210 for predicate in &where_clause.predicates {
2212 &hir::WherePredicate::BoundPredicate(ref bound_pred) => {
2213 let ty = icx.to_ty(&bound_pred.bounded_ty);
2215 // Keep the type around in a dummy predicate, in case of no bounds.
2216 // That way, `where Ty:` is not a complete noop (see #53696) and `Ty`
2217 // is still checked for WF.
2218 if bound_pred.bounds.is_empty() {
2219 if let ty::Param(_) = ty.kind {
2220 // This is a `where T:`, which can be in the HIR from the
2221 // transformation that moves `?Sized` to `T`'s declaration.
2222 // We can skip the predicate because type parameters are
2223 // trivially WF, but also we *should*, to avoid exposing
2224 // users who never wrote `where Type:,` themselves, to
2225 // compiler/tooling bugs from not handling WF predicates.
2227 let span = bound_pred.bounded_ty.span;
2228 let predicate = ty::OutlivesPredicate(ty, tcx.mk_region(ty::ReEmpty));
2230 (ty::Predicate::TypeOutlives(ty::Binder::dummy(predicate)), span)
2235 for bound in bound_pred.bounds.iter() {
2237 &hir::GenericBound::Trait(ref poly_trait_ref, _) => {
2238 let mut bounds = Bounds::default();
2239 let _ = AstConv::instantiate_poly_trait_ref(
2245 predicates.extend(bounds.predicates(tcx, ty));
2248 &hir::GenericBound::Outlives(ref lifetime) => {
2249 let region = AstConv::ast_region_to_region(&icx, lifetime, None);
2250 let pred = ty::Binder::bind(ty::OutlivesPredicate(ty, region));
2251 predicates.push((ty::Predicate::TypeOutlives(pred), lifetime.span))
2257 &hir::WherePredicate::RegionPredicate(ref region_pred) => {
2258 let r1 = AstConv::ast_region_to_region(&icx, ®ion_pred.lifetime, None);
2259 predicates.extend(region_pred.bounds.iter().map(|bound| {
2260 let (r2, span) = match bound {
2261 hir::GenericBound::Outlives(lt) => {
2262 (AstConv::ast_region_to_region(&icx, lt, None), lt.span)
2266 let pred = ty::Binder::bind(ty::OutlivesPredicate(r1, r2));
2268 (ty::Predicate::RegionOutlives(pred), span)
2272 &hir::WherePredicate::EqPredicate(..) => {
2278 // Add predicates from associated type bounds.
2279 if let Some((self_trait_ref, trait_items)) = is_trait {
2280 predicates.extend(trait_items.iter().flat_map(|trait_item_ref| {
2281 let trait_item = tcx.hir().trait_item(trait_item_ref.id);
2282 let bounds = match trait_item.kind {
2283 hir::TraitItemKind::Type(ref bounds, _) => bounds,
2284 _ => return Vec::new().into_iter()
2288 tcx.mk_projection(tcx.hir().local_def_id(trait_item.hir_id),
2289 self_trait_ref.substs);
2291 let bounds = AstConv::compute_bounds(
2292 &ItemCtxt::new(tcx, def_id),
2295 SizedByDefault::Yes,
2299 bounds.predicates(tcx, assoc_ty).into_iter()
2303 let mut predicates = predicates.predicates;
2305 // Subtle: before we store the predicates into the tcx, we
2306 // sort them so that predicates like `T: Foo<Item=U>` come
2307 // before uses of `U`. This avoids false ambiguity errors
2308 // in trait checking. See `setup_constraining_predicates`
2310 if let Node::Item(&Item {
2311 kind: ItemKind::Impl(..),
2315 let self_ty = tcx.type_of(def_id);
2316 let trait_ref = tcx.impl_trait_ref(def_id);
2317 cgp::setup_constraining_predicates(
2321 &mut cgp::parameters_for_impl(self_ty, trait_ref),
2325 let result = tcx.arena.alloc(ty::GenericPredicates {
2326 parent: generics.parent,
2329 debug!("explicit_predicates_of(def_id={:?}) = {:?}", def_id, result);
2333 /// Converts a specific `GenericBound` from the AST into a set of
2334 /// predicates that apply to the self type. A vector is returned
2335 /// because this can be anywhere from zero predicates (`T: ?Sized` adds no
2336 /// predicates) to one (`T: Foo`) to many (`T: Bar<X = i32>` adds `T: Bar`
2337 /// and `<T as Bar>::X == i32`).
2338 fn predicates_from_bound<'tcx>(
2339 astconv: &dyn AstConv<'tcx>,
2341 bound: &'tcx hir::GenericBound,
2342 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
2344 hir::GenericBound::Trait(ref tr, hir::TraitBoundModifier::None) => {
2345 let mut bounds = Bounds::default();
2346 let _ = astconv.instantiate_poly_trait_ref(
2351 bounds.predicates(astconv.tcx(), param_ty)
2353 hir::GenericBound::Outlives(ref lifetime) => {
2354 let region = astconv.ast_region_to_region(lifetime, None);
2355 let pred = ty::Binder::bind(ty::OutlivesPredicate(param_ty, region));
2356 vec![(ty::Predicate::TypeOutlives(pred), lifetime.span)]
2358 hir::GenericBound::Trait(_, hir::TraitBoundModifier::Maybe) => vec![],
2362 fn compute_sig_of_foreign_fn_decl<'tcx>(
2365 decl: &'tcx hir::FnDecl,
2367 ) -> ty::PolyFnSig<'tcx> {
2368 let unsafety = if abi == abi::Abi::RustIntrinsic {
2369 intrinsic_operation_unsafety(&*tcx.item_name(def_id).as_str())
2371 hir::Unsafety::Unsafe
2373 let fty = AstConv::ty_of_fn(&ItemCtxt::new(tcx, def_id), unsafety, abi, decl);
2375 // Feature gate SIMD types in FFI, since I am not sure that the
2376 // ABIs are handled at all correctly. -huonw
2377 if abi != abi::Abi::RustIntrinsic
2378 && abi != abi::Abi::PlatformIntrinsic
2379 && !tcx.features().simd_ffi
2381 let check = |ast_ty: &hir::Ty, ty: Ty<'_>| {
2387 "use of SIMD type `{}` in FFI is highly experimental and \
2388 may result in invalid code",
2389 tcx.hir().hir_to_pretty_string(ast_ty.hir_id)
2392 .help("add `#![feature(simd_ffi)]` to the crate attributes to enable")
2396 for (input, ty) in decl.inputs.iter().zip(*fty.inputs().skip_binder()) {
2399 if let hir::Return(ref ty) = decl.output {
2400 check(&ty, *fty.output().skip_binder())
2407 fn is_foreign_item(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
2408 match tcx.hir().get_if_local(def_id) {
2409 Some(Node::ForeignItem(..)) => true,
2411 _ => bug!("is_foreign_item applied to non-local def-id {:?}", def_id),
2415 fn static_mutability(tcx: TyCtxt<'_>, def_id: DefId) -> Option<hir::Mutability> {
2416 match tcx.hir().get_if_local(def_id) {
2417 Some(Node::Item(&hir::Item {
2418 kind: hir::ItemKind::Static(_, mutbl, _), ..
2420 Some(Node::ForeignItem( &hir::ForeignItem {
2421 kind: hir::ForeignItemKind::Static(_, mutbl), ..
2424 _ => bug!("static_mutability applied to non-local def-id {:?}", def_id),
2428 fn from_target_feature(
2431 attr: &ast::Attribute,
2432 whitelist: &FxHashMap<String, Option<Symbol>>,
2433 target_features: &mut Vec<Symbol>,
2435 let list = match attr.meta_item_list() {
2439 let bad_item = |span| {
2440 let msg = "malformed `target_feature` attribute input";
2441 let code = "enable = \"..\"".to_owned();
2442 tcx.sess.struct_span_err(span, &msg)
2443 .span_suggestion(span, "must be of the form", code, Applicability::HasPlaceholders)
2446 let rust_features = tcx.features();
2448 // Only `enable = ...` is accepted in the meta-item list.
2449 if !item.check_name(sym::enable) {
2450 bad_item(item.span());
2454 // Must be of the form `enable = "..."` (a string).
2455 let value = match item.value_str() {
2456 Some(value) => value,
2458 bad_item(item.span());
2463 // We allow comma separation to enable multiple features.
2464 target_features.extend(value.as_str().split(',').filter_map(|feature| {
2465 // Only allow whitelisted features per platform.
2466 let feature_gate = match whitelist.get(feature) {
2470 "the feature named `{}` is not valid for this target",
2473 let mut err = tcx.sess.struct_span_err(item.span(), &msg);
2476 format!("`{}` is not valid for this target", feature),
2478 if feature.starts_with("+") {
2479 let valid = whitelist.contains_key(&feature[1..]);
2481 err.help("consider removing the leading `+` in the feature name");
2489 // Only allow features whose feature gates have been enabled.
2490 let allowed = match feature_gate.as_ref().map(|s| *s) {
2491 Some(sym::arm_target_feature) => rust_features.arm_target_feature,
2492 Some(sym::aarch64_target_feature) => rust_features.aarch64_target_feature,
2493 Some(sym::hexagon_target_feature) => rust_features.hexagon_target_feature,
2494 Some(sym::powerpc_target_feature) => rust_features.powerpc_target_feature,
2495 Some(sym::mips_target_feature) => rust_features.mips_target_feature,
2496 Some(sym::avx512_target_feature) => rust_features.avx512_target_feature,
2497 Some(sym::mmx_target_feature) => rust_features.mmx_target_feature,
2498 Some(sym::sse4a_target_feature) => rust_features.sse4a_target_feature,
2499 Some(sym::tbm_target_feature) => rust_features.tbm_target_feature,
2500 Some(sym::wasm_target_feature) => rust_features.wasm_target_feature,
2501 Some(sym::cmpxchg16b_target_feature) => rust_features.cmpxchg16b_target_feature,
2502 Some(sym::adx_target_feature) => rust_features.adx_target_feature,
2503 Some(sym::movbe_target_feature) => rust_features.movbe_target_feature,
2504 Some(sym::rtm_target_feature) => rust_features.rtm_target_feature,
2505 Some(sym::f16c_target_feature) => rust_features.f16c_target_feature,
2506 Some(name) => bug!("unknown target feature gate {}", name),
2509 if !allowed && id.is_local() {
2510 feature_gate::emit_feature_err(
2511 &tcx.sess.parse_sess,
2512 feature_gate.unwrap(),
2514 feature_gate::GateIssue::Language,
2515 &format!("the target feature `{}` is currently unstable", feature),
2518 Some(Symbol::intern(feature))
2523 fn linkage_by_name(tcx: TyCtxt<'_>, def_id: DefId, name: &str) -> Linkage {
2524 use rustc::mir::mono::Linkage::*;
2526 // Use the names from src/llvm/docs/LangRef.rst here. Most types are only
2527 // applicable to variable declarations and may not really make sense for
2528 // Rust code in the first place but whitelist them anyway and trust that
2529 // the user knows what s/he's doing. Who knows, unanticipated use cases
2530 // may pop up in the future.
2532 // ghost, dllimport, dllexport and linkonce_odr_autohide are not supported
2533 // and don't have to be, LLVM treats them as no-ops.
2535 "appending" => Appending,
2536 "available_externally" => AvailableExternally,
2538 "extern_weak" => ExternalWeak,
2539 "external" => External,
2540 "internal" => Internal,
2541 "linkonce" => LinkOnceAny,
2542 "linkonce_odr" => LinkOnceODR,
2543 "private" => Private,
2545 "weak_odr" => WeakODR,
2547 let span = tcx.hir().span_if_local(def_id);
2548 if let Some(span) = span {
2549 tcx.sess.span_fatal(span, "invalid linkage specified")
2552 .fatal(&format!("invalid linkage specified: {}", name))
2558 fn codegen_fn_attrs(tcx: TyCtxt<'_>, id: DefId) -> CodegenFnAttrs {
2559 let attrs = tcx.get_attrs(id);
2561 let mut codegen_fn_attrs = CodegenFnAttrs::new();
2563 let whitelist = tcx.target_features_whitelist(LOCAL_CRATE);
2565 let mut inline_span = None;
2566 for attr in attrs.iter() {
2567 if attr.check_name(sym::cold) {
2568 codegen_fn_attrs.flags |= CodegenFnAttrFlags::COLD;
2569 } else if attr.check_name(sym::rustc_allocator) {
2570 codegen_fn_attrs.flags |= CodegenFnAttrFlags::ALLOCATOR;
2571 } else if attr.check_name(sym::unwind) {
2572 codegen_fn_attrs.flags |= CodegenFnAttrFlags::UNWIND;
2573 } else if attr.check_name(sym::ffi_returns_twice) {
2574 if tcx.is_foreign_item(id) {
2575 codegen_fn_attrs.flags |= CodegenFnAttrFlags::FFI_RETURNS_TWICE;
2577 // `#[ffi_returns_twice]` is only allowed `extern fn`s.
2582 "`#[ffi_returns_twice]` may only be used on foreign functions"
2585 } else if attr.check_name(sym::rustc_allocator_nounwind) {
2586 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_ALLOCATOR_NOUNWIND;
2587 } else if attr.check_name(sym::naked) {
2588 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NAKED;
2589 } else if attr.check_name(sym::no_mangle) {
2590 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
2591 } else if attr.check_name(sym::rustc_std_internal_symbol) {
2592 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2593 } else if attr.check_name(sym::no_debug) {
2594 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_DEBUG;
2595 } else if attr.check_name(sym::used) {
2596 codegen_fn_attrs.flags |= CodegenFnAttrFlags::USED;
2597 } else if attr.check_name(sym::thread_local) {
2598 codegen_fn_attrs.flags |= CodegenFnAttrFlags::THREAD_LOCAL;
2599 } else if attr.check_name(sym::export_name) {
2600 if let Some(s) = attr.value_str() {
2601 if s.as_str().contains("\0") {
2602 // `#[export_name = ...]` will be converted to a null-terminated string,
2603 // so it may not contain any null characters.
2608 "`export_name` may not contain null characters"
2611 codegen_fn_attrs.export_name = Some(s);
2613 } else if attr.check_name(sym::target_feature) {
2614 if tcx.fn_sig(id).unsafety() == Unsafety::Normal {
2615 let msg = "`#[target_feature(..)]` can only be applied to `unsafe` functions";
2616 tcx.sess.struct_span_err(attr.span, msg)
2617 .span_label(attr.span, "can only be applied to `unsafe` functions")
2618 .span_label(tcx.def_span(id), "not an `unsafe` function")
2621 from_target_feature(
2626 &mut codegen_fn_attrs.target_features,
2628 } else if attr.check_name(sym::linkage) {
2629 if let Some(val) = attr.value_str() {
2630 codegen_fn_attrs.linkage = Some(linkage_by_name(tcx, id, &val.as_str()));
2632 } else if attr.check_name(sym::link_section) {
2633 if let Some(val) = attr.value_str() {
2634 if val.as_str().bytes().any(|b| b == 0) {
2636 "illegal null byte in link_section \
2640 tcx.sess.span_err(attr.span, &msg);
2642 codegen_fn_attrs.link_section = Some(val);
2645 } else if attr.check_name(sym::link_name) {
2646 codegen_fn_attrs.link_name = attr.value_str();
2650 codegen_fn_attrs.inline = attrs.iter().fold(InlineAttr::None, |ia, attr| {
2651 if attr.path != sym::inline {
2654 match attr.meta().map(|i| i.kind) {
2655 Some(MetaItemKind::Word) => {
2659 Some(MetaItemKind::List(ref items)) => {
2661 inline_span = Some(attr.span);
2662 if items.len() != 1 {
2664 tcx.sess.diagnostic(),
2667 "expected one argument"
2670 } else if list_contains_name(&items[..], sym::always) {
2672 } else if list_contains_name(&items[..], sym::never) {
2676 tcx.sess.diagnostic(),
2685 Some(MetaItemKind::NameValue(_)) => ia,
2690 codegen_fn_attrs.optimize = attrs.iter().fold(OptimizeAttr::None, |ia, attr| {
2691 if attr.path != sym::optimize {
2694 let err = |sp, s| span_err!(tcx.sess.diagnostic(), sp, E0722, "{}", s);
2695 match attr.meta().map(|i| i.kind) {
2696 Some(MetaItemKind::Word) => {
2697 err(attr.span, "expected one argument");
2700 Some(MetaItemKind::List(ref items)) => {
2702 inline_span = Some(attr.span);
2703 if items.len() != 1 {
2704 err(attr.span, "expected one argument");
2706 } else if list_contains_name(&items[..], sym::size) {
2708 } else if list_contains_name(&items[..], sym::speed) {
2711 err(items[0].span(), "invalid argument");
2715 Some(MetaItemKind::NameValue(_)) => ia,
2720 // If a function uses #[target_feature] it can't be inlined into general
2721 // purpose functions as they wouldn't have the right target features
2722 // enabled. For that reason we also forbid #[inline(always)] as it can't be
2724 if codegen_fn_attrs.target_features.len() > 0 {
2725 if codegen_fn_attrs.inline == InlineAttr::Always {
2726 if let Some(span) = inline_span {
2729 "cannot use `#[inline(always)]` with \
2730 `#[target_feature]`",
2736 // Weak lang items have the same semantics as "std internal" symbols in the
2737 // sense that they're preserved through all our LTO passes and only
2738 // strippable by the linker.
2740 // Additionally weak lang items have predetermined symbol names.
2741 if tcx.is_weak_lang_item(id) {
2742 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2744 if let Some(name) = weak_lang_items::link_name(&attrs) {
2745 codegen_fn_attrs.export_name = Some(name);
2746 codegen_fn_attrs.link_name = Some(name);
2749 // Internal symbols to the standard library all have no_mangle semantics in
2750 // that they have defined symbol names present in the function name. This
2751 // also applies to weak symbols where they all have known symbol names.
2752 if codegen_fn_attrs.flags.contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL) {
2753 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;