Coverage Report

Created: 2026-03-19 17:04

/root/doris/cloud/src/recycler/recycler.h
Line
Count
Source (jump to first uncovered line)
1
// Licensed to the Apache Software Foundation (ASF) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The ASF licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17
18
#pragma once
19
20
#include <gen_cpp/cloud.pb.h>
21
#include <glog/logging.h>
22
23
#include <atomic>
24
#include <condition_variable>
25
#include <cstdint>
26
#include <deque>
27
#include <functional>
28
#include <memory>
29
#include <string>
30
#include <string_view>
31
#include <thread>
32
#include <unordered_map>
33
#include <unordered_set>
34
#include <utility>
35
36
#include "common/bvars.h"
37
#include "meta-service/delete_bitmap_lock_white_list.h"
38
#include "meta-service/txn_lazy_committer.h"
39
#include "meta-store/versionstamp.h"
40
#include "recycler/snapshot_chain_compactor.h"
41
#include "recycler/snapshot_data_migrator.h"
42
#include "recycler/storage_vault_accessor.h"
43
#include "recycler/white_black_list.h"
44
#include "snapshot/snapshot_manager.h"
45
46
namespace brpc {
47
class Server;
48
} // namespace brpc
49
50
namespace doris::cloud {
51
class TxnKv;
52
class InstanceRecycler;
53
class StorageVaultAccessor;
54
class Checker;
55
class SimpleThreadPool;
56
class RecyclerMetricsContext;
57
class TabletRecyclerMetricsContext;
58
class SegmentRecyclerMetricsContext;
59
struct RecyclerThreadPoolGroup {
60
8
    RecyclerThreadPoolGroup() = default;
61
    RecyclerThreadPoolGroup(std::shared_ptr<SimpleThreadPool> s3_producer_pool,
62
                            std::shared_ptr<SimpleThreadPool> recycle_tablet_pool,
63
                            std::shared_ptr<SimpleThreadPool> group_recycle_function_pool)
64
            : s3_producer_pool(std::move(s3_producer_pool)),
65
              recycle_tablet_pool(std::move(recycle_tablet_pool)),
66
11
              group_recycle_function_pool(std::move(group_recycle_function_pool)) {}
67
271
    ~RecyclerThreadPoolGroup() = default;
68
126
    RecyclerThreadPoolGroup(const RecyclerThreadPoolGroup&) = default;
69
    RecyclerThreadPoolGroup& operator=(RecyclerThreadPoolGroup& other) = default;
70
11
    RecyclerThreadPoolGroup& operator=(RecyclerThreadPoolGroup&& other) = default;
71
126
    RecyclerThreadPoolGroup(RecyclerThreadPoolGroup&&) = default;
72
    // used for accessor.delete_files, accessor.delete_directory
73
    std::shared_ptr<SimpleThreadPool> s3_producer_pool;
74
    // used for InstanceRecycler::recycle_tablet
75
    std::shared_ptr<SimpleThreadPool> recycle_tablet_pool;
76
    std::shared_ptr<SimpleThreadPool> group_recycle_function_pool;
77
};
78
79
class Recycler {
80
public:
81
    explicit Recycler(std::shared_ptr<TxnKv> txn_kv);
82
    ~Recycler();
83
84
    // returns 0 for success otherwise error
85
    int start(brpc::Server* server);
86
87
    void stop();
88
89
295
    bool stopped() const { return stopped_.load(std::memory_order_acquire); }
90
91
0
    RecyclerThreadPoolGroup& thread_pool_group() { return _thread_pool_group; }
92
93
private:
94
    void recycle_callback();
95
96
    void instance_scanner_callback();
97
98
    void lease_recycle_jobs();
99
100
    void check_recycle_tasks();
101
102
private:
103
    friend class RecyclerServiceImpl;
104
105
    std::shared_ptr<TxnKv> txn_kv_;
106
    std::atomic_bool stopped_ {false};
107
108
    std::vector<std::thread> workers_;
109
110
    std::mutex mtx_;
111
    // notify recycle workers
112
    std::condition_variable pending_instance_cond_;
113
    std::deque<InstanceInfoPB> pending_instance_queue_;
114
    std::unordered_set<std::string> pending_instance_set_;
115
    std::unordered_map<std::string, std::shared_ptr<InstanceRecycler>> recycling_instance_map_;
116
    // notify instance scanner and lease thread
117
    std::condition_variable notifier_;
118
119
    std::string ip_port_;
120
121
    WhiteBlackList instance_filter_;
122
    std::unique_ptr<Checker> checker_;
123
124
    RecyclerThreadPoolGroup _thread_pool_group;
125
126
    std::shared_ptr<TxnLazyCommitter> txn_lazy_committer_;
127
    std::shared_ptr<SnapshotManager> snapshot_manager_;
128
    std::shared_ptr<SnapshotDataMigrator> snapshot_data_migrator_;
129
    std::shared_ptr<SnapshotChainCompactor> snapshot_chain_compactor_;
130
};
131
132
enum class RowsetRecyclingState {
133
    FORMAL_ROWSET,
134
    TMP_ROWSET,
135
};
136
137
// Represents a single rowset deletion task for batch delete
138
struct RowsetDeleteTask {
139
    RowsetMetaCloudPB rowset_meta;
140
    std::string recycle_rowset_key;       // Primary key marking "pending recycle"
141
    std::string non_versioned_rowset_key; // Legacy non-versioned rowset meta key
142
    std::string versioned_rowset_key;     // Versioned meta rowset key
143
    std::string rowset_ref_count_key;
144
};
145
146
class RecyclerMetricsContext {
147
public:
148
9
    RecyclerMetricsContext() = default;
149
150
    RecyclerMetricsContext(std::string instance_id, std::string operation_type)
151
456
            : operation_type(std::move(operation_type)), instance_id(std::move(instance_id)) {
152
456
        start();
153
456
    }
154
155
464
    ~RecyclerMetricsContext() = default;
156
157
    std::atomic_ullong total_need_recycle_data_size = 0;
158
    std::atomic_ullong total_need_recycle_num = 0;
159
160
    std::atomic_ullong total_recycled_data_size = 0;
161
    std::atomic_ullong total_recycled_num = 0;
162
163
    std::string operation_type;
164
    std::string instance_id;
165
166
    double start_time = 0;
167
168
456
    void start() {
169
456
        start_time = duration_cast<std::chrono::milliseconds>(
170
456
                             std::chrono::system_clock::now().time_since_epoch())
171
456
                             .count();
172
456
    }
173
174
212
    double duration() const {
175
212
        return duration_cast<std::chrono::milliseconds>(
176
212
                       std::chrono::system_clock::now().time_since_epoch())
177
212
                       .count() -
178
212
               start_time;
179
212
    }
180
181
20
    void reset() {
182
20
        total_need_recycle_data_size = 0;
183
20
        total_need_recycle_num = 0;
184
20
        total_recycled_data_size = 0;
185
20
        total_recycled_num = 0;
186
20
        start_time = duration_cast<std::chrono::milliseconds>(
187
20
                             std::chrono::system_clock::now().time_since_epoch())
188
20
                             .count();
189
20
    }
190
191
212
    void finish_report() {
192
212
        if (!operation_type.empty()) {
193
212
            double cost = duration();
194
212
            g_bvar_recycler_instance_last_round_recycle_elpased_ts.put(
195
212
                    {instance_id, operation_type}, cost);
196
212
            g_bvar_recycler_instance_recycle_round.put({instance_id, operation_type}, 1);
197
212
            g_bvar_recycler_instance_recycle_total_bytes_since_started.put(
198
212
                    {instance_id, operation_type}, total_recycled_data_size.load());
199
212
            g_bvar_recycler_instance_recycle_total_num_since_started.put(
200
212
                    {instance_id, operation_type}, total_recycled_num.load());
201
212
            LOG(INFO) << "recycle instance: " << instance_id
202
212
                      << ", operation type: " << operation_type << ", cost: " << cost
203
212
                      << " ms, total recycled num: " << total_recycled_num.load()
204
212
                      << ", total recycled data size: " << total_recycled_data_size.load()
205
212
                      << " bytes";
206
212
            if (cost != 0) {
207
197
                if (total_recycled_num.load() != 0) {
208
35
                    g_bvar_recycler_instance_recycle_time_per_resource.put(
209
35
                            {instance_id, operation_type}, cost / total_recycled_num.load());
210
35
                }
211
197
                g_bvar_recycler_instance_recycle_bytes_per_ms.put(
212
197
                        {instance_id, operation_type}, total_recycled_data_size.load() / cost);
213
197
            }
214
212
        }
215
212
    }
216
217
    // `is_begin` is used to initialize total num of items need to be recycled
218
944
    void report(bool is_begin = false) {
219
944
        if (!operation_type.empty()) {
220
            // is init
221
925
            if (is_begin) {
222
0
                auto value = total_need_recycle_num.load();
223
224
0
                g_bvar_recycler_instance_last_round_to_recycle_bytes.put(
225
0
                        {instance_id, operation_type}, total_need_recycle_data_size.load());
226
0
                g_bvar_recycler_instance_last_round_to_recycle_num.put(
227
0
                        {instance_id, operation_type}, value);
228
925
            } else {
229
925
                g_bvar_recycler_instance_last_round_recycled_bytes.put(
230
925
                        {instance_id, operation_type}, total_recycled_data_size.load());
231
925
                g_bvar_recycler_instance_last_round_recycled_num.put({instance_id, operation_type},
232
925
                                                                     total_recycled_num.load());
233
925
            }
234
925
        }
235
944
    }
236
};
237
238
class TabletRecyclerMetricsContext : public RecyclerMetricsContext {
239
public:
240
126
    TabletRecyclerMetricsContext() : RecyclerMetricsContext("global_recycler", "recycle_tablet") {}
241
};
242
243
class SegmentRecyclerMetricsContext : public RecyclerMetricsContext {
244
public:
245
    SegmentRecyclerMetricsContext()
246
126
            : RecyclerMetricsContext("global_recycler", "recycle_segment") {}
247
};
248
249
class InstanceRecycler {
250
public:
251
    struct PackedFileRecycleStats {
252
        int64_t num_scanned = 0;          // packed-file kv scanned
253
        int64_t num_corrected = 0;        // packed-file kv corrected
254
        int64_t num_deleted = 0;          // packed-file kv deleted
255
        int64_t num_failed = 0;           // packed-file kv failed
256
        int64_t bytes_deleted = 0;        // packed-file kv bytes deleted from txn-kv
257
        int64_t num_object_deleted = 0;   // packed-file objects deleted from storage (vault/HDFS)
258
        int64_t bytes_object_deleted = 0; // bytes deleted from storage objects
259
        int64_t rowset_scan_count = 0;    // rowset metas scanned during correction
260
    };
261
262
    explicit InstanceRecycler(std::shared_ptr<TxnKv> txn_kv, const InstanceInfoPB& instance,
263
                              RecyclerThreadPoolGroup thread_pool_group,
264
                              std::shared_ptr<TxnLazyCommitter> txn_lazy_committer);
265
    ~InstanceRecycler();
266
267
0
    std::string_view instance_id() const { return instance_id_; }
268
3
    const InstanceInfoPB& instance_info() const { return instance_info_; }
269
270
    // returns 0 for success otherwise error
271
    int init();
272
273
0
    void stop() { stopped_.store(true, std::memory_order_release); }
274
80
    bool stopped() const { return stopped_.load(std::memory_order_acquire); }
275
276
    // returns 0 for success otherwise error
277
    int do_recycle();
278
279
    // remove all kv and data in this instance, ONLY be called when instance has been deleted
280
    // returns 0 for success otherwise error
281
    int recycle_deleted_instance();
282
283
    // scan and recycle expired indexes:
284
    // 1. dropped table, dropped mv
285
    // 2. half-successtable/index when create
286
    // returns 0 for success otherwise error
287
    int recycle_indexes();
288
289
    // scan and recycle expired partitions:
290
    // 1. dropped parttion
291
    // 2. half-success partition when create
292
    // returns 0 for success otherwise error
293
    int recycle_partitions();
294
295
    // scan and recycle expired rowsets:
296
    // 1. prepare_rowset will produce recycle_rowset before uploading data to remote storage (memo)
297
    // 2. compaction will change the input rowsets to recycle_rowset
298
    // returns 0 for success otherwise error
299
    int recycle_rowsets();
300
301
    // like `recycle_rowsets`, but for versioned rowsets.
302
    int recycle_versioned_rowsets();
303
304
    // scan and recycle expired tmp rowsets:
305
    // 1. commit_rowset will produce tmp_rowset when finish upload data (load or compaction) to remote storage
306
    // returns 0 for success otherwise error
307
    int recycle_tmp_rowsets();
308
309
    /**
310
     * recycle all tablets belonging to the index specified by `index_id`
311
     *
312
     * @param partition_id if positive, only recycle tablets in this partition belonging to the specified index
313
     * @return 0 for success otherwise error
314
     */
315
    int recycle_tablets(int64_t table_id, int64_t index_id, RecyclerMetricsContext& ctx,
316
                        int64_t partition_id = -1);
317
318
    /**
319
     * recycle all rowsets belonging to the tablet specified by `tablet_id`
320
     *
321
     * @return 0 for success otherwise error
322
     */
323
    int recycle_tablet(int64_t tablet_id, RecyclerMetricsContext& metrics_context);
324
325
    /**
326
     * like `recycle_tablet`, but for versioned tablet
327
     */
328
    int recycle_versioned_tablet(int64_t tablet_id, RecyclerMetricsContext& metrics_context);
329
330
    // scan and recycle useless partition version kv
331
    int recycle_versions();
332
333
    // scan and recycle the orphan partitions
334
    int recycle_orphan_partitions();
335
336
    // scan and abort timeout txn label
337
    // returns 0 for success otherwise error
338
    int abort_timeout_txn();
339
340
    //scan and recycle expire txn label
341
    // returns 0 for success otherwise error
342
    int recycle_expired_txn_label();
343
344
    // scan and recycle finished or timeout copy jobs
345
    // returns 0 for success otherwise error
346
    int recycle_copy_jobs();
347
348
    // scan and recycle dropped internal stage
349
    // returns 0 for success otherwise error
350
    int recycle_stage();
351
352
    // scan and recycle expired stage objects
353
    // returns 0 for success otherwise error
354
    int recycle_expired_stage_objects();
355
356
    // scan and recycle operation logs
357
    // returns 0 for success otherwise error
358
    int recycle_operation_logs();
359
360
    // scan and recycle expired restore jobs
361
    // returns 0 for success otherwise error
362
    int recycle_restore_jobs();
363
364
    /**
365
     * Scan packed-file metadata, correct reference counters, and recycle unused packed files.
366
     *
367
     * @return 0 on success, non-zero error code otherwise
368
     */
369
    int recycle_packed_files();
370
371
    // scan and recycle snapshots
372
    // returns 0 for success otherwise error
373
    int recycle_cluster_snapshots();
374
375
    // scan and recycle ref rowsets for deleted instance
376
    // returns 0 for success otherwise error
377
    int recycle_ref_rowsets(bool* has_unrecycled_rowsets);
378
379
    bool check_recycle_tasks();
380
381
    int scan_and_statistics_indexes();
382
383
    int scan_and_statistics_partitions();
384
385
    int scan_and_statistics_rowsets();
386
387
    int scan_and_statistics_tmp_rowsets();
388
389
    int scan_and_statistics_abort_timeout_txn();
390
391
    int scan_and_statistics_expired_txn_label();
392
393
    int scan_and_statistics_copy_jobs();
394
395
    int scan_and_statistics_stage();
396
397
    int scan_and_statistics_expired_stage_objects();
398
399
    int scan_and_statistics_versions();
400
401
    int scan_and_statistics_restore_jobs();
402
403
    /**
404
     * Decode the key of a packed-file metadata record into the persisted object path.
405
     *
406
     * @param key raw key persisted in txn-kv
407
     * @param packed_path output object storage path referenced by the key
408
     * @return true if decoding succeeds, false otherwise
409
     */
410
    static bool decode_packed_file_key(std::string_view key, std::string* packed_path);
411
412
29
    void TEST_add_accessor(std::string_view id, std::shared_ptr<StorageVaultAccessor> accessor) {
413
29
        accessor_map_.insert({std::string(id), std::move(accessor)});
414
29
    }
415
416
    // Recycle snapshot meta and data, return 0 for success otherwise error.
417
    int recycle_snapshot_meta_and_data(const std::string& resource_id,
418
                                       Versionstamp snapshot_version,
419
                                       const SnapshotPB& snapshot_pb);
420
421
private:
422
    // returns 0 for success otherwise error
423
    int init_obj_store_accessors();
424
425
    // returns 0 for success otherwise error
426
    int init_storage_vault_accessors();
427
428
    /**
429
     * Scan key-value pairs between [`begin`, `end`), and perform `recycle_func` on each key-value pair.
430
     *
431
     * @param recycle_func defines how to recycle resources corresponding to a key-value pair. Returns 0 if the recycling is successful.
432
     * @param loop_done is called after `RangeGetIterator` has no next kv. Usually used to perform a batch recycling. Returns 0 if success. 
433
     * @return 0 if all corresponding resources are recycled successfully, otherwise non-zero
434
     */
435
    int scan_and_recycle(std::string begin, std::string_view end,
436
                         std::function<int(std::string_view k, std::string_view v)> recycle_func,
437
                         std::function<int()> loop_done = nullptr);
438
439
    // return 0 for success otherwise error
440
    int delete_rowset_data(const doris::RowsetMetaCloudPB& rs_meta_pb);
441
442
    // return 0 for success otherwise error
443
    // NOTE: this function ONLY be called when the file paths cannot be calculated
444
    int delete_rowset_data(const std::string& resource_id, int64_t tablet_id,
445
                           const std::string& rowset_id);
446
447
    // return 0 for success otherwise error
448
    int delete_rowset_data(const std::map<std::string, doris::RowsetMetaCloudPB>& rowsets,
449
                           RowsetRecyclingState type, RecyclerMetricsContext& metrics_context);
450
451
    // Decrement packed file ref counts for rowset segments.
452
    // Returns 0 for success, -1 for error.
453
    int decrement_packed_file_ref_counts(const doris::RowsetMetaCloudPB& rs_meta_pb);
454
455
    // Decrement packed file ref count for delete bitmap if it's stored in packed file.
456
    // Returns 0 for success, -1 for error.
457
    // If delete bitmap is not stored in packed file, this function does nothing and returns 0.
458
    // out_is_packed: if not null, will be set to true if delete bitmap is stored in packed file.
459
    int decrement_delete_bitmap_packed_file_ref_counts(int64_t tablet_id,
460
                                                       const std::string& rowset_id,
461
                                                       bool* out_is_packed);
462
463
    int delete_packed_file_and_kv(const std::string& packed_file_path,
464
                                  const std::string& packed_key,
465
                                  const cloud::PackedFileInfoPB& packed_info);
466
467
    /**
468
     * Get stage storage info from instance and init StorageVaultAccessor
469
     * @return 0 if accessor is successfully inited, 1 if stage not found, negative for error
470
     */
471
    int init_copy_job_accessor(const std::string& stage_id, const StagePB::StageType& stage_type,
472
                               std::shared_ptr<StorageVaultAccessor>* accessor);
473
474
    void register_recycle_task(const std::string& task_name, int64_t start_time);
475
476
    void unregister_recycle_task(const std::string& task_name);
477
478
    // for scan all tablets and statistics metrics
479
    int scan_tablets_and_statistics(int64_t tablet_id, int64_t index_id,
480
                                    RecyclerMetricsContext& metrics_context,
481
                                    int64_t partition_id = -1, bool is_empty_tablet = false);
482
483
    // for scan all rs of tablet and statistics metrics
484
    int scan_tablet_and_statistics(int64_t tablet_id, RecyclerMetricsContext& metrics_context);
485
486
    // Recycle operation log and the log keys. The log keys are specified by `raw_keys`.
487
    //
488
    // Both `operation_log` and `raw_keys` will be removed in the same transaction, to ensure atomicity.
489
    int recycle_operation_log(Versionstamp log_version, const std::vector<std::string>& raw_keys,
490
                              OperationLogPB operation_log);
491
492
    // Recycle rowset meta and data, return 0 for success otherwise error
493
    //
494
    // Both recycle_rowset_key and non_versioned_rowset_key will be removed in the same transaction.
495
    //
496
    // This function will decrease the rowset ref count and remove the rowset meta and data if the ref count is 1.
497
    int recycle_rowset_meta_and_data(std::string_view recycle_rowset_key,
498
                                     const RowsetMetaCloudPB& rowset_meta,
499
                                     std::string_view non_versioned_rowset_key = "");
500
501
    // Classify rowset task by ref_count, return 0 to add to batch delete, 1 if handled (ref>1), -1 on error
502
    int classify_rowset_task_by_ref_count(RowsetDeleteTask& task,
503
                                          std::vector<RowsetDeleteTask>& batch_delete_tasks);
504
505
    // Cleanup metadata for deleted rowsets, return 0 for success otherwise error
506
    int cleanup_rowset_metadata(const std::vector<RowsetDeleteTask>& tasks);
507
508
    // Whether the instance has any snapshots, return 0 for success otherwise error.
509
    int has_cluster_snapshots(bool* any);
510
511
    // Whether need to recycle versioned keys
512
    bool should_recycle_versioned_keys() const;
513
    /**
514
     * Parse the path of a packed-file fragment and output the owning tablet and rowset identifiers.
515
     *
516
     * @param path packed-file fragment path to decode
517
     * @param tablet_id output tablet identifier extracted from the path
518
     * @param rowset_id output rowset identifier extracted from the path
519
     * @return true if both identifiers are successfully parsed, false otherwise
520
     */
521
    static bool parse_packed_slice_path(std::string_view path, int64_t* tablet_id,
522
                                        std::string* rowset_id);
523
    // Check whether a rowset referenced by a packed file still exists in metadata.
524
    // @param stats optional recycle statistics collector.
525
    int check_rowset_exists(int64_t tablet_id, const std::string& rowset_id, bool* exists,
526
                            PackedFileRecycleStats* stats = nullptr);
527
    int check_recycle_and_tmp_rowset_exists(int64_t tablet_id, const std::string& rowset_id,
528
                                            int64_t txn_id, bool* recycle_exists, bool* tmp_exists);
529
    /**
530
     * Resolve which storage accessor should be used for a packed file.
531
     *
532
     * @param hint preferred storage resource identifier persisted with the file
533
     * @return pair of the resolved resource identifier and accessor; the accessor can be null if unavailable
534
     */
535
    std::pair<std::string, std::shared_ptr<StorageVaultAccessor>> resolve_packed_file_accessor(
536
            const std::string& hint);
537
    // Recompute packed-file counters and lifecycle state after validating contained fragments.
538
    // @param stats optional recycle statistics collector.
539
    int correct_packed_file_info(cloud::PackedFileInfoPB* packed_info, bool* changed,
540
                                 const std::string& packed_file_path,
541
                                 PackedFileRecycleStats* stats = nullptr);
542
    // Correct and recycle a single packed-file record, updating metadata and accounting statistics.
543
    // @param stats optional recycle statistics collector.
544
    int process_single_packed_file(const std::string& packed_key,
545
                                   const std::string& packed_file_path,
546
                                   PackedFileRecycleStats* stats);
547
    // Process a packed-file KV while scanning and aggregate recycling statistics.
548
    int handle_packed_file_kv(std::string_view key, std::string_view value,
549
                              PackedFileRecycleStats* stats, int* ret);
550
551
    // Abort the transaction/job associated with a rowset that is about to be recycled.
552
    // This function is called during rowset recycling to prevent data loss by ensuring that
553
    // the transaction/job cannot be committed after its rowset data has been deleted.
554
    //
555
    // Scenario:
556
    // When recycler detects an expired prepared rowset (e.g., from a failed load transaction/job),
557
    // it needs to recycle the rowset data. However, if the transaction/job is still active and gets
558
    // committed after the data is deleted, it would lead to data loss - the transaction/job would
559
    // reference non-existent data.
560
    //
561
    // Solution:
562
    // Before recycling the rowset data, this function aborts the associated transaction/job to ensure
563
    // it cannot be committed. This guarantees that:
564
    // 1. The transaction/job state is marked as ABORTED
565
    // 2. Any subsequent commit_rowset/commit_txn attempts will fail
566
    // 3. The rowset data can be safely deleted without risk of data loss
567
    //
568
    // Parameters:
569
    //   txn_id: The transaction/job ID associated with the rowset to be recycled
570
    //
571
    // Returns:
572
    //   0 on success, -1 on failure
573
    int abort_txn_for_related_rowset(int64_t txn_id);
574
    int abort_job_for_related_rowset(const RowsetMetaCloudPB& rowset_meta);
575
576
    template <typename T>
577
    int abort_txn_or_job_for_recycle(T& rowset_meta_pb);
578
579
private:
580
    std::atomic_bool stopped_ {false};
581
    std::shared_ptr<TxnKv> txn_kv_;
582
    std::string instance_id_;
583
    InstanceInfoPB instance_info_;
584
585
    // TODO(plat1ko): Add new accessor to map in runtime for new created storage vaults
586
    std::unordered_map<std::string, std::shared_ptr<StorageVaultAccessor>> accessor_map_;
587
    using InvertedIndexInfo =
588
            std::pair<InvertedIndexStorageFormatPB, std::vector<std::pair<int64_t, std::string>>>;
589
590
    class InvertedIndexIdCache;
591
    std::unique_ptr<InvertedIndexIdCache> inverted_index_id_cache_;
592
593
    std::mutex recycled_tablets_mtx_;
594
    // Store recycled tablets, we can skip deleting rowset data of these tablets because these data has already been deleted.
595
    std::unordered_set<int64_t> recycled_tablets_;
596
597
    std::mutex recycle_tasks_mutex;
598
    // <task_name, start_time>>
599
    std::map<std::string, int64_t> running_recycle_tasks;
600
601
    RecyclerThreadPoolGroup _thread_pool_group;
602
603
    std::shared_ptr<TxnLazyCommitter> txn_lazy_committer_;
604
    std::shared_ptr<SnapshotManager> snapshot_manager_;
605
    std::shared_ptr<DeleteBitmapLockWhiteList> delete_bitmap_lock_white_list_;
606
    std::shared_ptr<ResourceManager> resource_mgr_;
607
608
    TabletRecyclerMetricsContext tablet_metrics_context_;
609
    SegmentRecyclerMetricsContext segment_metrics_context_;
610
};
611
612
struct OperationLogReferenceInfo {
613
    bool referenced_by_instance = false;
614
    bool referenced_by_snapshot = false;
615
    Versionstamp referenced_snapshot_timestamp;
616
};
617
618
// Helper class to check if operation logs can be recycled based on snapshots and versionstamps
619
class OperationLogRecycleChecker {
620
public:
621
    OperationLogRecycleChecker(std::string_view instance_id, TxnKv* txn_kv,
622
                               const InstanceInfoPB& instance_info)
623
27
            : instance_id_(instance_id), txn_kv_(txn_kv), instance_info_(instance_info) {}
624
625
    // Initialize the checker by loading snapshots and setting max version stamp
626
    int init();
627
628
    // Check if an operation log can be recycled
629
    bool can_recycle(const Versionstamp& log_versionstamp, int64_t log_min_timestamp,
630
                     OperationLogReferenceInfo* reference_info) const;
631
632
0
    Versionstamp max_versionstamp() const { return max_versionstamp_; }
633
634
23
    const std::vector<std::pair<SnapshotPB, Versionstamp>>& get_snapshots() const {
635
23
        return snapshots_;
636
23
    }
637
638
private:
639
    std::string_view instance_id_;
640
    TxnKv* txn_kv_;
641
    const InstanceInfoPB& instance_info_;
642
    Versionstamp max_versionstamp_;
643
    Versionstamp source_snapshot_versionstamp_;
644
    std::map<Versionstamp, size_t> snapshot_indexes_;
645
    std::vector<std::pair<SnapshotPB, Versionstamp>> snapshots_;
646
};
647
648
class SnapshotDataSizeCalculator {
649
public:
650
    SnapshotDataSizeCalculator(std::string_view instance_id, std::shared_ptr<TxnKv> txn_kv)
651
24
            : instance_id_(instance_id), txn_kv_(std::move(txn_kv)) {}
652
653
    void init(const std::vector<std::pair<SnapshotPB, Versionstamp>>& snapshots);
654
655
    int calculate_operation_log_data_size(const std::string_view& log_key,
656
                                          OperationLogPB& operation_log,
657
                                          OperationLogReferenceInfo& reference_info);
658
659
    int save_snapshot_data_size_with_retry();
660
661
private:
662
    int get_all_index_partitions(int64_t db_id, int64_t table_id, int64_t index_id,
663
                                 std::vector<int64_t>* partition_ids);
664
    int get_index_partition_data_size(int64_t db_id, int64_t table_id, int64_t index_id,
665
                                      int64_t partition_id, int64_t* data_size);
666
    int save_operation_log(const std::string_view& log_key, OperationLogPB& operation_log);
667
    int save_snapshot_data_size();
668
669
    std::string_view instance_id_;
670
    std::shared_ptr<TxnKv> txn_kv_;
671
672
    int64_t instance_retained_data_size_ = 0;
673
    std::map<Versionstamp, int64_t> retained_data_size_;
674
    std::set<std::string> calculated_partitions_;
675
};
676
677
} // namespace doris::cloud