compiler/rustc_hir_analysis/src/collect/dump.rs

use rustc_hir as hir;
use rustc_hir::def::DefKind;
use rustc_hir::def_id::LocalDefId;
use rustc_hir::{find_attr, intravisit};
use rustc_middle::hir::nested_filter;
use rustc_middle::ty::{self, TyCtxt, TypeVisitableExt, Unnormalized};
use rustc_span::sym;

pub(crate) fn generics(tcx: TyCtxt<'_>) {
    for did in tcx.hir_crate_items(()).definitions() {
        if did == hir::def_id::CRATE_DEF_ID {
            continue;
        }

        if find_attr!(tcx, did, RustcDumpGenerics) {
            let span = tcx.def_span(did);

            let mut diag =
                tcx.dcx().struct_span_err(span, format!("{}: {did:?}", sym::rustc_dump_generics));

            let generics = tcx.generics_of(did);
            diag.span_note(tcx.def_span(did), format!("{generics:#?}"));
            diag.emit();
        }
    }
}

pub(crate) fn opaque_hidden_types(tcx: TyCtxt<'_>) {
    if !find_attr!(tcx, crate, RustcDumpHiddenTypeOfOpaques) {
        return;
    }
    for id in tcx.hir_crate_items(()).opaques() {
        if let hir::OpaqueTyOrigin::FnReturn { parent: fn_def_id, .. }
        | hir::OpaqueTyOrigin::AsyncFn { parent: fn_def_id, .. } =
            tcx.hir_expect_opaque_ty(id).origin
            && let hir::Node::TraitItem(trait_item) = tcx.hir_node_by_def_id(fn_def_id)
            && let (_, hir::TraitFn::Required(..)) = trait_item.expect_fn()
        {
            continue;
        }

        let ty = tcx.type_of(id).instantiate_identity().skip_norm_wip();
        let span = tcx.def_span(id);
        tcx.dcx().emit_err(crate::diagnostics::TypeOf { span, ty });
    }
}

pub(crate) fn clauses_and_item_bounds(tcx: TyCtxt<'_>) {
    for id in tcx.hir_crate_items(()).owners() {
        #[expect(deprecated)] // we don't want to unnecessarily retrieve the attrs twice in a row.
        let attrs = tcx.get_all_attrs(id);

        if find_attr!(attrs, RustcDumpPredicates) {
            let clauses = tcx
                .clauses_of(id)
                .instantiate_identity(tcx)
                .clauses
                .into_iter()
                .map(Unnormalized::skip_norm_wip);
            let span = tcx.def_span(id);

            let mut diag = tcx.dcx().struct_span_err(span, sym::rustc_dump_predicates.as_str());
            for clause in clauses {
                diag.note(format!("{clause:?}"));
            }
            diag.emit();
        }

        if find_attr!(attrs, RustcDumpItemBounds) {
            let name = sym::rustc_dump_item_bounds.as_str();

            match tcx.def_kind(id) {
                DefKind::AssocTy => {
                    let bounds = tcx.item_bounds(id).instantiate_identity().skip_norm_wip();
                    let span = tcx.def_span(id);

                    let mut diag = tcx.dcx().struct_span_err(span, name);
                    for bound in bounds {
                        diag.note(format!("{bound:?}"));
                    }
                    diag.emit()
                }
                kind => tcx.dcx().span_delayed_bug(
                    tcx.def_span(id),
                    format!("attr parsing didn't report an error for `#[{name}]` on {kind:?}"),
                ),
            };
        }
    }
}

