Skip to content

Commit 0f656bc

Browse files
borsbors
committed
Auto merge of #116837 - oli-obk:smir_run_macro, r=spastorino
Avoid having `rustc_smir` depend on `rustc_interface` or `rustc_driver` This is done by moving all the logic into a macro that performs the entire "run" operation in one go. This makes #116806 obsolete as a follow up we should make the macro usable without manually having to write ```rust #[macro_use] extern crate rustc_smir; extern crate stable_mir; extern crate rustc_driver; extern crate rustc_interface; use rustc_smir::rustc_internal; ``` in every crate that uses the macro. r? `@spastorino`
2 parents 249624b + 87accdb commit 0f656bc

File tree

6 files changed

+101
-82
lines changed

6 files changed

+101
-82
lines changed

‎Cargo.lock

-2
Original file line numberDiff line numberDiff line change
@@ -4483,9 +4483,7 @@ name = "rustc_smir"
44834483
version = "0.0.0"
44844484
dependencies = [
44854485
"rustc_data_structures",
4486-
"rustc_driver",
44874486
"rustc_hir",
4488-
"rustc_interface",
44894487
"rustc_middle",
44904488
"rustc_span",
44914489
"rustc_target",

‎compiler/rustc_smir/Cargo.toml

-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@ edition = "2021"
55

66
[dependencies]
77
rustc_data_structures = { path = "../rustc_data_structures" }
8-
rustc_driver = { path = "../rustc_driver" }
98
rustc_hir = { path = "../rustc_hir" }
10-
rustc_interface = { path = "../rustc_interface" }
119
rustc_middle = { path = "../rustc_middle" }
1210
rustc_span = { path = "../rustc_span" }
1311
rustc_target = { path = "../rustc_target" }

‎compiler/rustc_smir/src/rustc_internal/mod.rs

+72-58
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,18 @@
33
//! For that, we define APIs that will temporarily be public to 3P that exposes rustc internal APIs
44
//! until stable MIR is complete.
55
6-
use crate::rustc_internal;
76
use crate::rustc_smir::Tables;
87
use rustc_data_structures::fx;
98
use rustc_data_structures::fx::FxIndexMap;
10-
use rustc_driver::{Callbacks, Compilation, RunCompiler};
11-
use rustc_interface::{interface, Queries};
129
use rustc_middle::mir::interpret::AllocId;
1310
use rustc_middle::ty;
1411
use rustc_middle::ty::TyCtxt;
1512
use rustc_span::def_id::{CrateNum, DefId};
1613
use rustc_span::Span;
1714
use stable_mir::ty::IndexedVal;
18-
use stable_mir::CompilerError;
1915
use std::fmt::Debug;
2016
use std::hash::Hash;
21-
use std::ops::{ControlFlow, Index};
17+
use std::ops::Index;
2218

2319
impl<'tcx> Index<stable_mir::DefId> for Tables<'tcx> {
2420
type Output = DefId;
@@ -141,63 +137,81 @@ pub fn run(tcx: TyCtxt<'_>, f: impl FnOnce()) {
141137
);
142138
}
143139

144-
pub struct StableMir<B = (), C = ()>
145-
where
146-
B: Send,
147-
C: Send,
148-
{
149-
args: Vec<String>,
150-
callback: fn(TyCtxt<'_>) -> ControlFlow<B, C>,
151-
result: Option<ControlFlow<B, C>>,
152-
}
140+
#[macro_export]
141+
macro_rules! run {
142+
($args:expr, $callback:expr) => {
143+
run!($args, tcx, $callback)
144+
};
145+
($args:expr, $tcx:ident, $callback:expr) => {{
146+
use rustc_driver::{Callbacks, Compilation, RunCompiler};
147+
use rustc_interface::{interface, Queries};
148+
use stable_mir::CompilerError;
149+
use std::ops::ControlFlow;
150+
151+
pub struct StableMir<B = (), C = ()>
152+
where
153+
B: Send,
154+
C: Send,
155+
{
156+
args: Vec<String>,
157+
callback: fn(TyCtxt<'_>) -> ControlFlow<B, C>,
158+
result: Option<ControlFlow<B, C>>,
159+
}
153160

154-
impl<B, C> StableMir<B, C>
155-
where
156-
B: Send,
157-
C: Send,
158-
{
159-
/// Creates a new `StableMir` instance, with given test_function and arguments.
160-
pub fn new(args: Vec<String>, callback: fn(TyCtxt<'_>) -> ControlFlow<B, C>) -> Self {
161-
StableMir { args, callback, result: None }
162-
}
163-
164-
/// Runs the compiler against given target and tests it with `test_function`
165-
pub fn run(&mut self) -> Result<C, CompilerError<B>> {
166-
let compiler_result =
167-
rustc_driver::catch_fatal_errors(|| RunCompiler::new(&self.args.clone(), self).run());
168-
match (compiler_result, self.result.take()) {
169-
(Ok(Ok(())), Some(ControlFlow::Continue(value))) => Ok(value),
170-
(Ok(Ok(())), Some(ControlFlow::Break(value))) => Err(CompilerError::Interrupted(value)),
171-
(Ok(Ok(_)), None) => Err(CompilerError::Skipped),
172-
(Ok(Err(_)), _) => Err(CompilerError::CompilationFailed),
173-
(Err(_), _) => Err(CompilerError::ICE),
161+
impl<B, C> StableMir<B, C>
162+
where
163+
B: Send,
164+
C: Send,
165+
{
166+
/// Creates a new `StableMir` instance, with given test_function and arguments.
167+
pub fn new(args: Vec<String>, callback: fn(TyCtxt<'_>) -> ControlFlow<B, C>) -> Self {
168+
StableMir { args, callback, result: None }
169+
}
170+
171+
/// Runs the compiler against given target and tests it with `test_function`
172+
pub fn run(&mut self) -> Result<C, CompilerError<B>> {
173+
let compiler_result = rustc_driver::catch_fatal_errors(|| {
174+
RunCompiler::new(&self.args.clone(), self).run()
175+
});
176+
match (compiler_result, self.result.take()) {
177+
(Ok(Ok(())), Some(ControlFlow::Continue(value))) => Ok(value),
178+
(Ok(Ok(())), Some(ControlFlow::Break(value))) => {
179+
Err(CompilerError::Interrupted(value))
180+
}
181+
(Ok(Ok(_)), None) => Err(CompilerError::Skipped),
182+
(Ok(Err(_)), _) => Err(CompilerError::CompilationFailed),
183+
(Err(_), _) => Err(CompilerError::ICE),
184+
}
185+
}
174186
}
175-
}
176-
}
177187

178-
impl<B, C> Callbacks for StableMir<B, C>
179-
where
180-
B: Send,
181-
C: Send,
182-
{
183-
/// Called after analysis. Return value instructs the compiler whether to
184-
/// continue the compilation afterwards (defaults to `Compilation::Continue`)
185-
fn after_analysis<'tcx>(
186-
&mut self,
187-
_compiler: &interface::Compiler,
188-
queries: &'tcx Queries<'tcx>,
189-
) -> Compilation {
190-
queries.global_ctxt().unwrap().enter(|tcx| {
191-
rustc_internal::run(tcx, || {
192-
self.result = Some((self.callback)(tcx));
193-
});
194-
if self.result.as_ref().is_some_and(|val| val.is_continue()) {
195-
Compilation::Continue
196-
} else {
197-
Compilation::Stop
188+
impl<B, C> Callbacks for StableMir<B, C>
189+
where
190+
B: Send,
191+
C: Send,
192+
{
193+
/// Called after analysis. Return value instructs the compiler whether to
194+
/// continue the compilation afterwards (defaults to `Compilation::Continue`)
195+
fn after_analysis<'tcx>(
196+
&mut self,
197+
_compiler: &interface::Compiler,
198+
queries: &'tcx Queries<'tcx>,
199+
) -> Compilation {
200+
queries.global_ctxt().unwrap().enter(|tcx| {
201+
rustc_internal::run(tcx, || {
202+
self.result = Some((self.callback)(tcx));
203+
});
204+
if self.result.as_ref().is_some_and(|val| val.is_continue()) {
205+
Compilation::Continue
206+
} else {
207+
Compilation::Stop
208+
}
209+
})
198210
}
199-
})
200-
}
211+
}
212+
213+
StableMir::new($args, |$tcx| $callback).run()
214+
}};
201215
}
202216

203217
/// Simmilar to rustc's `FxIndexMap`, `IndexMap` with extra

‎tests/ui-fulldeps/stable-mir/compilation-result.rs

+10-9
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,22 @@
44
// ignore-stage1
55
// ignore-cross-compile
66
// ignore-remote
7+
// ignore-windows-gnu mingw has troubles with linking https://github.com/rust-lang/rust/pull/116837
78
// edition: 2021
89

910
#![feature(rustc_private)]
1011
#![feature(assert_matches)]
1112

1213
extern crate rustc_middle;
14+
#[macro_use]
1315
extern crate rustc_smir;
16+
extern crate rustc_driver;
17+
extern crate rustc_interface;
1418
extern crate stable_mir;
1519

1620
use rustc_middle::ty::TyCtxt;
1721
use rustc_smir::rustc_internal;
1822
use std::io::Write;
19-
use std::ops::ControlFlow;
2023

2124
/// This test will generate and analyze a dummy crate using the stable mir.
2225
/// For that, it will first write the dummy crate into a file.
@@ -33,28 +36,26 @@ fn main() {
3336
}
3437

3538
fn test_continue(args: Vec<String>) {
36-
let continue_fn = |_: TyCtxt| ControlFlow::Continue::<(), bool>(true);
37-
let result = rustc_internal::StableMir::new(args, continue_fn).run();
39+
let result = run!(args, ControlFlow::Continue::<(), bool>(true));
3840
assert_eq!(result, Ok(true));
3941
}
4042

4143
fn test_break(args: Vec<String>) {
42-
let continue_fn = |_: TyCtxt| ControlFlow::Break::<bool, i32>(false);
43-
let result = rustc_internal::StableMir::new(args, continue_fn).run();
44+
let result = run!(args, ControlFlow::Break::<bool, i32>(false));
4445
assert_eq!(result, Err(stable_mir::CompilerError::Interrupted(false)));
4546
}
4647

48+
#[allow(unreachable_code)]
4749
fn test_skipped(mut args: Vec<String>) {
4850
args.push("--version".to_string());
49-
let unreach_fn = |_: TyCtxt| -> ControlFlow<()> { unreachable!() };
50-
let result = rustc_internal::StableMir::new(args, unreach_fn).run();
51+
let result = run!(args, unreachable!() as ControlFlow<()>);
5152
assert_eq!(result, Err(stable_mir::CompilerError::Skipped));
5253
}
5354

55+
#[allow(unreachable_code)]
5456
fn test_failed(mut args: Vec<String>) {
5557
args.push("--cfg=broken".to_string());
56-
let unreach_fn = |_: TyCtxt| -> ControlFlow<()> { unreachable!() };
57-
let result = rustc_internal::StableMir::new(args, unreach_fn).run();
58+
let result = run!(args, unreachable!() as ControlFlow<()>);
5859
assert_eq!(result, Err(stable_mir::CompilerError::CompilationFailed));
5960
}
6061

‎tests/ui-fulldeps/stable-mir/crate-info.rs

+7-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
// ignore-stage1
55
// ignore-cross-compile
66
// ignore-remote
7+
// ignore-windows-gnu mingw has troubles with linking https://github.com/rust-lang/rust/pull/116837
78
// edition: 2021
89

910
#![feature(rustc_private)]
@@ -12,7 +13,10 @@
1213

1314
extern crate rustc_hir;
1415
extern crate rustc_middle;
16+
#[macro_use]
1517
extern crate rustc_smir;
18+
extern crate rustc_driver;
19+
extern crate rustc_interface;
1620
extern crate stable_mir;
1721

1822
use rustc_hir::def::DefKind;
@@ -127,7 +131,8 @@ fn test_stable_mir(_tcx: TyCtxt<'_>) -> ControlFlow<()> {
127131
mut args,
128132
)) => {
129133
let func = def.body();
130-
match func.locals[1].ty
134+
match func.locals[1]
135+
.ty
131136
.fold(&mut args)
132137
.continue_value()
133138
.unwrap()
@@ -185,7 +190,7 @@ fn main() {
185190
CRATE_NAME.to_string(),
186191
path.to_string(),
187192
];
188-
rustc_internal::StableMir::new(args, test_stable_mir).run().unwrap();
193+
run!(args, tcx, test_stable_mir(tcx)).unwrap();
189194
}
190195

191196
fn generate_input(path: &str) -> std::io::Result<()> {

‎tests/ui-fulldeps/stable-mir/instance.rs

+12-9
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,24 @@
44
// ignore-stage1
55
// ignore-cross-compile
66
// ignore-remote
7+
// ignore-windows-gnu mingw has troubles with linking https://github.com/rust-lang/rust/pull/116837
78
// edition: 2021
89

910
#![feature(rustc_private)]
1011
#![feature(assert_matches)]
1112
#![feature(control_flow_enum)]
1213

1314
extern crate rustc_middle;
15+
#[macro_use]
1416
extern crate rustc_smir;
17+
extern crate rustc_driver;
18+
extern crate rustc_interface;
1519
extern crate stable_mir;
1620

1721
use rustc_middle::ty::TyCtxt;
1822

19-
use stable_mir::*;
2023
use rustc_smir::rustc_internal;
24+
use stable_mir::*;
2125
use std::io::Write;
2226
use std::ops::ControlFlow;
2327

@@ -28,16 +32,16 @@ fn test_stable_mir(_tcx: TyCtxt<'_>) -> ControlFlow<()> {
2832
let items = stable_mir::all_local_items();
2933

3034
// Get all items and split generic vs monomorphic items.
31-
let (generic, mono) : (Vec<_>, Vec<_>) = items.into_iter().partition(|item| {
32-
item.requires_monomorphization()
33-
});
35+
let (generic, mono): (Vec<_>, Vec<_>) =
36+
items.into_iter().partition(|item| item.requires_monomorphization());
3437
assert_eq!(mono.len(), 3, "Expected 2 mono functions and one constant");
3538
assert_eq!(generic.len(), 2, "Expected 2 generic functions");
3639

3740
// For all monomorphic items, get the correspondent instances.
38-
let instances = mono.iter().filter_map(|item| {
39-
mir::mono::Instance::try_from(*item).ok()
40-
}).collect::<Vec<mir::mono::Instance>>();
41+
let instances = mono
42+
.iter()
43+
.filter_map(|item| mir::mono::Instance::try_from(*item).ok())
44+
.collect::<Vec<mir::mono::Instance>>();
4145
assert_eq!(instances.len(), mono.len());
4246

4347
// For all generic items, try_from should fail.
@@ -46,7 +50,6 @@ fn test_stable_mir(_tcx: TyCtxt<'_>) -> ControlFlow<()> {
4650
ControlFlow::Continue(())
4751
}
4852

49-
5053
/// This test will generate and analyze a dummy crate using the stable mir.
5154
/// For that, it will first write the dummy crate into a file.
5255
/// Then it will create a `StableMir` using custom arguments and then
@@ -61,7 +64,7 @@ fn main() {
6164
CRATE_NAME.to_string(),
6265
path.to_string(),
6366
];
64-
rustc_internal::StableMir::new(args, test_stable_mir).run().unwrap();
67+
run!(args, tcx, test_stable_mir(tcx)).unwrap();
6568
}
6669

6770
fn generate_input(path: &str) -> std::io::Result<()> {

0 commit comments

Comments
 (0)