refactor(debug)!: refactor handling of the exit code

This makes it consistent with `std::process::ExitCode` and `semihosting::process::ExitCode`.
ROMemories · Dec 12, 2024 · 94d2c18 · 94d2c18
1 parent 5a9119c
commit 94d2c18
Show file tree

Hide file tree

Showing 17 changed files with 57 additions and 38 deletions.
diff --git a/examples/device-metadata/src/main.rs b/examples/device-metadata/src/main.rs
@@ -2,7 +2,7 @@
 #![no_std]
 #![feature(used_with_arg)]
 
-use ariel_os::debug::{exit, log::*, EXIT_SUCCESS};
+use ariel_os::debug::{exit, log::*, ExitCode};
 
 #[ariel_os::thread(autostart)]
 fn main() {
@@ -17,5 +17,5 @@ fn main() {
         info!("Device's first EUI-48 address: {}", eui48);
     }
 
-    exit(EXIT_SUCCESS);
+    exit(ExitCode::SUCCESS);
 }
diff --git a/examples/hello-world-threading/src/main.rs b/examples/hello-world-threading/src/main.rs
@@ -2,11 +2,11 @@
 #![no_std]
 #![feature(used_with_arg)]
 
-use ariel_os::debug::{exit, log::*};
+use ariel_os::debug::{exit, log::*, ExitCode};
 
 #[ariel_os::thread(autostart)]
 fn main() {
     info!("Hello World!");
 
-    exit(Ok(()));
+    exit(ExitCode::SUCCESS);
 }
diff --git a/examples/hello-world/src/main.rs b/examples/hello-world/src/main.rs
@@ -3,11 +3,11 @@
 #![feature(impl_trait_in_assoc_type)]
 #![feature(used_with_arg)]
 
-use ariel_os::debug::{exit, log::*};
+use ariel_os::debug::{exit, log::*, ExitCode};
 
 #[ariel_os::task(autostart)]
 async fn main() {
     info!("Hello World!");
 
-    exit(Ok(()));
+    exit(ExitCode::SUCCESS);
 }
diff --git a/examples/storage/src/main.rs b/examples/storage/src/main.rs
@@ -6,6 +6,7 @@
 use ariel_os::debug::{
     exit,
     log::{defmt, info},
+    ExitCode,
 };
 
 // Imports for using [`ariel_os::storage`]
@@ -35,7 +36,7 @@ async fn main() {
 
     if value > 10 {
         info!("counter value > 10, aborting test to safe flash cycles.");
-        exit(Ok(()));
+        exit(ExitCode::SUCCESS);
     }
 
     storage::insert("counter", value + 1).await.unwrap();
@@ -110,5 +111,5 @@ async fn main() {
     }
     info!("bye from storage test!");
 
-    exit(Ok(()));
+    exit(ExitCode::SUCCESS);
 }
diff --git a/examples/thread-async-interop/src/main.rs b/examples/thread-async-interop/src/main.rs
@@ -7,7 +7,7 @@ use embassy_sync::{blocking_mutex::raw::CriticalSectionRawMutex, signal::Signal}
 
 use ariel_os::{
     asynch::{blocker, spawner},
-    debug::{exit, log::*},
+    debug::{exit, log::*, ExitCode},
     time::{Duration, Instant, Timer},
 };
 
@@ -47,5 +47,5 @@ fn main() {
 
     info!("main(): all good, exiting.");
 
-    exit(Ok(()));
+    exit(ExitCode::SUCCESS);
 }
diff --git a/examples/threading-event/src/main.rs b/examples/threading-event/src/main.rs
@@ -2,7 +2,7 @@
 #![no_std]
 #![feature(used_with_arg)]
 
-use ariel_os::debug::{log::*, EXIT_SUCCESS};
+use ariel_os::debug::{log::*, ExitCode};
 use ariel_os::thread::{sync::Event, ThreadId};
 
 static EVENT: Event = Event::new();
@@ -16,7 +16,7 @@ fn waiter() {
 
     if my_id == ThreadId::new(0) {
         info!("All five threads should have reported \"Done.\". exiting.");
-        ariel_os::debug::exit(EXIT_SUCCESS);
+        ariel_os::debug::exit(ExitCode::SUCCESS);
     }
 }
 

