Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CLI for measuring execution time and cost #1628

Merged
merged 5 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 158 additions & 0 deletions simulator/src/replay/cmd_measure.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
use super::ledger_transaction_execution::*;
use super::txn_reader::TxnReader;
use super::Error;
use crate::replay::ledger_transaction::PreparedLedgerTransactionInner;
use clap::Parser;
use flate2::read::GzDecoder;
use flume;
use radix_engine::types::*;
use radix_engine::vm::wasm::*;
use radix_engine::vm::ScryptoVm;
use radix_engine_interface::prelude::NetworkDefinition;
use radix_engine_store_interface::db_key_mapper::SpreadPrefixKeyMapper;
use radix_engine_store_interface::interface::CommittableSubstateDatabase;
use radix_engine_stores::rocks_db_with_merkle_tree::RocksDBWithMerkleTreeSubstateStore;
use std::fs::File;
use std::fs::OpenOptions;
use std::io::prelude::*;
use std::path::PathBuf;
use std::thread;
use std::time::Duration;
use tar::Archive;
use transaction::prelude::IntentHash;
use transaction::prelude::TransactionHashBech32Encoder;

/// Run transactions in archive, using RocksDB
#[derive(Parser, Debug)]
pub struct TxnMeasure {
/// The transaction file, in `.tar.gz` format, with entries sorted
pub source: PathBuf,
/// Path to a folder for storing state
pub database_dir: PathBuf,
/// Path to the output file
pub output_file: PathBuf,

/// The network to use, [mainnet | stokenet]
#[clap(short, long)]
pub network: Option<String>,
/// The max version to execute
#[clap(short, long)]
pub max_version: Option<u64>,
}

impl TxnMeasure {
pub fn run(&self) -> Result<(), Error> {
let network = match &self.network {
Some(n) => NetworkDefinition::from_str(n).map_err(Error::ParseNetworkError)?,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NetworkDefinition::from_str() doesn't have stokenet as in comment above, also maybe there should be additional validation only for miannet or stokenet?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me add stokenet to NetworkDefinition since it's so commonly used.

None => NetworkDefinition::mainnet(),
};

let cur_version = {
let database = RocksDBWithMerkleTreeSubstateStore::standard(self.database_dir.clone());
let cur_version = database.get_current_version();
if cur_version >= self.max_version.unwrap_or(u64::MAX) {
return Ok(());
}
cur_version
};
let to_version = self.max_version.clone();

let start = std::time::Instant::now();
let (tx, rx) = flume::bounded(10);

// txn reader
let mut txn_reader = if self.source.is_file() {
let tar_gz = File::open(&self.source).map_err(Error::IOError)?;
let tar = GzDecoder::new(tar_gz);
let archive = Archive::new(tar);
TxnReader::TransactionFile(archive)
} else if self.source.is_dir() {
TxnReader::StateManagerDatabaseDir(self.source.clone())
} else {
return Err(Error::InvalidTransactionSource);
};
let txn_read_thread_handle =
thread::spawn(move || txn_reader.read(cur_version, to_version, tx));

// txn executor
let mut database = RocksDBWithMerkleTreeSubstateStore::standard(self.database_dir.clone());
let exists = self.output_file.exists();
let mut output = OpenOptions::new()
.write(true)
.append(true)
.create(true)
.open(&self.output_file)
.map_err(Error::IOError)?;
if !exists {
writeln!(output, "TXID,Processing Time,Cost Units,Cost XRD",)
.map_err(Error::IOError)?;
}

let txn_write_thread_handle = thread::spawn(move || {
let scrypto_vm = ScryptoVm::<DefaultWasmEngine>::default();
let iter = rx.iter();
for tx_payload in iter {
let tx_start_time = std::time::Instant::now();
let prepared = prepare_ledger_transaction(&tx_payload);
let receipt = execute_prepared_ledger_transaction(
&database,
&scrypto_vm,
&network,
&prepared,
);
let execution_finalization_cost_units = receipt.fee_summary().map(|x| {
x.total_execution_cost_units_consumed + x.total_finalization_cost_units_consumed
});
let execution_finalization_cost_xrd = receipt
.fee_summary()
.map(|x| x.total_execution_cost_in_xrd + x.total_finalization_cost_in_xrd);
let database_updates = receipt
.into_state_updates()
.create_database_updates::<SpreadPrefixKeyMapper>();
database.commit(&database_updates);
let tx_processing_time = tx_start_time.elapsed();
if let PreparedLedgerTransactionInner::UserV1(tx) = prepared.inner {
writeln!(
output,
"{},{},{},{}",
TransactionHashBech32Encoder::new(&network)
.encode(&IntentHash(tx.signed_intent.intent.summary.hash))
.unwrap(),
tx_processing_time.as_micros(),
execution_finalization_cost_units.unwrap(),
execution_finalization_cost_xrd.unwrap(),
)
.map_err(Error::IOError)?;
}

let new_state_root_hash = database.get_current_root_hash();
let new_version = database.get_current_version();

if new_version < 1000 || new_version % 1000 == 0 {
print_progress(start.elapsed(), new_version, new_state_root_hash);
}
}

let duration = start.elapsed();
println!("Time elapsed: {:?}", duration);
println!("State version: {}", database.get_current_version());
println!("State root hash: {}", database.get_current_root_hash());
Ok::<(), Error>(())
});

txn_read_thread_handle.join().unwrap()?;
txn_write_thread_handle.join().unwrap()?;

Ok(())
}
}

