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, 4 insertions, 4 deletions

diff --git a/examples/shared-with-init.rs b/examples/shared-with-init.rs
index 5ddd2cc3..0fb9191c 100644
--- a/examples/shared-with-init.rs
+++ b/examples/shared-with-init.rs
@@ -18,17 +18,17 @@ const APP: () = {
     static mut SHARED: Option<MustBeSend> = None;
 
     #[init(resources = [SHARED])]
-    fn init() {
+    fn init(c: init::Context) {
         // this `message` will be sent to task `UART0`
         let message = MustBeSend;
-        *resources.SHARED = Some(message);
+        *c.resources.SHARED = Some(message);
 
         rtfm::pend(Interrupt::UART0);
     }
 
     #[interrupt(resources = [SHARED])]
-    fn UART0() {
-        if let Some(message) = resources.SHARED.take() {
+    fn UART0(c: UART0::Context) {
+        if let Some(message) = c.resources.SHARED.take() {
             // `message` has been received
             drop(message);