Skip to content

Commit 6086486

Browse files
folkertdevfolkertdev
committed
Error on invalid signatures for interrupt ABIs
1 parent d9ca9bd commit 6086486

22 files changed

+949
-32
lines changed

‎Cargo.lock‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3317,6 +3317,7 @@ dependencies = [
33173317
"rustc_parse",
33183318
"rustc_session",
33193319
"rustc_span",
3320+
"rustc_target",
33203321
"thin-vec",
33213322
]
33223323

‎compiler/rustc_ast_passes/Cargo.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@ rustc_macros = { path = "../rustc_macros" }
1818
rustc_parse = { path = "../rustc_parse" }
1919
rustc_session = { path = "../rustc_session" }
2020
rustc_span = { path = "../rustc_span" }
21+
rustc_target = { path = "../rustc_target" }
2122
thin-vec = "0.2.12"
2223
# tidy-alphabetical-end

‎compiler/rustc_ast_passes/messages.ftl‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
1-
ast_passes_abi_custom_coroutine =
2-
functions with the `"custom"` ABI cannot be `{$coroutine_kind_str}`
1+
ast_passes_abi_cannot_be_coroutine =
2+
functions with the `{$abi}` ABI cannot be `{$coroutine_kind_str}`
33
.suggestion = remove the `{$coroutine_kind_str}` keyword from this definiton
44
5-
ast_passes_abi_custom_invalid_signature =
6-
invalid signature for `extern "custom"` function
7-
.note = functions with the `"custom"` ABI cannot have any parameters or return type
8-
.suggestion = remove the parameters and return type
9-
105
ast_passes_abi_custom_safe_foreign_function =
116
foreign functions with the `"custom"` ABI cannot be safe
127
.suggestion = remove the `safe` keyword from this definition
@@ -15,6 +10,16 @@ ast_passes_abi_custom_safe_function =
1510
functions with the `"custom"` ABI must be unsafe
1611
.suggestion = add the `unsafe` keyword to this definition
1712
13+
ast_passes_abi_must_not_have_parameters_or_return_type=
14+
invalid signature for `extern {$abi}` function
15+
.note = functions with the `{$abi}` ABI cannot have any parameters or return type
16+
.suggestion = remove the parameters and return type
17+
18+
ast_passes_abi_must_not_have_return_type=
19+
invalid signature for `extern {$abi}` function
20+
.note = functions with the `"custom"` ABI cannot have a return type
21+
.help = remove the return type
22+
1823
ast_passes_assoc_const_without_body =
1924
associated constant in `impl` without body
2025
.suggestion = provide a definition for the constant

‎compiler/rustc_ast_passes/src/ast_validation.rs‎

Lines changed: 70 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ use std::ops::{Deref, DerefMut};
2121
use std::str::FromStr;
2222

2323
use itertools::{Either, Itertools};
24-
use rustc_abi::ExternAbi;
24+
use rustc_abi::{CanonAbi, ExternAbi, InterruptKind};
2525
use rustc_ast::ptr::P;
2626
use rustc_ast::visit::{AssocCtxt, BoundKind, FnCtxt, FnKind, Visitor, walk_list};
2727
use rustc_ast::*;
@@ -37,6 +37,7 @@ use rustc_session::lint::builtin::{
3737
};
3838
use rustc_session::lint::{BuiltinLintDiag, LintBuffer};
3939
use rustc_span::{Ident, Span, kw, sym};
40+
use rustc_target::spec::{AbiMap, AbiMapping};
4041
use thin_vec::thin_vec;
4142

4243
use crate::errors::{self, TildeConstReason};
@@ -379,46 +380,94 @@ impl<'a> AstValidator<'a> {
379380
}
380381
}
381382

