add compile-fail tests; test only on nightly

we'll test on beta when 1.30-beta is out

Author: japaric

cortex-m-rt/.travis.yml

@@ -3,24 +3,29 @@ language: rust
 matrix:
   include:
     - env: TARGET=x86_64-unknown-linux-gnu
-      rust: stable
-      if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
-
-    - env: TARGET=thumbv6m-none-eabi
-      rust: stable
-      if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
-
-    - env: TARGET=thumbv7m-none-eabi
-      rust: stable
-      if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
-
-    - env: TARGET=thumbv7em-none-eabi
-      rust: stable
+      # TODO switch to 1.30-beta
+      rust: nightly
       if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
 
-    - env: TARGET=thumbv7em-none-eabihf
-      rust: stable
-      if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
+      # TODO enable when 1.30-beta is out
+    # - env: TARGET=thumbv6m-none-eabi
+    #   rust: beta
+    #   if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
+
+      # TODO enable when 1.30-beta is out
+    # - env: TARGET=thumbv7m-none-eabi
+    #   rust: beta
+    #   if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
+
+      # TODO enable when 1.30-beta is out
+    # - env: TARGET=thumbv7em-none-eabi
+    #   rust: beta
+    #   if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
+
+      # TODO enable when 1.30-beta is out
+    # - env: TARGET=thumbv7em-none-eabihf
+    #   rust: beta
+    #   if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master)
 
     - env: TARGET=thumbv6m-none-eabi
       rust: nightly

cortex-m-rt/Cargo.toml

@@ -15,9 +15,12 @@ r0 = "0.2.1"
 cortex-m-rt-macros = { path = "macros", version = "0.1.0" }
 
 [dev-dependencies]
-panic-semihosting = "0.3.0"
-panic-abort = "0.2.0"
 cortex-m = "0.5.4"
+panic-abort = "0.3.0"
+panic-semihosting = "0.4.0"
+
+[target.'cfg(not(target_os = "none"))'.dev-dependencies]
+compiletest_rs = "0.3.14"
 
 [features]
 device = []

cortex-m-rt/ci/script.sh

