compiler/rustc_passes/src/weak_lang_items.rs

//! Validity checking for weak lang items

use rustc_ast as ast;
use rustc_ast::visit;
use rustc_data_structures::fx::FxHashSet;
use rustc_hir::lang_items::{self, LangItem};
use rustc_hir::weak_lang_items::WEAK_LANG_ITEMS;
use rustc_middle::middle::lang_items::required;
use rustc_middle::ty::TyCtxt;
use rustc_session::config::CrateType;
use rustc_target::spec::Os;

use crate::errors::{
    MissingLangItem, MissingPanicHandler, PanicUnwindWithoutStd, UnknownExternLangItem,
};
use crate::lang_items::extract_ast;

/// Checks the crate for usage of weak lang items, returning a vector of all the
/// lang items required by this crate, but not defined yet.
pub(crate) fn check_crate(
    tcx: TyCtxt<'_>,
    items: &mut lang_items::LanguageItems,
    krate: &ast::Crate,
) {
    // These are never called by user code, they're generated by the compiler.
    // They will never implicitly be added to the `missing` array unless we do
    // so here.
    if items.eh_personality().is_none() {
        items.missing.push(LangItem::EhPersonality);
    }
    if tcx.sess.target.os == Os::Emscripten
        && items.eh_catch_typeinfo().is_none()
        && !tcx.sess.opts.unstable_opts.emscripten_wasm_eh
    {
        items.missing.push(LangItem::EhCatchTypeinfo);
    }

    visit::Visitor::visit_crate(&mut WeakLangItemVisitor { tcx, items }, krate);

    verify(tcx, items);
}

struct WeakLangItemVisitor<'a, 'tcx> {
    tcx: TyCtxt<'tcx>,
    items: &'a mut lang_items::LanguageItems,
}

impl<'ast> visit::Visitor<'ast> for WeakLangItemVisitor<'_, '_> {
    fn visit_foreign_item(&mut self, i: &'ast ast::ForeignItem) {
        if let Some((lang_item, _)) = extract_ast(&i.attrs) {
            if let Some(item) = LangItem::from_name(lang_item)
                && item.is_weak()
            {
                if self.items.get(item).is_none() {
                    self.items.missing.push(item);
                }
            } else {
                self.tcx.dcx().emit_err(UnknownExternLangItem { span: i.span, lang_item });
            }
        }
    }
}

fn verify(tcx: TyCtxt<'_>, items: &lang_items::LanguageItems) {
    // We only need to check for the presence of weak lang items if we're
    // emitting something that's not an rlib.
    let needs_check = tcx.crate_types().iter().any(|kind| match *kind {
        CrateType::Dylib
        | CrateType::ProcMacro
        | CrateType::Cdylib
        | CrateType::Executable
        | CrateType::StaticLib
        | CrateType::Sdylib => true,
        CrateType::Rlib => false,
    });
    if !needs_check {
        return;
    }

    let mut missing = FxHashSet::default();
    for &cnum in tcx.crates(()).iter() {
        for &item in tcx.missing_lang_items(cnum).iter() {
            missing.insert(item);
        }
    }

    for &item in WEAK_LANG_ITEMS.iter() {
        if missing.contains(&item) && required(tcx, item) && items.get(item).is_none() {
            if item == LangItem::PanicImpl {
                tcx.dcx().emit_err(MissingPanicHandler);
            } else if item == LangItem::EhPersonality {
                tcx.dcx().emit_err(PanicUnwindWithoutStd);
            } else {
                tcx.dcx().emit_err(MissingLangItem { name: item.name() });
            }
        }
    }
}