db_impl.h 27.1 KB
Newer Older
1 2 3 4 5
//  Copyright (c) 2013, Facebook, Inc.  All rights reserved.
//  This source code is licensed under the BSD-style license found in the
//  LICENSE file in the root directory of this source tree. An additional grant
//  of patent rights can be found in the PATENTS file in the same directory.
//
J
jorlow@chromium.org 已提交
6 7 8
// Copyright (c) 2011 The LevelDB Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. See the AUTHORS file for names of contributors.
9
#pragma once
K
Kai Liu 已提交
10

H
Haobo Xu 已提交
11
#include <atomic>
12
#include <deque>
13
#include <limits>
J
jorlow@chromium.org 已提交
14
#include <set>
I
Igor Canadi 已提交
15
#include <list>
T
Tomislav Novak 已提交
16
#include <utility>
17
#include <list>
18
#include <vector>
I
Igor Canadi 已提交
19
#include <string>
K
kailiu 已提交
20

J
jorlow@chromium.org 已提交
21 22 23
#include "db/dbformat.h"
#include "db/log_writer.h"
#include "db/snapshot.h"
24
#include "db/column_family.h"
25
#include "db/version_edit.h"
I
Igor Canadi 已提交
26
#include "db/wal_manager.h"
27
#include "db/writebuffer.h"
K
Kai Liu 已提交
28 29
#include "memtable_list.h"
#include "port/port.h"
30 31 32 33
#include "rocksdb/db.h"
#include "rocksdb/env.h"
#include "rocksdb/memtablerep.h"
#include "rocksdb/transaction_log.h"
34
#include "util/autovector.h"
35
#include "util/stop_watch.h"
36
#include "util/thread_local.h"
37
#include "util/scoped_arena_iterator.h"
Y
Yueh-Hsuan Chiang 已提交
38
#include "util/hash.h"
39
#include "util/instrumented_mutex.h"
I
Igor Canadi 已提交
40
#include "db/internal_stats.h"
41
#include "db/write_controller.h"
I
Igor Canadi 已提交
42
#include "db/flush_scheduler.h"
I
Igor Canadi 已提交
43
#include "db/write_thread.h"
44

45
namespace rocksdb {
J
jorlow@chromium.org 已提交
46 47 48 49 50 51

class MemTable;
class TableCache;
class Version;
class VersionEdit;
class VersionSet;
D
Danny Guo 已提交
52
class CompactionFilterV2;
53
class Arena;
I
Igor Canadi 已提交
54
struct JobContext;
J
jorlow@chromium.org 已提交
55 56 57

class DBImpl : public DB {
 public:
I
Igor Canadi 已提交
58
  DBImpl(const DBOptions& options, const std::string& dbname);
J
jorlow@chromium.org 已提交
59 60 61
  virtual ~DBImpl();

