Coverage Report

Created: 2026-08-25 11:49

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