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

feat(bin, engine): make state root task default #14371

Merged
merged 9 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all 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
4 changes: 2 additions & 2 deletions book/cli/reth/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -707,8 +707,8 @@ Engine:

[default: 2]

--engine.state-root-task
Enable state root task
--engine.legacy-state-root
Enable legacy state root

--engine.caching-and-prewarming
Enable cross-block caching and parallel prewarming
Expand Down
2 changes: 1 addition & 1 deletion crates/e2e-test-utils/src/node.rs
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ where
tokio::time::sleep(std::time::Duration::from_millis(100)).await;
self.engine_api.update_forkchoice(block, block).await?;

assert!(start.elapsed() <= std::time::Duration::from_secs(10), "timed out");
assert!(start.elapsed() <= std::time::Duration::from_secs(40), "timed out");
}

// Hack to make sure that all components have time to process canonical state update.
Expand Down
24 changes: 13 additions & 11 deletions crates/engine/tree/src/tree/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ pub struct TreeConfig {
/// This is used as a cutoff to prevent long-running sequential block execution when we receive
/// a batch of downloaded blocks.
max_execute_block_batch_size: usize,
/// Whether to use the new state root task calculation method instead of parallel calculation
use_state_root_task: bool,
/// Whether to use the legacy state root calculation method instead of the
/// new state root task
legacy_state_root: bool,
/// Whether to always compare trie updates from the state root task to the trie updates from
/// the regular state root calculation.
always_compare_trie_updates: bool,
Expand All @@ -62,7 +63,7 @@ impl Default for TreeConfig {
block_buffer_limit: DEFAULT_BLOCK_BUFFER_LIMIT,
max_invalid_header_cache_length: DEFAULT_MAX_INVALID_HEADER_CACHE_LENGTH,
max_execute_block_batch_size: DEFAULT_MAX_EXECUTE_BLOCK_BATCH_SIZE,
use_state_root_task: false,
legacy_state_root: false,
always_compare_trie_updates: false,
use_caching_and_prewarming: false,
cross_block_cache_size: DEFAULT_CROSS_BLOCK_CACHE_SIZE,
Expand All @@ -79,7 +80,7 @@ impl TreeConfig {
block_buffer_limit: u32,
max_invalid_header_cache_length: u32,
max_execute_block_batch_size: usize,
use_state_root_task: bool,
legacy_state_root: bool,
always_compare_trie_updates: bool,
use_caching_and_prewarming: bool,
cross_block_cache_size: u64,
Expand All @@ -90,7 +91,7 @@ impl TreeConfig {
block_buffer_limit,
max_invalid_header_cache_length,
max_execute_block_batch_size,
use_state_root_task,
legacy_state_root,
always_compare_trie_updates,
use_caching_and_prewarming,
cross_block_cache_size,
Expand Down Expand Up @@ -122,9 +123,10 @@ impl TreeConfig {
self.max_execute_block_batch_size
}

/// Returns whether to use the state root task calculation method.
pub const fn use_state_root_task(&self) -> bool {
self.use_state_root_task
/// Returns whether to use the legacy state root calculation method instead
/// of the new state root task
pub const fn legacy_state_root(&self) -> bool {
self.legacy_state_root
}

/// Returns whether or not cross-block caching and parallel prewarming should be used.
Expand Down Expand Up @@ -182,9 +184,9 @@ impl TreeConfig {
self
}

/// Setter for whether to use the new state root task calculation method.
pub const fn with_state_root_task(mut self, use_state_root_task: bool) -> Self {
self.use_state_root_task = use_state_root_task;
/// Setter for whether to use the legacy state root calculation method.
pub const fn with_legacy_state_root(mut self, legacy_state_root: bool) -> Self {
self.legacy_state_root = legacy_state_root;
self
}

Expand Down
35 changes: 18 additions & 17 deletions crates/engine/tree/src/tree/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2420,7 +2420,7 @@ where
let cancel_execution = ManualCancel::default();

let (state_root_handle, state_root_task_config, state_root_sender, state_hook) =
if is_descendant_of_persisting_blocks && self.config.use_state_root_task() {
if is_descendant_of_persisting_blocks && !self.config.legacy_state_root() {
let consistent_view = ConsistentDbView::new_with_latest_tip(self.provider.clone())?;

// Compute trie input
Expand Down Expand Up @@ -2548,21 +2548,7 @@ where
// a different database transaction per thread and it might end up with a
// different view of the database.
let (state_root, trie_output, root_elapsed) = if is_descendant_of_persisting_blocks {
if self.config.use_state_root_task() {
let state_root_handle = state_root_handle
.expect("state root handle must exist if use_state_root_task is true");
let state_root_config = state_root_task_config.expect("task config is present");

// Handle state root result from task using handle
self.handle_state_root_result(
state_root_handle,
state_root_config,
block.sealed_block(),
&hashed_state,
&state_provider,
root_time,
)?
} else {
if self.config.legacy_state_root() {
match self.compute_state_root_parallel(block.header().parent_hash(), &hashed_state)
{
Ok(result) => {
Expand All @@ -2582,6 +2568,20 @@ where
}
Err(error) => return Err(InsertBlockErrorKind::Other(Box::new(error))),
}
} else {
let state_root_handle = state_root_handle
.expect("state root handle must exist if use_state_root_task is true");
let state_root_config = state_root_task_config.expect("task config is present");

// Handle state root result from task using handle
self.handle_state_root_result(
state_root_handle,
state_root_config,
block.sealed_block(),
&hashed_state,
&state_provider,
root_time,
)?
}
} else {
debug!(target: "engine::tree", block=?block_num_hash, ?is_descendant_of_persisting_blocks, "Failed to compute state root in parallel");
Expand Down Expand Up @@ -3338,7 +3338,8 @@ mod tests {
persistence_handle,
PersistenceState::default(),
payload_builder,
TreeConfig::default(),
// TODO: fix tests for state root task https://github.com/paradigmxyz/reth/issues/14376
TreeConfig::default().with_legacy_state_root(true),
EngineApiKind::Ethereum,
evm_config,
);
Expand Down
2 changes: 1 addition & 1 deletion crates/node/builder/src/builder/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@ where
let engine_tree_config = TreeConfig::default()
.with_persistence_threshold(builder.config.engine.persistence_threshold)
.with_memory_block_buffer_target(builder.config.engine.memory_block_buffer_target)
.with_state_root_task(builder.config.engine.state_root_task_enabled)
.with_legacy_state_root(builder.config.engine.legacy_state_root_task_enabled)
.with_caching_and_prewarming(builder.config.engine.caching_and_prewarming_enabled)
.with_always_compare_trie_updates(builder.config.engine.state_root_task_compare_updates)
.with_cross_block_cache_size(
Expand Down
8 changes: 4 additions & 4 deletions crates/node/core/src/args/engine.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ pub struct EngineArgs {
#[arg(long = "engine.memory-block-buffer-target", default_value_t = DEFAULT_MEMORY_BLOCK_BUFFER_TARGET)]
pub memory_block_buffer_target: u64,

/// Enable state root task
#[arg(long = "engine.state-root-task")]
pub state_root_task_enabled: bool,
/// Enable legacy state root
#[arg(long = "engine.legacy-state-root", default_value = "false")]
pub legacy_state_root_task_enabled: bool,

/// Enable cross-block caching and parallel prewarming
#[arg(long = "engine.caching-and-prewarming")]
Expand All @@ -42,7 +42,7 @@ impl Default for EngineArgs {
Self {
persistence_threshold: DEFAULT_PERSISTENCE_THRESHOLD,
memory_block_buffer_target: DEFAULT_MEMORY_BLOCK_BUFFER_TARGET,
state_root_task_enabled: false,
legacy_state_root_task_enabled: false,
state_root_task_compare_updates: false,
caching_and_prewarming_enabled: false,
cross_block_cache_size: DEFAULT_CROSS_BLOCK_CACHE_SIZE_MB,
Expand Down
Loading