  // Implementations of the DB interface
62 63
  using DB::Put;
  virtual Status Put(const WriteOptions& options,
64
                     ColumnFamilyHandle* column_family, const Slice& key,
I
Igor Sugak 已提交
65
                     const Slice& value) override;
66 67
  using DB::Merge;
  virtual Status Merge(const WriteOptions& options,
68
                       ColumnFamilyHandle* column_family, const Slice& key,
I
Igor Sugak 已提交
69
                       const Slice& value) override;
70 71
  using DB::Delete;
  virtual Status Delete(const WriteOptions& options,
I
Igor Sugak 已提交
72 73
                        ColumnFamilyHandle* column_family,
                        const Slice& key) override;
74
  using DB::Write;
I
Igor Sugak 已提交
75 76
  virtual Status Write(const WriteOptions& options,
                       WriteBatch* updates) override;
77
  using DB::Get;
J
jorlow@chromium.org 已提交
78
  virtual Status Get(const ReadOptions& options,
79
                     ColumnFamilyHandle* column_family, const Slice& key,
I
Igor Sugak 已提交
80
                     std::string* value) override;
81 82 83
  using DB::MultiGet;
  virtual std::vector<Status> MultiGet(
      const ReadOptions& options,
84
      const std::vector<ColumnFamilyHandle*>& column_family,
I
Igor Sugak 已提交
85 86
      const std::vector<Slice>& keys,
      std::vector<std::string>* values) override;
87

88
  virtual Status CreateColumnFamily(const ColumnFamilyOptions& options,
89
                                    const std::string& column_family,
I
Igor Sugak 已提交
90 91
                                    ColumnFamilyHandle** handle) override;
  virtual Status DropColumnFamily(ColumnFamilyHandle* column_family) override;
92

93 94 95 96
  // Returns false if key doesn't exist in the database and true if it may.
  // If value_found is not passed in as null, then return the value if found in
  // memory. On return, if value was found, then value_found will be set to true
  // , otherwise false.
97
  using DB::KeyMayExist;
98
  virtual bool KeyMayExist(const ReadOptions& options,
99
                           ColumnFamilyHandle* column_family, const Slice& key,
I
Igor Sugak 已提交
100 101
                           std::string* value,
                           bool* value_found = nullptr) override;
102 103
  using DB::NewIterator;
  virtual Iterator* NewIterator(const ReadOptions& options,
I
Igor Sugak 已提交
104
                                ColumnFamilyHandle* column_family) override;
105 106
  virtual Status NewIterators(
      const ReadOptions& options,
I
Igor Canadi 已提交
107
      const std::vector<ColumnFamilyHandle*>& column_families,
I
Igor Sugak 已提交
108 109 110
      std::vector<Iterator*>* iterators) override;
  virtual const Snapshot* GetSnapshot() override;
  virtual void ReleaseSnapshot(const Snapshot* snapshot) override;
111
  using DB::GetProperty;
112
  virtual bool GetProperty(ColumnFamilyHandle* column_family,
I
Igor Sugak 已提交
113
                           const Slice& property, std::string* value) override;
114 115 116
  using DB::GetIntProperty;
  virtual bool GetIntProperty(ColumnFamilyHandle* column_family,
                              const Slice& property, uint64_t* value) override;
117
  using DB::GetApproximateSizes;
118
  virtual void GetApproximateSizes(ColumnFamilyHandle* column_family,
I
Igor Sugak 已提交
119 120
                                   const Range* range, int n,
                                   uint64_t* sizes) override;
121
  using DB::CompactRange;
122
  virtual Status CompactRange(ColumnFamilyHandle* column_family,
123
                              const Slice* begin, const Slice* end,
124
                              bool reduce_level = false, int target_level = -1,
I
Igor Sugak 已提交
125
                              uint32_t target_path_id = 0) override;
126

127
  using DB::CompactFiles;
I
Igor Sugak 已提交
128 129 130 131 132
  virtual Status CompactFiles(const CompactionOptions& compact_options,
                              ColumnFamilyHandle* column_family,
                              const std::vector<std::string>& input_file_names,
                              const int output_level,
                              const int output_path_id = -1) override;
133

134
  using DB::SetOptions;
I
Igor Sugak 已提交
135 136 137
  Status SetOptions(
      ColumnFamilyHandle* column_family,
      const std::unordered_map<std::string, std::string>& options_map) override;
138

139
  using DB::NumberLevels;
I
Igor Sugak 已提交
140
  virtual int NumberLevels(ColumnFamilyHandle* column_family) override;
141
  using DB::MaxMemCompactionLevel;
I
Igor Sugak 已提交
142
  virtual int MaxMemCompactionLevel(ColumnFamilyHandle* column_family) override;
143
  using DB::Level0StopWriteTrigger;
I
Igor Sugak 已提交
144 145 146 147
  virtual int Level0StopWriteTrigger(
      ColumnFamilyHandle* column_family) override;
  virtual const std::string& GetName() const override;
  virtual Env* GetEnv() const override;
148
  using DB::GetOptions;
I
Igor Sugak 已提交
149 150
  virtual const Options& GetOptions(
      ColumnFamilyHandle* column_family) const override;
151 152
  using DB::Flush;
  virtual Status Flush(const FlushOptions& options,
I
Igor Sugak 已提交
153
                       ColumnFamilyHandle* column_family) override;
I
Igor Canadi 已提交
154

I
Igor Sugak 已提交
155
  virtual SequenceNumber GetLatestSequenceNumber() const override;
I
Igor Canadi 已提交
156 157

#ifndef ROCKSDB_LITE
I
Igor Sugak 已提交
158 159
  virtual Status DisableFileDeletions() override;
  virtual Status EnableFileDeletions(bool force) override;
160
  virtual int IsFileDeletionsEnabled() const;
I
Igor Canadi 已提交
161
  // All the returned filenames start with "/"
162
  virtual Status GetLiveFiles(std::vector<std::string>&,
163
                              uint64_t* manifest_file_size,
I
Igor Sugak 已提交
164 165
                              bool flush_memtable = true) override;
  virtual Status GetSortedWalFiles(VectorLogPtr& files) override;
I
Igor Canadi 已提交
166

167 168 169
  virtual Status GetUpdatesSince(
      SequenceNumber seq_number, unique_ptr<TransactionLogIterator>* iter,
      const TransactionLogIterator::ReadOptions&
I
Igor Sugak 已提交
170 171
          read_options = TransactionLogIterator::ReadOptions()) override;
  virtual Status DeleteFile(std::string name) override;
172

I
Igor Sugak 已提交
173 174
  virtual void GetLiveFilesMetaData(
      std::vector<LiveFileMetaData>* metadata) override;
175 176 177 178 179 180 181 182 183

