Skip to content

Commit 32fbbc2

Browse files
folkertdevfolkertdev
committed
Error on invalid signatures for interrupt ABIs
1 parent 6d0c9e2 commit 32fbbc2

24 files changed

+470
-163
lines changed

‎Cargo.lock‎

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

‎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};
@@ -365,46 +366,94 @@ impl<'a> AstValidator<'a> {
365366
}
366367
}
367368

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

373-
// An `extern "custom"` function must be unsafe.
374419
match sig.header.safety {
375420
Safety::Unsafe(_) => { /* all good */ }
376421
Safety::Safe(safe_span) => {
377-
let safe_span =
378-
self.sess.psess.source_map().span_until_non_whitespace(safe_span.to(sig.span));
422+
let source_map = self.sess.psess.source_map();
423+
let safe_span = source_map.span_until_non_whitespace(safe_span.to(sig.span));
379424
dcx.emit_err(errors::AbiCustomSafeForeignFunction { span: sig.span, safe_span });
380425
}
381426
Safety::Default => match ctxt {
382427
FnCtxt::Foreign => { /* all good */ }
383428
FnCtxt::Free | FnCtxt::Assoc(_) => {
384-
self.dcx().emit_err(errors::AbiCustomSafeFunction {
429+
dcx.emit_err(errors::AbiCustomSafeFunction {
385430
span: sig.span,
431+
abi,
386432
unsafe_span: sig.span.shrink_to_lo(),
387433
});
388434
}
389435
},
390436
}
437+
}
391438

392-
// An `extern "custom"` function cannot be `async` and/or `gen`.
439+
fn check_abi_is_not_coroutine(&self, abi: ExternAbi, sig: &FnSig) {
393440
if let Some(coroutine_kind) = sig.header.coroutine_kind {
394441
let coroutine_kind_span = self
395442
.sess
396443
.psess
397444
.source_map()
398445
.span_until_non_whitespace(coroutine_kind.span().to(sig.span));
399446

400-
self.dcx().emit_err(errors::AbiCustomCoroutine {
447+
self.dcx().emit_err(errors::AbiCannotBeCoroutine {
401448
span: sig.span,
449+
abi,
402450
coroutine_kind_span,
403451
coroutine_kind_str: coroutine_kind.as_str(),
404452
});
405453
}
454+
}
406455

407-
// An `extern "custom"` function must not have any parameters or return type.
456+
fn check_abi_no_params_or_return(&self, abi: ExternAbi, ident: &Ident, sig: &FnSig) {
408457
let mut spans: Vec<_> = sig.decl.inputs.iter().map(|p| p.span).collect();
409458
if let FnRetTy::Ty(ref ret_ty) = sig.decl.output {
410459
spans.push(ret_ty.span);
@@ -415,11 +464,12 @@ impl<'a> AstValidator<'a> {
415464
let suggestion_span = header_span.shrink_to_hi().to(sig.decl.output.span());
416465
let padding = if header_span.is_empty() { "" } else { " " };
417466

418-
self.dcx().emit_err(errors::AbiCustomInvalidSignature {
467+
self.dcx().emit_err(errors::AbiMustNotHaveParametersOrReturnType {
419468
spans,
420469
symbol: ident.name,
421470
suggestion_span,
422471
padding,
472+
abi,
423473
});
424474
}
425475
}
@@ -1199,9 +1249,12 @@ impl<'a> Visitor<'a> for AstValidator<'a> {
11991249
self.check_foreign_fn_bodyless(*ident, body.as_deref());
12001250
self.check_foreign_fn_headerless(sig.header);
12011251
self.check_foreign_item_ascii_only(*ident);
1202-
if self.extern_mod_abi == Some(ExternAbi::Custom) {
1203-
self.check_custom_abi(FnCtxt::Foreign, ident, sig);
1204-
}
1252+
self.check_abi(
1253+
self.extern_mod_abi.unwrap_or(ExternAbi::FALLBACK),
1254+
FnCtxt::Foreign,
1255+
ident,
1256+
sig,
1257+
);
12051258
}
12061259
ForeignItemKind::TyAlias(box TyAlias {
12071260
defaultness,
@@ -1411,9 +1464,9 @@ impl<'a> Visitor<'a> for AstValidator<'a> {
14111464

14121465
if let FnKind::Fn(ctxt, _, fun) = fk
14131466
&& let Extern::Explicit(str_lit, _) = fun.sig.header.ext
1414-
&& let Ok(ExternAbi::Custom) = ExternAbi::from_str(str_lit.symbol.as_str())
1467+
&& let Ok(abi) = ExternAbi::from_str(str_lit.symbol.as_str())
14151468
{
1416-
self.check_custom_abi(ctxt, &fun.ident, &fun.sig);
1469+
self.check_abi(abi, ctxt, &fun.ident, &fun.sig);
14171470
}
14181471

14191472
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/bad-custom.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ const unsafe extern "custom" fn no_const_fn() {
9696

9797
async unsafe extern "custom" fn no_async_fn() {
9898
//~^ ERROR items with the `"custom"` ABI can only be declared externally or defined via naked functions
99-
//~| ERROR functions with the `"custom"` ABI cannot be `async`
99+
//~| ERROR functions with the "custom" ABI cannot be `async`
100100
}
101101

102102
fn no_promotion_to_fn_trait(f: unsafe extern "custom" fn()) -> impl Fn() {

‎tests/ui/abi/bad-custom.stderr‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ error: invalid signature for `extern "custom"` function
1515
LL | extern "custom" fn must_be_unsafe(a: i64) -> i64 {
1616
| ^^^^^^ ^^^
1717
|
18-
= note: functions with the `"custom"` ABI cannot have any parameters or return type
18+
= note: functions with the "custom" ABI cannot have any parameters or return type
1919
help: remove the parameters and return type
2020
|
2121
LL - extern "custom" fn must_be_unsafe(a: i64) -> i64 {
@@ -28,7 +28,7 @@ error: invalid signature for `extern "custom"` function
2828
LL | unsafe extern "custom" fn no_parameters(a: i64) {
2929
| ^^^^^^
3030
|
31-
= note: functions with the `"custom"` ABI cannot have any parameters or return type
31+
= note: functions with the "custom" ABI cannot have any parameters or return type
3232
help: remove the parameters and return type
3333
|
3434
LL - unsafe extern "custom" fn no_parameters(a: i64) {
@@ -41,7 +41,7 @@ error: invalid signature for `extern "custom"` function
4141
LL | unsafe extern "custom" fn no_return_type() -> i64 {
4242
| ^^^
4343
|
44-
= note: functions with the `"custom"` ABI cannot have any parameters or return type
44+
= note: functions with the "custom" ABI cannot have any parameters or return type
4545
help: remove the parameters and return type
4646
|
4747
LL - unsafe extern "custom" fn no_return_type() -> i64 {
@@ -54,7 +54,7 @@ error: invalid signature for `extern "custom"` function
5454
LL | unsafe extern "custom" fn double(a: i64) -> i64 {
5555
| ^^^^^^ ^^^
5656
|
57-
= note: functions with the `"custom"` ABI cannot have any parameters or return type
57+
= note: functions with the "custom" ABI cannot have any parameters or return type
5858
help: remove the parameters and return type
5959
|
6060
LL - unsafe extern "custom" fn double(a: i64) -> i64 {
@@ -67,7 +67,7 @@ error: invalid signature for `extern "custom"` function
6767
LL | unsafe extern "custom" fn is_even(self) -> bool {
6868
| ^^^^ ^^^^
6969
|
70-
= note: functions with the `"custom"` ABI cannot have any parameters or return type
70+
= note: functions with the "custom" ABI cannot have any parameters or return type
7171
help: remove the parameters and return type
7272
|
7373
LL - unsafe extern "custom" fn is_even(self) -> bool {
@@ -80,7 +80,7 @@ error: invalid signature for `extern "custom"` function
8080
LL | unsafe extern "custom" fn bitwise_not(a: i64) -> i64 {
8181
| ^^^^^^ ^^^
8282
|
83-
= note: functions with the `"custom"` ABI cannot have any parameters or return type
83+
= note: functions with the "custom" ABI cannot have any parameters or return type
8484
help: remove the parameters and return type
8585
|
8686
LL - unsafe extern "custom" fn bitwise_not(a: i64) -> i64 {
@@ -104,7 +104,7 @@ error: invalid signature for `extern "custom"` function
104104
LL | extern "custom" fn negate(a: i64) -> i64;
105105
| ^^^^^^ ^^^
106106
|
107-
= note: functions with the `"custom"` ABI cannot have any parameters or return type
107+
= note: functions with the "custom" ABI cannot have any parameters or return type
108108
help: remove the parameters and return type
109109
|
110110
LL - extern "custom" fn negate(a: i64) -> i64;
@@ -128,7 +128,7 @@ error: invalid signature for `extern "custom"` function
128128
LL | extern "custom" fn negate(a: i64) -> i64 {
129129
| ^^^^^^ ^^^
130130
|
131-
= note: functions with the `"custom"` ABI cannot have any parameters or return type
131+
= note: functions with the "custom" ABI cannot have any parameters or return type
132132
help: remove the parameters and return type
133133
|
134134
LL - extern "custom" fn negate(a: i64) -> i64 {
@@ -141,7 +141,7 @@ error: invalid signature for `extern "custom"` function
141141
LL | fn increment(a: i64) -> i64;
142142
| ^^^^^^ ^^^
143143
|
144-
= note: functions with the `"custom"` ABI cannot have any parameters or return type
144+
= note: functions with the "custom" ABI cannot have any parameters or return type
145145
help: remove the parameters and return type
146146
|
147147
LL - fn increment(a: i64) -> i64;
@@ -160,7 +160,7 @@ LL - safe fn extern_cannot_be_safe();
160160
LL + fn extern_cannot_be_safe();
161161
|
162162

163-
error: functions with the `"custom"` ABI cannot be `async`
163+
error: functions with the "custom" ABI cannot be `async`
164164
--> $DIR/bad-custom.rs:97:1
165165
|
166166
LL | async unsafe extern "custom" fn no_async_fn() {

0 commit comments

Comments
 (0)