Coverage Report

Created: 2026-08-14 22:15

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