Skip to content

Commit

Permalink
[docs] Update AptosVM readme (#15251)
Browse files Browse the repository at this point in the history
  • Loading branch information
georgemitenkov authored Nov 13, 2024
1 parent 1099aec commit d6cbb07
Showing 1 changed file with 35 additions and 101 deletions.
136 changes: 35 additions & 101 deletions aptos-move/aptos-vm/README.md
Original file line number Diff line number Diff line change
@@ -1,101 +1,35 @@
---
id: vm-runtime
title: MoveVM Runtime
custom_edit_url: https://github.com/aptos-labs/aptos-core/edit/main/language/move-binary-format/vm-runtime/README.md
---

# MoveVM Runtime

The MoveVM runtime is the verification and execution engine for the Move
bytecode format. The runtime is imported and loaded in 2 modes:
verification mode (by the [admission control](../../admission_control)
and [mempool](../../mempool) components) and execution mode (by the
[execution](../../execution) component).

## Overview

The MoveVM runtime is a stack machine. The VM runtime receives as input a
*block* which is a list of *transaction scripts* and a *data view*. The
data view is a **read only** snapshot of the data and code in the blockchain at
a given version (i.e., block height). At the time of startup, the runtime
does not have any code or data loaded. It is effectively *“empty”*.

Every transaction executes within the context of a [Aptos
account](../framework/modules/diem_account.mvir)---specifically the transaction
submitter's account. The execution of every transaction consists of three
parts: the account prologue, the transaction itself, and the account
epilogue. This is the only transaction flow known to the runtime, and it is
the only flow the runtime executes. The runtime is responsible to load the
individual transaction from the block and execute the transaction flow:

1. ***Transaction Prologue*** - in verification mode the runtime runs the
bytecode verifier over the transaction script and executes the
prologue defined in the [Aptos account
module](../framework/modules/diem_account.mvir). The prologue is responsible
for checking the structure of the transaction and
rejecting obviously bad transactions. In verification mode, the runtime
returns a status of either `success` or `failure` depending upon the
result of running the prologue. No updates to the blockchain state are
ever performed by the prologue.
2. ***Transaction Execution*** - in execution mode, and after verification,
the runtime starts executing transaction-specific/client code. A typical
code performs updates to data in the blockchain. Execution of the
transaction by the VM runtime produces a write set that acts as an
atomic state change from the current state of the blockchain---received
via the data view---to a new version that is the result of applying the
write set. Importantly, on-chain data is _never_ changed during the
execution of the transaction. Further, while the write set is produced as the
result of executing the bytecode, the changes are not applied to the global
blockchain state by the VM---this is the responsibility of the
[execution module](../../../execution/).
3. ***Transaction Epilogue*** - in execution mode the epilogue defined in
the [Aptos account module](../framework/modules/diem_account.mvir) is
executed to perform actions based upon the result of the execution of
the user-submitted transaction. One example of such an action is
debiting the gas fee for the transaction from the submitting account's
balance.

During execution, the runtime resolves references to code by loading the
referenced code via the data view. One can think of this process as similar
to linking. Then, within the context of a block of transactions---a list of
transactions coupled with a data view---the runtime caches code and
linked and imported modules across transactions within the block.
The runtime tracks state changes (data updates) from one transaction
to the next within each block of transactions; the semantics of the
execution of a block specify that transactions are sequentially executed
and, as a consequence, state changes of previous transactions must be
visible to subsequent transactions within each block.

## Implementation Details

* The runtime top level structs are in `runtime` and `diem vm` related
code.
* The transaction flow is implemented in the [`process_txn`](./src/process_txn.rs)
module.
* Code caching logic and policies are defined under the [code
cache](../../move-vm/runtime/src/code_cache/) directory.
* Runtime loaded code and the type system view for the runtime is defined
under the [loaded data](src/loaded_data/) directory.
* The data representation of values, and logic for write set generation can
be found under the [value](./src/value.rs) and [data
cache](./src/data_cache.rs) files.

## Folder Structure

```
.
├── src # VM Runtime files
│   ├── code_cache # VM Runtime code cache
│   ├── loaded_data # VM Runtime loaded data types, runtime caches over code
│   ├── unit_tests # unit tests
├── vm-cache-map # abstractions for the code cache
```

## This Module Interacts With

This crate is mainly used in two parts: AC and mempool use it to determine
if it should accept a transaction or not; the Executor runs the MoveVM
runtime to execute the program field in a SignedTransaction and convert
it into a TransactionOutput, which contains a writeset that the
executor need to patch to the blockchain as a side effect of this
transaction.
### AptosVM

AptosVM is used to execute a single Aptos transaction.
Executes both system and user transactions.
For every user transaction, the following steps are performed:

1. ***Prologue:***
Responsible for checking the structure of the transaction such as signature verification, balance checks on the account paying gas for this transaction, etc.
If prologue checks fail, transaction is discarded and there are no updates to the blockchain state.

2. **Execution:**
Runs the code specified by the transaction - can be a script or an entry function.
If transaction payload is a script, it is verified with Move bytecode verifier prior to execution.
If the payload is an entry function, it is loaded from the code cache (which guarantees that loaded code is verified).
When the code is verified and loaded, transaction arguments are checked and then the payload is executed via MoveVM that AptosVM wraps.
If execution is successful, a change set that can be (but is not yet) applied to the blockchain state is produced.
3. **Aborted execution:**
If execution is not successful, AptosVM checks if an account needs to be created for this user transaction.
For more details about sponsored account creation, see [AIP-52](https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-52.md).
4. **Epilogue:**
Post-processing of user transaction, used primarily to charge gas.
The post-processing runs on top of the blockchain state with the temporary changes made by executing the user code.
If transaction runs out of gas, the epilogue runs again but on the clean state.
In the end, the final change set is created, which includes writes created during **Execution**, as well as writes
created during the epilogue.

### AptosSimulationVM

Used to simulate transactions before executing them on a real network.
Implementation-wise, wraps AptosVM with some minor modifications for multi-signature transactions.

### AptosVMBlockExecutor

Used to execute a block of signature-verified transactions.
Based on the desired concurrency, can run the block sequentially or in parallel (via Block-STM).

0 comments on commit d6cbb07

Please sign in to comment.