Coverage Report

Created: 2026-08-11 15:19

/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
318
    ~RecyclerThreadPoolGroup() = default;
74
142
    RecyclerThreadPoolGroup(const RecyclerThreadPoolGroup&) = default;
75
    RecyclerThreadPoolGroup& operator=(RecyclerThreadPoolGroup& other) = default;
76
14
    RecyclerThreadPoolGroup& operator=(RecyclerThreadPoolGroup&& other) = default;
77
147
    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
3.86k
    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
595
            : operation_type(std::move(operation_type)), instance_id(std::move(instance_id)) {
158
595
        start();
159
595
    }
160
161
606
    ~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
596
    void start() {
175
596
        start_time = duration_cast<std::chrono::milliseconds>(
176
596
                             std::chrono::system_clock::now().time_since_epoch())
177
596
                             .count();
178
596
    }
179
180
305
    double duration() const {
181
305
        return duration_cast<std::chrono::milliseconds>(
182
305
                       std::chrono::system_clock::now().time_since_epoch())
183
305
                       .count() -
184
305
               start_time;
185
305
    }
186
187
20
    void reset() {
188
20
        total_need_recycle_data_size = 0;
189
20
        total_need_recycle_num = 0;
190
20
        total_recycled_data_size = 0;
191
20
        total_recycled_num = 0;
192
20
        start_time = duration_cast<std::chrono::milliseconds>(
193
20
                             std::chrono::system_clock::now().time_since_epoch())
194
20
                             .count();
195
20
    }
196
197
305
    void finish_report() {
198
305
        if (!operation_type.empty()) {
199
305
            double cost = duration();
200
305
            g_bvar_recycler_instance_last_round_recycle_elpased_ts.put(
201
305
                    {instance_id, operation_type}, cost);
202
305
            g_bvar_recycler_instance_recycle_round.put({instance_id, operation_type}, 1);
203
305
            g_bvar_recycler_instance_recycle_total_bytes_since_started.put(
204
305
                    {instance_id, operation_type}, total_recycled_data_size.load());
205
305
            g_bvar_recycler_instance_recycle_total_num_since_started.put(
206
305
                    {instance_id, operation_type}, total_recycled_num.load());
207
305
            LOG(INFO) << "recycle instance: " << instance_id
208
305
                      << ", operation type: " << operation_type << ", cost: " << cost
209
305
                      << " ms, total recycled num: " << total_recycled_num.load()
210
305
                      << ", total recycled data size: " << total_recycled_data_size.load()
211
305
                      << " bytes";
212
305
            if (cost != 0) {
213
268
                if (total_recycled_num.load() != 0) {
214
72
                    g_bvar_recycler_instance_recycle_time_per_resource.put(
215
72
                            {instance_id, operation_type}, cost / total_recycled_num.load());
216
72
                }
217
268
                g_bvar_recycler_instance_recycle_bytes_per_ms.put(
218
268
                        {instance_id, operation_type}, total_recycled_data_size.load() / cost);
219
268
            }
220
305
        }
221
305
    }
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.13k
            } else {
235
1.13k
                g_bvar_recycler_instance_last_round_recycled_bytes.put(
236
1.13k
                        {instance_id, operation_type}, total_recycled_data_size.load());
237
1.13k
                g_bvar_recycler_instance_last_round_recycled_num.put({instance_id, operation_type},
238
1.13k
                                                                     total_recycled_num.load());
239
1.13k
            }
240
1.14k
        }
241
1.17k
    }
