refactor: expand error location into metadata (#174)

## What ❔

Instead of including error location directly, includes it as a part of
otherwise empty error metadata. Prepares for inclusion of error contexts
in the next PR.

## Why ❔

<!-- Why are these changes done? What goal do they contribute to? What
are the principles behind them? -->
<!-- The `Why` has to be clear to non-Matter Labs entities running their
own ZK Chain -->
<!-- Example: PR templates ensure PR reviewers, observers, and future
iterators are in context about the evolution of repos. -->

## Is this a breaking change?
- [ ] Yes
- [x] No

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [x] Documentation comments have been added / updated.
- [x] Code has been formatted.

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Vladislav Volosnikov <Volosnikov.apmath@gmail.com>

Author: 3 people

basic_bootloader/src/bootloader/runner.rs

@@ -453,7 +453,7 @@ impl<'external, S: EthereumLikeTypes> Run<'_, 'external, S> {
                             }
                         }
                         SubsystemError::LeafDefect(_) => return Err(wrap_error!(e)),
-                        SubsystemError::LeafRuntime(runtime_error) => match runtime_error {
+                        SubsystemError::LeafRuntime(ref runtime_error) => match runtime_error {
                             RuntimeError::OutOfNativeResources(_) => return Err(wrap_error!(e)),
                             RuntimeError::OutOfErgs(_) => {
                                 return Err(internal_error!("Out of ergs on infinite ergs").into())

evm_interpreter/src/ee_trait_impl.rs

@@ -13,6 +13,7 @@ use zk_ee::system::errors::runtime::RuntimeError;
 use zk_ee::system::errors::subsystem::SubsystemError;
 use zk_ee::system::*;
 use zk_ee::types_config::SystemIOTypesConfig;
+use zk_ee::utils::cheap_clone::CheapCloneRiscV;
 use zk_ee::utils::{b160_to_u256, Bytes32};
 use zk_ee::{interface_error, internal_error, wrap_error};
 
@@ -434,7 +435,7 @@ impl<'ee, S: EthereumLikeTypes> ExecutionEnvironment<'ee, S, EvmErrors> for Inte
                     .map_err(|e| -> EvmSubsystemError {
                         match e.root_cause() {
                             RootCause::Runtime(e @ RuntimeError::OutOfNativeResources(_)) => {
-                                (*e).into()
+                                e.clone_or_copy().into()
                             }
                             _ => internal_error!("Keccak in create2 cannot fail").into(),
                         }

system_hooks/src/precompiles.rs

@@ -26,6 +26,7 @@ use zk_ee::{
         },
         CallModifier, Resources, System,
     },
+    utils::cheap_clone::CheapCloneRiscV as _,
 };
 
 ///
@@ -85,7 +86,7 @@ where
                 Ok((make_error_return_state(resources), rest))
             }
             RootCause::Runtime(e @ RuntimeError::OutOfNativeResources(_)) => {
-                Err(Into::<SystemError>::into(*e))
+                Err(Into::<SystemError>::into(e.clone_or_copy()))
             }
         },
     }

zk_ee/src/lib.rs

@@ -27,6 +27,14 @@
 #![allow(clippy::len_without_is_empty)]
 #![allow(clippy::needless_return)]
 #![allow(clippy::wrong_self_convention)]
+#![cfg_attr(
+    any(feature = "error_origins", not(target_arch = "riscv32")),
+    allow(clippy::result_large_err)
+)]
+#![cfg_attr(
+    any(feature = "error_origins", not(target_arch = "riscv32")),
+    allow(clippy::large_enum_variant)
+)]
 
 extern crate alloc;
 

zk_ee/src/system/errors/interface.rs

@@ -1,16 +1,20 @@
-use super::location::{ErrorLocation, Localizable};
+use super::{
+    location::{ErrorLocation, Localizable},
+    metadata::Metadata,
+};
 
 pub trait InterfaceErrorKind: Clone + core::fmt::Debug + Eq + Sized + Into<&'static str> {
     fn get_name(&self) -> &'static str;
 }
 
-#[derive(Debug, PartialEq, Eq, Clone, Copy)]
-pub struct InterfaceError<T: InterfaceErrorKind>(pub T, pub ErrorLocation);
+#[derive(Debug, PartialEq, Eq, Clone)]
+pub struct InterfaceError<T: InterfaceErrorKind>(pub T, pub Metadata);
 
 #[macro_export]
 macro_rules! interface_error {
     ($instance:expr) => {
-        $crate::system::errors::interface::InterfaceError($instance, $crate::location!()).into()
+        $crate::system::errors::interface::InterfaceError($instance, $crate::location!().into())
+            .into()
     };
 }
 