@@ -5,7 +5,11 @@ main() {
 
     cargo check --target $TARGET --features device
 
-    ( cd macros && cargo check && cargo test )
+    if [ $TARGET = x86_64-unknown-linux-gnu ]; then
+        ( cd macros && cargo check && cargo test )
+
+        cargo test --test compiletest
+    fi
 
     local examples=(
         alignment
@@ -18,7 +22,7 @@ main() {
     local fail_examples=(
         data_overflow
     )
-    if [ $TRAVIS_RUST_VERSION = nightly ]; then
+    if [ $TARGET != x86_64-unknown-linux-gnu ]; then
         # linking with GNU LD
         for ex in "${examples[@]}"; do
             cargo rustc --target $TARGET --example $ex -- \

cortex-m-rt/macros/src/lib.rs

@@ -124,6 +124,8 @@ pub fn entry(args: TokenStream, input: TokenStream) -> TokenStream {
         }).collect::<Vec<_>>();
 
     quote!(
+        // TODO(forbid) see tests/compile-fail/entry-hidden.rs
+        // #[forbid(dead_code)]
         #[export_name = "main"]
         #(#attrs)*
         pub fn #ident() -> ! {
@@ -297,7 +299,7 @@ pub fn exception(args: TokenStream, input: TokenStream) -> TokenStream {
                             _ => false,
                         },
                     },
-                "`#DefaultHandler` function must have signature `fn(i16)`"
+                "`DefaultHandler` exception must have signature `fn(i16)`"
             );
 
             let arg = match f.decl.inputs[0] {
@@ -345,7 +347,7 @@ pub fn exception(args: TokenStream, input: TokenStream) -> TokenStream {
                             _ => false,
                         },
                     },
-                "`#[exception(HardFault)]` function must have signature `fn(&ExceptionFrame) -> !`"
+                "`HardFault` exception must have signature `fn(&ExceptionFrame) -> !`"
             );
 
             let arg = match f.decl.inputs[0] {

cortex-m-rt/tests/compile-fail/default-handler-bad-signature-1.rs

@@ -0,0 +1,16 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::{entry, exception};
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+#[exception] //~ ERROR custom attribute panicked
+//~^ HELP `DefaultHandler` exception must have signature `fn(i16)`
+fn DefaultHandler(_irqn: i16, undef: u32) {}

cortex-m-rt/tests/compile-fail/default-handler-bad-signature-2.rs

@@ -0,0 +1,16 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::{entry, exception};
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+#[exception] //~ ERROR custom attribute panicked
+//~^ HELP `DefaultHandler` exception must have signature `fn(i16)`
+unsafe fn DefaultHandler(_irqn: i16) {}

cortex-m-rt/tests/compile-fail/default-handler-bad-signature-3.rs

@@ -0,0 +1,18 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::{entry, exception};
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+#[exception] //~ ERROR custom attribute panicked
+//~^ HELP `DefaultHandler` exception must have signature `fn(i16)`
+fn DefaultHandler(_irqn: i16) -> ! {
+    loop {}
+}

cortex-m-rt/tests/compile-fail/default-handler-hidden.rs

@@ -0,0 +1,22 @@
+// ignore-test :sadface: it's not possible to prevent this user error at compile time
+// see rust-lang/rust#53975 for details
+
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::{entry, exception};
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+mod hidden {
+    use cortex_m_rt::exception;
+
+    #[exception]
+    fn DefaultHandler(_irqn: i16) {}
+}

cortex-m-rt/tests/compile-fail/default-handler-twice.rs

@@ -0,0 +1,22 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::{entry, exception};
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+#[exception]
+fn DefaultHandler(_irqn: i16) {}
+
+pub mod reachable {
+    use cortex_m_rt::exception;
+
+    #[exception] //~ ERROR symbol `DefaultHandler` is already defined
+    fn DefaultHandler(_irqn: i16) {}
+}

cortex-m-rt/tests/compile-fail/entry-bad-signature-1.rs

@@ -0,0 +1,11 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::entry;
+
+#[entry] //~ ERROR custom attribute panicked
+//~^ HELP `#[entry]` function must have signature `fn() -> !`
+fn foo() {}

cortex-m-rt/tests/compile-fail/entry-bad-signature-2.rs

@@ -0,0 +1,11 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::entry;
+
+#[entry] //~ ERROR custom attribute panicked
+//~^ HELP `#[entry]` function must have signature `fn() -> !`
+fn foo(undef: i32) -> ! {}

cortex-m-rt/tests/compile-fail/entry-bad-signature-3.rs

@@ -0,0 +1,13 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::entry;
+
+#[entry] //~ ERROR custom attribute panicked
+//~^ HELP `#[entry]` function must have signature `fn() -> !`
+unsafe fn foo() -> ! {
+    loop {}
+}

cortex-m-rt/tests/compile-fail/entry-bad-signature-4.rs

@@ -0,0 +1,13 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::entry;
+
+#[entry] //~ ERROR custom attribute panicked
+//~^ HELP `#[entry]` function must have signature `fn() -> !`
+extern "C" fn foo() -> ! {
+    loop {}
+}

cortex-m-rt/tests/compile-fail/entry-hidden.rs

@@ -0,0 +1,19 @@
+// ignore-test :sadface: it's not possible to prevent this user error at compile time
+// see rust-lang/rust#53975 for details
+
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+mod hidden {
+    use cortex_m_rt::entry;
+
+    // this function needs to be "reachable" (all modules between it and the crate root must be
+    // `pub`) or linking will fail
+    #[entry]
+    fn foo() -> ! { //~ ERROR function is never used
+        loop {}
+    }
+}

cortex-m-rt/tests/compile-fail/entry-twice.rs

@@ -0,0 +1,17 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::entry;
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+#[entry] //~ ERROR symbol `main` is already defined
+fn bar() -> ! {
+    loop {}
+}

cortex-m-rt/tests/compile-fail/exception-bad-signature-1.rs

@@ -0,0 +1,16 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::{entry, exception};
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+#[exception] //~ ERROR custom attribute panicked
+//~^ HELP `#[exception]` functions other than `DefaultHandler` and `HardFault` must have signature `fn()`
+fn SysTick(undef: u32) {}

cortex-m-rt/tests/compile-fail/exception-bad-signature-2.rs

@@ -0,0 +1,16 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::{entry, exception};
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+#[exception] //~ ERROR custom attribute panicked
+//~^ HELP `#[exception]` functions other than `DefaultHandler` and `HardFault` must have signature `fn()`
+unsafe fn SysTick() {}

cortex-m-rt/tests/compile-fail/exception-bad-signature-3.rs

@@ -0,0 +1,18 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::{entry, exception};
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+#[exception] //~ ERROR custom attribute panicked
+//~^ HELP `#[exception]` functions other than `DefaultHandler` and `HardFault` must have signature `fn()`
+fn SysTick() -> ! {
+    loop {}
+}

cortex-m-rt/tests/compile-fail/exception-hidden.rs

@@ -0,0 +1,22 @@
+// ignore-test :sadface: it's not possible to prevent this user error at compile time
+// see rust-lang/rust#53975 for details
+
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::{entry, exception};
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+mod hidden {
+    use cortex_m_rt::exception;
+
+    #[exception]
+    fn SysTick() {}
+}

cortex-m-rt/tests/compile-fail/exception-twice.rs

@@ -0,0 +1,22 @@
+#![no_main]
+#![no_std]
+
+extern crate cortex_m_rt;
+extern crate panic_semihosting;
+
+use cortex_m_rt::{entry, exception};
+
+#[entry]
+fn foo() -> ! {
+    loop {}
+}
+
+#[exception]
+fn SysTick() {}
+
+pub mod reachable {
+    use cortex_m_rt::exception;
+
+    #[exception] //~ ERROR symbol `SysTick` is already defined
+    fn SysTick() {}
+}