diff --git a/src/ariel-os-debug/src/lib.rs b/src/ariel-os-debug/src/lib.rs
@@ -14,17 +14,35 @@ compile_error!(
     r#"feature "debug-console" enabled but no backend. Select feature "rtt-target" or feature "esp-println"."#
 );
 
-pub const EXIT_SUCCESS: Result<(), ()> = Ok(());
-pub const EXIT_FAILURE: Result<(), ()> = Err(());
-pub fn exit(code: Result<(), ()>) {
-    let code = match code {
-        EXIT_FAILURE => 1,
-        EXIT_SUCCESS => 0,
-    };
+/// Represents the exit code of a debug output.
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
+pub enum ExitCode {
+    #[doc(hidden)]
+    Success,
+    #[doc(hidden)]
+    Failure,
+}
+
+impl ExitCode {
+    /// The [`ExitCode`] for success.
+    pub const SUCCESS: Self = Self::Success;
+    /// The [`ExitCode`] for failure.
+    pub const FAILURE: Self = Self::Failure;
+
+    #[allow(dead_code, reason = "not always used due to conditional compilation")]
+    fn to_semihosting_code(self) -> i32 {
+        match self {
+            Self::Success => 0,
+            Self::Failure => 1,
+        }
+    }
+}
 
+pub fn exit(code: ExitCode) {
     loop {
         #[cfg(feature = "semihosting")]
-        semihosting::process::exit(code);
+        semihosting::process::exit(code.to_semihosting_code());
+
         #[cfg(not(feature = "semihosting"))]
         {
             let _ = code;

diff --git a/src/ariel-os-rt/src/cortexm.rs b/src/ariel-os-rt/src/cortexm.rs
@@ -174,7 +174,7 @@ unsafe fn DefaultHandler(_irqn: i16) {
     #[cfg(not(feature = "silent-panic"))]
     {
         ariel_os_debug::log::debug!("IRQn = {}", _irqn);
-        ariel_os_debug::exit(ariel_os_debug::EXIT_FAILURE);
+        ariel_os_debug::exit(ariel_os_debug::ExitCode::FAILURE);
     }
     #[allow(clippy::empty_loop)]
     loop {}

diff --git a/src/ariel-os-rt/src/lib.rs b/src/ariel-os-rt/src/lib.rs
@@ -52,7 +52,7 @@ fn panic(_info: &core::panic::PanicInfo) -> ! {
     #[cfg(not(feature = "silent-panic"))]
     {
         ariel_os_debug::println!("panic: {}\n", _info);
-        ariel_os_debug::exit(ariel_os_debug::EXIT_FAILURE);
+        ariel_os_debug::exit(ariel_os_debug::ExitCode::FAILURE);
     }
     #[allow(clippy::empty_loop)]
     loop {}

diff --git a/src/ariel-os-threads/et-tests/src/bin/locktest_threethreads.rs b/src/ariel-os-threads/et-tests/src/bin/locktest_threethreads.rs
@@ -3,7 +3,7 @@
 
 use cortex_m_rt::entry;
 use cortex_m_semihosting::{
-    debug::{self, EXIT_SUCCESS},
+    debug::{self, ExitCode},
     hprintln as println,
 };
 
@@ -80,7 +80,7 @@ fn main() -> ! {
 
     println!("main() shouldn't be here");
     // exit via semihosting call
-    debug::exit(EXIT_SUCCESS);
+    debug::exit(ExitCode::SUCCESS);
 
     // the cortex_m_rt `entry` macro requires `main()` to never return
     loop {}

diff --git a/src/ariel-os-threads/et-tests/src/bin/thread_flags_basic.rs b/src/ariel-os-threads/et-tests/src/bin/thread_flags_basic.rs
@@ -3,7 +3,7 @@
 
 use cortex_m_rt::entry;
 use cortex_m_semihosting::{
-    debug::{self, EXIT_SUCCESS},
+    debug::{self, ExitCode},
     hprintln as println,
 };
 
@@ -56,7 +56,7 @@ fn main() -> ! {
 
     println!("main() shouldn't be here");
     // exit via semihosting call
-    debug::exit(EXIT_SUCCESS);
+    debug::exit(ExitCode::SUCCESS);
 
     // the cortex_m_rt `entry` macro requires `main()` to never return
     loop {}

diff --git a/src/ariel-os-threads/et-tests/src/bin/twothread_channel.rs b/src/ariel-os-threads/et-tests/src/bin/twothread_channel.rs
@@ -3,7 +3,7 @@
 
 use cortex_m_rt::entry;
 use cortex_m_semihosting::{
-    debug::{self, EXIT_SUCCESS},
+    debug::{self, ExitCode},
     hprintln as println,
 };
 
@@ -72,7 +72,7 @@ fn main() -> ! {
     unsafe { start_threading() };
 
     // exit via semihosting call
-    debug::exit(EXIT_SUCCESS);
+    debug::exit(ExitCode::SUCCESS);
 
     // the cortex_m_rt `entry` macro requires `main()` to never return
     loop {}

diff --git a/src/ariel-os-threads/et-tests/src/bin/twothread_locktest.rs b/src/ariel-os-threads/et-tests/src/bin/twothread_locktest.rs
@@ -3,7 +3,7 @@
 
 use cortex_m_rt::entry;
 use cortex_m_semihosting::{
-    debug::{self, EXIT_SUCCESS},
+    debug::{self, ExitCode},
     hprintln as println,
 };
 
@@ -60,7 +60,7 @@ fn main() -> ! {
 
     println!("main() shouldn't be here");
     // exit via semihosting call
-    debug::exit(EXIT_SUCCESS);
+    debug::exit(ExitCode::SUCCESS);
 
     // the cortex_m_rt `entry` macro requires `main()` to never return
     loop {}

diff --git a/src/ariel-os-threads/et-tests/src/bin/twothreads.rs b/src/ariel-os-threads/et-tests/src/bin/twothreads.rs
@@ -3,7 +3,7 @@
 
 use cortex_m_rt::entry;
 use cortex_m_semihosting::{
-    debug::{self, EXIT_SUCCESS},
+    debug::{self, ExitCode},
     hprintln as println,
 };
 
@@ -35,7 +35,7 @@ fn main() -> ! {
 
     println!("main() shouldn't be here");
     // exit via semihosting call
-    debug::exit(EXIT_SUCCESS);
+    debug::exit(ExitCode::SUCCESS);
 
     // the cortex_m_rt `entry` macro requires `main()` to never return
     loop {}

diff --git a/tests/i2c-controller/src/main.rs b/tests/i2c-controller/src/main.rs
@@ -16,7 +16,7 @@ use ariel_os::{
     debug::{
         exit,
         log::{debug, info},
-        EXIT_SUCCESS,
+        ExitCode,
     },
     hal,
     i2c::controller::{highest_freq_in, I2cDevice, Kilohertz},
@@ -57,5 +57,5 @@ async fn main(peripherals: pins::Peripherals) {
 
     info!("Test passed!");
 
-    exit(EXIT_SUCCESS);
+    exit(ExitCode::SUCCESS);
 }
diff --git a/tests/spi-loopback/src/main.rs b/tests/spi-loopback/src/main.rs
@@ -14,7 +14,7 @@ use ariel_os::{
     debug::{
         exit,
         log::{debug, info},
-        EXIT_SUCCESS,
+        ExitCode,
     },
     gpio, hal,
     spi::{
@@ -63,5 +63,5 @@ async fn main(peripherals: pins::Peripherals) {
 
     info!("Test passed!");
 
-    exit(EXIT_SUCCESS);
+    exit(ExitCode::SUCCESS);
 }
diff --git a/tests/spi-main/src/main.rs b/tests/spi-main/src/main.rs
@@ -16,7 +16,7 @@ use ariel_os::{
     debug::{
         exit,
         log::{debug, info},
-        EXIT_SUCCESS,
+        ExitCode,
     },
     gpio, hal,
     spi::{
@@ -73,7 +73,7 @@ async fn main(peripherals: pins::Peripherals) {
 
     info!("Test passed!");
 
-    exit(EXIT_SUCCESS);
+    exit(ExitCode::SUCCESS);
 }
 
 fn get_spi_read_command(addr: u8) -> u8 {