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

diff --git a/macros/src/check.rs b/macros/src/check.rs
index 4adc2c1..4471e96 100644
--- a/macros/src/check.rs
+++ b/macros/src/check.rs
@@ -35,21 +35,12 @@ pub fn app(app: &App) -> parse::Result<()> {
         }
     }
 
-    // Check that all late resources have been initialized in `#[init]` if `init` has signature
-    // `fn()`
-    if !app.init.returns_late_resources {
-        for res in
-            app.resources
-                .iter()
-                .filter_map(|(name, res)| if res.expr.is_none() { Some(name) } else { None })
-        {
-            if app.init.assigns.iter().all(|assign| assign.left != *res) {
-                return Err(parse::Error::new(
-                    res.span(),
-                    "late resources MUST be initialized at the end of `init`",
-                ));
-            }
-        }
+    // Check that `init` returns `LateResources` if there's any declared late resource
+    if !app.init.returns_late_resources && app.resources.iter().any(|(_, res)| res.expr.is_none()) {
+        return Err(parse::Error::new(
+            app.init.span,
+            "late resources have been specified so `init` must return `init::LateResources`",
+        ));
     }
 
     // Check that all referenced tasks have been declared
@@ -128,7 +119,7 @@ pub fn app(app: &App) -> parse::Result<()> {
     } else if app.init.returns_late_resources {
         return Err(parse::Error::new(
             Span::call_site(),
-            "`init` signature must be `[unsafe] fn()` if there are no late resources",
+            "`init` signature must be `fn(init::Context)` if there are no late resources",
         ));
     }