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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
// Copyright 2021-2023 Protocol Labs
// SPDX-License-Identifier: Apache-2.0, MIT
use cid::Cid;
use fvm_ipld_encoding::{to_vec, CBOR};
use fvm_shared::address::Address;
use fvm_shared::econ::TokenAmount;
use fvm_shared::error::ExitCode;
use fvm_shared::upgrade::UpgradeInfo;
use fvm_shared::{ActorID, MethodNum, METHOD_CONSTRUCTOR};
use crate::engine::Engine;
use crate::gas::{Gas, GasCharge, GasTimer, GasTracker, PriceList};
use crate::kernel::{self, BlockRegistry, ClassifyResult, Context, Result};
use crate::machine::{Machine, MachineContext};
use crate::state_tree::ActorState;
use crate::Kernel;
pub mod backtrace;
mod state_access_tracker;
pub use backtrace::Backtrace;
mod default;
pub use default::DefaultCallManager;
use fvm_shared::event::StampedEvent;
use crate::trace::ExecutionTrace;
/// BlockID representing nil parameters or return data.
pub const NO_DATA_BLOCK_ID: u32 = 0;
/// The `CallManager` manages a single call stack.
///
/// When a top-level message is executed:
///
/// 1. The [`crate::executor::Executor`] creates a [`CallManager`] for that message, giving itself
/// to the [`CallManager`].
/// 2. The [`crate::executor::Executor`] calls the specified actor/entrypoint using
/// [`CallManager::call_actor()`].
/// 3. The [`CallManager`] then constructs a [`Kernel`] and executes the actual actor code on that
/// kernel.
/// 4. If an actor calls another actor, the [`Kernel`] will:
/// 1. Detach the [`CallManager`] from itself.
/// 2. Call [`CallManager::call_actor()`] to execute the new message.
/// 3. Re-attach the [`CallManager`].
/// 4. Return.
pub trait CallManager: 'static {
/// The underlying [`Machine`] on top of which this [`CallManager`] executes.
type Machine: Machine;
/// Construct a new call manager.
#[allow(clippy::too_many_arguments)]
fn new(
machine: Self::Machine,
engine: Engine,
gas_limit: u64,
origin: ActorID,
origin_address: Address,
receiver: Option<ActorID>,
receiver_address: Address,
nonce: u64,
gas_premium: TokenAmount,
) -> Self;
/// Calls an actor at the given address and entrypoint. The type parameter `K` specifies the the _kernel_ on top of which the target
/// actor should execute.
#[allow(clippy::too_many_arguments)]
fn call_actor<K: Kernel<CallManager = Self>>(
&mut self,
from: ActorID,
to: Address,
entrypoint: Entrypoint,
params: Option<kernel::Block>,
value: &TokenAmount,
gas_limit: Option<Gas>,
read_only: bool,
) -> Result<InvocationResult>;
/// Execute some operation (usually a call_actor) within a transaction.
fn with_transaction(
&mut self,
f: impl FnOnce(&mut Self) -> Result<InvocationResult>,
) -> Result<InvocationResult>;
/// Finishes execution, returning the gas used, machine, and exec trace if requested.
fn finish(self) -> (Result<FinishRet>, Self::Machine);
/// Returns a reference to the machine.
fn machine(&self) -> &Self::Machine;
/// Returns a mutable reference to the machine.
fn machine_mut(&mut self) -> &mut Self::Machine;
/// Returns a reference to the engine
fn engine(&self) -> &Engine;
/// Returns a reference to the gas tracker.
fn gas_tracker(&self) -> &GasTracker;
/// Returns the gas premium paid by the currently executing message.
fn gas_premium(&self) -> &TokenAmount;
/// Getter for origin actor.
fn origin(&self) -> ActorID;
/// Get the actor address (f2) that will should be assigned to the next actor created.
///
/// This method doesn't have any side-effects and will continue to return the same address until
/// `create_actor` is called next.
fn next_actor_address(&self) -> Address;
/// Create a new actor with the given code CID, actor ID, and delegated address. This method
/// does not register the actor with the init actor. It just creates it in the state-tree.
///
/// It handles all appropriate gas charging for creating new actors.
fn create_actor(
&mut self,
code_id: Cid,
actor_id: ActorID,
delegated_address: Option<Address>,
) -> Result<()>;
// returns the actor call stack
fn get_call_stack(&self) -> &[(ActorID, &'static str)];
/// Resolve an address into an actor ID, charging gas as appropriate.
fn resolve_address(&self, address: &Address) -> Result<Option<ActorID>>;
/// Sets an actor in the state-tree, charging gas as appropriate. Use `create_actor` if you want
/// to create a new actor.
fn set_actor(&mut self, id: ActorID, state: ActorState) -> Result<()>;
/// Looks up an actor in the state-tree, charging gas as appropriate.
fn get_actor(&self, id: ActorID) -> Result<Option<ActorState>>;
/// Deletes an actor from the state-tree, charging gas as appropriate.
fn delete_actor(&mut self, id: ActorID) -> Result<()>;
/// Transfers tokens from one actor to another, charging gas as appropriate.
fn transfer(&mut self, from: ActorID, to: ActorID, value: &TokenAmount) -> Result<()>;
/// Getter for message nonce.
fn nonce(&self) -> u64;
/// Gets the total invocations done on this call stack.
fn invocation_count(&self) -> u64;
/// Returns the current price list.
fn price_list(&self) -> &PriceList {
self.machine().context().price_list
}
/// Returns the machine context.
fn context(&self) -> &MachineContext {
self.machine().context()
}
/// Returns the blockstore.
fn blockstore(&self) -> &<Self::Machine as Machine>::Blockstore {
self.machine().blockstore()
}
/// Returns the externs.
fn externs(&self) -> &<Self::Machine as Machine>::Externs {
self.machine().externs()
}
/// Charge gas.
fn charge_gas(&self, charge: GasCharge) -> Result<GasTimer> {
self.gas_tracker().apply_charge(charge)
}
/// Limit memory usage throughout a message execution.
fn limiter_mut(&mut self) -> &mut <Self::Machine as Machine>::Limiter;
/// Appends an event to the event accumulator.
fn append_event(&mut self, evt: StampedEvent);
}
/// The result of calling actor's entrypoint
#[derive(Clone, Debug)]
pub struct InvocationResult {
/// The exit code (0 for success).
pub exit_code: ExitCode,
/// The return value, if any.
pub value: Option<kernel::Block>,
}
impl Default for InvocationResult {
fn default() -> Self {
Self {
value: None,
exit_code: ExitCode::OK,
}
}
}
/// The returned values upon finishing a call manager.
pub struct FinishRet {
pub gas_used: u64,
pub backtrace: Backtrace,
pub exec_trace: ExecutionTrace,
pub events: Vec<StampedEvent>,
pub events_root: Option<Cid>,
}
#[derive(Clone, Debug, Copy)]
pub enum Entrypoint {
/// Implicitly invoke a constructor. We keep this separate for better tracing.
ImplicitConstructor,
/// Invoke a method.
Invoke(MethodNum),
/// Upgrade to a new actor code CID.
Upgrade(UpgradeInfo),
}
pub static INVOKE_FUNC_NAME: &str = "invoke";
pub static UPGRADE_FUNC_NAME: &str = "upgrade";
const METHOD_UPGRADE: MethodNum = 932083;
impl std::fmt::Display for Entrypoint {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Entrypoint::ImplicitConstructor => write!(f, "implicit_constructor"),
Entrypoint::Invoke(method) => write!(f, "invoke({})", method),
Entrypoint::Upgrade(_) => write!(f, "upgrade"),
}
}
}
impl Entrypoint {
fn method_num(&self) -> MethodNum {
match self {
Entrypoint::ImplicitConstructor => METHOD_CONSTRUCTOR,
Entrypoint::Invoke(num) => *num,
Entrypoint::Upgrade(_) => METHOD_UPGRADE,
}
}
fn func_name(&self) -> &'static str {
match self {
Entrypoint::ImplicitConstructor | Entrypoint::Invoke(_) => INVOKE_FUNC_NAME,
Entrypoint::Upgrade(_) => UPGRADE_FUNC_NAME,
}
}
fn invokes(&self, method: MethodNum) -> bool {
match self {
Entrypoint::ImplicitConstructor => method == METHOD_CONSTRUCTOR,
Entrypoint::Invoke(num) => *num == method,
Entrypoint::Upgrade(_) => false,
}
}
fn into_params(self, br: &mut BlockRegistry) -> Result<Vec<wasmtime::Val>> {
match self {
Entrypoint::ImplicitConstructor | Entrypoint::Invoke(_) => Ok(Vec::new()),
Entrypoint::Upgrade(ui) => {
let ui_params = to_vec(&ui)
.or_fatal()
.context("failed to serialize upgrade params")?;
// This is CBOR instead of DAG_CBOR because these params are not reachable
let block_id = br.put_reachable(kernel::Block::new(CBOR, ui_params, Vec::new()))?;
Ok(vec![wasmtime::Val::I32(block_id as i32)])
}
}
}
}