risingwave_storage/
opts.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use risingwave_common::config::{
16    EvictionConfig, ObjectStoreConfig, RwConfig, StorageMemoryConfig, extract_storage_memory_config,
17};
18use risingwave_common::system_param::reader::{SystemParamsRead, SystemParamsReader};
19use risingwave_common::system_param::system_params_for_test;
20
21#[derive(Clone, Debug)]
22pub struct StorageOpts {
23    /// The size of parallel task for one compact/flush job.
24    pub parallel_compact_size_mb: u32,
25    /// Target size of the Sstable.
26    pub sstable_size_mb: u32,
27    /// Minimal target size of the Sstable to store data of different state-table in independent files as soon as possible.
28    pub min_sstable_size_mb: u32,
29    /// Size of each block in bytes in SST.
30    pub block_size_kb: u32,
31    /// False positive probability of bloom filter.
32    pub bloom_false_positive: f64,
33    /// parallelism while syncing share buffers into L0 SST. Should NOT be 0.
34    pub share_buffers_sync_parallelism: u32,
35    /// Worker threads number of dedicated tokio runtime for share buffer compaction. 0 means use
36    /// tokio's default value (number of CPU core).
37    pub share_buffer_compaction_worker_threads_number: u32,
38    /// Maximum shared buffer size, writes attempting to exceed the capacity will stall until there
39    /// is enough space.
40    pub shared_buffer_capacity_mb: usize,
41    /// The shared buffer will start flushing data to object when the ratio of memory usage to the
42    /// shared buffer capacity exceed such ratio.
43    pub shared_buffer_flush_ratio: f32,
44    /// The minimum total flush size of shared buffer spill. When a shared buffer spill is trigger,
45    /// the total flush size across multiple epochs should be at least higher than this size.
46    pub shared_buffer_min_batch_flush_size_mb: usize,
47    /// Remote directory for storing data and metadata objects.
48    pub data_directory: String,
49    /// Whether to enable write conflict detection
50    pub write_conflict_detection_enabled: bool,
51    /// Capacity of sstable block cache.
52    pub block_cache_capacity_mb: usize,
53    /// the number of block-cache shard. Less shard means that more concurrent-conflict.
54    pub block_cache_shard_num: usize,
55    /// Eviction config for block cache.
56    pub block_cache_eviction_config: EvictionConfig,
57    /// Capacity of sstable meta cache.
58    pub meta_cache_capacity_mb: usize,
59    /// the number of meta-cache shard. Less shard means that more concurrent-conflict.
60    pub meta_cache_shard_num: usize,
61    /// Eviction config for meta cache.
62    pub meta_cache_eviction_config: EvictionConfig,
63    /// max memory usage for large query.
64    pub prefetch_buffer_capacity_mb: usize,
65
66    pub max_cached_recent_versions_number: usize,
67
68    pub max_prefetch_block_number: usize,
69
70    pub disable_remote_compactor: bool,
71    /// Number of tasks shared buffer can upload in parallel.
72    pub share_buffer_upload_concurrency: usize,
73    /// Capacity of sstable meta cache.
74    pub compactor_memory_limit_mb: usize,
75    /// compactor streaming iterator recreate timeout.
76    /// deprecated
77    pub compact_iter_recreate_timeout_ms: u64,
78    /// Number of SST ids fetched from meta per RPC
79    pub sstable_id_remote_fetch_number: u32,
80    /// Whether to enable streaming upload for sstable.
81    pub min_sst_size_for_streaming_upload: u64,
82    pub max_concurrent_compaction_task_number: u64,
83    pub max_version_pinning_duration_sec: u64,
84    pub compactor_iter_max_io_retry_times: usize,
85
86    pub data_file_cache_dir: String,
87    pub data_file_cache_capacity_mb: usize,
88    pub data_file_cache_file_capacity_mb: usize,
89    pub data_file_cache_flushers: usize,
90    pub data_file_cache_reclaimers: usize,
91    pub data_file_cache_recover_mode: foyer::RecoverMode,
92    pub data_file_cache_recover_concurrency: usize,
93    pub data_file_cache_insert_rate_limit_mb: usize,
94    pub data_file_cache_indexer_shards: usize,
95    pub data_file_cache_compression: foyer::Compression,
96    pub data_file_cache_flush_buffer_threshold_mb: usize,
97    pub data_file_cache_runtime_config: foyer::RuntimeOptions,
98
99    pub cache_refill_data_refill_levels: Vec<u32>,
100    pub cache_refill_timeout_ms: u64,
101    pub cache_refill_concurrency: usize,
102    pub cache_refill_recent_filter_layers: usize,
103    pub cache_refill_recent_filter_rotate_interval_ms: usize,
104    pub cache_refill_unit: usize,
105    pub cache_refill_threshold: f64,
106
107    pub meta_file_cache_dir: String,
108    pub meta_file_cache_capacity_mb: usize,
109    pub meta_file_cache_file_capacity_mb: usize,
110    pub meta_file_cache_flushers: usize,
111    pub meta_file_cache_reclaimers: usize,
112    pub meta_file_cache_recover_mode: foyer::RecoverMode,
113    pub meta_file_cache_recover_concurrency: usize,
114    pub meta_file_cache_insert_rate_limit_mb: usize,
115    pub meta_file_cache_indexer_shards: usize,
116    pub meta_file_cache_compression: foyer::Compression,
117    pub meta_file_cache_flush_buffer_threshold_mb: usize,
118    pub meta_file_cache_runtime_config: foyer::RuntimeOptions,
119
120    /// The storage url for storing backups.
121    pub backup_storage_url: String,
122    /// The storage directory for storing backups.
123    pub backup_storage_directory: String,
124    /// max time which wait for preload. 0 represent do not do any preload.
125    pub max_preload_wait_time_mill: u64,
126
127    pub compactor_max_sst_key_count: u64,
128    pub compactor_max_task_multiplier: f32,
129    pub compactor_max_sst_size: u64,
130    /// enable `FastCompactorRunner`.
131    pub enable_fast_compaction: bool,
132    pub check_compaction_result: bool,
133    pub max_preload_io_retry_times: usize,
134    pub compactor_fast_max_compact_delete_ratio: u32,
135    pub compactor_fast_max_compact_task_size: u64,
136
137    pub mem_table_spill_threshold: usize,
138
139    pub compactor_concurrent_uploading_sst_count: Option<usize>,
140
141    pub compactor_max_overlap_sst_count: usize,
142
143    /// The maximum number of meta files that can be preloaded.
144    pub compactor_max_preload_meta_file_count: usize,
145
146    pub object_store_config: ObjectStoreConfig,
147    pub time_travel_version_cache_capacity: u64,
148}
149
150impl Default for StorageOpts {
151    fn default() -> Self {
152        let c = RwConfig::default();
153        let p = system_params_for_test();
154        let s = extract_storage_memory_config(&c);
155        Self::from((&c, &p.into(), &s))
156    }
157}
158
159impl From<(&RwConfig, &SystemParamsReader, &StorageMemoryConfig)> for StorageOpts {
160    fn from((c, p, s): (&RwConfig, &SystemParamsReader, &StorageMemoryConfig)) -> Self {
161        Self {
162            parallel_compact_size_mb: p.parallel_compact_size_mb(),
163            sstable_size_mb: p.sstable_size_mb(),
164            min_sstable_size_mb: c.storage.min_sstable_size_mb,
165            block_size_kb: p.block_size_kb(),
166            bloom_false_positive: p.bloom_false_positive(),
167            share_buffers_sync_parallelism: c.storage.share_buffers_sync_parallelism,
168            share_buffer_compaction_worker_threads_number: c
169                .storage
170                .share_buffer_compaction_worker_threads_number,
171            shared_buffer_capacity_mb: s.shared_buffer_capacity_mb,
172            shared_buffer_flush_ratio: c.storage.shared_buffer_flush_ratio,
173            shared_buffer_min_batch_flush_size_mb: c.storage.shared_buffer_min_batch_flush_size_mb,
174            data_directory: p.data_directory().to_owned(),
175            write_conflict_detection_enabled: c.storage.write_conflict_detection_enabled,
176            block_cache_capacity_mb: s.block_cache_capacity_mb,
177            block_cache_shard_num: s.block_cache_shard_num,
178            block_cache_eviction_config: s.block_cache_eviction_config.clone(),
179            meta_cache_capacity_mb: s.meta_cache_capacity_mb,
180            meta_cache_shard_num: s.meta_cache_shard_num,
181            meta_cache_eviction_config: s.meta_cache_eviction_config.clone(),
182            prefetch_buffer_capacity_mb: s.prefetch_buffer_capacity_mb,
183            max_cached_recent_versions_number: c.storage.max_cached_recent_versions_number,
184            max_prefetch_block_number: c.storage.max_prefetch_block_number,
185            disable_remote_compactor: c.storage.disable_remote_compactor,
186            share_buffer_upload_concurrency: c.storage.share_buffer_upload_concurrency,
187            compactor_memory_limit_mb: s.compactor_memory_limit_mb,
188            sstable_id_remote_fetch_number: c.storage.sstable_id_remote_fetch_number,
189            min_sst_size_for_streaming_upload: c.storage.min_sst_size_for_streaming_upload,
190            max_concurrent_compaction_task_number: c.storage.max_concurrent_compaction_task_number,
191            max_version_pinning_duration_sec: c.storage.max_version_pinning_duration_sec,
192            data_file_cache_dir: c.storage.data_file_cache.dir.clone(),
193            data_file_cache_capacity_mb: c.storage.data_file_cache.capacity_mb,
194            data_file_cache_file_capacity_mb: c.storage.data_file_cache.file_capacity_mb,
195            data_file_cache_flushers: c.storage.data_file_cache.flushers,
196            data_file_cache_reclaimers: c.storage.data_file_cache.reclaimers,
197            data_file_cache_recover_mode: c.storage.data_file_cache.recover_mode,
198            data_file_cache_recover_concurrency: c.storage.data_file_cache.recover_concurrency,
199            data_file_cache_insert_rate_limit_mb: c.storage.data_file_cache.insert_rate_limit_mb,
200            data_file_cache_indexer_shards: c.storage.data_file_cache.indexer_shards,
201            data_file_cache_compression: c.storage.data_file_cache.compression,
202            data_file_cache_flush_buffer_threshold_mb: s.block_file_cache_flush_buffer_threshold_mb,
203            data_file_cache_runtime_config: c.storage.data_file_cache.runtime_config.clone(),
204            meta_file_cache_dir: c.storage.meta_file_cache.dir.clone(),
205            meta_file_cache_capacity_mb: c.storage.meta_file_cache.capacity_mb,
206            meta_file_cache_file_capacity_mb: c.storage.meta_file_cache.file_capacity_mb,
207            meta_file_cache_flushers: c.storage.meta_file_cache.flushers,
208            meta_file_cache_reclaimers: c.storage.meta_file_cache.reclaimers,
209            meta_file_cache_recover_mode: c.storage.meta_file_cache.recover_mode,
210            meta_file_cache_recover_concurrency: c.storage.meta_file_cache.recover_concurrency,
211            meta_file_cache_insert_rate_limit_mb: c.storage.meta_file_cache.insert_rate_limit_mb,
212            meta_file_cache_indexer_shards: c.storage.meta_file_cache.indexer_shards,
213            meta_file_cache_compression: c.storage.meta_file_cache.compression,
214            meta_file_cache_flush_buffer_threshold_mb: s.meta_file_cache_flush_buffer_threshold_mb,
215            meta_file_cache_runtime_config: c.storage.meta_file_cache.runtime_config.clone(),
216            cache_refill_data_refill_levels: c.storage.cache_refill.data_refill_levels.clone(),
217            cache_refill_timeout_ms: c.storage.cache_refill.timeout_ms,
218            cache_refill_concurrency: c.storage.cache_refill.concurrency,
219            cache_refill_recent_filter_layers: c.storage.cache_refill.recent_filter_layers,
220            cache_refill_recent_filter_rotate_interval_ms: c
221                .storage
222                .cache_refill
223                .recent_filter_rotate_interval_ms,
224            cache_refill_unit: c.storage.cache_refill.unit,
225            cache_refill_threshold: c.storage.cache_refill.threshold,
226            max_preload_wait_time_mill: c.storage.max_preload_wait_time_mill,
227            compact_iter_recreate_timeout_ms: c.storage.compact_iter_recreate_timeout_ms,
228
229            max_preload_io_retry_times: c.storage.max_preload_io_retry_times,
230            backup_storage_url: p.backup_storage_url().to_owned(),
231            backup_storage_directory: p.backup_storage_directory().to_owned(),
232            compactor_max_sst_key_count: c.storage.compactor_max_sst_key_count,
233            compactor_max_task_multiplier: c.storage.compactor_max_task_multiplier,
234            compactor_max_sst_size: c.storage.compactor_max_sst_size,
235            enable_fast_compaction: c.storage.enable_fast_compaction,
236            check_compaction_result: c.storage.check_compaction_result,
237            mem_table_spill_threshold: c.storage.mem_table_spill_threshold,
238            object_store_config: c.storage.object_store.clone(),
239            compactor_fast_max_compact_delete_ratio: c
240                .storage
241                .compactor_fast_max_compact_delete_ratio,
242            compactor_fast_max_compact_task_size: c.storage.compactor_fast_max_compact_task_size,
243            compactor_iter_max_io_retry_times: c.storage.compactor_iter_max_io_retry_times,
244            compactor_concurrent_uploading_sst_count: c
245                .storage
246                .compactor_concurrent_uploading_sst_count,
247            time_travel_version_cache_capacity: c.storage.time_travel_version_cache_capacity,
248            compactor_max_overlap_sst_count: c.storage.compactor_max_overlap_sst_count,
249            compactor_max_preload_meta_file_count: c.storage.compactor_max_preload_meta_file_count,
250        }
251    }
252}
risingwave_storage/opts.rs

risingwave_storage/
opts.rs
