Skip to main content

rustc_builtin_macros/
alloc_error_handler.rs

1use rustc_ast::expand::allocator::{ALLOC_ERROR_HANDLER, global_fn_name};
2use rustc_ast::{
3    self as ast, Fn, FnHeader, FnSig, Generics, ItemKind, Safety, Stmt, StmtKind, TyKind,
4};
5use rustc_expand::base::{Annotatable, ExtCtxt};
6use rustc_span::{Ident, Span, kw, sym};
7use thin_vec::{ThinVec, thin_vec};
8
9use crate::diagnostics;
10use crate::util::check_builtin_macro_attribute;
11
12pub(crate) fn expand(
13    ecx: &mut ExtCtxt<'_>,
14    _span: Span,
15    meta_item: &ast::MetaItem,
16    item: Annotatable,
17) -> Vec<Annotatable> {
18    check_builtin_macro_attribute(ecx, meta_item, sym::alloc_error_handler);
19
20    let orig_item = item.clone();
21
22    // Allow using `#[alloc_error_handler]` on an item statement
23    // FIXME - if we get deref patterns, use them to reduce duplication here
24    let (item, ident, is_stmt, sig_span) = if let Annotatable::Item(item) = &item
25        && let ItemKind::Fn(fn_kind) = &item.kind
26    {
27        (item, fn_kind.ident, false, ecx.with_def_site_ctxt(fn_kind.sig.span))
28    } else if let Annotatable::Stmt(stmt) = &item
29        && let StmtKind::Item(item) = &stmt.kind
30        && let ItemKind::Fn(fn_kind) = &item.kind
31    {
32        (item, fn_kind.ident, true, ecx.with_def_site_ctxt(fn_kind.sig.span))
33    } else {
34        ecx.dcx().emit_err(diagnostics::AllocErrorMustBeFn { span: item.span() });
35        return ::alloc::boxed::box_assume_init_into_vec_unsafe(::alloc::intrinsics::write_box_via_move(::alloc::boxed::Box::new_uninit(),
        [orig_item]))vec![orig_item];
36    };
37
38    // Generate a bunch of new items using the AllocFnFactory
39    let span = ecx.with_def_site_ctxt(item.span);
40
41    // Generate item statements for the allocator methods.
42    let stmts = {
    let len = [()].len();
    let mut vec = ::thin_vec::ThinVec::with_capacity(len);
    vec.push(generate_handler(ecx, ident, span, sig_span));
    vec
}thin_vec![generate_handler(ecx, ident, span, sig_span)];
43
44    // Generate anonymous constant serving as container for the allocator methods.
45    let const_ty = ecx.ty(sig_span, TyKind::Tup(ThinVec::new()));
46    let const_body = ecx.expr_block(ecx.block(span, stmts));
47    let const_item = ecx.item_const(
48        span,
49        Ident::new(kw::Underscore, span),
50        const_ty,
51        Some(const_body),
52        ast::ConstItemKind::Body,
53    );
54    let const_item = if is_stmt {
55        Annotatable::Stmt(Box::new(ecx.stmt_item(span, const_item)))
56    } else {
57        Annotatable::Item(const_item)
58    };
59
60    // Return the original item and the new methods.
61    ::alloc::boxed::box_assume_init_into_vec_unsafe(::alloc::intrinsics::write_box_via_move(::alloc::boxed::Box::new_uninit(),
        [orig_item, const_item]))vec![orig_item, const_item]
62}
63
64// #[rustc_std_internal_symbol]
65// unsafe fn __rust_alloc_error_handler(size: usize, align: usize) -> ! {
66//     handler(core::alloc::Layout::from_size_align_unchecked(size, align))
67// }
68fn generate_handler(cx: &ExtCtxt<'_>, handler: Ident, span: Span, sig_span: Span) -> Stmt {
69    let usize = cx.path_ident(span, Ident::new(sym::usize, span));
70    let ty_usize = cx.ty_path(usize);
71    let size = Ident::new(sym::size, span);
72    let align = Ident::new(sym::align, span);
73
74    let layout_new = cx.std_path(&[sym::alloc, sym::Layout, sym::from_size_align_unchecked]);
75    let layout_new = cx.expr_path(cx.path(span, layout_new));
76    let layout = cx.expr_call(
77        span,
78        layout_new,
79        {
    let len = [(), ()].len();
    let mut vec = ::thin_vec::ThinVec::with_capacity(len);
    vec.push(cx.expr_ident(span, size));
    vec.push(cx.expr_ident(span, align));
    vec
}thin_vec![cx.expr_ident(span, size), cx.expr_ident(span, align)],
80    );
81
82    let call = cx.expr_call_ident(sig_span, handler, {
    let len = [()].len();
    let mut vec = ::thin_vec::ThinVec::with_capacity(len);
    vec.push(layout);
    vec
}thin_vec![layout]);
83
84    let never = ast::FnRetTy::Ty(cx.ty(span, TyKind::Never));
85    let params = {
    let len = [(), ()].len();
    let mut vec = ::thin_vec::ThinVec::with_capacity(len);
    vec.push(cx.param(span, size, ty_usize.clone()));
    vec.push(cx.param(span, align, ty_usize));
    vec
}thin_vec![cx.param(span, size, ty_usize.clone()), cx.param(span, align, ty_usize)];
86    let decl = cx.fn_decl(params, never);
87    let header = FnHeader { safety: Safety::Unsafe(span), ..FnHeader::default() };
88    let sig = FnSig { decl, header, span };
89
90    let body = Some(cx.block_expr(call));
91    let kind = ItemKind::Fn(Box::new(Fn {
92        defaultness: ast::Defaultness::Implicit,
93        sig,
94        ident: Ident::from_str_and_span(&global_fn_name(ALLOC_ERROR_HANDLER), span),
95        generics: Generics::default(),
96        contract: None,
97        body,
98        define_opaque: None,
99        eii_impls: ThinVec::new(),
100    }));
101
102    let attrs = {
    let len = [()].len();
    let mut vec = ::thin_vec::ThinVec::with_capacity(len);
    vec.push(cx.attr_word(sym::rustc_std_internal_symbol, span));
    vec
}thin_vec![cx.attr_word(sym::rustc_std_internal_symbol, span)];
103
104    let item = cx.item(span, attrs, kind);
105    cx.stmt_item(sig_span, item)
106}