382-
/// An `extern "custom"` function must be unsafe, and must not have any parameters or return
383-
/// type.
384-
fn check_custom_abi(&self, ctxt: FnCtxt, ident: &Ident, sig: &FnSig) {
383+
/// Check that this function does not violate the constraints of its ABI.
384+
fn check_abi(&self, abi: ExternAbi, ctxt: FnCtxt, ident: &Ident, sig: &FnSig) {
385+
match AbiMap::from_target(&self.sess.target).canonize_abi(abi, false) {
386+
AbiMapping::Direct(canon_abi) | AbiMapping::Deprecated(canon_abi) => {
387+
match canon_abi {
388+
CanonAbi::C
389+
| CanonAbi::Rust
390+
| CanonAbi::RustCold
391+
| CanonAbi::Arm(_)
392+
| CanonAbi::GpuKernel
393+
| CanonAbi::X86(_) => { /* nothing to check */ }
394+
395+
CanonAbi::Custom => {
396+
// An `extern "custom"` function must be unsafe.
397+
self.check_abi_is_unsafe(abi, ctxt, sig);
398+
399+
// An `extern "custom"` function cannot be `async` and/or `gen`.
400+
self.check_abi_is_not_coroutine(abi, sig);
401+
402+
// An `extern "custom"` function must have type `fn()`.
403+
self.check_abi_no_params_or_return(abi, ident, sig);
404+
}
405+
406+
CanonAbi::Interrupt(interrupt_kind) => {
407+
// An interrupt handler cannot be `async` and/or `gen`.
408+
self.check_abi_is_not_coroutine(abi, sig);
409+
410+
if let InterruptKind::X86 = interrupt_kind {
411+
// "x86-interrupt" is special because it does have arguments.
412+
// FIXME(workingjubilee): properly lint on acceptable input types.
413+
if let FnRetTy::Ty(ref ret_ty) = sig.decl.output {
414+
self.dcx().emit_err(errors::AbiMustNotHaveReturnType {
415+
span: ret_ty.span,
416+
abi,
417+
});
418+
}
419+
} else {
420+
// An `extern "interrupt"` function must have type `fn()`.
421+
self.check_abi_no_params_or_return(abi, ident, sig);
422+
}
423+
}
424+
}
425+
}
426+
AbiMapping::Invalid => { /* ignore */ }
427+
}
428+
}
429+
430+
fn check_abi_is_unsafe(&self, abi: ExternAbi, ctxt: FnCtxt, sig: &FnSig) {
385431
let dcx = self.dcx();
386432

387-
// An `extern "custom"` function must be unsafe.
388433
match sig.header.safety {
389434
Safety::Unsafe(_) => { /* all good */ }
390435
Safety::Safe(safe_span) => {
391-
let safe_span =
392-
self.sess.psess.source_map().span_until_non_whitespace(safe_span.to(sig.span));
436+
let source_map = self.sess.psess.source_map();
437+
let safe_span = source_map.span_until_non_whitespace(safe_span.to(sig.span));
393438
dcx.emit_err(errors::AbiCustomSafeForeignFunction { span: sig.span, safe_span });
394439
}
395440
Safety::Default => match ctxt {
396441
FnCtxt::Foreign => { /* all good */ }
397442
FnCtxt::Free | FnCtxt::Assoc(_) => {
398-
self.dcx().emit_err(errors::AbiCustomSafeFunction {
443+
dcx.emit_err(errors::AbiCustomSafeFunction {
399444
span: sig.span,
445+
abi,
400446
unsafe_span: sig.span.shrink_to_lo(),
401447
});
402448
}
403449
},
404450
}
451+
}
405452

406-
// An `extern "custom"` function cannot be `async` and/or `gen`.
453+
fn check_abi_is_not_coroutine(&self, abi: ExternAbi, sig: &FnSig) {
407454
if let Some(coroutine_kind) = sig.header.coroutine_kind {
408455
let coroutine_kind_span = self
409456
.sess
410457
.psess
411458
.source_map()
412459
.span_until_non_whitespace(coroutine_kind.span().to(sig.span));
413460

414-
self.dcx().emit_err(errors::AbiCustomCoroutine {
461+
self.dcx().emit_err(errors::AbiCannotBeCoroutine {
415462
span: sig.span,
463+
abi,
416464
coroutine_kind_span,
417465
coroutine_kind_str: coroutine_kind.as_str(),
418466
});
419467
}
468+
}
420469

421-
// An `extern "custom"` function must not have any parameters or return type.
470+
fn check_abi_no_params_or_return(&self, abi: ExternAbi, ident: &Ident, sig: &FnSig) {
422471
let mut spans: Vec<_> = sig.decl.inputs.iter().map(|p| p.span).collect();
423472
if let FnRetTy::Ty(ref ret_ty) = sig.decl.output {
424473
spans.push(ret_ty.span);
@@ -429,11 +478,12 @@ impl<'a> AstValidator<'a> {
429478
let suggestion_span = header_span.shrink_to_hi().to(sig.decl.output.span());
430479
let padding = if header_span.is_empty() { "" } else { " " };
431480

432-
self.dcx().emit_err(errors::AbiCustomInvalidSignature {
481+
self.dcx().emit_err(errors::AbiMustNotHaveParametersOrReturnType {
433482
spans,
434483
symbol: ident.name,
435484
suggestion_span,
436485
padding,
486+
abi,
437487
});
438488
}
439489
}
@@ -1215,9 +1265,12 @@ impl<'a> Visitor<'a> for AstValidator<'a> {
12151265
self.check_foreign_fn_bodyless(*ident, body.as_deref());
12161266
self.check_foreign_fn_headerless(sig.header);
12171267
self.check_foreign_item_ascii_only(*ident);
1218-
if self.extern_mod_abi == Some(ExternAbi::Custom) {
1219-
self.check_custom_abi(FnCtxt::Foreign, ident, sig);
1220-
}
1268+
self.check_abi(
1269+
self.extern_mod_abi.unwrap_or(ExternAbi::FALLBACK),
1270+
FnCtxt::Foreign,
1271+
ident,
1272+
sig,
1273+
);
12211274
}
12221275
ForeignItemKind::TyAlias(box TyAlias {
12231276
defaultness,
@@ -1427,9 +1480,9 @@ impl<'a> Visitor<'a> for AstValidator<'a> {
14271480

14281481
if let FnKind::Fn(ctxt, _, fun) = fk
14291482
&& let Extern::Explicit(str_lit, _) = fun.sig.header.ext
1430-
&& let Ok(ExternAbi::Custom) = ExternAbi::from_str(str_lit.symbol.as_str())
1483+
&& let Ok(abi) = ExternAbi::from_str(str_lit.symbol.as_str())
14311484
{
1432-
self.check_custom_abi(ctxt, &fun.ident, &fun.sig);
1485+
self.check_abi(abi, ctxt, &fun.ident, &fun.sig);
14331486
}
14341487

14351488
self.check_c_variadic_type(fk);

‎compiler/rustc_ast_passes/src/errors.rs‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
//! Errors emitted by ast_passes.
22
3+
use rustc_abi::ExternAbi;
34
use rustc_ast::ParamKindOrd;
45
use rustc_errors::codes::*;
56
use rustc_errors::{Applicability, Diag, EmissionGuarantee, Subdiagnostic};
@@ -845,6 +846,7 @@ pub(crate) struct AbiCustomSafeForeignFunction {
845846
pub(crate) struct AbiCustomSafeFunction {
846847
#[primary_span]
847848
pub span: Span,
849+
pub abi: ExternAbi,
848850

849851
#[suggestion(
850852
ast_passes_suggestion,
@@ -856,10 +858,11 @@ pub(crate) struct AbiCustomSafeFunction {
856858
}
857859

858860
#[derive(Diagnostic)]
859-
#[diag(ast_passes_abi_custom_coroutine)]
860-
pub(crate) struct AbiCustomCoroutine {
861+
#[diag(ast_passes_abi_cannot_be_coroutine)]
862+
pub(crate) struct AbiCannotBeCoroutine {
861863
#[primary_span]
862864
pub span: Span,
865+
pub abi: ExternAbi,
863866

864867
#[suggestion(
865868
ast_passes_suggestion,
@@ -872,11 +875,12 @@ pub(crate) struct AbiCustomCoroutine {
872875
}
873876

874877
#[derive(Diagnostic)]
875-
#[diag(ast_passes_abi_custom_invalid_signature)]
878+
#[diag(ast_passes_abi_must_not_have_parameters_or_return_type)]
876879
#[note]
877-
pub(crate) struct AbiCustomInvalidSignature {
880+
pub(crate) struct AbiMustNotHaveParametersOrReturnType {
878881
#[primary_span]
879882
pub spans: Vec<Span>,
883+
pub abi: ExternAbi,
880884

881885
#[suggestion(
882886
ast_passes_suggestion,
@@ -888,3 +892,13 @@ pub(crate) struct AbiCustomInvalidSignature {
888892
pub symbol: Symbol,
889893
pub padding: &'static str,
890894
}
895+
896+
#[derive(Diagnostic)]
897+
#[diag(ast_passes_abi_must_not_have_return_type)]
898+
#[note]
899+
pub(crate) struct AbiMustNotHaveReturnType {
900+
#[primary_span]
901+
#[help]
902+
pub span: Span,
903+
pub abi: ExternAbi,
904+
}

‎tests/codegen/abi-x86-interrupt.rs‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313
extern crate minicore;
1414
use minicore::*;
1515

16-
// CHECK: define x86_intrcc i64 @has_x86_interrupt_abi
16+
// CHECK: define x86_intrcc void @has_x86_interrupt_abi
1717
#[no_mangle]
18-
pub extern "x86-interrupt" fn has_x86_interrupt_abi(a: i64) -> i64 {
19-
a
20-
}
18+
pub extern "x86-interrupt" fn has_x86_interrupt_abi() {}

‎tests/ui/abi/cannot-be-called.avr.stderr‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
error: invalid signature for `extern "avr-interrupt"` function
2+
--> $DIR/cannot-be-called.rs:69:31
3+
|
4+
LL | extern "avr-interrupt" fn avr(_: u64) -> u64 {
5+
| ^^^^^^ ^^^
6+
|
7+
= note: functions with the `"avr-interrupt"` ABI cannot have any parameters or return type
8+
help: remove the parameters and return type
9+
|
10+
LL - extern "avr-interrupt" fn avr(_: u64) -> u64 {
11+
LL + extern "avr-interrupt" fn avr() {
12+
|
13+
14+
error[E0570]: `"x86-interrupt"` is not a supported ABI for the current target
15+
--> $DIR/cannot-be-called.rs:33:1
16+
|
17+
LL | / extern "x86-interrupt" {
18+
LL | |
19+
LL | | fn x86_foreign(_: u64) -> u64;
20+
LL | |
21+
LL | | }
22+
| |_^
23+
24+
error[E0570]: `"riscv-interrupt-m"` is not a supported ABI for the current target
25+
--> $DIR/cannot-be-called.rs:45:1
26+
|
27+
LL | / extern "riscv-interrupt-m" {
28+
LL | |
29+
LL | | fn riscv_m_foreign(_: u64) -> u64;
30+
LL | |
31+
LL | | }
32+
| |_^
33+
34+
error[E0570]: `"riscv-interrupt-s"` is not a supported ABI for the current target
35+
--> $DIR/cannot-be-called.rs:57:1
36+
|
37+
LL | / extern "riscv-interrupt-s" {
38+
LL | |
39+
LL | | fn riscv_s_foreign(_: u64) -> u64;
40+
LL | |
41+
LL | | }
42+
| |_^
43+
44+
error[E0570]: `"x86-interrupt"` is not a supported ABI for the current target
45+
--> $DIR/cannot-be-called.rs:39:1
46+
|
47+
LL | extern "x86-interrupt" fn x86(_: u64) -> u64 {
48+
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
49+
50+
error[E0570]: `"riscv-interrupt-m"` is not a supported ABI for the current target
51+
--> $DIR/cannot-be-called.rs:51:1
52+
|
53+
LL | extern "riscv-interrupt-m" fn riscv_m(_: u64) -> u64 {
54+
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
55+
56+
error[E0570]: `"riscv-interrupt-s"` is not a supported ABI for the current target
57+
--> $DIR/cannot-be-called.rs:63:1
58+
|
59+
LL | extern "riscv-interrupt-s" fn riscv_s(_: u64) -> u64 {
60+
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
61+
62+
error[E0570]: `"msp430-interrupt"` is not a supported ABI for the current target
63+
--> $DIR/cannot-be-called.rs:75:1
64+
|
65+
LL | extern "msp430-interrupt" fn msp430(_: u64) -> u64 {
66+
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67+
68+
error: aborting due to 8 previous errors
69+
70+
For more information about this error, try `rustc --explain E0570`.

0 commit comments

Comments
 (0)