-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Add extern "custom"
#3980
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
folkertdev
wants to merge
7
commits into
rust-lang:master
Choose a base branch
from
folkertdev:extern-custom-rfc
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+211
−0
Open
Add extern "custom"
#3980
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
bc0c28d
add `extern "custom"` RFC
folkertdev b38e056
changes after review
folkertdev 231b22f
Apply suggestions from code review
folkertdev eba79be
Fix abi_custom header levels
ehuss 5573cea
Rename 3980 extern-custom
ehuss 206ea92
Set 3980 RFC PR link
ehuss 6dbabd0
changes after T-lang meeting
folkertdev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| - Feature Name: `abi_custom` | ||
| - Start Date: 2026-07-01) | ||
| - RFC PR: [rust-lang/rfcs#0000](https://github.com/rust-lang/rfcs/pull/0000) | ||
| - Rust Issue: [rust-lang/rust#140829)](https://github.com/rust-lang/rust/issues/140829) | ||
|
|
||
| # Summary | ||
| [summary]: #summary | ||
|
|
||
| An `extern "custom" fn` is a function with a custom ABI that is unknown to rust. Often these are low-level functions that pass arguments in different registers than any standard calling convention, so using this helps rustc block you from using this in any place where rustc would need to understand that calling convention. | ||
|
|
||
|
|
||
| ```rust | ||
| /// # SAFETY | ||
| /// | ||
| /// - Expects the dividend and the divisor in r0 and r1. | ||
| /// - Returns the quotient in r0 and the remainder in r1. | ||
| #[unsafe(naked)] | ||
| pub unsafe extern "custom" fn __aeabi_uidivmod() { | ||
| core::arch::naked_asm!( | ||
| "push {{lr}}", | ||
| "sub sp, sp, #4", | ||
| "mov r2, sp", | ||
| "bl {trampoline}", | ||
| "ldr r1, [sp]", | ||
| "add sp, sp, #4", | ||
| "pop {{pc}}", | ||
| trampoline = sym crate::arm::__udivmodsi4 | ||
| ); | ||
| } | ||
|
|
||
| unsafe extern "custom" { | ||
| fn __fentry__(); | ||
| } | ||
| ``` | ||
|
|
||
| ### History | ||
|
|
||
| * https://github.com/rust-lang/rust/issues/140566 | ||
| * https://github.com/rust-lang/rust/issues/140829 | ||
| * https://github.com/rust-lang/rust/pull/140770 | ||
| * https://github.com/rust-lang/rust/pull/158504 | ||
|
|
||
| # Motivation | ||
| [motivation]: #motivation | ||
|
|
||
| In some low-level scenarios we must define naked functions with a custom ABI. This comes up in `rust-lang/compiler-builtins` (e.g. for `__rust_probestack` and `__aeabi_uidivmod`), and also in systems programming (e.g. when defining `__fentry__`, a symbol used the mcount mechanism). | ||
|
|
||
| The current solution is often to use `extern "C"`, but that is misleading: the function does not use the C calling convention, and calling it as if it were is almost certainly causing UB. | ||
|
|
||
| # Guide-level explanation | ||
| [guide-level-explanation]: #guide-level-explanation | ||
|
|
||
| Because rust doesn't know what calling convention to use, an `extern "custom"` function can only be called via inline assembly or FFI. | ||
|
|
||
| ``` | ||
| error: functions with the "custom" ABI cannot be called | ||
| --> <source>:5:5 | ||
| | | ||
| 5 | bar(); | ||
| | ^^^^^ | ||
| | | ||
| note: an `extern "custom"` function can only be called using inline assembly | ||
| ``` | ||
|
|
||
| An `extern "custom"` function definition must be a naked function: | ||
|
|
||
| ``` | ||
| error: items with the "custom" ABI can only be declared externally or defined via naked functions | ||
| --> <source>:10:1 | ||
| | | ||
| 10 | unsafe extern "custom" fn bar() { | ||
| | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| help: convert this to an `#[unsafe(naked)]` function | ||
| | | ||
| 10 + #[unsafe(naked)] | ||
| 11 | unsafe extern "custom" fn bar() { | ||
| | | ||
| ``` | ||
|
|
||
| An `extern "custom"` function definition must be unsafe. The intent here is that a safety comment is written on how this function may be called. | ||
|
|
||
| ``` | ||
| error: functions with the "custom" ABI must be unsafe | ||
| --> <source>:10:1 | ||
| | | ||
| 10 | extern "custom" fn bar() { | ||
| | ^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| help: add the `unsafe` keyword to this definition | ||
| | | ||
| 10 | unsafe extern "custom" fn bar() { | ||
| | ++++++ | ||
| ``` | ||
|
|
||
| In an `extern "custom"` block, functions cannot be marked as `safe`: | ||
|
|
||
| ``` | ||
| error: foreign functions with the "custom" ABI cannot be safe | ||
| --> <source>:16:5 | ||
| | | ||
| 16 | safe fn foobar(); | ||
| | ^^^^^^^^^^^^^^^^^ | ||
| | | ||
| help: remove the `safe` keyword from this definition | ||
| | | ||
| 16 - safe fn foobar(); | ||
| 16 + fn foobar(); | ||
| ``` | ||
|
|
||
| An `extern "custom"` function cannot have any arguments or a return type: | ||
|
|
||
| ``` | ||
| error: invalid signature for `extern "custom"` function | ||
| --> <source>:6:31 | ||
| | | ||
| 6 | unsafe extern "custom" fn foo(a: i32) -> i32 { | ||
| | ^^^^^^ ^^^ | ||
| | | ||
| = note: functions with the "custom" ABI cannot have any parameters or return type | ||
| help: remove the parameters and return type | ||
| | | ||
| 6 - unsafe extern "custom" fn foo(a: i32) -> i32 { | ||
| 6 + unsafe extern "custom" fn foo() { | ||
| | | ||
| ``` | ||
|
|
||
| # Reference-level explanation | ||
| [reference-level-explanation]: #reference-level-explanation | ||
|
|
||
| See https://github.com/rust-lang/reference/pull/2300. | ||
|
|
||
| # Drawbacks | ||
| [drawbacks]: #drawbacks | ||
|
|
||
| No specific drawback. | ||
|
|
||
| # Rationale and alternatives | ||
| [rationale-and-alternatives]: #rationale-and-alternatives | ||
|
|
||
| https://github.com/rust-lang/rust/issues/140566 | ||
|
|
||
| The name has already been debated. The name `unknown` has been mentioned, but to write the implementation you really do need to know the ABI. It is custom in the sense that rustc does not know about it, but the author definitely does. | ||
|
|
||
| # Prior art | ||
| [prior-art]: #prior-art | ||
|
|
||
| https://github.com/rust-lang/rust/issues/140566#issuecomment-2846205457 | ||
|
|
||
| We do have some other calling conventions that cannot be called using rust's function calling syntax: | ||
|
|
||
| - extern "*-interrupt` | ||
| - extern "gpu-kernel" | ||
|
|
||
| Those however do have a known ABI, it's just that semantically it does not make sense to call them from a rust program. | ||
|
|
||
| # Unresolved questions | ||
| [unresolved-questions]: #unresolved-questions | ||
|
|
||
| None currently. | ||
|
|
||
| # Future possibilities | ||
| [future-possibilities]: #future-possibilities | ||
|
|
||
| None currently. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.