personal/_posts/2022-09-26-cargo-careful.md

   1 ---
   2 title: "cargo careful: run your Rust code with extra careful debug checking"
   3 categories: rust
   4 reddit: /rust/comments/xogayv/cargo_careful_run_your_rust_code_with_extra/
   5 ---
   6
   7 Did you know that the standard library is full of useful checks that users never get to see?
   8 There are plenty of debug assertions in the standard library that will do things like check that `char::from_u32_unchecked` is called on a valid `char`, that `CStr::from_bytes_with_nul_unchecked` does not have internal nul bytes, or that pointer functions such as `copy` or `copy_nonoverlapping` are called on suitably aligned non-null (and non-overlapping) pointers.
   9 However, the regular standard library that is distributed by rustup is compiled without debug assertions, so there is no easy way for users to benefit from all this extra checking.
  10
  11 <!-- MORE -->
  12
  13 [`cargo careful`](https://github.com/RalfJung/cargo-careful) is here to close this gap:
  14 when invoked the first time, it builds a standard library with debug assertions from source, and then runs your program or test suite with that standard library.
  15 Installing `cargo careful` is as easy as `cargo install cargo-careful`, and then you can do `cargo +nightly careful run`/`cargo +nightly careful test` to execute your binary crates and test suites with an extra amount of debug checking.
  16
  17 This will naturally be slower than a regular debug or release build, but it is *much* faster than executing your program in [Miri](https://github.com/rust-lang/miri) and still helps find some Undefined Behavior.
  18 Unlike Miri, it is fully FFI-compatible (though the code behind the FFI barrier is completely unchecked).
  19 Of course Miri is much more thorough and `cargo careful` will miss many problems (for instance, it cannot detect out-of-bounds pointer arithmetic -- but it *does* perform bounds checking on `get_unchecked` slice accesses).
  20
  21 Note that for now, some of these checks (in particular for raw pointer methods) cause an abrupt abort of the program via SIGILL without a nice error message or backtrace.
  22 There are probably ways to improve this in the future.
  23 Meanwhile, if you have some `unsafe` code that for one reason or another you cannot test with Miri, give [`cargo careful`] a try and let me know how it is doing. :)
  24
  25 [`cargo careful`]: https://github.com/RalfJung/cargo-careful
  26
  27 *By the way, I am soon [starting as a professor at ETH Zürich]({% post_url 2022-08-16-eth %}), so if you are interested in working with me on programming language theory as a master student, PhD student, or post-doc, then please [reach out](https://research.ralfj.de/contact.html)!*