rust-lang / rust-lang/rust-clippy
New lint: `_.as_ptr() as *mut _` is Undefined Behavior
@llogiq is already working on this.
Since Dec 11, 2019.
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
Casting a *const T to *mut T may lead to memory corruption since it allows mutation of shared state. Even if the *const T happened to be unique, it is still undefined behavior and the optimizer may break such code in interesting ways. In a nutshell, this is as bad as transmuting a & into &mut.
Update: turns out there are cases when this is not immediately trigger UB, but in those cases you shouldn't be doing these casts anyway.
This often occurs when people try to consume a data structure and create a new one from it, e.g.
let new_slice = core::slice::from_raw_parts_mut(old_slice.as_ptr() as *mut B, len)
in which case the proper solution is to rewrite it as
let new_slice = core::slice::from_raw_parts_mut(old_slice.as_mut_ptr(), len)
This also may happen when people try to mutate shared state through a &, in which case they need a Cell, RefCell or an UnsafeCell instead.
Playground with a real-world snippet that passes Clippy as of version 0.0.212 but fails MIRI: https://play.rust-lang.org/?version=nightly&mode=debug&edition=2018&gist=b28a15e3d99616b03caafdd794550946
This pattern seems to be quite widespread - quoting @RalfJung on Zulip:
I have seen at least 2 or 3 cases over the last few weeks for a const-to-mut raw ptr cast being the give-away for mutation of shared data
Rust stdlib also had this bug: https://blog.rust-lang.org/2017/02/09/Rust-1.15.1.html
Contributor guide
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.
Assessment
This issue has not been assessed yet.