  // Obtains the meta data of the specified column family of the DB.
  // Status::NotFound() will be returned if the current DB does not have
  // any column family match the specified name.
  // TODO(yhchiang): output parameter is placed in the end in this codebase.
  virtual void GetColumnFamilyMetaData(
      ColumnFamilyHandle* column_family,
      ColumnFamilyMetaData* metadata) override;

I
Igor Canadi 已提交
184
#endif  // ROCKSDB_LITE
185

I
Igor Canadi 已提交
186 187 188 189
  // checks if all live files exist on file system and that their file sizes
  // match to our in-memory records
  virtual Status CheckConsistency();

I
Igor Sugak 已提交
190
  virtual Status GetDbIdentity(std::string& identity) override;
191

I
Igor Canadi 已提交
192
  Status RunManualCompaction(ColumnFamilyData* cfd, int input_level,
193 194
                             int output_level, uint32_t output_path_id,
                             const Slice* begin, const Slice* end);
195

196
#ifndef ROCKSDB_LITE
J
jorlow@chromium.org 已提交
197
  // Extra methods (for testing) that are not in the public DB interface
I
Igor Canadi 已提交
198
  // Implemented in db_impl_debug.cc
J
jorlow@chromium.org 已提交
199

200
  // Compact any files in the named level that overlap [*begin, *end]
201 202
  Status TEST_CompactRange(int level, const Slice* begin, const Slice* end,
                           ColumnFamilyHandle* column_family = nullptr);
J
jorlow@chromium.org 已提交
203

204
  // Force current memtable contents to be flushed.
205
  Status TEST_FlushMemTable(bool wait = true);
J
jorlow@chromium.org 已提交
206

207
  // Wait for memtable compaction
208
  Status TEST_WaitForFlushMemTable(ColumnFamilyHandle* column_family = nullptr);
209 210 211 212

  // Wait for any compaction
  Status TEST_WaitForCompact();

J
jorlow@chromium.org 已提交
213 214 215
  // Return an internal iterator over the current state of the database.
  // The keys of this iterator are internal keys (see format.h).
  // The returned iterator should be deleted when no longer needed.
216 217
  Iterator* TEST_NewInternalIterator(
      Arena* arena, ColumnFamilyHandle* column_family = nullptr);
J
jorlow@chromium.org 已提交
218

219 220
  // Return the maximum overlapping data (in bytes) at next level for any
  // file at a level >= 1.
221 222
  int64_t TEST_MaxNextLevelOverlappingBytes(ColumnFamilyHandle* column_family =
                                                nullptr);
223

A
Abhishek Kona 已提交
224 225
  // Return the current manifest file no.
  uint64_t TEST_Current_Manifest_FileNo();
226

227
  // get total level0 file size. Only for testing.
228
  uint64_t TEST_GetLevel0TotalSize();
229

230 231
  void TEST_GetFilesMetaData(ColumnFamilyHandle* column_family,
                             std::vector<std::vector<FileMetaData>>* metadata);
232

233 234 235 236 237 238 239 240 241 242
  void TEST_LockMutex();

  void TEST_UnlockMutex();

  // REQUIRES: mutex locked
  void* TEST_BeginWrite();

  // REQUIRES: mutex locked
  // pass the pointer that you got from TEST_BeginWrite()
  void TEST_EndWrite(void* w);
243 244 245 246

