stratus/eth/storage/permanent/
mod.rs

1pub use self::rocks::RocksCfCacheConfig;
2pub use self::rocks::RocksPermanentStorage;
3pub use self::rocks::RocksStorageState;
4
5pub mod rocks;
6
7use std::time::Duration;
8
9use clap::Parser;
10use display_json::DebugAsJson;
11
12/// Genesis file configuration
13#[cfg(feature = "dev")]
14use crate::config::GenesisFileConfig;
15use crate::ext::parse_duration;
16
17// -----------------------------------------------------------------------------
18// Config
19// -----------------------------------------------------------------------------
20
21/// Permanent storage configuration.
22#[derive(DebugAsJson, Clone, Parser, serde::Serialize)]
23pub struct PermanentStorageConfig {
24    /// RocksDB storage path prefix to execute multiple local Stratus instances.
25    #[arg(long = "rocks-path-prefix", env = "ROCKS_PATH_PREFIX")]
26    pub rocks_path_prefix: Option<String>,
27
28    /// The maximum time to wait for the RocksDB `wait_for_compaction` shutdown call.
29    #[arg(long = "rocks-shutdown-timeout", env = "ROCKS_SHUTDOWN_TIMEOUT", value_parser=parse_duration, default_value = "4m")]
30    pub rocks_shutdown_timeout: Duration,
31
32    /// Individual cache size configuration for each RocksDB Column Family.
33    #[clap(flatten)]
34    pub rocks_cf_cache: RocksCfCacheConfig,
35
36    /// Disables sync write for RocksDB (improves performance but reduces durability).
37    #[arg(long = "rocks-disable-sync-write", env = "ROCKS_DISABLE_SYNC_WRITE")]
38    pub rocks_disable_sync_write: bool,
39
40    /// Interval for collecting RocksDB column family size metrics.
41    #[arg(long = "rocks-cf-size-metrics-interval", env = "ROCKS_CF_SIZE_METRICS_INTERVAL", value_parser=parse_duration)]
42    pub rocks_cf_size_metrics_interval: Option<Duration>,
43
44    /// Minimum number of file descriptors required for RocksDB initialization.
45    #[arg(long = "rocks-file-descriptors-limit", env = "ROCKS_FILE_DESCRIPTORS_LIMIT", default_value = Self::DEFAULT_FILE_DESCRIPTORS_LIMIT)]
46    pub rocks_file_descriptors_limit: u64,
47
48    /// Genesis file configuration
49    #[clap(flatten)]
50    #[cfg(feature = "dev")]
51    pub genesis_file: GenesisFileConfig,
52}
53
54impl PermanentStorageConfig {
55    const DEFAULT_FILE_DESCRIPTORS_LIMIT: &'static str = if cfg!(feature = "dev") { "65536" } else { "1048576" };
56    /// Initializes permanent storage implementation.
57    pub fn init(&self) -> anyhow::Result<RocksPermanentStorage> {
58        tracing::info!(config = ?self, "creating permanent storage");
59
60        RocksPermanentStorage::new(
61            self.rocks_path_prefix.clone(),
62            self.rocks_shutdown_timeout,
63            self.rocks_cf_cache.clone(),
64            !self.rocks_disable_sync_write,
65            self.rocks_cf_size_metrics_interval,
66            self.rocks_file_descriptors_limit,
67        )
68    }
69}
stratus/eth/storage/permanent/mod.rs

stratus/eth/storage/permanent/
mod.rs
