Skip to content
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

Emit error when trying to use assembler syntax directives in asm! #82270

Merged
merged 4 commits into from
Mar 18, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
53 changes: 52 additions & 1 deletion compiler/rustc_builtin_macros/src/asm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ use rustc_errors::{Applicability, DiagnosticBuilder};
use rustc_expand::base::{self, *};
use rustc_parse::parser::Parser;
use rustc_parse_format as parse;
use rustc_span::symbol::{kw, sym, Symbol};
use rustc_span::{
symbol::{kw, sym, Symbol},
BytePos,
};
use rustc_span::{InnerSpan, Span};

struct AsmArgs {
Expand Down Expand Up @@ -465,6 +468,54 @@ fn expand_preparsed_asm(ecx: &mut ExtCtxt<'_>, sp: Span, args: AsmArgs) -> P<ast
for piece in unverified_pieces {
match piece {
parse::Piece::String(s) => {
if let Some(idx) = s.find(".intel_syntax") {
let mut end = idx + ".intel_syntax".len();
if let Some(prefix_idx) = s.split_at(end).1.find("noprefix") {
nagisa marked this conversation as resolved.
Show resolved Hide resolved
// Should be a space and it should be immediately after
nagisa marked this conversation as resolved.
Show resolved Hide resolved
if prefix_idx == 1 {
end += " noprefix".len();
}
}

let syntax_span =
template_span.from_inner(InnerSpan::new(idx + 1, end + 1));
let mut err = ecx.struct_span_err(syntax_span, "intel sytnax is the default syntax, and trying to use this directive may cause issues");
nagisa marked this conversation as resolved.
Show resolved Hide resolved
err.span_suggestion(
syntax_span,
"Remove this assembler directive",
nagisa marked this conversation as resolved.
Show resolved Hide resolved
s.replace(&s[idx..end], "").to_string(),
Applicability::MachineApplicable,
);
err.emit();
}

if let Some(idx) = s.find(".att_syntax") {
nagisa marked this conversation as resolved.
Show resolved Hide resolved
let mut end = idx + ".att_syntax".len();
if let Some(prefix_idx) = s.split_at(end).1.find("noprefix") {
// Should be a space and it should be immediately after
if prefix_idx == 1 {
end += " noprefix".len();
}
}

let syntax_span =
template_span.from_inner(InnerSpan::new(idx + 1, end + 1));
let mut err = ecx.struct_span_err(syntax_span, "using the .att_syntax directive may cause issues, use the att_syntax option instead");
let asm_end = sp.hi() - BytePos(2);
let suggestions = vec![
(syntax_span, "".to_string()),
(
Span::new(asm_end, asm_end, sp.ctxt()),
", options(att_syntax)".to_string(),
),
];
err.multipart_suggestion(
"Remove the assembler directive and replace it with options(att_syntax)",
suggestions,
Applicability::MachineApplicable,
);
err.emit();
}
template.push(ast::InlineAsmTemplatePiece::String(s.to_string()))
}
parse::Piece::NextArgument(arg) => {
Expand Down
14 changes: 14 additions & 0 deletions src/test/ui/asm/inline-syntax.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#![feature(asm, llvm_asm)]
Copy link
Member

Choose a reason for hiding this comment

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

This test needs to be conditional on target, or specify via compiler-flags what target to use. In later case, you will also need to make the test no_core – you can look at the other assembly tests (such as src/test/assembly/asm/x86-types.rs) to see how to set that up.

Copy link
Member

@nagisa nagisa Mar 7, 2021

Choose a reason for hiding this comment

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

The test should also check the behaviour when the target isn't x86_64, this can be done through revisions, you can see how those are used in the same x86-types.rs test as well.


fn main() {
unsafe {
asm!(".intel_syntax noprefix", "nop");
//~^ ERROR intel sytnax is the default syntax
asm!(".intel_syntax aaa noprefix", "nop");
//~^ ERROR intel sytnax is the default syntax
asm!(".att_syntax noprefix", "nop");
//~^ ERROR using the .att_syntax directive may cause issues
asm!(".att_syntax bbb noprefix", "nop");
//~^ ERROR using the .att_syntax directive may cause issues
}
}
36 changes: 36 additions & 0 deletions src/test/ui/asm/inline-syntax.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
error: intel sytnax is the default syntax, and trying to use this directive may cause issues
--> $DIR/inline-syntax.rs:5:15
|
LL | asm!(".intel_syntax noprefix", "nop");
| ^^^^^^^^^^^^^^^^^^^^^^ help: Remove this assembler directive

error: intel sytnax is the default syntax, and trying to use this directive may cause issues
--> $DIR/inline-syntax.rs:7:15
|
LL | asm!(".intel_syntax aaa noprefix", "nop");
| ^^^^^^^^^^^^^ help: Remove this assembler directive: `aaa noprefix`

error: using the .att_syntax directive may cause issues, use the att_syntax option instead
--> $DIR/inline-syntax.rs:9:15
|
LL | asm!(".att_syntax noprefix", "nop");
| ^^^^^^^^^^^^^^^^^^^^
|
help: Remove the assembler directive and replace it with options(att_syntax)
|
LL | asm!("", "nop", options(att_syntax));
| -- ^^^^^^^^^^^^^^^^^^^^^

error: using the .att_syntax directive may cause issues, use the att_syntax option instead
--> $DIR/inline-syntax.rs:11:15
|
LL | asm!(".att_syntax bbb noprefix", "nop");
| ^^^^^^^^^^^
|
help: Remove the assembler directive and replace it with options(att_syntax)
|
LL | asm!(" bbb noprefix", "nop", options(att_syntax));
| -- ^^^^^^^^^^^^^^^^^^^^^

error: aborting due to 4 previous errors