-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Better pretty printing for const raw pointers #65859
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 7 commits
22586d7
6a6ed12
d322044
3364c46
f2cb4d7
6c26bd6
175c608
c2dbe44
27d89ec
1407cdd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -864,6 +864,49 @@ pub trait PrettyPrinter<'tcx>: | |
|
||
let u8 = self.tcx().types.u8; | ||
|
||
if let ty::Ref(_, ref_ty, _) = ct.ty.kind { | ||
let byte_str = match (ct.val, &ref_ty.kind) { | ||
(ConstValue::Scalar(Scalar::Ptr(ptr)), ty::Array(t, n)) if *t == u8 => { | ||
let n = n.eval_usize(self.tcx(), ty::ParamEnv::empty()); | ||
Some(self.tcx() | ||
.alloc_map.lock() | ||
.unwrap_memory(ptr.alloc_id) | ||
.get_bytes(&self.tcx(), ptr, Size::from_bytes(n)).unwrap()) | ||
}, | ||
(ConstValue::Slice { data, start, end }, ty::Slice(t)) if *t == u8 => { | ||
// The `inspect` here is okay since we checked the bounds, and there are | ||
// no relocations (we have an active slice reference here). We don't use | ||
// this result to affect interpreter execution. | ||
Some(data.inspect_with_undef_and_ptr_outside_interpreter(start..end)) | ||
}, | ||
_ => None, | ||
}; | ||
|
||
if let Some(byte_str) = byte_str { | ||
p!(write("b\"")); | ||
for &c in byte_str { | ||
for e in std::ascii::escape_default(c) { | ||
self.write_char(e as char)?; | ||
} | ||
} | ||
p!(write("\"")); | ||
return Ok(self); | ||
} | ||
|
||
if let (ConstValue::Slice { data, start, end }, ty::Str) = | ||
(ct.val, &ref_ty.kind) | ||
{ | ||
// The `inspect` here is okay since we checked the bounds, and there are no | ||
// relocations (we have an active `str` reference here). We don't use this | ||
// result to affect interpreter execution. | ||
let slice = data.inspect_with_undef_and_ptr_outside_interpreter(start..end); | ||
let s = ::std::str::from_utf8(slice) | ||
.expect("non utf8 str from miri"); | ||
p!(write("{:?}", s)); | ||
return Ok(self); | ||
} | ||
}; | ||
|
||
match (ct.val, &ct.ty.kind) { | ||
(_, ty::FnDef(did, substs)) => p!(print_value_path(*did, substs)), | ||
(ConstValue::Unevaluated(did, substs), _) => { | ||
|
@@ -919,7 +962,16 @@ pub trait PrettyPrinter<'tcx>: | |
}, | ||
(ConstValue::Scalar(Scalar::Raw { data, .. }), ty::Char) => | ||
p!(write("{:?}", ::std::char::from_u32(data as u32).unwrap())), | ||
(ConstValue::Scalar(_), ty::RawPtr(_)) => p!(write("{{pointer}}")), | ||
(ConstValue::Scalar(value), ty::Ref(..)) | | ||
(ConstValue::Scalar(value), ty::RawPtr(_)) => { | ||
match value { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So this is a "fallback" case now, right? We already have a big case for references above. Unfortunately it is not immediately clear what distinguishes these cases. Could you add some comments both at the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't know the history of that big There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. From what I can see, the point of that is to print the content of the slice/array when possible for types The fallback then is that for all other references and raw pointers, we just print the pointer value, not the thing it points to. |
||
Scalar::Raw { data, size } => { | ||
p!(write("0x{:01$x} : ", data, size as usize * 2)); | ||
} | ||
_ => p!(write("{{pointer}} : ")) | ||
iwikal marked this conversation as resolved.
Show resolved
Hide resolved
|
||
}; | ||
p!(print(ct.ty)); | ||
} | ||
(ConstValue::Scalar(Scalar::Ptr(ptr)), ty::FnPtr(_)) => { | ||
let instance = { | ||
let alloc_map = self.tcx().alloc_map.lock(); | ||
|
@@ -928,54 +980,8 @@ pub trait PrettyPrinter<'tcx>: | |
p!(print_value_path(instance.def_id(), instance.substs)); | ||
}, | ||
_ => { | ||
let printed = if let ty::Ref(_, ref_ty, _) = ct.ty.kind { | ||
let byte_str = match (ct.val, &ref_ty.kind) { | ||
(ConstValue::Scalar(Scalar::Ptr(ptr)), ty::Array(t, n)) if *t == u8 => { | ||
let n = n.eval_usize(self.tcx(), ty::ParamEnv::empty()); | ||
Some(self.tcx() | ||
.alloc_map.lock() | ||
.unwrap_memory(ptr.alloc_id) | ||
.get_bytes(&self.tcx(), ptr, Size::from_bytes(n)).unwrap()) | ||
}, | ||
(ConstValue::Slice { data, start, end }, ty::Slice(t)) if *t == u8 => { | ||
// The `inspect` here is okay since we checked the bounds, and there are | ||
// no relocations (we have an active slice reference here). We don't use | ||
// this result to affect interpreter execution. | ||
Some(data.inspect_with_undef_and_ptr_outside_interpreter(start..end)) | ||
}, | ||
_ => None, | ||
}; | ||
|
||
if let Some(byte_str) = byte_str { | ||
p!(write("b\"")); | ||
for &c in byte_str { | ||
for e in std::ascii::escape_default(c) { | ||
self.write_char(e as char)?; | ||
} | ||
} | ||
p!(write("\"")); | ||
true | ||
} else if let (ConstValue::Slice { data, start, end }, ty::Str) = | ||
(ct.val, &ref_ty.kind) | ||
{ | ||
// The `inspect` here is okay since we checked the bounds, and there are no | ||
// relocations (we have an active `str` reference here). We don't use this | ||
// result to affect interpreter execution. | ||
let slice = data.inspect_with_undef_and_ptr_outside_interpreter(start..end); | ||
let s = ::std::str::from_utf8(slice) | ||
.expect("non utf8 str from miri"); | ||
p!(write("{:?}", s)); | ||
true | ||
} else { | ||
false | ||
} | ||
} else { | ||
false | ||
}; | ||
if !printed { | ||
// fallback | ||
p!(write("{:?} : ", ct.val), print(ct.ty)) | ||
} | ||
// fallback | ||
p!(write("{:?} : ", ct.val), print(ct.ty)) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, here you are using the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is no different from the old fallback. I simply moved the block that tries to print slices and strings to happen before the big match statement, so that the new const ref arm we just added doesn't override strings and slices. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. True. This was already bad before. I pointed this out because it might be related to your comment at #65859 (comment). if you don't want to fix this in this PR, feel free to open an issue. We shouldn't use There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
That's what I thought as well, but this is not the code path that causes that particular line in the mir-opt output. It comes from somewhere else, perhaps within miri itself. I don't feel confident making a decision about the fallback case, since I don't know what it affects, so I'll open an issue instead. And since it won't be user facing, should I just bless this output and be done with it? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why is it not user-facing? Isn't this here used for the type mismatch errors that the PR updates? I think I am confused about which change you are worried about. If this PR makes mir-opt fail, then please either fix that or update the mir-opt tests so that we can see in the diff what the changes are. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. _4 = const {pointer} : &i32;
_3 = const {pointer} : &i32;
_2 = const Scalar(AllocId(1).0x0) : *const i32; I saw this in the actual output from _4 = const {pointer} : &i32;
_3 = const {pointer} : &i32;
_2 = const {pointer} : *const i32; And started trying to get that to happen. But if it's not critical that mir dumps are pretty, I will happily abandon that work. I've solved the merge conflicts and pushed a blessing. |
||
} | ||
}; | ||
Ok(self) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
// normalize-stderr-32bit: "0x" -> "$$PREFIX" | ||
// normalize-stderr-64bit: "0x00000000" -> "$$PREFIX" | ||
|
||
#![feature(const_generics, const_compare_raw_pointers)] | ||
//~^ WARN the feature `const_generics` is incomplete and may cause the compiler to crash | ||
|
||
struct Const<const P: &'static ()>; | ||
|
||
#[repr(C)] | ||
union Transmuter { | ||
pointer: *const (), | ||
reference: &'static (), | ||
} | ||
|
||
fn main() { | ||
const A: &'static () = { | ||
unsafe { Transmuter { pointer: 10 as *const () }.reference } | ||
}; | ||
const B: &'static () = { | ||
unsafe { Transmuter { pointer: 11 as *const () }.reference } | ||
}; | ||
|
||
let _: Const<{A}> = Const::<{B}>; //~ mismatched types | ||
let _: Const<{A}> = Const::<{&()}>; //~ mismatched types | ||
let _: Const<{A}> = Const::<{A}>; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
warning: the feature `const_generics` is incomplete and may cause the compiler to crash | ||
--> $DIR/int-as-ref-const-param.rs:4:12 | ||
| | ||
LL | #![feature(const_generics, const_compare_raw_pointers)] | ||
| ^^^^^^^^^^^^^^ | ||
| | ||
= note: `#[warn(incomplete_features)]` on by default | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/int-as-ref-const-param.rs:23:25 | ||
| | ||
LL | let _: Const<{A}> = Const::<{B}>; | ||
| ^^^^^^^^^^^^ expected `$PREFIX0000000a : &()`, found `$PREFIX0000000b : &()` | ||
| | ||
= note: expected type `Const<$PREFIX0000000a : &()>` | ||
found type `Const<$PREFIX0000000b : &()>` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/int-as-ref-const-param.rs:24:25 | ||
| | ||
LL | let _: Const<{A}> = Const::<{&()}>; | ||
| ^^^^^^^^^^^^^^ expected `$PREFIX0000000a : &()`, found `{pointer} : &()` | ||
| | ||
= note: expected type `Const<$PREFIX0000000a : &()>` | ||
found type `Const<{pointer} : &()>` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. FWIW, on current nightly this prints
So, yeah, the new output is much better. :D It seems like right now the code is shared between printing this error and printing the mir-dump, and that is likely not what we want? |
||
|
||
error: aborting due to 2 previous errors | ||
|
||
For more information about this error, try `rustc --explain E0308`. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,29 @@ | ||
warning: the feature `const_generics` is incomplete and may cause the compiler to crash | ||
--> $DIR/raw-ptr-const-param.rs:1:12 | ||
--> $DIR/raw-ptr-const-param.rs:4:12 | ||
| | ||
LL | #![feature(const_generics, const_compare_raw_pointers)] | ||
| ^^^^^^^^^^^^^^ | ||
| | ||
= note: `#[warn(incomplete_features)]` on by default | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/raw-ptr-const-param.rs:7:38 | ||
--> $DIR/raw-ptr-const-param.rs:10:38 | ||
| | ||
LL | let _: Const<{15 as *const _}> = Const::<{10 as *const _}>; | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^ expected `{pointer}`, found `{pointer}` | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^ expected `$PREFIX0000000f : *const u32`, found `$PREFIX0000000a : *const u32` | ||
| | ||
= note: expected type `Const<{pointer}>` | ||
found type `Const<{pointer}>` | ||
= note: expected type `Const<$PREFIX0000000f : *const u32>` | ||
found type `Const<$PREFIX0000000a : *const u32>` | ||
|
||
error: aborting due to previous error | ||
error[E0308]: mismatched types | ||
--> $DIR/raw-ptr-const-param.rs:13:38 | ||
| | ||
LL | let _: Const<{10 as *const _}> = Const::<{&8_u32 as *const _}>; | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ expected `$PREFIX0000000a : *const u32`, found `{pointer} : *const u32` | ||
| | ||
= note: expected type `Const<$PREFIX0000000a : *const u32>` | ||
found type `Const<{pointer} : *const u32>` | ||
|
||
error: aborting due to 2 previous errors | ||
|
||
For more information about this error, try `rustc --explain E0308`. |
Uh oh!
There was an error while loading. Please reload this page.