Merge #176

176:  implement RFCs 147 and 155, fix #141, etc. r=japaric a=japaric

This PR:

- Implements RFC 147: "all functions must be safe"

- Implements RFC 155: "explicit Context parameter"

- Implements the pending breaking change #141: reject assign syntax in `init`
  (which was used to initialize late resources)

- Refactors code generation to make it more readable -- there are no more random
  identifiers in the output -- and align it with the book description of RTFM
  internals (see PR #175).

- Makes the framework hard depend on `core::mem::MaybeUninit` and thus will
  require nightly until that API is stabilized.

- Fixes a ceiling analysis bug where the priority of the system timer was not
  considered in the analysis (TODO backport this into the v0.4.x branch).

- Shrinks the size of all the internal queues by turning `AtomicUsize` indices
  into `AtomicU8`s.

- Removes the integration with `owned_singleton`.

closes #141
closes #147
closes #155

Additionally:

- This changes CI to push v0.5.x docs to
  https://japaric.github.io/rtfm5/book/en/ -- we need to do this because our
  official docs are hosted on https://japaric.github.io/cortex-m-rtfm and we
  need to keep them on v0.4.x until we release v0.5.0

- I propose that we use the master branch to develop the upcoming v0.5.0.

- I have created a branch v0.4.x for backports; new v0.4.x releases will come
  from that branch.

r? @korken89 @texitoi, sorry for doing all the impl work in a single commit --
I know that makes things harder to review for you.

Suggestions for compile-pass and compile-fail tests are welcome


Co-authored-by: Jorge Aparicio <jorge@japaric.io>

1 files changed, 0 insertions, 61 deletions

diff --git a/examples/singleton.rs b/examples/singleton.rs
deleted file mode 100644
index 9e48e541..00000000
--- a/examples/singleton.rs
+++ /dev/null
@@ -1,61 +0,0 @@
-//! examples/singleton.rs
-
-#![deny(unsafe_code)]
-#![deny(warnings)]
-#![no_main]
-#![no_std]
-
-extern crate panic_semihosting;
-
-use alloc_singleton::stable::pool::{Box, Pool};
-use cortex_m_semihosting::{debug, hprintln};
-use lm3s6965::Interrupt;
-use rtfm::app;
-
-#[app(device = lm3s6965)]
-const APP: () = {
-    #[Singleton(Send)]
-    static mut M: [u32; 2] = [0; 2];
-
-    static mut P: Pool<M> = ();
-
-    #[init(resources = [M])]
-    fn init() -> init::LateResources {
-        rtfm::pend(Interrupt::I2C0);
-
-        init::LateResources {
-            P: Pool::new(resources.M),
-        }
-    }
-
-    #[interrupt(
-        priority = 2,
-        resources = [P],
-        spawn = [foo, bar],
-    )]
-    fn I2C0() {
-        spawn.foo(resources.P.alloc(1).unwrap()).unwrap();
-        spawn.bar(resources.P.alloc(2).unwrap()).unwrap();
-    }
-
-    #[task(resources = [P])]
-    fn foo(x: Box<M>) {
-        hprintln!("foo({})", x).unwrap();
-
-        resources.P.lock(|p| p.dealloc(x));
-
-        debug::exit(debug::EXIT_SUCCESS);
-    }
-
-    #[task(priority = 2, resources = [P])]
-    fn bar(x: Box<M>) {
-        hprintln!("bar({})", x).unwrap();
-
-        resources.P.dealloc(x);
-    }
-
-    extern "C" {
-        fn UART0();
-        fn UART1();
-    }
-};