Skip to content

Commit 8041889

Browse files
celinvalcelinval
committed
Remove tcx from SMIR run macro and accept closures
Simplify the `run` macro to avoid sometimes unnecessary dependency on `TyCtxt`. Instead, users can use the new internal method `tcx()`. Additionally, extend the macro to accept closures that may capture variables. These are non-backward compatible changes, but they only affect internal APIs which are provided today as helper functions until we have a stable API to start the compiler.
1 parent 090d5ea commit 8041889

File tree

12 files changed

+134
-60
lines changed

12 files changed

+134
-60
lines changed

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

+105-17
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,49 @@ use std::ops::Index;
2424
mod internal;
2525
pub mod pretty;
2626

27+
/// Convert an internal Rust compiler item into its stable counterpart, if one exists.
28+
///
29+
/// # Warning
30+
///
31+
/// This function is unstable, and it's behavior may change at any point.
32+
/// E.g.: Items that were previously supported, may no longer be supported, or its translation may
33+
/// change.
34+
///
35+
/// # Panics
36+
///
37+
/// This function will panic if StableMIR has not been properly initialized.
2738
pub fn stable<'tcx, S: Stable<'tcx>>(item: S) -> S::T {
2839
with_tables(|tables| item.stable(tables))
2940
}
3041

42+
/// Convert a stable item into its internal Rust compiler counterpart, if one exists.
43+
///
44+
/// # Warning
45+
///
46+
/// This function is unstable, and it's behavior may change at any point.
47+
/// Not every stable item can be converted to an internal one.
48+
/// Furthermore, items that were previously supported, may no longer be supported in newer versions.
49+
///
50+
/// # Panics
51+
///
52+
/// This function will panic if StableMIR has not been properly initialized.
3153
pub fn internal<'tcx, S: RustcInternal<'tcx>>(item: S) -> S::T {
3254
with_tables(|tables| item.internal(tables))
3355
}
3456

57+
/// Retrieve the internal Rust compiler type context.
58+
///
59+
/// # Warning
60+
///
61+
/// This function is unstable, and it's behavior may change at any point.
62+
///
63+
/// # Panics
64+
///
65+
/// This function will panic if StableMIR has not been properly initialized.
66+
pub fn tcx<'tcx>() -> TyCtxt<'tcx> {
67+
with_tables(|tables| tables.tcx)
68+
}
69+
3570
impl<'tcx> Index<stable_mir::DefId> for Tables<'tcx> {
3671
type Output = DefId;
3772

@@ -190,35 +225,83 @@ where
190225
stable_mir::compiler_interface::run(&tables, || init(&tables, f))
191226
}
192227

