risingwave_meta/hummock/compaction/
compaction_config.rs

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

risingwave_meta/hummock/compaction/
compaction_config.rs
