Coverage Report

Created: 2026-06-09 22:29

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