rust-embedded / rust-embedded/heapless
heapless Vec does not work good with stacked borrows, while std Vec does
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2k
- Forks
- 253
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 1
Description
Pushing to heapless:Vec invalidates all previously created pointers into Vector
small example
fn vector() {
let mut a = Vec::with_capacity(10);
a.push(1);
let b = std::ptr::from_ref(a.get(0).unwrap());
a.push(1);
println!("{:?}", unsafe { *b });
}
fn heapless_vector() {
let mut a = heapless::Vec::<i32, 10>::new();
a.push(1).unwrap();
let b = std::ptr::from_ref(a.get(0).unwrap());
a.push(1).unwrap();
println!("{:?}", unsafe { *b });
}
miri shows error
running 2 tests
test test::heapless_vector ... error: Undefined Behavior: attempting a read access using <261088> at alloc102617[0x8], but that tag does not exist in the borrow stack for this location
--> src/main.rs:25:35
|
25 | println!("{:?}", unsafe { *b });
| ^^
| |
| attempting a read access using <261088> at alloc102617[0x8], but that tag does not exist in the borrow stack for this location
| this error occurs as part of an access at alloc102617[0x8..0xc]
|
= help: this indicates a potential bug in the program: it performed an invalid operation, but the Stacked Borrows rules it violated are still experimental
= help: see https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md for further information
help: <261088> was created by a SharedReadOnly retag at offsets [0x8..0xc]
--> src/main.rs:22:17
|
22 | let b = std::ptr::from_ref(a.get(0).unwrap());
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
help: <261088> was later invalidated at offsets [0x0..0x30] by a Unique function-entry retag inside this call
--> src/main.rs:23:9
|
23 | a.push(1).unwrap();
| ^^^^^^^^^
= note: BACKTRACE (of the first span) on thread `test::heapless_`:
= note: inside `test::heapless_vector` at src/main.rs:25:35: 25:37
note: inside closure
--> src/main.rs:18:25
|
17 | #[test]
| ------- in this procedural macro expansion
18 | fn heapless_vector() {
| ^
= note: this error originates in the attribute macro `test` (in Nightly builds, run with -Z macro-backtrace for more info)
right now i don't see any way to go around it, except for method like this
unsafe fn push_by_ptr(this: *mut Self, item: T)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the supplied example with Miri, then inspect the heapless Vec implementation involved in push and compare it with std::Vec. The work is complete when the supported pointer behavior under Stacked Borrows is established and the issue has an agreed implementation or documented limitation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- embedded-iot
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100