compiler/rustc_typeck/src/collect.rs

   1 //! "Collection" is the process of determining the type and other external
   2 //! details of each item in Rust. Collection is specifically concerned
   3 //! with *inter-procedural* things -- for example, for a function
   4 //! definition, collection will figure out the type and signature of the
   5 //! function, but it will not visit the *body* of the function in any way,
   6 //! nor examine type annotations on local variables (that's the job of
   7 //! type *checking*).
   8 //!
   9 //! Collecting is ultimately defined by a bundle of queries that
  10 //! inquire after various facts about the items in the crate (e.g.,
  11 //! `type_of`, `generics_of`, `predicates_of`, etc). See the `provide` function
  12 //! for the full set.
  13 //!
  14 //! At present, however, we do run collection across all items in the
  15 //! crate as a kind of pass. This should eventually be factored away.
  16
  17 use crate::astconv::AstConv;
  18 use crate::bounds::Bounds;
  19 use crate::check::intrinsic::intrinsic_operation_unsafety;
  20 use crate::constrained_generic_params as cgp;
  21 use crate::errors;
  22 use crate::middle::resolve_lifetime as rl;
  23 use rustc_ast as ast;
  24 use rustc_ast::{MetaItemKind, NestedMetaItem};
  25 use rustc_attr::{list_contains_name, InlineAttr, InstructionSetAttr, OptimizeAttr};
  26 use rustc_data_structures::captures::Captures;
  27 use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexSet};
  28 use rustc_errors::{struct_span_err, Applicability, DiagnosticBuilder, ErrorGuaranteed};
  29 use rustc_hir as hir;
  30 use rustc_hir::def::{CtorKind, DefKind};
  31 use rustc_hir::def_id::{DefId, LocalDefId, CRATE_DEF_ID, LOCAL_CRATE};
  32 use rustc_hir::intravisit::{self, Visitor};
  33 use rustc_hir::weak_lang_items;
  34 use rustc_hir::{GenericParamKind, HirId, Node};
  35 use rustc_middle::hir::nested_filter;
  36 use rustc_middle::middle::codegen_fn_attrs::{CodegenFnAttrFlags, CodegenFnAttrs};
  37 use rustc_middle::mir::mono::Linkage;
  38 use rustc_middle::ty::query::Providers;
  39 use rustc_middle::ty::subst::InternalSubsts;
  40 use rustc_middle::ty::util::Discr;
  41 use rustc_middle::ty::util::IntTypeExt;
  42 use rustc_middle::ty::{self, AdtKind, Const, DefIdTree, IsSuggestable, Ty, TyCtxt};
  43 use rustc_middle::ty::{ReprOptions, ToPredicate};
  44 use rustc_session::lint;
  45 use rustc_session::parse::feature_err;
  46 use rustc_span::symbol::{kw, sym, Ident, Symbol};
  47 use rustc_span::{Span, DUMMY_SP};
  48 use rustc_target::spec::{abi, SanitizerSet};
  49 use rustc_trait_selection::traits::error_reporting::suggestions::NextTypeParamName;
  50 use std::iter;
  51
  52 mod item_bounds;
  53 mod type_of;
  54
  55 #[derive(Debug)]
  56 struct OnlySelfBounds(bool);
  57
  58 ///////////////////////////////////////////////////////////////////////////
  59 // Main entry point
  60
  61 fn collect_mod_item_types(tcx: TyCtxt<'_>, module_def_id: LocalDefId) {
  62     tcx.hir().visit_item_likes_in_module(module_def_id, &mut CollectItemTypesVisitor { tcx });
  63 }
  64
  65 pub fn provide(providers: &mut Providers) {
  66     *providers = Providers {
  67         opt_const_param_of: type_of::opt_const_param_of,
  68         type_of: type_of::type_of,
  69         item_bounds: item_bounds::item_bounds,
  70         explicit_item_bounds: item_bounds::explicit_item_bounds,
  71         generics_of,
  72         predicates_of,
  73         predicates_defined_on,
  74         explicit_predicates_of,
  75         super_predicates_of,
  76         super_predicates_that_define_assoc_type,
  77         trait_explicit_predicates_and_bounds,
  78         type_param_predicates,
  79         trait_def,
  80         adt_def,
  81         fn_sig,
  82         impl_trait_ref,
  83         impl_polarity,
  84         is_foreign_item,
  85         generator_kind,
  86         codegen_fn_attrs,
  87         asm_target_features,
  88         collect_mod_item_types,
  89         should_inherit_track_caller,
  90         ..*providers
  91     };
  92 }
  93
  94 ///////////////////////////////////////////////////////////////////////////
  95
  96 /// Context specific to some particular item. This is what implements
  97 /// [`AstConv`].
  98 ///
  99 /// # `ItemCtxt` vs `FnCtxt`
 100 ///
 101 /// `ItemCtxt` is primarily used to type-check item signatures and lower them
 102 /// from HIR to their [`ty::Ty`] representation, which is exposed using [`AstConv`].
 103 /// It's also used for the bodies of items like structs where the body (the fields)
 104 /// are just signatures.
 105 ///
 106 /// This is in contrast to [`FnCtxt`], which is used to type-check bodies of
 107 /// functions, closures, and `const`s -- anywhere that expressions and statements show up.
 108 ///
 109 /// An important thing to note is that `ItemCtxt` does no inference -- it has no [`InferCtxt`] --
 110 /// while `FnCtxt` does do inference.
 111 ///
 112 /// [`FnCtxt`]: crate::check::FnCtxt
 113 /// [`InferCtxt`]: rustc_infer::infer::InferCtxt
 114 ///
 115 /// # Trait predicates
 116 ///
 117 /// `ItemCtxt` has information about the predicates that are defined
 118 /// on the trait. Unfortunately, this predicate information is
 119 /// available in various different forms at various points in the
 120 /// process. So we can't just store a pointer to e.g., the AST or the
 121 /// parsed ty form, we have to be more flexible. To this end, the
 122 /// `ItemCtxt` is parameterized by a `DefId` that it uses to satisfy
 123 /// `get_type_parameter_bounds` requests, drawing the information from
 124 /// the AST (`hir::Generics`), recursively.
 125 pub struct ItemCtxt<'tcx> {
 126     tcx: TyCtxt<'tcx>,
 127     item_def_id: DefId,
 128 }
 129
 130 ///////////////////////////////////////////////////////////////////////////
 131
 132 #[derive(Default)]
 133 pub(crate) struct HirPlaceholderCollector(pub(crate) Vec<Span>);
 134
 135 impl<'v> Visitor<'v> for HirPlaceholderCollector {
 136     fn visit_ty(&mut self, t: &'v hir::Ty<'v>) {
 137         if let hir::TyKind::Infer = t.kind {
 138             self.0.push(t.span);
 139         }
 140         intravisit::walk_ty(self, t)
 141     }
 142     fn visit_generic_arg(&mut self, generic_arg: &'v hir::GenericArg<'v>) {
 143         match generic_arg {
 144             hir::GenericArg::Infer(inf) => {
 145                 self.0.push(inf.span);
 146                 intravisit::walk_inf(self, inf);
 147             }
 148             hir::GenericArg::Type(t) => self.visit_ty(t),
 149             _ => {}
 150         }
 151     }
 152     fn visit_array_length(&mut self, length: &'v hir::ArrayLen) {
 153         if let &hir::ArrayLen::Infer(_, span) = length {
 154             self.0.push(span);
 155         }
 156         intravisit::walk_array_len(self, length)
 157     }
 158 }
 159
 160 struct CollectItemTypesVisitor<'tcx> {
 161     tcx: TyCtxt<'tcx>,
 162 }
 163
 164 /// If there are any placeholder types (`_`), emit an error explaining that this is not allowed
 165 /// and suggest adding type parameters in the appropriate place, taking into consideration any and
 166 /// all already existing generic type parameters to avoid suggesting a name that is already in use.
 167 pub(crate) fn placeholder_type_error<'tcx>(
 168     tcx: TyCtxt<'tcx>,
 169     generics: Option<&hir::Generics<'_>>,
 170     placeholder_types: Vec<Span>,
 171     suggest: bool,
 172     hir_ty: Option<&hir::Ty<'_>>,
 173     kind: &'static str,
 174 ) {
 175     if placeholder_types.is_empty() {
 176         return;
 177     }
 178
 179     placeholder_type_error_diag(tcx, generics, placeholder_types, vec![], suggest, hir_ty, kind)
 180         .emit();
 181 }
 182
 183 pub(crate) fn placeholder_type_error_diag<'tcx>(
 184     tcx: TyCtxt<'tcx>,
 185     generics: Option<&hir::Generics<'_>>,
 186     placeholder_types: Vec<Span>,
 187     additional_spans: Vec<Span>,
 188     suggest: bool,
 189     hir_ty: Option<&hir::Ty<'_>>,
 190     kind: &'static str,
 191 ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
 192     if placeholder_types.is_empty() {
 193         return bad_placeholder(tcx, additional_spans, kind);
 194     }
 195
 196     let params = generics.map(|g| g.params).unwrap_or_default();
 197     let type_name = params.next_type_param_name(None);
 198     let mut sugg: Vec<_> =
 199         placeholder_types.iter().map(|sp| (*sp, (*type_name).to_string())).collect();
 200
 201     if let Some(generics) = generics {
 202         if let Some(arg) = params.iter().find(|arg| {
 203             matches!(arg.name, hir::ParamName::Plain(Ident { name: kw::Underscore, .. }))
 204         }) {
 205             // Account for `_` already present in cases like `struct S<_>(_);` and suggest
 206             // `struct S<T>(T);` instead of `struct S<_, T>(T);`.
 207             sugg.push((arg.span, (*type_name).to_string()));
 208         } else if let Some(span) = generics.span_for_param_suggestion() {
 209             // Account for bounds, we want `fn foo<T: E, K>(_: K)` not `fn foo<T, K: E>(_: K)`.
 210             sugg.push((span, format!(", {}", type_name)));
 211         } else {
 212             sugg.push((generics.span, format!("<{}>", type_name)));
 213         }
 214     }
 215
 216     let mut err =
 217         bad_placeholder(tcx, placeholder_types.into_iter().chain(additional_spans).collect(), kind);
 218
 219     // Suggest, but only if it is not a function in const or static
 220     if suggest {
 221         let mut is_fn = false;
 222         let mut is_const_or_static = false;
 223
 224         if let Some(hir_ty) = hir_ty && let hir::TyKind::BareFn(_) = hir_ty.kind {
 225             is_fn = true;
 226
 227             // Check if parent is const or static
 228             let parent_id = tcx.hir().get_parent_node(hir_ty.hir_id);
 229             let parent_node = tcx.hir().get(parent_id);
 230
 231             is_const_or_static = matches!(
 232                 parent_node,
 233                 Node::Item(&hir::Item {
 234                     kind: hir::ItemKind::Const(..) | hir::ItemKind::Static(..),
 235                     ..
 236                 }) | Node::TraitItem(&hir::TraitItem {
 237                     kind: hir::TraitItemKind::Const(..),
 238                     ..
 239                 }) | Node::ImplItem(&hir::ImplItem { kind: hir::ImplItemKind::Const(..), .. })
 240             );
 241         }
 242
 243         // if function is wrapped around a const or static,
 244         // then don't show the suggestion
 245         if !(is_fn && is_const_or_static) {
 246             err.multipart_suggestion(
 247                 "use type parameters instead",
 248                 sugg,
 249                 Applicability::HasPlaceholders,
 250             );
 251         }
 252     }
 253
 254     err
 255 }
 256
 257 fn reject_placeholder_type_signatures_in_item<'tcx>(
 258     tcx: TyCtxt<'tcx>,
 259     item: &'tcx hir::Item<'tcx>,
 260 ) {
 261     let (generics, suggest) = match &item.kind {
 262         hir::ItemKind::Union(_, generics)
 263         | hir::ItemKind::Enum(_, generics)
 264         | hir::ItemKind::TraitAlias(generics, _)
 265         | hir::ItemKind::Trait(_, _, generics, ..)
 266         | hir::ItemKind::Impl(hir::Impl { generics, .. })
 267         | hir::ItemKind::Struct(_, generics) => (generics, true),
 268         hir::ItemKind::OpaqueTy(hir::OpaqueTy { generics, .. })
 269         | hir::ItemKind::TyAlias(_, generics) => (generics, false),
 270         // `static`, `fn` and `const` are handled elsewhere to suggest appropriate type.
 271         _ => return,
 272     };
 273
 274     let mut visitor = HirPlaceholderCollector::default();
 275     visitor.visit_item(item);
 276
 277     placeholder_type_error(tcx, Some(generics), visitor.0, suggest, None, item.kind.descr());
 278 }
 279
 280 impl<'tcx> Visitor<'tcx> for CollectItemTypesVisitor<'tcx> {
 281     type NestedFilter = nested_filter::OnlyBodies;
 282
 283     fn nested_visit_map(&mut self) -> Self::Map {
 284         self.tcx.hir()
 285     }
 286
 287     fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
 288         convert_item(self.tcx, item.item_id());
 289         reject_placeholder_type_signatures_in_item(self.tcx, item);
 290         intravisit::walk_item(self, item);
 291     }
 292
 293     fn visit_generics(&mut self, generics: &'tcx hir::Generics<'tcx>) {
 294         for param in generics.params {
 295             match param.kind {
 296                 hir::GenericParamKind::Lifetime { .. } => {}
 297                 hir::GenericParamKind::Type { default: Some(_), .. } => {
 298                     let def_id = self.tcx.hir().local_def_id(param.hir_id);
 299                     self.tcx.ensure().type_of(def_id);
 300                 }
 301                 hir::GenericParamKind::Type { .. } => {}
 302                 hir::GenericParamKind::Const { default, .. } => {
 303                     let def_id = self.tcx.hir().local_def_id(param.hir_id);
 304                     self.tcx.ensure().type_of(def_id);
 305                     if let Some(default) = default {
 306                         let default_def_id = self.tcx.hir().local_def_id(default.hir_id);
 307                         // need to store default and type of default
 308                         self.tcx.ensure().type_of(default_def_id);
 309                         self.tcx.ensure().const_param_default(def_id);
 310                     }
 311                 }
 312             }
 313         }
 314         intravisit::walk_generics(self, generics);
 315     }
 316
 317     fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
 318         if let hir::ExprKind::Closure { .. } = expr.kind {
 319             let def_id = self.tcx.hir().local_def_id(expr.hir_id);
 320             self.tcx.ensure().generics_of(def_id);
 321             // We do not call `type_of` for closures here as that
 322             // depends on typecheck and would therefore hide
 323             // any further errors in case one typeck fails.
 324         }
 325         intravisit::walk_expr(self, expr);
 326     }
 327
 328     fn visit_trait_item(&mut self, trait_item: &'tcx hir::TraitItem<'tcx>) {
 329         convert_trait_item(self.tcx, trait_item.trait_item_id());
 330         intravisit::walk_trait_item(self, trait_item);
 331     }
 332
 333     fn visit_impl_item(&mut self, impl_item: &'tcx hir::ImplItem<'tcx>) {
 334         convert_impl_item(self.tcx, impl_item.impl_item_id());
 335         intravisit::walk_impl_item(self, impl_item);
 336     }
 337 }
 338
 339 ///////////////////////////////////////////////////////////////////////////
 340 // Utility types and common code for the above passes.
 341
 342 fn bad_placeholder<'tcx>(
 343     tcx: TyCtxt<'tcx>,
 344     mut spans: Vec<Span>,
 345     kind: &'static str,
 346 ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
 347     let kind = if kind.ends_with('s') { format!("{}es", kind) } else { format!("{}s", kind) };
 348
 349     spans.sort();
 350     let mut err = struct_span_err!(
 351         tcx.sess,
 352         spans.clone(),
 353         E0121,
 354         "the placeholder `_` is not allowed within types on item signatures for {}",
 355         kind
 356     );
 357     for span in spans {
 358         err.span_label(span, "not allowed in type signatures");
 359     }
 360     err
 361 }
 362
 363 impl<'tcx> ItemCtxt<'tcx> {
 364     pub fn new(tcx: TyCtxt<'tcx>, item_def_id: DefId) -> ItemCtxt<'tcx> {
 365         ItemCtxt { tcx, item_def_id }
 366     }
 367
 368     pub fn to_ty(&self, ast_ty: &hir::Ty<'_>) -> Ty<'tcx> {
 369         <dyn AstConv<'_>>::ast_ty_to_ty(self, ast_ty)
 370     }
 371
 372     pub fn hir_id(&self) -> hir::HirId {
 373         self.tcx.hir().local_def_id_to_hir_id(self.item_def_id.expect_local())
 374     }
 375
 376     pub fn node(&self) -> hir::Node<'tcx> {
 377         self.tcx.hir().get(self.hir_id())
 378     }
 379 }
 380
 381 impl<'tcx> AstConv<'tcx> for ItemCtxt<'tcx> {
 382     fn tcx(&self) -> TyCtxt<'tcx> {
 383         self.tcx
 384     }
 385
 386     fn item_def_id(&self) -> Option<DefId> {
 387         Some(self.item_def_id)
 388     }
 389
 390     fn get_type_parameter_bounds(
 391         &self,
 392         span: Span,
 393         def_id: DefId,
 394         assoc_name: Ident,
 395     ) -> ty::GenericPredicates<'tcx> {
 396         self.tcx.at(span).type_param_predicates((
 397             self.item_def_id,
 398             def_id.expect_local(),
 399             assoc_name,
 400         ))
 401     }
 402
 403     fn re_infer(&self, _: Option<&ty::GenericParamDef>, _: Span) -> Option<ty::Region<'tcx>> {
 404         None
 405     }
 406
 407     fn allow_ty_infer(&self) -> bool {
 408         false
 409     }
 410
 411     fn ty_infer(&self, _: Option<&ty::GenericParamDef>, span: Span) -> Ty<'tcx> {
 412         self.tcx().ty_error_with_message(span, "bad placeholder type")
 413     }
 414
 415     fn ct_infer(&self, ty: Ty<'tcx>, _: Option<&ty::GenericParamDef>, span: Span) -> Const<'tcx> {
 416         let ty = self.tcx.fold_regions(ty, |r, _| match *r {
 417             ty::ReErased => self.tcx.lifetimes.re_static,
 418             _ => r,
 419         });
 420         self.tcx().const_error_with_message(ty, span, "bad placeholder constant")
 421     }
 422
 423     fn projected_ty_from_poly_trait_ref(
 424         &self,
 425         span: Span,
 426         item_def_id: DefId,
 427         item_segment: &hir::PathSegment<'_>,
 428         poly_trait_ref: ty::PolyTraitRef<'tcx>,
 429     ) -> Ty<'tcx> {
 430         if let Some(trait_ref) = poly_trait_ref.no_bound_vars() {
 431             let item_substs = <dyn AstConv<'tcx>>::create_substs_for_associated_item(
 432                 self,
 433                 self.tcx,
 434                 span,
 435                 item_def_id,
 436                 item_segment,
 437                 trait_ref.substs,
 438             );
 439             self.tcx().mk_projection(item_def_id, item_substs)
 440         } else {
 441             // There are no late-bound regions; we can just ignore the binder.
 442             let mut err = struct_span_err!(
 443                 self.tcx().sess,
 444                 span,
 445                 E0212,
 446                 "cannot use the associated type of a trait \
 447                  with uninferred generic parameters"
 448             );
 449
 450             match self.node() {
 451                 hir::Node::Field(_) | hir::Node::Ctor(_) | hir::Node::Variant(_) => {
 452                     let item =
 453                         self.tcx.hir().expect_item(self.tcx.hir().get_parent_item(self.hir_id()));
 454                     match &item.kind {
 455                         hir::ItemKind::Enum(_, generics)
 456                         | hir::ItemKind::Struct(_, generics)
 457                         | hir::ItemKind::Union(_, generics) => {
 458                             let lt_name = get_new_lifetime_name(self.tcx, poly_trait_ref, generics);
 459                             let (lt_sp, sugg) = match generics.params {
 460                                 [] => (generics.span, format!("<{}>", lt_name)),
 461                                 [bound, ..] => {
 462                                     (bound.span.shrink_to_lo(), format!("{}, ", lt_name))
 463                                 }
 464                             };
 465                             let suggestions = vec![
 466                                 (lt_sp, sugg),
 467                                 (
 468                                     span.with_hi(item_segment.ident.span.lo()),
 469                                     format!(
 470                                         "{}::",
 471                                         // Replace the existing lifetimes with a new named lifetime.
 472                                         self.tcx.replace_late_bound_regions_uncached(
 473                                             poly_trait_ref,
 474                                             |_| {
 475                                                 self.tcx.mk_region(ty::ReEarlyBound(
 476                                                     ty::EarlyBoundRegion {
 477                                                         def_id: item_def_id,
 478                                                         index: 0,
 479                                                         name: Symbol::intern(&lt_name),
 480                                                     },
 481                                                 ))
 482                                             }
 483                                         ),
 484                                     ),
 485                                 ),
 486                             ];
 487                             err.multipart_suggestion(
 488                                 "use a fully qualified path with explicit lifetimes",
 489                                 suggestions,
 490                                 Applicability::MaybeIncorrect,
 491                             );
 492                         }
 493                         _ => {}
 494                     }
 495                 }
 496                 hir::Node::Item(hir::Item {
 497                     kind:
 498                         hir::ItemKind::Struct(..) | hir::ItemKind::Enum(..) | hir::ItemKind::Union(..),
 499                     ..
 500                 }) => {}
 501                 hir::Node::Item(_)
 502                 | hir::Node::ForeignItem(_)
 503                 | hir::Node::TraitItem(_)
 504                 | hir::Node::ImplItem(_) => {
 505                     err.span_suggestion_verbose(
 506                         span.with_hi(item_segment.ident.span.lo()),
 507                         "use a fully qualified path with inferred lifetimes",
 508                         format!(
 509                             "{}::",
 510                             // Erase named lt, we want `<A as B<'_>::C`, not `<A as B<'a>::C`.
 511                             self.tcx.anonymize_late_bound_regions(poly_trait_ref).skip_binder(),
 512                         ),
 513                         Applicability::MaybeIncorrect,
 514                     );
 515                 }
 516                 _ => {}
 517             }
 518             err.emit();
 519             self.tcx().ty_error()
 520         }
 521     }
 522
 523     fn normalize_ty(&self, _span: Span, ty: Ty<'tcx>) -> Ty<'tcx> {
 524         // Types in item signatures are not normalized to avoid undue dependencies.
 525         ty
 526     }
 527
 528     fn set_tainted_by_errors(&self) {
 529         // There's no obvious place to track this, so just let it go.
 530     }
 531
 532     fn record_ty(&self, _hir_id: hir::HirId, _ty: Ty<'tcx>, _span: Span) {
 533         // There's no place to record types from signatures?
 534     }
 535 }
 536
 537 /// Synthesize a new lifetime name that doesn't clash with any of the lifetimes already present.
 538 fn get_new_lifetime_name<'tcx>(
 539     tcx: TyCtxt<'tcx>,
 540     poly_trait_ref: ty::PolyTraitRef<'tcx>,
 541     generics: &hir::Generics<'tcx>,
 542 ) -> String {
 543     let existing_lifetimes = tcx
 544         .collect_referenced_late_bound_regions(&poly_trait_ref)
 545         .into_iter()
 546         .filter_map(|lt| {
 547             if let ty::BoundRegionKind::BrNamed(_, name) = lt {
 548                 Some(name.as_str().to_string())
 549             } else {
 550                 None
 551             }
 552         })
 553         .chain(generics.params.iter().filter_map(|param| {
 554             if let hir::GenericParamKind::Lifetime { .. } = &param.kind {
 555                 Some(param.name.ident().as_str().to_string())
 556             } else {
 557                 None
 558             }
 559         }))
 560         .collect::<FxHashSet<String>>();
 561
 562     let a_to_z_repeat_n = |n| {
 563         (b'a'..=b'z').map(move |c| {
 564             let mut s = '\''.to_string();
 565             s.extend(std::iter::repeat(char::from(c)).take(n));
 566             s
 567         })
 568     };
 569
 570     // If all single char lifetime names are present, we wrap around and double the chars.
 571     (1..).flat_map(a_to_z_repeat_n).find(|lt| !existing_lifetimes.contains(lt.as_str())).unwrap()
 572 }
 573
 574 /// Returns the predicates defined on `item_def_id` of the form
 575 /// `X: Foo` where `X` is the type parameter `def_id`.
 576 #[instrument(level = "trace", skip(tcx))]
 577 fn type_param_predicates(
 578     tcx: TyCtxt<'_>,
 579     (item_def_id, def_id, assoc_name): (DefId, LocalDefId, Ident),
 580 ) -> ty::GenericPredicates<'_> {
 581     use rustc_hir::*;
 582
 583     // In the AST, bounds can derive from two places. Either
 584     // written inline like `<T: Foo>` or in a where-clause like
 585     // `where T: Foo`.
 586
 587     let param_id = tcx.hir().local_def_id_to_hir_id(def_id);
 588     let param_owner = tcx.hir().ty_param_owner(def_id);
 589     let generics = tcx.generics_of(param_owner);
 590     let index = generics.param_def_id_to_index[&def_id.to_def_id()];
 591     let ty = tcx.mk_ty_param(index, tcx.hir().ty_param_name(def_id));
 592
 593     // Don't look for bounds where the type parameter isn't in scope.
 594     let parent = if item_def_id == param_owner.to_def_id() {
 595         None
 596     } else {
 597         tcx.generics_of(item_def_id).parent
 598     };
 599
 600     let mut result = parent
 601         .map(|parent| {
 602             let icx = ItemCtxt::new(tcx, parent);
 603             icx.get_type_parameter_bounds(DUMMY_SP, def_id.to_def_id(), assoc_name)
 604         })
 605         .unwrap_or_default();
 606     let mut extend = None;
 607
 608     let item_hir_id = tcx.hir().local_def_id_to_hir_id(item_def_id.expect_local());
 609     let ast_generics = match tcx.hir().get(item_hir_id) {
 610         Node::TraitItem(item) => &item.generics,
 611
 612         Node::ImplItem(item) => &item.generics,
 613
 614         Node::Item(item) => {
 615             match item.kind {
 616                 ItemKind::Fn(.., ref generics, _)
 617                 | ItemKind::Impl(hir::Impl { ref generics, .. })
 618                 | ItemKind::TyAlias(_, ref generics)
 619                 | ItemKind::OpaqueTy(OpaqueTy {
 620                     ref generics,
 621                     origin: hir::OpaqueTyOrigin::TyAlias,
 622                     ..
 623                 })
 624                 | ItemKind::Enum(_, ref generics)
 625                 | ItemKind::Struct(_, ref generics)
 626                 | ItemKind::Union(_, ref generics) => generics,
 627                 ItemKind::Trait(_, _, ref generics, ..) => {
 628                     // Implied `Self: Trait` and supertrait bounds.
 629                     if param_id == item_hir_id {
 630                         let identity_trait_ref = ty::TraitRef::identity(tcx, item_def_id);
 631                         extend =
 632                             Some((identity_trait_ref.without_const().to_predicate(tcx), item.span));
 633                     }
 634                     generics
 635                 }
 636                 _ => return result,
 637             }
 638         }
 639
 640         Node::ForeignItem(item) => match item.kind {
 641             ForeignItemKind::Fn(_, _, ref generics) => generics,
 642             _ => return result,
 643         },
 644
 645         _ => return result,
 646     };
 647
 648     let icx = ItemCtxt::new(tcx, item_def_id);
 649     let extra_predicates = extend.into_iter().chain(
 650         icx.type_parameter_bounds_in_generics(
 651             ast_generics,
 652             param_id,
 653             ty,
 654             OnlySelfBounds(true),
 655             Some(assoc_name),
 656         )
 657         .into_iter()
 658         .filter(|(predicate, _)| match predicate.kind().skip_binder() {
 659             ty::PredicateKind::Trait(data) => data.self_ty().is_param(index),
 660             _ => false,
 661         }),
 662     );
 663     result.predicates =
 664         tcx.arena.alloc_from_iter(result.predicates.iter().copied().chain(extra_predicates));
 665     result
 666 }
 667
 668 impl<'tcx> ItemCtxt<'tcx> {
 669     /// Finds bounds from `hir::Generics`. This requires scanning through the
 670     /// AST. We do this to avoid having to convert *all* the bounds, which
 671     /// would create artificial cycles. Instead, we can only convert the
 672     /// bounds for a type parameter `X` if `X::Foo` is used.
 673     #[instrument(level = "trace", skip(self, ast_generics))]
 674     fn type_parameter_bounds_in_generics(
 675         &self,
 676         ast_generics: &'tcx hir::Generics<'tcx>,
 677         param_id: hir::HirId,
 678         ty: Ty<'tcx>,
 679         only_self_bounds: OnlySelfBounds,
 680         assoc_name: Option<Ident>,
 681     ) -> Vec<(ty::Predicate<'tcx>, Span)> {
 682         let param_def_id = self.tcx.hir().local_def_id(param_id).to_def_id();
 683         trace!(?param_def_id);
 684         ast_generics
 685             .predicates
 686             .iter()
 687             .filter_map(|wp| match *wp {
 688                 hir::WherePredicate::BoundPredicate(ref bp) => Some(bp),
 689                 _ => None,
 690             })
 691             .flat_map(|bp| {
 692                 let bt = if bp.is_param_bound(param_def_id) {
 693                     Some(ty)
 694                 } else if !only_self_bounds.0 {
 695                     Some(self.to_ty(bp.bounded_ty))
 696                 } else {
 697                     None
 698                 };
 699                 let bvars = self.tcx.late_bound_vars(bp.bounded_ty.hir_id);
 700
 701                 bp.bounds.iter().filter_map(move |b| bt.map(|bt| (bt, b, bvars))).filter(
 702                     |(_, b, _)| match assoc_name {
 703                         Some(assoc_name) => self.bound_defines_assoc_item(b, assoc_name),
 704                         None => true,
 705                     },
 706                 )
 707             })
 708             .flat_map(|(bt, b, bvars)| predicates_from_bound(self, bt, b, bvars))
 709             .collect()
 710     }
 711
 712     #[instrument(level = "trace", skip(self))]
 713     fn bound_defines_assoc_item(&self, b: &hir::GenericBound<'_>, assoc_name: Ident) -> bool {
 714         match b {
 715             hir::GenericBound::Trait(poly_trait_ref, _) => {
 716                 let trait_ref = &poly_trait_ref.trait_ref;
 717                 if let Some(trait_did) = trait_ref.trait_def_id() {
 718                     self.tcx.trait_may_define_assoc_type(trait_did, assoc_name)
 719                 } else {
 720                     false
 721                 }
 722             }
 723             _ => false,
 724         }
 725     }
 726 }
 727
 728 fn convert_item(tcx: TyCtxt<'_>, item_id: hir::ItemId) {
 729     let it = tcx.hir().item(item_id);
 730     debug!("convert: item {} with id {}", it.ident, it.hir_id());
 731     let def_id = item_id.def_id;
 732
 733     match it.kind {
 734         // These don't define types.
 735         hir::ItemKind::ExternCrate(_)
 736         | hir::ItemKind::Use(..)
 737         | hir::ItemKind::Macro(..)
 738         | hir::ItemKind::Mod(_)
 739         | hir::ItemKind::GlobalAsm(_) => {}
 740         hir::ItemKind::ForeignMod { items, .. } => {
 741             for item in items {
 742                 let item = tcx.hir().foreign_item(item.id);
 743                 tcx.ensure().generics_of(item.def_id);
 744                 tcx.ensure().type_of(item.def_id);
 745                 tcx.ensure().predicates_of(item.def_id);
 746                 match item.kind {
 747                     hir::ForeignItemKind::Fn(..) => tcx.ensure().fn_sig(item.def_id),
 748                     hir::ForeignItemKind::Static(..) => {
 749                         let mut visitor = HirPlaceholderCollector::default();
 750                         visitor.visit_foreign_item(item);
 751                         placeholder_type_error(
 752                             tcx,
 753                             None,
 754                             visitor.0,
 755                             false,
 756                             None,
 757                             "static variable",
 758                         );
 759                     }
 760                     _ => (),
 761                 }
 762             }
 763         }
 764         hir::ItemKind::Enum(ref enum_definition, _) => {
 765             tcx.ensure().generics_of(def_id);
 766             tcx.ensure().type_of(def_id);
 767             tcx.ensure().predicates_of(def_id);
 768             convert_enum_variant_types(tcx, def_id.to_def_id(), enum_definition.variants);
 769         }
 770         hir::ItemKind::Impl { .. } => {
 771             tcx.ensure().generics_of(def_id);
 772             tcx.ensure().type_of(def_id);
 773             tcx.ensure().impl_trait_ref(def_id);
 774             tcx.ensure().predicates_of(def_id);
 775         }
 776         hir::ItemKind::Trait(..) => {
 777             tcx.ensure().generics_of(def_id);
 778             tcx.ensure().trait_def(def_id);
 779             tcx.at(it.span).super_predicates_of(def_id);
 780             tcx.ensure().predicates_of(def_id);
 781         }
 782         hir::ItemKind::TraitAlias(..) => {
 783             tcx.ensure().generics_of(def_id);
 784             tcx.at(it.span).super_predicates_of(def_id);
 785             tcx.ensure().predicates_of(def_id);
 786         }
 787         hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
 788             tcx.ensure().generics_of(def_id);
 789             tcx.ensure().type_of(def_id);
 790             tcx.ensure().predicates_of(def_id);
 791
 792             for f in struct_def.fields() {
 793                 let def_id = tcx.hir().local_def_id(f.hir_id);
 794                 tcx.ensure().generics_of(def_id);
 795                 tcx.ensure().type_of(def_id);
 796                 tcx.ensure().predicates_of(def_id);
 797             }
 798
 799             if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
 800                 convert_variant_ctor(tcx, ctor_hir_id);
 801             }
 802         }
 803
 804         // Desugared from `impl Trait`, so visited by the function's return type.
 805         hir::ItemKind::OpaqueTy(hir::OpaqueTy {
 806             origin: hir::OpaqueTyOrigin::FnReturn(..) | hir::OpaqueTyOrigin::AsyncFn(..),
 807             ..
 808         }) => {}
 809
 810         // Don't call `type_of` on opaque types, since that depends on type
 811         // checking function bodies. `check_item_type` ensures that it's called
 812         // instead.
 813         hir::ItemKind::OpaqueTy(..) => {
 814             tcx.ensure().generics_of(def_id);
 815             tcx.ensure().predicates_of(def_id);
 816             tcx.ensure().explicit_item_bounds(def_id);
 817         }
 818         hir::ItemKind::TyAlias(..)
 819         | hir::ItemKind::Static(..)
 820         | hir::ItemKind::Const(..)
 821         | hir::ItemKind::Fn(..) => {
 822             tcx.ensure().generics_of(def_id);
 823             tcx.ensure().type_of(def_id);
 824             tcx.ensure().predicates_of(def_id);
 825             match it.kind {
 826                 hir::ItemKind::Fn(..) => tcx.ensure().fn_sig(def_id),
 827                 hir::ItemKind::OpaqueTy(..) => tcx.ensure().item_bounds(def_id),
 828                 hir::ItemKind::Const(ty, ..) | hir::ItemKind::Static(ty, ..) => {
 829                     if !is_suggestable_infer_ty(ty) {
 830                         let mut visitor = HirPlaceholderCollector::default();
 831                         visitor.visit_item(it);
 832                         placeholder_type_error(tcx, None, visitor.0, false, None, it.kind.descr());
 833                     }
 834                 }
 835                 _ => (),
 836             }
 837         }
 838     }
 839 }
 840
 841 fn convert_trait_item(tcx: TyCtxt<'_>, trait_item_id: hir::TraitItemId) {
 842     let trait_item = tcx.hir().trait_item(trait_item_id);
 843     tcx.ensure().generics_of(trait_item_id.def_id);
 844
 845     match trait_item.kind {
 846         hir::TraitItemKind::Fn(..) => {
 847             tcx.ensure().type_of(trait_item_id.def_id);
 848             tcx.ensure().fn_sig(trait_item_id.def_id);
 849         }
 850
 851         hir::TraitItemKind::Const(.., Some(_)) => {
 852             tcx.ensure().type_of(trait_item_id.def_id);
 853         }
 854
 855         hir::TraitItemKind::Const(..) => {
 856             tcx.ensure().type_of(trait_item_id.def_id);
 857             // Account for `const C: _;`.
 858             let mut visitor = HirPlaceholderCollector::default();
 859             visitor.visit_trait_item(trait_item);
 860             placeholder_type_error(tcx, None, visitor.0, false, None, "constant");
 861         }
 862
 863         hir::TraitItemKind::Type(_, Some(_)) => {
 864             tcx.ensure().item_bounds(trait_item_id.def_id);
 865             tcx.ensure().type_of(trait_item_id.def_id);
 866             // Account for `type T = _;`.
 867             let mut visitor = HirPlaceholderCollector::default();
 868             visitor.visit_trait_item(trait_item);
 869             placeholder_type_error(tcx, None, visitor.0, false, None, "associated type");
 870         }
 871
 872         hir::TraitItemKind::Type(_, None) => {
 873             tcx.ensure().item_bounds(trait_item_id.def_id);
 874             // #74612: Visit and try to find bad placeholders
 875             // even if there is no concrete type.
 876             let mut visitor = HirPlaceholderCollector::default();
 877             visitor.visit_trait_item(trait_item);
 878
 879             placeholder_type_error(tcx, None, visitor.0, false, None, "associated type");
 880         }
 881     };
 882
 883     tcx.ensure().predicates_of(trait_item_id.def_id);
 884 }
 885
 886 fn convert_impl_item(tcx: TyCtxt<'_>, impl_item_id: hir::ImplItemId) {
 887     let def_id = impl_item_id.def_id;
 888     tcx.ensure().generics_of(def_id);
 889     tcx.ensure().type_of(def_id);
 890     tcx.ensure().predicates_of(def_id);
 891     let impl_item = tcx.hir().impl_item(impl_item_id);
 892     match impl_item.kind {
 893         hir::ImplItemKind::Fn(..) => {
 894             tcx.ensure().fn_sig(def_id);
 895         }
 896         hir::ImplItemKind::TyAlias(_) => {
 897             // Account for `type T = _;`
 898             let mut visitor = HirPlaceholderCollector::default();
 899             visitor.visit_impl_item(impl_item);
 900
 901             placeholder_type_error(tcx, None, visitor.0, false, None, "associated type");
 902         }
 903         hir::ImplItemKind::Const(..) => {}
 904     }
 905 }
 906
 907 fn convert_variant_ctor(tcx: TyCtxt<'_>, ctor_id: hir::HirId) {
 908     let def_id = tcx.hir().local_def_id(ctor_id);
 909     tcx.ensure().generics_of(def_id);
 910     tcx.ensure().type_of(def_id);
 911     tcx.ensure().predicates_of(def_id);
 912 }
 913
 914 fn convert_enum_variant_types(tcx: TyCtxt<'_>, def_id: DefId, variants: &[hir::Variant<'_>]) {
 915     let def = tcx.adt_def(def_id);
 916     let repr_type = def.repr().discr_type();
 917     let initial = repr_type.initial_discriminant(tcx);
 918     let mut prev_discr = None::<Discr<'_>>;
 919
 920     // fill the discriminant values and field types
 921     for variant in variants {
 922         let wrapped_discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
 923         prev_discr = Some(
 924             if let Some(ref e) = variant.disr_expr {
 925                 let expr_did = tcx.hir().local_def_id(e.hir_id);
 926                 def.eval_explicit_discr(tcx, expr_did.to_def_id())
 927             } else if let Some(discr) = repr_type.disr_incr(tcx, prev_discr) {
 928                 Some(discr)
 929             } else {
 930                 struct_span_err!(tcx.sess, variant.span, E0370, "enum discriminant overflowed")
 931                     .span_label(
 932                         variant.span,
 933                         format!("overflowed on value after {}", prev_discr.unwrap()),
 934                     )
 935                     .note(&format!(
 936                         "explicitly set `{} = {}` if that is desired outcome",
 937                         variant.ident, wrapped_discr
 938                     ))
 939                     .emit();
 940                 None
 941             }
 942             .unwrap_or(wrapped_discr),
 943         );
 944
 945         for f in variant.data.fields() {
 946             let def_id = tcx.hir().local_def_id(f.hir_id);
 947             tcx.ensure().generics_of(def_id);
 948             tcx.ensure().type_of(def_id);
 949             tcx.ensure().predicates_of(def_id);
 950         }
 951
 952         // Convert the ctor, if any. This also registers the variant as
 953         // an item.
 954         if let Some(ctor_hir_id) = variant.data.ctor_hir_id() {
 955             convert_variant_ctor(tcx, ctor_hir_id);
 956         }
 957     }
 958 }
 959
 960 fn convert_variant(
 961     tcx: TyCtxt<'_>,
 962     variant_did: Option<LocalDefId>,
 963     ctor_did: Option<LocalDefId>,
 964     ident: Ident,
 965     discr: ty::VariantDiscr,
 966     def: &hir::VariantData<'_>,
 967     adt_kind: ty::AdtKind,
 968     parent_did: LocalDefId,
 969 ) -> ty::VariantDef {
 970     let mut seen_fields: FxHashMap<Ident, Span> = Default::default();
 971     let fields = def
 972         .fields()
 973         .iter()
 974         .map(|f| {
 975             let fid = tcx.hir().local_def_id(f.hir_id);
 976             let dup_span = seen_fields.get(&f.ident.normalize_to_macros_2_0()).cloned();
 977             if let Some(prev_span) = dup_span {
 978                 tcx.sess.emit_err(errors::FieldAlreadyDeclared {
 979                     field_name: f.ident,
 980                     span: f.span,
 981                     prev_span,
 982                 });
 983             } else {
 984                 seen_fields.insert(f.ident.normalize_to_macros_2_0(), f.span);
 985             }
 986
 987             ty::FieldDef { did: fid.to_def_id(), name: f.ident.name, vis: tcx.visibility(fid) }
 988         })
 989         .collect();
 990     let recovered = match def {
 991         hir::VariantData::Struct(_, r) => *r,
 992         _ => false,
 993     };
 994     ty::VariantDef::new(
 995         ident.name,
 996         variant_did.map(LocalDefId::to_def_id),
 997         ctor_did.map(LocalDefId::to_def_id),
 998         discr,
 999         fields,
1000         CtorKind::from_hir(def),
1001         adt_kind,
1002         parent_did.to_def_id(),
1003         recovered,
1004         adt_kind == AdtKind::Struct && tcx.has_attr(parent_did.to_def_id(), sym::non_exhaustive)
1005             || variant_did.map_or(false, |variant_did| {
1006                 tcx.has_attr(variant_did.to_def_id(), sym::non_exhaustive)
1007             }),
1008     )
1009 }
1010
1011 fn adt_def<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> ty::AdtDef<'tcx> {
1012     use rustc_hir::*;
1013
1014     let def_id = def_id.expect_local();
1015     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
1016     let Node::Item(item) = tcx.hir().get(hir_id) else {
1017         bug!();
1018     };
1019
1020     let repr = ReprOptions::new(tcx, def_id.to_def_id());
1021     let (kind, variants) = match item.kind {
1022         ItemKind::Enum(ref def, _) => {
1023             let mut distance_from_explicit = 0;
1024             let variants = def
1025                 .variants
1026                 .iter()
1027                 .map(|v| {
1028                     let variant_did = Some(tcx.hir().local_def_id(v.id));
1029                     let ctor_did =
1030                         v.data.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
1031
1032                     let discr = if let Some(ref e) = v.disr_expr {
1033                         distance_from_explicit = 0;
1034                         ty::VariantDiscr::Explicit(tcx.hir().local_def_id(e.hir_id).to_def_id())
1035                     } else {
1036                         ty::VariantDiscr::Relative(distance_from_explicit)
1037                     };
1038                     distance_from_explicit += 1;
1039
1040                     convert_variant(
1041                         tcx,
1042                         variant_did,
1043                         ctor_did,
1044                         v.ident,
1045                         discr,
1046                         &v.data,
1047                         AdtKind::Enum,
1048                         def_id,
1049                     )
1050                 })
1051                 .collect();
1052
1053             (AdtKind::Enum, variants)
1054         }
1055         ItemKind::Struct(ref def, _) => {
1056             let variant_did = None::<LocalDefId>;
1057             let ctor_did = def.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
1058
1059             let variants = std::iter::once(convert_variant(
1060                 tcx,
1061                 variant_did,
1062                 ctor_did,
1063                 item.ident,
1064                 ty::VariantDiscr::Relative(0),
1065                 def,
1066                 AdtKind::Struct,
1067                 def_id,
1068             ))
1069             .collect();
1070
1071             (AdtKind::Struct, variants)
1072         }
1073         ItemKind::Union(ref def, _) => {
1074             let variant_did = None;
1075             let ctor_did = def.ctor_hir_id().map(|hir_id| tcx.hir().local_def_id(hir_id));
1076
1077             let variants = std::iter::once(convert_variant(
1078                 tcx,
1079                 variant_did,
1080                 ctor_did,
1081                 item.ident,
1082                 ty::VariantDiscr::Relative(0),
1083                 def,
1084                 AdtKind::Union,
1085                 def_id,
1086             ))
1087             .collect();
1088
1089             (AdtKind::Union, variants)
1090         }
1091         _ => bug!(),
1092     };
1093     tcx.alloc_adt_def(def_id.to_def_id(), kind, variants, repr)
1094 }
1095
1096 /// Ensures that the super-predicates of the trait with a `DefId`
1097 /// of `trait_def_id` are converted and stored. This also ensures that
1098 /// the transitive super-predicates are converted.
1099 fn super_predicates_of(tcx: TyCtxt<'_>, trait_def_id: DefId) -> ty::GenericPredicates<'_> {
1100     debug!("super_predicates(trait_def_id={:?})", trait_def_id);
1101     tcx.super_predicates_that_define_assoc_type((trait_def_id, None))
1102 }
1103
1104 /// Ensures that the super-predicates of the trait with a `DefId`
1105 /// of `trait_def_id` are converted and stored. This also ensures that
1106 /// the transitive super-predicates are converted.
1107 fn super_predicates_that_define_assoc_type(
1108     tcx: TyCtxt<'_>,
1109     (trait_def_id, assoc_name): (DefId, Option<Ident>),
1110 ) -> ty::GenericPredicates<'_> {
1111     debug!(
1112         "super_predicates_that_define_assoc_type(trait_def_id={:?}, assoc_name={:?})",
1113         trait_def_id, assoc_name
1114     );
1115     if trait_def_id.is_local() {
1116         debug!("super_predicates_that_define_assoc_type: local trait_def_id={:?}", trait_def_id);
1117         let trait_hir_id = tcx.hir().local_def_id_to_hir_id(trait_def_id.expect_local());
1118
1119         let Node::Item(item) = tcx.hir().get(trait_hir_id) else {
1120             bug!("trait_node_id {} is not an item", trait_hir_id);
1121         };
1122
1123         let (generics, bounds) = match item.kind {
1124             hir::ItemKind::Trait(.., ref generics, ref supertraits, _) => (generics, supertraits),
1125             hir::ItemKind::TraitAlias(ref generics, ref supertraits) => (generics, supertraits),
1126             _ => span_bug!(item.span, "super_predicates invoked on non-trait"),
1127         };
1128
1129         let icx = ItemCtxt::new(tcx, trait_def_id);
1130
1131         // Convert the bounds that follow the colon, e.g., `Bar + Zed` in `trait Foo: Bar + Zed`.
1132         let self_param_ty = tcx.types.self_param;
1133         let superbounds1 = if let Some(assoc_name) = assoc_name {
1134             <dyn AstConv<'_>>::compute_bounds_that_match_assoc_type(
1135                 &icx,
1136                 self_param_ty,
1137                 bounds,
1138                 assoc_name,
1139             )
1140         } else {
1141             <dyn AstConv<'_>>::compute_bounds(&icx, self_param_ty, bounds)
1142         };
1143
1144         let superbounds1 = superbounds1.predicates(tcx, self_param_ty);
1145
1146         // Convert any explicit superbounds in the where-clause,
1147         // e.g., `trait Foo where Self: Bar`.
1148         // In the case of trait aliases, however, we include all bounds in the where-clause,
1149         // so e.g., `trait Foo = where u32: PartialEq<Self>` would include `u32: PartialEq<Self>`
1150         // as one of its "superpredicates".
1151         let is_trait_alias = tcx.is_trait_alias(trait_def_id);
1152         let superbounds2 = icx.type_parameter_bounds_in_generics(
1153             generics,
1154             item.hir_id(),
1155             self_param_ty,
1156             OnlySelfBounds(!is_trait_alias),
1157             assoc_name,
1158         );
1159
1160         // Combine the two lists to form the complete set of superbounds:
1161         let superbounds = &*tcx.arena.alloc_from_iter(superbounds1.into_iter().chain(superbounds2));
1162         debug!(?superbounds);
1163
1164         // Now require that immediate supertraits are converted,
1165         // which will, in turn, reach indirect supertraits.
1166         if assoc_name.is_none() {
1167             // Now require that immediate supertraits are converted,
1168             // which will, in turn, reach indirect supertraits.
1169             for &(pred, span) in superbounds {
1170                 debug!("superbound: {:?}", pred);
1171                 if let ty::PredicateKind::Trait(bound) = pred.kind().skip_binder() {
1172                     tcx.at(span).super_predicates_of(bound.def_id());
1173                 }
1174             }
1175         }
1176
1177         ty::GenericPredicates { parent: None, predicates: superbounds }
1178     } else {
1179         // if `assoc_name` is None, then the query should've been redirected to an
1180         // external provider
1181         assert!(assoc_name.is_some());
1182         tcx.super_predicates_of(trait_def_id)
1183     }
1184 }
1185
1186 fn trait_def(tcx: TyCtxt<'_>, def_id: DefId) -> ty::TraitDef {
1187     let item = tcx.hir().expect_item(def_id.expect_local());
1188
1189     let (is_auto, unsafety, items) = match item.kind {
1190         hir::ItemKind::Trait(is_auto, unsafety, .., items) => {
1191             (is_auto == hir::IsAuto::Yes, unsafety, items)
1192         }
1193         hir::ItemKind::TraitAlias(..) => (false, hir::Unsafety::Normal, &[][..]),
1194         _ => span_bug!(item.span, "trait_def_of_item invoked on non-trait"),
1195     };
1196
1197     let paren_sugar = tcx.has_attr(def_id, sym::rustc_paren_sugar);
1198     if paren_sugar && !tcx.features().unboxed_closures {
1199         tcx.sess
1200             .struct_span_err(
1201                 item.span,
1202                 "the `#[rustc_paren_sugar]` attribute is a temporary means of controlling \
1203                  which traits can use parenthetical notation",
1204             )
1205             .help("add `#![feature(unboxed_closures)]` to the crate attributes to use it")
1206             .emit();
1207     }
1208
1209     let is_marker = tcx.has_attr(def_id, sym::marker);
1210     let skip_array_during_method_dispatch =
1211         tcx.has_attr(def_id, sym::rustc_skip_array_during_method_dispatch);
1212     let spec_kind = if tcx.has_attr(def_id, sym::rustc_unsafe_specialization_marker) {
1213         ty::trait_def::TraitSpecializationKind::Marker
1214     } else if tcx.has_attr(def_id, sym::rustc_specialization_trait) {
1215         ty::trait_def::TraitSpecializationKind::AlwaysApplicable
1216     } else {
1217         ty::trait_def::TraitSpecializationKind::None
1218     };
1219     let must_implement_one_of = tcx
1220         .get_attr(def_id, sym::rustc_must_implement_one_of)
1221         // Check that there are at least 2 arguments of `#[rustc_must_implement_one_of]`
1222         // and that they are all identifiers
1223         .and_then(|attr| match attr.meta_item_list() {
1224             Some(items) if items.len() < 2 => {
1225                 tcx.sess
1226                     .struct_span_err(
1227                         attr.span,
1228                         "the `#[rustc_must_implement_one_of]` attribute must be \
1229                         used with at least 2 args",
1230                     )
1231                     .emit();
1232
1233                 None
1234             }
1235             Some(items) => items
1236                 .into_iter()
1237                 .map(|item| item.ident().ok_or(item.span()))
1238                 .collect::<Result<Box<[_]>, _>>()
1239                 .map_err(|span| {
1240                     tcx.sess
1241                         .struct_span_err(span, "must be a name of an associated function")
1242                         .emit();
1243                 })
1244                 .ok()
1245                 .zip(Some(attr.span)),
1246             // Error is reported by `rustc_attr!`
1247             None => None,
1248         })
1249         // Check that all arguments of `#[rustc_must_implement_one_of]` reference
1250         // functions in the trait with default implementations
1251         .and_then(|(list, attr_span)| {
1252             let errors = list.iter().filter_map(|ident| {
1253                 let item = items.iter().find(|item| item.ident == *ident);
1254
1255                 match item {
1256                     Some(item) if matches!(item.kind, hir::AssocItemKind::Fn { .. }) => {
1257                         if !tcx.impl_defaultness(item.id.def_id).has_value() {
1258                             tcx.sess
1259                                 .struct_span_err(
1260                                     item.span,
1261                                     "This function doesn't have a default implementation",
1262                                 )
1263                                 .span_note(attr_span, "required by this annotation")
1264                                 .emit();
1265
1266                             return Some(());
1267                         }
1268
1269                         return None;
1270                     }
1271                     Some(item) => {
1272                         tcx.sess
1273                             .struct_span_err(item.span, "Not a function")
1274                             .span_note(attr_span, "required by this annotation")
1275                             .note(
1276                                 "All `#[rustc_must_implement_one_of]` arguments \
1277                             must be associated function names",
1278                             )
1279                             .emit();
1280                     }
1281                     None => {
1282                         tcx.sess
1283                             .struct_span_err(ident.span, "Function not found in this trait")
1284                             .emit();
1285                     }
1286                 }
1287
1288                 Some(())
1289             });
1290
1291             (errors.count() == 0).then_some(list)
1292         })
1293         // Check for duplicates
1294         .and_then(|list| {
1295             let mut set: FxHashMap<Symbol, Span> = FxHashMap::default();
1296             let mut no_dups = true;
1297
1298             for ident in &*list {
1299                 if let Some(dup) = set.insert(ident.name, ident.span) {
1300                     tcx.sess
1301                         .struct_span_err(vec![dup, ident.span], "Functions names are duplicated")
1302                         .note(
1303                             "All `#[rustc_must_implement_one_of]` arguments \
1304                             must be unique",
1305                         )
1306                         .emit();
1307
1308                     no_dups = false;
1309                 }
1310             }
1311
1312             no_dups.then_some(list)
1313         });
1314
1315     ty::TraitDef::new(
1316         def_id,
1317         unsafety,
1318         paren_sugar,
1319         is_auto,
1320         is_marker,
1321         skip_array_during_method_dispatch,
1322         spec_kind,
1323         must_implement_one_of,
1324     )
1325 }
1326
1327 fn has_late_bound_regions<'tcx>(tcx: TyCtxt<'tcx>, node: Node<'tcx>) -> Option<Span> {
1328     struct LateBoundRegionsDetector<'tcx> {
1329         tcx: TyCtxt<'tcx>,
1330         outer_index: ty::DebruijnIndex,
1331         has_late_bound_regions: Option<Span>,
1332     }
1333
1334     impl<'tcx> Visitor<'tcx> for LateBoundRegionsDetector<'tcx> {
1335         fn visit_ty(&mut self, ty: &'tcx hir::Ty<'tcx>) {
1336             if self.has_late_bound_regions.is_some() {
1337                 return;
1338             }
1339             match ty.kind {
1340                 hir::TyKind::BareFn(..) => {
1341                     self.outer_index.shift_in(1);
1342                     intravisit::walk_ty(self, ty);
1343                     self.outer_index.shift_out(1);
1344                 }
1345                 _ => intravisit::walk_ty(self, ty),
1346             }
1347         }
1348
1349         fn visit_poly_trait_ref(&mut self, tr: &'tcx hir::PolyTraitRef<'tcx>) {
1350             if self.has_late_bound_regions.is_some() {
1351                 return;
1352             }
1353             self.outer_index.shift_in(1);
1354             intravisit::walk_poly_trait_ref(self, tr);
1355             self.outer_index.shift_out(1);
1356         }
1357
1358         fn visit_lifetime(&mut self, lt: &'tcx hir::Lifetime) {
1359             if self.has_late_bound_regions.is_some() {
1360                 return;
1361             }
1362
1363             match self.tcx.named_region(lt.hir_id) {
1364                 Some(rl::Region::Static | rl::Region::EarlyBound(..)) => {}
1365                 Some(rl::Region::LateBound(debruijn, _, _)) if debruijn < self.outer_index => {}
1366                 Some(rl::Region::LateBound(..) | rl::Region::Free(..)) | None => {
1367                     self.has_late_bound_regions = Some(lt.span);
1368                 }
1369             }
1370         }
1371     }
1372
1373     fn has_late_bound_regions<'tcx>(
1374         tcx: TyCtxt<'tcx>,
1375         generics: &'tcx hir::Generics<'tcx>,
1376         decl: &'tcx hir::FnDecl<'tcx>,
1377     ) -> Option<Span> {
1378         let mut visitor = LateBoundRegionsDetector {
1379             tcx,
1380             outer_index: ty::INNERMOST,
1381             has_late_bound_regions: None,
1382         };
1383         for param in generics.params {
1384             if let GenericParamKind::Lifetime { .. } = param.kind {
1385                 if tcx.is_late_bound(param.hir_id) {
1386                     return Some(param.span);
1387                 }
1388             }
1389         }
1390         visitor.visit_fn_decl(decl);
1391         visitor.has_late_bound_regions
1392     }
1393
1394     match node {
1395         Node::TraitItem(item) => match item.kind {
1396             hir::TraitItemKind::Fn(ref sig, _) => {
1397                 has_late_bound_regions(tcx, &item.generics, sig.decl)
1398             }
1399             _ => None,
1400         },
1401         Node::ImplItem(item) => match item.kind {
1402             hir::ImplItemKind::Fn(ref sig, _) => {
1403                 has_late_bound_regions(tcx, &item.generics, sig.decl)
1404             }
1405             _ => None,
1406         },
1407         Node::ForeignItem(item) => match item.kind {
1408             hir::ForeignItemKind::Fn(fn_decl, _, ref generics) => {
1409                 has_late_bound_regions(tcx, generics, fn_decl)
1410             }
1411             _ => None,
1412         },
1413         Node::Item(item) => match item.kind {
1414             hir::ItemKind::Fn(ref sig, .., ref generics, _) => {
1415                 has_late_bound_regions(tcx, generics, sig.decl)
1416             }
1417             _ => None,
1418         },
1419         _ => None,
1420     }
1421 }
1422
1423 struct AnonConstInParamTyDetector {
1424     in_param_ty: bool,
1425     found_anon_const_in_param_ty: bool,
1426     ct: HirId,
1427 }
1428
1429 impl<'v> Visitor<'v> for AnonConstInParamTyDetector {
1430     fn visit_generic_param(&mut self, p: &'v hir::GenericParam<'v>) {
1431         if let GenericParamKind::Const { ty, default: _ } = p.kind {
1432             let prev = self.in_param_ty;
1433             self.in_param_ty = true;
1434             self.visit_ty(ty);
1435             self.in_param_ty = prev;
1436         }
1437     }
1438
1439     fn visit_anon_const(&mut self, c: &'v hir::AnonConst) {
1440         if self.in_param_ty && self.ct == c.hir_id {
1441             self.found_anon_const_in_param_ty = true;
1442         } else {
1443             intravisit::walk_anon_const(self, c)
1444         }
1445     }
1446 }
1447
1448 fn generics_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::Generics {
1449     use rustc_hir::*;
1450
1451     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
1452
1453     let node = tcx.hir().get(hir_id);
1454     let parent_def_id = match node {
1455         Node::ImplItem(_)
1456         | Node::TraitItem(_)
1457         | Node::Variant(_)
1458         | Node::Ctor(..)
1459         | Node::Field(_) => {
1460             let parent_id = tcx.hir().get_parent_item(hir_id);
1461             Some(parent_id.to_def_id())
1462         }
1463         // FIXME(#43408) always enable this once `lazy_normalization` is
1464         // stable enough and does not need a feature gate anymore.
1465         Node::AnonConst(_) => {
1466             let parent_def_id = tcx.hir().get_parent_item(hir_id);
1467
1468             let mut in_param_ty = false;
1469             for (_parent, node) in tcx.hir().parent_iter(hir_id) {
1470                 if let Some(generics) = node.generics() {
1471                     let mut visitor = AnonConstInParamTyDetector {
1472                         in_param_ty: false,
1473                         found_anon_const_in_param_ty: false,
1474                         ct: hir_id,
1475                     };
1476
1477                     visitor.visit_generics(generics);
1478                     in_param_ty = visitor.found_anon_const_in_param_ty;
1479                     break;
1480                 }
1481             }
1482
1483             if in_param_ty {
1484                 // We do not allow generic parameters in anon consts if we are inside
1485                 // of a const parameter type, e.g. `struct Foo<const N: usize, const M: [u8; N]>` is not allowed.
1486                 None
1487             } else if tcx.lazy_normalization() {
1488                 if let Some(param_id) = tcx.hir().opt_const_param_default_param_hir_id(hir_id) {
1489                     // If the def_id we are calling generics_of on is an anon ct default i.e:
1490                     //
1491                     // struct Foo<const N: usize = { .. }>;
1492                     //        ^^^       ^          ^^^^^^ def id of this anon const
1493                     //        ^         ^ param_id
1494                     //        ^ parent_def_id
1495                     //
1496                     // then we only want to return generics for params to the left of `N`. If we don't do that we
1497                     // end up with that const looking like: `ty::ConstKind::Unevaluated(def_id, substs: [N#0])`.
1498                     //
1499                     // This causes ICEs (#86580) when building the substs for Foo in `fn foo() -> Foo { .. }` as
1500                     // we substitute the defaults with the partially built substs when we build the substs. Subst'ing
1501                     // the `N#0` on the unevaluated const indexes into the empty substs we're in the process of building.
1502                     //
1503                     // We fix this by having this function return the parent's generics ourselves and truncating the
1504                     // generics to only include non-forward declared params (with the exception of the `Self` ty)
1505                     //
1506                     // For the above code example that means we want `substs: []`
1507                     // For the following struct def we want `substs: [N#0]` when generics_of is called on
1508                     // the def id of the `{ N + 1 }` anon const
1509                     // struct Foo<const N: usize, const M: usize = { N + 1 }>;
1510                     //
1511                     // This has some implications for how we get the predicates available to the anon const
1512                     // see `explicit_predicates_of` for more information on this
1513                     let generics = tcx.generics_of(parent_def_id.to_def_id());
1514                     let param_def = tcx.hir().local_def_id(param_id).to_def_id();
1515                     let param_def_idx = generics.param_def_id_to_index[&param_def];
1516                     // In the above example this would be .params[..N#0]
1517                     let params = generics.params[..param_def_idx as usize].to_owned();
1518                     let param_def_id_to_index =
1519                         params.iter().map(|param| (param.def_id, param.index)).collect();
1520
1521                     return ty::Generics {
1522                         // we set the parent of these generics to be our parent's parent so that we
1523                         // dont end up with substs: [N, M, N] for the const default on a struct like this:
1524                         // struct Foo<const N: usize, const M: usize = { ... }>;
1525                         parent: generics.parent,
1526                         parent_count: generics.parent_count,
1527                         params,
1528                         param_def_id_to_index,
1529                         has_self: generics.has_self,
1530                         has_late_bound_regions: generics.has_late_bound_regions,
1531                     };
1532                 }
1533
1534                 // HACK(eddyb) this provides the correct generics when
1535                 // `feature(generic_const_expressions)` is enabled, so that const expressions
1536                 // used with const generics, e.g. `Foo<{N+1}>`, can work at all.
1537                 //
1538                 // Note that we do not supply the parent generics when using
1539                 // `min_const_generics`.
1540                 Some(parent_def_id.to_def_id())
1541             } else {
1542                 let parent_node = tcx.hir().get(tcx.hir().get_parent_node(hir_id));
1543                 match parent_node {
1544                     // HACK(eddyb) this provides the correct generics for repeat
1545                     // expressions' count (i.e. `N` in `[x; N]`), and explicit
1546                     // `enum` discriminants (i.e. `D` in `enum Foo { Bar = D }`),
1547                     // as they shouldn't be able to cause query cycle errors.
1548                     Node::Expr(&Expr { kind: ExprKind::Repeat(_, ref constant), .. })
1549                         if constant.hir_id() == hir_id =>
1550                     {
1551                         Some(parent_def_id.to_def_id())
1552                     }
1553                     Node::Variant(Variant { disr_expr: Some(ref constant), .. })
1554                         if constant.hir_id == hir_id =>
1555                     {
1556                         Some(parent_def_id.to_def_id())
1557                     }
1558                     Node::Expr(&Expr { kind: ExprKind::ConstBlock(_), .. }) => {
1559                         Some(tcx.typeck_root_def_id(def_id))
1560                     }
1561                     // Exclude `GlobalAsm` here which cannot have generics.
1562                     Node::Expr(&Expr { kind: ExprKind::InlineAsm(asm), .. })
1563                         if asm.operands.iter().any(|(op, _op_sp)| match op {
1564                             hir::InlineAsmOperand::Const { anon_const }
1565                             | hir::InlineAsmOperand::SymFn { anon_const } => {
1566                                 anon_const.hir_id == hir_id
1567                             }
1568                             _ => false,
1569                         }) =>
1570                     {
1571                         Some(parent_def_id.to_def_id())
1572                     }
1573                     _ => None,
1574                 }
1575             }
1576         }
1577         Node::Expr(&hir::Expr { kind: hir::ExprKind::Closure { .. }, .. }) => {
1578             Some(tcx.typeck_root_def_id(def_id))
1579         }
1580         Node::Item(item) => match item.kind {
1581             ItemKind::OpaqueTy(hir::OpaqueTy {
1582                 origin:
1583                     hir::OpaqueTyOrigin::FnReturn(fn_def_id) | hir::OpaqueTyOrigin::AsyncFn(fn_def_id),
1584                 in_trait,
1585                 ..
1586             }) => {
1587                 if in_trait {
1588                     assert!(matches!(tcx.def_kind(fn_def_id), DefKind::AssocFn))
1589                 } else {
1590                     assert!(matches!(tcx.def_kind(fn_def_id), DefKind::AssocFn | DefKind::Fn))
1591                 }
1592                 Some(fn_def_id.to_def_id())
1593             }
1594             ItemKind::OpaqueTy(hir::OpaqueTy { origin: hir::OpaqueTyOrigin::TyAlias, .. }) => {
1595                 let parent_id = tcx.hir().get_parent_item(hir_id);
1596                 assert_ne!(parent_id, CRATE_DEF_ID);
1597                 debug!("generics_of: parent of opaque ty {:?} is {:?}", def_id, parent_id);
1598                 // Opaque types are always nested within another item, and
1599                 // inherit the generics of the item.
1600                 Some(parent_id.to_def_id())
1601             }
1602             _ => None,
1603         },
1604         _ => None,
1605     };
1606
1607     let no_generics = hir::Generics::empty();
1608     let ast_generics = node.generics().unwrap_or(&no_generics);
1609     let (opt_self, allow_defaults) = match node {
1610         Node::Item(item) => {
1611             match item.kind {
1612                 ItemKind::Trait(..) | ItemKind::TraitAlias(..) => {
1613                     // Add in the self type parameter.
1614                     //
1615                     // Something of a hack: use the node id for the trait, also as
1616                     // the node id for the Self type parameter.
1617                     let opt_self = Some(ty::GenericParamDef {
1618                         index: 0,
1619                         name: kw::SelfUpper,
1620                         def_id,
1621                         pure_wrt_drop: false,
1622                         kind: ty::GenericParamDefKind::Type {
1623                             has_default: false,
1624                             synthetic: false,
1625                         },
1626                     });
1627
1628                     (opt_self, true)
1629                 }
1630                 ItemKind::TyAlias(..)
1631                 | ItemKind::Enum(..)
1632                 | ItemKind::Struct(..)
1633                 | ItemKind::OpaqueTy(..)
1634                 | ItemKind::Union(..) => (None, true),
1635                 _ => (None, false),
1636             }
1637         }
1638         _ => (None, false),
1639     };
1640
1641     let has_self = opt_self.is_some();
1642     let mut parent_has_self = false;
1643     let mut own_start = has_self as u32;
1644     let parent_count = parent_def_id.map_or(0, |def_id| {
1645         let generics = tcx.generics_of(def_id);
1646         assert!(!has_self);
1647         parent_has_self = generics.has_self;
1648         own_start = generics.count() as u32;
1649         generics.parent_count + generics.params.len()
1650     });
1651
1652     let mut params: Vec<_> = Vec::with_capacity(ast_generics.params.len() + has_self as usize);
1653
1654     if let Some(opt_self) = opt_self {
1655         params.push(opt_self);
1656     }
1657
1658     let early_lifetimes = early_bound_lifetimes_from_generics(tcx, ast_generics);
1659     params.extend(early_lifetimes.enumerate().map(|(i, param)| ty::GenericParamDef {
1660         name: param.name.ident().name,
1661         index: own_start + i as u32,
1662         def_id: tcx.hir().local_def_id(param.hir_id).to_def_id(),
1663         pure_wrt_drop: param.pure_wrt_drop,
1664         kind: ty::GenericParamDefKind::Lifetime,
1665     }));
1666
1667     // Now create the real type and const parameters.
1668     let type_start = own_start - has_self as u32 + params.len() as u32;
1669     let mut i = 0;
1670
1671     params.extend(ast_generics.params.iter().filter_map(|param| match param.kind {
1672         GenericParamKind::Lifetime { .. } => None,
1673         GenericParamKind::Type { ref default, synthetic, .. } => {
1674             if !allow_defaults && default.is_some() {
1675                 if !tcx.features().default_type_parameter_fallback {
1676                     tcx.struct_span_lint_hir(
1677                         lint::builtin::INVALID_TYPE_PARAM_DEFAULT,
1678                         param.hir_id,
1679                         param.span,
1680                         |lint| {
1681                             lint.build(
1682                                 "defaults for type parameters are only allowed in \
1683                                  `struct`, `enum`, `type`, or `trait` definitions",
1684                             )
1685                             .emit();
1686                         },
1687                     );
1688                 }
1689             }
1690
1691             let kind = ty::GenericParamDefKind::Type { has_default: default.is_some(), synthetic };
1692
1693             let param_def = ty::GenericParamDef {
1694                 index: type_start + i as u32,
1695                 name: param.name.ident().name,
1696                 def_id: tcx.hir().local_def_id(param.hir_id).to_def_id(),
1697                 pure_wrt_drop: param.pure_wrt_drop,
1698                 kind,
1699             };
1700             i += 1;
1701             Some(param_def)
1702         }
1703         GenericParamKind::Const { default, .. } => {
1704             if !allow_defaults && default.is_some() {
1705                 tcx.sess.span_err(
1706                     param.span,
1707                     "defaults for const parameters are only allowed in \
1708                     `struct`, `enum`, `type`, or `trait` definitions",
1709                 );
1710             }
1711
1712             let param_def = ty::GenericParamDef {
1713                 index: type_start + i as u32,
1714                 name: param.name.ident().name,
1715                 def_id: tcx.hir().local_def_id(param.hir_id).to_def_id(),
1716                 pure_wrt_drop: param.pure_wrt_drop,
1717                 kind: ty::GenericParamDefKind::Const { has_default: default.is_some() },
1718             };
1719             i += 1;
1720             Some(param_def)
1721         }
1722     }));
1723
1724     // provide junk type parameter defs - the only place that
1725     // cares about anything but the length is instantiation,
1726     // and we don't do that for closures.
1727     if let Node::Expr(&hir::Expr {
1728         kind: hir::ExprKind::Closure(hir::Closure { movability: gen, .. }),
1729         ..
1730     }) = node
1731     {
1732         let dummy_args = if gen.is_some() {
1733             &["<resume_ty>", "<yield_ty>", "<return_ty>", "<witness>", "<upvars>"][..]
1734         } else {
1735             &["<closure_kind>", "<closure_signature>", "<upvars>"][..]
1736         };
1737
1738         params.extend(dummy_args.iter().enumerate().map(|(i, &arg)| ty::GenericParamDef {
1739             index: type_start + i as u32,
1740             name: Symbol::intern(arg),
1741             def_id,
1742             pure_wrt_drop: false,
1743             kind: ty::GenericParamDefKind::Type { has_default: false, synthetic: false },
1744         }));
1745     }
1746
1747     // provide junk type parameter defs for const blocks.
1748     if let Node::AnonConst(_) = node {
1749         let parent_node = tcx.hir().get(tcx.hir().get_parent_node(hir_id));
1750         if let Node::Expr(&Expr { kind: ExprKind::ConstBlock(_), .. }) = parent_node {
1751             params.push(ty::GenericParamDef {
1752                 index: type_start,
1753                 name: Symbol::intern("<const_ty>"),
1754                 def_id,
1755                 pure_wrt_drop: false,
1756                 kind: ty::GenericParamDefKind::Type { has_default: false, synthetic: false },
1757             });
1758         }
1759     }
1760
1761     let param_def_id_to_index = params.iter().map(|param| (param.def_id, param.index)).collect();
1762
1763     ty::Generics {
1764         parent: parent_def_id,
1765         parent_count,
1766         params,
1767         param_def_id_to_index,
1768         has_self: has_self || parent_has_self,
1769         has_late_bound_regions: has_late_bound_regions(tcx, node),
1770     }
1771 }
1772
1773 fn are_suggestable_generic_args(generic_args: &[hir::GenericArg<'_>]) -> bool {
1774     generic_args.iter().any(|arg| match arg {
1775         hir::GenericArg::Type(ty) => is_suggestable_infer_ty(ty),
1776         hir::GenericArg::Infer(_) => true,
1777         _ => false,
1778     })
1779 }
1780
1781 /// Whether `ty` is a type with `_` placeholders that can be inferred. Used in diagnostics only to
1782 /// use inference to provide suggestions for the appropriate type if possible.
1783 fn is_suggestable_infer_ty(ty: &hir::Ty<'_>) -> bool {
1784     debug!(?ty);
1785     use hir::TyKind::*;
1786     match &ty.kind {
1787         Infer => true,
1788         Slice(ty) => is_suggestable_infer_ty(ty),
1789         Array(ty, length) => {
1790             is_suggestable_infer_ty(ty) || matches!(length, hir::ArrayLen::Infer(_, _))
1791         }
1792         Tup(tys) => tys.iter().any(is_suggestable_infer_ty),
1793         Ptr(mut_ty) | Rptr(_, mut_ty) => is_suggestable_infer_ty(mut_ty.ty),
1794         OpaqueDef(_, generic_args, _) => are_suggestable_generic_args(generic_args),
1795         Path(hir::QPath::TypeRelative(ty, segment)) => {
1796             is_suggestable_infer_ty(ty) || are_suggestable_generic_args(segment.args().args)
1797         }
1798         Path(hir::QPath::Resolved(ty_opt, hir::Path { segments, .. })) => {
1799             ty_opt.map_or(false, is_suggestable_infer_ty)
1800                 || segments.iter().any(|segment| are_suggestable_generic_args(segment.args().args))
1801         }
1802         _ => false,
1803     }
1804 }
1805
1806 pub fn get_infer_ret_ty<'hir>(output: &'hir hir::FnRetTy<'hir>) -> Option<&'hir hir::Ty<'hir>> {
1807     if let hir::FnRetTy::Return(ty) = output {
1808         if is_suggestable_infer_ty(ty) {
1809             return Some(&*ty);
1810         }
1811     }
1812     None
1813 }
1814
1815 #[instrument(level = "debug", skip(tcx))]
1816 fn fn_sig(tcx: TyCtxt<'_>, def_id: DefId) -> ty::PolyFnSig<'_> {
1817     use rustc_hir::Node::*;
1818     use rustc_hir::*;
1819
1820     let def_id = def_id.expect_local();
1821     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
1822
1823     let icx = ItemCtxt::new(tcx, def_id.to_def_id());
1824
1825     match tcx.hir().get(hir_id) {
1826         TraitItem(hir::TraitItem {
1827             kind: TraitItemKind::Fn(sig, TraitFn::Provided(_)),
1828             generics,
1829             ..
1830         })
1831         | Item(hir::Item { kind: ItemKind::Fn(sig, generics, _), .. }) => {
1832             infer_return_ty_for_fn_sig(tcx, sig, generics, def_id, &icx)
1833         }
1834
1835         ImplItem(hir::ImplItem { kind: ImplItemKind::Fn(sig, _), generics, .. }) => {
1836             // Do not try to inference the return type for a impl method coming from a trait
1837             if let Item(hir::Item { kind: ItemKind::Impl(i), .. }) =
1838                 tcx.hir().get(tcx.hir().get_parent_node(hir_id))
1839                 && i.of_trait.is_some()
1840             {
1841                 <dyn AstConv<'_>>::ty_of_fn(
1842                     &icx,
1843                     hir_id,
1844                     sig.header.unsafety,
1845                     sig.header.abi,
1846                     sig.decl,
1847                     Some(generics),
1848                     None,
1849                 )
1850             } else {
1851                 infer_return_ty_for_fn_sig(tcx, sig, generics, def_id, &icx)
1852             }
1853         }
1854
1855         TraitItem(hir::TraitItem {
1856             kind: TraitItemKind::Fn(FnSig { header, decl, span: _ }, _),
1857             generics,
1858             ..
1859         }) => <dyn AstConv<'_>>::ty_of_fn(
1860             &icx,
1861             hir_id,
1862             header.unsafety,
1863             header.abi,
1864             decl,
1865             Some(generics),
1866             None,
1867         ),
1868
1869         ForeignItem(&hir::ForeignItem { kind: ForeignItemKind::Fn(fn_decl, _, _), .. }) => {
1870             let abi = tcx.hir().get_foreign_abi(hir_id);
1871             compute_sig_of_foreign_fn_decl(tcx, def_id.to_def_id(), fn_decl, abi)
1872         }
1873
1874         Ctor(data) | Variant(hir::Variant { data, .. }) if data.ctor_hir_id().is_some() => {
1875             let ty = tcx.type_of(tcx.hir().get_parent_item(hir_id));
1876             let inputs =
1877                 data.fields().iter().map(|f| tcx.type_of(tcx.hir().local_def_id(f.hir_id)));
1878             ty::Binder::dummy(tcx.mk_fn_sig(
1879                 inputs,
1880                 ty,
1881                 false,
1882                 hir::Unsafety::Normal,
1883                 abi::Abi::Rust,
1884             ))
1885         }
1886
1887         Expr(&hir::Expr { kind: hir::ExprKind::Closure { .. }, .. }) => {
1888             // Closure signatures are not like other function
1889             // signatures and cannot be accessed through `fn_sig`. For
1890             // example, a closure signature excludes the `self`
1891             // argument. In any case they are embedded within the
1892             // closure type as part of the `ClosureSubsts`.
1893             //
1894             // To get the signature of a closure, you should use the
1895             // `sig` method on the `ClosureSubsts`:
1896             //
1897             //    substs.as_closure().sig(def_id, tcx)
1898             bug!(
1899                 "to get the signature of a closure, use `substs.as_closure().sig()` not `fn_sig()`",
1900             );
1901         }
1902
1903         x => {
1904             bug!("unexpected sort of node in fn_sig(): {:?}", x);
1905         }
1906     }
1907 }
1908
1909 fn infer_return_ty_for_fn_sig<'tcx>(
1910     tcx: TyCtxt<'tcx>,
1911     sig: &hir::FnSig<'_>,
1912     generics: &hir::Generics<'_>,
1913     def_id: LocalDefId,
1914     icx: &ItemCtxt<'tcx>,
1915 ) -> ty::PolyFnSig<'tcx> {
1916     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
1917
1918     match get_infer_ret_ty(&sig.decl.output) {
1919         Some(ty) => {
1920             let fn_sig = tcx.typeck(def_id).liberated_fn_sigs()[hir_id];
1921             // Typeck doesn't expect erased regions to be returned from `type_of`.
1922             let fn_sig = tcx.fold_regions(fn_sig, |r, _| match *r {
1923                 ty::ReErased => tcx.lifetimes.re_static,
1924                 _ => r,
1925             });
1926             let fn_sig = ty::Binder::dummy(fn_sig);
1927
1928             let mut visitor = HirPlaceholderCollector::default();
1929             visitor.visit_ty(ty);
1930             let mut diag = bad_placeholder(tcx, visitor.0, "return type");
1931             let ret_ty = fn_sig.skip_binder().output();
1932             if ret_ty.is_suggestable(tcx, false) {
1933                 diag.span_suggestion(
1934                     ty.span,
1935                     "replace with the correct return type",
1936                     ret_ty,
1937                     Applicability::MachineApplicable,
1938                 );
1939             } else if matches!(ret_ty.kind(), ty::FnDef(..)) {
1940                 let fn_sig = ret_ty.fn_sig(tcx);
1941                 if fn_sig
1942                     .skip_binder()
1943                     .inputs_and_output
1944                     .iter()
1945                     .all(|t| t.is_suggestable(tcx, false))
1946                 {
1947                     diag.span_suggestion(
1948                         ty.span,
1949                         "replace with the correct return type",
1950                         fn_sig,
1951                         Applicability::MachineApplicable,
1952                     );
1953                 }
1954             } else if ret_ty.is_closure() {
1955                 // We're dealing with a closure, so we should suggest using `impl Fn` or trait bounds
1956                 // to prevent the user from getting a papercut while trying to use the unique closure
1957                 // syntax (e.g. `[closure@src/lib.rs:2:5: 2:9]`).
1958                 diag.help("consider using an `Fn`, `FnMut`, or `FnOnce` trait bound");
1959                 diag.note("for more information on `Fn` traits and closure types, see https://doc.rust-lang.org/book/ch13-01-closures.html");
1960             }
1961             diag.emit();
1962
1963             fn_sig
1964         }
1965         None => <dyn AstConv<'_>>::ty_of_fn(
1966             icx,
1967             hir_id,
1968             sig.header.unsafety,
1969             sig.header.abi,
1970             sig.decl,
1971             Some(generics),
1972             None,
1973         ),
1974     }
1975 }
1976
1977 fn impl_trait_ref(tcx: TyCtxt<'_>, def_id: DefId) -> Option<ty::TraitRef<'_>> {
1978     let icx = ItemCtxt::new(tcx, def_id);
1979     match tcx.hir().expect_item(def_id.expect_local()).kind {
1980         hir::ItemKind::Impl(ref impl_) => impl_.of_trait.as_ref().map(|ast_trait_ref| {
1981             let selfty = tcx.type_of(def_id);
1982             <dyn AstConv<'_>>::instantiate_mono_trait_ref(&icx, ast_trait_ref, selfty)
1983         }),
1984         _ => bug!(),
1985     }
1986 }
1987
1988 fn impl_polarity(tcx: TyCtxt<'_>, def_id: DefId) -> ty::ImplPolarity {
1989     let is_rustc_reservation = tcx.has_attr(def_id, sym::rustc_reservation_impl);
1990     let item = tcx.hir().expect_item(def_id.expect_local());
1991     match &item.kind {
1992         hir::ItemKind::Impl(hir::Impl {
1993             polarity: hir::ImplPolarity::Negative(span),
1994             of_trait,
1995             ..
1996         }) => {
1997             if is_rustc_reservation {
1998                 let span = span.to(of_trait.as_ref().map_or(*span, |t| t.path.span));
1999                 tcx.sess.span_err(span, "reservation impls can't be negative");
2000             }
2001             ty::ImplPolarity::Negative
2002         }
2003         hir::ItemKind::Impl(hir::Impl {
2004             polarity: hir::ImplPolarity::Positive,
2005             of_trait: None,
2006             ..
2007         }) => {
2008             if is_rustc_reservation {
2009                 tcx.sess.span_err(item.span, "reservation impls can't be inherent");
2010             }
2011             ty::ImplPolarity::Positive
2012         }
2013         hir::ItemKind::Impl(hir::Impl {
2014             polarity: hir::ImplPolarity::Positive,
2015             of_trait: Some(_),
2016             ..
2017         }) => {
2018             if is_rustc_reservation {
2019                 ty::ImplPolarity::Reservation
2020             } else {
2021                 ty::ImplPolarity::Positive
2022             }
2023         }
2024         item => bug!("impl_polarity: {:?} not an impl", item),
2025     }
2026 }
2027
2028 /// Returns the early-bound lifetimes declared in this generics
2029 /// listing. For anything other than fns/methods, this is just all
2030 /// the lifetimes that are declared. For fns or methods, we have to
2031 /// screen out those that do not appear in any where-clauses etc using
2032 /// `resolve_lifetime::early_bound_lifetimes`.
2033 fn early_bound_lifetimes_from_generics<'a, 'tcx: 'a>(
2034     tcx: TyCtxt<'tcx>,
2035     generics: &'a hir::Generics<'a>,
2036 ) -> impl Iterator<Item = &'a hir::GenericParam<'a>> + Captures<'tcx> {
2037     generics.params.iter().filter(move |param| match param.kind {
2038         GenericParamKind::Lifetime { .. } => !tcx.is_late_bound(param.hir_id),
2039         _ => false,
2040     })
2041 }
2042
2043 /// Returns a list of type predicates for the definition with ID `def_id`, including inferred
2044 /// lifetime constraints. This includes all predicates returned by `explicit_predicates_of`, plus
2045 /// inferred constraints concerning which regions outlive other regions.
2046 #[instrument(level = "debug", skip(tcx))]
2047 fn predicates_defined_on(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2048     let mut result = tcx.explicit_predicates_of(def_id);
2049     debug!("predicates_defined_on: explicit_predicates_of({:?}) = {:?}", def_id, result,);
2050     let inferred_outlives = tcx.inferred_outlives_of(def_id);
2051     if !inferred_outlives.is_empty() {
2052         debug!(
2053             "predicates_defined_on: inferred_outlives_of({:?}) = {:?}",
2054             def_id, inferred_outlives,
2055         );
2056         if result.predicates.is_empty() {
2057             result.predicates = inferred_outlives;
2058         } else {
2059             result.predicates = tcx
2060                 .arena
2061                 .alloc_from_iter(result.predicates.iter().chain(inferred_outlives).copied());
2062         }
2063     }
2064
2065     debug!("predicates_defined_on({:?}) = {:?}", def_id, result);
2066     result
2067 }
2068
2069 /// Returns a list of all type predicates (explicit and implicit) for the definition with
2070 /// ID `def_id`. This includes all predicates returned by `predicates_defined_on`, plus
2071 /// `Self: Trait` predicates for traits.
2072 fn predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2073     let mut result = tcx.predicates_defined_on(def_id);
2074
2075     if tcx.is_trait(def_id) {
2076         // For traits, add `Self: Trait` predicate. This is
2077         // not part of the predicates that a user writes, but it
2078         // is something that one must prove in order to invoke a
2079         // method or project an associated type.
2080         //
2081         // In the chalk setup, this predicate is not part of the
2082         // "predicates" for a trait item. But it is useful in
2083         // rustc because if you directly (e.g.) invoke a trait
2084         // method like `Trait::method(...)`, you must naturally
2085         // prove that the trait applies to the types that were
2086         // used, and adding the predicate into this list ensures
2087         // that this is done.
2088         //
2089         // We use a DUMMY_SP here as a way to signal trait bounds that come
2090         // from the trait itself that *shouldn't* be shown as the source of
2091         // an obligation and instead be skipped. Otherwise we'd use
2092         // `tcx.def_span(def_id);`
2093
2094         let constness = if tcx.has_attr(def_id, sym::const_trait) {
2095             ty::BoundConstness::ConstIfConst
2096         } else {
2097             ty::BoundConstness::NotConst
2098         };
2099
2100         let span = rustc_span::DUMMY_SP;
2101         result.predicates =
2102             tcx.arena.alloc_from_iter(result.predicates.iter().copied().chain(std::iter::once((
2103                 ty::TraitRef::identity(tcx, def_id).with_constness(constness).to_predicate(tcx),
2104                 span,
2105             ))));
2106     }
2107     debug!("predicates_of(def_id={:?}) = {:?}", def_id, result);
2108     result
2109 }
2110
2111 /// Returns a list of user-specified type predicates for the definition with ID `def_id`.
2112 /// N.B., this does not include any implied/inferred constraints.
2113 #[instrument(level = "trace", skip(tcx), ret)]
2114 fn gather_explicit_predicates_of(tcx: TyCtxt<'_>, def_id: DefId) -> ty::GenericPredicates<'_> {
2115     use rustc_hir::*;
2116
2117     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
2118     let node = tcx.hir().get(hir_id);
2119
2120     let mut is_trait = None;
2121     let mut is_default_impl_trait = None;
2122
2123     let icx = ItemCtxt::new(tcx, def_id);
2124
2125     const NO_GENERICS: &hir::Generics<'_> = hir::Generics::empty();
2126
2127     // We use an `IndexSet` to preserves order of insertion.
2128     // Preserving the order of insertion is important here so as not to break UI tests.
2129     let mut predicates: FxIndexSet<(ty::Predicate<'_>, Span)> = FxIndexSet::default();
2130
2131     let ast_generics = match node {
2132         Node::TraitItem(item) => item.generics,
2133
2134         Node::ImplItem(item) => item.generics,
2135
2136         Node::Item(item) => {
2137             match item.kind {
2138                 ItemKind::Impl(ref impl_) => {
2139                     if impl_.defaultness.is_default() {
2140                         is_default_impl_trait = tcx.impl_trait_ref(def_id).map(ty::Binder::dummy);
2141                     }
2142                     &impl_.generics
2143                 }
2144                 ItemKind::Fn(.., ref generics, _)
2145                 | ItemKind::TyAlias(_, ref generics)
2146                 | ItemKind::Enum(_, ref generics)
2147                 | ItemKind::Struct(_, ref generics)
2148                 | ItemKind::Union(_, ref generics) => *generics,
2149
2150                 ItemKind::Trait(_, _, ref generics, ..) => {
2151                     is_trait = Some(ty::TraitRef::identity(tcx, def_id));
2152                     *generics
2153                 }
2154                 ItemKind::TraitAlias(ref generics, _) => {
2155                     is_trait = Some(ty::TraitRef::identity(tcx, def_id));
2156                     *generics
2157                 }
2158                 ItemKind::OpaqueTy(OpaqueTy {
2159                     origin: hir::OpaqueTyOrigin::AsyncFn(..) | hir::OpaqueTyOrigin::FnReturn(..),
2160                     ..
2161                 }) => {
2162                     // return-position impl trait
2163                     //
2164                     // We don't inherit predicates from the parent here:
2165                     // If we have, say `fn f<'a, T: 'a>() -> impl Sized {}`
2166                     // then the return type is `f::<'static, T>::{{opaque}}`.
2167                     //
2168                     // If we inherited the predicates of `f` then we would
2169                     // require that `T: 'static` to show that the return
2170                     // type is well-formed.
2171                     //
2172                     // The only way to have something with this opaque type
2173                     // is from the return type of the containing function,
2174                     // which will ensure that the function's predicates
2175                     // hold.
2176                     return ty::GenericPredicates { parent: None, predicates: &[] };
2177                 }
2178                 ItemKind::OpaqueTy(OpaqueTy {
2179                     ref generics,
2180                     origin: hir::OpaqueTyOrigin::TyAlias,
2181                     ..
2182                 }) => {
2183                     // type-alias impl trait
2184                     generics
2185                 }
2186
2187                 _ => NO_GENERICS,
2188             }
2189         }
2190
2191         Node::ForeignItem(item) => match item.kind {
2192             ForeignItemKind::Static(..) => NO_GENERICS,
2193             ForeignItemKind::Fn(_, _, ref generics) => *generics,
2194             ForeignItemKind::Type => NO_GENERICS,
2195         },
2196
2197         _ => NO_GENERICS,
2198     };
2199
2200     let generics = tcx.generics_of(def_id);
2201     let parent_count = generics.parent_count as u32;
2202     let has_own_self = generics.has_self && parent_count == 0;
2203
2204     // Below we'll consider the bounds on the type parameters (including `Self`)
2205     // and the explicit where-clauses, but to get the full set of predicates
2206     // on a trait we need to add in the supertrait bounds and bounds found on
2207     // associated types.
2208     if let Some(_trait_ref) = is_trait {
2209         predicates.extend(tcx.super_predicates_of(def_id).predicates.iter().cloned());
2210     }
2211
2212     // In default impls, we can assume that the self type implements
2213     // the trait. So in:
2214     //
2215     //     default impl Foo for Bar { .. }
2216     //
2217     // we add a default where clause `Foo: Bar`. We do a similar thing for traits
2218     // (see below). Recall that a default impl is not itself an impl, but rather a
2219     // set of defaults that can be incorporated into another impl.
2220     if let Some(trait_ref) = is_default_impl_trait {
2221         predicates.insert((trait_ref.without_const().to_predicate(tcx), tcx.def_span(def_id)));
2222     }
2223
2224     // Collect the region predicates that were declared inline as
2225     // well. In the case of parameters declared on a fn or method, we
2226     // have to be careful to only iterate over early-bound regions.
2227     let mut index = parent_count
2228         + has_own_self as u32
2229         + early_bound_lifetimes_from_generics(tcx, ast_generics).count() as u32;
2230
2231     trace!(?predicates);
2232     trace!(?ast_generics);
2233
2234     // Collect the predicates that were written inline by the user on each
2235     // type parameter (e.g., `<T: Foo>`).
2236     for param in ast_generics.params {
2237         match param.kind {
2238             // We already dealt with early bound lifetimes above.
2239             GenericParamKind::Lifetime { .. } => (),
2240             GenericParamKind::Type { .. } => {
2241                 let name = param.name.ident().name;
2242                 let param_ty = ty::ParamTy::new(index, name).to_ty(tcx);
2243                 index += 1;
2244
2245                 let mut bounds = Bounds::default();
2246                 // Params are implicitly sized unless a `?Sized` bound is found
2247                 <dyn AstConv<'_>>::add_implicitly_sized(
2248                     &icx,
2249                     &mut bounds,
2250                     &[],
2251                     Some((param.hir_id, ast_generics.predicates)),
2252                     param.span,
2253                 );
2254                 trace!(?bounds);
2255                 predicates.extend(bounds.predicates(tcx, param_ty));
2256                 trace!(?predicates);
2257             }
2258             GenericParamKind::Const { .. } => {
2259                 // Bounds on const parameters are currently not possible.
2260                 index += 1;
2261             }
2262         }
2263     }
2264
2265     trace!(?predicates);
2266     // Add in the bounds that appear in the where-clause.
2267     for predicate in ast_generics.predicates {
2268         match predicate {
2269             hir::WherePredicate::BoundPredicate(bound_pred) => {
2270                 let ty = icx.to_ty(bound_pred.bounded_ty);
2271                 let bound_vars = icx.tcx.late_bound_vars(bound_pred.bounded_ty.hir_id);
2272
2273                 // Keep the type around in a dummy predicate, in case of no bounds.
2274                 // That way, `where Ty:` is not a complete noop (see #53696) and `Ty`
2275                 // is still checked for WF.
2276                 if bound_pred.bounds.is_empty() {
2277                     if let ty::Param(_) = ty.kind() {
2278                         // This is a `where T:`, which can be in the HIR from the
2279                         // transformation that moves `?Sized` to `T`'s declaration.
2280                         // We can skip the predicate because type parameters are
2281                         // trivially WF, but also we *should*, to avoid exposing
2282                         // users who never wrote `where Type:,` themselves, to
2283                         // compiler/tooling bugs from not handling WF predicates.
2284                     } else {
2285                         let span = bound_pred.bounded_ty.span;
2286                         let predicate = ty::Binder::bind_with_vars(
2287                             ty::PredicateKind::WellFormed(ty.into()),
2288                             bound_vars,
2289                         );
2290                         predicates.insert((predicate.to_predicate(tcx), span));
2291                     }
2292                 }
2293
2294                 let mut bounds = Bounds::default();
2295                 <dyn AstConv<'_>>::add_bounds(
2296                     &icx,
2297                     ty,
2298                     bound_pred.bounds.iter(),
2299                     &mut bounds,
2300                     bound_vars,
2301                 );
2302                 predicates.extend(bounds.predicates(tcx, ty));
2303             }
2304
2305             hir::WherePredicate::RegionPredicate(region_pred) => {
2306                 let r1 = <dyn AstConv<'_>>::ast_region_to_region(&icx, &region_pred.lifetime, None);
2307                 predicates.extend(region_pred.bounds.iter().map(|bound| {
2308                     let (r2, span) = match bound {
2309                         hir::GenericBound::Outlives(lt) => {
2310                             (<dyn AstConv<'_>>::ast_region_to_region(&icx, lt, None), lt.span)
2311                         }
2312                         _ => bug!(),
2313                     };
2314                     let pred = ty::Binder::dummy(ty::PredicateKind::RegionOutlives(
2315                         ty::OutlivesPredicate(r1, r2),
2316                     ))
2317                     .to_predicate(icx.tcx);
2318
2319                     (pred, span)
2320                 }))
2321             }
2322
2323             hir::WherePredicate::EqPredicate(..) => {
2324                 // FIXME(#20041)
2325             }
2326         }
2327     }
2328
2329     if tcx.features().generic_const_exprs {
2330         predicates.extend(const_evaluatable_predicates_of(tcx, def_id.expect_local()));
2331     }
2332
2333     let mut predicates: Vec<_> = predicates.into_iter().collect();
2334
2335     // Subtle: before we store the predicates into the tcx, we
2336     // sort them so that predicates like `T: Foo<Item=U>` come
2337     // before uses of `U`.  This avoids false ambiguity errors
2338     // in trait checking. See `setup_constraining_predicates`
2339     // for details.
2340     if let Node::Item(&Item { kind: ItemKind::Impl { .. }, .. }) = node {
2341         let self_ty = tcx.type_of(def_id);
2342         let trait_ref = tcx.impl_trait_ref(def_id);
2343         cgp::setup_constraining_predicates(
2344             tcx,
2345             &mut predicates,
2346             trait_ref,
2347             &mut cgp::parameters_for_impl(self_ty, trait_ref),
2348         );
2349     }
2350
2351     ty::GenericPredicates {
2352         parent: generics.parent,
2353         predicates: tcx.arena.alloc_from_iter(predicates),
2354     }
2355 }
2356
2357 fn const_evaluatable_predicates_of<'tcx>(
2358     tcx: TyCtxt<'tcx>,
2359     def_id: LocalDefId,
2360 ) -> FxIndexSet<(ty::Predicate<'tcx>, Span)> {
2361     struct ConstCollector<'tcx> {
2362         tcx: TyCtxt<'tcx>,
2363         preds: FxIndexSet<(ty::Predicate<'tcx>, Span)>,
2364     }
2365
2366     impl<'tcx> intravisit::Visitor<'tcx> for ConstCollector<'tcx> {
2367         fn visit_anon_const(&mut self, c: &'tcx hir::AnonConst) {
2368             let def_id = self.tcx.hir().local_def_id(c.hir_id);
2369             let ct = ty::Const::from_anon_const(self.tcx, def_id);
2370             if let ty::ConstKind::Unevaluated(uv) = ct.kind() {
2371                 assert_eq!(uv.promoted, None);
2372                 let span = self.tcx.hir().span(c.hir_id);
2373                 self.preds.insert((
2374                     ty::Binder::dummy(ty::PredicateKind::ConstEvaluatable(uv.shrink()))
2375                         .to_predicate(self.tcx),
2376                     span,
2377                 ));
2378             }
2379         }
2380
2381         fn visit_const_param_default(&mut self, _param: HirId, _ct: &'tcx hir::AnonConst) {
2382             // Do not look into const param defaults,
2383             // these get checked when they are actually instantiated.
2384             //
2385             // We do not want the following to error:
2386             //
2387             //     struct Foo<const N: usize, const M: usize = { N + 1 }>;
2388             //     struct Bar<const N: usize>(Foo<N, 3>);
2389         }
2390     }
2391
2392     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
2393     let node = tcx.hir().get(hir_id);
2394
2395     let mut collector = ConstCollector { tcx, preds: FxIndexSet::default() };
2396     if let hir::Node::Item(item) = node && let hir::ItemKind::Impl(ref impl_) = item.kind {
2397         if let Some(of_trait) = &impl_.of_trait {
2398             debug!("const_evaluatable_predicates_of({:?}): visit impl trait_ref", def_id);
2399             collector.visit_trait_ref(of_trait);
2400         }
2401
2402         debug!("const_evaluatable_predicates_of({:?}): visit_self_ty", def_id);
2403         collector.visit_ty(impl_.self_ty);
2404     }
2405
2406     if let Some(generics) = node.generics() {
2407         debug!("const_evaluatable_predicates_of({:?}): visit_generics", def_id);
2408         collector.visit_generics(generics);
2409     }
2410
2411     if let Some(fn_sig) = tcx.hir().fn_sig_by_hir_id(hir_id) {
2412         debug!("const_evaluatable_predicates_of({:?}): visit_fn_decl", def_id);
2413         collector.visit_fn_decl(fn_sig.decl);
2414     }
2415     debug!("const_evaluatable_predicates_of({:?}) = {:?}", def_id, collector.preds);
2416
2417     collector.preds
2418 }
2419
2420 fn trait_explicit_predicates_and_bounds(
2421     tcx: TyCtxt<'_>,
2422     def_id: LocalDefId,
2423 ) -> ty::GenericPredicates<'_> {
2424     assert_eq!(tcx.def_kind(def_id), DefKind::Trait);
2425     gather_explicit_predicates_of(tcx, def_id.to_def_id())
2426 }
2427
2428 fn explicit_predicates_of<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId) -> ty::GenericPredicates<'tcx> {
2429     let def_kind = tcx.def_kind(def_id);
2430     if let DefKind::Trait = def_kind {
2431         // Remove bounds on associated types from the predicates, they will be
2432         // returned by `explicit_item_bounds`.
2433         let predicates_and_bounds = tcx.trait_explicit_predicates_and_bounds(def_id.expect_local());
2434         let trait_identity_substs = InternalSubsts::identity_for_item(tcx, def_id);
2435
2436         let is_assoc_item_ty = |ty: Ty<'tcx>| {
2437             // For a predicate from a where clause to become a bound on an
2438             // associated type:
2439             // * It must use the identity substs of the item.
2440             //     * Since any generic parameters on the item are not in scope,
2441             //       this means that the item is not a GAT, and its identity
2442             //       substs are the same as the trait's.
2443             // * It must be an associated type for this trait (*not* a
2444             //   supertrait).
2445             if let ty::Projection(projection) = ty.kind() {
2446                 projection.substs == trait_identity_substs
2447                     && tcx.associated_item(projection.item_def_id).container_id(tcx) == def_id
2448             } else {
2449                 false
2450             }
2451         };
2452
2453         let predicates: Vec<_> = predicates_and_bounds
2454             .predicates
2455             .iter()
2456             .copied()
2457             .filter(|(pred, _)| match pred.kind().skip_binder() {
2458                 ty::PredicateKind::Trait(tr) => !is_assoc_item_ty(tr.self_ty()),
2459                 ty::PredicateKind::Projection(proj) => {
2460                     !is_assoc_item_ty(proj.projection_ty.self_ty())
2461                 }
2462                 ty::PredicateKind::TypeOutlives(outlives) => !is_assoc_item_ty(outlives.0),
2463                 _ => true,
2464             })
2465             .collect();
2466         if predicates.len() == predicates_and_bounds.predicates.len() {
2467             predicates_and_bounds
2468         } else {
2469             ty::GenericPredicates {
2470                 parent: predicates_and_bounds.parent,
2471                 predicates: tcx.arena.alloc_slice(&predicates),
2472             }
2473         }
2474     } else {
2475         if matches!(def_kind, DefKind::AnonConst) && tcx.lazy_normalization() {
2476             let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
2477             if tcx.hir().opt_const_param_default_param_hir_id(hir_id).is_some() {
2478                 // In `generics_of` we set the generics' parent to be our parent's parent which means that
2479                 // we lose out on the predicates of our actual parent if we dont return those predicates here.
2480                 // (See comment in `generics_of` for more information on why the parent shenanigans is necessary)
2481                 //
2482                 // struct Foo<T, const N: usize = { <T as Trait>::ASSOC }>(T) where T: Trait;
2483                 //        ^^^                     ^^^^^^^^^^^^^^^^^^^^^^^ the def id we are calling
2484                 //        ^^^                                             explicit_predicates_of on
2485                 //        parent item we dont have set as the
2486                 //        parent of generics returned by `generics_of`
2487                 //
2488                 // In the above code we want the anon const to have predicates in its param env for `T: Trait`
2489                 let item_def_id = tcx.hir().get_parent_item(hir_id);
2490                 // In the above code example we would be calling `explicit_predicates_of(Foo)` here
2491                 return tcx.explicit_predicates_of(item_def_id);
2492             }
2493         }
2494         gather_explicit_predicates_of(tcx, def_id)
2495     }
2496 }
2497
2498 /// Converts a specific `GenericBound` from the AST into a set of
2499 /// predicates that apply to the self type. A vector is returned
2500 /// because this can be anywhere from zero predicates (`T: ?Sized` adds no
2501 /// predicates) to one (`T: Foo`) to many (`T: Bar<X = i32>` adds `T: Bar`
2502 /// and `<T as Bar>::X == i32`).
2503 fn predicates_from_bound<'tcx>(
2504     astconv: &dyn AstConv<'tcx>,
2505     param_ty: Ty<'tcx>,
2506     bound: &'tcx hir::GenericBound<'tcx>,
2507     bound_vars: &'tcx ty::List<ty::BoundVariableKind>,
2508 ) -> Vec<(ty::Predicate<'tcx>, Span)> {
2509     let mut bounds = Bounds::default();
2510     astconv.add_bounds(param_ty, [bound].into_iter(), &mut bounds, bound_vars);
2511     bounds.predicates(astconv.tcx(), param_ty).collect()
2512 }
2513
2514 fn compute_sig_of_foreign_fn_decl<'tcx>(
2515     tcx: TyCtxt<'tcx>,
2516     def_id: DefId,
2517     decl: &'tcx hir::FnDecl<'tcx>,
2518     abi: abi::Abi,
2519 ) -> ty::PolyFnSig<'tcx> {
2520     let unsafety = if abi == abi::Abi::RustIntrinsic {
2521         intrinsic_operation_unsafety(tcx.item_name(def_id))
2522     } else {
2523         hir::Unsafety::Unsafe
2524     };
2525     let hir_id = tcx.hir().local_def_id_to_hir_id(def_id.expect_local());
2526     let fty = <dyn AstConv<'_>>::ty_of_fn(
2527         &ItemCtxt::new(tcx, def_id),
2528         hir_id,
2529         unsafety,
2530         abi,
2531         decl,
2532         None,
2533         None,
2534     );
2535
2536     // Feature gate SIMD types in FFI, since I am not sure that the
2537     // ABIs are handled at all correctly. -huonw
2538     if abi != abi::Abi::RustIntrinsic
2539         && abi != abi::Abi::PlatformIntrinsic
2540         && !tcx.features().simd_ffi
2541     {
2542         let check = |ast_ty: &hir::Ty<'_>, ty: Ty<'_>| {
2543             if ty.is_simd() {
2544                 let snip = tcx
2545                     .sess
2546                     .source_map()
2547                     .span_to_snippet(ast_ty.span)
2548                     .map_or_else(|_| String::new(), |s| format!(" `{}`", s));
2549                 tcx.sess
2550                     .struct_span_err(
2551                         ast_ty.span,
2552                         &format!(
2553                             "use of SIMD type{} in FFI is highly experimental and \
2554                              may result in invalid code",
2555                             snip
2556                         ),
2557                     )
2558                     .help("add `#![feature(simd_ffi)]` to the crate attributes to enable")
2559                     .emit();
2560             }
2561         };
2562         for (input, ty) in iter::zip(decl.inputs, fty.inputs().skip_binder()) {
2563             check(input, *ty)
2564         }
2565         if let hir::FnRetTy::Return(ref ty) = decl.output {
2566             check(ty, fty.output().skip_binder())
2567         }
2568     }
2569
2570     fty
2571 }
2572
2573 fn is_foreign_item(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
2574     match tcx.hir().get_if_local(def_id) {
2575         Some(Node::ForeignItem(..)) => true,
2576         Some(_) => false,
2577         _ => bug!("is_foreign_item applied to non-local def-id {:?}", def_id),
2578     }
2579 }
2580
2581 fn generator_kind(tcx: TyCtxt<'_>, def_id: DefId) -> Option<hir::GeneratorKind> {
2582     match tcx.hir().get_if_local(def_id) {
2583         Some(Node::Expr(&rustc_hir::Expr {
2584             kind: rustc_hir::ExprKind::Closure(&rustc_hir::Closure { body, .. }),
2585             ..
2586         })) => tcx.hir().body(body).generator_kind(),
2587         Some(_) => None,
2588         _ => bug!("generator_kind applied to non-local def-id {:?}", def_id),
2589     }
2590 }
2591
2592 fn from_target_feature(
2593     tcx: TyCtxt<'_>,
2594     attr: &ast::Attribute,
2595     supported_target_features: &FxHashMap<String, Option<Symbol>>,
2596     target_features: &mut Vec<Symbol>,
2597 ) {
2598     let Some(list) = attr.meta_item_list() else { return };
2599     let bad_item = |span| {
2600         let msg = "malformed `target_feature` attribute input";
2601         let code = "enable = \"..\"";
2602         tcx.sess
2603             .struct_span_err(span, msg)
2604             .span_suggestion(span, "must be of the form", code, Applicability::HasPlaceholders)
2605             .emit();
2606     };
2607     let rust_features = tcx.features();
2608     for item in list {
2609         // Only `enable = ...` is accepted in the meta-item list.
2610         if !item.has_name(sym::enable) {
2611             bad_item(item.span());
2612             continue;
2613         }
2614
2615         // Must be of the form `enable = "..."` (a string).
2616         let Some(value) = item.value_str() else {
2617             bad_item(item.span());
2618             continue;
2619         };
2620
2621         // We allow comma separation to enable multiple features.
2622         target_features.extend(value.as_str().split(',').filter_map(|feature| {
2623             let Some(feature_gate) = supported_target_features.get(feature) else {
2624                 let msg =
2625                     format!("the feature named `{}` is not valid for this target", feature);
2626                 let mut err = tcx.sess.struct_span_err(item.span(), &msg);
2627                 err.span_label(
2628                     item.span(),
2629                     format!("`{}` is not valid for this target", feature),
2630                 );
2631                 if let Some(stripped) = feature.strip_prefix('+') {
2632                     let valid = supported_target_features.contains_key(stripped);
2633                     if valid {
2634                         err.help("consider removing the leading `+` in the feature name");
2635                     }
2636                 }
2637                 err.emit();
2638                 return None;
2639             };
2640
2641             // Only allow features whose feature gates have been enabled.
2642             let allowed = match feature_gate.as_ref().copied() {
2643                 Some(sym::arm_target_feature) => rust_features.arm_target_feature,
2644                 Some(sym::hexagon_target_feature) => rust_features.hexagon_target_feature,
2645                 Some(sym::powerpc_target_feature) => rust_features.powerpc_target_feature,
2646                 Some(sym::mips_target_feature) => rust_features.mips_target_feature,
2647                 Some(sym::riscv_target_feature) => rust_features.riscv_target_feature,
2648                 Some(sym::avx512_target_feature) => rust_features.avx512_target_feature,
2649                 Some(sym::sse4a_target_feature) => rust_features.sse4a_target_feature,
2650                 Some(sym::tbm_target_feature) => rust_features.tbm_target_feature,
2651                 Some(sym::wasm_target_feature) => rust_features.wasm_target_feature,
2652                 Some(sym::cmpxchg16b_target_feature) => rust_features.cmpxchg16b_target_feature,
2653                 Some(sym::movbe_target_feature) => rust_features.movbe_target_feature,
2654                 Some(sym::rtm_target_feature) => rust_features.rtm_target_feature,
2655                 Some(sym::f16c_target_feature) => rust_features.f16c_target_feature,
2656                 Some(sym::ermsb_target_feature) => rust_features.ermsb_target_feature,
2657                 Some(sym::bpf_target_feature) => rust_features.bpf_target_feature,
2658                 Some(sym::aarch64_ver_target_feature) => rust_features.aarch64_ver_target_feature,
2659                 Some(name) => bug!("unknown target feature gate {}", name),
2660                 None => true,
2661             };
2662             if !allowed {
2663                 feature_err(
2664                     &tcx.sess.parse_sess,
2665                     feature_gate.unwrap(),
2666                     item.span(),
2667                     &format!("the target feature `{}` is currently unstable", feature),
2668                 )
2669                 .emit();
2670             }
2671             Some(Symbol::intern(feature))
2672         }));
2673     }
2674 }
2675
2676 fn linkage_by_name(tcx: TyCtxt<'_>, def_id: LocalDefId, name: &str) -> Linkage {
2677     use rustc_middle::mir::mono::Linkage::*;
2678
2679     // Use the names from src/llvm/docs/LangRef.rst here. Most types are only
2680     // applicable to variable declarations and may not really make sense for
2681     // Rust code in the first place but allow them anyway and trust that the
2682     // user knows what they're doing. Who knows, unanticipated use cases may pop
2683     // up in the future.
2684     //
2685     // ghost, dllimport, dllexport and linkonce_odr_autohide are not supported
2686     // and don't have to be, LLVM treats them as no-ops.
2687     match name {
2688         "appending" => Appending,
2689         "available_externally" => AvailableExternally,
2690         "common" => Common,
2691         "extern_weak" => ExternalWeak,
2692         "external" => External,
2693         "internal" => Internal,
2694         "linkonce" => LinkOnceAny,
2695         "linkonce_odr" => LinkOnceODR,
2696         "private" => Private,
2697         "weak" => WeakAny,
2698         "weak_odr" => WeakODR,
2699         _ => tcx.sess.span_fatal(tcx.def_span(def_id), "invalid linkage specified"),
2700     }
2701 }
2702
2703 fn codegen_fn_attrs(tcx: TyCtxt<'_>, did: DefId) -> CodegenFnAttrs {
2704     if cfg!(debug_assertions) {
2705         let def_kind = tcx.def_kind(did);
2706         assert!(
2707             def_kind.has_codegen_attrs(),
2708             "unexpected `def_kind` in `codegen_fn_attrs`: {def_kind:?}",
2709         );
2710     }
2711
2712     let did = did.expect_local();
2713     let attrs = tcx.hir().attrs(tcx.hir().local_def_id_to_hir_id(did));
2714     let mut codegen_fn_attrs = CodegenFnAttrs::new();
2715     if tcx.should_inherit_track_caller(did) {
2716         codegen_fn_attrs.flags |= CodegenFnAttrFlags::TRACK_CALLER;
2717     }
2718
2719     // The panic_no_unwind function called by TerminatorKind::Abort will never
2720     // unwind. If the panic handler that it invokes unwind then it will simply
2721     // call the panic handler again.
2722     if Some(did.to_def_id()) == tcx.lang_items().panic_no_unwind() {
2723         codegen_fn_attrs.flags |= CodegenFnAttrFlags::NEVER_UNWIND;
2724     }
2725
2726     let supported_target_features = tcx.supported_target_features(LOCAL_CRATE);
2727
2728     let mut inline_span = None;
2729     let mut link_ordinal_span = None;
2730     let mut no_sanitize_span = None;
2731     for attr in attrs.iter() {
2732         if attr.has_name(sym::cold) {
2733             codegen_fn_attrs.flags |= CodegenFnAttrFlags::COLD;
2734         } else if attr.has_name(sym::rustc_allocator) {
2735             codegen_fn_attrs.flags |= CodegenFnAttrFlags::ALLOCATOR;
2736         } else if attr.has_name(sym::ffi_returns_twice) {
2737             if tcx.is_foreign_item(did) {
2738                 codegen_fn_attrs.flags |= CodegenFnAttrFlags::FFI_RETURNS_TWICE;
2739             } else {
2740                 // `#[ffi_returns_twice]` is only allowed `extern fn`s.
2741                 struct_span_err!(
2742                     tcx.sess,
2743                     attr.span,
2744                     E0724,
2745                     "`#[ffi_returns_twice]` may only be used on foreign functions"
2746                 )
2747                 .emit();
2748             }
2749         } else if attr.has_name(sym::ffi_pure) {
2750             if tcx.is_foreign_item(did) {
2751                 if attrs.iter().any(|a| a.has_name(sym::ffi_const)) {
2752                     // `#[ffi_const]` functions cannot be `#[ffi_pure]`
2753                     struct_span_err!(
2754                         tcx.sess,
2755                         attr.span,
2756                         E0757,
2757                         "`#[ffi_const]` function cannot be `#[ffi_pure]`"
2758                     )
2759                     .emit();
2760                 } else {
2761                     codegen_fn_attrs.flags |= CodegenFnAttrFlags::FFI_PURE;
2762                 }
2763             } else {
2764                 // `#[ffi_pure]` is only allowed on foreign functions
2765                 struct_span_err!(
2766                     tcx.sess,
2767                     attr.span,
2768                     E0755,
2769                     "`#[ffi_pure]` may only be used on foreign functions"
2770                 )
2771                 .emit();
2772             }
2773         } else if attr.has_name(sym::ffi_const) {
2774             if tcx.is_foreign_item(did) {
2775                 codegen_fn_attrs.flags |= CodegenFnAttrFlags::FFI_CONST;
2776             } else {
2777                 // `#[ffi_const]` is only allowed on foreign functions
2778                 struct_span_err!(
2779                     tcx.sess,
2780                     attr.span,
2781                     E0756,
2782                     "`#[ffi_const]` may only be used on foreign functions"
2783                 )
2784                 .emit();
2785             }
2786         } else if attr.has_name(sym::rustc_allocator_nounwind) {
2787             codegen_fn_attrs.flags |= CodegenFnAttrFlags::NEVER_UNWIND;
2788         } else if attr.has_name(sym::rustc_reallocator) {
2789             codegen_fn_attrs.flags |= CodegenFnAttrFlags::REALLOCATOR;
2790         } else if attr.has_name(sym::rustc_deallocator) {
2791             codegen_fn_attrs.flags |= CodegenFnAttrFlags::DEALLOCATOR;
2792         } else if attr.has_name(sym::rustc_allocator_zeroed) {
2793             codegen_fn_attrs.flags |= CodegenFnAttrFlags::ALLOCATOR_ZEROED;
2794         } else if attr.has_name(sym::naked) {
2795             codegen_fn_attrs.flags |= CodegenFnAttrFlags::NAKED;
2796         } else if attr.has_name(sym::no_mangle) {
2797             codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
2798         } else if attr.has_name(sym::no_coverage) {
2799             codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_COVERAGE;
2800         } else if attr.has_name(sym::rustc_std_internal_symbol) {
2801             codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
2802         } else if attr.has_name(sym::used) {
2803             let inner = attr.meta_item_list();
2804             match inner.as_deref() {
2805                 Some([item]) if item.has_name(sym::linker) => {
2806                     if !tcx.features().used_with_arg {
2807                         feature_err(
2808                             &tcx.sess.parse_sess,
2809                             sym::used_with_arg,
2810                             attr.span,
2811                             "`#[used(linker)]` is currently unstable",
2812                         )
2813                         .emit();
2814                     }
2815                     codegen_fn_attrs.flags |= CodegenFnAttrFlags::USED_LINKER;
2816                 }
2817                 Some([item]) if item.has_name(sym::compiler) => {
2818                     if !tcx.features().used_with_arg {
2819                         feature_err(
2820                             &tcx.sess.parse_sess,
2821                             sym::used_with_arg,
2822                             attr.span,
2823                             "`#[used(compiler)]` is currently unstable",
2824                         )
2825                         .emit();
2826                     }
2827                     codegen_fn_attrs.flags |= CodegenFnAttrFlags::USED;
2828                 }
2829                 Some(_) => {
2830                     tcx.sess.emit_err(errors::ExpectedUsedSymbol { span: attr.span });
2831                 }
2832                 None => {
2833                     // Unfortunately, unconditionally using `llvm.used` causes
2834                     // issues in handling `.init_array` with the gold linker,
2835                     // but using `llvm.compiler.used` caused a nontrival amount
2836                     // of unintentional ecosystem breakage -- particularly on
2837                     // Mach-O targets.
2838                     //
2839                     // As a result, we emit `llvm.compiler.used` only on ELF
2840                     // targets. This is somewhat ad-hoc, but actually follows
2841                     // our pre-LLVM 13 behavior (prior to the ecosystem
2842                     // breakage), and seems to match `clang`'s behavior as well
2843                     // (both before and after LLVM 13), possibly because they
2844                     // have similar compatibility concerns to us. See
2845                     // https://github.com/rust-lang/rust/issues/47384#issuecomment-1019080146
2846                     // and following comments for some discussion of this, as
2847                     // well as the comments in `rustc_codegen_llvm` where these
2848                     // flags are handled.
2849                     //
2850                     // Anyway, to be clear: this is still up in the air
2851                     // somewhat, and is subject to change in the future (which
2852                     // is a good thing, because this would ideally be a bit
2853                     // more firmed up).
2854                     let is_like_elf = !(tcx.sess.target.is_like_osx
2855                         || tcx.sess.target.is_like_windows
2856                         || tcx.sess.target.is_like_wasm);
2857                     codegen_fn_attrs.flags |= if is_like_elf {
2858                         CodegenFnAttrFlags::USED
2859                     } else {
2860                         CodegenFnAttrFlags::USED_LINKER
2861                     };
2862                 }
2863             }
2864         } else if attr.has_name(sym::cmse_nonsecure_entry) {
2865             if !matches!(tcx.fn_sig(did).abi(), abi::Abi::C { .. }) {
2866                 struct_span_err!(
2867                     tcx.sess,
2868                     attr.span,
2869                     E0776,
2870                     "`#[cmse_nonsecure_entry]` requires C ABI"
2871                 )
2872                 .emit();
2873             }
2874             if !tcx.sess.target.llvm_target.contains("thumbv8m") {
2875                 struct_span_err!(tcx.sess, attr.span, E0775, "`#[cmse_nonsecure_entry]` is only valid for targets with the TrustZone-M extension")
2876                     .emit();
2877             }
2878             codegen_fn_attrs.flags |= CodegenFnAttrFlags::CMSE_NONSECURE_ENTRY;
2879         } else if attr.has_name(sym::thread_local) {
2880             codegen_fn_attrs.flags |= CodegenFnAttrFlags::THREAD_LOCAL;
2881         } else if attr.has_name(sym::track_caller) {
2882             if !tcx.is_closure(did.to_def_id()) && tcx.fn_sig(did).abi() != abi::Abi::Rust {
2883                 struct_span_err!(tcx.sess, attr.span, E0737, "`#[track_caller]` requires Rust ABI")
2884                     .emit();
2885             }
2886             if tcx.is_closure(did.to_def_id()) && !tcx.features().closure_track_caller {
2887                 feature_err(
2888                     &tcx.sess.parse_sess,
2889                     sym::closure_track_caller,
2890                     attr.span,
2891                     "`#[track_caller]` on closures is currently unstable",
2892                 )
2893                 .emit();
2894             }
2895             codegen_fn_attrs.flags |= CodegenFnAttrFlags::TRACK_CALLER;
2896         } else if attr.has_name(sym::export_name) {
2897             if let Some(s) = attr.value_str() {
2898                 if s.as_str().contains('\0') {
2899                     // `#[export_name = ...]` will be converted to a null-terminated string,
2900                     // so it may not contain any null characters.
2901                     struct_span_err!(
2902                         tcx.sess,
2903                         attr.span,
2904                         E0648,
2905                         "`export_name` may not contain null characters"
2906                     )
2907                     .emit();
2908                 }
2909                 codegen_fn_attrs.export_name = Some(s);
2910             }
2911         } else if attr.has_name(sym::target_feature) {
2912             if !tcx.is_closure(did.to_def_id())
2913                 && tcx.fn_sig(did).unsafety() == hir::Unsafety::Normal
2914             {
2915                 if tcx.sess.target.is_like_wasm || tcx.sess.opts.actually_rustdoc {
2916                     // The `#[target_feature]` attribute is allowed on
2917                     // WebAssembly targets on all functions, including safe
2918                     // ones. Other targets require that `#[target_feature]` is
2919                     // only applied to unsafe functions (pending the
2920                     // `target_feature_11` feature) because on most targets
2921                     // execution of instructions that are not supported is
2922                     // considered undefined behavior. For WebAssembly which is a
2923                     // 100% safe target at execution time it's not possible to
2924                     // execute undefined instructions, and even if a future
2925                     // feature was added in some form for this it would be a
2926                     // deterministic trap. There is no undefined behavior when
2927                     // executing WebAssembly so `#[target_feature]` is allowed
2928                     // on safe functions (but again, only for WebAssembly)
2929                     //
2930                     // Note that this is also allowed if `actually_rustdoc` so
2931                     // if a target is documenting some wasm-specific code then
2932                     // it's not spuriously denied.
2933                 } else if !tcx.features().target_feature_11 {
2934                     let mut err = feature_err(
2935                         &tcx.sess.parse_sess,
2936                         sym::target_feature_11,
2937                         attr.span,
2938                         "`#[target_feature(..)]` can only be applied to `unsafe` functions",
2939                     );
2940                     err.span_label(tcx.def_span(did), "not an `unsafe` function");
2941                     err.emit();
2942                 } else {
2943                     check_target_feature_trait_unsafe(tcx, did, attr.span);
2944                 }
2945             }
2946             from_target_feature(
2947                 tcx,
2948                 attr,
2949                 supported_target_features,
2950                 &mut codegen_fn_attrs.target_features,
2951             );
2952         } else if attr.has_name(sym::linkage) {
2953             if let Some(val) = attr.value_str() {
2954                 codegen_fn_attrs.linkage = Some(linkage_by_name(tcx, did, val.as_str()));
2955             }
2956         } else if attr.has_name(sym::link_section) {
2957             if let Some(val) = attr.value_str() {
2958                 if val.as_str().bytes().any(|b| b == 0) {
2959                     let msg = format!(
2960                         "illegal null byte in link_section \
2961                          value: `{}`",
2962                         &val
2963                     );
2964                     tcx.sess.span_err(attr.span, &msg);
2965                 } else {
2966                     codegen_fn_attrs.link_section = Some(val);
2967                 }
2968             }
2969         } else if attr.has_name(sym::link_name) {
2970             codegen_fn_attrs.link_name = attr.value_str();
2971         } else if attr.has_name(sym::link_ordinal) {
2972             link_ordinal_span = Some(attr.span);
2973             if let ordinal @ Some(_) = check_link_ordinal(tcx, attr) {
2974                 codegen_fn_attrs.link_ordinal = ordinal;
2975             }
2976         } else if attr.has_name(sym::no_sanitize) {
2977             no_sanitize_span = Some(attr.span);
2978             if let Some(list) = attr.meta_item_list() {
2979                 for item in list.iter() {
2980                     if item.has_name(sym::address) {
2981                         codegen_fn_attrs.no_sanitize |= SanitizerSet::ADDRESS;
2982                     } else if item.has_name(sym::cfi) {
2983                         codegen_fn_attrs.no_sanitize |= SanitizerSet::CFI;
2984                     } else if item.has_name(sym::memory) {
2985                         codegen_fn_attrs.no_sanitize |= SanitizerSet::MEMORY;
2986                     } else if item.has_name(sym::memtag) {
2987                         codegen_fn_attrs.no_sanitize |= SanitizerSet::MEMTAG;
2988                     } else if item.has_name(sym::shadow_call_stack) {
2989                         codegen_fn_attrs.no_sanitize |= SanitizerSet::SHADOWCALLSTACK;
2990                     } else if item.has_name(sym::thread) {
2991                         codegen_fn_attrs.no_sanitize |= SanitizerSet::THREAD;
2992                     } else if item.has_name(sym::hwaddress) {
2993                         codegen_fn_attrs.no_sanitize |= SanitizerSet::HWADDRESS;
2994                     } else {
2995                         tcx.sess
2996                             .struct_span_err(item.span(), "invalid argument for `no_sanitize`")
2997                             .note("expected one of: `address`, `cfi`, `hwaddress`, `memory`, `memtag`, `shadow-call-stack`, or `thread`")
2998                             .emit();
2999                     }
3000                 }
3001             }
3002         } else if attr.has_name(sym::instruction_set) {
3003             codegen_fn_attrs.instruction_set = match attr.meta_kind() {
3004                 Some(MetaItemKind::List(ref items)) => match items.as_slice() {
3005                     [NestedMetaItem::MetaItem(set)] => {
3006                         let segments =
3007                             set.path.segments.iter().map(|x| x.ident.name).collect::<Vec<_>>();
3008                         match segments.as_slice() {
3009                             [sym::arm, sym::a32] | [sym::arm, sym::t32] => {
3010                                 if !tcx.sess.target.has_thumb_interworking {
3011                                     struct_span_err!(
3012                                         tcx.sess.diagnostic(),
3013                                         attr.span,
3014                                         E0779,
3015                                         "target does not support `#[instruction_set]`"
3016                                     )
3017                                     .emit();
3018                                     None
3019                                 } else if segments[1] == sym::a32 {
3020                                     Some(InstructionSetAttr::ArmA32)
3021                                 } else if segments[1] == sym::t32 {
3022                                     Some(InstructionSetAttr::ArmT32)
3023                                 } else {
3024                                     unreachable!()
3025                                 }
3026                             }
3027                             _ => {
3028                                 struct_span_err!(
3029                                     tcx.sess.diagnostic(),
3030                                     attr.span,
3031                                     E0779,
3032                                     "invalid instruction set specified",
3033                                 )
3034                                 .emit();
3035                                 None
3036                             }
3037                         }
3038                     }
3039                     [] => {
3040                         struct_span_err!(
3041                             tcx.sess.diagnostic(),
3042                             attr.span,
3043                             E0778,
3044                             "`#[instruction_set]` requires an argument"
3045                         )
3046                         .emit();
3047                         None
3048                     }
3049                     _ => {
3050                         struct_span_err!(
3051                             tcx.sess.diagnostic(),
3052                             attr.span,
3053                             E0779,
3054                             "cannot specify more than one instruction set"
3055                         )
3056                         .emit();
3057                         None
3058                     }
3059                 },
3060                 _ => {
3061                     struct_span_err!(
3062                         tcx.sess.diagnostic(),
3063                         attr.span,
3064                         E0778,
3065                         "must specify an instruction set"
3066                     )
3067                     .emit();
3068                     None
3069                 }
3070             };
3071         } else if attr.has_name(sym::repr) {
3072             codegen_fn_attrs.alignment = match attr.meta_item_list() {
3073                 Some(items) => match items.as_slice() {
3074                     [item] => match item.name_value_literal() {
3075                         Some((sym::align, literal)) => {
3076                             let alignment = rustc_attr::parse_alignment(&literal.kind);
3077
3078                             match alignment {
3079                                 Ok(align) => Some(align),
3080                                 Err(msg) => {
3081                                     struct_span_err!(
3082                                         tcx.sess.diagnostic(),
3083                                         attr.span,
3084                                         E0589,
3085                                         "invalid `repr(align)` attribute: {}",
3086                                         msg
3087                                     )
3088                                     .emit();
3089
3090                                     None
3091                                 }
3092                             }
3093                         }
3094                         _ => None,
3095                     },
3096                     [] => None,
3097                     _ => None,
3098                 },
3099                 None => None,
3100             };
3101         }
3102     }
3103
3104     codegen_fn_attrs.inline = attrs.iter().fold(InlineAttr::None, |ia, attr| {
3105         if !attr.has_name(sym::inline) {
3106             return ia;
3107         }
3108         match attr.meta_kind() {
3109             Some(MetaItemKind::Word) => InlineAttr::Hint,
3110             Some(MetaItemKind::List(ref items)) => {
3111                 inline_span = Some(attr.span);
3112                 if items.len() != 1 {
3113                     struct_span_err!(
3114                         tcx.sess.diagnostic(),
3115                         attr.span,
3116                         E0534,
3117                         "expected one argument"
3118                     )
3119                     .emit();
3120                     InlineAttr::None
3121                 } else if list_contains_name(&items, sym::always) {
3122                     InlineAttr::Always
3123                 } else if list_contains_name(&items, sym::never) {
3124                     InlineAttr::Never
3125                 } else {
3126                     struct_span_err!(
3127                         tcx.sess.diagnostic(),
3128                         items[0].span(),
3129                         E0535,
3130                         "invalid argument"
3131                     )
3132                     .emit();
3133
3134                     InlineAttr::None
3135                 }
3136             }
3137             Some(MetaItemKind::NameValue(_)) => ia,
3138             None => ia,
3139         }
3140     });
3141
3142     codegen_fn_attrs.optimize = attrs.iter().fold(OptimizeAttr::None, |ia, attr| {
3143         if !attr.has_name(sym::optimize) {
3144             return ia;
3145         }
3146         let err = |sp, s| struct_span_err!(tcx.sess.diagnostic(), sp, E0722, "{}", s).emit();
3147         match attr.meta_kind() {
3148             Some(MetaItemKind::Word) => {
3149                 err(attr.span, "expected one argument");
3150                 ia
3151             }
3152             Some(MetaItemKind::List(ref items)) => {
3153                 inline_span = Some(attr.span);
3154                 if items.len() != 1 {
3155                     err(attr.span, "expected one argument");
3156                     OptimizeAttr::None
3157                 } else if list_contains_name(&items, sym::size) {
3158                     OptimizeAttr::Size
3159                 } else if list_contains_name(&items, sym::speed) {
3160                     OptimizeAttr::Speed
3161                 } else {
3162                     err(items[0].span(), "invalid argument");
3163                     OptimizeAttr::None
3164                 }
3165             }
3166             Some(MetaItemKind::NameValue(_)) => ia,
3167             None => ia,
3168         }
3169     });
3170
3171     // #73631: closures inherit `#[target_feature]` annotations
3172     if tcx.features().target_feature_11 && tcx.is_closure(did.to_def_id()) {
3173         let owner_id = tcx.parent(did.to_def_id());
3174         if tcx.def_kind(owner_id).has_codegen_attrs() {
3175             codegen_fn_attrs
3176                 .target_features
3177                 .extend(tcx.codegen_fn_attrs(owner_id).target_features.iter().copied());
3178         }
3179     }
3180
3181     // If a function uses #[target_feature] it can't be inlined into general
3182     // purpose functions as they wouldn't have the right target features
3183     // enabled. For that reason we also forbid #[inline(always)] as it can't be
3184     // respected.
3185     if !codegen_fn_attrs.target_features.is_empty() {
3186         if codegen_fn_attrs.inline == InlineAttr::Always {
3187             if let Some(span) = inline_span {
3188                 tcx.sess.span_err(
3189                     span,
3190                     "cannot use `#[inline(always)]` with \
3191                      `#[target_feature]`",
3192                 );
3193             }
3194         }
3195     }
3196
3197     if !codegen_fn_attrs.no_sanitize.is_empty() {
3198         if codegen_fn_attrs.inline == InlineAttr::Always {
3199             if let (Some(no_sanitize_span), Some(inline_span)) = (no_sanitize_span, inline_span) {
3200                 let hir_id = tcx.hir().local_def_id_to_hir_id(did);
3201                 tcx.struct_span_lint_hir(
3202                     lint::builtin::INLINE_NO_SANITIZE,
3203                     hir_id,
3204                     no_sanitize_span,
3205                     |lint| {
3206                         lint.build("`no_sanitize` will have no effect after inlining")
3207                             .span_note(inline_span, "inlining requested here")
3208                             .emit();
3209                     },
3210                 )
3211             }
3212         }
3213     }
3214
3215     // Weak lang items have the same semantics as "std internal" symbols in the
3216     // sense that they're preserved through all our LTO passes and only
3217     // strippable by the linker.
3218     //
3219     // Additionally weak lang items have predetermined symbol names.
3220     if tcx.is_weak_lang_item(did.to_def_id()) {
3221         codegen_fn_attrs.flags |= CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL;
3222     }
3223     if let Some(name) = weak_lang_items::link_name(attrs) {
3224         codegen_fn_attrs.export_name = Some(name);
3225         codegen_fn_attrs.link_name = Some(name);
3226     }
3227     check_link_name_xor_ordinal(tcx, &codegen_fn_attrs, link_ordinal_span);
3228
3229     // Internal symbols to the standard library all have no_mangle semantics in
3230     // that they have defined symbol names present in the function name. This
3231     // also applies to weak symbols where they all have known symbol names.
3232     if codegen_fn_attrs.flags.contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL) {
3233         codegen_fn_attrs.flags |= CodegenFnAttrFlags::NO_MANGLE;
3234     }
3235
3236     // Any linkage to LLVM intrinsics for now forcibly marks them all as never
3237     // unwinds since LLVM sometimes can't handle codegen which `invoke`s
3238     // intrinsic functions.
3239     if let Some(name) = &codegen_fn_attrs.link_name {
3240         if name.as_str().starts_with("llvm.") {
3241             codegen_fn_attrs.flags |= CodegenFnAttrFlags::NEVER_UNWIND;
3242         }
3243     }
3244
3245     codegen_fn_attrs
3246 }
3247
3248 /// Computes the set of target features used in a function for the purposes of
3249 /// inline assembly.
3250 fn asm_target_features<'tcx>(tcx: TyCtxt<'tcx>, did: DefId) -> &'tcx FxHashSet<Symbol> {
3251     let mut target_features = tcx.sess.unstable_target_features.clone();
3252     if tcx.def_kind(did).has_codegen_attrs() {
3253         let attrs = tcx.codegen_fn_attrs(did);
3254         target_features.extend(&attrs.target_features);
3255         match attrs.instruction_set {
3256             None => {}
3257             Some(InstructionSetAttr::ArmA32) => {
3258                 target_features.remove(&sym::thumb_mode);
3259             }
3260             Some(InstructionSetAttr::ArmT32) => {
3261                 target_features.insert(sym::thumb_mode);
3262             }
3263         }
3264     }
3265
3266     tcx.arena.alloc(target_features)
3267 }
3268
3269 /// Checks if the provided DefId is a method in a trait impl for a trait which has track_caller
3270 /// applied to the method prototype.
3271 fn should_inherit_track_caller(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
3272     if let Some(impl_item) = tcx.opt_associated_item(def_id)
3273         && let ty::AssocItemContainer::ImplContainer = impl_item.container
3274         && let Some(trait_item) = impl_item.trait_item_def_id
3275     {
3276         return tcx
3277             .codegen_fn_attrs(trait_item)
3278             .flags
3279             .intersects(CodegenFnAttrFlags::TRACK_CALLER);
3280     }
3281
3282     false
3283 }
3284
3285 fn check_link_ordinal(tcx: TyCtxt<'_>, attr: &ast::Attribute) -> Option<u16> {
3286     use rustc_ast::{Lit, LitIntType, LitKind};
3287     if !tcx.features().raw_dylib && tcx.sess.target.arch == "x86" {
3288         feature_err(
3289             &tcx.sess.parse_sess,
3290             sym::raw_dylib,
3291             attr.span,
3292             "`#[link_ordinal]` is unstable on x86",
3293         )
3294         .emit();
3295     }
3296     let meta_item_list = attr.meta_item_list();
3297     let meta_item_list: Option<&[ast::NestedMetaItem]> = meta_item_list.as_ref().map(Vec::as_ref);
3298     let sole_meta_list = match meta_item_list {
3299         Some([item]) => item.literal(),
3300         Some(_) => {
3301             tcx.sess
3302                 .struct_span_err(attr.span, "incorrect number of arguments to `#[link_ordinal]`")
3303                 .note("the attribute requires exactly one argument")
3304                 .emit();
3305             return None;
3306         }
3307         _ => None,
3308     };
3309     if let Some(Lit { kind: LitKind::Int(ordinal, LitIntType::Unsuffixed), .. }) = sole_meta_list {
3310         // According to the table at https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#import-header,
3311         // the ordinal must fit into 16 bits.  Similarly, the Ordinal field in COFFShortExport (defined
3312         // in llvm/include/llvm/Object/COFFImportFile.h), which we use to communicate import information
3313         // to LLVM for `#[link(kind = "raw-dylib"_])`, is also defined to be uint16_t.
3314         //
3315         // FIXME: should we allow an ordinal of 0?  The MSVC toolchain has inconsistent support for this:
3316         // both LINK.EXE and LIB.EXE signal errors and abort when given a .DEF file that specifies
3317         // a zero ordinal.  However, llvm-dlltool is perfectly happy to generate an import library
3318         // for such a .DEF file, and MSVC's LINK.EXE is also perfectly happy to consume an import
3319         // library produced by LLVM with an ordinal of 0, and it generates an .EXE.  (I don't know yet
3320         // if the resulting EXE runs, as I haven't yet built the necessary DLL -- see earlier comment
3321         // about LINK.EXE failing.)
3322         if *ordinal <= u16::MAX as u128 {
3323             Some(*ordinal as u16)
3324         } else {
3325             let msg = format!("ordinal value in `link_ordinal` is too large: `{}`", &ordinal);
3326             tcx.sess
3327                 .struct_span_err(attr.span, &msg)
3328                 .note("the value may not exceed `u16::MAX`")
3329                 .emit();
3330             None
3331         }
3332     } else {
3333         tcx.sess
3334             .struct_span_err(attr.span, "illegal ordinal format in `link_ordinal`")
3335             .note("an unsuffixed integer value, e.g., `1`, is expected")
3336             .emit();
3337         None
3338     }
3339 }
3340
3341 fn check_link_name_xor_ordinal(
3342     tcx: TyCtxt<'_>,
3343     codegen_fn_attrs: &CodegenFnAttrs,
3344     inline_span: Option<Span>,
3345 ) {
3346     if codegen_fn_attrs.link_name.is_none() || codegen_fn_attrs.link_ordinal.is_none() {
3347         return;
3348     }
3349     let msg = "cannot use `#[link_name]` with `#[link_ordinal]`";
3350     if let Some(span) = inline_span {
3351         tcx.sess.span_err(span, msg);
3352     } else {
3353         tcx.sess.err(msg);
3354     }
3355 }
3356
3357 /// Checks the function annotated with `#[target_feature]` is not a safe
3358 /// trait method implementation, reporting an error if it is.
3359 fn check_target_feature_trait_unsafe(tcx: TyCtxt<'_>, id: LocalDefId, attr_span: Span) {
3360     let hir_id = tcx.hir().local_def_id_to_hir_id(id);
3361     let node = tcx.hir().get(hir_id);
3362     if let Node::ImplItem(hir::ImplItem { kind: hir::ImplItemKind::Fn(..), .. }) = node {
3363         let parent_id = tcx.hir().get_parent_item(hir_id);
3364         let parent_item = tcx.hir().expect_item(parent_id);
3365         if let hir::ItemKind::Impl(hir::Impl { of_trait: Some(_), .. }) = parent_item.kind {
3366             tcx.sess
3367                 .struct_span_err(
3368                     attr_span,
3369                     "`#[target_feature(..)]` cannot be applied to safe trait method",
3370                 )
3371                 .span_label(attr_span, "cannot be applied to safe trait method")
3372                 .span_label(tcx.def_span(id), "not an `unsafe` function")
3373                 .emit();
3374         }
3375     }
3376 }