Rename some things around validation error reporting to signal that it is in fact about validation failures

oli-obk · oli-obk · commit a316c21dc8aa · 2024-03-14T12:21:35.000Z
diff --git a/compiler/rustc_const_eval/messages.ftl b/compiler/rustc_const_eval/messages.ftl
@@ -374,12 +374,6 @@ const_eval_unallowed_op_in_const_context =
 const_eval_unavailable_target_features_for_fn =
     calling a function that requires unavailable target features: {$unavailable_feats}
 
-const_eval_undefined_behavior =
-    it is undefined behavior to use this value
-
-const_eval_undefined_behavior_note =
-    The rules on what exactly is undefined behavior aren't clear, so this check might be overzealous. Please open an issue on the rustc repository if you believe it should not be considered undefined behavior.
-
 const_eval_uninhabited_enum_variant_read =
     read discriminant of an uninhabited enum variant
 const_eval_uninhabited_enum_variant_written =
@@ -434,6 +428,12 @@ const_eval_validation_expected_raw_ptr = expected a raw pointer
 const_eval_validation_expected_ref = expected a reference
 const_eval_validation_expected_str = expected a string
 
+const_eval_validation_failure =
+    it is undefined behavior to use this value
+
+const_eval_validation_failure_note =
+    The rules on what exactly is undefined behavior aren't clear, so this check might be overzealous. Please open an issue on the rustc repository if you believe it should not be considered undefined behavior.
+
 const_eval_validation_front_matter_invalid_value = constructing invalid value
 const_eval_validation_front_matter_invalid_value_with_path = constructing invalid value at {$path}
 
diff --git a/compiler/rustc_const_eval/src/const_eval/eval_queries.rs b/compiler/rustc_const_eval/src/const_eval/eval_queries.rs
@@ -382,7 +382,7 @@ fn eval_in_interpreter<'tcx, R: InterpretationResult<'tcx>>(
 }
 
 #[inline(always)]
-pub fn const_validate_mplace<'mir, 'tcx>(
+fn const_validate_mplace<'mir, 'tcx>(
     ecx: &InterpCx<'mir, 'tcx, CompileTimeInterpreter<'mir, 'tcx>>,
     mplace: &MPlaceTy<'tcx>,
     cid: GlobalId<'tcx>,
@@ -402,15 +402,17 @@ pub fn const_validate_mplace<'mir, 'tcx>(
             }
         };
         ecx.const_validate_operand(&mplace.into(), path, &mut ref_tracking, mode)
-            .map_err(|error| const_report_error(&ecx, error, alloc_id))?;
+            // Instead of just reporting the `InterpError` via the usual machinery, we give a more targetted
+            // error about the validation failure.
+            .map_err(|error| report_validation_error(&ecx, error, alloc_id))?;
         inner = true;
     }
 
     Ok(())
 }
 
 #[inline(always)]
-pub fn const_report_error<'mir, 'tcx>(
+fn report_validation_error<'mir, 'tcx>(
     ecx: &InterpCx<'mir, 'tcx, CompileTimeInterpreter<'mir, 'tcx>>,
     error: InterpErrorInfo<'tcx>,
     alloc_id: AllocId,
@@ -429,6 +431,6 @@ pub fn const_report_error<'mir, 'tcx>(
         error,
         None,
         || crate::const_eval::get_span_and_frames(ecx.tcx, ecx.stack()),
-        move |span, frames| errors::UndefinedBehavior { span, ub_note, frames, raw_bytes },
+        move |span, frames| errors::ValidationFailure { span, ub_note, frames, raw_bytes },
     )
 }
diff --git a/compiler/rustc_const_eval/src/errors.rs b/compiler/rustc_const_eval/src/errors.rs
@@ -412,11 +412,11 @@ pub struct NullaryIntrinsicError {
 }
 
 #[derive(Diagnostic)]
-#[diag(const_eval_undefined_behavior, code = E0080)]
-pub struct UndefinedBehavior {
+#[diag(const_eval_validation_failure, code = E0080)]
+pub struct ValidationFailure {
     #[primary_span]
     pub span: Span,
-    #[note(const_eval_undefined_behavior_note)]
+    #[note(const_eval_validation_failure_note)]
     pub ub_note: Option<()>,
     #[subdiagnostic]
     pub frames: Vec<FrameNote>,

Original file line number	Diff line number	Diff line change
`@@ -382,7 +382,7 @@ fn eval_in_interpreter<'tcx, R: InterpretationResult<'tcx>>(`
`382`	`382`	`}`
`383`	`383`
`384`	`384`	`#[inline(always)]`
`385`		`-pub fn const_validate_mplace<'mir, 'tcx>(`
	`385`	`+fn const_validate_mplace<'mir, 'tcx>(`
`386`	`386`	`ecx: &InterpCx<'mir, 'tcx, CompileTimeInterpreter<'mir, 'tcx>>,`
`387`	`387`	`mplace: &MPlaceTy<'tcx>,`
`388`	`388`	`cid: GlobalId<'tcx>,`
`@@ -402,15 +402,17 @@ pub fn const_validate_mplace<'mir, 'tcx>(`
`402`	`402`	`}`
`403`	`403`	`};`
`404`	`404`	`ecx.const_validate_operand(&mplace.into(), path, &mut ref_tracking, mode)`
`405`		`- .map_err(\|error\| const_report_error(&ecx, error, alloc_id))?;`
	`405`	+ // Instead of just reporting the `InterpError` via the usual machinery, we give a more targetted
	`406`	`+ // error about the validation failure.`
	`407`	`+ .map_err(\|error\| report_validation_error(&ecx, error, alloc_id))?;`
`406`	`408`	`inner = true;`
`407`	`409`	`}`
`408`	`410`
`409`	`411`	`Ok(())`
`410`	`412`	`}`
`411`	`413`
`412`	`414`	`#[inline(always)]`
`413`		`-pub fn const_report_error<'mir, 'tcx>(`
	`415`	`+fn report_validation_error<'mir, 'tcx>(`
`414`	`416`	`ecx: &InterpCx<'mir, 'tcx, CompileTimeInterpreter<'mir, 'tcx>>,`
`415`	`417`	`error: InterpErrorInfo<'tcx>,`
`416`	`418`	`alloc_id: AllocId,`
`@@ -429,6 +431,6 @@ pub fn const_report_error<'mir, 'tcx>(`
`429`	`431`	`error,`
`430`	`432`	`None,`
`431`	`433`	`\|\| crate::const_eval::get_span_and_frames(ecx.tcx, ecx.stack()),`
`432`		`- move \|span, frames\| errors::UndefinedBehavior { span, ub_note, frames, raw_bytes },`
	`434`	`+ move \|span, frames\| errors::ValidationFailure { span, ub_note, frames, raw_bytes },`
`433`	`435`	`)`
`434`	`436`	`}`