228+
/// Instantiate and run the compiler with the provided arguments and callback.
229+
///
230+
/// The callback will be invoked after the compiler ran all its analysis, but before code generation.
231+
/// Note that this macro accepts two different formats for the callback:
232+
/// 1. An ident that resolves to a function that accepts no argument and returns `ControlFlow<B, C>`
233+
/// ```ignore(needs-extern-crate)
234+
/// # extern crate rustc_driver;
235+
/// # extern crate rustc_interface;
236+
/// # #[macro_use]
237+
/// # extern crate rustc_smir;
238+
/// # extern crate stable_mir;
239+
/// #
240+
/// # fn main() {
241+
/// # use std::ops::ControlFlow;
242+
/// # use stable_mir::CompilerError;
243+
/// fn analyze_code() -> ControlFlow<(), ()> {
244+
/// // Your code goes in here.
245+
/// # ControlFlow::Continue(())
246+
/// }
247+
/// # let args = vec!["--verbose".to_string()];
248+
/// let result = run!(args, analyze_code);
249+
/// # assert_eq!(result, Err(CompilerError::Skipped))
250+
/// # }
251+
/// ```
252+
/// 2. An expression that represents the body of a closure:
253+
/// ```ignore(needs-extern-crate)
254+
/// # extern crate rustc_driver;
255+
/// # extern crate rustc_interface;
256+
/// # #[macro_use]
257+
/// # extern crate rustc_smir;
258+
/// # extern crate stable_mir;
259+
/// #
260+
/// # fn main() {
261+
/// # use std::ops::ControlFlow;
262+
/// # use stable_mir::CompilerError;
263+
/// fn analyze_code(extra_args: Vec<String>) -> ControlFlow<(), ()> {
264+
/// # let _ = extra_args;
265+
/// // Your code goes in here.
266+
/// # ControlFlow::Continue(())
267+
/// }
268+
/// # let args = vec!["--verbose".to_string()];
269+
/// # let extra_args = vec![];
270+
/// let result = run!(args, analyze_code(extra_args));
271+
/// # assert_eq!(result, Err(CompilerError::Skipped))
272+
/// # }
273+
/// ```
193274
#[macro_export]
194275
macro_rules! run {
195-
($args:expr, $callback:expr) => {
196-
run!($args, tcx, $callback)
276+
($args:expr, $callback_fn:ident) => {
277+
run!($args, $callback_fn())
197278
};
198-
($args:expr, $tcx:ident, $callback:expr) => {{
279+
($args:expr, $callback:expr) => {{
199280
use rustc_driver::{Callbacks, Compilation, RunCompiler};
200281
use rustc_interface::{interface, Queries};
201282
use stable_mir::CompilerError;
202283
use std::ops::ControlFlow;
203284

204-
pub struct StableMir<B = (), C = ()>
285+
pub struct StableMir<B = (), C = (), F = fn() -> ControlFlow<B, C>>
205286
where
206287
B: Send,
207288
C: Send,
289+
F: FnOnce() -> ControlFlow<B, C> + Send,
208290
{
209291
args: Vec<String>,
210-
callback: fn(TyCtxt<'_>) -> ControlFlow<B, C>,
292+
callback: Option<F>,
211293
result: Option<ControlFlow<B, C>>,
212294
}
213295

214-
impl<B, C> StableMir<B, C>
296+
impl<B, C, F> StableMir<B, C, F>
215297
where
216298
B: Send,
217299
C: Send,
300+
F: FnOnce() -> ControlFlow<B, C> + Send,
218301
{
219302
/// Creates a new `StableMir` instance, with given test_function and arguments.
220-
pub fn new(args: Vec<String>, callback: fn(TyCtxt<'_>) -> ControlFlow<B, C>) -> Self {
221-
StableMir { args, callback, result: None }
303+
pub fn new(args: Vec<String>, callback: F) -> Self {
304+
StableMir { args, callback: Some(callback), result: None }
222305
}
223306

224307
/// Runs the compiler against given target and tests it with `test_function`
@@ -238,10 +321,11 @@ macro_rules! run {
238321
}
239322
}
240323

241-
impl<B, C> Callbacks for StableMir<B, C>
324+
impl<B, C, F> Callbacks for StableMir<B, C, F>
242325
where
243326
B: Send,
244327
C: Send,
328+
F: FnOnce() -> ControlFlow<B, C> + Send,
245329
{
246330
/// Called after analysis. Return value instructs the compiler whether to
247331
/// continue the compilation afterwards (defaults to `Compilation::Continue`)
@@ -251,20 +335,24 @@ macro_rules! run {
251335
queries: &'tcx Queries<'tcx>,
252336
) -> Compilation {
253337
queries.global_ctxt().unwrap().enter(|tcx| {
254-
rustc_internal::run(tcx, || {
255-
self.result = Some((self.callback)(tcx));
256-
})
257-
.unwrap();
258-
if self.result.as_ref().is_some_and(|val| val.is_continue()) {
259-
Compilation::Continue
338+
if let Some(callback) = self.callback.take() {
339+
rustc_internal::run(tcx, || {
340+
self.result = Some((callback)());
341+
})
342+
.unwrap();
343+
if self.result.as_ref().is_some_and(|val| val.is_continue()) {
344+
Compilation::Continue
345+
} else {
346+
Compilation::Stop
347+
}
260348
} else {
261-
Compilation::Stop
349+
Compilation::Continue
262350
}
263351
})
264352
}
265353
}
266354

267-
StableMir::new($args, |$tcx| $callback).run()
355+
StableMir::new($args, || $callback).run()
268356
}};
269357
}
270358

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

+2-4
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,12 @@
1212
#![feature(ascii_char, ascii_char_variants)]
1313

1414
extern crate rustc_hir;
15-
extern crate rustc_middle;
1615
#[macro_use]
1716
extern crate rustc_smir;
1817
extern crate rustc_driver;
1918
extern crate rustc_interface;
2019
extern crate stable_mir;
2120

22-
use rustc_middle::ty::TyCtxt;
2321
use rustc_smir::rustc_internal;
2422
use stable_mir::abi::{ArgAbi, CallConvention, FieldsShape, PassMode, VariantsShape};
2523
use stable_mir::mir::mono::Instance;
@@ -32,7 +30,7 @@ use std::ops::ControlFlow;
3230
const CRATE_NAME: &str = "input";
3331

3432
/// This function uses the Stable MIR APIs to get information about the test crate.
35-
fn test_stable_mir(_tcx: TyCtxt<'_>) -> ControlFlow<()> {
33+
fn test_stable_mir() -> ControlFlow<()> {
3634
// Find items in the local crate.
3735
let items = stable_mir::all_local_items();
3836

@@ -117,7 +115,7 @@ fn main() {
117115
CRATE_NAME.to_string(),
118116
path.to_string(),
119117
];
120-
run!(args, tcx, test_stable_mir(tcx)).unwrap();
118+
run!(args, test_stable_mir).unwrap();
121119
}
122120

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

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

+2-4
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,12 @@
1414
#![feature(ascii_char, ascii_char_variants)]
1515

1616
extern crate rustc_hir;
17-
extern crate rustc_middle;
1817
#[macro_use]
1918
extern crate rustc_smir;
2019
extern crate rustc_driver;
2120
extern crate rustc_interface;
2221
extern crate stable_mir;
2322

24-
use rustc_middle::ty::TyCtxt;
2523
use rustc_smir::rustc_internal;
2624
use stable_mir::crate_def::CrateDef;
2725
use stable_mir::mir::alloc::GlobalAlloc;
@@ -40,7 +38,7 @@ use std::ops::ControlFlow;
4038
const CRATE_NAME: &str = "input";
4139

4240
/// This function uses the Stable MIR APIs to get information about the test crate.
43-
fn test_stable_mir(_tcx: TyCtxt<'_>) -> ControlFlow<()> {
41+
fn test_stable_mir() -> ControlFlow<()> {
4442
// Find items in the local crate.
4543
let items = stable_mir::all_local_items();
4644
check_foo(*get_item(&items, (ItemKind::Static, "FOO")).unwrap());
@@ -230,7 +228,7 @@ fn main() {
230228
CRATE_NAME.to_string(),
231229
path.to_string(),
232230
];
233-
run!(args, tcx, test_stable_mir(tcx)).unwrap();
231+
run!(args, test_stable_mir).unwrap();
234232
}
235233

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

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

+2-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
#![feature(assert_matches)]
1212
#![feature(control_flow_enum)]
1313

14-
extern crate rustc_middle;
1514
#[macro_use]
1615
extern crate rustc_smir;
1716
extern crate rustc_driver;
@@ -20,7 +19,6 @@ extern crate stable_mir;
2019

2120
use std::assert_matches::assert_matches;
2221
use mir::{mono::Instance, TerminatorKind::*};
23-
use rustc_middle::ty::TyCtxt;
2422
use rustc_smir::rustc_internal;
2523
use stable_mir::ty::{RigidTy, TyKind, Ty, UintTy};
2624
use stable_mir::*;
@@ -30,7 +28,7 @@ use std::ops::ControlFlow;
3028
const CRATE_NAME: &str = "input";
3129

3230
/// This function uses the Stable MIR APIs to get information about the test crate.
33-
fn test_stable_mir(_tcx: TyCtxt<'_>) -> ControlFlow<()> {
31+
fn test_stable_mir() -> ControlFlow<()> {
3432
let entry = stable_mir::entry_fn().unwrap();
3533
let main_fn = Instance::try_from(entry).unwrap();
3634
assert_eq!(main_fn.name(), "main");
@@ -113,7 +111,7 @@ fn main() {
113111
CRATE_NAME.to_string(),
114112
path.to_string(),
115113
];
116-
run!(args, tcx, test_stable_mir(tcx)).unwrap();
114+
run!(args, test_stable_mir).unwrap();
117115
}
118116

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

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

+2-4
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,13 @@
1111
#![feature(assert_matches)]
1212
#![feature(control_flow_enum)]
1313

14-
extern crate rustc_middle;
1514
#[macro_use]
1615
extern crate rustc_smir;
1716
extern crate rustc_driver;
1817
extern crate rustc_interface;
1918
extern crate stable_mir;
2019

2120
use mir::{mono::Instance, TerminatorKind::*};
22-
use rustc_middle::ty::TyCtxt;
2321
use rustc_smir::rustc_internal;
2422
use stable_mir::ty::{RigidTy, TyKind};
2523
use stable_mir::*;
@@ -29,7 +27,7 @@ use std::ops::ControlFlow;
2927
const CRATE_NAME: &str = "input";
3028

3129
/// This function uses the Stable MIR APIs to get information about the test crate.
32-
fn test_stable_mir(_tcx: TyCtxt<'_>) -> ControlFlow<()> {
30+
fn test_stable_mir() -> ControlFlow<()> {
3331
let items = stable_mir::all_local_items();
3432

3533
// Get all items and split generic vs monomorphic items.
@@ -96,7 +94,7 @@ fn main() {
9694
CRATE_NAME.to_string(),
9795
path.to_string(),
9896
];
99-
run!(args, tcx, test_stable_mir(tcx)).unwrap();
97+
run!(args, test_stable_mir).unwrap();
10098
}
10199

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

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

+2-4
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,12 @@
1111
#![feature(assert_matches)]
1212
#![feature(control_flow_enum)]
1313

14-
extern crate rustc_middle;
1514
#[macro_use]
1615
extern crate rustc_smir;
1716
extern crate rustc_driver;
1817
extern crate rustc_interface;
1918
extern crate stable_mir;
2019

21-
use rustc_middle::ty::TyCtxt;
2220
use rustc_smir::rustc_internal;
2321
use stable_mir::*;
2422
use std::io::Write;
@@ -27,7 +25,7 @@ use std::ops::ControlFlow;
2725
const CRATE_NAME: &str = "input";
2826

2927
/// This function uses the Stable MIR APIs to get information about the test crate.
30-
fn test_item_kind(_tcx: TyCtxt<'_>) -> ControlFlow<()> {
28+
fn test_item_kind() -> ControlFlow<()> {
3129
let items = stable_mir::all_local_items();
3230
assert_eq!(items.len(), 4);
3331
// Constructor item.
@@ -59,7 +57,7 @@ fn main() {
5957
CRATE_NAME.to_string(),
6058
path.to_string(),
6159
];
62-
run!(args, tcx, test_item_kind(tcx)).unwrap();
60+
run!(args, test_item_kind).unwrap();
6361
}
6462

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

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

+2-4
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,12 @@
1212
#![feature(assert_matches)]
1313
#![feature(control_flow_enum)]
1414

15-
extern crate rustc_middle;
1615
#[macro_use]
1716
extern crate rustc_smir;
1817
extern crate rustc_driver;
1918
extern crate rustc_interface;
2019
extern crate stable_mir;
2120

22-
use rustc_middle::ty::TyCtxt;
2321
use rustc_smir::rustc_internal;
2422
use stable_mir::ty::{RigidTy, TyKind, Ty, };
2523
use stable_mir::mir::{Body, MirVisitor, FieldIdx, Place, ProjectionElem, visit::{Location,
@@ -30,7 +28,7 @@ use std::ops::ControlFlow;
3028
const CRATE_NAME: &str = "input";
3129

3230
/// This function uses the Stable MIR APIs to get information about the test crate.
33-
fn test_stable_mir(_tcx: TyCtxt<'_>) -> ControlFlow<()> {
31+
fn test_stable_mir() -> ControlFlow<()> {
3432
let main_fn = stable_mir::entry_fn();
3533
let body = main_fn.unwrap().body();
3634
let mut visitor = PlaceVisitor{ body: &body, tested: false};
@@ -87,7 +85,7 @@ fn main() {
8785
CRATE_NAME.to_string(),
8886
path.to_string(),
8987
];
90-
run!(args, tcx, test_stable_mir(tcx)).unwrap();
88+
run!(args, test_stable_mir).unwrap();
9189
}
9290

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

0 commit comments

Comments
 (0)