  uint64_t TEST_max_total_in_memory_state() {
    return max_total_in_memory_state_;
  }
247

248
#endif  // ROCKSDB_LITE
I
Igor Canadi 已提交
249

I
Igor Canadi 已提交
250
  // Returns the list of live files in 'live' and the list
K
kailiu 已提交
251
  // of all files in the filesystem in 'candidate_files'.
I
Igor Canadi 已提交
252
  // If force == false and the last call was less than
253
  // db_options_.delete_obsolete_files_period_micros microseconds ago,
I
Igor Canadi 已提交
254 255
  // it will not fill up the job_context
  void FindObsoleteFiles(JobContext* job_context, bool force,
I
Igor Canadi 已提交
256 257 258 259 260 261
                         bool no_full_scan = false);

  // Diffs the files listed in filenames and those that do not
  // belong to live files are posibly removed. Also, removes all the
  // files in sst_delete_files and log_delete_files.
  // It is not necessary to hold the mutex when invoking this method.
I
Igor Canadi 已提交
262
  void PurgeObsoleteFiles(const JobContext& background_contet);
I
Igor Canadi 已提交
263

I
Igor Sugak 已提交
264
  ColumnFamilyHandle* DefaultColumnFamily() const override;
265

266 267
  const SnapshotList& snapshots() const { return snapshots_; }

268 269
  void CancelAllBackgroundWork(bool wait = false);

270
 protected:
H
heyongqiang 已提交
271 272
  Env* const env_;
  const std::string dbname_;
273
  unique_ptr<VersionSet> versions_;
274
  const DBOptions db_options_;
L
Lei Jin 已提交
275
  Statistics* stats_;
H
heyongqiang 已提交
276

277
  Iterator* NewInternalIterator(const ReadOptions&, ColumnFamilyData* cfd,
278
                                SuperVersion* super_version, Arena* arena);
279

280 281
  void NotifyOnFlushCompleted(ColumnFamilyData* cfd, uint64_t file_number,
                              const MutableCFOptions& mutable_cf_options);
282

O
Ori Bernstein 已提交
283 284 285
  void NotifyOnCompactionCompleted(ColumnFamilyData* cfd,
                                   Compaction *c, const Status &st);

Y
Yueh-Hsuan Chiang 已提交
286 287 288 289 290 291
  void NewThreadStatusCfInfo(ColumnFamilyData* cfd) const;

  void EraseThreadStatusCfInfo(ColumnFamilyData* cfd) const;

  void EraseThreadStatusDbInfo() const;

J
jorlow@chromium.org 已提交
292 293
 private:
  friend class DB;
294
  friend class InternalStats;
I
Igor Canadi 已提交
295
#ifndef ROCKSDB_LITE
L
Lei Jin 已提交
296
  friend class ForwardIterator;
I
Igor Canadi 已提交
297
#endif
298
  friend struct SuperVersion;
L
Lei Jin 已提交
299
  friend class CompactedDBImpl;
300
  struct CompactionState;
301

S
Stanislau Hlebik 已提交
302
  struct WriteContext;
J
jorlow@chromium.org 已提交
303 304 305 306 307 308

  Status NewDB();

  // Recover the descriptor from persistent storage.  May do a significant
  // amount of work to recover recently logged updates.  Any changes to
  // be made to the descriptor are added to *edit.
309 310
  Status Recover(const std::vector<ColumnFamilyDescriptor>& column_families,
                 bool read_only = false, bool error_if_log_file_exist = false);
J
jorlow@chromium.org 已提交
311 312 313

