Skip to content

add extern "custom" #2300

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.

Sign up for GitHub

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

Draft
folkertdev wants to merge 3 commits into
base: master
Choose a base branch
from
+21 −1
Draft

add extern "custom" #2300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a83cc3
add `extern "custom"`
folkertdev Jun 27, 2026
2890548
Update src/items/external-blocks.md
folkertdev Jul 29, 2026
c979f98
add rules for parameters and return type
folkertdev Jul 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/items/external-blocks.md
View file
Open in desktop

@tgross35 tgross35 Jun 28, 2026 •
edited by rustbot
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it would be good to have an example at src/inline-assembly.md alongside naked functions?

View changes since the review

@tgross35 tgross35 Jun 28, 2026 •
edited by rustbot
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somewhere in the reference it would probably be good to clarify the purpose of parameters and return types in extern "custom" definitions, since they don't directly serve any purpose. I feel like we discussed this somewhere but can't seem to find it.

View changes since the review

@folkertdev folkertdev Jun 28, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We actually disallow them entirely

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() {
  |

Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ r[items.extern.fn.param-patterns]
Patterns are not allowed in parameters, only [IDENTIFIER] or `_` may be used.

r[items.extern.fn.qualifiers]
The `safe` and `unsafe` function qualifiers are allowed, but other function qualifiers (e.g. `const`, `async`, `extern`) are not.
The `safe` and `unsafe` function qualifiers are allowed, but other function qualifiers (e.g. `const`, `async`, `extern`) are not. The `safe` qualifier is rejected in `extern "custom"` blocks.

r[items.extern.fn.foreign-abi]
Functions within external blocks may be called by Rust code, just like functions defined in Rust. The Rust compiler automatically translates between the Rust ABI and the foreign ABI.
Expand Down Expand Up @@ -112,6 +112,9 @@ r[items.extern.abi.system]
r[items.extern.abi.unwind]
* `extern "C-unwind"` and `extern "system-unwind"` --- Identical to `"C"` and `"system"`, respectively, but with [different behavior][unwind-behavior] when the callee unwinds (by panicking or throwing a C++ style exception).
r[items.extern.abi.custom]
* `unsafe extern "custom"` --- A custom ABI that is not known to the compiler.
r[items.extern.abi.platform]
There are also some platform-specific ABI strings:
Expand Down
17 changes: 17 additions & 0 deletions src/items/functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,21 @@ With `panic=unwind`, when a `panic` is turned into an abort by a non-unwinding A

For other considerations and limitations regarding unwinding across FFI boundaries, see the [relevant section in the Panic documentation][panic-ffi].

r[items.fn.extern.custom]
An `extern "custom"` function has an unknown, custom ABI. The only way to call such a function is via [inline assembly].

@tgross35 tgross35 Jun 28, 2026 •
edited by rustbot
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a usage hint:

... unknown, custom ABI. This can be used to implement calling conventions unsupported by rustc. The only way to call such a function is via [inline assembly].

View changes since the review


r[items.fn.extern.custom.safety]
An `extern "custom"` function must be `unsafe`.

r[items.fn.extern.custom.parameters]
An `extern "custom"` function does not have any parameters.

r[items.fn.extern.custom.return-type]
An `extern "custom"` function must return the [unit type].

r[items.fn.extern.custom.naked]
An `extern "custom"` function definition must be a [naked function].

Comment on lines +242 to +256

@traviscross traviscross Jul 28, 2026 •
edited by rustbot
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to add the rules here about what's allowed or not allowed in terms of parameters and return types.

View changes since the review

@traviscross traviscross Jul 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rustbot author

@traviscross traviscross Jul 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And we need to add text about the function pointer restrictions as well.

@folkertdev folkertdev Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where should that function pointer text go? Here on the item and/or in external-blocks.md, or somewhere else?

[forced-unwinding]: https://rust-lang.github.io/rfcs/2945-c-unwind-abi.html#forced-unwinding
[panic handler]: ../panic.md#the-panic_handler-attribute
[panic-ffi]: ../panic.md#unwinding-across-ffi-boundaries
Expand Down Expand Up @@ -411,6 +426,7 @@ fn foo_oof(#[some_inert_attribute] arg: u8) {
[testing attributes]: ../attributes/testing.md
[`cold`]: ../attributes/codegen.md#the-cold-attribute
[`inline`]: ../attributes/codegen.md#the-inline-attribute
[naked function]: ../attributes/codegen.md#the-naked-attribute
[`deprecated`]: ../attributes/diagnostics.md#the-deprecated-attribute
[`doc`]: ../../rustdoc/the-doc-attribute.html
[`must_use`]: ../attributes/diagnostics.md#the-must_use-attribute
Expand All @@ -427,3 +443,4 @@ fn foo_oof(#[some_inert_attribute] arg: u8) {
[variadic function]: external-blocks.md#variadic-functions
[`extern` block]: external-blocks.md
[zero-sized]: glossary.zst
[inline assembly]: ../inline-assembly.md
Loading