rustc_hir_analysis/collect/

generics_of.rs

use std::assert_matches;
use std::ops::ControlFlow;

use rustc_errors::{Diag, DiagCtxtHandle, Diagnostic, Level};
use rustc_hir::def::DefKind;
use rustc_hir::def_id::LocalDefId;
use rustc_hir::intravisit::{self, Visitor, VisitorExt};
use rustc_hir::{self as hir, AmbigArg, GenericParamKind, HirId, Node};
use rustc_middle::span_bug;
use rustc_middle::ty::{self, TyCtxt};
use rustc_session::lint;
use rustc_span::{Span, kw, sym};
use tracing::{debug, instrument};

use crate::middle::resolve_bound_vars as rbv;

#[instrument(level = "debug", skip(tcx), ret)]
pub(super) fn generics_of(tcx: TyCtxt<'_>, def_id: LocalDefId) -> ty::Generics {
    use rustc_hir::*;

    struct GenericParametersForbiddenHere {
        msg: &'static str,
    }

    impl<'a> Diagnostic<'a, ()> for GenericParametersForbiddenHere {
        fn into_diag(self, dcx: DiagCtxtHandle<'a>, level: Level) -> Diag<'a, ()> {
            let Self { msg } = self;
            Diag::new(dcx, level, msg)
        }
    }

    // For an RPITIT, synthesize generics which are equal to the opaque's generics
    // and parent fn's generics compressed into one list.
    if let Some(ty::ImplTraitInTraitData::Trait { fn_def_id, opaque_def_id }) =
        tcx.opt_rpitit_info(def_id.to_def_id())
    {
        debug!("RPITIT fn_def_id={fn_def_id:?} opaque_def_id={opaque_def_id:?}");
        let trait_def_id = tcx.parent(fn_def_id);
        let opaque_ty_generics = tcx.generics_of(opaque_def_id);
        let opaque_ty_parent_count = opaque_ty_generics.parent_count;
        let mut own_params = opaque_ty_generics.own_params.clone();

        let parent_generics = tcx.generics_of(trait_def_id);
        let parent_count = parent_generics.parent_count + parent_generics.own_params.len();

        let mut trait_fn_params = tcx.generics_of(fn_def_id).own_params.clone();

        for param in &mut own_params {
            param.index = param.index + parent_count as u32 + trait_fn_params.len() as u32
                - opaque_ty_parent_count as u32;
        }

        trait_fn_params.extend(own_params);
        own_params = trait_fn_params;

        let param_def_id_to_index =
            own_params.iter().map(|param| (param.def_id, param.index)).collect();

        return ty::Generics {
            parent: Some(trait_def_id),
            parent_count,
            own_params,
            param_def_id_to_index,
            has_self: opaque_ty_generics.has_self,
            has_late_bound_regions: opaque_ty_generics.has_late_bound_regions,
        };
    }

    let hir_id = tcx.local_def_id_to_hir_id(def_id);
    let node = tcx.hir_node(hir_id);

    let parent_def_id = match node {
        Node::ImplItem(_)
        | Node::TraitItem(_)
        | Node::Variant(_)
        | Node::Ctor(..)
        | Node::Field(_) => {
            let parent_id = tcx.hir_get_parent_item(hir_id);
            Some(parent_id.def_id)
        }
        // FIXME(#43408) always enable this once `lazy_normalization` is
        // stable enough and does not need a feature gate anymore.
        Node::AnonConst(_) => {
            let parent_did = tcx.local_parent(def_id);
            debug!(?parent_did);

            let mut in_param_ty = false;
            for (_parent, node) in tcx.hir_parent_iter(hir_id) {
                if let Some(generics) = node.generics() {
                    let mut visitor = AnonConstInParamTyDetector { in_param_ty: false, ct: hir_id };

                    in_param_ty = visitor.visit_generics(generics).is_break();
                    break;
                }
            }

            match tcx.anon_const_kind(def_id) {
                // Stable: anon consts are not able to use any generic parameters...
                ty::AnonConstKind::MCG => None,
                // GCA anon consts inherit their parent's generics.
                ty::AnonConstKind::GCA => Some(parent_did),
                // we provide generics to repeat expr counts as a backwards compatibility hack. #76200
                ty::AnonConstKind::RepeatExprCount => Some(parent_did),

                // Even GCE anon const should not be allowed to use generic parameters as it would be
                // trivially forward declared uses once desugared. E.g. `const N: [u8; ANON::<N>]`.
                //
                // We could potentially mirror the hack done for defaults of generic parameters but
                // this case just doesn't come up much compared to `const N: u32 = ...`. Long term the
                // hack for defaulted parameters should be removed eventually anyway.
                ty::AnonConstKind::GCE if in_param_ty => None,
                // GCE anon consts as a default for a generic parameter should have their provided generics
                // "truncated" up to whatever generic parameter this anon const is within the default of.
                //
                // FIXME(generic_const_exprs): This only handles `const N: usize = /*defid*/` but not type
                // parameter defaults, e.g. `T = Foo</*defid*/>`.
                ty::AnonConstKind::GCE
                    if let Some(param_id) =
                        tcx.hir_opt_const_param_default_param_def_id(hir_id) =>
                {
                    // If the def_id we are calling generics_of on is an anon ct default i.e:
                    //
                    // struct Foo<const N: usize = { .. }>;
                    //        ^^^       ^          ^^^^^^ def id of this anon const
                    //        ^         ^ param_id
                    //        ^ parent_def_id
                    //
                    // then we only want to return generics for params to the left of `N`. If we don't do that we
                    // end up with that const looking like: `ty::ConstKind::Unevaluated(def_id, args: [N#0])`.
                    //
                    // This causes ICEs (#86580) when building the args for Foo in `fn foo() -> Foo { .. }` as
                    // we instantiate the defaults with the partially built args when we build the args. Instantiating
                    // the `N#0` on the unevaluated const indexes into the empty args we're in the process of building.
                    //
                    // We fix this by having this function return the parent's generics ourselves and truncating the
                    // generics to only include non-forward declared params (with the exception of the `Self` ty)
                    //
                    // For the above code example that means we want `args: []`
                    // For the following struct def we want `args: [N#0]` when generics_of is called on
                    // the def id of the `{ N + 1 }` anon const
                    // struct Foo<const N: usize, const M: usize = { N + 1 }>;
                    //
                    // This has some implications for how we get the predicates available to the anon const
                    // see `explicit_predicates_of` for more information on this
                    let generics = tcx.generics_of(parent_did);
                    let param_def_idx = generics.param_def_id_to_index[&param_id.to_def_id()];
                    // In the above example this would be .params[..N#0]
                    let own_params = generics.params_to(param_def_idx as usize, tcx).to_owned();
                    let param_def_id_to_index =
                        own_params.iter().map(|param| (param.def_id, param.index)).collect();

                    return ty::Generics {
                        // we set the parent of these generics to be our parent's parent so that we
                        // dont end up with args: [N, M, N] for the const default on a struct like this:
                        // struct Foo<const N: usize, const M: usize = { ... }>;
                        parent: generics.parent,
                        parent_count: generics.parent_count,
                        own_params,
                        param_def_id_to_index,
                        has_self: generics.has_self,
                        has_late_bound_regions: generics.has_late_bound_regions,
                    };
                }
                ty::AnonConstKind::GCE => Some(parent_did),

                // Field defaults are allowed to use generic parameters, e.g. `field: u32 = /*defid: N + 1*/`
                ty::AnonConstKind::NonTypeSystem
                    if matches!(tcx.parent_hir_node(hir_id), Node::TyPat(_) | Node::Field(_)) =>
                {
                    Some(parent_did)
                }
                // Default to no generic parameters for other kinds of anon consts
                ty::AnonConstKind::NonTypeSystem => None,
            }
        }
        Node::ConstBlock(_)
        | Node::Expr(&hir::Expr { kind: hir::ExprKind::Closure { .. }, .. }) => {
            Some(tcx.typeck_root_def_id_local(def_id))
        }
        Node::OpaqueTy(&hir::OpaqueTy {
            origin:
                hir::OpaqueTyOrigin::FnReturn { parent: fn_def_id, in_trait_or_impl }
                | hir::OpaqueTyOrigin::AsyncFn { parent: fn_def_id, in_trait_or_impl },
            ..
        }) => {
            if in_trait_or_impl.is_some() {
                assert_matches!(tcx.def_kind(fn_def_id), DefKind::AssocFn);
            } else {
                assert_matches!(tcx.def_kind(fn_def_id), DefKind::AssocFn | DefKind::Fn);
            }
            Some(fn_def_id)
        }
        Node::OpaqueTy(&hir::OpaqueTy {
            origin: hir::OpaqueTyOrigin::TyAlias { parent, in_assoc_ty },
            ..
        }) => {
            if in_assoc_ty {
                assert_matches!(tcx.def_kind(parent), DefKind::AssocTy);
            } else {
                assert_matches!(tcx.def_kind(parent), DefKind::TyAlias);
            }
            debug!("generics_of: parent of opaque ty {:?} is {:?}", def_id, parent);
            // Opaque types are always nested within another item, and
            // inherit the generics of the item.
            Some(parent)
        }

        // All of these nodes have no parent from which to inherit generics.
        Node::Item(_) | Node::ForeignItem(_) => None,

        // Params don't really have generics, but we use it when instantiating their value paths.
        Node::GenericParam(_) => None,

        Node::Synthetic => span_bug!(
            tcx.def_span(def_id),
            "synthetic HIR should have its `generics_of` explicitly fed"
        ),

        _ => span_bug!(tcx.def_span(def_id), "generics_of: unexpected node kind {node:?}"),
    };

    // Add in the self type parameter.
    let opt_self = if let Node::Item(item) = node
        && let ItemKind::Trait { .. } | ItemKind::TraitAlias(..) = item.kind
    {
        // Something of a hack: We reuse the node ID of the trait for the self type parameter.
        Some(ty::GenericParamDef {
            index: 0,
            name: kw::SelfUpper,
            def_id: def_id.to_def_id(),
            pure_wrt_drop: false,
            kind: ty::GenericParamDefKind::Type { has_default: false, synthetic: false },
        })
    } else {
        None
    };

    let param_default_policy = param_default_policy(node);
    let hir_generics = node.generics().unwrap_or(hir::Generics::empty());
    let has_self = opt_self.is_some();
    let mut parent_has_self = false;
    let mut own_start = has_self as u32;
    let parent_count = parent_def_id.map_or(0, |def_id| {
        let generics = tcx.generics_of(def_id);
        assert!(!has_self);
        parent_has_self = generics.has_self;
        own_start = generics.count() as u32;
        generics.parent_count + generics.own_params.len()
    });

    let mut own_params: Vec<_> = Vec::with_capacity(hir_generics.params.len() + has_self as usize);

    if let Some(opt_self) = opt_self {
        own_params.push(opt_self);
    }

    let early_lifetimes = super::early_bound_lifetimes_from_generics(tcx, hir_generics);
    own_params.extend(early_lifetimes.enumerate().map(|(i, param)| ty::GenericParamDef {
        name: param.name.ident().name,
        index: own_start + i as u32,
        def_id: param.def_id.to_def_id(),
        pure_wrt_drop: param.pure_wrt_drop,
        kind: ty::GenericParamDefKind::Lifetime,
    }));

    // Now create the real type and const parameters.
    let type_start = own_start - has_self as u32 + own_params.len() as u32;
    let mut i: u32 = 0;
    let mut next_index = || {
        let prev = i;
        i += 1;
        prev + type_start
    };

    own_params.extend(hir_generics.params.iter().filter_map(|param| {
        const MESSAGE: &str = "defaults for generic parameters are not allowed here";
        let kind = match param.kind {
            GenericParamKind::Lifetime { .. } => return None,
            GenericParamKind::Type { default, synthetic } => {
                if default.is_some() {
                    match param_default_policy.expect("no policy for generic param default") {
                        ParamDefaultPolicy::Allowed => {}
                        ParamDefaultPolicy::FutureCompatForbidden => {
                            tcx.emit_node_span_lint(
                                lint::builtin::INVALID_TYPE_PARAM_DEFAULT,
                                param.hir_id,
                                param.span,
                                GenericParametersForbiddenHere { msg: MESSAGE },
                            );
                        }
                        ParamDefaultPolicy::Forbidden => {
                            tcx.dcx().span_err(param.span, MESSAGE);
                        }
                    }
                }

                ty::GenericParamDefKind::Type { has_default: default.is_some(), synthetic }
            }
            GenericParamKind::Const { ty: _, default } => {
                if default.is_some() {
                    match param_default_policy.expect("no policy for generic param default") {
                        ParamDefaultPolicy::Allowed => {}
                        ParamDefaultPolicy::FutureCompatForbidden
                        | ParamDefaultPolicy::Forbidden => {
                            tcx.dcx().span_err(param.span, MESSAGE);
                        }
                    }
                }

                ty::GenericParamDefKind::Const { has_default: default.is_some() }
            }
        };
        Some(ty::GenericParamDef {
            index: next_index(),
            name: param.name.ident().name,
            def_id: param.def_id.to_def_id(),
            pure_wrt_drop: param.pure_wrt_drop,
            kind,
        })
    }));

    // provide junk type parameter defs - the only place that
    // cares about anything but the length is instantiation,
    // and we don't do that for closures.
    if let Node::Expr(&hir::Expr {
        kind: hir::ExprKind::Closure(hir::Closure { kind, .. }), ..
    }) = node
    {
        // See `ClosureArgsParts`, `CoroutineArgsParts`, and `CoroutineClosureArgsParts`
        // for info on the usage of each of these fields.
        let len = match kind {
            // The args are: closure_kind, closure_signature, upvars.
            ClosureKind::Closure => 3,
            // The args are: coroutine_kind, resume_ty, yield_ty, return_ty, upvars.
            ClosureKind::Coroutine(_) => 5,
            // The args are: closure_kind, closure_signature_parts, upvars, bound_captures_by_ref.
            ClosureKind::CoroutineClosure(_) => 4,
        };

        own_params.extend((0..len).map(|_| ty::GenericParamDef {
            index: next_index(),
            name: sym::empty, // dummy; exact value doesn't matter
            def_id: def_id.to_def_id(),
            pure_wrt_drop: false,
            kind: ty::GenericParamDefKind::Type { has_default: false, synthetic: false },
        }));
    }

    // provide junk type parameter defs for const blocks.
    if let Node::ConstBlock(_) = node {
        own_params.push(ty::GenericParamDef {
            index: next_index(),
            name: rustc_span::sym::const_ty_placeholder,
            def_id: def_id.to_def_id(),
            pure_wrt_drop: false,
            kind: ty::GenericParamDefKind::Type { has_default: false, synthetic: false },
        });
    }

    if let Node::OpaqueTy(&hir::OpaqueTy { .. }) = node {
        assert!(own_params.is_empty());

        let lifetimes = tcx.opaque_captured_lifetimes(def_id);
        debug!(?lifetimes);

        own_params.extend(lifetimes.iter().map(|&(_, param)| ty::GenericParamDef {
            name: tcx.item_name(param.to_def_id()),
            index: next_index(),
            def_id: param.to_def_id(),
            pure_wrt_drop: false,
            kind: ty::GenericParamDefKind::Lifetime,
        }))
    }

    let param_def_id_to_index =
        own_params.iter().map(|param| (param.def_id, param.index)).collect();

    ty::Generics {
        parent: parent_def_id.map(LocalDefId::to_def_id),
        parent_count,
        own_params,
        param_def_id_to_index,
        has_self: has_self || parent_has_self,
        has_late_bound_regions: has_late_bound_regions(tcx, node),
    }
}

#[derive(Clone, Copy)]
enum ParamDefaultPolicy {
    Allowed,
    /// Tracked in <https://github.com/rust-lang/rust/issues/36887>.
    FutureCompatForbidden,
    Forbidden,
}

fn param_default_policy(node: Node<'_>) -> Option<ParamDefaultPolicy> {
    use rustc_hir::*;

    Some(match node {
        Node::Item(item) => match item.kind {
            ItemKind::Trait { .. }
            | ItemKind::TraitAlias(..)
            | ItemKind::TyAlias(..)
            | ItemKind::Enum(..)
            | ItemKind::Struct(..)
            | ItemKind::Union(..) => ParamDefaultPolicy::Allowed,
            ItemKind::Fn { .. } | ItemKind::Impl(_) => ParamDefaultPolicy::FutureCompatForbidden,
            // Re. GCI, we're not bound by backward compatibility.
            ItemKind::Const(..) => ParamDefaultPolicy::Forbidden,
            _ => return None,
        },
        Node::TraitItem(item) => match item.kind {
            // Re. GATs and GACs (generic_const_items), we're not bound by backward compatibility.
            TraitItemKind::Const(..) | TraitItemKind::Type(..) => ParamDefaultPolicy::Forbidden,
            TraitItemKind::Fn(..) => ParamDefaultPolicy::FutureCompatForbidden,
        },
        Node::ImplItem(item) => match item.kind {
            // Re. GATs and GACs (generic_const_items), we're not bound by backward compatibility.
            ImplItemKind::Const(..) | ImplItemKind::Type(..) => ParamDefaultPolicy::Forbidden,
            ImplItemKind::Fn(..) => ParamDefaultPolicy::FutureCompatForbidden,
        },
        // Generic params are (semantically) invalid on foreign items. Still, for maximum forward
        // compatibility, let's hard-reject defaults on them.
        Node::ForeignItem(_) => ParamDefaultPolicy::Forbidden,
        Node::OpaqueTy(..) => ParamDefaultPolicy::Allowed,
        _ => return None,
    })
}

fn has_late_bound_regions<'tcx>(tcx: TyCtxt<'tcx>, node: Node<'tcx>) -> Option<Span> {
    struct LateBoundRegionsDetector<'tcx> {
        tcx: TyCtxt<'tcx>,
        outer_index: ty::DebruijnIndex,
    }

    impl<'tcx> Visitor<'tcx> for LateBoundRegionsDetector<'tcx> {
        type Result = ControlFlow<Span>;
        fn visit_ty(&mut self, ty: &'tcx hir::Ty<'tcx, AmbigArg>) -> ControlFlow<Span> {
            match ty.kind {
                hir::TyKind::FnPtr(..) => {
                    self.outer_index.shift_in(1);
                    let res = intravisit::walk_ty(self, ty);
                    self.outer_index.shift_out(1);
                    res
                }
                hir::TyKind::UnsafeBinder(_) => {
                    self.outer_index.shift_in(1);
                    let res = intravisit::walk_ty(self, ty);
                    self.outer_index.shift_out(1);
                    res
                }
                _ => intravisit::walk_ty(self, ty),
            }
        }

        fn visit_poly_trait_ref(&mut self, tr: &'tcx hir::PolyTraitRef<'tcx>) -> ControlFlow<Span> {
            self.outer_index.shift_in(1);
            let res = intravisit::walk_poly_trait_ref(self, tr);
            self.outer_index.shift_out(1);
            res
        }

        fn visit_lifetime(&mut self, lt: &'tcx hir::Lifetime) -> ControlFlow<Span> {
            match self.tcx.named_bound_var(lt.hir_id) {
                Some(rbv::ResolvedArg::StaticLifetime | rbv::ResolvedArg::EarlyBound(..)) => {
                    ControlFlow::Continue(())
                }
                Some(rbv::ResolvedArg::LateBound(debruijn, _, _))
                    if debruijn < self.outer_index =>
                {
                    ControlFlow::Continue(())
                }
                Some(
                    rbv::ResolvedArg::LateBound(..)
                    | rbv::ResolvedArg::Free(..)
                    | rbv::ResolvedArg::Error(_),
                )
                | None => ControlFlow::Break(lt.ident.span),
            }
        }
    }

    fn has_late_bound_regions<'tcx>(
        tcx: TyCtxt<'tcx>,
        generics: &'tcx hir::Generics<'tcx>,
        decl: &'tcx hir::FnDecl<'tcx>,
    ) -> Option<Span> {
        let mut visitor = LateBoundRegionsDetector { tcx, outer_index: ty::INNERMOST };
        for param in generics.params {
            if let GenericParamKind::Lifetime { .. } = param.kind {
                if tcx.is_late_bound(param.hir_id) {
                    return Some(param.span);
                }
            }
        }
        visitor.visit_fn_decl(decl).break_value()
    }

    let decl = node.fn_decl()?;
    let generics = node.generics()?;
    has_late_bound_regions(tcx, generics, decl)
}

struct AnonConstInParamTyDetector {
    in_param_ty: bool,
    ct: HirId,
}

impl<'v> Visitor<'v> for AnonConstInParamTyDetector {
    type Result = ControlFlow<()>;

    fn visit_generic_param(&mut self, p: &'v hir::GenericParam<'v>) -> Self::Result {
        if let GenericParamKind::Const { ty, default: _ } = p.kind {
            let prev = self.in_param_ty;
            self.in_param_ty = true;
            let res = self.visit_ty_unambig(ty);
            self.in_param_ty = prev;
            res
        } else {
            ControlFlow::Continue(())
        }
    }

    fn visit_anon_const(&mut self, c: &'v hir::AnonConst) -> Self::Result {
        if self.in_param_ty && self.ct == c.hir_id {
            return ControlFlow::Break(());
        }
        intravisit::walk_anon_const(self, c)
    }
}