rust/stable_mir at b6015a68de40d9563ecba7b7310b32ed6cad20dd - rust

mirror of https://github.com/rust-lang/rust.git synced 2025-10-23 21:54:16 +00:00

History

Makai c42a9ac602 move stable_mir back to its own crate and move rustc_internal to thestable_mir crate

As part of this reorganization, some traits need to be moved from `rustc_smir::context::traits` to `stable_mir::unstable::internal_cx`. These traits are specifically designed for `InternalCx` to clarify the behavior of different functions that share the same name. This move is necessary to avoid orphan rule violations.

2025-07-06 12:25:42 +00:00

src

move stable_mir back to its own crate and move rustc_internal to thestable_mir crate

2025-07-06 12:25:42 +00:00

Cargo.toml

move stable_mir back to its own crate and move rustc_internal to thestable_mir crate

2025-07-06 12:25:42 +00:00

README.md

Update README.md

2024-10-24 16:19:55 -07:00

rust-toolchain.toml

…

README.md

This crate is currently developed in-tree together with the compiler.

Our goal is to start publishing stable_mir into crates.io. Until then, users will use this as any other rustc crate, by installing the rustup component rustc-dev, and declaring stable-mir as an external crate.

See the StableMIR "Getting Started" guide for more information.

Stable MIR Design

The stable-mir will follow a similar approach to proc-macro2. Its implementation is split between two main crates:

stable_mir: Public crate, to be published on crates.io, which will contain the stable data structure as well as calls to rustc_smir APIs. The translation between stable and internal constructs will also be done in this crate, however, this is currently implemented in the rustc_smir crate.¹.
rustc_smir: This crate implements the public APIs to the compiler. It is responsible for gathering all the information requested, and providing the data in its unstable form.

I.e., tools will depend on stable_mir crate, which will invoke the compiler using APIs defined in rustc_smir.

I.e.:

    ┌──────────────────────────────────┐           ┌──────────────────────────────────┐
    │   External Tool     ┌──────────┐ │           │ ┌──────────┐   Rust Compiler     │
    │                     │          │ │           │ │          │                     │
    │                     │stable_mir| │           │ │rustc_smir│                     │
    │                     │          │ ├──────────►| │          │                     │
    │                     │          │ │◄──────────┤ │          │                     │
    │                     │          │ │           │ │          │                     │
    │                     │          │ │           │ │          │                     │
    │                     └──────────┘ │           │ └──────────┘                     │
    └──────────────────────────────────┘           └──────────────────────────────────┘

More details can be found here: https://hackmd.io/XhnYHKKuR6-LChhobvlT-g?view

This is currently implemented in the rustc_smir crate, but we are working to change that. ↩︎