Lessons learned from a successful Rust rewrite

(gaultier.github.io)

88 points | by broken_broken_ 7 hours ago ago

23 comments

  • WhatIsDukkha an hour ago

    This seems like a weird use of Rust.

    There is no mention of how much of the codebase is even in safe Rust after all this work so no clear value to the migration?

    Frequently when people get their code ported they then begin a process of reducing the unsafe surface area but not here.

    The author seems to have little or no value on safe Rust? It doesn't seem evident from reading/skimming his 4 articles on the process.

    Interesting mechanical bits to read for sure though so it' still a useful read more broadly.

    It's unsurprising that the author would go use Zig next time since they didn't seem to have any value alignment with Rust's core safety guarantees.

    • empath75 15 minutes ago

      I don't really understand why they chose to rewrite this in rust if they're just going to spend their time writing unsafe C code in rust.

  • steveklabnik 2 hours ago

    Incidentally, the first code sample can work, you just need to use the new raw syntax, or addr_of_mut on older Rusts:

        fn main() {
            let mut x = 1;
            unsafe {
                let a = &raw mut x;
                let b = &raw mut x;
        
                *a = 2;
                *b = 3;
            }
        }
    
    The issue is that the way that the code was before, you'd be creating a temporary &mut T to a location where a pointer already exists. This new syntax gives you a way to create a *mut T without the intermediate &mut T.

    That said, this doesn't mean that the pain is invalid; unsafe Rust is tricky. But at least in this case, the fix isn't too bad.

    • daghamm 2 hours ago

      Every time I think I am getting good at Rust, the core team adds a new keyword to send me back to square one.

      (All right, i don't actually know if this is old or new. But you get my point?

      • rectang an hour ago

        I thought myself a pretty decent C coder, certainly someone who was conscientious and took safety seriously. I am nevertheless often humbled when programming unsafe Rust as I discover aspects and errors I had not anticipated or thought through. I don't attribute this to Rust, but instead to the deceptively difficult problem domain.

        • WesolyKubeczek an hour ago

          Are things you have learned so far transferable back to C? Can you with your new experience consider yourself a better C coder?

          • jsheard 24 minutes ago

            I'd say that learning Rust can give you a lot of ideas to bring back to C++, many of the common Rust abstractions and patterns can be implemented in C++ albeit without the strict compiler guardrails. It's hard to do the same in plain old C though due to the lack of RAII and generics.

      • steveklabnik 2 hours ago

        This was stabilized thirteen days ago, in Rust 1.82.0. addr_of_mut! was stabilized three and a half years ago, in Rust 1.51.0.

        > you get my point?

        I don't think Rust adds keywords very often. But I can acknowledge this is a subjective point. Additionally, in this case, it is literally a one sentence explanation: `&raw mut` is how you can create a `*mut T`, and `&raw` is how you can create a `*const T`. That's it. You can safely ignore this whole thing until you're writing some unsafe code. It doesn't feel like a large burden to me, though of course I am biased.

        • daghamm 36 minutes ago

          You are biased, more complex Rust means more book sales :)

          Joke aside, my main issue with Rust is that is is already more complicated than C++. And it is still growing.

          • steveklabnik 19 minutes ago

            I don't think Rust is anywhere near as complex as C++.

            I agree that it seems like the team has an appetite for change that's larger than I personally would agree is appropriate. We'll see what they end up shipping.

  • ubj 2 hours ago

    I've recently seen a lot of Rust rewrite projects that have talked about how much they've been required to use unsafe blocks. I'm currently in process of my first C++-to-Rust rewrite, and I haven't needed to reach for unsafe at all yet.

    What kinds of projects or C++ features are requiring such high usage of unsafe? I'm not implying that this is bad or unnecessary--I'm genuinely curious as to what requires unsafe to be used so frequently. Since by all accounts unsafe Rust can be harder to use than C++, this may help inform me as to whether I attempt using Rust in future rewrites.

    • steveklabnik 2 hours ago

      I agree that in my experience, little unsafe is needed. However, (from an earlier article in this series):

      > This project is a library that exposes a C API but the implementation is C++, and it vendors C libraries (e.g. mbedtls) which we build from source. The final artifacts are a `libfoo.a` static library and a `libfoo.h` C header.

      In this case, this project is doing a lot of FFI, both exposing C, as well as calling into C libraries. That's unsafe. Which is a good example of a project that may use unsafe more than the average Rust project.

      • kelnos 19 minutes ago

        My feeling was that this rewrite is not actually "done". Sure, all their C++ has been converted to Rust, but it seems like there's a lot of unsafe that they could rewrite in safe Rust.

        And for the C libraries they vendor in, assuming none of them are exposed directly in their public API, it's likely they can replace them with Rust libraries with equivalent behavior. mbedtls seems like a good example of that; certainly it wouldn't be a small effort to switch to rustls, but it might be worth it to do so. And even if they didn't choose to do that, I just did a quick search on crates.io, and it looks like there are safe wrappers for mbedtls.

      • ubj 2 hours ago

        Ah, that makes sense. Thanks for the clarification.

    • lsbehe 2 hours ago

      He mentioned FFI into and out of his code, which has been my main encounter with unsafe rust too. Often enough I could limit the use to the entry/exit code but that's not always possible.

  • mmastrac 2 hours ago

    This post is subtly wrong: "multiple read-only pointers XOR one mutable pointer" is actually "multiple read-only references XOR one mutable reference".

    It _is_ valid to have multiple mutable pointers, just as C and C++ allow. It's when you have multiple live, mutable references (including pointers created from live mutable references) that you end up in UB territory.

  • showsomerespect 14 minutes ago

    The "arena allocator" hyperlink links to localhost:8000

  • hyperman1 an hour ago

    As someone who likes what Rust brings to the table, I am pleasantly surprised with the honesty of this review.

    Interfacing with the C world, both as caller and calllee, happens a lot in real world code. All the C bugs come right back at that point.

  • kelnos 24 minutes ago

    I feel like some of the "what didn't go so well" sections were essentially because their rewrite was incomplete:

    > I am still chasing Undefined Behavior. Doing an incremental rewrite from C/C++ to Rust, we had to use a lot of raw pointers and unsafe{} blocks. And even when segregating these to the entry point of the library, they proved to be a big pain in the neck.

    These sound like an artifact of the rewrite itself, and I suspect many of these unsafe blocks can be rewritten safely now that there is no C++ code left.

    > I am talking about code that Miri cannot run, period: [some code that calls OpenSSL (mbedtls?) directly]

    This should be replaced by a safe OpenSSL (mbedtls?) wrapper, or if it wouldn't change the behavior of their library in incompatible ways, rustls.

    > I am still chasing memory leaks. Our library offers a C API, something like this: [init()/release() C memory management pattern]

    Not sure what this has to do with Rust, though. Yes, if you're going to test your library using the exposed C API interface, your tests may have memory leaks. And yes, if your users are expected to use the library using the C API, they will have to be just as careful about memory as they were before.

    The benefit of this rewrite in Rust would be about them not misusing memory internally inside the library. If that benefit isn't useful enough, then they shouldn't have done this rewrite.

    > Cross-compilation does not always work

    I've certainly run into issues with cross-compilation with Rust, but it is always so much easier than with C/C++.

    > Cbindgen does not always work. [...] Every time, I thought of dumping cbindgen and writing all of the C prototypes by hand. I think it would have been simpler in the end.

    I'm skeptical of the idea that an automated tool is going to generate something that you'll want to use as your public API. I would probably use cbindgen to get a first draft of the API, modify and clean up the output, and use that as the first version, and then manually add/change things from there as the API changes.

    I don't want to silently, accidentally change the API (or worse, ABI) of my library because a code generator changed behavior in a subtle way based on either me upgrading it, or me changing my code in a seemingly-innocuous way.

    > Unstable ABI

    This is a bummer, but consider that they are not exposing a Rust API to their customers: they're exposing a C API. Why would the expect to be able to expose Rust types through the API?

    And they actually can do this: while it is correct that standard Rust types could have a different layout depending on what version of rustc is used to build it, that doesn't actually matter for a pre-built, distributed binary, as long as access to those types from the outside code (that is, through the C API) is done only through accessors/functions and never through direct struct member access. Sure, that requires some overhead, but I would argue that you should never expose struct/object internals in your public API anyway.

  • happyweasel an hour ago

    The only real comparison would be a rewrite in modern c++ and then compare that to the rewrite in rust. Also the author mentioned that the original code had no tests at all. Well, good luck.

  • lidflipguy 13 minutes ago

    I found a hygiene box lid that was circular shaped and thought to myself yeah I can flip this for warfare because I saw someone flip a checkers piece because this would be the first time I played and I have only one shot too to get this right so I got my hygiene box lid and said example heads or tails for heads motherfucker and he said tails and lost I forgot so I said I have got top and I flipped it a pretty good ways down to the towel to muffle out the sound and she spun so fast I couldn't see her and she landed right were I needed it to land on the towel and I lost I'm kidding lol I won. Thank God I had a bunch of weight on my shoulders if I were to have lost. Very far from home too. Didn't have a camera.

  • tharne an hour ago

    That's a confusing title. I was under the impression that on Hacker news, every Rust rewrite is a successful rewrite.

    • layer8 10 minutes ago

      They are just emphasizing the tautology, not sure why you are confused. ;)