Coverage Report

Created: 2026-07-06 09:38

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/io/cache/block_file_cache.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 <bvar/bvar.h>
21
#include <concurrentqueue.h>
22
23
#include <algorithm>
24
#include <array>
25
#include <atomic>
26
#include <boost/lockfree/spsc_queue.hpp>
27
#include <functional>
28
#include <limits>
29
#include <memory>
30
#include <mutex>
31
#include <optional>
32
#include <thread>
33
#include <unordered_map>
34
#include <vector>
35
36
#include "io/cache/block_file_cache_ttl_mgr.h"
37
#include "io/cache/cache_lru_dumper.h"
38
#include "io/cache/file_block.h"
39
#include "io/cache/file_cache_common.h"
40
#include "io/cache/file_cache_storage.h"
41
#include "io/cache/lru_queue_recorder.h"
42
#include "runtime/runtime_profile.h"
43
#include "util/threadpool.h"
44
45
namespace doris::io {
46
using RecycleFileCacheKeys = moodycamel::ConcurrentQueue<FileCacheKey>;
47
48
class LockScopedTimer {
49
public:
50
2.30M
    LockScopedTimer() : start_(std::chrono::steady_clock::now()) {}
51
2.30M
    ~LockScopedTimer() {
52
2.30M
        auto end = std::chrono::steady_clock::now();
53
2.30M
        auto duration_us =
54
2.30M
                std::chrono::duration_cast<std::chrono::microseconds>(end - start_).count();
55
2.30M
        if (duration_us > config::cache_lock_held_long_tail_threshold_us) {
56
0
            LOG(WARNING) << "Lock held time " << std::to_string(duration_us) << "us. "
57
0
                         << get_stack_trace();
58
0
        }
59
2.30M
    }
60
61
private:
62
    std::chrono::time_point<std::chrono::steady_clock> start_;
63
};
64
65
// Note: the cache_lock is scoped, so do not add do...while(0) here.
66
#define SCOPED_CACHE_LOCK(MUTEX, cache)                                                           \
67
2.28M
    std::chrono::time_point<std::chrono::steady_clock> start_time =                               \
68
2.28M
            std::chrono::steady_clock::now();                                                     \
69
2.28M
    std::lock_guard cache_lock(MUTEX);                                                            \
70
2.28M
    std::chrono::time_point<std::chrono::steady_clock> acq_time =                                 \
71
2.28M
            std::chrono::steady_clock::now();                                                     \
72
2.28M
    auto duration_us =                                                                            \
73
2.28M
            std::chrono::duration_cast<std::chrono::microseconds>(acq_time - start_time).count(); \
74
2.28M
    *(cache->_cache_lock_wait_time_us) << duration_us;                                            \
75
2.28M
    if (duration_us > config::cache_lock_wait_long_tail_threshold_us) {                           \
76
0
        LOG(WARNING) << "Lock wait time " << std::to_string(duration_us) << "us. "                \
77
0
                     << get_stack_trace() << std::endl;                                           \
78
0
    }                                                                                             \
79
2.28M
    LockScopedTimer cache_lock_timer;
80
81
class FSFileCacheStorage;
82
83
// NeedUpdateLRUBlocks keeps FileBlockSPtr entries that require LRU updates in a
84
// deduplicated, sharded container. Entries are keyed by the raw FileBlock
85
// pointer so that multiple shared_ptr copies of the same block are treated as a
86
// single pending update. The structure is thread-safe and optimized for high
87
// contention insert/drain workloads in the background update thread.
88
// Note that Blocks are updated in batch, internal order is not important.
89
class NeedUpdateLRUBlocks {
90
public:
91
264
    NeedUpdateLRUBlocks() = default;
92
93
    // Insert a block into the pending set. Returns true only when the block
94
    // was not already queued. Null inputs are ignored.
95
    bool insert(FileBlockSPtr block, size_t max_queue_size = std::numeric_limits<size_t>::max());
96
97
    // Drain up to `limit` unique blocks into `output`. The method returns how
98
    // many blocks were actually drained and shrinks the internal size
99
    // accordingly.
100
    size_t drain(size_t limit, std::vector<FileBlockSPtr>* output);
101
102
    // Remove every pending block from the structure and reset the size.
103
    void clear();
104
105
    // Thread-safe approximate size of queued unique blocks.
106
180k
    size_t size() const { return _size.load(std::memory_order_relaxed); }
107
108
private:
109
    static constexpr size_t kShardCount = 64;
110
    static constexpr size_t kShardMask = kShardCount - 1;
111
112
    struct Shard {
113
        std::mutex mutex;
114
        std::unordered_map<FileBlock*, FileBlockSPtr> entries;
115
    };
116
117
    size_t shard_index(FileBlock* ptr) const;
118
    void decrease_size(size_t delta);
119
120
    std::array<Shard, kShardCount> _shards;
121
    std::atomic<size_t> _size {0};
122
};
123
124
// The BlockFileCache is responsible for the management of the blocks
125
// The current strategies are lru and ttl.
126
127
struct FileBlockCell {
128
    friend class FileBlock;
129
130
    FileBlockSPtr file_block;
131
    /// Iterator is put here on first reservation attempt, if successful.
132
    std::optional<LRUQueue::Iterator> queue_iterator;
133
134
    mutable int64_t atime {0};
135
1.26M
    void update_atime() const {
136
1.26M
        atime = std::chrono::duration_cast<std::chrono::seconds>(
137
1.26M
                        std::chrono::steady_clock::now().time_since_epoch())
138
1.26M
                        .count();
139
1.26M
    }
140
141
    /// Pointer to file block is always hold by the cache itself.
142
    /// Apart from pointer in cache, it can be hold by cache users, when they call
143
    /// getorSet(), but cache users always hold it via FileBlocksHolder.
144
23.9M
    bool releasable() const {
145
23.9M
        return (file_block.use_count() == 1 ||
146
23.9M
                (file_block.use_count() == 2 && file_block->_owned_by_cached_reader));
147
23.9M
    }
148
149
25.5M
    size_t size() const { return file_block->_block_range.size(); }
150
151
    FileBlockCell() = default;
152
    FileBlockCell(FileBlockSPtr file_block, std::lock_guard<std::mutex>& cache_lock);
153
    FileBlockCell(FileBlockCell&& other) noexcept
154
904k
            : file_block(std::move(other.file_block)),
155
904k
              queue_iterator(other.queue_iterator),
156
904k
              atime(other.atime) {
157
904k
        file_block->cell = this;
158
904k
    }
159
160
    FileBlockCell& operator=(const FileBlockCell&) = delete;
161
    FileBlockCell(const FileBlockCell&) = delete;
162
163
0
    size_t dowloading_size() const { return file_block->_downloaded_size; }
164
};
165
166
class BlockFileCache {
167
    friend class FSFileCacheStorage;
168
    friend class MemFileCacheStorage;
169
    friend class FileBlock;
170
    friend struct FileBlocksHolder;
171
    friend class CacheLRUDumper;
172
    friend class LRUQueueRecorder;
173
    friend struct FileBlockCell;
174
    friend class BlockFileCacheTest;
175
176
public:
177
    // hash the file_name to uint128
178
    static UInt128Wrapper hash(const std::string& path);
179
180
    BlockFileCache(const std::string& cache_base_path, const FileCacheSettings& cache_settings);
181
182
256
    virtual ~BlockFileCache() {
183
256
        {
184
256
            std::lock_guard lock(_close_mtx);
185
256
            _close = true;
186
256
        }
187
256
        _close_cv.notify_all();
188
256
        if (_cache_background_monitor_thread.joinable()) {
189
227
            _cache_background_monitor_thread.join();
190
227
        }
191
256
        if (_cache_background_gc_thread.joinable()) {
192
227
            _cache_background_gc_thread.join();
193
227
        }
194
256
        if (_cache_background_evict_in_advance_thread.joinable()) {
195
227
            _cache_background_evict_in_advance_thread.join();
196
227
        }
197
256
        if (_cache_background_lru_dump_thread.joinable()) {
198
227
            _cache_background_lru_dump_thread.join();
199
227
        }
200
256
        if (_cache_background_lru_log_replay_thread.joinable()) {
201
227
            _cache_background_lru_log_replay_thread.join();
202
227
        }
203
256
        if (_cache_background_block_lru_update_thread.joinable()) {
204
227
            _cache_background_block_lru_update_thread.join();
205
227
        }
206
256
        if (_ttl_mgr) {
207
196
            _ttl_mgr.reset();
208
196
        }
209
256
    }
210
211
    /// Restore cache from local filesystem.
212
    Status initialize();
213
214
    /// Cache capacity in bytes.
215
14
    [[nodiscard]] size_t capacity() const { return _capacity; }
216
217
    // try to release all releasable block
218
    // it maybe hang the io/system
219
    size_t try_release();
220
221
8.07k
    [[nodiscard]] const std::string& get_base_path() const { return _cache_base_path; }
222
223
    // Get storage for inspection
224
1
    FileCacheStorage* get_storage() const { return _storage.get(); }
225
226
    /**
227
         * Given an `offset` and `size` representing [offset, offset + size) bytes interval,
228
         * return list of cached non-overlapping non-empty
229
         * file blocks `[block1, ..., blockN]` which intersect with given interval.
230
         *
231
         * blocks in returned list are ordered in ascending order and represent a full contiguous
232
         * interval (no holes). Each block in returned list has state: DOWNLOADED, DOWNLOADING or EMPTY.
233
         *
234
         * As long as pointers to returned file blocks are hold
235
         * it is guaranteed that these file blocks are not removed from cache.
236
         */
237
    FileBlocksHolder get_or_set(const UInt128Wrapper& hash, size_t offset, size_t size,
238
                                CacheContext& context);
239
240
    /**
241
     * Return existing downloaded blocks only if they fully cover [offset, offset + size).
242
     * This lookup is read-only: it does not reserve cache space or create EMPTY blocks.
243
     */
244
    Status get_downloaded_blocks_if_fully_covered(const UInt128Wrapper& hash, size_t offset,
245
                                                  size_t size, const CacheContext& context,
246
                                                  FileBlocks* blocks, bool* fully_covered);
247
248
    /**
249
     * record blocks read directly by CachedRemoteFileReader
250
     */
251
    void add_need_update_lru_block(FileBlockSPtr block);
252
253
    /**
254
     * Clear all cached data for this cache instance async
255
     *
256
     * @returns summary message
257
     */
258
    std::string clear_file_cache_async();
259
    std::string clear_file_cache_sync();
260
261
    /**
262
     * Reset the cache capacity. If the new_capacity is smaller than _capacity, the redundant data will be remove async.
263
     *
264
     * @returns summary message
265
     */
266
    std::string reset_capacity(size_t new_capacity);
267
268
    std::map<size_t, FileBlockSPtr> get_blocks_by_key(const UInt128Wrapper& hash);
269
270
    /// For debug and UT
271
    std::string dump_structure(const UInt128Wrapper& hash);
272
    std::string dump_single_cache_type(const UInt128Wrapper& hash, size_t offset);
273
274
    void dump_lru_queues(bool force);
275
276
    [[nodiscard]] size_t get_used_cache_size(FileCacheType type) const;
277
278
    [[nodiscard]] size_t get_file_blocks_num(FileCacheType type) const;
279
280
    // change the block cache type
281
    void change_cache_type(const UInt128Wrapper& hash, size_t offset, FileCacheType new_type,
282
                           std::lock_guard<std::mutex>& cache_lock);
283
284
    // remove all blocks that belong to the key
285
    void remove_if_cached(const UInt128Wrapper& key);
286
    void remove_if_cached_async(const UInt128Wrapper& key);
287
288
    // Reset the block size and keep FileBlock, LRU queue, and cache counters consistent.
289
    void reset_range(const UInt128Wrapper&, size_t offset, size_t old_size, size_t new_size,
290
                     std::lock_guard<std::mutex>& cache_lock);
291
292
    // get the hotest blocks message by key
293
    // The tuple is composed of <offset, size, cache_type, expiration_time>
294
    [[nodiscard]] std::vector<std::tuple<size_t, size_t, FileCacheType, uint64_t>>
295
    get_hot_blocks_meta(const UInt128Wrapper& hash) const;
296
297
    [[nodiscard]] bool get_async_open_success() const { return _async_open_done; }
298
299
    BlockFileCache& operator=(const BlockFileCache&) = delete;
300
    BlockFileCache(const BlockFileCache&) = delete;
301
302
    // try to reserve the new space for the new block if the cache is full
303
    bool try_reserve(const UInt128Wrapper& hash, const CacheContext& context, size_t offset,
304
                     size_t size, std::lock_guard<std::mutex>& cache_lock);
305
306
    /**
307
     * Proactively evict cache blocks to free up space before cache is full.
308
     * 
309
     * This function attempts to evict blocks from both NORMAL and TTL queues to maintain 
310
     * cache size below high watermark. Unlike try_reserve() which blocks until space is freed,
311
     * this function initiates asynchronous eviction in background.
312
     * 
313
     * @param size Number of bytes to try to evict
314
     * @param cache_lock Lock that must be held while accessing cache data structures
315
     * 
316
     * @pre Caller must hold cache_lock
317
     * @pre _need_evict_cache_in_advance must be true
318
     * @pre _recycle_keys queue must have capacity for evicted blocks
319
     */
320
    void try_evict_in_advance(size_t size, std::lock_guard<std::mutex>& cache_lock);
321
322
    void update_ttl_atime(const UInt128Wrapper& hash);
323
324
    std::map<std::string, double> get_stats();
325
326
    // for be UTs
327
    std::map<std::string, double> get_stats_unsafe();
328
    [[nodiscard]] size_t need_update_lru_blocks_size_unsafe() const {
329
        return _need_update_lru_blocks.size();
330
    }
331
332
    using AccessRecord =
333
            std::unordered_map<AccessKeyAndOffset, LRUQueue::Iterator, KeyAndOffsetHash>;
334
335
    /// Used to track and control the cache access of each query.
336
    /// Through it, we can realize the processing of different queries by the cache layer.
337
    struct QueryFileCacheContext {
338
        LRUQueue lru_queue;
339
        AccessRecord records;
340
341
25
        QueryFileCacheContext(size_t max_cache_size) : lru_queue(max_cache_size, 0, 0) {}
342
343
        void remove(const UInt128Wrapper& hash, size_t offset,
344
                    std::lock_guard<std::mutex>& cache_lock);
345
346
        void reserve(const UInt128Wrapper& hash, size_t offset, size_t size,
347
                     std::lock_guard<std::mutex>& cache_lock);
348
349
141
        size_t get_max_cache_size() const { return lru_queue.get_max_size(); }
350
351
120
        size_t get_cache_size(std::lock_guard<std::mutex>& cache_lock) const {
352
120
            return lru_queue.get_capacity(cache_lock);
353
120
        }
354
355
50
        LRUQueue& queue() { return lru_queue; }
356
    };
357
358
    using QueryFileCacheContextPtr = std::shared_ptr<QueryFileCacheContext>;
359
    using QueryFileCacheContextMap = std::unordered_map<TUniqueId, QueryFileCacheContextPtr>;
360
361
    QueryFileCacheContextPtr get_query_context(const TUniqueId& query_id,
362
                                               std::lock_guard<std::mutex>&);
363
364
    void remove_query_context(const TUniqueId& query_id);
365
366
    QueryFileCacheContextPtr get_or_set_query_context(const TUniqueId& query_id,
367
                                                      std::lock_guard<std::mutex>& cache_lock,
368
                                                      int file_cache_query_limit_percent);
369
370
    /// Save a query context information, and adopt different cache policies
371
    /// for different queries through the context cache layer.
372
    struct QueryFileCacheContextHolder {
373
        QueryFileCacheContextHolder(const TUniqueId& query_id, BlockFileCache* mgr,
374
                                    QueryFileCacheContextPtr context)
375
27
                : query_id(query_id), mgr(mgr), context(context) {}
376
377
        QueryFileCacheContextHolder& operator=(const QueryFileCacheContextHolder&) = delete;
378
        QueryFileCacheContextHolder(const QueryFileCacheContextHolder&) = delete;
379
380
27
        ~QueryFileCacheContextHolder() {
381
            /// If only the query_map and the current holder hold the context_query,
382
            /// the query has been completed and the query_context is released.
383
27
            if (context) {
384
26
                context.reset();
385
26
                mgr->remove_query_context(query_id);
386
26
            }
387
27
        }
388
389
        const TUniqueId& query_id;
390
        BlockFileCache* mgr = nullptr;
391
        QueryFileCacheContextPtr context;
392
    };
393
    using QueryFileCacheContextHolderPtr = std::unique_ptr<QueryFileCacheContextHolder>;
394
    QueryFileCacheContextHolderPtr get_query_context_holder(const TUniqueId& query_id,
395
                                                            int file_cache_query_limit_percent);
396
397
5.29k
    int64_t approximate_available_cache_size() const {
398
5.29k
        return std::max<int64_t>(
399
5.29k
                _cache_capacity_metrics->get_value() - _cur_cache_size_metrics->get_value(), 0);
400
5.29k
    }
401
402
    Status report_file_cache_inconsistency(std::vector<std::string>& results);
403
    Status check_file_cache_consistency(InconsistencyContext& inconsistency_context);
404
405
private:
406
    // Shared scan used by both clear modes. It keeps the FileBlock holder lifecycle intact:
407
    // releasable blocks are removed immediately, while blocks held by readers are only marked
408
    // deleting and are later removed by FileBlocksHolder destruction.
409
    std::string clear_file_cache_impl(bool sync_remove);
410
411
    LRUQueue& get_queue(FileCacheType type);
412
    const LRUQueue& get_queue(FileCacheType type) const;
413
414
    template <class T, class U>
415
        requires IsXLock<T> && IsXLock<U>
416
    void remove(FileBlockSPtr file_block, T& cache_lock, U& segment_lock, bool sync = true);
417
418
    FileBlocks get_impl(const UInt128Wrapper& hash, const CacheContext& context,
419
                        const FileBlock::Range& range, std::lock_guard<std::mutex>& cache_lock);
420
421
    template <class T>
422
        requires IsXLock<T>
423
    FileBlockCell* get_cell(const UInt128Wrapper& hash, size_t offset, T& cache_lock);
424
425
    virtual FileBlockCell* add_cell(const UInt128Wrapper& hash, const CacheContext& context,
426
                                    size_t offset, size_t size, FileBlock::State state,
427
                                    std::lock_guard<std::mutex>& cache_lock);
428
429
    Status initialize_unlocked(std::lock_guard<std::mutex>& cache_lock);
430
431
    void update_block_lru(FileBlockSPtr block, std::lock_guard<std::mutex>& cache_lock);
432
433
    void use_cell(const FileBlockCell& cell, FileBlocks* result, bool not_need_move,
434
                  std::lock_guard<std::mutex>& cache_lock);
435
436
    bool try_reserve_for_lru(const UInt128Wrapper& hash, QueryFileCacheContextPtr query_context,
437
                             const CacheContext& context, size_t offset, size_t size,
438
                             std::lock_guard<std::mutex>& cache_lock,
439
                             bool evict_in_advance = false);
440
441
    bool try_reserve_during_async_load(size_t size, std::lock_guard<std::mutex>& cache_lock);
442
443
    std::vector<FileCacheType> get_other_cache_type(FileCacheType cur_cache_type);
444
    std::vector<FileCacheType> get_other_cache_type_without_ttl(FileCacheType cur_cache_type);
445
446
    bool try_reserve_from_other_queue(FileCacheType cur_cache_type, size_t offset, int64_t cur_time,
447
                                      std::lock_guard<std::mutex>& cache_lock,
448
                                      bool evict_in_advance = false);
449
450
    size_t get_available_cache_size(FileCacheType cache_type) const;
451
452
    FileBlocks split_range_into_cells(const UInt128Wrapper& hash, const CacheContext& context,
453
                                      size_t offset, size_t size, FileBlock::State state,
454
                                      std::lock_guard<std::mutex>& cache_lock);
455
456
    std::string dump_structure_unlocked(const UInt128Wrapper& hash,
457
                                        std::lock_guard<std::mutex>& cache_lock);
458
459
    std::string dump_single_cache_type_unlocked(const UInt128Wrapper& hash, size_t offset,
460
                                                std::lock_guard<std::mutex>& cache_lock);
461
462
    void fill_holes_with_empty_file_blocks(FileBlocks& file_blocks, const UInt128Wrapper& hash,
463
                                           const CacheContext& context,
464
                                           const FileBlock::Range& range,
465
                                           std::lock_guard<std::mutex>& cache_lock);
466
467
    size_t get_used_cache_size_unlocked(FileCacheType type,
468
                                        std::lock_guard<std::mutex>& cache_lock) const;
469
470
    void check_disk_resource_limit();
471
    void check_need_evict_cache_in_advance();
472
473
    size_t get_available_cache_size_unlocked(FileCacheType type,
474
                                             std::lock_guard<std::mutex>& cache_lock) const;
475
476
    size_t get_file_blocks_num_unlocked(FileCacheType type,
477
                                        std::lock_guard<std::mutex>& cache_lock) const;
478
479
    bool need_to_move(FileCacheType cell_type, FileCacheType query_type) const;
480
481
    void run_background_monitor();
482
    void run_background_gc();
483
    void run_background_lru_log_replay();
484
    size_t replay_lru_logs_once();
485
    void run_background_lru_dump();
486
    void restore_lru_queues_from_disk(std::lock_guard<std::mutex>& cache_lock);
487
    void run_background_evict_in_advance();
488
    void run_background_block_lru_update();
489
490
    bool try_reserve_from_other_queue_by_time_interval(FileCacheType cur_type,
491
                                                       std::vector<FileCacheType> other_cache_types,
492
                                                       size_t size, int64_t cur_time,
493
                                                       std::lock_guard<std::mutex>& cache_lock,
494
                                                       bool evict_in_advance);
495
496
    bool try_reserve_from_other_queue_by_size(FileCacheType cur_type,
497
                                              std::vector<FileCacheType> other_cache_types,
498
                                              size_t size, std::lock_guard<std::mutex>& cache_lock,
499
                                              bool evict_in_advance);
500
501
    bool is_overflow(size_t removed_size, size_t need_size, size_t cur_cache_size,
502
                     bool evict_in_advance) const;
503
504
    void remove_file_blocks(std::vector<FileBlockCell*>&, std::lock_guard<std::mutex>&, bool sync,
505
                            std::string& reason);
506
507
    void find_evict_candidates(LRUQueue& queue, size_t size, size_t cur_cache_size,
508
                               size_t& removed_size, std::vector<FileBlockCell*>& to_evict,
509
                               std::lock_guard<std::mutex>& cache_lock, size_t& cur_removed_size,
510
                               bool evict_in_advance);
511
512
    Status check_ofstream_status(std::ofstream& out, std::string& filename);
513
    Status dump_one_lru_entry(std::ofstream& out, std::string& filename, const UInt128Wrapper& hash,
514
                              size_t offset, size_t size);
515
    Status finalize_dump(std::ofstream& out, size_t entry_num, std::string& tmp_filename,
516
                         std::string& final_filename, size_t& file_size);
517
    Status check_ifstream_status(std::ifstream& in, std::string& filename);
518
    Status parse_dump_footer(std::ifstream& in, std::string& filename, size_t& entry_num);
519
    Status parse_one_lru_entry(std::ifstream& in, std::string& filename, UInt128Wrapper& hash,
520
                               size_t& offset, size_t& size);
521
    void remove_lru_dump_files();
522
523
    void clear_need_update_lru_blocks();
524
525
    // info
526
    std::string _cache_base_path;
527
    size_t _capacity = 0;
528
    size_t _max_file_block_size = 0;
529
530
    mutable std::mutex _mutex;
531
    bool _close {false};
532
    std::mutex _close_mtx;
533
    std::condition_variable _close_cv;
534
    std::thread _cache_background_monitor_thread;
535
    std::thread _cache_background_gc_thread;
536
    std::thread _cache_background_evict_in_advance_thread;
537
    std::thread _cache_background_lru_dump_thread;
538
    std::thread _cache_background_lru_log_replay_thread;
539
    std::thread _cache_background_block_lru_update_thread;
540
    std::atomic_bool _async_open_done {false};
541
    // disk space or inode is less than the specified value
542
    bool _disk_resource_limit_mode {false};
543
    bool _need_evict_cache_in_advance {false};
544
    bool _is_initialized {false};
545
546
    // strategy
547
    using FileBlocksByOffset = std::map<size_t, FileBlockCell>;
548
    using CachedFiles = std::unordered_map<UInt128Wrapper, FileBlocksByOffset, KeyHash>;
549
    CachedFiles _files;
550
    QueryFileCacheContextMap _query_map;
551
    size_t _cur_cache_size = 0;
552
    size_t _cur_ttl_size = 0;
553
    std::multimap<uint64_t, UInt128Wrapper> _time_to_key;
554
    std::unordered_map<UInt128Wrapper, uint64_t, KeyHash> _key_to_time;
555
    // The three queues are level queue.
556
    // It means as level1/level2/level3 queue.
557
    // but the level2 is maximum.
558
    // If some datas are importance, we can cache it into index queue
559
    // If some datas are just use once, we can cache it into disposable queue
560
    // The size proportion is [1:17:2].
561
    LRUQueue _index_queue;
562
    LRUQueue _normal_queue;
563
    LRUQueue _disposable_queue;
564
    LRUQueue _ttl_queue;
565
566
    // keys for async remove
567
    RecycleFileCacheKeys _recycle_keys;
568
569
    std::unique_ptr<LRUQueueRecorder> _lru_recorder;
570
    std::unique_ptr<CacheLRUDumper> _lru_dumper;
571
    std::unique_ptr<BlockFileCacheTtlMgr> _ttl_mgr;
572
573
    // metrics
574
    std::shared_ptr<bvar::Status<size_t>> _cache_capacity_metrics;
575
    std::shared_ptr<bvar::Status<size_t>> _cur_cache_size_metrics;
576
    std::shared_ptr<bvar::Status<size_t>> _cur_ttl_cache_size_metrics;
577
    std::shared_ptr<bvar::Status<size_t>> _cur_ttl_cache_lru_queue_cache_size_metrics;
578
    std::shared_ptr<bvar::Status<size_t>> _cur_ttl_cache_lru_queue_element_count_metrics;
579
    std::shared_ptr<bvar::Status<size_t>> _cur_normal_queue_element_count_metrics;
580
    std::shared_ptr<bvar::Status<size_t>> _cur_normal_queue_cache_size_metrics;
581
    std::shared_ptr<bvar::Status<size_t>> _cur_index_queue_element_count_metrics;
582
    std::shared_ptr<bvar::Status<size_t>> _cur_index_queue_cache_size_metrics;
583
    std::shared_ptr<bvar::Status<size_t>> _cur_disposable_queue_element_count_metrics;
584
    std::shared_ptr<bvar::Status<size_t>> _cur_disposable_queue_cache_size_metrics;
585
    std::array<std::shared_ptr<bvar::Adder<size_t>>, 4> _queue_evict_size_metrics;
586
    std::shared_ptr<bvar::Adder<size_t>> _total_read_size_metrics;
587
    std::shared_ptr<bvar::Adder<size_t>> _total_hit_size_metrics;
588
    std::shared_ptr<bvar::Adder<size_t>> _total_evict_size_metrics;
589
    std::shared_ptr<bvar::Adder<size_t>> _gc_evict_bytes_metrics;
590
    std::shared_ptr<bvar::Adder<size_t>> _gc_evict_count_metrics;
591
    std::shared_ptr<bvar::Adder<size_t>> _evict_by_time_metrics_matrix[4][4];
592
    std::shared_ptr<bvar::Adder<size_t>> _evict_by_size_metrics_matrix[4][4];
593
    std::shared_ptr<bvar::Adder<size_t>> _evict_by_self_lru_metrics_matrix[4];
594
    std::shared_ptr<bvar::Adder<size_t>> _evict_by_try_release;
595
596
    std::shared_ptr<bvar::Window<bvar::Adder<size_t>>> _num_hit_blocks_5m;
597
    std::shared_ptr<bvar::Window<bvar::Adder<size_t>>> _num_read_blocks_5m;
598
    std::shared_ptr<bvar::Window<bvar::Adder<size_t>>> _num_hit_blocks_1h;
599
    std::shared_ptr<bvar::Window<bvar::Adder<size_t>>> _num_read_blocks_1h;
600
601
    std::shared_ptr<bvar::Adder<size_t>> _num_read_blocks;
602
    std::shared_ptr<bvar::Adder<size_t>> _num_hit_blocks;
603
    std::shared_ptr<bvar::Adder<size_t>> _num_removed_blocks;
604
605
    std::shared_ptr<bvar::Adder<size_t>> _no_warmup_num_read_blocks;
606
    std::shared_ptr<bvar::Adder<size_t>> _no_warmup_num_hit_blocks;
607
608
    std::shared_ptr<bvar::Window<bvar::Adder<size_t>>> _no_warmup_num_hit_blocks_5m;
609
    std::shared_ptr<bvar::Window<bvar::Adder<size_t>>> _no_warmup_num_read_blocks_5m;
610
    std::shared_ptr<bvar::Window<bvar::Adder<size_t>>> _no_warmup_num_hit_blocks_1h;
611
    std::shared_ptr<bvar::Window<bvar::Adder<size_t>>> _no_warmup_num_read_blocks_1h;
612
613
    std::shared_ptr<bvar::Status<double>> _hit_ratio;
614
    std::shared_ptr<bvar::Status<double>> _hit_ratio_5m;
615
    std::shared_ptr<bvar::Status<double>> _hit_ratio_1h;
616
    std::shared_ptr<bvar::Status<double>> _no_warmup_hit_ratio;
617
    std::shared_ptr<bvar::Status<double>> _no_warmup_hit_ratio_5m;
618
    std::shared_ptr<bvar::Status<double>> _no_warmup_hit_ratio_1h;
619
    std::shared_ptr<bvar::Status<size_t>> _disk_limit_mode_metrics;
620
    std::shared_ptr<bvar::Status<size_t>> _need_evict_cache_in_advance_metrics;
621
    std::shared_ptr<bvar::Status<size_t>> _meta_store_write_queue_size_metrics;
622
623
    std::shared_ptr<bvar::LatencyRecorder> _cache_lock_wait_time_us;
624
    std::shared_ptr<bvar::LatencyRecorder> _get_or_set_latency_us;
625
    std::shared_ptr<bvar::LatencyRecorder> _storage_sync_remove_latency_us;
626
    std::shared_ptr<bvar::LatencyRecorder> _storage_retry_sync_remove_latency_us;
627
    std::shared_ptr<bvar::LatencyRecorder> _storage_async_remove_latency_us;
628
    std::shared_ptr<bvar::LatencyRecorder> _evict_in_advance_latency_us;
629
    std::shared_ptr<bvar::LatencyRecorder> _recycle_keys_length_recorder;
630
    std::shared_ptr<bvar::LatencyRecorder> _update_lru_blocks_latency_us;
631
    std::shared_ptr<bvar::LatencyRecorder> _need_update_lru_blocks_length_recorder;
632
    std::shared_ptr<bvar::Adder<size_t>> _need_update_lru_blocks_produce_metrics;
633
    std::shared_ptr<bvar::Adder<size_t>> _need_update_lru_blocks_consume_metrics;
634
    std::shared_ptr<bvar::LatencyRecorder> _ttl_gc_latency_us;
635
636
    std::shared_ptr<bvar::LatencyRecorder> _shadow_queue_levenshtein_distance;
637
    std::array<std::shared_ptr<bvar::LatencyRecorder>, 4> _lru_recorder_queue_length_recorder;
638
    std::array<std::shared_ptr<bvar::Adder<size_t>>, 4> _lru_recorder_queue_produce_metrics;
639
    std::array<std::shared_ptr<bvar::Adder<size_t>>, 4> _lru_recorder_queue_consume_metrics;
640
    std::array<std::shared_ptr<bvar::Status<size_t>>, 4>
641
            _lru_recorder_shadow_queue_element_count_metrics;
642
    std::shared_ptr<bvar::Adder<size_t>> _lru_recorder_log_replay_idle_metrics;
643
    // keep _storage last so it will deconstruct first
644
    // otherwise, load_cache_info_into_memory might crash
645
    // coz it will use other members of BlockFileCache
646
    // so join this async load thread first
647
    std::unique_ptr<FileCacheStorage> _storage;
648
    std::shared_ptr<bvar::LatencyRecorder> _lru_dump_latency_us;
649
    std::mutex _dump_lru_queues_mtx;
650
    NeedUpdateLRUBlocks _need_update_lru_blocks;
651
};
652
653
} // namespace doris::io