rtic/book/en/src/by-example/tips_indirection.md

32 lines
1.2 KiB
Markdown
Raw Normal View History

2021-09-22 13:22:45 +02:00
# Using indirection for faster message passing
Message passing always involves copying the payload from the sender into a
static variable and then from the static variable into the receiver. Thus
sending a large buffer, like a `[u8; 128]`, as a message involves two expensive
2021-12-18 22:36:11 +01:00
`memcpy`s.
Indirection can minimize message passing overhead:
2021-09-22 13:22:45 +02:00
instead of sending the buffer by value, one can send an owning pointer into the
buffer.
2022-02-20 19:21:25 +01:00
One can use a global memory allocator to achieve indirection (`alloc::Box`,
2021-09-22 13:22:45 +02:00
`alloc::Rc`, etc.), which requires using the nightly channel as of Rust v1.37.0,
or one can use a statically allocated memory pool like [`heapless::Pool`].
[`heapless::Pool`]: https://docs.rs/heapless/0.5.0/heapless/pool/index.html
2022-02-20 19:21:25 +01:00
As this example of approach goes completely outside of RTIC resource
model with shared and local the program would rely on the correctness
of the memory allocator, in this case `heapless::pool`.
2021-09-22 13:22:45 +02:00
Here's an example where `heapless::Pool` is used to "box" buffers of 128 bytes.
``` rust
{{#include ../../../../examples/pool.rs}}
```
``` console
$ cargo run --target thumbv7m-none-eabi --example pool
{{#include ../../../../ci/expected/pool.run}}
```