  void MaybeIgnoreError(Status* s) const;

314 315
  const Status CreateArchivalDirectory();

J
jorlow@chromium.org 已提交
316 317 318
  // Delete any unneeded files and stale in-memory entries.
  void DeleteObsoleteFiles();

I
Igor Canadi 已提交
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
  // Background process needs to call
  //     auto x = CaptureCurrentFileNumberInPendingOutputs()
  //     <do something>
  //     ReleaseFileNumberFromPendingOutputs(x)
  // This will protect any temporary files created while <do something> is
  // executing from being deleted.
  // -----------
  // This function will capture current file number and append it to
  // pending_outputs_. This will prevent any background process to delete any
  // file created after this point.
  std::list<uint64_t>::iterator CaptureCurrentFileNumberInPendingOutputs();
  // This function should be called with the result of
  // CaptureCurrentFileNumberInPendingOutputs(). It then marks that any file
  // created between the calls CaptureCurrentFileNumberInPendingOutputs() and
  // ReleaseFileNumberFromPendingOutputs() can now be deleted (if it's not live
  // and blocked by any other pending_outputs_ calls)
  void ReleaseFileNumberFromPendingOutputs(std::list<uint64_t>::iterator v);

337
  // Flush the in-memory write buffer to storage.  Switches to a new
J
jorlow@chromium.org 已提交
338
  // log-file/memtable and writes a new descriptor iff successful.
I
Igor Canadi 已提交
339 340 341 342
  Status FlushMemTableToOutputFile(ColumnFamilyData* cfd,
                                   const MutableCFOptions& mutable_cf_options,
                                   bool* madeProgress, JobContext* job_context,
                                   LogBuffer* log_buffer);
J
jorlow@chromium.org 已提交
343

S
Stanislau Hlebik 已提交
344 345 346
  // REQUIRES: log_numbers are sorted in ascending order
  Status RecoverLogFiles(const std::vector<uint64_t>& log_numbers,
                         SequenceNumber* max_sequence, bool read_only);
J
jorlow@chromium.org 已提交
347

348 349 350 351 352
  // The following two methods are used to flush a memtable to
  // storage. The first one is used atdatabase RecoveryTime (when the
  // database is opened) and is heavyweight because it holds the mutex
  // for the entire period. The second method WriteLevel0Table supports
  // concurrent flush memtables to storage.
353 354
  Status WriteLevel0TableForRecovery(ColumnFamilyData* cfd, MemTable* mem,
                                     VersionEdit* edit);
I
Igor Canadi 已提交
355
  Status DelayWrite(uint64_t expiration_time);
356

I
Igor Canadi 已提交
357
  Status ScheduleFlushes(WriteContext* context);
358

S
Stanislau Hlebik 已提交
359 360 361
  Status SetNewMemtableAndNewLogFile(ColumnFamilyData* cfd,
                                     WriteContext* context);

H
heyongqiang 已提交
362
  // Force current memtable contents to be flushed.
363
  Status FlushMemTable(ColumnFamilyData* cfd, const FlushOptions& options);
H
heyongqiang 已提交
364

365
  // Wait for memtable flushed
366
  Status WaitForFlushMemTable(ColumnFamilyData* cfd);
H
heyongqiang 已提交
367

368 369 370
  void RecordFlushIOStats();
  void RecordCompactionIOStats();

I
Igor Canadi 已提交
371
#ifndef ROCKSDB_LITE
372 373 374 375
  Status CompactFilesImpl(
      const CompactionOptions& compact_options, ColumnFamilyData* cfd,
      Version* version, const std::vector<std::string>& input_file_names,
      const int output_level, int output_path_id);
I
Igor Canadi 已提交
376
#endif  // ROCKSDB_LITE
377 378 379

  ColumnFamilyData* GetColumnFamilyDataByName(const std::string& cf_name);

380
  void MaybeScheduleFlushOrCompaction();
381 382
  void SchedulePendingFlush(ColumnFamilyData* cfd);
  void SchedulePendingCompaction(ColumnFamilyData* cfd);
383 384 385 386
  static void BGWorkCompaction(void* db);
  static void BGWorkFlush(void* db);
  void BackgroundCallCompaction();
  void BackgroundCallFlush();
I
Igor Canadi 已提交
387
  Status BackgroundCompaction(bool* madeProgress, JobContext* job_context,
388
                              LogBuffer* log_buffer);
I
Igor Canadi 已提交
389
  Status BackgroundFlush(bool* madeProgress, JobContext* job_context,
H
Haobo Xu 已提交
390
                         LogBuffer* log_buffer);
J
jorlow@chromium.org 已提交
391

I
Igor Canadi 已提交
392 393 394
  // This function is called as part of compaction. It enables Flush process to
  // preempt compaction, since it's higher prioirty
  uint64_t CallFlushDuringCompaction(ColumnFamilyData* cfd,
I
Igor Canadi 已提交
395 396 397
                                     const MutableCFOptions& mutable_cf_options,
                                     JobContext* job_context,
                                     LogBuffer* log_buffer);
I
Igor Canadi 已提交
398

399 400
  void PrintStatistics();

401
  // dump rocksdb.stats to LOG
402 403
  void MaybeDumpStats();

404 405
  // Return the minimum empty level that could hold the total data in the
  // input level. Return the input level, if such level could not be found.
406 407
  int FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd,
      const MutableCFOptions& mutable_cf_options, int level);
408

409 410 411
  // Move the files in the input level to the target level.
  // If target_level < 0, automatically calculate the minimum level that could
  // hold the data set.
I
Igor Canadi 已提交
412
  Status ReFitLevel(ColumnFamilyData* cfd, int level, int target_level = -1);
413

414 415 416 417 418 419
  // helper functions for adding and removing from flush & compaction queues
  void AddToCompactionQueue(ColumnFamilyData* cfd);
  ColumnFamilyData* PopFirstFromCompactionQueue();
  void AddToFlushQueue(ColumnFamilyData* cfd);
  ColumnFamilyData* PopFirstFromFlushQueue();

J
jorlow@chromium.org 已提交
420
  // table_cache_ provides its own synchronization
I
Igor Canadi 已提交
421
  std::shared_ptr<Cache> table_cache_;
J
jorlow@chromium.org 已提交
422

423
  // Lock over the persistent DB state.  Non-nullptr iff successfully acquired.
J
jorlow@chromium.org 已提交
424 425 426
  FileLock* db_lock_;

