-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Add a used attribute #1459
Closed
Closed
Add a used attribute #1459
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
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 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,62 @@ | ||
- Feature Name: preserve | ||
- Start Date: 2016-01-11 | ||
- RFC PR: (leave this empty) | ||
- Rust Issue: (leave this empty) | ||
|
||
# Summary | ||
[summary]: #summary | ||
|
||
Add a `preserve` attribute to prevent symbols from being discarded. This | ||
attribute is similar to GCC's `used` attribute. | ||
|
||
# Motivation | ||
[motivation]: #motivation | ||
|
||
The compiler cannot always see all references to a symbol. For example, if a | ||
symbol is only referenced from inline assembly, the compiler might think that | ||
the symbol is unused. | ||
|
||
If the compiler thinks that a symbol is unused, it might optimize the symbol | ||
away which might change the behavior of the program or cause the linking step to | ||
fail. For example: | ||
|
||
```rust | ||
#![allow(dead_code)] | ||
|
||
#[link_section = ".init_array"] | ||
static F: extern fn() = f; | ||
|
||
extern fn f() { | ||
println!("test"); | ||
} | ||
|
||
fn main() { } | ||
``` | ||
|
||
When this program is compiled without optimization, it prints "test". But if it | ||
is compiled with optimization, it prints nothing. | ||
|
||
# Detailed design | ||
[design]: #detailed-design | ||
|
||
A `#[preserve]` attribute is added. This attribute can be applied to static | ||
variables and functions without type parameters. | ||
|
||
If an item is marked with this attribute, the compiler generates the | ||
corresponding symbol and the symbol is not discarded by the compilation process. | ||
It may be discarded by the linking process. | ||
|
||
# Drawbacks | ||
[drawbacks]: #drawbacks | ||
|
||
None. | ||
|
||
# Alternatives | ||
[alternatives]: #alternatives | ||
|
||
The name of the attribute could be changed. | ||
|
||
# Unresolved questions | ||
[unresolved]: #unresolved-questions | ||
|
||
None. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that this drawbacks section should probably at least mention that "may be discarded by the linker" can in some cases be confusing. In annotating a symbol as
#[preserve]
one might expect it to be preserved but it may not make it all the way through.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One might expect that
#[inline]
inlines the function but that's not true either.