[vm] New bytecode for aborting with message (#18347)

* [vm] New VM instruction for aborting with message

* Fix hashing

* Add type checks for Abort/AbortMsg

* Add comment

* Do not change `ExecutionStatus`

* Revert changes

* Cursor feedback

* Fix formatting

* Fix macro

* Return error on message type mismatch

* Include abort message in prologue/epilogue for debugging

* [vm] New bytecode for aborting with message

* Cursor feedback

* Rustfmt

* More cursor feedback

* More places to handle `AbortMsg` variant

* Feature gate abort messages

* Use feature flag to enable abort messages in VM

* Add comment

* Replace `&vector<u8>` with `vector<u8>`

* Replace `&vector<u8>` with `vector<u8>`

* Fix error for invalid abort messages

* Combine `Abort` and `AbortMsg` in stackless buytecode

* Wolfgang feedback

* George feedback

* Add test for invalid message

* Charge gas per byte

* Clippy

* Add to default features

* Update tests

* Fix gas profiler

* Simplify gas model

* Fix sourcifier

* Cap length of abort message

* Update limit

* Update abort_msg_per_byte

Author: calintat

aptos-move/aptos-gas-meter/src/meter.rs

@@ -547,6 +547,12 @@ where
 
         self.algebra.charge_execution(cost)
     }
+
+    fn charge_abort_message(&mut self, bytes: &[u8]) -> PartialVMResult<()> {
+        let num_bytes = NumBytes::new(bytes.len() as u64);
+        let cost = ABORT_MSG_BASE + ABORT_MSG_PER_BYTE * num_bytes;
+        self.algebra.charge_execution(cost)
+    }
 }
 
 impl<A> AptosGasMeter for StandardGasMeter<A>

aptos-move/aptos-gas-profiling/src/profiler.rs

@@ -367,6 +367,9 @@ where
 
         [VEC_SWAP]
         fn charge_vec_swap(&mut self) -> PartialVMResult<()>;
+
+        [ABORT_MSG]
+        fn charge_abort_message(&mut self, bytes: &[u8]) -> PartialVMResult<()>;
     }
 
     fn balance_internal(&self) -> InternalGas {

aptos-move/aptos-gas-schedule/src/gas_schedule/instr.rs

@@ -4,7 +4,7 @@
 //! This module defines the gas parameters for all Move instructions.
 
 use crate::{
-    gas_feature_versions::{RELEASE_V1_18, RELEASE_V1_33, RELEASE_V1_38},
+    gas_feature_versions::{RELEASE_V1_18, RELEASE_V1_33, RELEASE_V1_38, RELEASE_V1_40},
     gas_schedule::VMGasParameters,
 };
 use aptos_gas_algebra::{
@@ -22,6 +22,8 @@ crate::gas_schedule::macros::define_gas_parameters!(
         // control flow
         [ret: InternalGas, "ret", 220],
         [abort: InternalGas, "abort", 220],
+        [abort_msg_base: InternalGas, { RELEASE_V1_40.. => "abort_msg.base" }, 440],
+        [abort_msg_per_byte: InternalGasPerByte, { RELEASE_V1_40.. => "abort_msg.per_byte" }, 45],
 
         // Note(Gas): The costs of the branch instructions have been jacked up a bit intentionally
         //            to prevent any single transaction from running for too long.

aptos-move/aptos-memory-usage-tracker/src/lib.rs

@@ -343,6 +343,17 @@ where
             .charge_native_function_before_execution(ty_args, args)
     }
 
+    fn charge_abort_message(&mut self, bytes: &[u8]) -> PartialVMResult<()> {
+        self.release_heap_memory(
+            self.vm_gas_params()
+                .misc
+                .abs_val
+                .abstract_heap_size(bytes, self.feature_version())?,
+        );
+
+        self.base.charge_abort_message(bytes)
+    }
+
     #[inline]
     fn charge_native_function(
         &mut self,

aptos-move/aptos-release-builder/src/components/feature_flags.rs

@@ -157,6 +157,7 @@ pub enum FeatureFlag {
     EnableFrameworkForOption,
     SessionContinuation,
     EnableFunctionReflection,
+    VMBinaryFormatV10,
 }
 
 fn generate_features_blob(writer: &CodeWriter, data: &[u64]) {
@@ -413,6 +414,7 @@ impl From<FeatureFlag> for AptosFeatureFlag {
             FeatureFlag::EnableFrameworkForOption => AptosFeatureFlag::ENABLE_FRAMEWORK_FOR_OPTION,
             FeatureFlag::SessionContinuation => AptosFeatureFlag::SESSION_CONTINUATION,
             FeatureFlag::EnableFunctionReflection => AptosFeatureFlag::ENABLE_FUNCTION_REFLECTION,
+            FeatureFlag::VMBinaryFormatV10 => AptosFeatureFlag::VM_BINARY_FORMAT_V10,
         }
     }
 }
@@ -596,6 +598,7 @@ impl From<AptosFeatureFlag> for FeatureFlag {
             AptosFeatureFlag::ENABLE_FRAMEWORK_FOR_OPTION => FeatureFlag::EnableFrameworkForOption,
             AptosFeatureFlag::SESSION_CONTINUATION => FeatureFlag::SessionContinuation,
             AptosFeatureFlag::ENABLE_FUNCTION_REFLECTION => FeatureFlag::EnableFunctionReflection,
+            AptosFeatureFlag::VM_BINARY_FORMAT_V10 => FeatureFlag::VMBinaryFormatV10,
         }
     }
 }

