Coverage Report

Created: 2026-06-17 15:01

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