risingwave_meta/hummock/compaction/
compaction_config.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::CompactionConfig as CompactionConfigOpt;
16use risingwave_common::config::meta::default::compaction_config;
17use risingwave_pb::hummock::CompactionConfig;
18use risingwave_pb::hummock::compaction_config::CompactionMode;
19
20pub struct CompactionConfigBuilder {
21    config: CompactionConfig,
22}
23
24impl CompactionConfigBuilder {
25    pub fn new() -> Self {
26        Self {
27            config: CompactionConfig {
28                max_bytes_for_level_base: compaction_config::max_bytes_for_level_base(),
29                max_bytes_for_level_multiplier: compaction_config::max_bytes_for_level_multiplier(),
30                max_level: compaction_config::max_level() as u64,
31                max_compaction_bytes: compaction_config::max_compaction_bytes(),
32                sub_level_max_compaction_bytes: compaction_config::sub_level_max_compaction_bytes(),
33                level0_tier_compact_file_number: compaction_config::level0_tier_compact_file_number(
34                ),
35                target_file_size_base: compaction_config::target_file_size_base(),
36                compaction_mode: CompactionMode::Range as i32,
37                // support compression setting per level
38                // L0/L1 and L2 do not use compression algorithms
39                // L3 - L4 use Lz4, else use Zstd
40                compression_algorithm: vec![
41                    "None".to_owned(),
42                    "None".to_owned(),
43                    "None".to_owned(),
44                    "Lz4".to_owned(),
45                    "Lz4".to_owned(),
46                    "Zstd".to_owned(),
47                    "Zstd".to_owned(),
48                ],
49                compaction_filter_mask: compaction_config::compaction_filter_mask(),
50                max_sub_compaction: compaction_config::max_sub_compaction(),
51                max_space_reclaim_bytes: compaction_config::max_space_reclaim_bytes(),
52                split_by_state_table: false,
53                split_weight_by_vnode: 0,
54                level0_stop_write_threshold_sub_level_number:
55                    compaction_config::level0_stop_write_threshold_sub_level_number(),
56                // This configure variable shall be larger than level0_tier_compact_file_number, and
57                // it shall meet the following condition:
58                //    level0_max_compact_file_number * target_file_size_base >
59                // max_bytes_for_level_base
60                level0_max_compact_file_number: compaction_config::level0_max_compact_file_number(),
61                level0_sub_level_compact_level_count:
62                    compaction_config::level0_sub_level_compact_level_count(),
63                level0_overlapping_sub_level_compact_level_count:
64                    compaction_config::level0_overlapping_sub_level_compact_level_count(),
65                tombstone_reclaim_ratio: compaction_config::tombstone_reclaim_ratio(),
66                enable_emergency_picker: compaction_config::enable_emergency_picker(),
67                max_l0_compact_level_count: Some(compaction_config::max_l0_compact_level_count()),
68                sst_allowed_trivial_move_min_size: Some(
69                    compaction_config::sst_allowed_trivial_move_min_size(),
70                ),
71                disable_auto_group_scheduling: Some(
72                    compaction_config::disable_auto_group_scheduling(),
73                ),
74                max_overlapping_level_size: Some(compaction_config::max_overlapping_level_size()),
75                sst_allowed_trivial_move_max_count: Some(
76                    compaction_config::sst_allowed_trivial_move_max_count(),
77                ),
78                emergency_level0_sst_file_count: Some(
79                    compaction_config::emergency_level0_sst_file_count(),
80                ),
81                emergency_level0_sub_level_partition: Some(
82                    compaction_config::emergency_level0_sub_level_partition(),
83                ),
84                level0_stop_write_threshold_max_sst_count: Some(
85                    compaction_config::level0_stop_write_threshold_max_sst_count(),
86                ),
87                level0_stop_write_threshold_max_size: Some(
88                    compaction_config::level0_stop_write_threshold_max_size(),
89                ),
90                enable_optimize_l0_interval_selection: Some(
91                    compaction_config::enable_optimize_l0_interval_selection(),
92                ),
93                vnode_aligned_level_size_threshold:
94                    compaction_config::vnode_aligned_level_size_threshold(),
95                max_kv_count_for_xor16: compaction_config::max_kv_count_for_xor16(),
96            },
97        }
98    }
99
100    pub fn with_config(config: CompactionConfig) -> Self {
101        Self { config }
102    }
103
104    pub fn with_opt(opt: &CompactionConfigOpt) -> Self {
105        Self::new()
106            .max_bytes_for_level_base(opt.max_bytes_for_level_base)
107            .max_bytes_for_level_multiplier(opt.max_bytes_for_level_multiplier)
108            .max_compaction_bytes(opt.max_compaction_bytes)
109            .sub_level_max_compaction_bytes(opt.sub_level_max_compaction_bytes)
110            .level0_tier_compact_file_number(opt.level0_tier_compact_file_number)
111            .target_file_size_base(opt.target_file_size_base)
112            .compaction_filter_mask(opt.compaction_filter_mask)
113            .max_sub_compaction(opt.max_sub_compaction)
114            .level0_stop_write_threshold_sub_level_number(
115                opt.level0_stop_write_threshold_sub_level_number,
116            )
117            .level0_sub_level_compact_level_count(opt.level0_sub_level_compact_level_count)
118            .level0_overlapping_sub_level_compact_level_count(
119                opt.level0_overlapping_sub_level_compact_level_count,
120            )
121            .max_space_reclaim_bytes(opt.max_space_reclaim_bytes)
122            .level0_max_compact_file_number(opt.level0_max_compact_file_number)
123            .tombstone_reclaim_ratio(opt.tombstone_reclaim_ratio)
124            .max_level(opt.max_level as u64)
125            .sst_allowed_trivial_move_min_size(Some(opt.sst_allowed_trivial_move_min_size))
126            .sst_allowed_trivial_move_max_count(Some(opt.sst_allowed_trivial_move_max_count))
127            .max_overlapping_level_size(Some(opt.max_overlapping_level_size))
128            .emergency_level0_sst_file_count(Some(opt.emergency_level0_sst_file_count))
129            .emergency_level0_sub_level_partition(Some(opt.emergency_level0_sub_level_partition))
130            .level0_stop_write_threshold_max_sst_count(Some(
131                opt.level0_stop_write_threshold_max_sst_count,
132            ))
133            .level0_stop_write_threshold_max_size(Some(opt.level0_stop_write_threshold_max_size))
134            .enable_optimize_l0_interval_selection(Some(opt.enable_optimize_l0_interval_selection))
135            .vnode_aligned_level_size_threshold(opt.vnode_aligned_level_size_threshold)
136            .max_kv_count_for_xor16(opt.max_kv_count_for_xor16)
137    }
138
139    pub fn build(self) -> CompactionConfig {
140        if let Err(reason) = validate_compaction_config(&self.config) {
141            tracing::warn!("Bad compaction config: {}", reason);
142        }
143        self.config
144    }
145}
146
147/// Returns Ok if `config` is valid,
148/// or the reason why it's invalid.
149pub fn validate_compaction_config(config: &CompactionConfig) -> Result<(), String> {
150    let sub_level_number_threshold_min = 1;
151    if config.level0_stop_write_threshold_sub_level_number < sub_level_number_threshold_min {
152        return Err(format!(
153            "{} is too small for level0_stop_write_threshold_sub_level_number, expect >= {}",
154            config.level0_stop_write_threshold_sub_level_number, sub_level_number_threshold_min
155        ));
156    }
157    Ok(())
158}
159
160impl Default for CompactionConfigBuilder {
161    fn default() -> Self {
162        Self::new()
163    }
164}
165
166macro_rules! builder_field {
167    ($( $name:ident: $type:ty ),* ,) => {
168        impl CompactionConfigBuilder {
169            $(
170                pub fn $name(mut self, v:$type) -> Self {
171                    self.config.$name = v;
172                    self
173                }
174            )*
175        }
176    }
177}
178
179builder_field! {
180    max_bytes_for_level_base: u64,
181    max_bytes_for_level_multiplier: u64,
182    max_level: u64,
183    max_compaction_bytes: u64,
184    sub_level_max_compaction_bytes: u64,
185    level0_tier_compact_file_number: u64,
186    compaction_mode: i32,
187    compression_algorithm: Vec<String>,
188    compaction_filter_mask: u32,
189    target_file_size_base: u64,
190    max_sub_compaction: u32,
191    max_space_reclaim_bytes: u64,
192    level0_stop_write_threshold_sub_level_number: u64,
193    level0_max_compact_file_number: u64,
194    level0_sub_level_compact_level_count: u32,
195    level0_overlapping_sub_level_compact_level_count: u32,
196    tombstone_reclaim_ratio: u32,
197    sst_allowed_trivial_move_min_size: Option<u64>,
198    sst_allowed_trivial_move_max_count: Option<u32>,
199    disable_auto_group_scheduling: Option<bool>,
200    max_overlapping_level_size: Option<u64>,
201    emergency_level0_sst_file_count: Option<u32>,
202    emergency_level0_sub_level_partition: Option<u32>,
203    level0_stop_write_threshold_max_sst_count: Option<u32>,
204    level0_stop_write_threshold_max_size: Option<u64>,
205    enable_optimize_l0_interval_selection: Option<bool>,
206    vnode_aligned_level_size_threshold: Option<u64>,
207    max_kv_count_for_xor16: Option<u64>,
208}
risingwave_meta/hummock/compaction/compaction_config.rs

risingwave_meta/hummock/compaction/
compaction_config.rs
