Doc comment custom MIR debuginfo.

and add a test for the constant case
This commit is contained in:
Camille GILLOT 2023-10-21 08:33:37 +00:00 committed by Ralf Jung
parent cb2bd2bb06
commit c76f1f0b9b
4 changed files with 62 additions and 3 deletions

View File

@ -249,6 +249,30 @@
//! `Call(ret_val = function(arg1, arg2, ...), ReturnTo(next_block), UnwindContinue())`.
//! - [`TailCall`] does not have a return destination or next block, so its syntax is just
//! `TailCall(function(arg1, arg2, ...))`.
//!
//! #### Debuginfo
//!
//! - A debuginfo name can be given to a local using `debug my_name => contents;`.
//! For `contents`, we use the same syntax as operands, to support both places and constants.
//!
//! ```rust
//! #![allow(internal_features)]
//! #![feature(core_intrinsics, custom_mir)]
//!
//! use core::intrinsics::mir::*;
//!
//! #[custom_mir(dialect = "built")]
//! fn debuginfo(option: Option<&i32>) {
//! mir!(
//! debug option => option;
//! debug projection => *Field::<&i32>(Variant(option, 1), 0);
//! debug constant => 5_usize;
//! {
//! Return()
//! }
//! )
//! }
//! ```
#![unstable(
feature = "custom_mir",

View File

@ -0,0 +1,10 @@
// MIR for `constant` after built
fn constant() -> () {
debug scalar => const 5_usize;
let mut _0: ();
bb0: {
return;
}
}

View File

@ -2,7 +2,7 @@
fn numbered(_1: (u32, i32)) -> () {
debug first => (_1.0: u32);
debug second => (_1.0: u32);
debug second => (_1.1: i32);
let mut _0: ();
bb0: {

View File

@ -1,4 +1,3 @@
// skip-filecheck
#![feature(custom_mir, core_intrinsics)]
extern crate core;
@ -7,6 +6,8 @@ use core::intrinsics::mir::*;
// EMIT_MIR debuginfo.pointee.built.after.mir
#[custom_mir(dialect = "built")]
fn pointee(opt: &mut Option<i32>) {
// CHECK-LABEL: fn pointee(
// CHECK: debug foo => (((*_1) as variant#1).0: i32);
mir! {
debug foo => Field::<i32>(Variant(*opt, 1), 0);
{
@ -18,9 +19,12 @@ fn pointee(opt: &mut Option<i32>) {
// EMIT_MIR debuginfo.numbered.built.after.mir
#[custom_mir(dialect = "analysis", phase = "post-cleanup")]
fn numbered(i: (u32, i32)) {
// CHECK-LABEL: fn numbered(
// CHECK: debug first => (_1.0: u32);
// CHECK: debug second => (_1.1: i32);
mir! {
debug first => i.0;
debug second => i.0;
debug second => i.1;
{
Return()
}
@ -34,6 +38,8 @@ struct S {
// EMIT_MIR debuginfo.structured.built.after.mir
#[custom_mir(dialect = "analysis", phase = "post-cleanup")]
fn structured(i: S) {
// CHECK-LABEL: fn structured(
// CHECK: debug x => (_1.0: f32);
mir! {
debug x => i.x;
{
@ -45,6 +51,8 @@ fn structured(i: S) {
// EMIT_MIR debuginfo.variant.built.after.mir
#[custom_mir(dialect = "built")]
fn variant(opt: Option<i32>) {
// CHECK-LABEL: fn variant(
// CHECK: debug inner => ((_1 as variant#1).0: i32);
mir! {
debug inner => Field::<i32>(Variant(opt, 1), 0);
{
@ -56,6 +64,9 @@ fn variant(opt: Option<i32>) {
// EMIT_MIR debuginfo.variant_deref.built.after.mir
#[custom_mir(dialect = "built")]
fn variant_deref(opt: Option<&i32>) {
// CHECK-LABEL: fn variant_deref(
// CHECK: debug pointer => ((_1 as variant#1).0: &i32);
// CHECK: debug deref => (*((_1 as variant#1).0: &i32));
mir! {
debug pointer => Field::<&i32>(Variant(opt, 1), 0);
debug deref => *Field::<&i32>(Variant(opt, 1), 0);
@ -65,10 +76,24 @@ fn variant_deref(opt: Option<&i32>) {
}
}
// EMIT_MIR debuginfo.constant.built.after.mir
#[custom_mir(dialect = "built")]
fn constant() {
// CHECK-LABEL: fn constant(
// CHECK: debug scalar => const 5_usize;
mir!(
debug scalar => 5_usize;
{
Return()
}
)
}
fn main() {
numbered((5, 6));
structured(S { x: 5. });
variant(Some(5));
variant_deref(Some(&5));
pointee(&mut Some(5));
constant();
}