mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2025-12-18 05:45:19 +01:00
Code Issues Projects Releases Packages Wiki Activity

book/resources: rm #[task_local] mention; add #[lock_free] example

Browse source 
the #[task_local] attribute was removed
This commit is contained in:
Jorge Aparicio 2021-07-22 09:17:39 +02:00
parent f9a7efb235
commit 5805a05fac
3 changed files with 85 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
book/en/src/by-example/resources.md
View file

@ -97,11 +97,15 @@ $ cargo run --example only-shared-access
## Lock-free resource access of mutable resources
There exists two other options dealing with resources
A critical section is *not* required to access a `#[shared]` resource that's only accessed by tasks running at the *same* priority.
In this case, you can opt out of the `lock` API by adding the `#[lock_free]` field-level attribute to the resource declaration (see example below).
Note that this is merely a convenience: if you do use the `lock` API, at runtime the framework will *not* produce a critical section.
* `#[lock_free]`: there might be several tasks with the same priority
accessing the resource without critical section. Since tasks with the
same priority never can preempt another task on the same priority
this is safe.
* `#[task_local]`: there must be only one task using this resource,
similar to a `static mut` task local resource, but (optionally) set-up by init.
``` rust
{{#include ../../../../examples/lock-free.rs}}
```
``` console
$ cargo run --example lock-free
{{#include ../../../../ci/expected/lock-free.run}}
```