242
};
243
244
class TabletRecyclerMetricsContext : public RecyclerMetricsContext {
245
public:
246
147
    TabletRecyclerMetricsContext() : RecyclerMetricsContext("global_recycler", "recycle_tablet") {}
247
};
248
249
class SegmentRecyclerMetricsContext : public RecyclerMetricsContext {
250
public:
251
    SegmentRecyclerMetricsContext()
252
147
            : 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
5
    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
57
    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
    // scan and recycle expired indexes:
292
    // 1. dropped table, dropped mv
293
    // 2. half-successtable/index when create
294
    // returns 0 for success otherwise error
295
    int recycle_indexes();
296
297
    // scan and recycle expired partitions:
298
    // 1. dropped parttion
299
    // 2. half-success partition when create
300
    // returns 0 for success otherwise error
301
    int recycle_partitions();
302
303
    // scan and recycle expired rowsets:
304
    // 1. prepare_rowset will produce recycle_rowset before uploading data to remote storage (memo)
305
    // 2. compaction will change the input rowsets to recycle_rowset
306
    // returns 0 for success otherwise error
307
    int recycle_rowsets();
308
309
    // like `recycle_rowsets`, but for versioned rowsets.
310
    int recycle_versioned_rowsets();
311
312
    // scan and recycle expired tmp rowsets:
313
    // 1. commit_rowset will produce tmp_rowset when finish upload data (load or compaction) to remote storage
314
    // returns 0 for success otherwise error
315
    int recycle_tmp_rowsets();
316
317
    /**
318
     * recycle all tablets belonging to the index specified by `index_id`
319
     *
320
     * @param partition_id if positive, only recycle tablets in this partition belonging to the specified index
321
     * @return 0 for success otherwise error
322
     */
323
    int recycle_tablets(int64_t table_id, int64_t index_id, RecyclerMetricsContext& ctx,
324
                        int64_t partition_id = -1);
325
326
    /**
327
     * recycle all rowsets belonging to the tablet specified by `tablet_id`
328
     *
329
     * @return 0 for success otherwise error
330
     */
331
    int recycle_tablet(int64_t tablet_id, RecyclerMetricsContext& metrics_context);
332
333
    /**
334
     * like `recycle_tablet`, but for versioned tablet
335
     */
336
    int recycle_versioned_tablet(int64_t tablet_id, RecyclerMetricsContext& metrics_context);
337
338
    // scan and recycle useless partition version kv
339
    int recycle_versions();
340
341
    // scan and recycle the orphan partitions
342
    int recycle_orphan_partitions();
343
344
    // scan and abort timeout txn label
345
    // returns 0 for success otherwise error
346
    int abort_timeout_txn();
347
348
    //scan and recycle expire txn label
349
    // returns 0 for success otherwise error
350
    int recycle_expired_txn_label();
351
352
    // scan and recycle finished or timeout copy jobs
353
    // returns 0 for success otherwise error
354
    int recycle_copy_jobs();
355
356
    // scan and recycle dropped internal stage
357
    // returns 0 for success otherwise error
358
    int recycle_stage();
359
360
    // scan and recycle expired stage objects
361
    // returns 0 for success otherwise error
362
    int recycle_expired_stage_objects();
363
364
    // scan and recycle operation logs
365
    // returns 0 for success otherwise error
366
    int recycle_operation_logs();
367
368
    // scan and recycle expired restore jobs
369
    // returns 0 for success otherwise error
370
    int recycle_restore_jobs();
371
372
    /**
373
     * Scan packed-file metadata, correct reference counters, and recycle unused packed files.
374
     *
375
     * @return 0 on success, non-zero error code otherwise
376
     */
377
    int recycle_packed_files();
378
379
    // scan and recycle snapshots
380
    // returns 0 for success otherwise error
381
    int recycle_cluster_snapshots();
382
383
    // scan and recycle ref rowsets for deleted instance
384
    // returns 0 for success otherwise error
385
    int recycle_ref_rowsets(bool* has_unrecycled_rowsets);
386
387
    bool check_recycle_tasks();
388
389
    int scan_and_statistics_indexes();
390
391
    int scan_and_statistics_partitions();
392
393
    int scan_and_statistics_rowsets();
394
395
    int scan_and_statistics_tmp_rowsets();
396
397
    int scan_and_statistics_abort_timeout_txn();
398
399
    int scan_and_statistics_expired_txn_label();
400
401
    int scan_and_statistics_copy_jobs();
402
403
    int scan_and_statistics_stage();
404
405
    int scan_and_statistics_expired_stage_objects();
406
407
    int scan_and_statistics_versions();
408
409
    int scan_and_statistics_restore_jobs();
410
411
    void scan_and_statistics_operation_logs();
412
413
    /**
414
     * Decode the key of a packed-file metadata record into the persisted object path.
415
     *
416
     * @param key raw key persisted in txn-kv
417
     * @param packed_path output object storage path referenced by the key
418
     * @return true if decoding succeeds, false otherwise
419
     */
420
    static bool decode_packed_file_key(std::string_view key, std::string* packed_path);
421
422
30
    void TEST_add_accessor(std::string_view id, std::shared_ptr<StorageVaultAccessor> accessor) {
423
30
        accessor_map_.insert({std::string(id), std::move(accessor)});
424
30
    }
425
426
    // Recycle snapshot meta and data, return 0 for success otherwise error.
427
    int recycle_snapshot_meta_and_data(const std::string& instance_id,
428
                                       const std::string& resource_id,
429
                                       Versionstamp snapshot_version,
430
                                       const SnapshotPB& snapshot_pb);
431
432
private:
433
    // returns 0 for success otherwise error
434
    int init_obj_store_accessors();
435
436
    // returns 0 for success otherwise error
437
    int init_storage_vault_accessors();
438
439
    int recycle_stream(int64_t stream_id, const RecycleIndexPB& recycle_index,
440
                       std::string_view recycle_key);
441
442
    int recycle_table_stream_offset_prefix(std::string prefix,
443
                                           RecyclerMetricsContext* metrics_context);
444
445
    int finalize_recycle_stream(int64_t stream_id, const RecycleIndexPB& recycle_index,
446
                                std::string_view recycle_key);
447
448
    int recycle_partition_table_stream_offsets(
449
            int64_t db_id, int64_t table_id, int64_t partition_id,
450
            const google::protobuf::RepeatedPtrField<TableStreamIdentityPB>& table_streams);
451
452
    /**
453
     * Scan key-value pairs between [`begin`, `end`) with multiple rounds of range get(`RangeGetIterator`),
454
     * and perform `recycle_func` on each key-value pair.
455
     *
456
     * @param recycle_func defines how to recycle resources corresponding to a key-value pair.
457
     *                     The scan will stop if recycle_func() returns non-zero.
458
     *                     recycle_func() returns 0 if the recycling is successful or the scan can continue with ignorable errors.
459
     * @param loop_done is called after a round (`RangeGetIterator`) in the scan has no next kv. Usually used to perform a batch recycling.
460
     *                  The scan will stop if loop_done() returns non-zero.
461
     *                  loop_done() returns 0 if the recycling is successful or the scan can continue with ignorable errors.
462
     * @return 0 if all corresponding resources are recycled successfully, otherwise non-zero
463
     */
464
    int scan_and_recycle(std::string begin, std::string_view end,
465
                         std::function<int(std::string_view k, std::string_view v)> recycle_func,
466
                         std::function<int()> loop_done = nullptr,
467
                         std::function<bool(std::string*)> next_begin_getter = nullptr);
468
469
    static int next_recycle_rowset_tablet_key(const std::string& instance_id, int64_t tablet_id,
470
                                              std::string* next_key);
471
472
    int scan_recycle_rowsets_by_tablet(
473
            std::string begin, std::string_view end,
474
            std::function<int(std::string_view k, std::string_view v)> recycle_func,
475
            std::function<int()> loop_done = nullptr);
476
477
    // return 0 for success otherwise error
478
    int delete_rowset_data(const doris::RowsetMetaCloudPB& rs_meta_pb);
479
480
    // return 0 for success otherwise error
481
    // NOTE: this function ONLY be called when the file paths cannot be calculated
482
    int delete_rowset_data(const std::string& resource_id, int64_t tablet_id,
483
                           const std::string& rowset_id);
484
485
    // return 0 for success otherwise error
486
    int delete_rowset_data(const std::map<std::string, doris::RowsetMetaCloudPB>& rowsets,
487
                           RowsetRecyclingState type, RecyclerMetricsContext& metrics_context);
488
489
    // Decrement packed file ref counts for rowset segments.
490
    // Returns 0 for success, -1 for error.
491
    int decrement_packed_file_ref_counts(const doris::RowsetMetaCloudPB& rs_meta_pb);
492
493
    enum class DeleteBitmapStorageType {
494
        NOT_FOUND,
495
        IN_FDB,
496
        STANDALONE_FILE,
497
        PACKED_FILE,
498
    };
499
500
    // Process delete bitmap storage and decrement packed file ref count when needed.
501
    // Returns 0 for success, -1 for error.
502
    // out_storage_type: if not null, will be set to the delete bitmap storage type.
503
    int decrement_delete_bitmap_packed_file_ref_counts(int64_t tablet_id,
504
                                                       const std::string& rowset_id,
505
                                                       DeleteBitmapStorageType* out_storage_type);
506
507
    int delete_packed_file_and_kv(const std::string& packed_file_path,
508
                                  const std::string& packed_key,
509
                                  const cloud::PackedFileInfoPB& packed_info);
510
511
    /**
512
     * Get stage storage info from instance and init StorageVaultAccessor
513
     * @return 0 if accessor is successfully inited, 1 if stage not found, negative for error
514
     */
515
    int init_copy_job_accessor(const std::string& stage_id, const StagePB::StageType& stage_type,
516
                               std::shared_ptr<StorageVaultAccessor>* accessor);
517
518
    void register_recycle_task(const std::string& task_name, int64_t start_time);
519
520
    void unregister_recycle_task(const std::string& task_name);
521
522
    // for scan all tablets and statistics metrics
523
    int scan_tablets_and_statistics(int64_t tablet_id, int64_t index_id,
524
                                    RecyclerMetricsContext& metrics_context,
525
                                    int64_t partition_id = -1, bool is_empty_tablet = false);
526
527
    // for scan all rs of tablet and statistics metrics
528
    int scan_tablet_and_statistics(int64_t tablet_id, RecyclerMetricsContext& metrics_context);
529
530
    // Recycle operation log and the log keys. The log keys are specified by `raw_keys`.
531
    //
532
    // Both `operation_log` and `raw_keys` will be removed in the same transaction, to ensure atomicity.
533
    int recycle_operation_log(Versionstamp log_version, const std::vector<std::string>& raw_keys,
534
                              OperationLogPB operation_log,
535
                              OplogRecycleStats* oplog_stats = nullptr);
536
537
    // Recycle rowset meta and data, return 0 for success otherwise error
538
    //
539
    // This function will decrease the rowset ref count and remove the rowset meta and data if the ref count is 1.
540
    int recycle_rowset_meta_and_data(const RowsetDeleteTask& task);
541
542
    // Classify rowset task by ref_count, return 0 to add to batch delete, 1 if handled (ref>1), -1 on error
543
    int classify_rowset_task_by_ref_count(RowsetDeleteTask& task,
544
                                          std::vector<RowsetDeleteTask>& batch_delete_tasks);
545
546
    // Cleanup metadata for deleted rowsets, return 0 for success otherwise error
547
    int cleanup_rowset_metadata(const std::vector<RowsetDeleteTask>& tasks);
548
549
    // Whether the instance has any snapshots, return 0 for success otherwise error.
550
    int has_cluster_snapshots(bool* any);
551
552
    // Whether need to recycle versioned keys
553
    bool should_recycle_versioned_keys() const;
554
555
    /**
556
     * Parse the path of a packed-file fragment and output the owning tablet and rowset identifiers.
557
     *
558
     * @param path packed-file fragment path to decode
559
     * @param tablet_id output tablet identifier extracted from the path
560
     * @param rowset_id output rowset identifier extracted from the path
561
     * @return true if both identifiers are successfully parsed, false otherwise
562
     */
563
    static bool parse_packed_slice_path(std::string_view path, int64_t* tablet_id,
564
                                        std::string* rowset_id);
565
    // Check whether a rowset referenced by a packed file still exists in metadata.
566
    // @param stats optional recycle statistics collector.
567
    int check_rowset_exists(int64_t tablet_id, const std::string& rowset_id, bool* exists,
568
                            PackedFileRecycleStats* stats = nullptr);
569
    int check_recycle_and_tmp_rowset_exists(int64_t tablet_id, const std::string& rowset_id,
570
                                            int64_t txn_id, bool* recycle_exists, bool* tmp_exists);
571
    /**
572
     * Resolve which storage accessor should be used for a packed file.
573
     *
574
     * @param hint preferred storage resource identifier persisted with the file
575
     * @return pair of the resolved resource identifier and accessor; the accessor can be null if unavailable
576
     */
577
    std::pair<std::string, std::shared_ptr<StorageVaultAccessor>> resolve_packed_file_accessor(
578
            const std::string& hint);
579
    // Recompute packed-file counters and lifecycle state after validating contained fragments.
580
    // @param stats optional recycle statistics collector.
581
    int correct_packed_file_info(cloud::PackedFileInfoPB* packed_info, bool* changed,
582
                                 const std::string& packed_file_path,
583
                                 PackedFileRecycleStats* stats = nullptr);
584
    // Correct and recycle a single packed-file record, updating metadata and accounting statistics.
585
    // @param stats optional recycle statistics collector.
586
    int process_single_packed_file(const std::string& packed_key,
587
                                   const std::string& packed_file_path,
588
                                   PackedFileRecycleStats* stats);
589
    // Process a packed-file KV while scanning and aggregate recycling statistics.
590
    int handle_packed_file_kv(std::string_view key, std::string_view value,
591
                              PackedFileRecycleStats* stats, int* ret);
592
593
    // Abort the transaction/job associated with a rowset that is about to be recycled.
594
    // This function is called during rowset recycling to prevent data loss by ensuring that
595
    // the transaction/job cannot be committed after its rowset data has been deleted.
596
    //
597
    // Scenario:
598
    // When recycler detects an expired prepared rowset (e.g., from a failed load transaction/job),
599
    // it needs to recycle the rowset data. However, if the transaction/job is still active and gets
600
    // committed after the data is deleted, it would lead to data loss - the transaction/job would
601
    // reference non-existent data.
602
    //
603
    // Solution:
604
    // Before recycling the rowset data, this function aborts the associated transaction/job to ensure
605
    // it cannot be committed. This guarantees that:
606
    // 1. The transaction/job state is marked as ABORTED
607
    // 2. Any subsequent commit_rowset/commit_txn attempts will fail
608
    // 3. The rowset data can be safely deleted without risk of data loss
609
    //
610
    // Parameters:
611
    //   txn_id: The transaction/job ID associated with the rowset to be recycled
612
    //
613
    // Returns:
614
    //   0 on success, -1 on failure
615
    int abort_txn_for_related_rowset(int64_t txn_id);
616
    int abort_job_for_related_rowset(const RowsetMetaCloudPB& rowset_meta);
617
618
    template <typename T>
619
    int batch_abort_txn_or_job_for_recycle(const std::vector<std::string>& keys,
620
                                           bool skip_base_version);
621
622
private:
623
    std::atomic_bool stopped_ {false};
624
    std::shared_ptr<TxnKv> txn_kv_;
625
    std::string instance_id_;
626
    InstanceInfoPB instance_info_;
627
628
    // TODO(plat1ko): Add new accessor to map in runtime for new created storage vaults
629
    std::unordered_map<std::string, std::shared_ptr<StorageVaultAccessor>> accessor_map_;
630
    using InvertedIndexInfo =
631
            std::pair<InvertedIndexStorageFormatPB, std::vector<std::pair<int64_t, std::string>>>;
632
633
    class InvertedIndexIdCache;
634
    std::unique_ptr<InvertedIndexIdCache> inverted_index_id_cache_;
635
636
    std::mutex recycled_tablets_mtx_;
637
    // Store recycled tablets, we can skip deleting rowset data of these tablets because these data has already been deleted.
638
    std::unordered_set<int64_t> recycled_tablets_;
639
640
    std::mutex recycle_tasks_mutex;
641
    // <task_name, start_time>>
642
    std::map<std::string, int64_t> running_recycle_tasks;
643
644
    RecyclerThreadPoolGroup _thread_pool_group;
645
646
    std::shared_ptr<TxnLazyCommitter> txn_lazy_committer_;
647
    std::shared_ptr<SnapshotManager> snapshot_manager_;
648
    std::shared_ptr<DeleteBitmapLockWhiteList> delete_bitmap_lock_white_list_;
649
    std::shared_ptr<ResourceManager> resource_mgr_;
650
651
    TabletRecyclerMetricsContext tablet_metrics_context_;
652
    SegmentRecyclerMetricsContext segment_metrics_context_;
653
};
654
655
struct OperationLogReferenceInfo {
656
    bool referenced_by_instance = false;
657
    bool referenced_by_snapshot = false;
658
    Versionstamp referenced_snapshot_timestamp;
659
};
660
661
struct OplogRecycleStats {
662
    // Total oplog count scanned per round
663
    std::atomic<int64_t> total_num {0};
664
    // Oplogs not recycled this round (per round, written to mBvarStatus)
665
    std::atomic<int64_t> not_recycled_num {0};
666
    // Recycle failures (per round, accumulated to mBvarIntAdder at end)
667
    std::atomic<int64_t> failed_num {0};
668
    // Per-oplog-type recycled counts (incremented after successful commit)
669
    std::atomic<int64_t> recycled_commit_partition {0};
670
    std::atomic<int64_t> recycled_drop_partition {0};
671
    std::atomic<int64_t> recycled_commit_index {0};
672
    std::atomic<int64_t> recycled_drop_index {0};
673
    std::atomic<int64_t> recycled_update_tablet {0};
674
    std::atomic<int64_t> recycled_compaction {0};
675
    std::atomic<int64_t> recycled_schema_change {0};
676
    std::atomic<int64_t> recycled_commit_txn {0};
677
};
678
679
// Helper class to check if operation logs can be recycled based on snapshots and versionstamps
680
class OperationLogRecycleChecker {
681
public:
682
    OperationLogRecycleChecker(std::string_view instance_id, TxnKv* txn_kv,
683
                               const InstanceInfoPB& instance_info)
684
36
            : instance_id_(instance_id), txn_kv_(txn_kv), instance_info_(instance_info) {}
685
686
    // Initialize the checker by loading snapshots and setting max version stamp
687
    int init();
688
689
    // Check if an operation log can be recycled
690
    bool can_recycle(const Versionstamp& log_versionstamp, int64_t log_min_timestamp,
691
                     OperationLogReferenceInfo* reference_info) const;
692
693
0
    Versionstamp max_versionstamp() const { return max_versionstamp_; }
694
695
29
    const std::vector<std::pair<SnapshotPB, Versionstamp>>& get_snapshots() const {
696
29
        return snapshots_;
697
29
    }
698
699
private:
700
    std::string_view instance_id_;
701
    TxnKv* txn_kv_;
702
    const InstanceInfoPB& instance_info_;
703
    Versionstamp max_versionstamp_;
704
    Versionstamp source_snapshot_versionstamp_;
705
    std::map<Versionstamp, size_t> snapshot_indexes_;
706
    std::vector<std::pair<SnapshotPB, Versionstamp>> snapshots_;
707
};
708
709
class SnapshotDataSizeCalculator {
710
public:
711
    SnapshotDataSizeCalculator(std::string_view instance_id, std::shared_ptr<TxnKv> txn_kv)
712
30
            : instance_id_(instance_id), txn_kv_(std::move(txn_kv)) {}
713
714
    void init(const std::vector<std::pair<SnapshotPB, Versionstamp>>& snapshots);
715
716
    int calculate_operation_log_data_size(const std::string_view& log_key,
717
                                          OperationLogPB& operation_log,
718
                                          OperationLogReferenceInfo& reference_info);
719
720
    int save_snapshot_data_size_with_retry();
721
722
private:
723
    int get_all_index_partitions(int64_t db_id, int64_t table_id, int64_t index_id,
724
                                 std::vector<int64_t>* partition_ids);
725
    int get_index_partition_data_size(int64_t db_id, int64_t table_id, int64_t index_id,
726
                                      int64_t partition_id, int64_t* data_size);
727
    int save_operation_log(const std::string_view& log_key, OperationLogPB& operation_log);
728
    int save_snapshot_data_size();
729
730
    std::string_view instance_id_;
731
    std::shared_ptr<TxnKv> txn_kv_;
732
733
    int64_t instance_retained_data_size_ = 0;
734
    std::map<Versionstamp, int64_t> retained_data_size_;
735
    std::set<std::string> calculated_partitions_;
736
};
737
738
} // namespace doris::cloud