  // State below is protected by mutex_
427
  InstrumentedMutex mutex_;
I
Igor Canadi 已提交
428
  std::atomic<bool> shutting_down_;
429 430 431 432 433 434 435 436
  // This condition variable is signaled on these conditions:
  // * whenever bg_compaction_scheduled_ goes down to 0
  // * if bg_manual_only_ > 0, whenever a compaction finishes, even if it hasn't
  // made any progress
  // * whenever a compaction made any progress
  // * whenever bg_flush_scheduled_ value decreases (i.e. whenever a flush is
  // done, even if it didn't make any progress)
  // * whenever there is an error in background flush or compaction
437
  InstrumentedCondVar bg_cv_;
438
  uint64_t logfile_number_;
439
  unique_ptr<log::Writer> log_;
440
  bool log_dir_synced_;
I
Igor Canadi 已提交
441
  bool log_empty_;
442
  ColumnFamilyHandleImpl* default_cf_handle_;
443
  InternalStats* default_cf_internal_stats_;
444
  unique_ptr<ColumnFamilyMemTablesImpl> column_family_memtables_;
I
Igor Canadi 已提交
445 446 447 448 449 450 451 452 453 454 455 456 457
  struct LogFileNumberSize {
    explicit LogFileNumberSize(uint64_t _number)
        : number(_number), size(0), getting_flushed(false) {}
    void AddSize(uint64_t new_size) { size += new_size; }
    uint64_t number;
    uint64_t size;
    bool getting_flushed;
  };
  std::deque<LogFileNumberSize> alive_log_files_;
  uint64_t total_log_size_;
  // only used for dynamically adjusting max_total_wal_size. it is a sum of
  // [write_buffer_size * max_write_buffer_number] over all column families
  uint64_t max_total_in_memory_state_;
458 459 460
  // If true, we have only one (default) column family. We use this to optimize
  // some code-paths
  bool single_column_family_mode_;
I
Igor Canadi 已提交
461

S
sdong 已提交
462 463
  bool is_snapshot_supported_;

464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
  // Class to maintain directories for all database paths other than main one.
  class Directories {
   public:
    Status SetDirectories(Env* env, const std::string& dbname,
                          const std::string& wal_dir,
                          const std::vector<DbPath>& data_paths);

    Directory* GetDataDir(size_t path_id);

    Directory* GetWalDir() {
      if (wal_dir_) {
        return wal_dir_.get();
      }
      return db_dir_.get();
    }

    Directory* GetDbDir() { return db_dir_.get(); }

   private:
    std::unique_ptr<Directory> db_dir_;
    std::vector<std::unique_ptr<Directory>> data_dirs_;
    std::unique_ptr<Directory> wal_dir_;

    Status CreateAndNewDirectory(Env* env, const std::string& dirname,
                                 std::unique_ptr<Directory>* directory) const;
  };

