Allow unused arguments in asm!

Author: Amanieu

Diff for: src/doc/unstable-book/src/library-features/asm.md

@@ -201,7 +201,7 @@ fn mul(a: u64, b: u64) -> u128 {
         );
     }
 
-    (hi as u128) << 64 + lo as u128
+    ((hi as u128) << 64) + lo as u128
 }
 ```
 
@@ -382,7 +382,9 @@ The macro will initially be supported only on ARM, AArch64, x86, x86-64 and RISC
 
 The assembler template uses the same syntax as [format strings][format-syntax] (i.e. placeholders are specified by curly braces). The corresponding arguments are accessed in order, by index, or by name. However, implicit named arguments (introduced by [RFC #2795][rfc-2795]) are not supported.
 
-As with format strings, named arguments must appear after positional arguments. Explicit register operands must appear at the end of the operand list, after any named arguments if any. Explicit register operands cannot be used by placeholders in the template string. All other operands must appear at least once in the template string, otherwise a compiler error is generated.
+As with format strings, named arguments must appear after positional arguments. Explicit register operands must appear at the end of the operand list, after named arguments if any.
+
+Explicit register operands cannot be used by placeholders in the template string. All other named and positional operands must appear at least once in the template string, otherwise a compiler error is generated.
 
 The exact assembly code syntax is target-specific and opaque to the compiler except for the way operands are substituted into the template string to form the code passed to the assembler.
 

Diff for: src/librustc_builtin_macros/asm.rs

@@ -3,10 +3,11 @@ use rustc_ast::ptr::P;
 use rustc_ast::token;
 use rustc_ast::tokenstream::TokenStream;
 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
-use rustc_errors::{Applicability, DiagnosticBuilder};
+use rustc_errors::{pluralize, Applicability, DiagnosticBuilder};
 use rustc_expand::base::{self, *};
 use rustc_parse::parser::Parser;
 use rustc_parse_format as parse;
+use rustc_session::lint::builtin::UNUSED_ASM_ARGUMENTS;
 use rustc_span::symbol::{kw, sym, Symbol};
 use rustc_span::{InnerSpan, Span};
 
@@ -485,34 +486,11 @@ fn expand_preparsed_asm(ecx: &mut ExtCtxt<'_>, sp: Span, args: AsmArgs) -> P<ast
         .into_iter()
         .enumerate()
         .filter(|&(_, used)| !used)
-        .map(|(idx, _)| {
-            if named_pos.contains(&idx) {
-                // named argument
-                (operands[idx].1, "named argument never used")
-            } else {
-                // positional argument
-                (operands[idx].1, "argument never used")
-            }
-        })
+        .map(|(idx, _)| operands[idx].1)
         .collect();
-    match unused_operands.len() {
-        0 => {}
-        1 => {
-            let (sp, msg) = unused_operands.into_iter().next().unwrap();
-            let mut err = ecx.struct_span_err(sp, msg);
-            err.span_label(sp, msg);
-            err.emit();
-        }
-        _ => {
-            let mut err = ecx.struct_span_err(
-                unused_operands.iter().map(|&(sp, _)| sp).collect::<Vec<Span>>(),
-                "multiple unused asm arguments",
-            );
-            for (sp, msg) in unused_operands {
-                err.span_label(sp, msg);
-            }
-            err.emit();
-        }
+    if !unused_operands.is_empty() {
+        let msg = format!("asm argument{} not used in template", pluralize!(unused_operands.len()));
+        ecx.parse_sess.buffer_lint(UNUSED_ASM_ARGUMENTS, unused_operands, ast::CRATE_NODE_ID, &msg);
     }
 
     let line_spans = if parser.line_spans.is_empty() {

Diff for: src/librustc_session/lint/builtin.rs

@@ -532,6 +532,12 @@ declare_lint! {
     "unsafe operations in unsafe functions without an explicit unsafe block are deprecated",
 }
 
+declare_lint! {
+    pub UNUSED_ASM_ARGUMENTS,
+    Warn,
+    "inline asm arguments not used in the template string",
+}
+
 declare_lint_pass! {
     /// Does nothing as a lint pass, but registers some `Lint`s
     /// that are used by other parts of the compiler.

Diff for: src/test/ui/asm/bad-template.rs

@@ -9,18 +9,20 @@ fn main() {
         //~^ ERROR invalid reference to argument at index 0
         asm!("{1}", in(reg) foo);
         //~^ ERROR invalid reference to argument at index 1
-        //~^^ ERROR argument never used
+        //~^^ WARN asm argument not used in template
         asm!("{a}");
         //~^ ERROR there is no argument named `a`
         asm!("{}", a = in(reg) foo);
         //~^ ERROR invalid reference to argument at index 0
-        //~^^ ERROR argument never used
+        //~^^ WARN asm argument not used in template
         asm!("{1}", a = in(reg) foo);
         //~^ ERROR invalid reference to argument at index 1
-        //~^^ ERROR named argument never used
+        //~^^ WARN asm argument not used in template
         asm!("{}", in("eax") foo);
         //~^ ERROR invalid reference to argument at index 0
         asm!("{:foo}", in(reg) foo);
         //~^ ERROR asm template modifier must be a single character
+        asm!("", in(reg) 0, in(reg) 1);
+        //~^ WARN asm arguments not used in template
     }
 }

Diff for: src/test/ui/asm/bad-template.stderr

@@ -14,12 +14,6 @@ LL |         asm!("{1}", in(reg) foo);
    |
    = note: there is 1 argument
 
-error: argument never used
-  --> $DIR/bad-template.rs:10:21
-   |
-LL |         asm!("{1}", in(reg) foo);
-   |                     ^^^^^^^^^^^ argument never used
-
 error: there is no argument named `a`
   --> $DIR/bad-template.rs:13:15
    |
@@ -41,12 +35,6 @@ note: named arguments cannot be referenced by position
 LL |         asm!("{}", a = in(reg) foo);
    |                    ^^^^^^^^^^^^^^^
 
-error: named argument never used
-  --> $DIR/bad-template.rs:15:20
-   |
-LL |         asm!("{}", a = in(reg) foo);
-   |                    ^^^^^^^^^^^^^^^ named argument never used
-
 error: invalid reference to argument at index 1
   --> $DIR/bad-template.rs:18:15
    |
@@ -55,12 +43,6 @@ LL |         asm!("{1}", a = in(reg) foo);
    |
    = note: no positional arguments were given
 
-error: named argument never used
-  --> $DIR/bad-template.rs:18:21
-   |
-LL |         asm!("{1}", a = in(reg) foo);
-   |                     ^^^^^^^^^^^^^^^ named argument never used
-
 error: invalid reference to argument at index 0
   --> $DIR/bad-template.rs:21:15
    |
@@ -82,5 +64,31 @@ error: asm template modifier must be a single character
 LL |         asm!("{:foo}", in(reg) foo);
    |                 ^^^
 
-error: aborting due to 10 previous errors
+warning: asm argument not used in template
+  --> $DIR/bad-template.rs:10:21
+   |
+LL |         asm!("{1}", in(reg) foo);
+   |                     ^^^^^^^^^^^
+   |
+   = note: `#[warn(unused_asm_arguments)]` on by default
+
+warning: asm argument not used in template
+  --> $DIR/bad-template.rs:15:20
+   |
+LL |         asm!("{}", a = in(reg) foo);
+   |                    ^^^^^^^^^^^^^^^
+
+warning: asm argument not used in template
+  --> $DIR/bad-template.rs:18:21
+   |
+LL |         asm!("{1}", a = in(reg) foo);
+   |                     ^^^^^^^^^^^^^^^
+
+warning: asm arguments not used in template
+  --> $DIR/bad-template.rs:25:18
+   |
+LL |         asm!("", in(reg) 0, in(reg) 1);
+   |                  ^^^^^^^^^  ^^^^^^^^^
+
+error: aborting due to 7 previous errors; 4 warnings emitted
 