@@ -19,7 +23,7 @@ pub struct AsInterfaceError<E>(pub E);
 
 impl<T: InterfaceErrorKind> Localizable for InterfaceError<T> {
     fn get_location(&self) -> ErrorLocation {
-        let InterfaceError(_, location) = self;
-        *location
+        let InterfaceError(_, meta) = self;
+        meta.location
     }
 }

zk_ee/src/system/errors/internal.rs

@@ -1,22 +1,26 @@
-use super::location::{ErrorLocation, Localizable};
+use super::{
+    location::{ErrorLocation, Localizable},
+    metadata::Metadata,
+};
 
 ///
 /// Internal error, should not be triggered by user input.
 /// Do not construct it explicitly; instead, use the macro [`internal_error`].
 ///
-#[derive(Debug, PartialEq, Eq, Clone, Copy)]
-pub struct InternalError(pub &'static str, pub ErrorLocation);
+#[cfg_attr(target_arch = "riscv32", derive(Copy))]
+#[derive(Debug, PartialEq, Eq, Clone)]
+pub struct InternalError(pub &'static str, pub Metadata);
 
 #[macro_export]
 macro_rules! internal_error {
     ($msg:expr $(,)?) => {
-        $crate::system::errors::internal::InternalError($msg, $crate::location!())
+        $crate::system::errors::internal::InternalError($msg, $crate::location!().into())
     };
 }
 
 impl Localizable for InternalError {
     fn get_location(&self) -> ErrorLocation {
-        let InternalError(_, location) = self;
-        *location
+        let InternalError(_, meta) = self;
+        meta.location
     }
 }

zk_ee/src/system/errors/metadata.rs

@@ -0,0 +1,27 @@
+use super::location::ErrorLocation;
+
+#[cfg_attr(target_arch = "riscv32", derive(Copy))]
+#[derive(Debug, PartialEq, Eq, Clone)]
+pub struct Metadata {
+    pub location: ErrorLocation,
+}
+
+impl Metadata {
+    pub fn new(location: ErrorLocation) -> Self {
+        Self { location }
+    }
+}
+
+impl From<ErrorLocation> for Metadata {
+    fn from(location: ErrorLocation) -> Self {
+        Self::new(location)
+    }
+}
+
+impl core::fmt::Display for Metadata {
+    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+        let Self { location } = self;
+        writeln!(f, "-- at {location}")?;
+        Ok(())
+    }
+}

zk_ee/src/system/errors/mod.rs

@@ -3,6 +3,7 @@ pub mod display;
 pub mod interface;
 pub mod internal;
 pub mod location;
+pub mod metadata;
 pub mod no_errors;
 pub mod root_cause;
 pub mod runtime;

zk_ee/src/system/errors/runtime.rs

@@ -1,16 +1,29 @@
 use strum_macros::IntoStaticStr;
 
-use super::location::ErrorLocation;
+use super::location::{ErrorLocation, Localizable};
+use super::metadata::Metadata;
 
-#[derive(Copy, Clone, Debug, PartialEq, Eq, IntoStaticStr)]
+#[cfg_attr(target_arch = "riscv32", derive(Copy))]
+#[derive(Clone, Debug, PartialEq, Eq, IntoStaticStr)]
 pub enum RuntimeError {
-    OutOfNativeResources(ErrorLocation),
-    OutOfErgs(ErrorLocation),
+    OutOfNativeResources(Metadata),
+    OutOfErgs(Metadata),
 }
 
 #[macro_export]
 macro_rules! out_of_native_resources {
     () => {
-        $crate::system::errors::runtime::RuntimeError::OutOfNativeResources($crate::location!())
+        $crate::system::errors::runtime::RuntimeError::OutOfNativeResources(
+            $crate::location!().into(),
+        )
     };
 }
+impl Localizable for RuntimeError {
+    fn get_location(&self) -> ErrorLocation {
+        match self {
+            RuntimeError::OutOfNativeResources(metadata) | RuntimeError::OutOfErgs(metadata) => {
+                metadata.location
+            }
+        }
+    }
+}

zk_ee/src/system/errors/system.rs

@@ -5,7 +5,8 @@ use super::{
     subsystem::{Subsystem, SubsystemError},
 };
 
-#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+#[cfg_attr(target_arch = "riscv32", derive(Copy))]
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub enum SystemError {
     LeafDefect(InternalError),
     LeafRuntime(RuntimeError),
@@ -50,9 +51,7 @@ where
 macro_rules! out_of_ergs_error {
     () => {
         $crate::system::errors::system::SystemError::LeafRuntime(
-            $crate::system::errors::runtime::RuntimeError::OutOfErgs(
-                $crate::system::errors::location::ErrorLocation::new(file!(), line!()),
-            ),
+            $crate::system::errors::runtime::RuntimeError::OutOfErgs($crate::location!().into()),
         )
     };
 }