  Directories directories_;
492

493 494
  WriteBuffer write_buffer_;

I
Igor Canadi 已提交
495 496
  WriteThread write_thread_;

497
  WriteBatch tmp_batch_;
498

499
  WriteController write_controller_;
I
Igor Canadi 已提交
500
  FlushScheduler flush_scheduler_;
501

J
jorlow@chromium.org 已提交
502 503
  SnapshotList snapshots_;

I
Igor Canadi 已提交
504 505 506 507 508 509 510 511 512 513
  // For each background job, pending_outputs_ keeps the current file number at
  // the time that background job started.
  // FindObsoleteFiles()/PurgeObsoleteFiles() never deletes any file that has
  // number bigger than any of the file number in pending_outputs_. Since file
  // numbers grow monotonically, this also means that pending_outputs_ is always
  // sorted. After a background job is done executing, its file number is
  // deleted from pending_outputs_, which allows PurgeObsoleteFiles() to clean
  // it up.
  // State is protected with db mutex.
  std::list<uint64_t> pending_outputs_;
J
jorlow@chromium.org 已提交
514

515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
  // flush_queue_ and compaction_queue_ hold column families that we need to
  // flush and compact, respectively.
  // A column family is inserted into flush_queue_ when it satisfies condition
  // cfd->imm()->IsFlushPending()
  // A column family is inserted into compaction_queue_ when it satisfied
  // condition cfd->NeedsCompaction()
  // Column families in this list are all Ref()-erenced
  // TODO(icanadi) Provide some kind of ReferencedColumnFamily class that will
  // do RAII on ColumnFamilyData
  // Column families are in this queue when they need to be flushed or
  // compacted. Consumers of these queues are flush and compaction threads. When
  // column family is put on this queue, we increase unscheduled_flushes_ and
  // unscheduled_compactions_. When these variables are bigger than zero, that
  // means we need to schedule background threads for compaction and thread.
  // Once the background threads are scheduled, we decrease unscheduled_flushes_
  // and unscheduled_compactions_. That way we keep track of number of
  // compaction and flush threads we need to schedule. This scheduling is done
  // in MaybeScheduleFlushOrCompaction()
  // invariant(column family present in flush_queue_ <==>
  // ColumnFamilyData::pending_flush_ == true)
  std::deque<ColumnFamilyData*> flush_queue_;
  // invariant(column family present in compaction_queue_ <==>
  // ColumnFamilyData::pending_compaction_ == true)
  std::deque<ColumnFamilyData*> compaction_queue_;
  int unscheduled_flushes_;
  int unscheduled_compactions_;
541

542
  // count how many background compactions are running or have been scheduled
543
  int bg_compaction_scheduled_;
J
jorlow@chromium.org 已提交
544

545 546 547 548 549
  // If non-zero, MaybeScheduleFlushOrCompaction() will only schedule manual
  // compactions (if manual_compaction_ is not null). This mechanism enables
  // manual compactions to wait until all other compactions are finished.
  int bg_manual_only_;

550 551 552
  // number of background memtable flush jobs, submitted to the HIGH pool
  int bg_flush_scheduled_;

H
hans@chromium.org 已提交
553 554
  // Information for a manual compaction
  struct ManualCompaction {
I
Igor Canadi 已提交
555
    ColumnFamilyData* cfd;
556 557
    int input_level;
    int output_level;
558
    uint32_t output_path_id;
G
Gabor Cselle 已提交
559
    bool done;
L
Lei Jin 已提交
560
    Status status;
561
    bool in_progress;           // compaction request being processed?
562 563
    const InternalKey* begin;   // nullptr means beginning of key range
    const InternalKey* end;     // nullptr means end of key range
G
Gabor Cselle 已提交
564
    InternalKey tmp_storage;    // Used to keep track of compaction progress
H
hans@chromium.org 已提交
565 566
  };
  ManualCompaction* manual_compaction_;
J
jorlow@chromium.org 已提交
567 568 569 570

  // Have we encountered a background error in paranoid mode?
  Status bg_error_;

571
  // shall we disable deletion of obsolete files
572 573 574 575 576 577
  // if 0 the deletion is enabled.
  // if non-zero, files will not be getting deleted
  // This enables two different threads to call
  // EnableFileDeletions() and DisableFileDeletions()
  // without any synchronization
  int disable_delete_obsolete_files_;
578

I
Igor Canadi 已提交
579 580
  // next time when we should run DeleteObsoleteFiles with full scan
  uint64_t delete_obsolete_files_next_run_;
581

582
  // last time stats were dumped to LOG
H
Haobo Xu 已提交
583
  std::atomic<uint64_t> last_stats_dump_time_microsec_;
584

585 586 587 588
  // Each flush or compaction gets its own job id. this counter makes sure
  // they're unique
  std::atomic<int> next_job_id_;

589 590
  bool flush_on_destroy_; // Used when disableWAL is true.

H
heyongqiang 已提交
591
  static const int KEEP_LOG_FILE_NUM = 1000;
H
heyongqiang 已提交
592
  std::string db_absolute_path_;
H
heyongqiang 已提交
593

594
  // The options to access storage files
L
Lei Jin 已提交
595
  const EnvOptions env_options_;
596

I
Igor Canadi 已提交
597 598 599 600
#ifndef ROCKSDB_LITE
  WalManager wal_manager_;
#endif  // ROCKSDB_LITE

601 602 603 604 605 606
  // A value of true temporarily disables scheduling of background work
  bool bg_work_gate_closed_;

