Coverage Report

Created: 2026-03-09 22:06

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