Coverage Report

Created: 2026-07-16 15:49

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