rust/stable_mir at e7ac2eabd0b51f7beec909794e76db3e991aa08d - rust

mirror of https://github.com/rust-lang/rust.git synced 2025-05-14 02:49:40 +00:00

History

Flakebi e7e5202978 Add gpu-kernel calling convention The amdgpu-kernel calling convention was reverted in commit `f6b21e90d1` due to inactivity in the amdgpu target. Introduce a `gpu-kernel` calling convention that translates to `ptx_kernel` or `amdgpu_kernel`, depending on the target that rust compiles for.		2025-01-16 00:26:55 +01:00
..
src	Add gpu-kernel calling convention	2025-01-16 00:26:55 +01: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. ↩︎