  // Guard against multiple concurrent refitting
  bool refitting_level_;

607 608 609
  // Indicate DB was opened successfully
  bool opened_successfully_;

610 611 612 613 614 615
  // The list of registered event listeners.
  std::list<EventListener*> listeners_;

  // count how many events are currently being notified.
  int notifying_events_;

J
jorlow@chromium.org 已提交
616 617 618 619
  // No copying allowed
  DBImpl(const DBImpl&);
  void operator=(const DBImpl&);

620 621 622 623 624 625
  // Return the earliest snapshot where seqno is visible.
  // Store the snapshot right before that, if any, in prev_snapshot
  inline SequenceNumber findEarliestVisibleSnapshot(
    SequenceNumber in,
    std::vector<SequenceNumber>& snapshots,
    SequenceNumber* prev_snapshot);
626

I
Igor Canadi 已提交
627
  // Background threads call this function, which is just a wrapper around
I
Igor Canadi 已提交
628 629 630 631 632 633
  // the InstallSuperVersion() function. Background threads carry
  // job_context which can have new_superversion already
  // allocated.
  void InstallSuperVersionBackground(
      ColumnFamilyData* cfd, JobContext* job_context,
      const MutableCFOptions& mutable_cf_options);
L
Lei Jin 已提交
634

635 636 637 638 639 640 641 642 643 644 645
  // All ColumnFamily state changes go through this function. Here we analyze
  // the new state and we schedule background work if we detect that the new
  // state needs flush or compaction.
  // If dont_schedule_bg_work == true, then caller asks us to not schedule flush
  // or compaction here, but it also promises to schedule needed background
  // work. We use this to  scheduling background compactions when we are in the
  // write thread, which is very performance critical. Caller schedules
  // background work as soon as it exits the write thread
  SuperVersion* InstallSuperVersion(ColumnFamilyData* cfd, SuperVersion* new_sv,
                                    const MutableCFOptions& mutable_cf_options,
                                    bool dont_schedule_bg_work = false);
I
Igor Canadi 已提交
646

647 648 649 650 651 652 653 654 655 656
  // Find Super version and reference it. Based on options, it might return
  // the thread local cached one.
  inline SuperVersion* GetAndRefSuperVersion(ColumnFamilyData* cfd);

  // Un-reference the super version and return it to thread local cache if
  // needed. If it is the last reference of the super version. Clean it up
  // after un-referencing it.
  inline void ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                           SuperVersion* sv);

I
Igor Canadi 已提交
657
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
658 659 660
  using DB::GetPropertiesOfAllTables;
  virtual Status GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                          TablePropertiesCollection* props)
661
      override;
I
Igor Canadi 已提交
662
#endif  // ROCKSDB_LITE
663

664 665
  // Function that Get and KeyMayExist call with no_io true or false
  // Note: 'value_found' from KeyMayExist propagates here
666 667 668
  Status GetImpl(const ReadOptions& options, ColumnFamilyHandle* column_family,
                 const Slice& key, std::string* value,
                 bool* value_found = nullptr);
669 670 671 672

  bool GetIntPropertyInternal(ColumnFamilyHandle* column_family,
                              DBPropertyType property_type,
                              bool need_out_of_mutex, uint64_t* value);
J
jorlow@chromium.org 已提交
673 674 675 676 677 678 679
};

// Sanitize db options.  The caller should delete result.info_log if
// it is not equal to src.info_log.
extern Options SanitizeOptions(const std::string& db,
                               const InternalKeyComparator* icmp,
                               const Options& src);
680
extern DBOptions SanitizeOptions(const std::string& db, const DBOptions& src);
S
Siying Dong 已提交
681

M
miguelportilla 已提交
682 683 684 685 686 687 688
// Fix user-supplied options to be reasonable
template <class T, class V>
static void ClipToRange(T* ptr, V minvalue, V maxvalue) {
  if (static_cast<V>(*ptr) > maxvalue) *ptr = maxvalue;
  if (static_cast<V>(*ptr) < minvalue) *ptr = minvalue;
}

689
}  // namespace rocksdb