Skip to content

Commit a18deee

Browse files
committed
Revise changes for unsafe extern blocks
We made an editing pass on the changes for `unsafe extern` blocks. We fixed some editorial items and aligned some stylistic points with the rest of the Reference. We did some rewording that also had the effect of minimizing the changes a bit further. In the examples, we added `safe` and `unsafe` qualifiers to items, as the RFC suggests that this is the preferred way to write these.
1 parent adff1fd commit a18deee

File tree

3 files changed

+27
-24
lines changed

3 files changed

+27
-24
lines changed

src/items/external-blocks.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -21,38 +21,39 @@ Two kinds of item _declarations_ are allowed in external blocks: [functions] and
2121
[statics]. Calling functions or accessing statics that are declared in external
2222
blocks is only allowed in an `unsafe` context.
2323

24-
Starting in edition 2024, the `unsafe` keyword is required to appear before the
25-
`extern` keyword. In previous editions is accepted but not required.
24+
**Edition differences**: Starting in the 2024 edition, the `unsafe` keyword is
25+
required to appear before the `extern` keyword on external blocks. In previous
26+
editions, it is accepted but not required.
2627

2728
## Functions
2829

2930
Functions within external blocks are declared in the same way as other Rust
3031
functions, with the exception that they must not have a body and are instead
3132
terminated by a semicolon. Patterns are not allowed in parameters, only
32-
[IDENTIFIER] or `_` may be used. Only safety funcion qualifiers are allowed
33-
(`unsafe`, `safe`), other function qualifiers (`const`, `async`, and `extern`)
34-
are not allowed.
33+
[IDENTIFIER] or `_` may be used. The `safe` and `unsafe` function qualifiers are
34+
allowed, but other function qualifiers (e.g. `const`, `async`, `extern`) are
35+
not.
3536

3637
Functions within external blocks may be called by Rust code, just like
3738
functions defined in Rust. The Rust compiler automatically translates between
3839
the Rust ABI and the foreign ABI.
3940

40-
A function declared with an explicit safety qualifier (`unsafe`, `safe`) would
41-
take such safety qualification, if no qualifier is present is implicitly
42-
`unsafe`. When coerced to a function pointer, a function declared in an extern
43-
block has type `unsafe extern "abi" for<'l1, ..., 'lm> fn(A1, ..., An) -> R`,
44-
where `'l1`, ... `'lm` are its lifetime parameters, `A1`, ..., `An` are the
45-
declared types of its parameters and `R` is the declared return type.
41+
A function declared in an extern block is implicitly `unsafe` unless the `safe`
42+
function qualifier is present.
43+
44+
When coerced to a function pointer, a function declared in an extern block has
45+
type `extern "abi" for<'l1, ..., 'lm> fn(A1, ..., An) -> R`, where `'l1`,
46+
... `'lm` are its lifetime parameters, `A1`, ..., `An` are the declared types of
47+
its parameters, `R` is the declared return type.
4648

4749
## Statics
4850

4951
Statics within external blocks are declared in the same way as [statics] outside of external blocks,
5052
except that they do not have an expression initializing their value.
51-
It is `unsafe` by default or if the item is declared as `unsafe` to access a static item declared in
52-
an extern block, unless the item was explicitly declared as `safe`.
53-
It does not matter if it's mutable, because there is nothing guaranteeing that the bit pattern at
54-
the static's memory is valid for the type it is declared with, since some arbitrary (e.g. C) code is
55-
in charge of initializing the static.
53+
Unless a static item declared in an extern block is qualified as `safe`, it is `unsafe` to access that item, whether or
54+
not it's mutable, because there is nothing guaranteeing that the bit pattern at the static's
55+
memory is valid for the type it is declared with, since some arbitrary (e.g. C) code is in charge
56+
of initializing the static.
5657

5758
Extern statics can be either immutable or mutable just like [statics] outside of external blocks.
5859
An immutable static *must* be initialized before any Rust code is executed. It is not enough for
@@ -105,9 +106,9 @@ identifier.
105106

106107
```rust
107108
unsafe extern "C" {
108-
fn foo(...);
109-
fn bar(x: i32, ...);
110-
fn with_name(format: *const u8, args: ...);
109+
safe fn foo(...);
110+
unsafe fn bar(x: i32, ...);
111+
unsafe fn with_name(format: *const u8, args: ...);
111112
}
112113
```
113114

@@ -278,7 +279,7 @@ uses the [_MetaNameValueStr_] syntax to specify the name of the symbol.
278279
```rust
279280
unsafe extern {
280281
#[link_name = "actual_symbol_name"]
281-
fn name_in_rust();
282+
safe fn name_in_rust();
282283
}
283284
```
284285

@@ -307,7 +308,7 @@ it, and that assigned ordinal may change between builds of the binary.
307308
#[link(name = "exporter", kind = "raw-dylib")]
308309
unsafe extern "stdcall" {
309310
#[link_ordinal(15)]
310-
fn imported_function_stdcall(i: i32);
311+
safe fn imported_function_stdcall(i: i32);
311312
}
312313
```
313314

src/items/functions.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,11 @@ their _definition_:
158158
<!-- ignore: fake ABI -->
159159
```rust,ignore
160160
unsafe extern "ABI" {
161-
fn foo(); /* no body */
161+
unsafe fn foo(); /* no body */
162+
safe fn bar(); /* no body */
162163
}
163-
unsafe { foo() }
164+
unsafe { foo() };
165+
bar();
164166
```
165167

166168
When `"extern" Abi?*` is omitted from `FunctionQualifiers` in function items,

src/types/never.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ fn foo() -> ! {
1818

1919
```rust
2020
unsafe extern "C" {
21-
pub fn no_return_extern_func() -> !;
21+
pub safe fn no_return_extern_func() -> !;
2222
}
2323
```

0 commit comments

Comments
 (0)