// Copyright (c) 2019-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 "rocksdb/env.h" #include "rocksdb/file_system.h" #include "rocksdb/system_clock.h" #ifdef _WIN32 // Windows API macro interference #undef DeleteFile #undef GetCurrentTime #undef LoadLibrary #endif namespace ROCKSDB_NAMESPACE { class CompositeEnv : public Env { public: // Initialize a CompositeEnvWrapper that delegates all thread/time related // calls to env, and all file operations to fs explicit CompositeEnv(const std::shared_ptr& fs, const std::shared_ptr& clock) : Env(fs, clock) {} Status RegisterDbPaths(const std::vector& paths) override { return file_system_->RegisterDbPaths(paths); } Status UnregisterDbPaths(const std::vector& paths) override { return file_system_->UnregisterDbPaths(paths); } // The following text is boilerplate that forwards all methods to target() Status NewSequentialFile(const std::string& f, std::unique_ptr* r, const EnvOptions& options) override; Status NewRandomAccessFile(const std::string& f, std::unique_ptr* r, const EnvOptions& options) override; Status NewWritableFile(const std::string& f, std::unique_ptr* r, const EnvOptions& options) override; Status ReopenWritableFile(const std::string& fname, std::unique_ptr* result, const EnvOptions& options) override; Status ReuseWritableFile(const std::string& fname, const std::string& old_fname, std::unique_ptr* r, const EnvOptions& options) override; Status NewRandomRWFile(const std::string& fname, std::unique_ptr* result, const EnvOptions& options) override; Status NewMemoryMappedFileBuffer( const std::string& fname, std::unique_ptr* result) override { return file_system_->NewMemoryMappedFileBuffer(fname, result); } Status NewDirectory(const std::string& name, std::unique_ptr* result) override; Status FileExists(const std::string& f) override { IOOptions io_opts; IODebugContext dbg; return file_system_->FileExists(f, io_opts, &dbg); } Status GetChildren(const std::string& dir, std::vector* r) override { IOOptions io_opts; IODebugContext dbg; return file_system_->GetChildren(dir, io_opts, r, &dbg); } Status GetChildrenFileAttributes( const std::string& dir, std::vector* result) override { IOOptions io_opts; IODebugContext dbg; return file_system_->GetChildrenFileAttributes(dir, io_opts, result, &dbg); } Status DeleteFile(const std::string& f) override { IOOptions io_opts; IODebugContext dbg; return file_system_->DeleteFile(f, io_opts, &dbg); } Status Truncate(const std::string& fname, size_t size) override { IOOptions io_opts; IODebugContext dbg; return file_system_->Truncate(fname, size, io_opts, &dbg); } Status CreateDir(const std::string& d) override { IOOptions io_opts; IODebugContext dbg; return file_system_->CreateDir(d, io_opts, &dbg); } Status CreateDirIfMissing(const std::string& d) override { IOOptions io_opts; IODebugContext dbg; return file_system_->CreateDirIfMissing(d, io_opts, &dbg); } Status DeleteDir(const std::string& d) override { IOOptions io_opts; IODebugContext dbg; return file_system_->DeleteDir(d, io_opts, &dbg); } Status GetFileSize(const std::string& f, uint64_t* s) override { IOOptions io_opts; IODebugContext dbg; return file_system_->GetFileSize(f, io_opts, s, &dbg); } Status GetFileModificationTime(const std::string& fname, uint64_t* file_mtime) override { IOOptions io_opts; IODebugContext dbg; return file_system_->GetFileModificationTime(fname, io_opts, file_mtime, &dbg); } Status RenameFile(const std::string& s, const std::string& t) override { IOOptions io_opts; IODebugContext dbg; return file_system_->RenameFile(s, t, io_opts, &dbg); } Status LinkFile(const std::string& s, const std::string& t) override { IOOptions io_opts; IODebugContext dbg; return file_system_->LinkFile(s, t, io_opts, &dbg); } Status NumFileLinks(const std::string& fname, uint64_t* count) override { IOOptions io_opts; IODebugContext dbg; return file_system_->NumFileLinks(fname, io_opts, count, &dbg); } Status AreFilesSame(const std::string& first, const std::string& second, bool* res) override { IOOptions io_opts; IODebugContext dbg; return file_system_->AreFilesSame(first, second, io_opts, res, &dbg); } Status LockFile(const std::string& f, FileLock** l) override { IOOptions io_opts; IODebugContext dbg; return file_system_->LockFile(f, io_opts, l, &dbg); } Status UnlockFile(FileLock* l) override { IOOptions io_opts; IODebugContext dbg; return file_system_->UnlockFile(l, io_opts, &dbg); } Status GetAbsolutePath(const std::string& db_path, std::string* output_path) override { IOOptions io_opts; IODebugContext dbg; return file_system_->GetAbsolutePath(db_path, io_opts, output_path, &dbg); } Status NewLogger(const std::string& fname, std::shared_ptr* result) override { IOOptions io_opts; IODebugContext dbg; return file_system_->NewLogger(fname, io_opts, result, &dbg); } Status IsDirectory(const std::string& path, bool* is_dir) override { IOOptions io_opts; IODebugContext dbg; return file_system_->IsDirectory(path, io_opts, is_dir, &dbg); } Status GetTestDirectory(std::string* path) override { IOOptions io_opts; IODebugContext dbg; return file_system_->GetTestDirectory(io_opts, path, &dbg); } EnvOptions OptimizeForLogRead(const EnvOptions& env_options) const override { return file_system_->OptimizeForLogRead(FileOptions(env_options)); } EnvOptions OptimizeForManifestRead( const EnvOptions& env_options) const override { return file_system_->OptimizeForManifestRead(FileOptions(env_options)); } EnvOptions OptimizeForLogWrite(const EnvOptions& env_options, const DBOptions& db_options) const override { return file_system_->OptimizeForLogWrite(FileOptions(env_options), db_options); } EnvOptions OptimizeForManifestWrite( const EnvOptions& env_options) const override { return file_system_->OptimizeForManifestWrite(FileOptions(env_options)); } EnvOptions OptimizeForCompactionTableWrite( const EnvOptions& env_options, const ImmutableDBOptions& immutable_ops) const override { return file_system_->OptimizeForCompactionTableWrite( FileOptions(env_options), immutable_ops); } EnvOptions OptimizeForCompactionTableRead( const EnvOptions& env_options, const ImmutableDBOptions& db_options) const override { return file_system_->OptimizeForCompactionTableRead( FileOptions(env_options), db_options); } EnvOptions OptimizeForBlobFileRead( const EnvOptions& env_options, const ImmutableDBOptions& db_options) const override { return file_system_->OptimizeForBlobFileRead(FileOptions(env_options), db_options); } // This seems to clash with a macro on Windows, so #undef it here #ifdef GetFreeSpace #undef GetFreeSpace #endif Status GetFreeSpace(const std::string& path, uint64_t* diskfree) override { IOOptions io_opts; IODebugContext dbg; return file_system_->GetFreeSpace(path, io_opts, diskfree, &dbg); } uint64_t NowMicros() override { return system_clock_->NowMicros(); } uint64_t NowNanos() override { return system_clock_->NowNanos(); } uint64_t NowCPUNanos() override { return system_clock_->CPUNanos(); } void SleepForMicroseconds(int micros) override { system_clock_->SleepForMicroseconds(micros); } Status GetCurrentTime(int64_t* unix_time) override { return system_clock_->GetCurrentTime(unix_time); } std::string TimeToString(uint64_t time) override { return system_clock_->TimeToString(time); } }; class CompositeEnvWrapper : public CompositeEnv { public: // Initialize a CompositeEnvWrapper that delegates all thread/time related // calls to env, and all file operations to fs explicit CompositeEnvWrapper(Env* env, const std::shared_ptr& fs) : CompositeEnvWrapper(env, fs, env->GetSystemClock()) {} explicit CompositeEnvWrapper(Env* env, const std::shared_ptr& sc) : CompositeEnvWrapper(env, env->GetFileSystem(), sc) {} explicit CompositeEnvWrapper(Env* env, const std::shared_ptr& fs, const std::shared_ptr& sc) : CompositeEnv(fs, sc), env_target_(env) {} // Return the target to which this Env forwards all calls Env* env_target() const { return env_target_; } #if !defined(OS_WIN) && !defined(ROCKSDB_NO_DYNAMIC_EXTENSION) Status LoadLibrary(const std::string& lib_name, const std::string& search_path, std::shared_ptr* result) override { return env_target_->LoadLibrary(lib_name, search_path, result); } #endif void Schedule(void (*f)(void* arg), void* a, Priority pri, void* tag = nullptr, void (*u)(void* arg) = nullptr) override { return env_target_->Schedule(f, a, pri, tag, u); } int UnSchedule(void* tag, Priority pri) override { return env_target_->UnSchedule(tag, pri); } void StartThread(void (*f)(void*), void* a) override { return env_target_->StartThread(f, a); } void WaitForJoin() override { return env_target_->WaitForJoin(); } unsigned int GetThreadPoolQueueLen(Priority pri = LOW) const override { return env_target_->GetThreadPoolQueueLen(pri); } Status GetHostName(char* name, uint64_t len) override { return env_target_->GetHostName(name, len); } void SetBackgroundThreads(int num, Priority pri) override { return env_target_->SetBackgroundThreads(num, pri); } int GetBackgroundThreads(Priority pri) override { return env_target_->GetBackgroundThreads(pri); } Status SetAllowNonOwnerAccess(bool allow_non_owner_access) override { return env_target_->SetAllowNonOwnerAccess(allow_non_owner_access); } void IncBackgroundThreadsIfNeeded(int num, Priority pri) override { return env_target_->IncBackgroundThreadsIfNeeded(num, pri); } void LowerThreadPoolIOPriority(Priority pool) override { env_target_->LowerThreadPoolIOPriority(pool); } void LowerThreadPoolCPUPriority(Priority pool) override { env_target_->LowerThreadPoolCPUPriority(pool); } Status LowerThreadPoolCPUPriority(Priority pool, CpuPriority pri) override { return env_target_->LowerThreadPoolCPUPriority(pool, pri); } Status GetThreadList(std::vector* thread_list) override { return env_target_->GetThreadList(thread_list); } ThreadStatusUpdater* GetThreadStatusUpdater() const override { return env_target_->GetThreadStatusUpdater(); } uint64_t GetThreadID() const override { return env_target_->GetThreadID(); } std::string GenerateUniqueId() override { return env_target_->GenerateUniqueId(); } private: Env* env_target_; }; } // namespace ROCKSDB_NAMESPACE