aptos-move/aptos-transactional-test-harness/tests/aptos_test_harness/diamond_clicker.exp

@@ -1,6 +1,6 @@
 processed 4 tasks
 task 1 lines 4-35:  print-bytecode --input=module [module Alice::game {]
-// Bytecode version v9
+// Bytecode version v10
 module 0xf75daa73fc071f93593335eb9033da804777eb94491650dd3f095ce6f778acb6::game
 use 0x1::signer
 use 0x1::debug

aptos-move/aptos-vm/src/verifier/event_validation.rs

@@ -235,6 +235,7 @@ pub(crate) fn validate_emit_calls(
                     | Le
                     | Ge
                     | Abort
+                    | AbortMsg
                     | Nop
                     | ImmBorrowVariantField(_)
                     | ImmBorrowVariantFieldGeneric(_)

third_party/move/move-binary-format/src/check_bounds.rs

@@ -673,8 +673,8 @@ impl<'a> BoundsChecker<'a> {
                 | LdI8(_) | LdI16(_) | LdI32(_) | LdI64(_) | LdI256(_) | LdI128(_) | CastI8
                 | CastI16 | CastI32 | CastI64 | CastI128 | CastI256 | LdTrue | LdFalse
                 | ReadRef | WriteRef | Add | Sub | Mul | Mod | Div | Negate | BitOr | BitAnd
-                | Xor | Shl | Shr | Or | And | Not | Eq | Neq | Lt | Gt | Le | Ge | Abort | Nop => {
-                },
+                | Xor | Shl | Shr | Or | And | Not | Eq | Neq | Lt | Gt | Le | Ge | Abort
+                | AbortMsg | Nop => {},
             }
         }
         Ok(())

third_party/move/move-binary-format/src/check_complexity.rs

@@ -376,6 +376,7 @@ impl BinaryComplexityMeter<'_> {
                 | MoveTo(_)
                 | MoveFrom(_)
                 | Abort
+                | AbortMsg
                 | Nop => (),
             }
         }

third_party/move/move-binary-format/src/deserializer.rs

@@ -1831,6 +1831,14 @@ fn load_code(cursor: &mut VersionedCursor, code: &mut Vec<Bytecode>) -> BinaryLo
                     )),
                 );
             },
+            Opcodes::ABORT_MSG if cursor.version() < VERSION_10 => {
+                return Err(
+                    PartialVMError::new(StatusCode::MALFORMED).with_message(format!(
+                        "aborting with message not available before bytecode version {}",
+                        VERSION_10
+                    )),
+                );
+            },
             _ => {},
         };
 
@@ -1943,6 +1951,7 @@ fn load_code(cursor: &mut VersionedCursor, code: &mut Vec<Bytecode>) -> BinaryLo
             Opcodes::LE => Bytecode::Le,
             Opcodes::GE => Bytecode::Ge,
             Opcodes::ABORT => Bytecode::Abort,
+            Opcodes::ABORT_MSG => Bytecode::AbortMsg,
             Opcodes::NOP => Bytecode::Nop,
             Opcodes::EXISTS => Bytecode::Exists(load_struct_def_index(cursor)?),
             Opcodes::EXISTS_GENERIC => Bytecode::ExistsGeneric(load_struct_def_inst_index(cursor)?),
@@ -2226,6 +2235,8 @@ impl Opcodes {
             0x65 => Ok(Opcodes::CAST_I128),
             0x66 => Ok(Opcodes::CAST_I256),
             0x67 => Ok(Opcodes::NEGATE),
+            // Since bytecode version 10
+            0x68 => Ok(Opcodes::ABORT_MSG),
             _ => Err(PartialVMError::new(StatusCode::UNKNOWN_OPCODE)
                 .with_message(format!("code {:X}", value))),
         }