rust/stable_mir at 7c769959505efaf8d6717e67e8def06b5f1a515d - rust

mirror of https://github.com/rust-lang/rust.git synced 2024-11-29 10:13:54 +00:00

History

Jubilee 4036472749 Rollup merge of #132131 - celinval:smir-crate-defs, r=compiler-errors [StableMIR] API to retrieve definitions from crates Add functions to retrieve function definitions and static items from all crates (local and external). For external crates, we're still missing items from trait implementation and primitives. r? ````@compiler-errors:```` Do you know what is the best way to retrieve the associated items for primitives and trait implementations for external crates? Thanks!		2024-11-07 18:48:22 -08:00
..
src	Rollup merge of #132131 - celinval:smir-crate-defs, r=compiler-errors	2024-11-07 18:48:22 -08:00
Cargo.toml	add serde derive Serialize to stable_mir	2024-06-26 11:56:01 -04:00
README.md	Update README.md	2024-10-24 16:19:55 -07:00
rust-toolchain.toml	Split out the stable part of smir into its own crate to prevent accidental usage of forever unstable things	2023-09-25 14:38:27 +00:00

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. ↩︎