https://github.com/federicobruzzone/rusty-links
RustyLinks: leverage ownership semantics and borrow checking to perform static analysis on the rustc's MIR
https://github.com/federicobruzzone/rusty-links
compiler-design rustc semantic-analysis static-analysis syntactic-analysis
Last synced: 6 months ago
JSON representation
RustyLinks: leverage ownership semantics and borrow checking to perform static analysis on the rustc's MIR
- Host: GitHub
- URL: https://github.com/federicobruzzone/rusty-links
- Owner: FedericoBruzzone
- Created: 2024-11-04T14:32:02.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-23T17:41:32.000Z (9 months ago)
- Last Synced: 2025-01-23T18:34:01.633Z (9 months ago)
- Topics: compiler-design, rustc, semantic-analysis, static-analysis, syntactic-analysis
- Language: Rust
- Homepage:
- Size: 221 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RustyLinks
RustyLinks instruments the Rust compiler, in particular the MIR (Mid-level Intermediate Representation), to leverage ownership semantics and borrow checking to perform static analysis.
It is a research project that aims to improve the Rust programming language by providing additional information to the compiler.
## Usage in common Rust projects
### Setup
```bash
rustup toolchain install nightly-2024-12-10
rustup component add --toolchain nightly-2024-12-10 rust-src rustc-dev llvm-tools-preview miri rust-analyzer clippy
```
### Test
```bash
cargo test -- --test-threads=1 --nocapture
```
### Cli (`cargo` wrapper)
> ℹ️ Additional logs can be enabled by setting the `RUST_LOG` environment variable to `debug`.
> ℹ️ The `RUST_LOG_STYLE` environment variable can be set to `always` to force the logs to be colored.
```bash
cd tests/workspaces/first
cargo run --manifest-path ../../../Cargo.toml --bin cargo-rusty-links [--CARGO_ARG] -- [--PLUGIN_ARG]
```
or
```
cd tests/workspaces/first
LD_LIBRARY_PATH=$(rustc --print sysroot)/lib ../../../target/debug/cargo-rusty-links [--PLUGIN_ARG] -- [--CARGO_ARG]
```
### Driver (`rustc` wrapper)
> ⚠️ It is not currently possible to pass the plugin args to the driver without using an environment variable. Using the CLI is advised.
TODO: Find a way to pass to the driver the plugin args using "PLUGIN_ARGS" environment variable
```bash
CARGO_PRIMARY_PACKAGE=1 cargo run --bin rusty-links-driver -- ./tests/workspaces/first/src/main.rs [--RUSTC_ARG (e.g., --cfg 'feature="test"')]
```
or
```bash
cd tests/workspaces/first
CARGO_PRIMARY_PACKAGE=1 cargo run --manifest-path ../../Cargo.toml --bin rusty-links-driver -- ./src/main.rs
```
## Example: usage in `rustc` compiler
### `rustc` setup
```shell
cd tests
git clone git@github.com:rust-lang/rust.git --depth 1
cd rust
./x setup
./x build --stage 0
./x build --stage 1
./x build --stage 2 # Implies compilation of stage1's stdlib
```
### RustyLinks setup
Set in `rust-toolchain` the `channel=stage1`.
```shell
cd ../..
cargo clean
cargo build
```
### Driver (`rustc` wrapper)
```shell
cd tests/rust
rm -rf target
RUSTC_BOOTSTRAP=1 CARGO_PRIMARY_PACKAGE=1 RUST_LOG_STYLE=always RUST_LOG=trace LD_LIBRARY_PATH=PATH/TO/rusty-links/tests/rust/build/x86_64-unknown-linux-gnu/stage1/lib/rustlib/x86_64-unknown-linux-gnu/lib ../../target/debug/cargo-rusty-links --color-log --print-mir --print-rl-graph --filter-with-file "compiler/rustc/src/main.rs"
```
## Contact
If you have any questions, suggestions, or feedback, do not hesitate to [contact me](https://federicobruzzone.github.io/).