1 // ignore-tidy-filelength
2 //! "Collection" is the process of determining the type and other external
3 //! details of each item in Rust. Collection is specifically concerned
4 //! with *inter-procedural* things -- for example, for a function
5 //! definition, collection will figure out the type and signature of the
6 //! function, but it will not visit the *body* of the function in any way,
7 //! nor examine type annotations on local variables (that's the job of
10 //! Collecting is ultimately defined by a bundle of queries that
11 //! inquire after various facts about the items in the crate (e.g.,
12 //! `type_of`, `generics_of`, `predicates_of`, etc). See the `provide` function
15 //! At present, however, we do run collection across all items in the
16 //! crate as a kind of pass. This should eventually be factored away.
18 use crate::astconv::AstConv;
19 use crate::bounds::Bounds;
20 use crate::check::intrinsic::intrinsic_operation_unsafety;
21 use crate::constrained_generic_params as cgp;
23 use crate::middle::resolve_lifetime as rl;
25 use rustc_ast::{MetaItemKind, NestedMetaItem};
26 use rustc_attr::{list_contains_name, InlineAttr, InstructionSetAttr, OptimizeAttr};
27 use rustc_data_structures::captures::Captures;
28 use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexSet};
29 use rustc_errors::{struct_span_err, Applicability, DiagnosticBuilder, ErrorGuaranteed};
31 use rustc_hir::def::{CtorKind, DefKind};
32 use rustc_hir::def_id::{DefId, LocalDefId, CRATE_DEF_ID, LOCAL_CRATE};
33 use rustc_hir::intravisit::{self, Visitor};
34 use rustc_hir::weak_lang_items;
35 use rustc_hir::{GenericParamKind, HirId, Node};
36 use rustc_middle::hir::nested_filter;
37 use rustc_middle::middle::codegen_fn_attrs::{CodegenFnAttrFlags, CodegenFnAttrs};
38 use rustc_middle::mir::mono::Linkage;
39 use rustc_middle::ty::query::Providers;
40 use rustc_middle::ty::subst::InternalSubsts;
41 use rustc_middle::ty::util::Discr;
42 use rustc_middle::ty::util::IntTypeExt;
43 use rustc_middle::ty::{self, AdtKind, Const, DefIdTree, Ty, TyCtxt};
44 use rustc_middle::ty::{ReprOptions, ToPredicate};
45 use rustc_session::lint;
46 use rustc_session::parse::feature_err;
47 use rustc_span::symbol::{kw, sym, Ident, Symbol};
48 use rustc_span::{Span, DUMMY_SP};
49 use rustc_target::spec::{abi, PanicStrategy, SanitizerSet};
50 use rustc_trait_selection::traits::error_reporting::suggestions::NextTypeParamName;
56 struct OnlySelfBounds(bool);
58 ///////////////////////////////////////////////////////////////////////////
61 fn collect_mod_item_types(tcx: TyCtxt<'_>, module_def_id: LocalDefId) {
62 tcx.hir().visit_item_likes_in_module(
64 &mut CollectItemTypesVisitor { tcx }.as_deep_visitor(),
68 pub fn provide(providers: &mut Providers) {
69 *providers = Providers {
70 opt_const_param_of: type_of::opt_const_param_of,
71 type_of: type_of::type_of,
72 item_bounds: item_bounds::item_bounds,
73 explicit_item_bounds: item_bounds::explicit_item_bounds,
76 predicates_defined_on,
77 explicit_predicates_of,
79 super_predicates_that_define_assoc_type,
80 trait_explicit_predicates_and_bounds,
81 type_param_predicates,
91 collect_mod_item_types,
92 should_inherit_track_caller,
97 ///////////////////////////////////////////////////////////////////////////
99 /// Context specific to some particular item. This is what implements
100 /// `AstConv`. It has information about the predicates that are defined
101 /// on the trait. Unfortunately, this predicate information is
102 /// available in various different forms at various points in the
103 /// process. So we can't just store a pointer to e.g., the AST or the
104 /// parsed ty form, we have to be more flexible. To this end, the
105 /// `ItemCtxt` is parameterized by a `DefId` that it uses to satisfy
106 /// `get_type_parameter_bounds` requests, drawing the information from
107 /// the AST (`hir::Generics`), recursively.
108 pub struct ItemCtxt<'tcx> {
113 ///////////////////////////////////////////////////////////////////////////
116 crate struct HirPlaceholderCollector(crate Vec<Span>);
118 impl<'v> Visitor<'v> for HirPlaceholderCollector {
119 fn visit_ty(&mut self, t: &'v hir::Ty<'v>) {
120 if let hir::TyKind::Infer = t.kind {
123 intravisit::walk_ty(self, t)
125 fn visit_generic_arg(&mut self, generic_arg: &'v hir::GenericArg<'v>) {
127 hir::GenericArg::Infer(inf) => {
128 self.0.push(inf.span);
129 intravisit::walk_inf(self, inf);
131 hir::GenericArg::Type(t) => self.visit_ty(t),
135 fn visit_array_length(&mut self, length: &'v hir::ArrayLen) {
136 if let &hir::ArrayLen::Infer(_, span) = length {
139 intravisit::walk_array_len(self, length)
143 struct CollectItemTypesVisitor<'tcx> {
147 /// If there are any placeholder types (`_`), emit an error explaining that this is not allowed
148 /// and suggest adding type parameters in the appropriate place, taking into consideration any and
149 /// all already existing generic type parameters to avoid suggesting a name that is already in use.
150 crate fn placeholder_type_error<'tcx>(
153 generics: &[hir::GenericParam<'_>],
154 placeholder_types: Vec<Span>,
156 hir_ty: Option<&hir::Ty<'_>>,
159 if placeholder_types.is_empty() {
163 placeholder_type_error_diag(
176 crate fn placeholder_type_error_diag<'tcx>(
179 generics: &[hir::GenericParam<'_>],
180 placeholder_types: Vec<Span>,
181 additional_spans: Vec<Span>,
183 hir_ty: Option<&hir::Ty<'_>>,
185 ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
186 if placeholder_types.is_empty() {
187 return bad_placeholder(tcx, additional_spans, kind);
190 let type_name = generics.next_type_param_name(None);
191 let mut sugg: Vec<_> =
192 placeholder_types.iter().map(|sp| (*sp, (*type_name).to_string())).collect();
194 if generics.is_empty() {
195 if let Some(span) = span {
196 sugg.push((span, format!("<{}>", type_name)));
198 } else if let Some(arg) = generics
200 .find(|arg| matches!(arg.name, hir::ParamName::Plain(Ident { name: kw::Underscore, .. })))
202 // Account for `_` already present in cases like `struct S<_>(_);` and suggest
203 // `struct S<T>(T);` instead of `struct S<_, T>(T);`.
204 sugg.push((arg.span, (*type_name).to_string()));
206 let last = generics.iter().last().unwrap();
207 // Account for bounds, we want `fn foo<T: E, K>(_: K)` not `fn foo<T, K: E>(_: K)`.
208 let span = last.bounds_span_for_suggestions().unwrap_or(last.span.shrink_to_hi());
209 sugg.push((span, format!(", {}", type_name)));
213 bad_placeholder(tcx, placeholder_types.into_iter().chain(additional_spans).collect(), kind);
215 // Suggest, but only if it is not a function in const or static
217 let mut is_fn = false;
218 let mut is_const_or_static = false;
220 if let Some(hir_ty) = hir_ty && let hir::TyKind::BareFn(_) = hir_ty.kind {
223 // Check if parent is const or static
224 let parent_id = tcx.hir().get_parent_node(hir_ty.hir_id);
225 let parent_node = tcx.hir().get(parent_id);
227 is_const_or_static = matches!(
229 Node::Item(&hir::Item {
230 kind: hir::ItemKind::Const(..) | hir::ItemKind::Static(..),
232 }) | Node::TraitItem(&hir::TraitItem {
233 kind: hir::TraitItemKind::Const(..),
235 }) | Node::ImplItem(&hir::ImplItem { kind: hir::ImplItemKind::Const(..), .. })
239 // if function is wrapped around a const or static,
240 // then don't show the suggestion
241 if !(is_fn && is_const_or_static) {
242 err.multipart_suggestion(
243 "use type parameters instead",
245 Applicability::HasPlaceholders,
253 fn reject_placeholder_type_signatures_in_item<'tcx>(
255 item: &'tcx hir::Item<'tcx>,
257 let (generics, suggest) = match &item.kind {
258 hir::ItemKind::Union(_, generics)
259 | hir::ItemKind::Enum(_, generics)
260 | hir::ItemKind::TraitAlias(generics, _)
261 | hir::ItemKind::Trait(_, _, generics, ..)
262 | hir::ItemKind::Impl(hir::Impl { generics, .. })
263 | hir::ItemKind::Struct(_, generics) => (generics, true),
264 hir::ItemKind::OpaqueTy(hir::OpaqueTy { generics, .. })
265 | hir::ItemKind::TyAlias(_, generics) => (generics, false),
266 // `static`, `fn` and `const` are handled elsewhere to suggest appropriate type.
270 let mut visitor = HirPlaceholderCollector::default();
271 visitor.visit_item(item);
273 placeholder_type_error(
284 impl<'tcx> Visitor<'tcx> for CollectItemTypesVisitor<'tcx> {
285 type NestedFilter = nested_filter::OnlyBodies;
287 fn nested_visit_map(&mut self) -> Self::Map {
291 fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
292 convert_item(self.tcx, item.item_id());
293 reject_placeholder_type_signatures_in_item(self.tcx, item);
294 intravisit::walk_item(self, item);
297 fn visit_generics(&mut self, generics: &'tcx hir::Generics<'tcx>) {
298 for param in generics.params {
300 hir::GenericParamKind::Lifetime { .. } => {}
301 hir::GenericParamKind::Type { default: Some(_), .. } => {
302 let def_id = self.tcx.hir().local_def_id(param.hir_id);
303 self.tcx.ensure().type_of(def_id);
305 hir::GenericParamKind::Type { .. } => {}
306 hir::GenericParamKind::Const { default, .. } => {
307 let def_id = self.tcx.hir().local_def_id(param.hir_id);
308 self.tcx.ensure().type_of(def_id);
309 if let Some(default) = default {
310 let default_def_id = self.tcx.hir().local_def_id(default.hir_id);
311 // need to store default and type of default
312 self.tcx.ensure().type_of(default_def_id);
313 self.tcx.ensure().const_param_default(def_id);
318 intravisit::walk_generics(self, generics);
321 fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
322 if let hir::ExprKind::Closure(..) = expr.kind {
323 let def_id = self.tcx.hir().local_def_id(expr.hir_id);
324 self.tcx.ensure().generics_of(def_id);
325 // We do not call `type_of` for closures here as that
326 // depends on typecheck and would therefore hide
327 // any further errors in case one typeck fails.
329 intravisit::walk_expr(self, expr);
332 fn visit_trait_item(&mut self, trait_item: &'tcx hir::TraitItem<'tcx>) {
333 convert_trait_item(self.tcx, trait_item.trait_item_id());
334 intravisit::walk_trait_item(self, trait_item);
337 fn visit_impl_item(&mut self, impl_item: &'tcx hir::ImplItem<'tcx>) {
338 convert_impl_item(self.tcx, impl_item.impl_item_id());
339 intravisit::walk_impl_item(self, impl_item);
343 ///////////////////////////////////////////////////////////////////////////
344 // Utility types and common code for the above passes.
346 fn bad_placeholder<'tcx>(
348 mut spans: Vec<Span>,
350 ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
351 let kind = if kind.ends_with('s') { format!("{}es", kind) } else { format!("{}s", kind) };
354 let mut err = struct_span_err!(
358 "the placeholder `_` is not allowed within types on item signatures for {}",
362 err.span_label(span, "not allowed in type signatures");
367 impl<'tcx> ItemCtxt<'tcx> {
368 pub fn new(tcx: TyCtxt<'tcx>, item_def_id: DefId) -> ItemCtxt<'tcx> {
369 ItemCtxt { tcx, item_def_id }
372 pub fn to_ty(&self, ast_ty: &hir::Ty<'_>) -> Ty<'tcx> {
373 <dyn AstConv<'_>>::ast_ty_to_ty(self, ast_ty)
376 pub fn hir_id(&self) -> hir::HirId {
377 self.tcx.hir().local_def_id_to_hir_id(self.item_def_id.expect_local())
380 pub fn node(&self) -> hir::Node<'tcx> {
381 self.tcx.hir().get(self.hir_id())
385 impl<'tcx> AstConv<'tcx> for ItemCtxt<'tcx> {
386 fn tcx(&self) -> TyCtxt<'tcx> {
390 fn item_def_id(&self) -> Option<DefId> {
391 Some(self.item_def_id)
394 fn get_type_parameter_bounds(
399 ) -> ty::GenericPredicates<'tcx> {
400 self.tcx.at(span).type_param_predicates((
402 def_id.expect_local(),
407 fn re_infer(&self, _: Option<&ty::GenericParamDef>, _: Span) -> Option<ty::Region<'tcx>> {
411 fn allow_ty_infer(&self) -> bool {
415 fn ty_infer(&self, _: Option<&ty::GenericParamDef>, span: Span) -> Ty<'tcx> {
416 self.tcx().ty_error_with_message(span, "bad placeholder type")
419 fn ct_infer(&self, ty: Ty<'tcx>, _: Option<&ty::GenericParamDef>, span: Span) -> Const<'tcx> {
420 let ty = self.tcx.fold_regions(ty, &mut false, |r, _| match *r {
421 ty::ReErased => self.tcx.lifetimes.re_static,
424 self.tcx().const_error_with_message(ty, span, "bad placeholder constant")
427 fn projected_ty_from_poly_trait_ref(
431 item_segment: &hir::PathSegment<'_>,
432 poly_trait_ref: ty::PolyTraitRef<'tcx>,
434 if let Some(trait_ref) = poly_trait_ref.no_bound_vars() {
435 let item_substs = <dyn AstConv<'tcx>>::create_substs_for_associated_item(
443 self.tcx().mk_projection(item_def_id, item_substs)
445 // There are no late-bound regions; we can just ignore the binder.
446 let mut err = struct_span_err!(
450 "cannot use the associated type of a trait \
451 with uninferred generic parameters"
455 hir::Node::Field(_) | hir::Node::Ctor(_) | hir::Node::Variant(_) => {
457 self.tcx.hir().expect_item(self.tcx.hir().get_parent_item(self.hir_id()));
459 hir::ItemKind::Enum(_, generics)
460 | hir::ItemKind::Struct(_, generics)
461 | hir::ItemKind::Union(_, generics) => {
462 let lt_name = get_new_lifetime_name(self.tcx, poly_trait_ref, generics);
463 let (lt_sp, sugg) = match generics.params {
464 [] => (generics.span, format!("<{}>", lt_name)),
466 (bound.span.shrink_to_lo(), format!("{}, ", lt_name))
469 let suggestions = vec![
472 span.with_hi(item_segment.ident.span.lo()),
475 // Replace the existing lifetimes with a new named lifetime.
477 .replace_late_bound_regions(poly_trait_ref, |_| {
478 self.tcx.mk_region(ty::ReEarlyBound(
479 ty::EarlyBoundRegion {
482 name: Symbol::intern(<_name),
490 err.multipart_suggestion(
491 "use a fully qualified path with explicit lifetimes",
493 Applicability::MaybeIncorrect,
499 hir::Node::Item(hir::Item {
501 hir::ItemKind::Struct(..) | hir::ItemKind::Enum(..) | hir::ItemKind::Union(..),
505 | hir::Node::ForeignItem(_)
506 | hir::Node::TraitItem(_)
507 | hir::Node::ImplItem(_) => {
508 err.span_suggestion_verbose(
509 span.with_hi(item_segment.ident.span.lo()),
510 "use a fully qualified path with inferred lifetimes",
513 // Erase named lt, we want `<A as B<'_>::C`, not `<A as B<'a>::C`.
514 self.tcx.anonymize_late_bound_regions(poly_trait_ref).skip_binder(),
516 Applicability::MaybeIncorrect,
522 self.tcx().ty_error()
526 fn normalize_ty(&self, _span: Span, ty: Ty<'tcx>) -> Ty<'tcx> {
527 // Types in item signatures are not normalized to avoid undue dependencies.
531 fn set_tainted_by_errors(&self) {
532 // There's no obvious place to track this, so just let it go.
535 fn record_ty(&self, _hir_id: hir::HirId, _ty: Ty<'tcx>, _span: Span) {
536 // There's no place to record types from signatures?
540 /// Synthesize a new lifetime name that doesn't clash with any of the lifetimes already present.
541 fn get_new_lifetime_name<'tcx>(
543 poly_trait_ref: ty::PolyTraitRef<'tcx>,
544 generics: &hir::Generics<'tcx>,
546 let existing_lifetimes = tcx
547 .collect_referenced_late_bound_regions(&poly_trait_ref)
550 if let ty::BoundRegionKind::BrNamed(_, name) = lt {
551 Some(name.as_str().to_string())
556 .chain(generics.params.iter().filter_map(|param| {
557 if let hir::GenericParamKind::Lifetime { .. } = ¶m.kind {
558 Some(param.name.ident().as_str().to_string())
563 .collect::<FxHashSet<String>>();
565 let a_to_z_repeat_n = |n| {
566 (b'a'..=b'z').map(move |c| {
567 let mut s = '\''.to_string();
568 s.extend(std::iter::repeat(char::from(c)).take(n));
573 // If all single char lifetime names are present, we wrap around and double the chars.
574 (1..).flat_map(a_to_z_repeat_n).find(|lt| !existing_lifetimes.contains(lt.as_str())).unwrap()
577 /// Returns the predicates defined on `item_def_id` of the form
578 /// `X: Foo` where `X` is the type parameter `def_id`.
579 fn type_param_predicates(
581 (item_def_id, def_id, assoc_name): (DefId, LocalDefId, Ident),
582 ) -> ty::GenericPredicates<'_> {
585 // In the AST, bounds can derive from two places. Either
586 // written inline like `<T: Foo>` or in a where-clause like
589 let param_id = tcx.hir().local_def_id_to_hir_id(def_id);
590 let param_owner = tcx.hir().ty_param_owner(def_id);
591 let generics = tcx.generics_of(param_owner);
592 let index = generics.param_def_id_to_index[&def_id.to_def_id()];
593 let ty = tcx.mk_ty_param(index, tcx.hir().ty_param_name(def_id));
595 // Don't look for bounds where the type parameter isn't in scope.
596 let parent = if item_def_id == param_owner.to_def_id() {
599 tcx.generics_of(item_def_id).parent
602 let mut result = parent
604 let icx = ItemCtxt::new(tcx, parent);
605 icx.get_type_parameter_bounds(DUMMY_SP, def_id.to_def_id(), assoc_name)
607 .unwrap_or_default();
608 let mut extend = None;
610 let item_hir_id = tcx.hir().local_def_id_to_hir_id(item_def_id.expect_local());
611 let ast_generics = match tcx.hir().get(item_hir_id) {
612 Node::TraitItem(item) => &item.generics,
614 Node::ImplItem(item) => &item.generics,
616 Node::Item(item) => {
618 ItemKind::Fn(.., ref generics, _)
619 | ItemKind::Impl(hir::Impl { ref generics, .. })
620 | ItemKind::TyAlias(_, ref generics)
621 | ItemKind::OpaqueTy(OpaqueTy {
623 origin: hir::OpaqueTyOrigin::TyAlias,
626 | ItemKind::Enum(_, ref generics)
627 | ItemKind::Struct(_, ref generics)
628 | ItemKind::Union(_, ref generics) => generics,
629 ItemKind::Trait(_, _, ref generics, ..) => {
630 // Implied `Self: Trait` and supertrait bounds.
631 if param_id == item_hir_id {
632 let identity_trait_ref = ty::TraitRef::identity(tcx, item_def_id);
634 Some((identity_trait_ref.without_const().to_predicate(tcx), item.span));
642 Node::ForeignItem(item) => match item.kind {
643 ForeignItemKind::Fn(_, _, ref generics) => generics,
650 let icx = ItemCtxt::new(tcx, item_def_id);
651 let extra_predicates = extend.into_iter().chain(
652 icx.type_parameter_bounds_in_generics(
656 OnlySelfBounds(true),
660 .filter(|(predicate, _)| match predicate.kind().skip_binder() {
661 ty::PredicateKind::Trait(data) => data.self_ty().is_param(index),
666 tcx.arena.alloc_from_iter(result.predicates.iter().copied().chain(extra_predicates));
670 impl<'tcx> ItemCtxt<'tcx> {
671 /// Finds bounds from `hir::Generics`. This requires scanning through the
672 /// AST. We do this to avoid having to convert *all* the bounds, which
673 /// would create artificial cycles. Instead, we can only convert the
674 /// bounds for a type parameter `X` if `X::Foo` is used.
675 fn type_parameter_bounds_in_generics(
677 ast_generics: &'tcx hir::Generics<'tcx>,
678 param_id: hir::HirId,
680 only_self_bounds: OnlySelfBounds,
681 assoc_name: Option<Ident>,
682 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
683 let from_ty_params = ast_generics
686 .filter_map(|param| match param.kind {
687 GenericParamKind::Type { .. } | GenericParamKind::Const { .. }
688 if param.hir_id == param_id =>
694 .flat_map(|bounds| bounds.iter())
695 .filter(|b| match assoc_name {
696 Some(assoc_name) => self.bound_defines_assoc_item(b, assoc_name),
699 .flat_map(|b| predicates_from_bound(self, ty, b, ty::List::empty()));
701 let param_def_id = self.tcx.hir().local_def_id(param_id).to_def_id();
702 let from_where_clauses = ast_generics
705 .filter_map(|wp| match *wp {
706 hir::WherePredicate::BoundPredicate(ref bp) => Some(bp),
710 let bt = if bp.is_param_bound(param_def_id) {
712 } else if !only_self_bounds.0 {
713 Some(self.to_ty(bp.bounded_ty))
717 let bvars = self.tcx.late_bound_vars(bp.bounded_ty.hir_id);
721 .filter(|b| match assoc_name {
722 Some(assoc_name) => self.bound_defines_assoc_item(b, assoc_name),
725 .filter_map(move |b| bt.map(|bt| (bt, b, bvars)))
727 .flat_map(|(bt, b, bvars)| predicates_from_bound(self, bt, b, bvars));
729 from_ty_params.chain(from_where_clauses).collect()
732 fn bound_defines_assoc_item(&self, b: &hir::GenericBound<'_>, assoc_name: Ident) -> bool {
733 debug!("bound_defines_assoc_item(b={:?}, assoc_name={:?})", b, assoc_name);
736 hir::GenericBound::Trait(poly_trait_ref, _) => {
737 let trait_ref = &poly_trait_ref.trait_ref;
738 if let Some(trait_did) = trait_ref.trait_def_id() {
739 self.tcx.trait_may_define_assoc_type(trait_did, assoc_name)
749 fn convert_item(tcx: TyCtxt<'_>, item_id: hir::ItemId) {
750 let it = tcx.hir().item(item_id);
751 debug!("convert: item {} with id {}", it.ident, it.hir_id());
752 let def_id = item_id.def_id;
755 // These don't define types.
756 hir::ItemKind::ExternCrate(_)
757 | hir::ItemKind::Use(..)
758 | hir::ItemKind::Macro(..)
759 | hir::ItemKind::Mod(_)
760 | hir::ItemKind::GlobalAsm(_) => {}
761 hir::ItemKind::ForeignMod { items, .. } => {
763 let item = tcx.hir().foreign_item(item.id);
764 tcx.ensure().generics_of(item.def_id);
765 tcx.ensure().type_of(item.def_id);
766 tcx.ensure().predicates_of(item.def_id);
768 hir::ForeignItemKind::Fn(..) => tcx.ensure().fn_sig(item.def_id),
769 hir::ForeignItemKind::Static(..) => {
770 let mut visitor = HirPlaceholderCollector::default();
771 visitor.visit_foreign_item(item);
772 placeholder_type_error(
786 hir::ItemKind::Enum(ref enum_definition, _) => {
787 tcx.ensure().generics_of(def_id);
788 tcx.ensure().type_of(def_id);
789 tcx.ensure().predicates_of(def_id);
790 convert_enum_variant_types(tcx, def_id.to_def_id(), enum_definition.variants);
792 hir::ItemKind::Impl { .. } => {
793 tcx.ensure().generics_of(def_id);
794 tcx.ensure().type_of(def_id);
795 tcx.ensure().impl_trait_ref(def_id);
796 tcx.ensure().predicates_of(def_id);
798 hir::ItemKind::Trait(..) => {
799 tcx.ensure().generics_of(def_id);
800 tcx.ensure().trait_def(def_id);
801 tcx.at(it.span).super_predicates_of(def_id);
802 tcx.ensure().predicates_of(def_id);
804 hir::ItemKind::TraitAlias(..) => {
805 tcx.ensure().generics_of(def_id);
806 tcx.at(it.span).super_predicates_of(def_id);
807 tcx.ensure().predicates_of(def_id);
809 hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
810 tcx.ensure().generics_of(def_id);
811 tcx.ensure().type_of(def_id);
812 tcx.ensure().predicates_of(def_id);
814 for f in struct_def.fields() {
815 let def_id = tcx.hir().local_def_id(f.hir_id);
816 tcx.ensure().generics_of(def_id);
817 tcx.ensure().type_of(def_id);
818 tcx.ensure().predicates_of(def_id);
821 if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
822 convert_variant_ctor(tcx, ctor_hir_id);
826 // Desugared from `impl Trait`, so visited by the function's return type.
827 hir::ItemKind::OpaqueTy(hir::OpaqueTy {
828 origin: hir::OpaqueTyOrigin::FnReturn(..) | hir::OpaqueTyOrigin::AsyncFn(..),
832 // Don't call `type_of` on opaque types, since that depends on type
833 // checking function bodies. `check_item_type` ensures that it's called
835 hir::ItemKind::OpaqueTy(..) => {
836 tcx.ensure().generics_of(def_id);
837 tcx.ensure().predicates_of(def_id);
838 tcx.ensure().explicit_item_bounds(def_id);
840 hir::ItemKind::TyAlias(..)
841 | hir::ItemKind::Static(..)
842 | hir::ItemKind::Const(..)
843 | hir::ItemKind::Fn(..) => {
844 tcx.ensure().generics_of(def_id);
845 tcx.ensure().type_of(def_id);
846 tcx.ensure().predicates_of(def_id);
848 hir::ItemKind::Fn(..) => tcx.ensure().fn_sig(def_id),
849 hir::ItemKind::OpaqueTy(..) => tcx.ensure().item_bounds(def_id),
850 hir::ItemKind::Const(ty, ..) | hir::ItemKind::Static(ty, ..) => {
851 // (#75889): Account for `const C: dyn Fn() -> _ = "";`
852 if let hir::TyKind::TraitObject(..) = ty.kind {
853 let mut visitor = HirPlaceholderCollector::default();
854 visitor.visit_item(it);
855 placeholder_type_error(
872 fn convert_trait_item(tcx: TyCtxt<'_>, trait_item_id: hir::TraitItemId) {
873 let trait_item = tcx.hir().trait_item(trait_item_id);
874 tcx.ensure().generics_of(trait_item_id.def_id);
876 match trait_item.kind {
877 hir::TraitItemKind::Fn(..) => {
878 tcx.ensure().type_of(trait_item_id.def_id);
879 tcx.ensure().fn_sig(trait_item_id.def_id);
882 hir::TraitItemKind::Const(.., Some(_)) => {
883 tcx.ensure().type_of(trait_item_id.def_id);
886 hir::TraitItemKind::Const(..) => {
887 tcx.ensure().type_of(trait_item_id.def_id);
888 // Account for `const C: _;`.
889 let mut visitor = HirPlaceholderCollector::default();
890 visitor.visit_trait_item(trait_item);
891 placeholder_type_error(tcx, None, &[], visitor.0, false, None, "constant");
894 hir::TraitItemKind::Type(_, Some(_)) => {
895 tcx.ensure().item_bounds(trait_item_id.def_id);
896 tcx.ensure().type_of(trait_item_id.def_id);
897 // Account for `type T = _;`.
898 let mut visitor = HirPlaceholderCollector::default();
899 visitor.visit_trait_item(trait_item);
900 placeholder_type_error(tcx, None, &[], visitor.0, false, None, "associated type");
903 hir::TraitItemKind::Type(_, None) => {
904 tcx.ensure().item_bounds(trait_item_id.def_id);
905 // #74612: Visit and try to find bad placeholders
906 // even if there is no concrete type.
907 let mut visitor = HirPlaceholderCollector::default();
908 visitor.visit_trait_item(trait_item);
910 placeholder_type_error(tcx, None, &[], visitor.0, false, None, "associated type");
914 tcx.ensure().predicates_of(trait_item_id.def_id);
917 fn convert_impl_item(tcx: TyCtxt<'_>, impl_item_id: hir::ImplItemId) {
918 let def_id = impl_item_id.def_id;
919 tcx.ensure().generics_of(def_id);
920 tcx.ensure().type_of(def_id);
921 tcx.ensure().predicates_of(def_id);
922 let impl_item = tcx.hir().impl_item(impl_item_id);
923 match impl_item.kind {
924 hir::ImplItemKind::Fn(..) => {
925 tcx.ensure().fn_sig(def_id);
927 hir::ImplItemKind::TyAlias(_) => {
928 // Account for `type T = _;`
929 let mut visitor = HirPlaceholderCollector::default();
930 visitor.visit_impl_item(impl_item);
932 placeholder_type_error(tcx, None, &[], visitor.0, false, None, "associated type");
934 hir::ImplItemKind::Const(..) => {}
938 fn convert_variant_ctor(tcx: TyCtxt<'_>, ctor_id: hir::HirId) {
939 let def_id = tcx.hir().local_def_id(ctor_id);
940 tcx.ensure().generics_of(def_id);
941 tcx.ensure().type_of(def_id);
942 tcx.ensure().predicates_of(def_id);
945 fn convert_enum_variant_types(tcx: TyCtxt<'_>, def_id: DefId, variants: &[hir::Variant<'_>]) {
946 let def = tcx.adt_def(def_id);
947 let repr_type = def.repr().discr_type();
948 let initial = repr_type.initial_discriminant(tcx);
949 let mut prev_discr = None::<Discr<'_>>;
951 // fill the discriminant values and field types
952 for variant in variants {
953 let wrapped_discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
955 if let Some(ref e) = variant.disr_expr {
956 let expr_did = tcx.hir().local_def_id(e.hir_id);
957 def.eval_explicit_discr(tcx, expr_did.to_def_id())
958 } else if let Some(discr) = repr_type.disr_incr(tcx, prev_discr) {
961 struct_span_err!(tcx.sess, variant.span, E0370, "enum discriminant overflowed")
964 format!("overflowed on value after {}", prev_discr.unwrap()),
967 "explicitly set `{} = {}` if that is desired outcome",
968 variant.ident, wrapped_discr
973 .unwrap_or(wrapped_discr),
976 for f in variant.data.fields() {
977 let def_id = tcx.hir().local_def_id(f.hir_id);
978 tcx.ensure().generics_of(def_id);
979 tcx.ensure().type_of(def_id);
980 tcx.ensure().predicates_of(def_id);
983 // Convert the ctor, if any. This also registers the variant as
985 if let Some(ctor_hir_id) = variant.data.ctor_hir_id() {
986 convert_variant_ctor(tcx, ctor_hir_id);
993 variant_did: Option<LocalDefId>,
994 ctor_did: Option<LocalDefId>,
996 discr: ty::VariantDiscr,
997 def: &hir::VariantData<'_>,
998 adt_kind: ty::AdtKind,
999 parent_did: LocalDefId,
1000 ) -> ty::VariantDef {
1001 let mut seen_fields: FxHashMap<Ident, Span> = Default::default();
1006 let fid = tcx.hir().local_def_id(f.hir_id);
1007 let dup_span = seen_fields.get(&f.ident.normalize_to_macros_2_0()).cloned();
1008 if let Some(prev_span) = dup_span {
1009 tcx.sess.emit_err(errors::FieldAlreadyDeclared {
1010 field_name: f.ident,
1015 seen_fields.insert(f.ident.normalize_to_macros_2_0(), f.span);
1018 ty::FieldDef { did: fid.to_def_id(), name: f.ident.name, vis: tcx.visibility(fid) }
1021 let recovered = match def {
1022 hir::VariantData::Struct(_, r) => *r,
1025 ty::VariantDef::new(
1027 variant_did.map(LocalDefId::to_def_id),
1028 ctor_did.map(LocalDefId::to_def_id),
1031 CtorKind::from_hir(def),
1033 parent_did.to_def_id(),
1035 adt_kind == AdtKind::Struct && tcx.has_attr(parent_did.to_def_id(), sym::non_exhaustive)
1036 || variant_did.map_or(false, |variant_did| {
1037 tcx.has_attr(variant_did.to_def_id(), sym::non_exhaustive)
1042 fn adt_def<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> ty::AdtDef<'tcx> {
1045 let def_id = def_id.expect_local();
1046 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
1047 let Node::Item(item) = tcx.hir().get(hir_id) else {
1051 let repr = ReprOptions::new(tcx, def_id.to_def_id());
1052 let (kind, variants) = match item.kind {
1053 ItemKind::Enum(ref def, _) => {
1054 let mut distance_from_explicit = 0;
1059 let variant_did = Some(tcx.hir().local_def_id(v.id));
1061 v.data.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
1063 let discr = if let Some(ref e) = v.disr_expr {
1064 distance_from_explicit = 0;
1065 ty::VariantDiscr::Explicit(tcx.hir().local_def_id(e.hir_id).to_def_id())
1067 ty::VariantDiscr::Relative(distance_from_explicit)
1069 distance_from_explicit += 1;
1084 (AdtKind::Enum, variants)
1086 ItemKind::Struct(ref def, _) => {
1087 let variant_did = None::<LocalDefId>;
1088 let ctor_did = def.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
1090 let variants = std::iter::once(convert_variant(
1095 ty::VariantDiscr::Relative(0),
1102 (AdtKind::Struct, variants)
1104 ItemKind::Union(ref def, _) => {
1105 let variant_did = None;
1106 let ctor_did = def.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
1108 let variants = std::iter::once(convert_variant(
1113 ty::VariantDiscr::Relative(0),
1120 (AdtKind::Union, variants)
1124 tcx.alloc_adt_def(def_id.to_def_id(), kind, variants, repr)
1127 /// Ensures that the super-predicates of the trait with a `DefId`
1128 /// of `trait_def_id` are converted and stored. This also ensures that
1129 /// the transitive super-predicates are converted.
1130 fn super_predicates_of(tcx: TyCtxt<'_>, trait_def_id: DefId) -> ty::GenericPredicates<'_> {
1131 debug!("super_predicates(trait_def_id={:?})", trait_def_id);
1132 tcx.super_predicates_that_define_assoc_type((trait_def_id, None))
1135 /// Ensures that the super-predicates of the trait with a `DefId`
1136 /// of `trait_def_id` are converted and stored. This also ensures that
1137 /// the transitive super-predicates are converted.
1138 fn super_predicates_that_define_assoc_type(
1140 (trait_def_id, assoc_name): (DefId, Option<Ident>),
1141 ) -> ty::GenericPredicates<'_> {
1143 "super_predicates_that_define_assoc_type(trait_def_id={:?}, assoc_name={:?})",
1144 trait_def_id, assoc_name
1146 if trait_def_id.is_local() {
1147 debug!("super_predicates_that_define_assoc_type: local trait_def_id={:?}", trait_def_id);
1148 let trait_hir_id = tcx.hir().local_def_id_to_hir_id(trait_def_id.expect_local());
1150 let Node::Item(item) = tcx.hir().get(trait_hir_id) else {
1151 bug!("trait_node_id {} is not an item", trait_hir_id);
1154 let (generics, bounds) = match item.kind {
1155 hir::ItemKind::Trait(.., ref generics, ref supertraits, _) => (generics, supertraits),
1156 hir::ItemKind::TraitAlias(ref generics, ref supertraits) => (generics, supertraits),
1157 _ => span_bug!(item.span, "super_predicates invoked on non-trait"),
1160 let icx = ItemCtxt::new(tcx, trait_def_id);
1162 // Convert the bounds that follow the colon, e.g., `Bar + Zed` in `trait Foo: Bar + Zed`.
1163 let self_param_ty = tcx.types.self_param;
1164 let superbounds1 = if let Some(assoc_name) = assoc_name {
1165 <dyn AstConv<'_>>::compute_bounds_that_match_assoc_type(
1172 <dyn AstConv<'_>>::compute_bounds(&icx, self_param_ty, bounds)
1175 let superbounds1 = superbounds1.predicates(tcx, self_param_ty);
1177 // Convert any explicit superbounds in the where-clause,
1178 // e.g., `trait Foo where Self: Bar`.
1179 // In the case of trait aliases, however, we include all bounds in the where-clause,
1180 // so e.g., `trait Foo = where u32: PartialEq<Self>` would include `u32: PartialEq<Self>`
1181 // as one of its "superpredicates".
1182 let is_trait_alias = tcx.is_trait_alias(trait_def_id);
1183 let superbounds2 = icx.type_parameter_bounds_in_generics(
1187 OnlySelfBounds(!is_trait_alias),
1191 // Combine the two lists to form the complete set of superbounds:
1192 let superbounds = &*tcx.arena.alloc_from_iter(superbounds1.into_iter().chain(superbounds2));
1194 // Now require that immediate supertraits are converted,
1195 // which will, in turn, reach indirect supertraits.
1196 if assoc_name.is_none() {
1197 // Now require that immediate supertraits are converted,
1198 // which will, in turn, reach indirect supertraits.
1199 for &(pred, span) in superbounds {
1200 debug!("superbound: {:?}", pred);
1201 if let ty::PredicateKind::Trait(bound) = pred.kind().skip_binder() {
1202 tcx.at(span).super_predicates_of(bound.def_id());
1207 ty::GenericPredicates { parent: None, predicates: superbounds }
1209 // if `assoc_name` is None, then the query should've been redirected to an
1210 // external provider
1211 assert!(assoc_name.is_some());
1212 tcx.super_predicates_of(trait_def_id)
1216 fn trait_def(tcx: TyCtxt<'_>, def_id: DefId) -> ty::TraitDef {
1217 let item = tcx.hir().expect_item(def_id.expect_local());
1219 let (is_auto, unsafety, items) = match item.kind {
1220 hir::ItemKind::Trait(is_auto, unsafety, .., items) => {
1221 (is_auto == hir::IsAuto::Yes, unsafety, items)
1223 hir::ItemKind::TraitAlias(..) => (false, hir::Unsafety::Normal, &[][..]),
1224 _ => span_bug!(item.span, "trait_def_of_item invoked on non-trait"),
1227 let paren_sugar = tcx.has_attr(def_id, sym::rustc_paren_sugar);
1228 if paren_sugar && !tcx.features().unboxed_closures {
1232 "the `#[rustc_paren_sugar]` attribute is a temporary means of controlling \
1233 which traits can use parenthetical notation",
1235 .help("add `#![feature(unboxed_closures)]` to the crate attributes to use it")
1239 let is_marker = tcx.has_attr(def_id, sym::marker);
1240 let skip_array_during_method_dispatch =
1241 tcx.has_attr(def_id, sym::rustc_skip_array_during_method_dispatch);
1242 let spec_kind = if tcx.has_attr(def_id, sym::rustc_unsafe_specialization_marker) {
1243 ty::trait_def::TraitSpecializationKind::Marker
1244 } else if tcx.has_attr(def_id, sym::rustc_specialization_trait) {
1245 ty::trait_def::TraitSpecializationKind::AlwaysApplicable
1247 ty::trait_def::TraitSpecializationKind::None
1249 let must_implement_one_of = tcx
1252 .find(|attr| attr.has_name(sym::rustc_must_implement_one_of))
1253 // Check that there are at least 2 arguments of `#[rustc_must_implement_one_of]`
1254 // and that they are all identifiers
1255 .and_then(|attr| match attr.meta_item_list() {
1256 Some(items) if items.len() < 2 => {
1260 "the `#[rustc_must_implement_one_of]` attribute must be \
1261 used with at least 2 args",
1267 Some(items) => items
1269 .map(|item| item.ident().ok_or(item.span()))
1270 .collect::<Result<Box<[_]>, _>>()
1273 .struct_span_err(span, "must be a name of an associated function")
1277 .zip(Some(attr.span)),
1278 // Error is reported by `rustc_attr!`
1281 // Check that all arguments of `#[rustc_must_implement_one_of]` reference
1282 // functions in the trait with default implementations
1283 .and_then(|(list, attr_span)| {
1284 let errors = list.iter().filter_map(|ident| {
1285 let item = items.iter().find(|item| item.ident == *ident);
1288 Some(item) if matches!(item.kind, hir::AssocItemKind::Fn { .. }) => {
1289 if !item.defaultness.has_value() {
1293 "This function doesn't have a default implementation",
1295 .span_note(attr_span, "required by this annotation")
1305 .struct_span_err(item.span, "Not a function")
1306 .span_note(attr_span, "required by this annotation")
1308 "All `#[rustc_must_implement_one_of]` arguments \
1309 must be associated function names",
1315 .struct_span_err(ident.span, "Function not found in this trait")
1323 (errors.count() == 0).then_some(list)
1325 // Check for duplicates
1327 let mut set: FxHashMap<Symbol, Span> = FxHashMap::default();
1328 let mut no_dups = true;
1330 for ident in &*list {
1331 if let Some(dup) = set.insert(ident.name, ident.span) {
1333 .struct_span_err(vec![dup, ident.span], "Functions names are duplicated")
1335 "All `#[rustc_must_implement_one_of]` arguments \
1344 no_dups.then_some(list)
1353 skip_array_during_method_dispatch,
1355 must_implement_one_of,
1359 fn has_late_bound_regions<'tcx>(tcx: TyCtxt<'tcx>, node: Node<'tcx>) -> Option<Span> {
1360 struct LateBoundRegionsDetector<'tcx> {
1362 outer_index: ty::DebruijnIndex,
1363 has_late_bound_regions: Option<Span>,
1366 impl<'tcx> Visitor<'tcx> for LateBoundRegionsDetector<'tcx> {
1367 fn visit_ty(&mut self, ty: &'tcx hir::Ty<'tcx>) {
1368 if self.has_late_bound_regions.is_some() {
1372 hir::TyKind::BareFn(..) => {
1373 self.outer_index.shift_in(1);
1374 intravisit::walk_ty(self, ty);
1375 self.outer_index.shift_out(1);
1377 _ => intravisit::walk_ty(self, ty),
1381 fn visit_poly_trait_ref(
1383 tr: &'tcx hir::PolyTraitRef<'tcx>,
1384 m: hir::TraitBoundModifier,
1386 if self.has_late_bound_regions.is_some() {
1389 self.outer_index.shift_in(1);
1390 intravisit::walk_poly_trait_ref(self, tr, m);
1391 self.outer_index.shift_out(1);
1394 fn visit_lifetime(&mut self, lt: &'tcx hir::Lifetime) {
1395 if self.has_late_bound_regions.is_some() {
1399 match self.tcx.named_region(lt.hir_id) {
1400 Some(rl::Region::Static | rl::Region::EarlyBound(..)) => {}
1402 rl::Region::LateBound(debruijn, _, _)
1403 | rl::Region::LateBoundAnon(debruijn, _, _),
1404 ) if debruijn < self.outer_index => {}
1406 rl::Region::LateBound(..)
1407 | rl::Region::LateBoundAnon(..)
1408 | rl::Region::Free(..),
1411 self.has_late_bound_regions = Some(lt.span);
1417 fn has_late_bound_regions<'tcx>(
1420 generics: &'tcx hir::Generics<'tcx>,
1421 decl: &'tcx hir::FnDecl<'tcx>,
1423 let mut visitor = LateBoundRegionsDetector {
1425 outer_index: ty::INNERMOST,
1426 has_late_bound_regions: None,
1428 let late_bound_map = tcx.is_late_bound_map(def_id);
1429 let is_late_bound = |id| {
1430 let id = tcx.hir().local_def_id(id);
1431 late_bound_map.map_or(false, |(_, set)| set.contains(&id))
1433 for param in generics.params {
1434 if let GenericParamKind::Lifetime { .. } = param.kind {
1435 if is_late_bound(param.hir_id) {
1436 return Some(param.span);
1440 visitor.visit_fn_decl(decl);
1441 visitor.has_late_bound_regions
1445 Node::TraitItem(item) => match item.kind {
1446 hir::TraitItemKind::Fn(ref sig, _) => {
1447 has_late_bound_regions(tcx, item.def_id, &item.generics, sig.decl)
1451 Node::ImplItem(item) => match item.kind {
1452 hir::ImplItemKind::Fn(ref sig, _) => {
1453 has_late_bound_regions(tcx, item.def_id, &item.generics, sig.decl)
1457 Node::ForeignItem(item) => match item.kind {
1458 hir::ForeignItemKind::Fn(fn_decl, _, ref generics) => {
1459 has_late_bound_regions(tcx, item.def_id, generics, fn_decl)
1463 Node::Item(item) => match item.kind {
1464 hir::ItemKind::Fn(ref sig, .., ref generics, _) => {
1465 has_late_bound_regions(tcx, item.def_id, generics, sig.decl)
1473 struct AnonConstInParamTyDetector {
1475 found_anon_const_in_param_ty: bool,
1479 impl<'v> Visitor<'v> for AnonConstInParamTyDetector {
1480 fn visit_generic_param(&mut self, p: &'v hir::GenericParam<'v>) {
1481 if let GenericParamKind::Const { ty, default: _ } = p.kind {
1482 let prev = self.in_param_ty;
1483 self.in_param_ty = true;
1485 self.in_param_ty = prev;
1489 fn visit_anon_const(&mut self, c: &'v hir::AnonConst) {
1490 if self.in_param_ty && self.ct == c.hir_id {
1491 self.found_anon_const_in_param_ty = true;
1493 intravisit::walk_anon_const(self, c)
1498 fn generics_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::Generics {
1501 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
1503 let node = tcx.hir().get(hir_id);
1504 let parent_def_id = match node {
1506 | Node::TraitItem(_)
1509 | Node::Field(_) => {
1510 let parent_id = tcx.hir().get_parent_item(hir_id);
1511 Some(parent_id.to_def_id())
1513 // FIXME(#43408) always enable this once `lazy_normalization` is
1514 // stable enough and does not need a feature gate anymore.
1515 Node::AnonConst(_) => {
1516 let parent_def_id = tcx.hir().get_parent_item(hir_id);
1518 let mut in_param_ty = false;
1519 for (_parent, node) in tcx.hir().parent_iter(hir_id) {
1520 if let Some(generics) = node.generics() {
1521 let mut visitor = AnonConstInParamTyDetector {
1523 found_anon_const_in_param_ty: false,
1527 visitor.visit_generics(generics);
1528 in_param_ty = visitor.found_anon_const_in_param_ty;
1534 // We do not allow generic parameters in anon consts if we are inside
1535 // of a const parameter type, e.g. `struct Foo<const N: usize, const M: [u8; N]>` is not allowed.
1537 } else if tcx.lazy_normalization() {
1538 if let Some(param_id) = tcx.hir().opt_const_param_default_param_hir_id(hir_id) {
1539 // If the def_id we are calling generics_of on is an anon ct default i.e:
1541 // struct Foo<const N: usize = { .. }>;
1542 // ^^^ ^ ^^^^^^ def id of this anon const
1546 // then we only want to return generics for params to the left of `N`. If we don't do that we
1547 // end up with that const looking like: `ty::ConstKind::Unevaluated(def_id, substs: [N#0])`.
1549 // This causes ICEs (#86580) when building the substs for Foo in `fn foo() -> Foo { .. }` as
1550 // we substitute the defaults with the partially built substs when we build the substs. Subst'ing
1551 // the `N#0` on the unevaluated const indexes into the empty substs we're in the process of building.
1553 // We fix this by having this function return the parent's generics ourselves and truncating the
1554 // generics to only include non-forward declared params (with the exception of the `Self` ty)
1556 // For the above code example that means we want `substs: []`
1557 // For the following struct def we want `substs: [N#0]` when generics_of is called on
1558 // the def id of the `{ N + 1 }` anon const
1559 // struct Foo<const N: usize, const M: usize = { N + 1 }>;
1561 // This has some implications for how we get the predicates available to the anon const
1562 // see `explicit_predicates_of` for more information on this
1563 let generics = tcx.generics_of(parent_def_id.to_def_id());
1564 let param_def = tcx.hir().local_def_id(param_id).to_def_id();
1565 let param_def_idx = generics.param_def_id_to_index[¶m_def];
1566 // In the above example this would be .params[..N#0]
1567 let params = generics.params[..param_def_idx as usize].to_owned();
1568 let param_def_id_to_index =
1569 params.iter().map(|param| (param.def_id, param.index)).collect();
1571 return ty::Generics {
1572 // we set the parent of these generics to be our parent's parent so that we
1573 // dont end up with substs: [N, M, N] for the const default on a struct like this:
1574 // struct Foo<const N: usize, const M: usize = { ... }>;
1575 parent: generics.parent,
1576 parent_count: generics.parent_count,
1578 param_def_id_to_index,
1579 has_self: generics.has_self,
1580 has_late_bound_regions: generics.has_late_bound_regions,
1584 // HACK(eddyb) this provides the correct generics when
1585 // `feature(generic_const_expressions)` is enabled, so that const expressions
1586 // used with const generics, e.g. `Foo<{N+1}>`, can work at all.
1588 // Note that we do not supply the parent generics when using
1589 // `min_const_generics`.
1590 Some(parent_def_id.to_def_id())
1592 let parent_node = tcx.hir().get(tcx.hir().get_parent_node(hir_id));
1594 // HACK(eddyb) this provides the correct generics for repeat
1595 // expressions' count (i.e. `N` in `[x; N]`), and explicit
1596 // `enum` discriminants (i.e. `D` in `enum Foo { Bar = D }`),
1597 // as they shouldn't be able to cause query cycle errors.
1598 Node::Expr(&Expr { kind: ExprKind::Repeat(_, ref constant), .. })
1599 if constant.hir_id() == hir_id =>
1601 Some(parent_def_id.to_def_id())
1603 Node::Variant(Variant { disr_expr: Some(ref constant), .. })
1604 if constant.hir_id == hir_id =>
1606 Some(parent_def_id.to_def_id())
1608 Node::Expr(&Expr { kind: ExprKind::ConstBlock(_), .. }) => {
1609 Some(tcx.typeck_root_def_id(def_id))
1615 Node::Expr(&hir::Expr { kind: hir::ExprKind::Closure(..), .. }) => {
1616 Some(tcx.typeck_root_def_id(def_id))
1618 Node::Item(item) => match item.kind {
1619 ItemKind::OpaqueTy(hir::OpaqueTy {
1621 hir::OpaqueTyOrigin::FnReturn(fn_def_id) | hir::OpaqueTyOrigin::AsyncFn(fn_def_id),
1623 }) => Some(fn_def_id.to_def_id()),
1624 ItemKind::OpaqueTy(hir::OpaqueTy { origin: hir::OpaqueTyOrigin::TyAlias, .. }) => {
1625 let parent_id = tcx.hir().get_parent_item(hir_id);
1626 assert_ne!(parent_id, CRATE_DEF_ID);
1627 debug!("generics_of: parent of opaque ty {:?} is {:?}", def_id, parent_id);
1628 // Opaque types are always nested within another item, and
1629 // inherit the generics of the item.
1630 Some(parent_id.to_def_id())
1637 let mut opt_self = None;
1638 let mut allow_defaults = false;
1640 let no_generics = hir::Generics::empty();
1641 let ast_generics = match node {
1642 Node::TraitItem(item) => &item.generics,
1644 Node::ImplItem(item) => &item.generics,
1646 Node::Item(item) => {
1648 ItemKind::Fn(.., ref generics, _)
1649 | ItemKind::Impl(hir::Impl { ref generics, .. }) => generics,
1651 ItemKind::TyAlias(_, ref generics)
1652 | ItemKind::Enum(_, ref generics)
1653 | ItemKind::Struct(_, ref generics)
1654 | ItemKind::OpaqueTy(hir::OpaqueTy { ref generics, .. })
1655 | ItemKind::Union(_, ref generics) => {
1656 allow_defaults = true;
1660 ItemKind::Trait(_, _, ref generics, ..)
1661 | ItemKind::TraitAlias(ref generics, ..) => {
1662 // Add in the self type parameter.
1664 // Something of a hack: use the node id for the trait, also as
1665 // the node id for the Self type parameter.
1666 let param_id = item.def_id;
1668 opt_self = Some(ty::GenericParamDef {
1670 name: kw::SelfUpper,
1671 def_id: param_id.to_def_id(),
1672 pure_wrt_drop: false,
1673 kind: ty::GenericParamDefKind::Type {
1675 object_lifetime_default: rl::Set1::Empty,
1680 allow_defaults = true;
1688 Node::ForeignItem(item) => match item.kind {
1689 ForeignItemKind::Static(..) => &no_generics,
1690 ForeignItemKind::Fn(_, _, ref generics) => generics,
1691 ForeignItemKind::Type => &no_generics,
1697 let has_self = opt_self.is_some();
1698 let mut parent_has_self = false;
1699 let mut own_start = has_self as u32;
1700 let parent_count = parent_def_id.map_or(0, |def_id| {
1701 let generics = tcx.generics_of(def_id);
1703 parent_has_self = generics.has_self;
1704 own_start = generics.count() as u32;
1705 generics.parent_count + generics.params.len()
1708 let mut params: Vec<_> = Vec::with_capacity(ast_generics.params.len() + has_self as usize);
1710 if let Some(opt_self) = opt_self {
1711 params.push(opt_self);
1714 let early_lifetimes = early_bound_lifetimes_from_generics(tcx, hir_id.owner, ast_generics);
1715 params.extend(early_lifetimes.enumerate().map(|(i, param)| ty::GenericParamDef {
1716 name: param.name.ident().name,
1717 index: own_start + i as u32,
1718 def_id: tcx.hir().local_def_id(param.hir_id).to_def_id(),
1719 pure_wrt_drop: param.pure_wrt_drop,
1720 kind: ty::GenericParamDefKind::Lifetime,
1723 let object_lifetime_defaults = tcx.object_lifetime_defaults(hir_id.owner);
1725 // Now create the real type and const parameters.
1726 let type_start = own_start - has_self as u32 + params.len() as u32;
1729 params.extend(ast_generics.params.iter().filter_map(|param| match param.kind {
1730 GenericParamKind::Lifetime { .. } => None,
1731 GenericParamKind::Type { ref default, synthetic, .. } => {
1732 if !allow_defaults && default.is_some() {
1733 if !tcx.features().default_type_parameter_fallback {
1734 tcx.struct_span_lint_hir(
1735 lint::builtin::INVALID_TYPE_PARAM_DEFAULT,
1740 "defaults for type parameters are only allowed in \
1741 `struct`, `enum`, `type`, or `trait` definitions",
1749 let kind = ty::GenericParamDefKind::Type {
1750 has_default: default.is_some(),
1751 object_lifetime_default: object_lifetime_defaults
1753 .map_or(rl::Set1::Empty, |o| o[i]),
1757 let param_def = ty::GenericParamDef {
1758 index: type_start + i as u32,
1759 name: param.name.ident().name,
1760 def_id: tcx.hir().local_def_id(param.hir_id).to_def_id(),
1761 pure_wrt_drop: param.pure_wrt_drop,
1767 GenericParamKind::Const { default, .. } => {
1768 if !allow_defaults && default.is_some() {
1771 "defaults for const parameters are only allowed in \
1772 `struct`, `enum`, `type`, or `trait` definitions",
1776 let param_def = ty::GenericParamDef {
1777 index: type_start + i as u32,
1778 name: param.name.ident().name,
1779 def_id: tcx.hir().local_def_id(param.hir_id).to_def_id(),
1780 pure_wrt_drop: param.pure_wrt_drop,
1781 kind: ty::GenericParamDefKind::Const { has_default: default.is_some() },
1788 // provide junk type parameter defs - the only place that
1789 // cares about anything but the length is instantiation,
1790 // and we don't do that for closures.
1791 if let Node::Expr(&hir::Expr { kind: hir::ExprKind::Closure(.., gen), .. }) = node {
1792 let dummy_args = if gen.is_some() {
1793 &["<resume_ty>", "<yield_ty>", "<return_ty>", "<witness>", "<upvars>"][..]
1795 &["<closure_kind>", "<closure_signature>", "<upvars>"][..]
1798 params.extend(dummy_args.iter().enumerate().map(|(i, &arg)| ty::GenericParamDef {
1799 index: type_start + i as u32,
1800 name: Symbol::intern(arg),
1802 pure_wrt_drop: false,
1803 kind: ty::GenericParamDefKind::Type {
1805 object_lifetime_default: rl::Set1::Empty,
1811 // provide junk type parameter defs for const blocks.
1812 if let Node::AnonConst(_) = node {
1813 let parent_node = tcx.hir().get(tcx.hir().get_parent_node(hir_id));
1814 if let Node::Expr(&Expr { kind: ExprKind::ConstBlock(_), .. }) = parent_node {
1815 params.push(ty::GenericParamDef {
1817 name: Symbol::intern("<const_ty>"),
1819 pure_wrt_drop: false,
1820 kind: ty::GenericParamDefKind::Type {
1822 object_lifetime_default: rl::Set1::Empty,
1829 let param_def_id_to_index = params.iter().map(|param| (param.def_id, param.index)).collect();
1832 parent: parent_def_id,
1835 param_def_id_to_index,
1836 has_self: has_self || parent_has_self,
1837 has_late_bound_regions: has_late_bound_regions(tcx, node),
1841 fn are_suggestable_generic_args(generic_args: &[hir::GenericArg<'_>]) -> bool {
1842 generic_args.iter().any(|arg| match arg {
1843 hir::GenericArg::Type(ty) => is_suggestable_infer_ty(ty),
1844 hir::GenericArg::Infer(_) => true,
1849 /// Whether `ty` is a type with `_` placeholders that can be inferred. Used in diagnostics only to
1850 /// use inference to provide suggestions for the appropriate type if possible.
1851 fn is_suggestable_infer_ty(ty: &hir::Ty<'_>) -> bool {
1856 Slice(ty) => is_suggestable_infer_ty(ty),
1857 Array(ty, length) => {
1858 is_suggestable_infer_ty(ty) || matches!(length, hir::ArrayLen::Infer(_, _))
1860 Tup(tys) => tys.iter().any(is_suggestable_infer_ty),
1861 Ptr(mut_ty) | Rptr(_, mut_ty) => is_suggestable_infer_ty(mut_ty.ty),
1862 OpaqueDef(_, generic_args) => are_suggestable_generic_args(generic_args),
1863 Path(hir::QPath::TypeRelative(ty, segment)) => {
1864 is_suggestable_infer_ty(ty) || are_suggestable_generic_args(segment.args().args)
1866 Path(hir::QPath::Resolved(ty_opt, hir::Path { segments, .. })) => {
1867 ty_opt.map_or(false, is_suggestable_infer_ty)
1868 || segments.iter().any(|segment| are_suggestable_generic_args(segment.args().args))
1874 pub fn get_infer_ret_ty<'hir>(output: &'hir hir::FnRetTy<'hir>) -> Option<&'hir hir::Ty<'hir>> {
1875 if let hir::FnRetTy::Return(ty) = output {
1876 if is_suggestable_infer_ty(ty) {
1883 fn fn_sig(tcx: TyCtxt<'_>, def_id: DefId) -> ty::PolyFnSig<'_> {
1884 use rustc_hir::Node::*;
1887 let def_id = def_id.expect_local();
1888 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
1890 let icx = ItemCtxt::new(tcx, def_id.to_def_id());
1892 match tcx.hir().get(hir_id) {
1893 TraitItem(hir::TraitItem {
1894 kind: TraitItemKind::Fn(sig, TraitFn::Provided(_)),
1899 | Item(hir::Item { kind: ItemKind::Fn(sig, generics, _), ident, .. }) => {
1900 infer_return_ty_for_fn_sig(tcx, sig, *ident, generics, def_id, &icx)
1903 ImplItem(hir::ImplItem { kind: ImplItemKind::Fn(sig, _), ident, generics, .. }) => {
1904 // Do not try to inference the return type for a impl method coming from a trait
1905 if let Item(hir::Item { kind: ItemKind::Impl(i), .. }) =
1906 tcx.hir().get(tcx.hir().get_parent_node(hir_id))
1907 && i.of_trait.is_some()
1909 <dyn AstConv<'_>>::ty_of_fn(
1912 sig.header.unsafety,
1920 infer_return_ty_for_fn_sig(tcx, sig, *ident, generics, def_id, &icx)
1924 TraitItem(hir::TraitItem {
1925 kind: TraitItemKind::Fn(FnSig { header, decl, span: _ }, _),
1929 }) => <dyn AstConv<'_>>::ty_of_fn(
1940 ForeignItem(&hir::ForeignItem {
1941 kind: ForeignItemKind::Fn(fn_decl, _, _), ident, ..
1943 let abi = tcx.hir().get_foreign_abi(hir_id);
1944 compute_sig_of_foreign_fn_decl(tcx, def_id.to_def_id(), fn_decl, abi, ident)
1947 Ctor(data) | Variant(hir::Variant { data, .. }) if data.ctor_hir_id().is_some() => {
1948 let ty = tcx.type_of(tcx.hir().get_parent_item(hir_id));
1950 data.fields().iter().map(|f| tcx.type_of(tcx.hir().local_def_id(f.hir_id)));
1951 ty::Binder::dummy(tcx.mk_fn_sig(
1955 hir::Unsafety::Normal,
1960 Expr(&hir::Expr { kind: hir::ExprKind::Closure(..), .. }) => {
1961 // Closure signatures are not like other function
1962 // signatures and cannot be accessed through `fn_sig`. For
1963 // example, a closure signature excludes the `self`
1964 // argument. In any case they are embedded within the
1965 // closure type as part of the `ClosureSubsts`.
1967 // To get the signature of a closure, you should use the
1968 // `sig` method on the `ClosureSubsts`:
1970 // substs.as_closure().sig(def_id, tcx)
1972 "to get the signature of a closure, use `substs.as_closure().sig()` not `fn_sig()`",
1977 bug!("unexpected sort of node in fn_sig(): {:?}", x);
1982 fn infer_return_ty_for_fn_sig<'tcx>(
1984 sig: &hir::FnSig<'_>,
1986 generics: &hir::Generics<'_>,
1988 icx: &ItemCtxt<'tcx>,
1989 ) -> ty::PolyFnSig<'tcx> {
1990 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
1992 match get_infer_ret_ty(&sig.decl.output) {
1994 let fn_sig = tcx.typeck(def_id).liberated_fn_sigs()[hir_id];
1995 // Typeck doesn't expect erased regions to be returned from `type_of`.
1996 let fn_sig = tcx.fold_regions(fn_sig, &mut false, |r, _| match *r {
1997 ty::ReErased => tcx.lifetimes.re_static,
2000 let fn_sig = ty::Binder::dummy(fn_sig);
2002 let mut visitor = HirPlaceholderCollector::default();
2003 visitor.visit_ty(ty);
2004 let mut diag = bad_placeholder(tcx, visitor.0, "return type");
2005 let ret_ty = fn_sig.skip_binder().output();
2006 if ret_ty.is_suggestable(tcx) {
2007 diag.span_suggestion(
2009 "replace with the correct return type",
2011 Applicability::MachineApplicable,
2013 } else if matches!(ret_ty.kind(), ty::FnDef(..)) {
2014 let fn_sig = ret_ty.fn_sig(tcx);
2015 if fn_sig.skip_binder().inputs_and_output.iter().all(|t| t.is_suggestable(tcx)) {
2016 diag.span_suggestion(
2018 "replace with the correct return type",
2020 Applicability::MachineApplicable,
2023 } else if ret_ty.is_closure() {
2024 // We're dealing with a closure, so we should suggest using `impl Fn` or trait bounds
2025 // to prevent the user from getting a papercut while trying to use the unique closure
2026 // syntax (e.g. `[closure@src/lib.rs:2:5: 2:9]`).
2027 diag.help("consider using an `Fn`, `FnMut`, or `FnOnce` trait bound");
2028 diag.note("for more information on `Fn` traits and closure types, see https://doc.rust-lang.org/book/ch13-01-closures.html");
2034 None => <dyn AstConv<'_>>::ty_of_fn(
2037 sig.header.unsafety,
2047 fn impl_trait_ref(tcx: TyCtxt<'_>, def_id: DefId) -> Option<ty::TraitRef<'_>> {
2048 let icx = ItemCtxt::new(tcx, def_id);
2049 match tcx.hir().expect_item(def_id.expect_local()).kind {
2050 hir::ItemKind::Impl(ref impl_) => impl_.of_trait.as_ref().map(|ast_trait_ref| {
2051 let selfty = tcx.type_of(def_id);
2052 <dyn AstConv<'_>>::instantiate_mono_trait_ref(&icx, ast_trait_ref, selfty)
2058 fn impl_polarity(tcx: TyCtxt<'_>, def_id: DefId) -> ty::ImplPolarity {
2059 let is_rustc_reservation = tcx.has_attr(def_id, sym::rustc_reservation_impl);
2060 let item = tcx.hir().expect_item(def_id.expect_local());
2062 hir::ItemKind::Impl(hir::Impl {
2063 polarity: hir::ImplPolarity::Negative(span),
2067 if is_rustc_reservation {
2068 let span = span.to(of_trait.as_ref().map_or(*span, |t| t.path.span));
2069 tcx.sess.span_err(span, "reservation impls can't be negative");
2071 ty::ImplPolarity::Negative
2073 hir::ItemKind::Impl(hir::Impl {
2074 polarity: hir::ImplPolarity::Positive,
2078 if is_rustc_reservation {
2079 tcx.sess.span_err(item.span, "reservation impls can't be inherent");
2081 ty::ImplPolarity::Positive
2083 hir::ItemKind::Impl(hir::Impl {
2084 polarity: hir::ImplPolarity::Positive,
2088 if is_rustc_reservation {
2089 ty::ImplPolarity::Reservation
2091 ty::ImplPolarity::Positive
2094 item => bug!("impl_polarity: {:?} not an impl", item),
2098 /// Returns the early-bound lifetimes declared in this generics
2099 /// listing. For anything other than fns/methods, this is just all
2100 /// the lifetimes that are declared. For fns or methods, we have to
2101 /// screen out those that do not appear in any where-clauses etc using
2102 /// `resolve_lifetime::early_bound_lifetimes`.
2103 fn early_bound_lifetimes_from_generics<'a, 'tcx: 'a>(
2106 generics: &'a hir::Generics<'a>,
2107 ) -> impl Iterator<Item = &'a hir::GenericParam<'a>> + Captures<'tcx> {
2108 let late_bound_map = if generics.params.is_empty() {
2109 // This function may be called on `def_id == CRATE_DEF_ID`,
2110 // which makes `is_late_bound_map` ICE. Don't even try if there
2111 // is no generic parameter.
2114 tcx.is_late_bound_map(def_id)
2116 let is_late_bound = move |hir_id| {
2117 let id = tcx.hir().local_def_id(hir_id);
2118 late_bound_map.map_or(false, |(_, set)| set.contains(&id))
2120 generics.params.iter().filter(move |param| match param.kind {
2121 GenericParamKind::Lifetime { .. } => !is_late_bound(param.hir_id),
2126 /// Returns a list of type predicates for the definition with ID `def_id`, including inferred
2127 /// lifetime constraints. This includes all predicates returned by `explicit_predicates_of`, plus
2128 /// inferred constraints concerning which regions outlive other regions.
2129 fn predicates_defined_on(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2130 debug!("predicates_defined_on({:?})", def_id);
2131 let mut result = tcx.explicit_predicates_of(def_id);
2132 debug!("predicates_defined_on: explicit_predicates_of({:?}) = {:?}", def_id, result,);
2133 let inferred_outlives = tcx.inferred_outlives_of(def_id);
2134 if !inferred_outlives.is_empty() {
2136 "predicates_defined_on: inferred_outlives_of({:?}) = {:?}",
2137 def_id, inferred_outlives,
2139 if result.predicates.is_empty() {
2140 result.predicates = inferred_outlives;
2142 result.predicates = tcx
2144 .alloc_from_iter(result.predicates.iter().chain(inferred_outlives).copied());
2148 debug!("predicates_defined_on({:?}) = {:?}", def_id, result);
2152 /// Returns a list of all type predicates (explicit and implicit) for the definition with
2153 /// ID `def_id`. This includes all predicates returned by `predicates_defined_on`, plus
2154 /// `Self: Trait` predicates for traits.
2155 fn predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2156 let mut result = tcx.predicates_defined_on(def_id);
2158 if tcx.is_trait(def_id) {
2159 // For traits, add `Self: Trait` predicate. This is
2160 // not part of the predicates that a user writes, but it
2161 // is something that one must prove in order to invoke a
2162 // method or project an associated type.
2164 // In the chalk setup, this predicate is not part of the
2165 // "predicates" for a trait item. But it is useful in
2166 // rustc because if you directly (e.g.) invoke a trait
2167 // method like `Trait::method(...)`, you must naturally
2168 // prove that the trait applies to the types that were
2169 // used, and adding the predicate into this list ensures
2170 // that this is done.
2172 // We use a DUMMY_SP here as a way to signal trait bounds that come
2173 // from the trait itself that *shouldn't* be shown as the source of
2174 // an obligation and instead be skipped. Otherwise we'd use
2175 // `tcx.def_span(def_id);`
2176 let span = rustc_span::DUMMY_SP;
2178 tcx.arena.alloc_from_iter(result.predicates.iter().copied().chain(std::iter::once((
2179 ty::TraitRef::identity(tcx, def_id).without_const().to_predicate(tcx),
2183 debug!("predicates_of(def_id={:?}) = {:?}", def_id, result);
2187 /// Returns a list of user-specified type predicates for the definition with ID `def_id`.
2188 /// N.B., this does not include any implied/inferred constraints.
2189 fn gather_explicit_predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2192 debug!("explicit_predicates_of(def_id={:?})", def_id);
2194 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
2195 let node = tcx.hir().get(hir_id);
2197 let mut is_trait = None;
2198 let mut is_default_impl_trait = None;
2200 let icx = ItemCtxt::new(tcx, def_id);
2202 const NO_GENERICS: &hir::Generics<'_> = hir::Generics::empty();
2204 // We use an `IndexSet` to preserves order of insertion.
2205 // Preserving the order of insertion is important here so as not to break UI tests.
2206 let mut predicates: FxIndexSet<(ty::Predicate<'_>, Span)> = FxIndexSet::default();
2208 let ast_generics = match node {
2209 Node::TraitItem(item) => item.generics,
2211 Node::ImplItem(item) => item.generics,
2213 Node::Item(item) => {
2215 ItemKind::Impl(ref impl_) => {
2216 if impl_.defaultness.is_default() {
2217 is_default_impl_trait = tcx.impl_trait_ref(def_id).map(ty::Binder::dummy);
2221 ItemKind::Fn(.., ref generics, _)
2222 | ItemKind::TyAlias(_, ref generics)
2223 | ItemKind::Enum(_, ref generics)
2224 | ItemKind::Struct(_, ref generics)
2225 | ItemKind::Union(_, ref generics) => *generics,
2227 ItemKind::Trait(_, _, ref generics, ..) => {
2228 is_trait = Some(ty::TraitRef::identity(tcx, def_id));
2231 ItemKind::TraitAlias(ref generics, _) => {
2232 is_trait = Some(ty::TraitRef::identity(tcx, def_id));
2235 ItemKind::OpaqueTy(OpaqueTy {
2236 origin: hir::OpaqueTyOrigin::AsyncFn(..) | hir::OpaqueTyOrigin::FnReturn(..),
2239 // return-position impl trait
2241 // We don't inherit predicates from the parent here:
2242 // If we have, say `fn f<'a, T: 'a>() -> impl Sized {}`
2243 // then the return type is `f::<'static, T>::{{opaque}}`.
2245 // If we inherited the predicates of `f` then we would
2246 // require that `T: 'static` to show that the return
2247 // type is well-formed.
2249 // The only way to have something with this opaque type
2250 // is from the return type of the containing function,
2251 // which will ensure that the function's predicates
2253 return ty::GenericPredicates { parent: None, predicates: &[] };
2255 ItemKind::OpaqueTy(OpaqueTy {
2257 origin: hir::OpaqueTyOrigin::TyAlias,
2260 // type-alias impl trait
2268 Node::ForeignItem(item) => match item.kind {
2269 ForeignItemKind::Static(..) => NO_GENERICS,
2270 ForeignItemKind::Fn(_, _, ref generics) => *generics,
2271 ForeignItemKind::Type => NO_GENERICS,
2277 let generics = tcx.generics_of(def_id);
2278 let parent_count = generics.parent_count as u32;
2279 let has_own_self = generics.has_self && parent_count == 0;
2281 // Below we'll consider the bounds on the type parameters (including `Self`)
2282 // and the explicit where-clauses, but to get the full set of predicates
2283 // on a trait we need to add in the supertrait bounds and bounds found on
2284 // associated types.
2285 if let Some(_trait_ref) = is_trait {
2286 predicates.extend(tcx.super_predicates_of(def_id).predicates.iter().cloned());
2289 // In default impls, we can assume that the self type implements
2290 // the trait. So in:
2292 // default impl Foo for Bar { .. }
2294 // we add a default where clause `Foo: Bar`. We do a similar thing for traits
2295 // (see below). Recall that a default impl is not itself an impl, but rather a
2296 // set of defaults that can be incorporated into another impl.
2297 if let Some(trait_ref) = is_default_impl_trait {
2298 predicates.insert((trait_ref.without_const().to_predicate(tcx), tcx.def_span(def_id)));
2301 // Collect the region predicates that were declared inline as
2302 // well. In the case of parameters declared on a fn or method, we
2303 // have to be careful to only iterate over early-bound regions.
2304 let mut index = parent_count + has_own_self as u32;
2305 for param in early_bound_lifetimes_from_generics(tcx, hir_id.owner, ast_generics) {
2306 let region = tcx.mk_region(ty::ReEarlyBound(ty::EarlyBoundRegion {
2307 def_id: tcx.hir().local_def_id(param.hir_id).to_def_id(),
2309 name: param.name.ident().name,
2314 GenericParamKind::Lifetime { .. } => {
2315 param.bounds.iter().for_each(|bound| match bound {
2316 hir::GenericBound::Outlives(lt) => {
2317 let bound = <dyn AstConv<'_>>::ast_region_to_region(&icx, lt, None);
2318 let outlives = ty::Binder::dummy(ty::OutlivesPredicate(region, bound));
2319 predicates.insert((outlives.to_predicate(tcx), lt.span));
2328 // Collect the predicates that were written inline by the user on each
2329 // type parameter (e.g., `<T: Foo>`).
2330 for param in ast_generics.params {
2332 // We already dealt with early bound lifetimes above.
2333 GenericParamKind::Lifetime { .. } => (),
2334 GenericParamKind::Type { .. } => {
2335 let name = param.name.ident().name;
2336 let param_ty = ty::ParamTy::new(index, name).to_ty(tcx);
2339 let mut bounds = <dyn AstConv<'_>>::compute_bounds(&icx, param_ty, param.bounds);
2340 // Params are implicitly sized unless a `?Sized` bound is found
2341 <dyn AstConv<'_>>::add_implicitly_sized(
2345 Some((param.hir_id, ast_generics.predicates)),
2348 predicates.extend(bounds.predicates(tcx, param_ty));
2350 GenericParamKind::Const { .. } => {
2351 // Bounds on const parameters are currently not possible.
2352 debug_assert!(param.bounds.is_empty());
2358 // Add in the bounds that appear in the where-clause.
2359 for predicate in ast_generics.predicates {
2361 hir::WherePredicate::BoundPredicate(bound_pred) => {
2362 let ty = icx.to_ty(bound_pred.bounded_ty);
2363 let bound_vars = icx.tcx.late_bound_vars(bound_pred.bounded_ty.hir_id);
2365 // Keep the type around in a dummy predicate, in case of no bounds.
2366 // That way, `where Ty:` is not a complete noop (see #53696) and `Ty`
2367 // is still checked for WF.
2368 if bound_pred.bounds.is_empty() {
2369 if let ty::Param(_) = ty.kind() {
2370 // This is a `where T:`, which can be in the HIR from the
2371 // transformation that moves `?Sized` to `T`'s declaration.
2372 // We can skip the predicate because type parameters are
2373 // trivially WF, but also we *should*, to avoid exposing
2374 // users who never wrote `where Type:,` themselves, to
2375 // compiler/tooling bugs from not handling WF predicates.
2377 let span = bound_pred.bounded_ty.span;
2378 let re_root_empty = tcx.lifetimes.re_root_empty;
2379 let predicate = ty::Binder::bind_with_vars(
2380 ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(
2386 predicates.insert((predicate.to_predicate(tcx), span));
2390 let mut bounds = Bounds::default();
2391 <dyn AstConv<'_>>::add_bounds(
2394 bound_pred.bounds.iter(),
2398 predicates.extend(bounds.predicates(tcx, ty));
2401 hir::WherePredicate::RegionPredicate(region_pred) => {
2402 let r1 = <dyn AstConv<'_>>::ast_region_to_region(&icx, ®ion_pred.lifetime, None);
2403 predicates.extend(region_pred.bounds.iter().map(|bound| {
2404 let (r2, span) = match bound {
2405 hir::GenericBound::Outlives(lt) => {
2406 (<dyn AstConv<'_>>::ast_region_to_region(&icx, lt, None), lt.span)
2410 let pred = ty::Binder::dummy(ty::PredicateKind::RegionOutlives(
2411 ty::OutlivesPredicate(r1, r2),
2413 .to_predicate(icx.tcx);
2419 hir::WherePredicate::EqPredicate(..) => {
2425 if tcx.features().generic_const_exprs {
2426 predicates.extend(const_evaluatable_predicates_of(tcx, def_id.expect_local()));
2429 let mut predicates: Vec<_> = predicates.into_iter().collect();
2431 // Subtle: before we store the predicates into the tcx, we
2432 // sort them so that predicates like `T: Foo<Item=U>` come
2433 // before uses of `U`. This avoids false ambiguity errors
2434 // in trait checking. See `setup_constraining_predicates`
2436 if let Node::Item(&Item { kind: ItemKind::Impl { .. }, .. }) = node {
2437 let self_ty = tcx.type_of(def_id);
2438 let trait_ref = tcx.impl_trait_ref(def_id);
2439 cgp::setup_constraining_predicates(
2443 &mut cgp::parameters_for_impl(self_ty, trait_ref),
2447 let result = ty::GenericPredicates {
2448 parent: generics.parent,
2449 predicates: tcx.arena.alloc_from_iter(predicates),
2451 debug!("explicit_predicates_of(def_id={:?}) = {:?}", def_id, result);
2455 fn const_evaluatable_predicates_of<'tcx>(
2458 ) -> FxIndexSet<(ty::Predicate<'tcx>, Span)> {
2459 struct ConstCollector<'tcx> {
2461 preds: FxIndexSet<(ty::Predicate<'tcx>, Span)>,
2464 impl<'tcx> intravisit::Visitor<'tcx> for ConstCollector<'tcx> {
2465 fn visit_anon_const(&mut self, c: &'tcx hir::AnonConst) {
2466 let def_id = self.tcx.hir().local_def_id(c.hir_id);
2467 let ct = ty::Const::from_anon_const(self.tcx, def_id);
2468 if let ty::ConstKind::Unevaluated(uv) = ct.val() {
2469 assert_eq!(uv.promoted, None);
2470 let span = self.tcx.hir().span(c.hir_id);
2472 ty::Binder::dummy(ty::PredicateKind::ConstEvaluatable(uv.shrink()))
2473 .to_predicate(self.tcx),
2479 fn visit_const_param_default(&mut self, _param: HirId, _ct: &'tcx hir::AnonConst) {
2480 // Do not look into const param defaults,
2481 // these get checked when they are actually instantiated.
2483 // We do not want the following to error:
2485 // struct Foo<const N: usize, const M: usize = { N + 1 }>;
2486 // struct Bar<const N: usize>(Foo<N, 3>);
2490 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
2491 let node = tcx.hir().get(hir_id);
2493 let mut collector = ConstCollector { tcx, preds: FxIndexSet::default() };
2494 if let hir::Node::Item(item) = node && let hir::ItemKind::Impl(ref impl_) = item.kind {
2495 if let Some(of_trait) = &impl_.of_trait {
2496 debug!("const_evaluatable_predicates_of({:?}): visit impl trait_ref", def_id);
2497 collector.visit_trait_ref(of_trait);
2500 debug!("const_evaluatable_predicates_of({:?}): visit_self_ty", def_id);
2501 collector.visit_ty(impl_.self_ty);
2504 if let Some(generics) = node.generics() {
2505 debug!("const_evaluatable_predicates_of({:?}): visit_generics", def_id);
2506 collector.visit_generics(generics);
2509 if let Some(fn_sig) = tcx.hir().fn_sig_by_hir_id(hir_id) {
2510 debug!("const_evaluatable_predicates_of({:?}): visit_fn_decl", def_id);
2511 collector.visit_fn_decl(fn_sig.decl);
2513 debug!("const_evaluatable_predicates_of({:?}) = {:?}", def_id, collector.preds);
2518 fn trait_explicit_predicates_and_bounds(
2521 ) -> ty::GenericPredicates<'_> {
2522 assert_eq!(tcx.def_kind(def_id), DefKind::Trait);
2523 gather_explicit_predicates_of(tcx, def_id.to_def_id())
2526 fn explicit_predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2527 let def_kind = tcx.def_kind(def_id);
2528 if let DefKind::Trait = def_kind {
2529 // Remove bounds on associated types from the predicates, they will be
2530 // returned by `explicit_item_bounds`.
2531 let predicates_and_bounds = tcx.trait_explicit_predicates_and_bounds(def_id.expect_local());
2532 let trait_identity_substs = InternalSubsts::identity_for_item(tcx, def_id);
2534 let is_assoc_item_ty = |ty: Ty<'_>| {
2535 // For a predicate from a where clause to become a bound on an
2537 // * It must use the identity substs of the item.
2538 // * Since any generic parameters on the item are not in scope,
2539 // this means that the item is not a GAT, and its identity
2540 // substs are the same as the trait's.
2541 // * It must be an associated type for this trait (*not* a
2543 if let ty::Projection(projection) = ty.kind() {
2544 projection.substs == trait_identity_substs
2545 && tcx.associated_item(projection.item_def_id).container.id() == def_id
2551 let predicates: Vec<_> = predicates_and_bounds
2555 .filter(|(pred, _)| match pred.kind().skip_binder() {
2556 ty::PredicateKind::Trait(tr) => !is_assoc_item_ty(tr.self_ty()),
2557 ty::PredicateKind::Projection(proj) => {
2558 !is_assoc_item_ty(proj.projection_ty.self_ty())
2560 ty::PredicateKind::TypeOutlives(outlives) => !is_assoc_item_ty(outlives.0),
2564 if predicates.len() == predicates_and_bounds.predicates.len() {
2565 predicates_and_bounds
2567 ty::GenericPredicates {
2568 parent: predicates_and_bounds.parent,
2569 predicates: tcx.arena.alloc_slice(&predicates),
2573 if matches!(def_kind, DefKind::AnonConst) && tcx.lazy_normalization() {
2574 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
2575 if tcx.hir().opt_const_param_default_param_hir_id(hir_id).is_some() {
2576 // In `generics_of` we set the generics' parent to be our parent's parent which means that
2577 // we lose out on the predicates of our actual parent if we dont return those predicates here.
2578 // (See comment in `generics_of` for more information on why the parent shenanigans is necessary)
2580 // struct Foo<T, const N: usize = { <T as Trait>::ASSOC }>(T) where T: Trait;
2581 // ^^^ ^^^^^^^^^^^^^^^^^^^^^^^ the def id we are calling
2582 // ^^^ explicit_predicates_of on
2583 // parent item we dont have set as the
2584 // parent of generics returned by `generics_of`
2586 // In the above code we want the anon const to have predicates in its param env for `T: Trait`
2587 let item_def_id = tcx.hir().get_parent_item(hir_id);
2588 // In the above code example we would be calling `explicit_predicates_of(Foo)` here
2589 return tcx.explicit_predicates_of(item_def_id);
2592 gather_explicit_predicates_of(tcx, def_id)
2596 /// Converts a specific `GenericBound` from the AST into a set of
2597 /// predicates that apply to the self type. A vector is returned
2598 /// because this can be anywhere from zero predicates (`T: ?Sized` adds no
2599 /// predicates) to one (`T: Foo`) to many (`T: Bar<X = i32>` adds `T: Bar`
2600 /// and `<T as Bar>::X == i32`).
2601 fn predicates_from_bound<'tcx>(
2602 astconv: &dyn AstConv<'tcx>,
2604 bound: &'tcx hir::GenericBound<'tcx>,
2605 bound_vars: &'tcx ty::List<ty::BoundVariableKind>,
2606 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
2607 let mut bounds = Bounds::default();
2608 astconv.add_bounds(param_ty, [bound].into_iter(), &mut bounds, bound_vars);
2609 bounds.predicates(astconv.tcx(), param_ty).collect()
2612 fn compute_sig_of_foreign_fn_decl<'tcx>(
2615 decl: &'tcx hir::FnDecl<'tcx>,
2618 ) -> ty::PolyFnSig<'tcx> {
2619 let unsafety = if abi == abi::Abi::RustIntrinsic {
2620 intrinsic_operation_unsafety(tcx.item_name(def_id))
2622 hir::Unsafety::Unsafe
2624 let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
2625 let fty = <dyn AstConv<'_>>::ty_of_fn(
2626 &ItemCtxt::new(tcx, def_id),
2631 &hir::Generics::empty(),
2636 // Feature gate SIMD types in FFI, since I am not sure that the
2637 // ABIs are handled at all correctly. -huonw
2638 if abi != abi::Abi::RustIntrinsic
2639 && abi != abi::Abi::PlatformIntrinsic
2640 && !tcx.features().simd_ffi
2642 let check = |ast_ty: &hir::Ty<'_>, ty: Ty<'_>| {
2647 .span_to_snippet(ast_ty.span)
2648 .map_or_else(|_| String::new(), |s| format!(" `{}`", s));
2653 "use of SIMD type{} in FFI is highly experimental and \
2654 may result in invalid code",
2658 .help("add `#![feature(simd_ffi)]` to the crate attributes to enable")
2662 for (input, ty) in iter::zip(decl.inputs, fty.inputs().skip_binder()) {
2665 if let hir::FnRetTy::Return(ref ty) = decl.output {
2666 check(ty, fty.output().skip_binder())
2673 fn is_foreign_item(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
2674 match tcx.hir().get_if_local(def_id) {
2675 Some(Node::ForeignItem(..)) => true,
2677 _ => bug!("is_foreign_item applied to non-local def-id {:?}", def_id),
2681 fn generator_kind(tcx: TyCtxt<'_>, def_id: DefId) -> Option<hir::GeneratorKind> {
2682 match tcx.hir().get_if_local(def_id) {
2683 Some(Node::Expr(&rustc_hir::Expr {
2684 kind: rustc_hir::ExprKind::Closure(_, _, body_id, _, _),
2686 })) => tcx.hir().body(body_id).generator_kind(),
2688 _ => bug!("generator_kind applied to non-local def-id {:?}", def_id),
2692 fn from_target_feature(
2695 attr: &ast::Attribute,
2696 supported_target_features: &FxHashMap<String, Option<Symbol>>,
2697 target_features: &mut Vec<Symbol>,
2699 let Some(list) = attr.meta_item_list() else { return };
2700 let bad_item = |span| {
2701 let msg = "malformed `target_feature` attribute input";
2702 let code = "enable = \"..\"".to_owned();
2704 .struct_span_err(span, msg)
2705 .span_suggestion(span, "must be of the form", code, Applicability::HasPlaceholders)
2708 let rust_features = tcx.features();
2710 // Only `enable = ...` is accepted in the meta-item list.
2711 if !item.has_name(sym::enable) {
2712 bad_item(item.span());
2716 // Must be of the form `enable = "..."` (a string).
2717 let Some(value) = item.value_str() else {
2718 bad_item(item.span());
2722 // We allow comma separation to enable multiple features.
2723 target_features.extend(value.as_str().split(',').filter_map(|feature| {
2724 let Some(feature_gate) = supported_target_features.get(feature) else {
2726 format!("the feature named `{}` is not valid for this target", feature);
2727 let mut err = tcx.sess.struct_span_err(item.span(), &msg);
2730 format!("`{}` is not valid for this target", feature),
2732 if let Some(stripped) = feature.strip_prefix('+') {
2733 let valid = supported_target_features.contains_key(stripped);
2735 err.help("consider removing the leading `+` in the feature name");
2742 // Only allow features whose feature gates have been enabled.
2743 let allowed = match feature_gate.as_ref().copied() {
2744 Some(sym::arm_target_feature) => rust_features.arm_target_feature,
2745 Some(sym::hexagon_target_feature) => rust_features.hexagon_target_feature,
2746 Some(sym::powerpc_target_feature) => rust_features.powerpc_target_feature,
2747 Some(sym::mips_target_feature) => rust_features.mips_target_feature,
2748 Some(sym::riscv_target_feature) => rust_features.riscv_target_feature,
2749 Some(sym::avx512_target_feature) => rust_features.avx512_target_feature,
2750 Some(sym::sse4a_target_feature) => rust_features.sse4a_target_feature,
2751 Some(sym::tbm_target_feature) => rust_features.tbm_target_feature,
2752 Some(sym::wasm_target_feature) => rust_features.wasm_target_feature,
2753 Some(sym::cmpxchg16b_target_feature) => rust_features.cmpxchg16b_target_feature,
2754 Some(sym::movbe_target_feature) => rust_features.movbe_target_feature,
2755 Some(sym::rtm_target_feature) => rust_features.rtm_target_feature,
2756 Some(sym::f16c_target_feature) => rust_features.f16c_target_feature,
2757 Some(sym::ermsb_target_feature) => rust_features.ermsb_target_feature,
2758 Some(sym::bpf_target_feature) => rust_features.bpf_target_feature,
2759 Some(sym::aarch64_ver_target_feature) => rust_features.aarch64_ver_target_feature,
2760 Some(name) => bug!("unknown target feature gate {}", name),
2763 if !allowed && id.is_local() {
2765 &tcx.sess.parse_sess,
2766 feature_gate.unwrap(),
2768 &format!("the target feature `{}` is currently unstable", feature),
2772 Some(Symbol::intern(feature))
2777 fn linkage_by_name(tcx: TyCtxt<'_>, def_id: DefId, name: &str) -> Linkage {
2778 use rustc_middle::mir::mono::Linkage::*;
2780 // Use the names from src/llvm/docs/LangRef.rst here. Most types are only
2781 // applicable to variable declarations and may not really make sense for
2782 // Rust code in the first place but allow them anyway and trust that the
2783 // user knows what they're doing. Who knows, unanticipated use cases may pop
2784 // up in the future.
2786 // ghost, dllimport, dllexport and linkonce_odr_autohide are not supported
2787 // and don't have to be, LLVM treats them as no-ops.
2789 "appending" => Appending,
2790 "available_externally" => AvailableExternally,
2792 "extern_weak" => ExternalWeak,
2793 "external" => External,
2794 "internal" => Internal,
2795 "linkonce" => LinkOnceAny,
2796 "linkonce_odr" => LinkOnceODR,
2797 "private" => Private,
2799 "weak_odr" => WeakODR,
2801 let span = tcx.hir().span_if_local(def_id);
2802 if let Some(span) = span {
2803 tcx.sess.span_fatal(span, "invalid linkage specified")
2805 tcx.sess.fatal(&format!("invalid linkage specified: {}", name))
2811 fn codegen_fn_attrs(tcx: TyCtxt<'_>, id: DefId) -> CodegenFnAttrs {
2812 let attrs = tcx.get_attrs(id);
2814 let mut codegen_fn_attrs = CodegenFnAttrs::new();
2815 if tcx.should_inherit_track_caller(id) {
2816 codegen_fn_attrs.flags |= CodegenFnAttrFlags::TRACK_CALLER;
2819 // With -Z panic-in-drop=abort, drop_in_place never unwinds.
2820 if tcx.sess.opts.debugging_opts.panic_in_drop == PanicStrategy::Abort {
2821 if Some(id) == tcx.lang_items().drop_in_place_fn() {
2822 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NEVER_UNWIND;
2826 // The panic_no_unwind function called by TerminatorKind::Abort will never
2827 // unwind. If the panic handler that it invokes unwind then it will simply
2828 // call the panic handler again.
2829 if Some(id) == tcx.lang_items().panic_no_unwind() {
2830 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NEVER_UNWIND;
2833 let supported_target_features = tcx.supported_target_features(LOCAL_CRATE);
2835 let mut inline_span = None;
2836 let mut link_ordinal_span = None;
2837 let mut no_sanitize_span = None;
2838 for attr in attrs.iter() {
2839 if attr.has_name(sym::cold) {
2840 codegen_fn_attrs.flags |= CodegenFnAttrFlags::COLD;
2841 } else if attr.has_name(sym::rustc_allocator) {
2842 codegen_fn_attrs.flags |= CodegenFnAttrFlags::ALLOCATOR;
2843 } else if attr.has_name(sym::ffi_returns_twice) {
2844 if tcx.is_foreign_item(id) {
2845 codegen_fn_attrs.flags |= CodegenFnAttrFlags::FFI_RETURNS_TWICE;
2847 // `#[ffi_returns_twice]` is only allowed `extern fn`s.
2852 "`#[ffi_returns_twice]` may only be used on foreign functions"
2856 } else if attr.has_name(sym::ffi_pure) {
2857 if tcx.is_foreign_item(id) {
2858 if attrs.iter().any(|a| a.has_name(sym::ffi_const)) {
2859 // `#[ffi_const]` functions cannot be `#[ffi_pure]`
2864 "`#[ffi_const]` function cannot be `#[ffi_pure]`"
2868 codegen_fn_attrs.flags |= CodegenFnAttrFlags::FFI_PURE;
2871 // `#[ffi_pure]` is only allowed on foreign functions
2876 "`#[ffi_pure]` may only be used on foreign functions"
2880 } else if attr.has_name(sym::ffi_const) {
2881 if tcx.is_foreign_item(id) {
2882 codegen_fn_attrs.flags |= CodegenFnAttrFlags::FFI_CONST;
2884 // `#[ffi_const]` is only allowed on foreign functions
2889 "`#[ffi_const]` may only be used on foreign functions"
2893 } else if attr.has_name(sym::rustc_allocator_nounwind) {
2894 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NEVER_UNWIND;
2895 } else if attr.has_name(sym::naked) {
2896 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NAKED;
2897 } else if attr.has_name(sym::no_mangle) {
2898 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
2899 } else if attr.has_name(sym::no_coverage) {
2900 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_COVERAGE;
2901 } else if attr.has_name(sym::rustc_std_internal_symbol) {
2902 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2903 } else if attr.has_name(sym::used) {
2904 let inner = attr.meta_item_list();
2905 match inner.as_deref() {
2906 Some([item]) if item.has_name(sym::linker) => {
2907 if !tcx.features().used_with_arg {
2909 &tcx.sess.parse_sess,
2912 "`#[used(linker)]` is currently unstable",
2916 codegen_fn_attrs.flags |= CodegenFnAttrFlags::USED_LINKER;
2918 Some([item]) if item.has_name(sym::compiler) => {
2919 if !tcx.features().used_with_arg {
2921 &tcx.sess.parse_sess,
2924 "`#[used(compiler)]` is currently unstable",
2928 codegen_fn_attrs.flags |= CodegenFnAttrFlags::USED;
2934 "expected `used`, `used(compiler)` or `used(linker)`",
2938 None => codegen_fn_attrs.flags |= CodegenFnAttrFlags::USED,
2940 } else if attr.has_name(sym::cmse_nonsecure_entry) {
2941 if !matches!(tcx.fn_sig(id).abi(), abi::Abi::C { .. }) {
2946 "`#[cmse_nonsecure_entry]` requires C ABI"
2950 if !tcx.sess.target.llvm_target.contains("thumbv8m") {
2951 struct_span_err!(tcx.sess, attr.span, E0775, "`#[cmse_nonsecure_entry]` is only valid for targets with the TrustZone-M extension")
2954 codegen_fn_attrs.flags |= CodegenFnAttrFlags::CMSE_NONSECURE_ENTRY;
2955 } else if attr.has_name(sym::thread_local) {
2956 codegen_fn_attrs.flags |= CodegenFnAttrFlags::THREAD_LOCAL;
2957 } else if attr.has_name(sym::track_caller) {
2958 if !tcx.is_closure(id) && tcx.fn_sig(id).abi() != abi::Abi::Rust {
2959 struct_span_err!(tcx.sess, attr.span, E0737, "`#[track_caller]` requires Rust ABI")
2962 if tcx.is_closure(id) && !tcx.features().closure_track_caller {
2964 &tcx.sess.parse_sess,
2965 sym::closure_track_caller,
2967 "`#[track_caller]` on closures is currently unstable",
2971 codegen_fn_attrs.flags |= CodegenFnAttrFlags::TRACK_CALLER;
2972 } else if attr.has_name(sym::export_name) {
2973 if let Some(s) = attr.value_str() {
2974 if s.as_str().contains('\0') {
2975 // `#[export_name = ...]` will be converted to a null-terminated string,
2976 // so it may not contain any null characters.
2981 "`export_name` may not contain null characters"
2985 codegen_fn_attrs.export_name = Some(s);
2987 } else if attr.has_name(sym::target_feature) {
2988 if !tcx.is_closure(id) && tcx.fn_sig(id).unsafety() == hir::Unsafety::Normal {
2989 if tcx.sess.target.is_like_wasm || tcx.sess.opts.actually_rustdoc {
2990 // The `#[target_feature]` attribute is allowed on
2991 // WebAssembly targets on all functions, including safe
2992 // ones. Other targets require that `#[target_feature]` is
2993 // only applied to unsafe functions (pending the
2994 // `target_feature_11` feature) because on most targets
2995 // execution of instructions that are not supported is
2996 // considered undefined behavior. For WebAssembly which is a
2997 // 100% safe target at execution time it's not possible to
2998 // execute undefined instructions, and even if a future
2999 // feature was added in some form for this it would be a
3000 // deterministic trap. There is no undefined behavior when
3001 // executing WebAssembly so `#[target_feature]` is allowed
3002 // on safe functions (but again, only for WebAssembly)
3004 // Note that this is also allowed if `actually_rustdoc` so
3005 // if a target is documenting some wasm-specific code then
3006 // it's not spuriously denied.
3007 } else if !tcx.features().target_feature_11 {
3008 let mut err = feature_err(
3009 &tcx.sess.parse_sess,
3010 sym::target_feature_11,
3012 "`#[target_feature(..)]` can only be applied to `unsafe` functions",
3014 err.span_label(tcx.def_span(id), "not an `unsafe` function");
3016 } else if let Some(local_id) = id.as_local() {
3017 check_target_feature_trait_unsafe(tcx, local_id, attr.span);
3020 from_target_feature(
3024 supported_target_features,
3025 &mut codegen_fn_attrs.target_features,
3027 } else if attr.has_name(sym::linkage) {
3028 if let Some(val) = attr.value_str() {
3029 codegen_fn_attrs.linkage = Some(linkage_by_name(tcx, id, val.as_str()));
3031 } else if attr.has_name(sym::link_section) {
3032 if let Some(val) = attr.value_str() {
3033 if val.as_str().bytes().any(|b| b == 0) {
3035 "illegal null byte in link_section \
3039 tcx.sess.span_err(attr.span, &msg);
3041 codegen_fn_attrs.link_section = Some(val);
3044 } else if attr.has_name(sym::link_name) {
3045 codegen_fn_attrs.link_name = attr.value_str();
3046 } else if attr.has_name(sym::link_ordinal) {
3047 link_ordinal_span = Some(attr.span);
3048 if let ordinal @ Some(_) = check_link_ordinal(tcx, attr) {
3049 codegen_fn_attrs.link_ordinal = ordinal;
3051 } else if attr.has_name(sym::no_sanitize) {
3052 no_sanitize_span = Some(attr.span);
3053 if let Some(list) = attr.meta_item_list() {
3054 for item in list.iter() {
3055 if item.has_name(sym::address) {
3056 codegen_fn_attrs.no_sanitize |= SanitizerSet::ADDRESS;
3057 } else if item.has_name(sym::cfi) {
3058 codegen_fn_attrs.no_sanitize |= SanitizerSet::CFI;
3059 } else if item.has_name(sym::memory) {
3060 codegen_fn_attrs.no_sanitize |= SanitizerSet::MEMORY;
3061 } else if item.has_name(sym::memtag) {
3062 codegen_fn_attrs.no_sanitize |= SanitizerSet::MEMTAG;
3063 } else if item.has_name(sym::thread) {
3064 codegen_fn_attrs.no_sanitize |= SanitizerSet::THREAD;
3065 } else if item.has_name(sym::hwaddress) {
3066 codegen_fn_attrs.no_sanitize |= SanitizerSet::HWADDRESS;
3069 .struct_span_err(item.span(), "invalid argument for `no_sanitize`")
3070 .note("expected one of: `address`, `cfi`, `hwaddress`, `memory`, `memtag`, or `thread`")
3075 } else if attr.has_name(sym::instruction_set) {
3076 codegen_fn_attrs.instruction_set = match attr.meta_kind() {
3077 Some(MetaItemKind::List(ref items)) => match items.as_slice() {
3078 [NestedMetaItem::MetaItem(set)] => {
3080 set.path.segments.iter().map(|x| x.ident.name).collect::<Vec<_>>();
3081 match segments.as_slice() {
3082 [sym::arm, sym::a32] | [sym::arm, sym::t32] => {
3083 if !tcx.sess.target.has_thumb_interworking {
3085 tcx.sess.diagnostic(),
3088 "target does not support `#[instruction_set]`"
3092 } else if segments[1] == sym::a32 {
3093 Some(InstructionSetAttr::ArmA32)
3094 } else if segments[1] == sym::t32 {
3095 Some(InstructionSetAttr::ArmT32)
3102 tcx.sess.diagnostic(),
3105 "invalid instruction set specified",
3114 tcx.sess.diagnostic(),
3117 "`#[instruction_set]` requires an argument"
3124 tcx.sess.diagnostic(),
3127 "cannot specify more than one instruction set"
3135 tcx.sess.diagnostic(),
3138 "must specify an instruction set"
3144 } else if attr.has_name(sym::repr) {
3145 codegen_fn_attrs.alignment = match attr.meta_item_list() {
3146 Some(items) => match items.as_slice() {
3147 [item] => match item.name_value_literal() {
3148 Some((sym::align, literal)) => {
3149 let alignment = rustc_attr::parse_alignment(&literal.kind);
3152 Ok(align) => Some(align),
3155 tcx.sess.diagnostic(),
3158 "invalid `repr(align)` attribute: {}",
3177 codegen_fn_attrs.inline = attrs.iter().fold(InlineAttr::None, |ia, attr| {
3178 if !attr.has_name(sym::inline) {
3181 match attr.meta_kind() {
3182 Some(MetaItemKind::Word) => InlineAttr::Hint,
3183 Some(MetaItemKind::List(ref items)) => {
3184 inline_span = Some(attr.span);
3185 if items.len() != 1 {
3187 tcx.sess.diagnostic(),
3190 "expected one argument"
3194 } else if list_contains_name(&items, sym::always) {
3196 } else if list_contains_name(&items, sym::never) {
3200 tcx.sess.diagnostic(),
3210 Some(MetaItemKind::NameValue(_)) => ia,
3215 codegen_fn_attrs.optimize = attrs.iter().fold(OptimizeAttr::None, |ia, attr| {
3216 if !attr.has_name(sym::optimize) {
3219 let err = |sp, s| struct_span_err!(tcx.sess.diagnostic(), sp, E0722, "{}", s).emit();
3220 match attr.meta_kind() {
3221 Some(MetaItemKind::Word) => {
3222 err(attr.span, "expected one argument");
3225 Some(MetaItemKind::List(ref items)) => {
3226 inline_span = Some(attr.span);
3227 if items.len() != 1 {
3228 err(attr.span, "expected one argument");
3230 } else if list_contains_name(&items, sym::size) {
3232 } else if list_contains_name(&items, sym::speed) {
3235 err(items[0].span(), "invalid argument");
3239 Some(MetaItemKind::NameValue(_)) => ia,
3244 // #73631: closures inherit `#[target_feature]` annotations
3245 if tcx.features().target_feature_11 && tcx.is_closure(id) {
3246 let owner_id = tcx.parent(id).expect("closure should have a parent");
3249 .extend(tcx.codegen_fn_attrs(owner_id).target_features.iter().copied())
3252 // If a function uses #[target_feature] it can't be inlined into general
3253 // purpose functions as they wouldn't have the right target features
3254 // enabled. For that reason we also forbid #[inline(always)] as it can't be
3256 if !codegen_fn_attrs.target_features.is_empty() {
3257 if codegen_fn_attrs.inline == InlineAttr::Always {
3258 if let Some(span) = inline_span {
3261 "cannot use `#[inline(always)]` with \
3262 `#[target_feature]`",
3268 if !codegen_fn_attrs.no_sanitize.is_empty() {
3269 if codegen_fn_attrs.inline == InlineAttr::Always {
3270 if let (Some(no_sanitize_span), Some(inline_span)) = (no_sanitize_span, inline_span) {
3271 let hir_id = tcx.hir().local_def_id_to_hir_id(id.expect_local());
3272 tcx.struct_span_lint_hir(
3273 lint::builtin::INLINE_NO_SANITIZE,
3277 lint.build("`no_sanitize` will have no effect after inlining")
3278 .span_note(inline_span, "inlining requested here")
3286 // Weak lang items have the same semantics as "std internal" symbols in the
3287 // sense that they're preserved through all our LTO passes and only
3288 // strippable by the linker.
3290 // Additionally weak lang items have predetermined symbol names.
3291 if tcx.is_weak_lang_item(id) {
3292 codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
3294 if let Some(name) = weak_lang_items::link_name(attrs) {
3295 codegen_fn_attrs.export_name = Some(name);
3296 codegen_fn_attrs.link_name = Some(name);
3298 check_link_name_xor_ordinal(tcx, &codegen_fn_attrs, link_ordinal_span);
3300 // Internal symbols to the standard library all have no_mangle semantics in
3301 // that they have defined symbol names present in the function name. This
3302 // also applies to weak symbols where they all have known symbol names.
3303 if codegen_fn_attrs.flags.contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL) {
3304 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
3307 // Any linkage to LLVM intrinsics for now forcibly marks them all as never
3308 // unwinds since LLVM sometimes can't handle codegen which `invoke`s
3309 // intrinsic functions.
3310 if let Some(name) = &codegen_fn_attrs.link_name {
3311 if name.as_str().starts_with("llvm.") {
3312 codegen_fn_attrs.flags |= CodegenFnAttrFlags::NEVER_UNWIND;
3319 /// Computes the set of target features used in a function for the purposes of
3320 /// inline assembly.
3321 fn asm_target_features<'tcx>(tcx: TyCtxt<'tcx>, id: DefId) -> &'tcx FxHashSet<Symbol> {
3322 let mut target_features = tcx.sess.target_features.clone();
3323 let attrs = tcx.codegen_fn_attrs(id);
3324 target_features.extend(&attrs.target_features);
3325 match attrs.instruction_set {
3327 Some(InstructionSetAttr::ArmA32) => {
3328 target_features.remove(&sym::thumb_mode);
3330 Some(InstructionSetAttr::ArmT32) => {
3331 target_features.insert(sym::thumb_mode);
3334 tcx.arena.alloc(target_features)
3337 /// Checks if the provided DefId is a method in a trait impl for a trait which has track_caller
3338 /// applied to the method prototype.
3339 fn should_inherit_track_caller(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
3340 if let Some(impl_item) = tcx.opt_associated_item(def_id)
3341 && let ty::AssocItemContainer::ImplContainer(_) = impl_item.container
3342 && let Some(trait_item) = impl_item.trait_item_def_id
3345 .codegen_fn_attrs(trait_item)
3347 .intersects(CodegenFnAttrFlags::TRACK_CALLER);
3353 fn check_link_ordinal(tcx: TyCtxt<'_>, attr: &ast::Attribute) -> Option<u16> {
3354 use rustc_ast::{Lit, LitIntType, LitKind};
3355 let meta_item_list = attr.meta_item_list();
3356 let meta_item_list: Option<&[ast::NestedMetaItem]> = meta_item_list.as_ref().map(Vec::as_ref);
3357 let sole_meta_list = match meta_item_list {
3358 Some([item]) => item.literal(),
3361 .struct_span_err(attr.span, "incorrect number of arguments to `#[link_ordinal]`")
3362 .note("the attribute requires exactly one argument")
3368 if let Some(Lit { kind: LitKind::Int(ordinal, LitIntType::Unsuffixed), .. }) = sole_meta_list {
3369 // According to the table at https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#import-header,
3370 // the ordinal must fit into 16 bits. Similarly, the Ordinal field in COFFShortExport (defined
3371 // in llvm/include/llvm/Object/COFFImportFile.h), which we use to communicate import information
3372 // to LLVM for `#[link(kind = "raw-dylib"_])`, is also defined to be uint16_t.
3374 // FIXME: should we allow an ordinal of 0? The MSVC toolchain has inconsistent support for this:
3375 // both LINK.EXE and LIB.EXE signal errors and abort when given a .DEF file that specifies
3376 // a zero ordinal. However, llvm-dlltool is perfectly happy to generate an import library
3377 // for such a .DEF file, and MSVC's LINK.EXE is also perfectly happy to consume an import
3378 // library produced by LLVM with an ordinal of 0, and it generates an .EXE. (I don't know yet
3379 // if the resulting EXE runs, as I haven't yet built the necessary DLL -- see earlier comment
3380 // about LINK.EXE failing.)
3381 if *ordinal <= u16::MAX as u128 {
3382 Some(*ordinal as u16)
3384 let msg = format!("ordinal value in `link_ordinal` is too large: `{}`", &ordinal);
3386 .struct_span_err(attr.span, &msg)
3387 .note("the value may not exceed `u16::MAX`")
3393 .struct_span_err(attr.span, "illegal ordinal format in `link_ordinal`")
3394 .note("an unsuffixed integer value, e.g., `1`, is expected")
3400 fn check_link_name_xor_ordinal(
3402 codegen_fn_attrs: &CodegenFnAttrs,
3403 inline_span: Option<Span>,
3405 if codegen_fn_attrs.link_name.is_none() || codegen_fn_attrs.link_ordinal.is_none() {
3408 let msg = "cannot use `#[link_name]` with `#[link_ordinal]`";
3409 if let Some(span) = inline_span {
3410 tcx.sess.span_err(span, msg);
3416 /// Checks the function annotated with `#[target_feature]` is not a safe
3417 /// trait method implementation, reporting an error if it is.
3418 fn check_target_feature_trait_unsafe(tcx: TyCtxt<'_>, id: LocalDefId, attr_span: Span) {
3419 let hir_id = tcx.hir().local_def_id_to_hir_id(id);
3420 let node = tcx.hir().get(hir_id);
3421 if let Node::ImplItem(hir::ImplItem { kind: hir::ImplItemKind::Fn(..), .. }) = node {
3422 let parent_id = tcx.hir().get_parent_item(hir_id);
3423 let parent_item = tcx.hir().expect_item(parent_id);
3424 if let hir::ItemKind::Impl(hir::Impl { of_trait: Some(_), .. }) = parent_item.kind {
3428 "`#[target_feature(..)]` cannot be applied to safe trait method",
3430 .span_label(attr_span, "cannot be applied to safe trait method")
3431 .span_label(tcx.def_span(id), "not an `unsafe` function")