Coverage Report

Created: 2026-07-14 19:27

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