1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
// Copyright (c) The Diem Core Contributors
// SPDX-License-Identifier: Apache-2.0
#![forbid(unsafe_code)]
//! # The VM runtime
//!
//! ## Transaction flow
//!
//! This is the path taken to process a single transaction.
//!
//! ```text
//! SignedTransaction
//! +
//! |
//! +--------------------------|-------------------+
//! | Validate +--------------+--------------+ |
//! | | | |
//! | | check signature | |
//! | | | |
//! | +--------------+--------------+ |
//! | | |
//! | | |
//! | v |
//! | +--------------+--------------+ |
//! | | | |
//! | | check size and gas | |
//! | | | +---------------------------------+
//! | +--------------+--------------+ | validation error |
//! | | | |
//! | | | |
//! | v | |
//! | +--------------+--------------+ | |
//! | | | | |
//! | | run prologue | | |
//! | | | | |
//! | +--------------+--------------+ | |
//! | | | |
//! +--------------------------|-------------------+ |
//! | |
//! +--------------------------|-------------------+ |
//! | v | |
//! | Verify +--------------+--------------+ | |
//! | | | | |
//! | | deserialize script, | | |
//! | | verify arguments | | |
//! | | | | |
//! | +--------------+--------------+ | |
//! | | | |
//! | | | v
//! | v | +----------------+------+
//! | +--------------+--------------+ | | |
//! | | | +------------------->+ discard, no write set |
//! | | deserialize modules | | verification error | |
//! | | | | +----------------+------+
//! | +--------------+--------------+ | ^
//! | | | |
//! | | | |
//! | v | |
//! | +--------------+--------------+ | |
//! | | | | |
//! | | verify scripts and modules | | |
//! | | | | |
//! | +--------------+--------------+ | |
//! | | | |
//! +--------------------------|-------------------+ |
//! | |
//! +--------------------------|-------------------+ |
//! | v | |
//! | Execute +--------------+--------------+ | |
//! | | | | |
//! | | execute main | | |
//! | | | | |
//! | +--------------+--------------+ | |
//! | | | |
//! | success or failure | | |
//! | v | |
//! | +--------------+--------------+ | |
//! | | | +---------------------------------+
//! | | run epilogue | | invariant violation (internal panic)
//! | | | |
//! | +--------------+--------------+ |
//! | | |
//! | | |
//! | v |
//! | +--------------+--------------+ | +-----------------------+
//! | | | | execution failure | |
//! | | make write set +------------------------>+ keep, only charge gas |
//! | | | | | |
//! | +--------------+--------------+ | +-----------------------+
//! | | |
//! +--------------------------|-------------------+
//! |
//! v
//! +--------------+--------------+
//! | |
//! | keep, transaction executed |
//! | + gas charged |
//! | |
//! +-----------------------------+
//! ```
#[macro_use]
extern crate mirai_annotations;
mod access_path_cache;
#[macro_use]
mod counters;
pub mod data_cache;
#[cfg(feature = "mirai-contracts")]
pub mod foreign_contracts;
mod adapter_common;
mod diem_vm_impl;
mod errors;
pub mod natives;
pub mod transaction_metadata;
// pub mod diem_transaction_executor;
// pub mod diem_transaction_validator;
pub mod diem_vm;
pub mod logging;
pub mod script_to_script_function;
pub mod system_module_names;
#[cfg(test)]
mod unit_tests;
pub use crate::{diem_vm::DiemVM, diem_vm_impl::convert_changeset_and_events};
use diem_state_view::StateView;
use diem_types::{
access_path::AccessPath,
transaction::{SignedTransaction, Transaction, TransactionOutput, VMValidatorResult},
vm_status::VMStatus,
};
use move_core_types::{
account_address::AccountAddress,
language_storage::{ResourceKey, StructTag},
};
/// This trait describes the VM's validation interfaces.
pub trait VMValidator {
/// Executes the prologue of the Diem Account and verifies that the transaction is valid.
fn validate_transaction(
&self,
transaction: SignedTransaction,
state_view: &dyn StateView,
) -> VMValidatorResult;
}
/// This trait describes the VM's execution interface.
pub trait VMExecutor: Send + Sync {
// NOTE: At the moment there are no persistent caches that live past the end of a block (that's
// why execute_block doesn't take &self.)
// There are some cache invalidation issues around transactions publishing code that need to be
// sorted out before that's possible.
/// Executes a block of transactions and returns output for each one of them.
fn execute_block(
transactions: Vec<Transaction>,
state_view: &dyn StateView,
) -> Result<Vec<TransactionOutput>, VMStatus>;
}
/// Get the AccessPath to a resource stored under `address` with type name `tag`
fn create_access_path(address: AccountAddress, tag: StructTag) -> AccessPath {
let resource_tag = ResourceKey::new(address, tag);
AccessPath::resource_access_path(resource_tag)
}