Diff for: src/test/ui/asm/parse-error.rs

@@ -43,7 +43,7 @@ fn main() {
         //~^ ERROR arguments are not allowed after options
         asm!("{a}", a = const foo, a = const bar);
         //~^ ERROR duplicate argument named `a`
-        //~^^ ERROR argument never used
+        //~^^ WARN asm argument not used in template
         asm!("", a = in("eax") foo);
         //~^ ERROR explicit register arguments cannot have names
         asm!("{a}", in("eax") foo, a = const bar);

Diff for: src/test/ui/asm/parse-error.stderr

@@ -122,12 +122,6 @@ LL |         asm!("{a}", a = const foo, a = const bar);
    |                     |
    |                     previously here
 
-error: argument never used
-  --> $DIR/parse-error.rs:44:36
-   |
-LL |         asm!("{a}", a = const foo, a = const bar);
-   |                                    ^^^^^^^^^^^^^ argument never used
-
 error: explicit register arguments cannot have names
   --> $DIR/parse-error.rs:47:18
    |
@@ -158,5 +152,13 @@ LL |         asm!("{1}", in("eax") foo, const bar);
    |                     |
    |                     explicit register argument
 
-error: aborting due to 24 previous errors
+warning: asm argument not used in template
+  --> $DIR/parse-error.rs:44:36
+   |
+LL |         asm!("{a}", a = const foo, a = const bar);
+   |                                    ^^^^^^^^^^^^^
+   |
+   = note: `#[warn(unused_asm_arguments)]` on by default
+
+error: aborting due to 23 previous errors; 1 warning emitted