pub(crate) fn def_parents(tcx: TyCtxt<'_>) {
    for iid in tcx.hir_free_items() {
        let did = iid.owner_id.def_id;
        if find_attr!(tcx, did, RustcDumpDefParents) {
            struct AnonConstFinder<'tcx> {
                tcx: TyCtxt<'tcx>,
                anon_consts: Vec<LocalDefId>,
            }

            impl<'tcx> intravisit::Visitor<'tcx> for AnonConstFinder<'tcx> {
                type NestedFilter = nested_filter::All;

                fn maybe_tcx(&mut self) -> Self::MaybeTyCtxt {
                    self.tcx
                }

                fn visit_anon_const(&mut self, c: &'tcx rustc_hir::AnonConst) {
                    self.anon_consts.push(c.def_id);
                    intravisit::walk_anon_const(self, c)
                }
            }

            // Look for any anon consts inside of this item as there is no way to apply
            // the `rustc_dump_def_parents` attribute to the anon const so it would not be possible
            // to see what its def parent is.
            let mut anon_ct_finder = AnonConstFinder { tcx, anon_consts: vec![] };
            intravisit::walk_item(&mut anon_ct_finder, tcx.hir_item(iid));

            for did in [did].into_iter().chain(anon_ct_finder.anon_consts) {
                let span = tcx.def_span(did);

                let mut diag = tcx
                    .dcx()
                    .struct_span_err(span, format!("{}: {did:?}", sym::rustc_dump_def_parents));

                let mut current_did = did.to_def_id();
                while let Some(parent_did) = tcx.opt_parent(current_did) {
                    current_did = parent_did;
                    diag.span_note(tcx.def_span(parent_did), format!("{parent_did:?}"));
                }
                diag.emit();
            }
        }
    }
}

pub(crate) fn vtables<'tcx>(tcx: TyCtxt<'tcx>) {
    for id in tcx.hir_free_items() {
        let def_id = id.owner_id.def_id;

        let Some(&attr_span) = find_attr!(tcx, def_id, RustcDumpVtable(span) => span) else {
            continue;
        };

        let vtable_entries = match tcx.hir_item(id).kind {
            hir::ItemKind::Impl(hir::Impl { of_trait: Some(_), .. }) => {
                let trait_ref = tcx.impl_trait_ref(def_id).instantiate_identity();
                if trait_ref.skip_normalization().has_non_region_param() {
                    tcx.dcx().span_err(
                        attr_span,
                        "`rustc_dump_vtable` must be applied to non-generic impl",
                    );
                    continue;
                }
                if !tcx.is_dyn_compatible(trait_ref.skip_normalization().def_id) {
                    tcx.dcx().span_err(
                        attr_span,
                        "`rustc_dump_vtable` must be applied to dyn-compatible trait",
                    );
                    continue;
                }
                let Ok(trait_ref) = tcx
                    .try_normalize_erasing_regions(ty::TypingEnv::fully_monomorphized(), trait_ref)
                else {
                    tcx.dcx().span_err(
                        attr_span,
                        "`rustc_dump_vtable` applied to impl header that cannot be normalized",
                    );
                    continue;
                };
                tcx.vtable_entries(trait_ref)
            }
            hir::ItemKind::TyAlias(..) => {
                let ty = tcx.type_of(def_id).instantiate_identity();
                if ty.has_non_region_param() {
                    tcx.dcx().span_err(
                        attr_span,
                        "`rustc_dump_vtable` must be applied to non-generic type",
                    );
                    continue;
                }
                let Ok(ty) =
                    tcx.try_normalize_erasing_regions(ty::TypingEnv::fully_monomorphized(), ty)
                else {
                    tcx.dcx().span_err(
                        attr_span,
                        "`rustc_dump_vtable` applied to type alias that cannot be normalized",
                    );
                    continue;
                };
                let ty::Dynamic(data, _) = *ty.kind() else {
                    tcx.dcx().span_err(attr_span, "`rustc_dump_vtable` to type alias of dyn type");
                    continue;
                };
                if let Some(principal) = data.principal() {
                    tcx.vtable_entries(
                        tcx.instantiate_bound_regions_with_erased(principal).with_self_ty(tcx, ty),
                    )
                } else {
                    TyCtxt::COMMON_VTABLE_ENTRIES
                }
            }
            _ => {
                tcx.dcx().span_err(
                    attr_span,
                    "`rustc_dump_vtable` only applies to impl, or type alias of dyn type",
                );
                continue;
            }
        };

        tcx.dcx().span_err(tcx.def_span(def_id), format!("vtable entries: {vtable_entries:#?}"));
    }
}