fn print_progress(duration: Duration, new_version: u64, new_root: Hash) {
let seconds = duration.as_secs() % 60;
let minutes = (duration.as_secs() / 60) % 60;
let hours = (duration.as_secs() / 60) / 60;
println!(
"New version: {}, {}, {:0>2}:{:0>2}:{:0>2}",
new_version, new_root, hours, minutes, seconds
);
}
51 changes: 46 additions & 5 deletions simulator/src/replay/ledger_transaction_execution.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
use super::ledger_transaction::*;
use radix_engine::system::bootstrap::*;
use radix_engine::track::StateUpdates;
use radix_engine::transaction::{execute_transaction, CostingParameters, ExecutionConfig};
use radix_engine::transaction::{
execute_transaction, CostingParameters, ExecutionConfig, TransactionFeeSummary,
TransactionReceipt,
};
use radix_engine::types::*;
use radix_engine::vm::wasm::*;
use radix_engine::vm::{DefaultNativeVm, ScryptoVm, Vm};
Expand All @@ -12,23 +15,61 @@ use transaction::validation::{
NotarizedTransactionValidator, TransactionValidator, ValidationConfig,
};

pub enum LedgerTransactionReceipt {
Flash(FlashReceipt),
Standard(TransactionReceipt),
}

impl LedgerTransactionReceipt {
pub fn into_state_updates(self) -> StateUpdates {
match self {
LedgerTransactionReceipt::Flash(receipt) => receipt.state_updates,
LedgerTransactionReceipt::Standard(receipt) => {
receipt.into_commit_ignore_outcome().state_updates
}
}
}

pub fn fee_summary(&self) -> Option<&TransactionFeeSummary> {
match self {
LedgerTransactionReceipt::Flash(_) => None,
LedgerTransactionReceipt::Standard(receipt) => Some(&receipt.fee_summary),
}
}
}

pub fn execute_ledger_transaction<S: SubstateDatabase>(
database: &S,
scrypto_vm: &ScryptoVm<DefaultWasmEngine>,
network: &NetworkDefinition,
tx_payload: &[u8],
) -> StateUpdates {
let prepared = prepare_ledger_transaction(tx_payload);
execute_prepared_ledger_transaction(database, scrypto_vm, network, &prepared)
.into_state_updates()
}

pub fn prepare_ledger_transaction(tx_payload: &[u8]) -> PreparedLedgerTransaction {
let transaction =
LedgerTransaction::from_payload_bytes(&tx_payload).expect("Failed to decode transaction");
let prepared = transaction
.prepare()
.expect("Failed to prepare transaction");
prepared
}

pub fn execute_prepared_ledger_transaction<S: SubstateDatabase>(
database: &S,
scrypto_vm: &ScryptoVm<DefaultWasmEngine>,
network: &NetworkDefinition,
prepared: &PreparedLedgerTransaction,
) -> LedgerTransactionReceipt {
match &prepared.inner {
PreparedLedgerTransactionInner::Genesis(prepared_genesis_tx) => {
match prepared_genesis_tx.as_ref() {
PreparedGenesisTransaction::Flash(_) => {
let receipt = create_substate_flash_for_genesis();
receipt.state_updates
LedgerTransactionReceipt::Flash(receipt)
}
PreparedGenesisTransaction::Transaction(tx) => {
let receipt = execute_transaction(
Expand All @@ -41,7 +82,7 @@ pub fn execute_ledger_transaction<S: SubstateDatabase>(
&ExecutionConfig::for_genesis_transaction(network.clone()),
&tx.get_executable(btreeset!(AuthAddresses::system_role())),
);
receipt.into_commit_ignore_outcome().state_updates
LedgerTransactionReceipt::Standard(receipt)
}
}
}
Expand All @@ -59,7 +100,7 @@ pub fn execute_ledger_transaction<S: SubstateDatabase>(
.expect("Transaction validation failure")
.get_executable(),
);
receipt.into_commit_ignore_outcome().state_updates
LedgerTransactionReceipt::Standard(receipt)
}
PreparedLedgerTransactionInner::RoundUpdateV1(tx) => {
let receipt = execute_transaction(
Expand All @@ -72,7 +113,7 @@ pub fn execute_ledger_transaction<S: SubstateDatabase>(
&ExecutionConfig::for_system_transaction(network.clone()),
&tx.get_executable(),
);
receipt.into_commit_ignore_outcome().state_updates
LedgerTransactionReceipt::Standard(receipt)
}
}
}
4 changes: 4 additions & 0 deletions simulator/src/replay/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ pub mod txn_reader;

mod cmd_execute;
mod cmd_execute_in_memory;
mod cmd_measure;
mod cmd_prepare;
mod cmd_sync;
mod error;

pub use cmd_execute::*;
pub use cmd_execute_in_memory::*;
pub use cmd_measure::*;
pub use cmd_prepare::*;
pub use cmd_sync::*;
pub use error::*;
Expand All @@ -30,6 +32,7 @@ pub enum Command {
Execute(TxnExecute),
ExecuteInMemory(TxnExecuteInMemory),
Sync(TxnSync),
Measure(TxnMeasure),
}

pub fn run() -> Result<(), Error> {
Expand All @@ -40,5 +43,6 @@ pub fn run() -> Result<(), Error> {
Command::Execute(cmd) => cmd.run(),
Command::ExecuteInMemory(cmd) => cmd.run(),
Command::Sync(cmd) => cmd.sync(),
Command::Measure(cmd) => cmd.run(),
}
}