Packages

rocksdb

2.1.0
3.1.2 3.1.1 3.1.0 3.0.0 2.6.2 2.6.1 retired 2.6.0 retired 2.5.0 2.4.1 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.1 1.5.0 1.4.0 1.3.2 1.3.1 1.3.0 1.2.0 1.1.1 1.1.0 1.0.0 0.26.2 0.26.1 0.26.0 0.25.0 0.24.0 0.23.3 0.23.2 0.23.1 0.23.0 0.22.0 0.21.0 0.20.1 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.1 0.13.0 0.12.0 0.11.0 0.10.0 0.9.1 0.9.0 0.8.2 0.8.1 0.8.0 0.7.1 0.7.0 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0

RocksDB for Erlang

HexDocs

Current section

Files

Jump to
Readme
64 Versions
0 Dependencies
Dependants
Files
Activity
rocksdb deps rocksdb db blob blob_file_cache.h
Raw

deps/rocksdb/db/blob/blob_file_cache.h 

//  Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.

//  This source code is licensed under both the GPLv2 (found in the

//  COPYING file in the root directory) and Apache 2.0 License

//  (found in the LICENSE.Apache file in the root directory).



#pragma once



#include <cinttypes>



#include "cache/typed_cache.h"

#include "db/blob/blob_file_reader.h"

#include "rocksdb/rocksdb_namespace.h"

#include "util/mutexlock.h"



namespace ROCKSDB_NAMESPACE {



class Cache;

struct ImmutableOptions;

struct FileOptions;

class HistogramImpl;

class Status;

class Slice;

class IOTracer;



class BlobFileCache {

 public:

  BlobFileCache(Cache* cache, const ImmutableOptions* immutable_options,

                const FileOptions* file_options, uint32_t column_family_id,

                HistogramImpl* blob_file_read_hist,

                const std::shared_ptr<IOTracer>& io_tracer);



  BlobFileCache(const BlobFileCache&) = delete;

  BlobFileCache& operator=(const BlobFileCache&) = delete;



  Status GetBlobFileReader(const ReadOptions& read_options,

                           uint64_t blob_file_number,

                           CacheHandleGuard<BlobFileReader>* blob_file_reader);



  // Called when a blob file is obsolete to ensure it is removed from the cache

  // to avoid effectively leaking the open file and assicated memory

  void Evict(uint64_t blob_file_number);



  // Used to identify cache entries for blob files (not normally useful)

  static const Cache::CacheItemHelper* GetHelper() {

    return CacheInterface::GetBasicHelper();

  }



 private:

  using CacheInterface =

      BasicTypedCacheInterface<BlobFileReader, CacheEntryRole::kMisc>;

  using TypedHandle = CacheInterface::TypedHandle;

  CacheInterface cache_;

  // Note: mutex_ below is used to guard against multiple threads racing to open

  // the same file.

  Striped<CacheAlignedWrapper<port::Mutex>> mutex_;

  const ImmutableOptions* immutable_options_;

  const FileOptions* file_options_;

  uint32_t column_family_id_;

  HistogramImpl* blob_file_read_hist_;

  std::shared_ptr<IOTracer> io_tracer_;



  static constexpr size_t kNumberOfMutexStripes = 1 << 7;

};



}  // namespace ROCKSDB_NAMESPACE