db_impl.cc 171.4 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 9 10 11
// 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.

#include "db/db_impl.h"

I
Igor Canadi 已提交
12 13
#define __STDC_FORMAT_MACROS
#include <inttypes.h>
J
jorlow@chromium.org 已提交
14
#include <algorithm>
15 16
#include <climits>
#include <cstdio>
J
jorlow@chromium.org 已提交
17
#include <set>
18
#include <stdexcept>
19 20
#include <stdint.h>
#include <string>
21
#include <unordered_set>
22
#include <unordered_map>
T
Tomislav Novak 已提交
23
#include <utility>
24
#include <vector>
25

J
jorlow@chromium.org 已提交
26
#include "db/builder.h"
27
#include "db/db_iter.h"
K
kailiu 已提交
28
#include "db/dbformat.h"
J
jorlow@chromium.org 已提交
29 30 31 32
#include "db/filename.h"
#include "db/log_reader.h"
#include "db/log_writer.h"
#include "db/memtable.h"
K
kailiu 已提交
33
#include "db/memtable_list.h"
34
#include "db/merge_context.h"
35
#include "db/merge_helper.h"
J
jorlow@chromium.org 已提交
36
#include "db/table_cache.h"
K
kailiu 已提交
37
#include "db/table_properties_collector.h"
T
Tomislav Novak 已提交
38
#include "db/tailing_iter.h"
L
Lei Jin 已提交
39
#include "db/forward_iterator.h"
40
#include "db/transaction_log_impl.h"
J
jorlow@chromium.org 已提交
41 42
#include "db/version_set.h"
#include "db/write_batch_internal.h"
43
#include "port/port.h"
I
Igor Canadi 已提交
44
#include "rocksdb/cache.h"
45
#include "port/likely.h"
46 47 48 49 50 51
#include "rocksdb/compaction_filter.h"
#include "rocksdb/db.h"
#include "rocksdb/env.h"
#include "rocksdb/merge_operator.h"
#include "rocksdb/statistics.h"
#include "rocksdb/status.h"
S
Siying Dong 已提交
52
#include "rocksdb/table.h"
J
jorlow@chromium.org 已提交
53
#include "table/block.h"
54
#include "table/block_based_table_factory.h"
J
jorlow@chromium.org 已提交
55
#include "table/merger.h"
K
kailiu 已提交
56
#include "table/table_builder.h"
J
jorlow@chromium.org 已提交
57
#include "table/two_level_iterator.h"
58
#include "util/auto_roll_logger.h"
K
kailiu 已提交
59
#include "util/autovector.h"
60
#include "util/build_version.h"
J
jorlow@chromium.org 已提交
61
#include "util/coding.h"
I
Igor Canadi 已提交
62
#include "util/hash_skiplist_rep.h"
63
#include "util/hash_linklist_rep.h"
J
jorlow@chromium.org 已提交
64
#include "util/logging.h"
H
Haobo Xu 已提交
65
#include "util/log_buffer.h"
J
jorlow@chromium.org 已提交
66
#include "util/mutexlock.h"
67
#include "util/perf_context_imp.h"
68
#include "util/iostats_context_imp.h"
69
#include "util/stop_watch.h"
70
#include "util/sync_point.h"
J
jorlow@chromium.org 已提交
71

72
namespace rocksdb {
J
jorlow@chromium.org 已提交
73

74
const std::string kDefaultColumnFamilyName("default");
75

K
kailiu 已提交
76
void DumpLeveldbBuildVersion(Logger * log);
77

78 79 80 81 82
// Information kept for every waiting writer
struct DBImpl::Writer {
  Status status;
  WriteBatch* batch;
  bool sync;
H
heyongqiang 已提交
83
  bool disableWAL;
84
  bool in_batch_group;
85
  bool done;
86
  uint64_t timeout_hint_us;
87 88 89 90 91
  port::CondVar cv;

  explicit Writer(port::Mutex* mu) : cv(mu) { }
};

J
jorlow@chromium.org 已提交
92 93 94
struct DBImpl::CompactionState {
  Compaction* const compaction;

95 96 97 98 99
  // If there were two snapshots with seq numbers s1 and
  // s2 and s1 < s2, and if we find two instances of a key k1 then lies
  // entirely within s1 and s2, then the earlier version of k1 can be safely
  // deleted because that version is not visible in any snapshot.
  std::vector<SequenceNumber> existing_snapshots;
J
jorlow@chromium.org 已提交
100 101 102 103

  // Files produced by compaction
  struct Output {
    uint64_t number;
104
    uint32_t path_id;
J
jorlow@chromium.org 已提交
105 106
    uint64_t file_size;
    InternalKey smallest, largest;
107
    SequenceNumber smallest_seqno, largest_seqno;
J
jorlow@chromium.org 已提交
108 109
  };
  std::vector<Output> outputs;
110
  std::list<uint64_t> allocated_file_numbers;
J
jorlow@chromium.org 已提交
111 112

  // State kept for output being generated
113 114
  unique_ptr<WritableFile> outfile;
  unique_ptr<TableBuilder> builder;
J
jorlow@chromium.org 已提交
115 116 117 118 119 120 121 122 123

  uint64_t total_bytes;

  Output* current_output() { return &outputs[outputs.size()-1]; }

  explicit CompactionState(Compaction* c)
      : compaction(c),
        total_bytes(0) {
  }
124

125 126 127 128 129 130 131 132
  // Create a client visible context of this compaction
  CompactionFilter::Context GetFilterContextV1() {
    CompactionFilter::Context context;
    context.is_full_compaction = compaction->IsFullCompaction();
    context.is_manual_compaction = compaction->IsManualCompaction();
    return context;
  }

133
  // Create a client visible context of this compaction
D
Danny Guo 已提交
134 135
  CompactionFilterContext GetFilterContext() {
    CompactionFilterContext context;
136
    context.is_full_compaction = compaction->IsFullCompaction();
137
    context.is_manual_compaction = compaction->IsManualCompaction();
138 139
    return context;
  }
D
Danny Guo 已提交
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

  std::vector<Slice> key_buf_;
  std::vector<Slice> existing_value_buf_;
  std::vector<std::string> key_str_buf_;
  std::vector<std::string> existing_value_str_buf_;
  // new_value_buf_ will only be appended if a value changes
  std::vector<std::string> new_value_buf_;
  // if values_changed_buf_[i] is true
  // new_value_buf_ will add a new entry with the changed value
  std::vector<bool> value_changed_buf_;
  // to_delete_buf_[i] is true iff key_buf_[i] is deleted
  std::vector<bool> to_delete_buf_;
  // buffer for the parsed internal keys, the string buffer is backed
  // by key_str_buf_
  std::vector<ParsedInternalKey> ikey_buf_;

  std::vector<Slice> other_key_buf_;
  std::vector<Slice> other_value_buf_;
  std::vector<std::string> other_key_str_buf_;
  std::vector<std::string> other_value_str_buf_;

  std::vector<Slice> combined_key_buf_;
  std::vector<Slice> combined_value_buf_;

  std::string cur_prefix_;

  // Buffers the kv-pair that will be run through compaction filter V2
  // in the future.
  void BufferKeyValueSlices(const Slice& key, const Slice& value) {
    key_str_buf_.emplace_back(key.ToString());
    existing_value_str_buf_.emplace_back(value.ToString());
    key_buf_.emplace_back(Slice(key_str_buf_.back()));
    existing_value_buf_.emplace_back(Slice(existing_value_str_buf_.back()));

    ParsedInternalKey ikey;
    ParseInternalKey(key_buf_.back(), &ikey);
    ikey_buf_.emplace_back(ikey);
  }

  // Buffers the kv-pair that will not be run through compaction filter V2
  // in the future.
  void BufferOtherKeyValueSlices(const Slice& key, const Slice& value) {
    other_key_str_buf_.emplace_back(key.ToString());
    other_value_str_buf_.emplace_back(value.ToString());
    other_key_buf_.emplace_back(Slice(other_key_str_buf_.back()));
    other_value_buf_.emplace_back(Slice(other_value_str_buf_.back()));
  }

  // Add a kv-pair to the combined buffer
  void AddToCombinedKeyValueSlices(const Slice& key, const Slice& value) {
    // The real strings are stored in the batch buffers
    combined_key_buf_.emplace_back(key);
    combined_value_buf_.emplace_back(value);
  }

  // Merging the two buffers
  void MergeKeyValueSliceBuffer(const InternalKeyComparator* comparator) {
    size_t i = 0;
    size_t j = 0;
    size_t total_size = key_buf_.size() + other_key_buf_.size();
    combined_key_buf_.reserve(total_size);
    combined_value_buf_.reserve(total_size);

    while (i + j < total_size) {
      int comp_res = 0;
      if (i < key_buf_.size() && j < other_key_buf_.size()) {
        comp_res = comparator->Compare(key_buf_[i], other_key_buf_[j]);
      } else if (i >= key_buf_.size() && j < other_key_buf_.size()) {
        comp_res = 1;
      } else if (j >= other_key_buf_.size() && i < key_buf_.size()) {
        comp_res = -1;
      }
      if (comp_res > 0) {
        AddToCombinedKeyValueSlices(other_key_buf_[j], other_value_buf_[j]);
        j++;
      } else if (comp_res < 0) {
        AddToCombinedKeyValueSlices(key_buf_[i], existing_value_buf_[i]);
        i++;
      }
    }
  }

  void CleanupBatchBuffer() {
    to_delete_buf_.clear();
    key_buf_.clear();
    existing_value_buf_.clear();
    key_str_buf_.clear();
    existing_value_str_buf_.clear();
    new_value_buf_.clear();
    value_changed_buf_.clear();
    ikey_buf_.clear();

    to_delete_buf_.shrink_to_fit();
    key_buf_.shrink_to_fit();
    existing_value_buf_.shrink_to_fit();
    key_str_buf_.shrink_to_fit();
    existing_value_str_buf_.shrink_to_fit();
    new_value_buf_.shrink_to_fit();
    value_changed_buf_.shrink_to_fit();
    ikey_buf_.shrink_to_fit();

    other_key_buf_.clear();
    other_value_buf_.clear();
    other_key_str_buf_.clear();
    other_value_str_buf_.clear();
    other_key_buf_.shrink_to_fit();
    other_value_buf_.shrink_to_fit();
    other_key_str_buf_.shrink_to_fit();
    other_value_str_buf_.shrink_to_fit();
  }

  void CleanupMergedBuffer() {
    combined_key_buf_.clear();
    combined_value_buf_.clear();
    combined_key_buf_.shrink_to_fit();
    combined_value_buf_.shrink_to_fit();
  }
J
jorlow@chromium.org 已提交
257 258
};

259
namespace {
J
jorlow@chromium.org 已提交
260
// Fix user-supplied options to be reasonable
261
template <class T, class V>
J
jorlow@chromium.org 已提交
262
static void ClipToRange(T* ptr, V minvalue, V maxvalue) {
D
dgrogan@chromium.org 已提交
263 264
  if (static_cast<V>(*ptr) > maxvalue) *ptr = maxvalue;
  if (static_cast<V>(*ptr) < minvalue) *ptr = minvalue;
J
jorlow@chromium.org 已提交
265
}
266 267
}  // anonymous namespace

J
jorlow@chromium.org 已提交
268 269
Options SanitizeOptions(const std::string& dbname,
                        const InternalKeyComparator* icmp,
S
Sanjay Ghemawat 已提交
270
                        const InternalFilterPolicy* ipolicy,
J
jorlow@chromium.org 已提交
271
                        const Options& src) {
272 273 274 275 276 277 278
  auto db_options = SanitizeOptions(dbname, DBOptions(src));
  auto cf_options = SanitizeOptions(icmp, ipolicy, ColumnFamilyOptions(src));
  return Options(db_options, cf_options);
}

DBOptions SanitizeOptions(const std::string& dbname, const DBOptions& src) {
  DBOptions result = src;
L
Lei Jin 已提交
279

280 281
  // result.max_open_files means an "infinite" open files.
  if (result.max_open_files != -1) {
282
    ClipToRange(&result.max_open_files, 20, 1000000);
283
  }
284

285
  if (result.info_log == nullptr) {
K
Kai Liu 已提交
286 287
    Status s = CreateLoggerFromOptions(dbname, result.db_log_dir, src.env,
                                       result, &result.info_log);
J
jorlow@chromium.org 已提交
288 289
    if (!s.ok()) {
      // No place suitable for logging
290
      result.info_log = nullptr;
J
jorlow@chromium.org 已提交
291 292
    }
  }
293 294 295 296 297

  if (result.wal_dir.empty()) {
    // Use dbname as default
    result.wal_dir = dbname;
  }
298
  if (result.wal_dir.back() == '/') {
I
Igor Canadi 已提交
299
    result.wal_dir = result.wal_dir.substr(0, result.wal_dir.size() - 1);
300
  }
301

302
  if (result.db_paths.size() == 0) {
303
    result.db_paths.emplace_back(dbname, std::numeric_limits<uint64_t>::max());
304 305
  }

J
jorlow@chromium.org 已提交
306 307 308
  return result;
}

309
namespace {
310 311 312 313 314 315 316
CompressionType GetCompressionFlush(const Options& options) {
  // Compressing memtable flushes might not help unless the sequential load
  // optimization is used for leveled compaction. Otherwise the CPU and
  // latency overhead is not offset by saving much space.

  bool can_compress;

317
  if (options.compaction_style == kCompactionStyleUniversal) {
318 319 320 321
    can_compress =
        (options.compaction_options_universal.compression_size_percent < 0);
  } else {
    // For leveled compress when min_level_to_compress == 0.
322 323
    can_compress = options.compression_per_level.empty() ||
                   options.compression_per_level[0] != kNoCompression;
324 325 326 327 328 329 330 331
  }

  if (can_compress) {
    return options.compression;
  } else {
    return kNoCompression;
  }
}
332
}  // namespace
333

I
Igor Canadi 已提交
334
DBImpl::DBImpl(const DBOptions& options, const std::string& dbname)
J
jorlow@chromium.org 已提交
335
    : env_(options.env),
H
heyongqiang 已提交
336
      dbname_(dbname),
I
Igor Canadi 已提交
337
      options_(SanitizeOptions(dbname, options)),
L
Lei Jin 已提交
338
      stats_(options_.statistics.get()),
339
      db_lock_(nullptr),
H
Haobo Xu 已提交
340
      mutex_(options.use_adaptive_mutex),
341
      shutting_down_(nullptr),
J
jorlow@chromium.org 已提交
342
      bg_cv_(&mutex_),
343
      logfile_number_(0),
I
Igor Canadi 已提交
344
      log_empty_(true),
345
      default_cf_handle_(nullptr),
I
Igor Canadi 已提交
346 347
      total_log_size_(0),
      max_total_in_memory_state_(0),
348
      tmp_batch_(),
349
      bg_schedule_needed_(false),
350
      bg_compaction_scheduled_(0),
351
      bg_manual_only_(0),
352
      bg_flush_scheduled_(0),
353
      manual_compaction_(nullptr),
354
      disable_delete_obsolete_files_(0),
I
Igor Canadi 已提交
355
      delete_obsolete_files_last_run_(options.env->NowMicros()),
356
      purge_wal_files_last_run_(0),
357
      last_stats_dump_time_microsec_(0),
358
      default_interval_to_delete_obsolete_WAL_(600),
359
      flush_on_destroy_(false),
360
      delayed_writes_(0),
361 362
      storage_options_(options),
      bg_work_gate_closed_(false),
363 364
      refitting_level_(false),
      opened_successfully_(false) {
H
heyongqiang 已提交
365
  env_->GetAbsolutePath(dbname, &db_absolute_path_);
366

J
jorlow@chromium.org 已提交
367
  // Reserve ten files or so for other uses and give the rest to TableCache.
368 369
  // Give a large number for setting of "infinite" open files.
  const int table_cache_size =
370 371 372 373 374 375
      (options_.max_open_files == -1) ? 4194304 : options_.max_open_files - 10;
  // Reserve ten files or so for other uses and give the rest to TableCache.
  table_cache_ =
      NewLRUCache(table_cache_size, options_.table_cache_numshardbits,
                  options_.table_cache_remove_scan_count_limit);

I
Igor Canadi 已提交
376 377
  versions_.reset(
      new VersionSet(dbname_, &options_, storage_options_, table_cache_.get()));
378 379
  column_family_memtables_.reset(
      new ColumnFamilyMemTablesImpl(versions_->GetColumnFamilySet()));
380

K
kailiu 已提交
381
  DumpLeveldbBuildVersion(options_.info_log.get());
382
  options_.Dump(options_.info_log.get());
383

I
Igor Canadi 已提交
384
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
385 386 387
}

DBImpl::~DBImpl() {
388 389 390 391 392 393 394 395
  mutex_.Lock();
  if (flush_on_destroy_) {
    for (auto cfd : *versions_->GetColumnFamilySet()) {
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
        cfd->Ref();
        mutex_.Unlock();
        FlushMemTable(cfd, FlushOptions());
        mutex_.Lock();
396
        cfd->Unref();
397 398
      }
    }
399
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
400
  }
I
Igor Canadi 已提交
401 402

  // Wait for background work to finish
403
  shutting_down_.Release_Store(this);  // Any non-nullptr value is ok
I
Igor Canadi 已提交
404
  while (bg_compaction_scheduled_ || bg_flush_scheduled_) {
H
hans@chromium.org 已提交
405
    bg_cv_.Wait();
J
jorlow@chromium.org 已提交
406
  }
407

I
Igor Canadi 已提交
408 409 410 411 412
  if (default_cf_handle_ != nullptr) {
    // we need to delete handle outside of lock because it does its own locking
    mutex_.Unlock();
    delete default_cf_handle_;
    mutex_.Lock();
413 414
  }

415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
  if (options_.allow_thread_local) {
    // Clean up obsolete files due to SuperVersion release.
    // (1) Need to delete to obsolete files before closing because RepairDB()
    // scans all existing files in the file system and builds manifest file.
    // Keeping obsolete files confuses the repair process.
    // (2) Need to check if we Open()/Recover() the DB successfully before
    // deleting because if VersionSet recover fails (may be due to corrupted
    // manifest file), it is not able to identify live files correctly. As a
    // result, all "live" files can get deleted by accident. However, corrupted
    // manifest is recoverable by RepairDB().
    if (opened_successfully_) {
      DeletionState deletion_state;
      FindObsoleteFiles(deletion_state, true);
      // manifest number starting from 2
      deletion_state.manifest_file_number = 1;
430 431 432
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
433 434 435
    }
  }

436
  // versions need to be destroyed before table_cache since it can hold
437 438
  // references to table_cache.
  versions_.reset();
439
  mutex_.Unlock();
I
Igor Canadi 已提交
440 441 442
  if (db_lock_ != nullptr) {
    env_->UnlockFile(db_lock_);
  }
443

I
Igor Canadi 已提交
444
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
445 446 447
}

Status DBImpl::NewDB() {
448
  VersionEdit new_db;
449
  new_db.SetLogNumber(0);
J
jorlow@chromium.org 已提交
450 451 452
  new_db.SetNextFile(2);
  new_db.SetLastSequence(0);

453
  Log(options_.info_log, "Creating manifest 1 \n");
J
jorlow@chromium.org 已提交
454
  const std::string manifest = DescriptorFileName(dbname_, 1);
455
  unique_ptr<WritableFile> file;
I
Igor Canadi 已提交
456 457
  Status s = env_->NewWritableFile(
      manifest, &file, env_->OptimizeForManifestWrite(storage_options_));
J
jorlow@chromium.org 已提交
458 459 460
  if (!s.ok()) {
    return s;
  }
461
  file->SetPreallocationBlockSize(options_.manifest_preallocation_size);
J
jorlow@chromium.org 已提交
462
  {
463
    log::Writer log(std::move(file));
J
jorlow@chromium.org 已提交
464 465 466 467 468 469
    std::string record;
    new_db.EncodeTo(&record);
    s = log.AddRecord(record);
  }
  if (s.ok()) {
    // Make "CURRENT" file that points to the new manifest file.
470
    s = SetCurrentFile(env_, dbname_, 1, db_directory_.get());
J
jorlow@chromium.org 已提交
471 472 473 474 475 476 477 478 479 480
  } else {
    env_->DeleteFile(manifest);
  }
  return s;
}

void DBImpl::MaybeIgnoreError(Status* s) const {
  if (s->ok() || options_.paranoid_checks) {
    // No change needed
  } else {
481
    Log(options_.info_log, "Ignoring error %s", s->ToString().c_str());
J
jorlow@chromium.org 已提交
482 483 484 485
    *s = Status::OK();
  }
}

486
const Status DBImpl::CreateArchivalDirectory() {
487
  if (options_.WAL_ttl_seconds > 0 || options_.WAL_size_limit_MB > 0) {
488
    std::string archivalPath = ArchivalDirectory(options_.wal_dir);
489 490 491 492 493
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

494
void DBImpl::PrintStatistics() {
495
  auto dbstats = options_.statistics.get();
496 497
  if (dbstats) {
    Log(options_.info_log,
498 499
        "STATISTCS:\n %s",
        dbstats->ToString().c_str());
500 501 502
  }
}

503
void DBImpl::MaybeDumpStats() {
H
Haobo Xu 已提交
504 505 506 507 508 509 510 511 512 513 514 515
  if (options_.stats_dump_period_sec == 0) return;

  const uint64_t now_micros = env_->NowMicros();

  if (last_stats_dump_time_microsec_ +
      options_.stats_dump_period_sec * 1000000
      <= now_micros) {
    // Multiple threads could race in here simultaneously.
    // However, the last one will update last_stats_dump_time_microsec_
    // atomically. We could see more than one dump during one dump
    // period in rare cases.
    last_stats_dump_time_microsec_ = now_micros;
516 517

    DBPropertyType cf_property_type = GetPropertyType("rocksdb.cfstats");
518
    DBPropertyType db_property_type = GetPropertyType("rocksdb.dbstats");
H
Haobo Xu 已提交
519
    std::string stats;
520 521 522
    {
      MutexLock l(&mutex_);
      for (auto cfd : *versions_->GetColumnFamilySet()) {
523 524
        cfd->internal_stats()->GetProperty(
            cf_property_type, "rocksdb.cfstats", &stats);
525 526
      }
      default_cf_internal_stats_->GetProperty(
527
          db_property_type, "rocksdb.dbstats", &stats);
528 529
    }
    Log(options_.info_log, "------- DUMPING STATS -------");
H
Haobo Xu 已提交
530
    Log(options_.info_log, "%s", stats.c_str());
531

532
    PrintStatistics();
533 534 535
  }
}

536
// Returns the list of live files in 'sst_live' and the list
K
kailiu 已提交
537
// of all files in the filesystem in 'candidate_files'.
I
Igor Canadi 已提交
538 539 540 541 542 543 544
// no_full_scan = true -- never do the full scan using GetChildren()
// force = false -- don't force the full scan, except every
//  options_.delete_obsolete_files_period_micros
// force = true -- force the full scan
void DBImpl::FindObsoleteFiles(DeletionState& deletion_state,
                               bool force,
                               bool no_full_scan) {
D
Dhruba Borthakur 已提交
545 546
  mutex_.AssertHeld();

547
  // if deletion is disabled, do nothing
548
  if (disable_delete_obsolete_files_ > 0) {
549 550 551
    return;
  }

552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
  bool doing_the_full_scan = false;

  // logic for figurint out if we're doing the full scan
  if (no_full_scan) {
    doing_the_full_scan = false;
  } else if (force || options_.delete_obsolete_files_period_micros == 0) {
    doing_the_full_scan = true;
  } else {
    const uint64_t now_micros = env_->NowMicros();
    if (delete_obsolete_files_last_run_ +
        options_.delete_obsolete_files_period_micros < now_micros) {
      doing_the_full_scan = true;
      delete_obsolete_files_last_run_ = now_micros;
    }
  }

I
Igor Canadi 已提交
568 569 570
  // get obsolete files
  versions_->GetObsoleteFiles(&deletion_state.sst_delete_files);

I
Igor Canadi 已提交
571 572
  // store the current filenum, lognum, etc
  deletion_state.manifest_file_number = versions_->ManifestFileNumber();
573 574
  deletion_state.pending_manifest_file_number =
      versions_->PendingManifestFileNumber();
575
  deletion_state.log_number = versions_->MinLogNumber();
I
Igor Canadi 已提交
576 577
  deletion_state.prev_log_number = versions_->PrevLogNumber();

578 579 580 581 582 583 584 585
  if (!doing_the_full_scan && !deletion_state.HaveSomethingToDelete()) {
    // avoid filling up sst_live if we're sure that we
    // are not going to do the full scan and that we don't have
    // anything to delete at the moment
    return;
  }

  // don't delete live files
586 587 588 589 590
  for (auto pair : pending_outputs_) {
    deletion_state.sst_live.emplace_back(pair.first, pair.second, 0);
  }
  /*  deletion_state.sst_live.insert(pending_outputs_.begin(),
                                   pending_outputs_.end());*/
I
Igor Canadi 已提交
591 592
  versions_->AddLiveFiles(&deletion_state.sst_live);

593
  if (doing_the_full_scan) {
594 595 596 597 598 599 600 601 602
    for (uint32_t path_id = 0; path_id < options_.db_paths.size(); path_id++) {
      // set of all files in the directory. We'll exclude files that are still
      // alive in the subsequent processings.
      std::vector<std::string> files;
      env_->GetChildren(dbname_, &files);  // Ignore errors
      for (std::string file : files) {
        deletion_state.candidate_files.emplace_back(file, path_id);
      }
    }
603 604 605 606 607

    //Add log files in wal_dir
    if (options_.wal_dir != dbname_) {
      std::vector<std::string> log_files;
      env_->GetChildren(options_.wal_dir, &log_files); // Ignore errors
608 609 610
      for (std::string log_file : log_files) {
        deletion_state.candidate_files.emplace_back(log_file, 0);
      }
611
    }
612
  }
613 614
}

615 616 617 618 619 620 621 622 623 624 625 626 627
namespace {
bool CompareCandidateFile(const rocksdb::DBImpl::CandidateFileInfo& first,
                          const rocksdb::DBImpl::CandidateFileInfo& second) {
  if (first.file_name > second.file_name) {
    return true;
  } else if (first.file_name < second.file_name) {
    return false;
  } else {
    return (first.path_id > first.path_id);
  }
}
};  // namespace

D
Dhruba Borthakur 已提交
628
// Diffs the files listed in filenames and those that do not
I
Igor Canadi 已提交
629
// belong to live files are posibly removed. Also, removes all the
630
// files in sst_delete_files and log_delete_files.
631
// It is not necessary to hold the mutex when invoking this method.
D
Dhruba Borthakur 已提交
632
void DBImpl::PurgeObsoleteFiles(DeletionState& state) {
633 634
  // we'd better have sth to delete
  assert(state.HaveSomethingToDelete());
635

I
Igor Canadi 已提交
636 637 638 639
  // this checks if FindObsoleteFiles() was run before. If not, don't do
  // PurgeObsoleteFiles(). If FindObsoleteFiles() was run, we need to also
  // run PurgeObsoleteFiles(), even if disable_delete_obsolete_files_ is true
  if (state.manifest_file_number == 0) {
I
Igor Canadi 已提交
640 641
    return;
  }
642

643
  // Now, convert live list to an unordered map, WITHOUT mutex held;
644
  // set is slow.
645 646 647 648
  std::unordered_map<uint64_t, const FileDescriptor*> sst_live_map;
  for (FileDescriptor& fd : state.sst_live) {
    sst_live_map[fd.GetNumber()] = &fd;
  }
I
Igor Canadi 已提交
649

K
kailiu 已提交
650 651 652 653 654 655 656
  auto& candidate_files = state.candidate_files;
  candidate_files.reserve(
      candidate_files.size() +
      state.sst_delete_files.size() +
      state.log_delete_files.size());
  // We may ignore the dbname when generating the file names.
  const char* kDumbDbName = "";
657
  for (auto file : state.sst_delete_files) {
658 659 660
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
661
    delete file;
I
Igor Canadi 已提交
662 663
  }

K
kailiu 已提交
664 665
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
666 667
      candidate_files.emplace_back(LogFileName(kDumbDbName, file_num).substr(1),
                                   0);
I
Igor Canadi 已提交
668 669
    }
  }
670

K
kailiu 已提交
671
  // dedup state.candidate_files so we don't try to delete the same
I
Igor Canadi 已提交
672
  // file twice
673
  sort(candidate_files.begin(), candidate_files.end(), CompareCandidateFile);
674 675
  candidate_files.erase(unique(candidate_files.begin(), candidate_files.end()),
                        candidate_files.end());
J
jorlow@chromium.org 已提交
676

677 678
  std::vector<std::string> old_info_log_files;

679 680 681
  for (const auto& candidate_file : candidate_files) {
    std::string to_delete = candidate_file.file_name;
    uint32_t path_id = candidate_file.path_id;
K
kailiu 已提交
682 683 684 685 686 687
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
    if (!ParseFileName(to_delete, &number, &type)) {
      continue;
    }
J
jorlow@chromium.org 已提交
688

K
kailiu 已提交
689 690 691 692 693 694 695 696
    bool keep = true;
    switch (type) {
      case kLogFile:
        keep = ((number >= state.log_number) ||
                (number == state.prev_log_number));
        break;
      case kDescriptorFile:
        // Keep my manifest file, and any newer incarnations'
697
        // (can happen during manifest roll)
K
kailiu 已提交
698 699 700
        keep = (number >= state.manifest_file_number);
        break;
      case kTableFile:
701
        keep = (sst_live_map.find(number) != sst_live_map.end());
K
kailiu 已提交
702 703 704
        break;
      case kTempFile:
        // Any temp files that are currently being written to must
705 706 707 708
        // be recorded in pending_outputs_, which is inserted into "live".
        // Also, SetCurrentFile creates a temp file when writing out new
        // manifest, which is equal to state.pending_manifest_file_number. We
        // should not delete that file
709
        keep = (sst_live_map.find(number) != sst_live_map.end()) ||
710
               (number == state.pending_manifest_file_number);
K
kailiu 已提交
711 712 713 714
        break;
      case kInfoLogFile:
        keep = true;
        if (number != 0) {
715
          old_info_log_files.push_back(to_delete);
J
jorlow@chromium.org 已提交
716
        }
K
kailiu 已提交
717 718 719 720 721 722 723 724 725 726 727 728 729
        break;
      case kCurrentFile:
      case kDBLockFile:
      case kIdentityFile:
      case kMetaDatabase:
        keep = true;
        break;
    }

    if (keep) {
      continue;
    }

730
    std::string fname;
K
kailiu 已提交
731 732
    if (type == kTableFile) {
      // evict from cache
733
      TableCache::Evict(table_cache_.get(), number);
734 735 736 737
      fname = TableFileName(options_.db_paths, number, path_id);
    } else {
      fname =
          ((type == kLogFile) ? options_.wal_dir : dbname_) + "/" + to_delete;
K
kailiu 已提交
738
    }
739

K
kailiu 已提交
740 741
    if (type == kLogFile &&
        (options_.WAL_ttl_seconds > 0 || options_.WAL_size_limit_MB > 0)) {
742
      auto archived_log_name = ArchivedLogFileName(options_.wal_dir, number);
743 744
      // The sync point below is used in (DBTest,TransactionLogIteratorRace)
      TEST_SYNC_POINT("DBImpl::PurgeObsoleteFiles:1");
745
      Status s = env_->RenameFile(fname, archived_log_name);
746 747
      // The sync point below is used in (DBTest,TransactionLogIteratorRace)
      TEST_SYNC_POINT("DBImpl::PurgeObsoleteFiles:2");
748 749 750
      Log(options_.info_log,
          "Move log file %s to %s -- %s\n",
          fname.c_str(), archived_log_name.c_str(), s.ToString().c_str());
K
kailiu 已提交
751 752
    } else {
      Status s = env_->DeleteFile(fname);
753 754
      Log(options_.info_log, "Delete %s type=%d #%" PRIu64 " -- %s\n",
          fname.c_str(), type, number, s.ToString().c_str());
J
jorlow@chromium.org 已提交
755 756
    }
  }
H
heyongqiang 已提交
757

758
  // Delete old info log files.
759
  size_t old_info_log_file_count = old_info_log_files.size();
K
Kai Liu 已提交
760 761
  // NOTE: Currently we only support log purge when options_.db_log_dir is
  // located in `dbname` directory.
762
  if (old_info_log_file_count >= options_.keep_log_file_num &&
K
Kai Liu 已提交
763
      options_.db_log_dir.empty()) {
764 765
    std::sort(old_info_log_files.begin(), old_info_log_files.end());
    size_t end = old_info_log_file_count - options_.keep_log_file_num;
766
    for (unsigned int i = 0; i <= end; i++) {
767 768 769 770 771 772 773
      std::string& to_delete = old_info_log_files.at(i);
      Log(options_.info_log, "Delete info log file %s\n", to_delete.c_str());
      Status s = env_->DeleteFile(dbname_ + "/" + to_delete);
      if (!s.ok()) {
        Log(options_.info_log, "Delete info log file %s FAILED -- %s\n",
            to_delete.c_str(), s.ToString().c_str());
      }
H
heyongqiang 已提交
774 775
    }
  }
776
  PurgeObsoleteWALFiles();
I
Igor Canadi 已提交
777
  LogFlush(options_.info_log);
D
Dhruba Borthakur 已提交
778 779 780 781 782
}

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
  DeletionState deletion_state;
I
Igor Canadi 已提交
783
  FindObsoleteFiles(deletion_state, true);
784 785 786
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
787 788
}

I
Igor Canadi 已提交
789
#ifndef ROCKSDB_LITE
790 791 792 793 794 795 796 797
// 1. Go through all archived files and
//    a. if ttl is enabled, delete outdated files
//    b. if archive size limit is enabled, delete empty files,
//        compute file number and size.
// 2. If size limit is enabled:
//    a. compute how many files should be deleted
//    b. get sorted non-empty archived logs
//    c. delete what should be deleted
798
void DBImpl::PurgeObsoleteWALFiles() {
799 800 801 802 803 804
  bool const ttl_enabled = options_.WAL_ttl_seconds > 0;
  bool const size_limit_enabled =  options_.WAL_size_limit_MB > 0;
  if (!ttl_enabled && !size_limit_enabled) {
    return;
  }

805 806
  int64_t current_time;
  Status s = env_->GetCurrentTime(&current_time);
807 808 809 810 811 812 813 814
  if (!s.ok()) {
    Log(options_.info_log, "Can't get current time: %s", s.ToString().c_str());
    assert(false);
    return;
  }
  uint64_t const now_seconds = static_cast<uint64_t>(current_time);
  uint64_t const time_to_check = (ttl_enabled && !size_limit_enabled) ?
    options_.WAL_ttl_seconds / 2 : default_interval_to_delete_obsolete_WAL_;
815

816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
  if (purge_wal_files_last_run_ + time_to_check > now_seconds) {
    return;
  }

  purge_wal_files_last_run_ = now_seconds;

  std::string archival_dir = ArchivalDirectory(options_.wal_dir);
  std::vector<std::string> files;
  s = env_->GetChildren(archival_dir, &files);
  if (!s.ok()) {
    Log(options_.info_log, "Can't get archive files: %s", s.ToString().c_str());
    assert(false);
    return;
  }

  size_t log_files_num = 0;
  uint64_t log_file_size = 0;

  for (auto& f : files) {
    uint64_t number;
    FileType type;
    if (ParseFileName(f, &number, &type) && type == kLogFile) {
      std::string const file_path = archival_dir + "/" + f;
      if (ttl_enabled) {
        uint64_t file_m_time;
        Status const s = env_->GetFileModificationTime(file_path,
          &file_m_time);
        if (!s.ok()) {
          Log(options_.info_log, "Can't get file mod time: %s: %s",
              file_path.c_str(), s.ToString().c_str());
          continue;
        }
        if (now_seconds - file_m_time > options_.WAL_ttl_seconds) {
          Status const s = env_->DeleteFile(file_path);
          if (!s.ok()) {
            Log(options_.info_log, "Can't delete file: %s: %s",
                file_path.c_str(), s.ToString().c_str());
            continue;
I
Igor Canadi 已提交
854 855 856
          } else {
            MutexLock l(&read_first_record_cache_mutex_);
            read_first_record_cache_.erase(number);
857 858
          }
          continue;
859
        }
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
      }

      if (size_limit_enabled) {
        uint64_t file_size;
        Status const s = env_->GetFileSize(file_path, &file_size);
        if (!s.ok()) {
          Log(options_.info_log, "Can't get file size: %s: %s",
              file_path.c_str(), s.ToString().c_str());
          return;
        } else {
          if (file_size > 0) {
            log_file_size = std::max(log_file_size, file_size);
            ++log_files_num;
          } else {
            Status s = env_->DeleteFile(file_path);
            if (!s.ok()) {
              Log(options_.info_log, "Can't delete file: %s: %s",
                  file_path.c_str(), s.ToString().c_str());
              continue;
I
Igor Canadi 已提交
879 880 881
            } else {
              MutexLock l(&read_first_record_cache_mutex_);
              read_first_record_cache_.erase(number);
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
            }
          }
        }
      }
    }
  }

  if (0 == log_files_num || !size_limit_enabled) {
    return;
  }

  size_t const files_keep_num = options_.WAL_size_limit_MB *
    1024 * 1024 / log_file_size;
  if (log_files_num <= files_keep_num) {
    return;
  }

  size_t files_del_num = log_files_num - files_keep_num;
  VectorLogPtr archived_logs;
901
  GetSortedWalsOfType(archival_dir, archived_logs, kArchivedLogFile);
902 903 904 905 906 907 908 909 910 911 912 913 914 915

  if (files_del_num > archived_logs.size()) {
    Log(options_.info_log, "Trying to delete more archived log files than "
        "exist. Deleting all");
    files_del_num = archived_logs.size();
  }

  for (size_t i = 0; i < files_del_num; ++i) {
    std::string const file_path = archived_logs[i]->PathName();
    Status const s = DeleteFile(file_path);
    if (!s.ok()) {
      Log(options_.info_log, "Can't delete file: %s: %s",
          file_path.c_str(), s.ToString().c_str());
      continue;
I
Igor Canadi 已提交
916 917 918
    } else {
      MutexLock l(&read_first_record_cache_mutex_);
      read_first_record_cache_.erase(archived_logs[i]->LogNumber());
919 920
    }
  }
D
Dhruba Borthakur 已提交
921 922
}

923 924 925 926 927 928 929 930 931 932
namespace {
struct CompareLogByPointer {
  bool operator()(const unique_ptr<LogFile>& a, const unique_ptr<LogFile>& b) {
    LogFileImpl* a_impl = dynamic_cast<LogFileImpl*>(a.get());
    LogFileImpl* b_impl = dynamic_cast<LogFileImpl*>(b.get());
    return *a_impl < *b_impl;
  }
};
}

I
Igor Canadi 已提交
933 934 935 936 937 938 939 940 941 942 943 944 945
Status DBImpl::GetSortedWalsOfType(const std::string& path,
                                   VectorLogPtr& log_files,
                                   WalFileType log_type) {
  std::vector<std::string> all_files;
  const Status status = env_->GetChildren(path, &all_files);
  if (!status.ok()) {
    return status;
  }
  log_files.reserve(all_files.size());
  for (const auto& f : all_files) {
    uint64_t number;
    FileType type;
    if (ParseFileName(f, &number, &type) && type == kLogFile) {
I
Igor Canadi 已提交
946 947
      SequenceNumber sequence;
      Status s = ReadFirstRecord(log_type, number, &sequence);
I
Igor Canadi 已提交
948 949 950
      if (!s.ok()) {
        return s;
      }
I
Igor Canadi 已提交
951 952 953 954
      if (sequence == 0) {
        // empty file
        continue;
      }
I
Igor Canadi 已提交
955

956 957 958 959 960 961
      // Reproduce the race condition where a log file is moved
      // to archived dir, between these two sync points, used in
      // (DBTest,TransactionLogIteratorRace)
      TEST_SYNC_POINT("DBImpl::GetSortedWalsOfType:1");
      TEST_SYNC_POINT("DBImpl::GetSortedWalsOfType:2");

I
Igor Canadi 已提交
962 963
      uint64_t size_bytes;
      s = env_->GetFileSize(LogFileName(path, number), &size_bytes);
964 965 966 967 968
      // re-try in case the alive log file has been moved to archive.
      if (!s.ok() && log_type == kAliveLogFile &&
          env_->FileExists(ArchivedLogFileName(path, number))) {
        s = env_->GetFileSize(ArchivedLogFileName(path, number), &size_bytes);
      }
I
Igor Canadi 已提交
969 970 971 972 973
      if (!s.ok()) {
        return s;
      }

      log_files.push_back(std::move(unique_ptr<LogFile>(
I
Igor Canadi 已提交
974
          new LogFileImpl(number, log_type, sequence, size_bytes))));
I
Igor Canadi 已提交
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
    }
  }
  CompareLogByPointer compare_log_files;
  std::sort(log_files.begin(), log_files.end(), compare_log_files);
  return status;
}

Status DBImpl::RetainProbableWalFiles(VectorLogPtr& all_logs,
                                      const SequenceNumber target) {
  int64_t start = 0;  // signed to avoid overflow when target is < first file.
  int64_t end = static_cast<int64_t>(all_logs.size()) - 1;
  // Binary Search. avoid opening all files.
  while (end >= start) {
    int64_t mid = start + (end - start) / 2;  // Avoid overflow.
    SequenceNumber current_seq_num = all_logs.at(mid)->StartSequence();
    if (current_seq_num == target) {
      end = mid;
      break;
    } else if (current_seq_num < target) {
      start = mid + 1;
    } else {
      end = mid - 1;
    }
  }
I
Igor Canadi 已提交
999 1000
  // end could be -ve.
  size_t start_index = std::max(static_cast<int64_t>(0), end);
I
Igor Canadi 已提交
1001 1002 1003 1004 1005 1006
  // The last wal file is always included
  all_logs.erase(all_logs.begin(), all_logs.begin() + start_index);
  return Status::OK();
}

Status DBImpl::ReadFirstRecord(const WalFileType type, const uint64_t number,
I
Igor Canadi 已提交
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
                               SequenceNumber* sequence) {
  if (type != kAliveLogFile && type != kArchivedLogFile) {
    return Status::NotSupported("File Type Not Known " + std::to_string(type));
  }
  {
    MutexLock l(&read_first_record_cache_mutex_);
    auto itr = read_first_record_cache_.find(number);
    if (itr != read_first_record_cache_.end()) {
      *sequence = itr->second;
      return Status::OK();
    }
  }
  Status s;
I
Igor Canadi 已提交
1020 1021
  if (type == kAliveLogFile) {
    std::string fname = LogFileName(options_.wal_dir, number);
I
Igor Canadi 已提交
1022 1023 1024 1025
    s = ReadFirstLine(fname, sequence);
    if (env_->FileExists(fname) && !s.ok()) {
      // return any error that is not caused by non-existing file
      return s;
I
Igor Canadi 已提交
1026
    }
I
Igor Canadi 已提交
1027
  }
I
Igor Canadi 已提交
1028

I
Igor Canadi 已提交
1029
  if (type == kArchivedLogFile || !s.ok()) {
I
Igor Canadi 已提交
1030 1031
    //  check if the file got moved to archive.
    std::string archived_file = ArchivedLogFileName(options_.wal_dir, number);
I
Igor Canadi 已提交
1032
    s = ReadFirstLine(archived_file, sequence);
I
Igor Canadi 已提交
1033
  }
I
Igor Canadi 已提交
1034 1035 1036 1037 1038 1039

  if (s.ok() && *sequence != 0) {
    MutexLock l(&read_first_record_cache_mutex_);
    read_first_record_cache_.insert({number, *sequence});
  }
  return s;
I
Igor Canadi 已提交
1040 1041
}

I
Igor Canadi 已提交
1042 1043
// the function returns status.ok() and sequence == 0 if the file exists, but is
// empty
I
Igor Canadi 已提交
1044
Status DBImpl::ReadFirstLine(const std::string& fname,
I
Igor Canadi 已提交
1045
                             SequenceNumber* sequence) {
I
Igor Canadi 已提交
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
    Logger* info_log;
    const char* fname;

    Status* status;
    bool ignore_error;  // true if options_.paranoid_checks==false
    virtual void Corruption(size_t bytes, const Status& s) {
      Log(info_log, "%s%s: dropping %d bytes; %s",
          (this->ignore_error ? "(ignoring error) " : ""), fname,
          static_cast<int>(bytes), s.ToString().c_str());
      if (this->status->ok()) {
        // only keep the first error
        *this->status = s;
      }
    }
  };

  unique_ptr<SequentialFile> file;
  Status status = env_->NewSequentialFile(fname, &file, storage_options_);

  if (!status.ok()) {
    return status;
  }

  LogReporter reporter;
  reporter.env = env_;
  reporter.info_log = options_.info_log.get();
  reporter.fname = fname.c_str();
  reporter.status = &status;
  reporter.ignore_error = !options_.paranoid_checks;
  log::Reader reader(std::move(file), &reporter, true /*checksum*/,
                     0 /*initial_offset*/);
  std::string scratch;
  Slice record;

  if (reader.ReadRecord(&record, &scratch) &&
      (status.ok() || !options_.paranoid_checks)) {
    if (record.size() < 12) {
      reporter.Corruption(record.size(),
                          Status::Corruption("log record too small"));
      // TODO read record's till the first no corrupt entry?
    } else {
I
Igor Canadi 已提交
1089 1090 1091
      WriteBatch batch;
      WriteBatchInternal::SetContents(&batch, record);
      *sequence = WriteBatchInternal::Sequence(&batch);
I
Igor Canadi 已提交
1092 1093 1094 1095
      return Status::OK();
    }
  }

I
Igor Canadi 已提交
1096 1097 1098
  // ReadRecord returns false on EOF, which means that the log file is empty. we
  // return status.ok() in that case and set sequence number to 0
  *sequence = 0;
I
Igor Canadi 已提交
1099 1100 1101 1102 1103
  return status;
}

#endif  // ROCKSDB_LITE

1104
Status DBImpl::Recover(
1105 1106
    const std::vector<ColumnFamilyDescriptor>& column_families, bool read_only,
    bool error_if_log_file_exist) {
J
jorlow@chromium.org 已提交
1107 1108
  mutex_.AssertHeld();

1109
  bool is_new_db = false;
1110
  assert(db_lock_ == nullptr);
I
Igor Canadi 已提交
1111
  if (!read_only) {
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
    // We call CreateDirIfMissing() as the directory may already exist (if we
    // are reopening a DB), when this happens we don't want creating the
    // directory to cause an error. However, we need to check if creating the
    // directory fails or else we may get an obscure message about the lock
    // file not existing. One real-world example of this occurring is if
    // env->CreateDirIfMissing() doesn't create intermediate directories, e.g.
    // when dbname_ is "dir/db" but when "dir" doesn't exist.
    Status s = env_->CreateDirIfMissing(dbname_);
    if (!s.ok()) {
      return s;
    }

1124 1125
    for (auto& db_path : options_.db_paths) {
      s = env_->CreateDirIfMissing(db_path.path);
1126 1127 1128 1129 1130
      if (!s.ok()) {
        return s;
      }
    }

1131 1132 1133 1134 1135
    s = env_->NewDirectory(dbname_, &db_directory_);
    if (!s.ok()) {
      return s;
    }

1136
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
1137 1138 1139
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
1140

1141 1142 1143
    if (!env_->FileExists(CurrentFileName(dbname_))) {
      if (options_.create_if_missing) {
        s = NewDB();
1144
        is_new_db = true;
1145 1146 1147 1148 1149 1150
        if (!s.ok()) {
          return s;
        }
      } else {
        return Status::InvalidArgument(
            dbname_, "does not exist (create_if_missing is false)");
J
jorlow@chromium.org 已提交
1151 1152
      }
    } else {
1153 1154 1155 1156
      if (options_.error_if_exists) {
        return Status::InvalidArgument(
            dbname_, "exists (error_if_exists is true)");
      }
J
jorlow@chromium.org 已提交
1157
    }
M
Mayank Agarwal 已提交
1158 1159 1160 1161 1162 1163 1164
    // Check for the IDENTITY file and create it if not there
    if (!env_->FileExists(IdentityFileName(dbname_))) {
      s = SetIdentityFile(env_, dbname_);
      if (!s.ok()) {
        return s;
      }
    }
J
jorlow@chromium.org 已提交
1165 1166
  }

1167
  Status s = versions_->Recover(column_families, read_only);
I
Igor Canadi 已提交
1168 1169 1170
  if (options_.paranoid_checks && s.ok()) {
    s = CheckConsistency();
  }
J
jorlow@chromium.org 已提交
1171 1172
  if (s.ok()) {
    SequenceNumber max_sequence(0);
1173 1174
    default_cf_handle_ = new ColumnFamilyHandleImpl(
        versions_->GetColumnFamilySet()->GetDefault(), this, &mutex_);
1175
    default_cf_internal_stats_ = default_cf_handle_->cfd()->internal_stats();
1176 1177
    single_column_family_mode_ =
        versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1;
1178 1179 1180 1181 1182 1183 1184

    // Recover from all newer log files than the ones named in the
    // descriptor (new log files may have been added by the previous
    // incarnation without registering them in the descriptor).
    //
    // Note that PrevLogNumber() is no longer used, but we pay
    // attention to it in case we are recovering a database
1185
    // produced by an older version of rocksdb.
1186
    const uint64_t min_log = versions_->MinLogNumber();
1187 1188
    const uint64_t prev_log = versions_->PrevLogNumber();
    std::vector<std::string> filenames;
1189
    s = env_->GetChildren(options_.wal_dir, &filenames);
1190 1191
    if (!s.ok()) {
      return s;
1192
    }
K
kailiu 已提交
1193

1194 1195
    std::vector<uint64_t> logs;
    for (size_t i = 0; i < filenames.size(); i++) {
K
kailiu 已提交
1196 1197
      uint64_t number;
      FileType type;
1198 1199 1200 1201 1202 1203 1204 1205 1206
      if (ParseFileName(filenames[i], &number, &type) && type == kLogFile) {
        if (is_new_db) {
          return Status::Corruption(
              "While creating a new Db, wal_dir contains "
              "existing log file: ",
              filenames[i]);
        } else if ((number >= min_log) || (number == prev_log)) {
          logs.push_back(number);
        }
1207
      }
J
jorlow@chromium.org 已提交
1208
    }
1209

H
heyongqiang 已提交
1210 1211 1212 1213 1214 1215
    if (logs.size() > 0 && error_if_log_file_exist) {
      return Status::Corruption(""
          "The db was opened in readonly mode with error_if_log_file_exist"
          "flag but a log file already exists");
    }

1216 1217
    // Recover in the order in which the logs were generated
    std::sort(logs.begin(), logs.end());
K
kailiu 已提交
1218
    for (const auto& log : logs) {
1219 1220 1221
      // The previous incarnation may not have written any MANIFEST
      // records after allocating this log number.  So we manually
      // update the file number allocation counter in VersionSet.
K
kailiu 已提交
1222
      versions_->MarkFileNumberUsed(log);
K
Kai Liu 已提交
1223
      s = RecoverLogFile(log, &max_sequence, read_only);
1224
    }
L
Lei Jin 已提交
1225
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1226 1227
  }

I
Igor Canadi 已提交
1228 1229 1230 1231 1232
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    max_total_in_memory_state_ += cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
  }

J
jorlow@chromium.org 已提交
1233 1234 1235
  return s;
}

I
Igor Canadi 已提交
1236 1237
Status DBImpl::RecoverLogFile(uint64_t log_number, SequenceNumber* max_sequence,
                              bool read_only) {
J
jorlow@chromium.org 已提交
1238 1239
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1240
    Logger* info_log;
J
jorlow@chromium.org 已提交
1241
    const char* fname;
1242 1243
    Status* status;  // nullptr if options_.paranoid_checks==false or
                     //            options_.skip_log_error_on_recovery==true
J
jorlow@chromium.org 已提交
1244
    virtual void Corruption(size_t bytes, const Status& s) {
1245
      Log(info_log, "%s%s: dropping %d bytes; %s",
1246
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1247
          fname, static_cast<int>(bytes), s.ToString().c_str());
1248
      if (this->status != nullptr && this->status->ok()) *this->status = s;
J
jorlow@chromium.org 已提交
1249 1250 1251 1252 1253
    }
  };

  mutex_.AssertHeld();

1254
  std::unordered_map<int, VersionEdit> version_edits;
1255
  // no need to refcount because iteration is under mutex
1256 1257
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    VersionEdit edit;
1258 1259
    edit.SetColumnFamily(cfd->GetID());
    version_edits.insert({cfd->GetID(), edit});
1260
  }
I
Igor Canadi 已提交
1261

J
jorlow@chromium.org 已提交
1262
  // Open the log file
1263
  std::string fname = LogFileName(options_.wal_dir, log_number);
1264
  unique_ptr<SequentialFile> file;
1265
  Status status = env_->NewSequentialFile(fname, &file, storage_options_);
J
jorlow@chromium.org 已提交
1266 1267 1268 1269 1270 1271 1272 1273
  if (!status.ok()) {
    MaybeIgnoreError(&status);
    return status;
  }

  // Create the log reader.
  LogReporter reporter;
  reporter.env = env_;
1274
  reporter.info_log = options_.info_log.get();
J
jorlow@chromium.org 已提交
1275
  reporter.fname = fname.c_str();
1276 1277
  reporter.status = (options_.paranoid_checks &&
                     !options_.skip_log_error_on_recovery ? &status : nullptr);
J
jorlow@chromium.org 已提交
1278 1279 1280 1281
  // We intentially make log::Reader do checksumming even if
  // paranoid_checks==false so that corruptions cause entire commits
  // to be skipped instead of propagating bad information (like overly
  // large sequence numbers).
1282
  log::Reader reader(std::move(file), &reporter, true/*checksum*/,
1283
                     0/*initial_offset*/);
1284
  Log(options_.info_log, "Recovering log #%" PRIu64 "", log_number);
J
jorlow@chromium.org 已提交
1285 1286 1287 1288 1289

  // Read all the records and add to a memtable
  std::string scratch;
  Slice record;
  WriteBatch batch;
I
Igor Canadi 已提交
1290
  while (reader.ReadRecord(&record, &scratch)) {
J
jorlow@chromium.org 已提交
1291 1292 1293 1294 1295 1296 1297
    if (record.size() < 12) {
      reporter.Corruption(
          record.size(), Status::Corruption("log record too small"));
      continue;
    }
    WriteBatchInternal::SetContents(&batch, record);

1298
    status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
1299
        &batch, column_family_memtables_.get(), true, log_number);
1300

J
jorlow@chromium.org 已提交
1301 1302
    MaybeIgnoreError(&status);
    if (!status.ok()) {
I
Igor Canadi 已提交
1303
      return status;
J
jorlow@chromium.org 已提交
1304 1305 1306 1307 1308 1309 1310 1311
    }
    const SequenceNumber last_seq =
        WriteBatchInternal::Sequence(&batch) +
        WriteBatchInternal::Count(&batch) - 1;
    if (last_seq > *max_sequence) {
      *max_sequence = last_seq;
    }

1312
    if (!read_only) {
1313 1314
      // no need to refcount since client still doesn't have access
      // to the DB and can not drop column families while we iterate
1315
      for (auto cfd : *versions_->GetColumnFamilySet()) {
1316
        if (cfd->mem()->ShouldFlush()) {
1317
          // If this asserts, it means that InsertInto failed in
1318 1319
          // filtering updates to already-flushed column families
          assert(cfd->GetLogNumber() <= log_number);
1320
          auto iter = version_edits.find(cfd->GetID());
1321 1322
          assert(iter != version_edits.end());
          VersionEdit* edit = &iter->second;
1323
          status = WriteLevel0TableForRecovery(cfd, cfd->mem(), edit);
1324 1325 1326 1327 1328 1329 1330 1331
          // we still want to clear the memtable, even if the recovery failed
          cfd->CreateNewMemtable();
          if (!status.ok()) {
            // Reflect errors immediately so that conditions like full
            // file-systems cause the DB::Open() to fail.
            return status;
          }
        }
J
jorlow@chromium.org 已提交
1332 1333 1334 1335
      }
    }
  }

1336 1337 1338 1339
  if (versions_->LastSequence() < *max_sequence) {
    versions_->SetLastSequence(*max_sequence);
  }

1340
  if (!read_only) {
1341 1342
    // no need to refcount since client still doesn't have access
    // to the DB and can not drop column families while we iterate
1343
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1344
      auto iter = version_edits.find(cfd->GetID());
1345 1346 1347
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

1348 1349 1350 1351
      if (cfd->GetLogNumber() > log_number) {
        // Column family cfd has already flushed the data
        // from log_number. Memtable has to be empty because
        // we filter the updates based on log_number
1352
        // (in WriteBatch::InsertInto)
1353 1354 1355 1356 1357 1358 1359
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1360
        status = WriteLevel0TableForRecovery(cfd, cfd->mem(), edit);
1361
      }
1362 1363 1364 1365 1366
      // we still want to clear the memtable, even if the recovery failed
      cfd->CreateNewMemtable();
      if (!status.ok()) {
        return status;
      }
J
jorlow@chromium.org 已提交
1367

1368 1369 1370 1371 1372 1373 1374
      // write MANIFEST with update
      // writing log number in the manifest means that any log file
      // with number strongly less than (log_number + 1) is already
      // recovered and should be ignored on next reincarnation.
      // Since we already recovered log_number, we want all logs
      // with numbers `<= log_number` (includes this one) to be ignored
      edit->SetLogNumber(log_number + 1);
1375 1376 1377
      // we must mark the next log number as used, even though it's
      // not actually used. that is because VersionSet assumes
      // VersionSet::next_file_number_ always to be strictly greater than any
I
Igor Canadi 已提交
1378
      // log number
1379
      versions_->MarkFileNumberUsed(log_number + 1);
1380 1381 1382 1383 1384
      status = versions_->LogAndApply(cfd, edit, &mutex_);
      if (!status.ok()) {
        return status;
      }
    }
1385
  }
I
Igor Canadi 已提交
1386

J
jorlow@chromium.org 已提交
1387 1388 1389
  return status;
}

1390 1391
Status DBImpl::WriteLevel0TableForRecovery(ColumnFamilyData* cfd, MemTable* mem,
                                           VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1392
  mutex_.AssertHeld();
1393
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1394
  FileMetaData meta;
1395 1396
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
  pending_outputs_[meta.fd.GetNumber()] = 0;  // path 0 for level 0 file.
1397
  Iterator* iter = mem->NewIterator(ReadOptions(), true);
1398 1399 1400
  const SequenceNumber newest_snapshot = snapshots_.GetNewest();
  const SequenceNumber earliest_seqno_in_memtable =
    mem->GetFirstSequenceNumber();
1401 1402
  Log(options_.info_log, "[%s] Level-0 table #%" PRIu64 ": started",
      cfd->GetName().c_str(), meta.fd.GetNumber());
1403 1404 1405 1406

  Status s;
  {
    mutex_.Unlock();
I
Igor Canadi 已提交
1407
    s = BuildTable(dbname_, env_, *cfd->options(), storage_options_,
1408
                   cfd->table_cache(), iter, &meta, cfd->internal_comparator(),
1409
                   newest_snapshot, earliest_seqno_in_memtable,
L
Lei Jin 已提交
1410
                   GetCompressionFlush(*cfd->options()), Env::IO_HIGH);
I
Igor Canadi 已提交
1411
    LogFlush(options_.info_log);
1412 1413 1414
    mutex_.Lock();
  }

1415 1416 1417 1418
  Log(options_.info_log,
      "[%s] Level-0 table #%" PRIu64 ": %" PRIu64 " bytes %s",
      cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
      s.ToString().c_str());
J
jorlow@chromium.org 已提交
1419
  delete iter;
1420

1421
  pending_outputs_.erase(meta.fd.GetNumber());
1422 1423 1424 1425

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1426
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1427 1428 1429
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1430 1431
  }

L
Lei Jin 已提交
1432
  InternalStats::CompactionStats stats(1);
1433
  stats.micros = env_->NowMicros() - start_micros;
1434
  stats.bytes_written = meta.fd.GetFileSize();
M
Mark Callaghan 已提交
1435
  stats.files_out_levelnp1 = 1;
1436
  cfd->internal_stats()->AddCompactionStats(level, stats);
1437 1438
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1439
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1440 1441 1442
  return s;
}

1443
Status DBImpl::WriteLevel0Table(ColumnFamilyData* cfd,
1444
                                autovector<MemTable*>& mems, VersionEdit* edit,
1445
                                uint64_t* filenumber, LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
1446
  mutex_.AssertHeld();
1447 1448
  const uint64_t start_micros = env_->NowMicros();
  FileMetaData meta;
1449 1450

  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
1451
  *filenumber = meta.fd.GetNumber();
1452
  pending_outputs_[meta.fd.GetNumber()] = 0;  // path 0 for level 0 file.
1453

1454 1455
  const SequenceNumber newest_snapshot = snapshots_.GetNewest();
  const SequenceNumber earliest_seqno_in_memtable =
1456
    mems[0]->GetFirstSequenceNumber();
1457
  Version* base = cfd->current();
1458
  base->Ref();          // it is likely that we do not need this reference
1459 1460 1461
  Status s;
  {
    mutex_.Unlock();
H
Haobo Xu 已提交
1462
    log_buffer->FlushBufferToLog();
K
Kai Liu 已提交
1463
    std::vector<Iterator*> memtables;
1464
    for (MemTable* m : mems) {
1465 1466 1467
      Log(options_.info_log,
          "[%s] Flushing memtable with next log file: %" PRIu64 "\n",
          cfd->GetName().c_str(), m->GetNextLogNumber());
1468
      memtables.push_back(m->NewIterator(ReadOptions(), true));
1469
    }
I
Igor Canadi 已提交
1470
    Iterator* iter = NewMergingIterator(&cfd->internal_comparator(),
1471
                                        &memtables[0], memtables.size());
1472 1473
    Log(options_.info_log, "[%s] Level-0 flush table #%" PRIu64 ": started",
        cfd->GetName().c_str(), meta.fd.GetNumber());
1474

I
Igor Canadi 已提交
1475
    s = BuildTable(dbname_, env_, *cfd->options(), storage_options_,
1476
                   cfd->table_cache(), iter, &meta, cfd->internal_comparator(),
1477
                   newest_snapshot, earliest_seqno_in_memtable,
L
Lei Jin 已提交
1478
                   GetCompressionFlush(*cfd->options()), Env::IO_HIGH);
I
Igor Canadi 已提交
1479
    LogFlush(options_.info_log);
1480
    delete iter;
1481 1482
    Log(options_.info_log,
        "[%s] Level-0 flush table #%" PRIu64 ": %" PRIu64 " bytes %s",
F
Feng Zhu 已提交
1483
        cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
1484
        s.ToString().c_str());
I
Igor Canadi 已提交
1485

1486 1487 1488
    if (!options_.disableDataSync) {
      db_directory_->Fsync();
    }
1489 1490
    mutex_.Lock();
  }
1491 1492
  base->Unref();

1493
  // re-acquire the most current version
1494
  base = cfd->current();
1495 1496 1497 1498 1499 1500

  // There could be multiple threads writing to its own level-0 file.
  // The pending_outputs cannot be cleared here, otherwise this newly
  // created file might not be considered as a live-file by another
  // compaction thread that is concurrently deleting obselete files.
  // The pending_outputs can be cleared only after the new version is
A
Abhishek Kona 已提交
1501
  // committed so that other threads can recognize this file as a
1502 1503 1504 1505 1506 1507
  // valid one.
  // pending_outputs_.erase(meta.number);

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1508
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1509 1510 1511 1512 1513 1514
    const Slice min_user_key = meta.smallest.user_key();
    const Slice max_user_key = meta.largest.user_key();
    // if we have more than 1 background thread, then we cannot
    // insert files directly into higher levels because some other
    // threads could be concurrently producing compacted files for
    // that key range.
1515
    if (base != nullptr && options_.max_background_compactions <= 1 &&
1516
        cfd->options()->compaction_style == kCompactionStyleLevel) {
1517 1518
      level = base->PickLevelForMemTableOutput(min_user_key, max_user_key);
    }
1519 1520 1521
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1522 1523
  }

L
Lei Jin 已提交
1524
  InternalStats::CompactionStats stats(1);
1525
  stats.micros = env_->NowMicros() - start_micros;
1526
  stats.bytes_written = meta.fd.GetFileSize();
1527
  cfd->internal_stats()->AddCompactionStats(level, stats);
1528 1529
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1530
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
1531 1532 1533
  return s;
}

1534 1535
Status DBImpl::FlushMemTableToOutputFile(ColumnFamilyData* cfd,
                                         bool* madeProgress,
H
Haobo Xu 已提交
1536 1537
                                         DeletionState& deletion_state,
                                         LogBuffer* log_buffer) {
1538
  mutex_.AssertHeld();
1539
  assert(cfd->imm()->size() != 0);
1540
  assert(cfd->imm()->IsFlushPending());
1541 1542 1543

  // Save the contents of the earliest memtable as a new Table
  uint64_t file_number;
K
Kai Liu 已提交
1544
  autovector<MemTable*> mems;
1545
  cfd->imm()->PickMemtablesToFlush(&mems);
1546
  if (mems.empty()) {
I
Igor Canadi 已提交
1547 1548
    LogToBuffer(log_buffer, "[%s] Nothing in memtable to flush",
                cfd->GetName().c_str());
L
Lei Jin 已提交
1549
    return Status::OK();
1550 1551 1552
  }

  // record the logfile_number_ before we release the mutex
1553 1554 1555
  // entries mems are (implicitly) sorted in ascending order by their created
  // time. We will use the first memtable's `edit` to keep the meta info for
  // this flush.
1556
  MemTable* m = mems[0];
1557 1558
  VersionEdit* edit = m->GetEdits();
  edit->SetPrevLogNumber(0);
1559 1560
  // SetLogNumber(log_num) indicates logs with number smaller than log_num
  // will no longer be picked up for recovery.
1561 1562
  edit->SetLogNumber(mems.back()->GetNextLogNumber());
  edit->SetColumnFamily(cfd->GetID());
1563

1564
  // This will release and re-acquire the mutex.
1565
  Status s = WriteLevel0Table(cfd, mems, edit, &file_number, log_buffer);
1566

1567
  if (s.ok() && shutting_down_.Acquire_Load() && cfd->IsDropped()) {
L
Lei Jin 已提交
1568
    s = Status::ShutdownInProgress(
I
Igor Canadi 已提交
1569
        "Database shutdown or Column family drop during flush");
1570
  }
J
jorlow@chromium.org 已提交
1571

L
Lei Jin 已提交
1572
  if (!s.ok()) {
1573
    cfd->imm()->RollbackMemtableFlush(mems, file_number, &pending_outputs_);
1574 1575
  } else {
    // Replace immutable memtable with the generated Table
1576 1577
    s = cfd->imm()->InstallMemtableFlushResults(
        cfd, mems, versions_.get(), &mutex_, options_.info_log.get(),
1578
        file_number, &pending_outputs_, &deletion_state.memtables_to_free,
1579
        db_directory_.get(), log_buffer);
1580
  }
J
jorlow@chromium.org 已提交
1581 1582

  if (s.ok()) {
1583
    InstallSuperVersion(cfd, deletion_state);
1584 1585 1586
    if (madeProgress) {
      *madeProgress = 1;
    }
I
Igor Canadi 已提交
1587 1588 1589
    Version::LevelSummaryStorage tmp;
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
                cfd->current()->LevelSummary(&tmp));
1590

1591
    if (disable_delete_obsolete_files_ == 0) {
I
Igor Canadi 已提交
1592
      // add to deletion state
1593
      while (alive_log_files_.size() &&
I
Igor Canadi 已提交
1594 1595 1596 1597
             alive_log_files_.begin()->number < versions_->MinLogNumber()) {
        const auto& earliest = *alive_log_files_.begin();
        deletion_state.log_delete_files.push_back(earliest.number);
        total_log_size_ -= earliest.size;
1598 1599
        alive_log_files_.pop_front();
      }
1600
    }
J
jorlow@chromium.org 已提交
1601
  }
1602 1603 1604 1605 1606 1607 1608

  if (!s.ok() && !s.IsShutdownInProgress() && options_.paranoid_checks &&
      bg_error_.ok()) {
    // if a bad error happened (not ShutdownInProgress) and paranoid_checks is
    // true, mark DB read-only
    bg_error_ = s;
  }
1609
  RecordFlushIOStats();
J
jorlow@chromium.org 已提交
1610 1611 1612
  return s;
}

1613
Status DBImpl::CompactRange(ColumnFamilyHandle* column_family,
1614
                            const Slice* begin, const Slice* end,
1615 1616 1617 1618 1619 1620
                            bool reduce_level, int target_level,
                            uint32_t target_path_id) {
  if (target_path_id >= options_.db_paths.size()) {
    return Status::InvalidArgument("Invalid target path ID");
  }

1621 1622
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
I
Igor Canadi 已提交
1623 1624

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
1625 1626 1627 1628 1629
  if (!s.ok()) {
    LogFlush(options_.info_log);
    return s;
  }

I
Igor Canadi 已提交
1630
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
1631 1632
  {
    MutexLock l(&mutex_);
I
Igor Canadi 已提交
1633 1634
    Version* base = cfd->current();
    for (int level = 1; level < cfd->NumberLevels(); level++) {
G
Gabor Cselle 已提交
1635 1636 1637 1638 1639
      if (base->OverlapInLevel(level, begin, end)) {
        max_level_with_files = level;
      }
    }
  }
1640 1641
  for (int level = 0; level <= max_level_with_files; level++) {
    // in case the compaction is unversal or if we're compacting the
1642 1643 1644
    // bottom-most level, the output level will be the same as input one.
    // level 0 can never be the bottommost level (i.e. if all files are in level
    // 0, we will compact to level 1)
I
Igor Canadi 已提交
1645
    if (cfd->options()->compaction_style == kCompactionStyleUniversal ||
I
Igor Canadi 已提交
1646
        cfd->options()->compaction_style == kCompactionStyleFIFO ||
1647
        (level == max_level_with_files && level > 0)) {
1648
      s = RunManualCompaction(cfd, level, level, target_path_id, begin, end);
1649
    } else {
1650 1651
      s = RunManualCompaction(cfd, level, level + 1, target_path_id, begin,
                              end);
L
Lei Jin 已提交
1652 1653 1654 1655
    }
    if (!s.ok()) {
      LogFlush(options_.info_log);
      return s;
1656
    }
G
Gabor Cselle 已提交
1657
  }
1658 1659

  if (reduce_level) {
I
Igor Canadi 已提交
1660
    s = ReFitLevel(cfd, max_level_with_files, target_level);
1661
  }
I
Igor Canadi 已提交
1662
  LogFlush(options_.info_log);
L
Lei Jin 已提交
1663 1664

  return s;
1665 1666 1667
}

// return the same level if it cannot be moved
I
Igor Canadi 已提交
1668
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd, int level) {
1669
  mutex_.AssertHeld();
I
Igor Canadi 已提交
1670
  Version* current = cfd->current();
1671
  int minimum_level = level;
1672
  for (int i = level - 1; i > 0; --i) {
1673
    // stop if level i is not empty
1674
    if (current->NumLevelFiles(i) > 0) break;
1675
    // stop if level i is too small (cannot fit the level files)
I
Igor Canadi 已提交
1676
    if (cfd->compaction_picker()->MaxBytesForLevel(i) <
1677 1678 1679
        current->NumLevelBytes(level)) {
      break;
    }
1680 1681 1682 1683 1684 1685

    minimum_level = i;
  }
  return minimum_level;
}

I
Igor Canadi 已提交
1686 1687
Status DBImpl::ReFitLevel(ColumnFamilyData* cfd, int level, int target_level) {
  assert(level < cfd->NumberLevels());
1688

I
Igor Canadi 已提交
1689
  SuperVersion* superversion_to_free = nullptr;
1690
  SuperVersion* new_superversion = new SuperVersion();
I
Igor Canadi 已提交
1691 1692

  mutex_.Lock();
1693 1694 1695

  // only allow one thread refitting
  if (refitting_level_) {
I
Igor Canadi 已提交
1696
    mutex_.Unlock();
1697
    Log(options_.info_log, "ReFitLevel: another thread is refitting");
I
Igor Canadi 已提交
1698
    delete new_superversion;
L
Lei Jin 已提交
1699
    return Status::NotSupported("another thread is refitting");
1700 1701 1702 1703 1704
  }
  refitting_level_ = true;

  // wait for all background threads to stop
  bg_work_gate_closed_ = true;
1705
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_) {
1706
    Log(options_.info_log,
1707 1708
        "RefitLevel: waiting for background threads to stop: %d %d",
        bg_compaction_scheduled_, bg_flush_scheduled_);
1709 1710 1711 1712
    bg_cv_.Wait();
  }

  // move to a smaller level
1713 1714
  int to_level = target_level;
  if (target_level < 0) {
I
Igor Canadi 已提交
1715
    to_level = FindMinimumEmptyLevelFitting(cfd, level);
1716
  }
1717 1718 1719

  assert(to_level <= level);

L
Lei Jin 已提交
1720
  Status status;
1721
  if (to_level < level) {
I
Igor Canadi 已提交
1722
    Log(options_.info_log, "[%s] Before refitting:\n%s", cfd->GetName().c_str(),
I
Igor Canadi 已提交
1723
        cfd->current()->DebugString().data());
1724

1725
    VersionEdit edit;
I
Igor Canadi 已提交
1726 1727
    edit.SetColumnFamily(cfd->GetID());
    for (const auto& f : cfd->current()->files_[level]) {
1728
      edit.DeleteFile(level, f->fd.GetNumber());
1729 1730 1731
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
                   f->smallest_seqno, f->largest_seqno);
1732
    }
I
Igor Canadi 已提交
1733 1734
    Log(options_.info_log, "[%s] Apply version edit:\n%s",
        cfd->GetName().c_str(), edit.DebugString().data());
1735

I
Igor Canadi 已提交
1736
    status = versions_->LogAndApply(cfd, &edit, &mutex_, db_directory_.get());
1737
    superversion_to_free = cfd->InstallSuperVersion(new_superversion, &mutex_);
I
Igor Canadi 已提交
1738
    new_superversion = nullptr;
1739

I
Igor Canadi 已提交
1740 1741
    Log(options_.info_log, "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
        status.ToString().data());
1742 1743

    if (status.ok()) {
I
Igor Canadi 已提交
1744 1745
      Log(options_.info_log, "[%s] After refitting:\n%s",
          cfd->GetName().c_str(), cfd->current()->DebugString().data());
1746 1747 1748 1749 1750
    }
  }

  refitting_level_ = false;
  bg_work_gate_closed_ = false;
I
Igor Canadi 已提交
1751 1752 1753 1754

  mutex_.Unlock();
  delete superversion_to_free;
  delete new_superversion;
L
Lei Jin 已提交
1755
  return status;
G
Gabor Cselle 已提交
1756 1757
}

1758 1759 1760
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
1761 1762
}

1763 1764 1765
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->options()->max_mem_compaction_level;
1766 1767
}

1768 1769 1770
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->options()->level0_stop_writes_trigger;
1771 1772
}

1773
Status DBImpl::Flush(const FlushOptions& options,
1774 1775 1776
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return FlushMemTable(cfh->cfd(), options);
H
heyongqiang 已提交
1777 1778
}

1779
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
1780 1781 1782
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
1783
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
1784 1785
                                   int output_level, uint32_t output_path_id,
                                   const Slice* begin, const Slice* end) {
1786
  assert(input_level >= 0);
1787

G
Gabor Cselle 已提交
1788 1789
  InternalKey begin_storage, end_storage;

H
hans@chromium.org 已提交
1790
  ManualCompaction manual;
I
Igor Canadi 已提交
1791
  manual.cfd = cfd;
1792 1793
  manual.input_level = input_level;
  manual.output_level = output_level;
1794
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
1795
  manual.done = false;
1796
  manual.in_progress = false;
1797 1798 1799
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
I
Igor Canadi 已提交
1800 1801
      cfd->options()->compaction_style == kCompactionStyleUniversal ||
      cfd->options()->compaction_style == kCompactionStyleFIFO) {
1802
    manual.begin = nullptr;
G
Gabor Cselle 已提交
1803 1804 1805 1806
  } else {
    begin_storage = InternalKey(*begin, kMaxSequenceNumber, kValueTypeForSeek);
    manual.begin = &begin_storage;
  }
1807
  if (end == nullptr ||
I
Igor Canadi 已提交
1808 1809
      cfd->options()->compaction_style == kCompactionStyleUniversal ||
      cfd->options()->compaction_style == kCompactionStyleFIFO) {
1810
    manual.end = nullptr;
G
Gabor Cselle 已提交
1811 1812 1813 1814 1815 1816
  } else {
    end_storage = InternalKey(*end, 0, static_cast<ValueType>(0));
    manual.end = &end_storage;
  }

  MutexLock l(&mutex_);
1817

1818 1819 1820 1821 1822 1823
  // When a manual compaction arrives, temporarily disable scheduling of
  // non-manual compactions and wait until the number of scheduled compaction
  // jobs drops to zero. This is needed to ensure that this manual compaction
  // can compact any range of keys/files.
  //
  // bg_manual_only_ is non-zero when at least one thread is inside
1824
  // RunManualCompaction(), i.e. during that time no other compaction will
1825 1826 1827
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
1828
  // RunManualCompaction() from getting to the second while loop below.
1829 1830 1831 1832 1833 1834
  // However, only one of them will actually schedule compaction, while
  // others will wait on a condition variable until it completes.

  ++bg_manual_only_;
  while (bg_compaction_scheduled_ > 0) {
    Log(options_.info_log,
I
Igor Canadi 已提交
1835 1836 1837
        "[%s] Manual compaction waiting for all other scheduled background "
        "compactions to finish",
        cfd->GetName().c_str());
1838 1839
    bg_cv_.Wait();
  }
1840

I
Igor Canadi 已提交
1841 1842
  Log(options_.info_log, "[%s] Manual compaction starting",
      cfd->GetName().c_str());
1843

1844 1845 1846 1847
  while (!manual.done && !shutting_down_.Acquire_Load() && bg_error_.ok()) {
    assert(bg_manual_only_ > 0);
    if (manual_compaction_ != nullptr) {
      // Running either this or some other manual compaction
G
Gabor Cselle 已提交
1848
      bg_cv_.Wait();
1849 1850 1851
    } else {
      manual_compaction_ = &manual;
      MaybeScheduleFlushOrCompaction();
G
Gabor Cselle 已提交
1852
    }
H
hans@chromium.org 已提交
1853
  }
1854

1855 1856 1857
  assert(!manual.in_progress);
  assert(bg_manual_only_ > 0);
  --bg_manual_only_;
L
Lei Jin 已提交
1858
  return manual.status;
J
jorlow@chromium.org 已提交
1859 1860
}

1861 1862
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
                             const FlushOptions& options) {
1863 1864
  // nullptr batch means just wait for earlier writes to be done
  Status s = Write(WriteOptions(), nullptr);
H
heyongqiang 已提交
1865
  if (s.ok() && options.wait) {
1866
    // Wait until the compaction completes
1867
    s = WaitForFlushMemTable(cfd);
1868 1869
  }
  return s;
J
jorlow@chromium.org 已提交
1870 1871
}

1872
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
1873 1874 1875
  Status s;
  // Wait until the compaction completes
  MutexLock l(&mutex_);
1876
  while (cfd->imm()->size() > 0 && bg_error_.ok()) {
1877 1878
    bg_cv_.Wait();
  }
1879
  if (!bg_error_.ok()) {
1880 1881 1882
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
1883 1884
}

1885
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
1886
  mutex_.AssertHeld();
1887
  bg_schedule_needed_ = false;
1888 1889
  if (bg_work_gate_closed_) {
    // gate closed for backgrond work
J
jorlow@chromium.org 已提交
1890 1891 1892
  } else if (shutting_down_.Acquire_Load()) {
    // DB is being deleted; no more background compactions
  } else {
1893
    bool is_flush_pending = false;
1894
    // no need to refcount since we're under a mutex
1895
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
1896
      if (cfd->imm()->IsFlushPending()) {
1897 1898 1899
        is_flush_pending = true;
      }
    }
1900
    if (is_flush_pending) {
1901
      // memtable flush needed
1902 1903 1904
      if (bg_flush_scheduled_ < options_.max_background_flushes) {
        bg_flush_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH);
1905
      } else if (options_.max_background_flushes > 0) {
1906
        bg_schedule_needed_ = true;
1907
      }
1908
    }
1909
    bool is_compaction_needed = false;
1910
    // no need to refcount since we're under a mutex
1911
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
1912
      if (cfd->current()->NeedsCompaction()) {
1913 1914 1915 1916
        is_compaction_needed = true;
        break;
      }
    }
1917

1918 1919
    // Schedule BGWorkCompaction if there's a compaction pending (or a memtable
    // flush, but the HIGH pool is not enabled)
1920
    // Do it only if max_background_compactions hasn't been reached and, in case
1921
    // bg_manual_only_ > 0, if it's a manual compaction.
1922 1923
    if ((manual_compaction_ || is_compaction_needed ||
         (is_flush_pending && options_.max_background_flushes == 0)) &&
1924
        (!bg_manual_only_ || manual_compaction_)) {
1925 1926 1927 1928 1929 1930
      if (bg_compaction_scheduled_ < options_.max_background_compactions) {
        bg_compaction_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW);
      } else {
        bg_schedule_needed_ = true;
      }
1931 1932 1933 1934
    }
  }
}

1935
void DBImpl::RecordFlushIOStats() {
L
Lei Jin 已提交
1936
  RecordTick(stats_, FLUSH_WRITE_BYTES, iostats_context.bytes_written);
1937 1938 1939 1940
  IOSTATS_RESET(bytes_written);
}

void DBImpl::RecordCompactionIOStats() {
L
Lei Jin 已提交
1941
  RecordTick(stats_, COMPACT_READ_BYTES, IOSTATS(bytes_read));
1942
  IOSTATS_RESET(bytes_read);
L
Lei Jin 已提交
1943
  RecordTick(stats_, COMPACT_WRITE_BYTES, IOSTATS(bytes_written));
1944 1945 1946
  IOSTATS_RESET(bytes_written);
}

1947
void DBImpl::BGWorkFlush(void* db) {
1948
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
1949 1950 1951 1952
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
}

void DBImpl::BGWorkCompaction(void* db) {
1953
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
1954 1955 1956
  reinterpret_cast<DBImpl*>(db)->BackgroundCallCompaction();
}

I
Igor Canadi 已提交
1957
Status DBImpl::BackgroundFlush(bool* madeProgress,
H
Haobo Xu 已提交
1958 1959
                               DeletionState& deletion_state,
                               LogBuffer* log_buffer) {
1960 1961 1962 1963 1964 1965
  mutex_.AssertHeld();
  // call_status is failure if at least one flush was a failure. even if
  // flushing one column family reports a failure, we will continue flushing
  // other column families. however, call_status will be a failure in that case.
  Status call_status;
  // refcounting in iteration
1966
  for (auto cfd : *versions_->GetColumnFamilySet()) {
1967 1968 1969
    cfd->Ref();
    Status flush_status;
    while (flush_status.ok() && cfd->imm()->IsFlushPending()) {
1970 1971
      LogToBuffer(
          log_buffer,
1972
          "BackgroundCallFlush doing FlushMemTableToOutputFile with column "
I
Igor Canadi 已提交
1973 1974 1975
          "family [%s], flush slots available %d",
          cfd->GetName().c_str(),
          options_.max_background_flushes - bg_flush_scheduled_);
1976 1977
      flush_status = FlushMemTableToOutputFile(cfd, madeProgress,
                                               deletion_state, log_buffer);
1978 1979 1980
    }
    if (call_status.ok() && !flush_status.ok()) {
      call_status = flush_status;
1981
    }
1982
    cfd->Unref();
J
jorlow@chromium.org 已提交
1983
  }
1984
  versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
1985
  return call_status;
J
jorlow@chromium.org 已提交
1986 1987
}

1988
void DBImpl::BackgroundCallFlush() {
1989
  bool madeProgress = false;
K
Kai Liu 已提交
1990
  DeletionState deletion_state(true);
1991 1992
  assert(bg_flush_scheduled_);

1993
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, options_.info_log.get());
H
Haobo Xu 已提交
1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
  {
    MutexLock l(&mutex_);

    Status s;
    if (!shutting_down_.Acquire_Load()) {
      s = BackgroundFlush(&madeProgress, deletion_state, &log_buffer);
      if (!s.ok()) {
        // Wait a little bit before retrying background compaction in
        // case this is an environmental problem and we do not want to
        // chew up resources for failed compactions for the duration of
        // the problem.
2005 2006
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
H
Haobo Xu 已提交
2007 2008
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
2009 2010 2011 2012
        Log(options_.info_log,
            "Waiting after background flush error: %s"
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
H
Haobo Xu 已提交
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
        log_buffer.FlushBufferToLog();
        LogFlush(options_.info_log);
        env_->SleepForMicroseconds(1000000);
        mutex_.Lock();
      }
    }

    // If !s.ok(), this means that Flush failed. In that case, we want
    // to delete all obsolete files and we force FindObsoleteFiles()
    FindObsoleteFiles(deletion_state, !s.ok());
    // delete unnecessary files if any, this is done outside the mutex
2024
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2025
      mutex_.Unlock();
2026 2027 2028 2029 2030
      // Have to flush the info logs before bg_flush_scheduled_--
      // because if bg_flush_scheduled_ becomes 0 and the lock is
      // released, the deconstructor of DB can kick in and destroy all the
      // states of DB so info_log might not be available after that point.
      // It also applies to access other states that DB owns.
H
Haobo Xu 已提交
2031
      log_buffer.FlushBufferToLog();
2032 2033 2034
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2035 2036
      mutex_.Lock();
    }
I
Igor Canadi 已提交
2037

H
Haobo Xu 已提交
2038
    bg_flush_scheduled_--;
2039 2040 2041 2042 2043
    // Any time the mutex is released After finding the work to do, another
    // thread might execute MaybeScheduleFlushOrCompaction(). It is possible
    // that there is a pending job but it is not scheduled because of the
    // max thread limit.
    if (madeProgress || bg_schedule_needed_) {
H
Haobo Xu 已提交
2044 2045 2046
      MaybeScheduleFlushOrCompaction();
    }
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
2047 2048 2049 2050
    // IMPORTANT: there should be no code after calling SignalAll. This call may
    // signal the DB destructor that it's OK to proceed with destruction. In
    // that case, all DB variables will be dealloacated and referencing them
    // will cause trouble.
2051
  }
2052
  RecordFlushIOStats();
J
jorlow@chromium.org 已提交
2053 2054
}

2055
void DBImpl::BackgroundCallCompaction() {
2056
  bool madeProgress = false;
K
Kai Liu 已提交
2057
  DeletionState deletion_state(true);
H
Haobo Xu 已提交
2058 2059

  MaybeDumpStats();
2060
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, options_.info_log.get());
2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071
  {
    MutexLock l(&mutex_);
    assert(bg_compaction_scheduled_);
    Status s;
    if (!shutting_down_.Acquire_Load()) {
      s = BackgroundCompaction(&madeProgress, deletion_state, &log_buffer);
      if (!s.ok()) {
        // Wait a little bit before retrying background compaction in
        // case this is an environmental problem and we do not want to
        // chew up resources for failed compactions for the duration of
        // the problem.
2072 2073
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
2074 2075
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
H
Haobo Xu 已提交
2076
        log_buffer.FlushBufferToLog();
2077 2078 2079 2080
        Log(options_.info_log,
            "Waiting after background compaction error: %s, "
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
2081 2082 2083 2084 2085
        LogFlush(options_.info_log);
        env_->SleepForMicroseconds(1000000);
        mutex_.Lock();
      }
    }
H
Haobo Xu 已提交
2086

2087 2088 2089 2090 2091 2092 2093
    // If !s.ok(), this means that Compaction failed. In that case, we want
    // to delete all obsolete files we might have created and we force
    // FindObsoleteFiles(). This is because deletion_state does not catch
    // all created files if compaction failed.
    FindObsoleteFiles(deletion_state, !s.ok());

    // delete unnecessary files if any, this is done outside the mutex
2094
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2095
      mutex_.Unlock();
2096 2097 2098 2099 2100
      // Have to flush the info logs before bg_compaction_scheduled_--
      // because if bg_flush_scheduled_ becomes 0 and the lock is
      // released, the deconstructor of DB can kick in and destroy all the
      // states of DB so info_log might not be available after that point.
      // It also applies to access other states that DB owns.
H
Haobo Xu 已提交
2101
      log_buffer.FlushBufferToLog();
2102 2103 2104
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2105 2106
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
2107

2108
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2109

2110 2111
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

2112 2113 2114
    // Previous compaction may have produced too many files in a level,
    // So reschedule another compaction if we made progress in the
    // last compaction.
2115 2116 2117 2118 2119 2120
    //
    // Also, any time the mutex is released After finding the work to do,
    // another thread might execute MaybeScheduleFlushOrCompaction(). It is
    // possible  that there is a pending job but it is not scheduled because of
    // the max thread limit.
    if (madeProgress || bg_schedule_needed_) {
2121 2122
      MaybeScheduleFlushOrCompaction();
    }
2123 2124 2125 2126 2127 2128 2129 2130 2131
    if (madeProgress || bg_compaction_scheduled_ == 0 || bg_manual_only_ > 0) {
      // signal if
      // * madeProgress -- need to wakeup MakeRoomForWrite
      // * bg_compaction_scheduled_ == 0 -- need to wakeup ~DBImpl
      // * bg_manual_only_ > 0 -- need to wakeup RunManualCompaction
      // If none of this is true, there is no need to signal since nobody is
      // waiting for it
      bg_cv_.SignalAll();
    }
I
Igor Canadi 已提交
2132 2133 2134 2135
    // IMPORTANT: there should be no code after calling SignalAll. This call may
    // signal the DB destructor that it's OK to proceed with destruction. In
    // that case, all DB variables will be dealloacated and referencing them
    // will cause trouble.
2136
  }
J
jorlow@chromium.org 已提交
2137 2138
}

A
Abhishek Kona 已提交
2139
Status DBImpl::BackgroundCompaction(bool* madeProgress,
2140 2141
                                    DeletionState& deletion_state,
                                    LogBuffer* log_buffer) {
2142
  *madeProgress = false;
J
jorlow@chromium.org 已提交
2143
  mutex_.AssertHeld();
2144

2145 2146
  bool is_manual = (manual_compaction_ != nullptr) &&
                   (manual_compaction_->in_progress == false);
2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164

  if (is_manual) {
    // another thread cannot pick up the same work
    manual_compaction_->in_progress = true;
  }

  // FLUSH preempts compaction
  Status flush_stat;
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    while (cfd->imm()->IsFlushPending()) {
      LogToBuffer(
          log_buffer,
          "BackgroundCompaction doing FlushMemTableToOutputFile, "
          "compaction slots available %d",
          options_.max_background_compactions - bg_compaction_scheduled_);
      cfd->Ref();
      flush_stat = FlushMemTableToOutputFile(cfd, madeProgress, deletion_state,
                                             log_buffer);
2165
      cfd->Unref();
2166 2167 2168 2169 2170 2171 2172
      if (!flush_stat.ok()) {
        if (is_manual) {
          manual_compaction_->status = flush_stat;
          manual_compaction_->done = true;
          manual_compaction_->in_progress = false;
          manual_compaction_ = nullptr;
        }
2173
        return flush_stat;
2174 2175 2176 2177 2178
      }
    }
  }

  unique_ptr<Compaction> c;
2179 2180
  InternalKey manual_end_storage;
  InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
2181
  if (is_manual) {
G
Gabor Cselle 已提交
2182
    ManualCompaction* m = manual_compaction_;
2183
    assert(m->in_progress);
2184 2185 2186
    c.reset(m->cfd->CompactRange(m->input_level, m->output_level,
                                 m->output_path_id, m->begin, m->end,
                                 &manual_end));
2187
    if (!c) {
2188
      m->done = true;
G
Gabor Cselle 已提交
2189
    }
I
Igor Canadi 已提交
2190 2191 2192 2193 2194 2195 2196 2197 2198
    LogToBuffer(log_buffer,
                "[%s] Manual compaction from level-%d to level-%d from %s .. "
                "%s; will stop at %s\n",
                m->cfd->GetName().c_str(), m->input_level, m->output_level,
                (m->begin ? m->begin->DebugString().c_str() : "(begin)"),
                (m->end ? m->end->DebugString().c_str() : "(end)"),
                ((m->done || manual_end == nullptr)
                     ? "(end)"
                     : manual_end->DebugString().c_str()));
I
Igor Canadi 已提交
2199
  } else {
2200
    // no need to refcount in iteration since it's always under a mutex
I
Igor Canadi 已提交
2201
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
2202
      if (!cfd->options()->disable_auto_compactions) {
2203
        c.reset(cfd->PickCompaction(log_buffer));
I
Igor Canadi 已提交
2204 2205
        if (c != nullptr) {
          // update statistics
L
Lei Jin 已提交
2206
          MeasureTime(stats_, NUM_FILES_IN_SINGLE_COMPACTION,
I
Igor Canadi 已提交
2207 2208 2209
                      c->inputs(0)->size());
          break;
        }
I
Igor Canadi 已提交
2210 2211
      }
    }
J
jorlow@chromium.org 已提交
2212 2213 2214
  }

  Status status;
2215
  if (!c) {
H
hans@chromium.org 已提交
2216
    // Nothing to do
2217
    LogToBuffer(log_buffer, "Compaction nothing to do");
I
Igor Canadi 已提交
2218 2219 2220 2221 2222 2223 2224 2225
  } else if (c->IsDeletionCompaction()) {
    // TODO(icanadi) Do we want to honor snapshots here? i.e. not delete old
    // file if there is alive snapshot pointing to it
    assert(c->num_input_files(1) == 0);
    assert(c->level() == 0);
    assert(c->column_family_data()->options()->compaction_style ==
           kCompactionStyleFIFO);
    for (const auto& f : *c->inputs(0)) {
2226
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
2227 2228 2229 2230 2231 2232 2233 2234 2235
    }
    status = versions_->LogAndApply(c->column_family_data(), c->edit(), &mutex_,
                                    db_directory_.get());
    InstallSuperVersion(c->column_family_data(), deletion_state);
    LogToBuffer(log_buffer, "[%s] Deleted %d files\n",
                c->column_family_data()->GetName().c_str(),
                c->num_input_files(0));
    c->ReleaseCompactionFiles(status);
    *madeProgress = true;
H
hans@chromium.org 已提交
2236
  } else if (!is_manual && c->IsTrivialMove()) {
J
jorlow@chromium.org 已提交
2237
    // Move file to next level
2238
    assert(c->num_input_files(0) == 1);
J
jorlow@chromium.org 已提交
2239
    FileMetaData* f = c->input(0, 0);
2240
    c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
2241 2242 2243
    c->edit()->AddFile(c->level() + 1, f->fd.GetNumber(), f->fd.GetPathId(),
                       f->fd.GetFileSize(), f->smallest, f->largest,
                       f->smallest_seqno, f->largest_seqno);
I
Igor Canadi 已提交
2244
    status = versions_->LogAndApply(c->column_family_data(), c->edit(), &mutex_,
2245
                                    db_directory_.get());
I
Igor Canadi 已提交
2246
    InstallSuperVersion(c->column_family_data(), deletion_state);
2247

2248
    Version::LevelSummaryStorage tmp;
2249 2250 2251 2252 2253 2254
    LogToBuffer(
        log_buffer, "[%s] Moved #%lld to level-%d %lld bytes %s: %s\n",
        c->column_family_data()->GetName().c_str(),
        static_cast<unsigned long long>(f->fd.GetNumber()), c->level() + 1,
        static_cast<unsigned long long>(f->fd.GetFileSize()),
        status.ToString().c_str(), c->input_version()->LevelSummary(&tmp));
I
Igor Canadi 已提交
2255
    c->ReleaseCompactionFiles(status);
2256
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2257
  } else {
2258
    MaybeScheduleFlushOrCompaction(); // do more compaction work in parallel.
2259
    CompactionState* compact = new CompactionState(c.get());
H
Haobo Xu 已提交
2260
    status = DoCompactionWork(compact, deletion_state, log_buffer);
2261
    CleanupCompaction(compact, status);
I
Igor Canadi 已提交
2262
    c->ReleaseCompactionFiles(status);
2263
    c->ReleaseInputs();
2264
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2265
  }
2266
  c.reset();
J
jorlow@chromium.org 已提交
2267 2268 2269 2270 2271 2272

  if (status.ok()) {
    // Done
  } else if (shutting_down_.Acquire_Load()) {
    // Ignore compaction errors found during shutting down
  } else {
2273
    Log(InfoLogLevel::WARN_LEVEL, options_.info_log, "Compaction error: %s",
2274
        status.ToString().c_str());
J
jorlow@chromium.org 已提交
2275 2276 2277 2278
    if (options_.paranoid_checks && bg_error_.ok()) {
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
2279 2280

  if (is_manual) {
G
Gabor Cselle 已提交
2281
    ManualCompaction* m = manual_compaction_;
2282
    if (!status.ok()) {
L
Lei Jin 已提交
2283
      m->status = status;
2284 2285
      m->done = true;
    }
2286 2287 2288 2289 2290 2291 2292 2293 2294
    // For universal compaction:
    //   Because universal compaction always happens at level 0, so one
    //   compaction will pick up all overlapped files. No files will be
    //   filtered out due to size limit and left for a successive compaction.
    //   So we can safely conclude the current compaction.
    //
    //   Also note that, if we don't stop here, then the current compaction
    //   writes a new file back to level 0, which will be used in successive
    //   compaction. Hence the manual compaction will never finish.
2295 2296 2297 2298 2299
    //
    // Stop the compaction if manual_end points to nullptr -- this means
    // that we compacted the whole range. manual_end should always point
    // to nullptr in case of universal compaction
    if (manual_end == nullptr) {
2300 2301
      m->done = true;
    }
G
Gabor Cselle 已提交
2302 2303 2304
    if (!m->done) {
      // We only compacted part of the requested range.  Update *m
      // to the range that is left to be compacted.
I
Igor Canadi 已提交
2305
      // Universal and FIFO compactions should always compact the whole range
I
Igor Canadi 已提交
2306
      assert(m->cfd->options()->compaction_style != kCompactionStyleUniversal);
I
Igor Canadi 已提交
2307
      assert(m->cfd->options()->compaction_style != kCompactionStyleFIFO);
2308
      m->tmp_storage = *manual_end;
G
Gabor Cselle 已提交
2309 2310
      m->begin = &m->tmp_storage;
    }
2311
    m->in_progress = false; // not being processed anymore
2312
    manual_compaction_ = nullptr;
H
hans@chromium.org 已提交
2313
  }
2314
  return status;
J
jorlow@chromium.org 已提交
2315 2316
}

2317
void DBImpl::CleanupCompaction(CompactionState* compact, Status status) {
J
jorlow@chromium.org 已提交
2318
  mutex_.AssertHeld();
2319
  if (compact->builder != nullptr) {
J
jorlow@chromium.org 已提交
2320 2321
    // May happen if we get a shutdown call in the middle of compaction
    compact->builder->Abandon();
2322
    compact->builder.reset();
J
jorlow@chromium.org 已提交
2323
  } else {
2324
    assert(compact->outfile == nullptr);
J
jorlow@chromium.org 已提交
2325
  }
D
dgrogan@chromium.org 已提交
2326
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2327 2328
    const CompactionState::Output& out = compact->outputs[i];
    pending_outputs_.erase(out.number);
2329 2330 2331 2332

    // If this file was inserted into the table cache then remove
    // them here because this compaction was not committed.
    if (!status.ok()) {
I
Igor Canadi 已提交
2333
      TableCache::Evict(table_cache_.get(), out.number);
2334
    }
J
jorlow@chromium.org 已提交
2335 2336 2337 2338
  }
  delete compact;
}

2339
// Allocate the file numbers for the output file. We allocate as
2340
// many output file numbers as there are files in level+1 (at least one)
2341 2342 2343
// Insert them into pending_outputs so that they do not get deleted.
void DBImpl::AllocateCompactionOutputFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2344 2345
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
2346
  int filesNeeded = compact->compaction->num_input_files(1);
2347
  for (int i = 0; i < std::max(filesNeeded, 1); i++) {
2348
    uint64_t file_number = versions_->NewFileNumber();
2349
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
2350 2351 2352 2353 2354 2355 2356
    compact->allocated_file_numbers.push_back(file_number);
  }
}

// Frees up unused file number.
void DBImpl::ReleaseCompactionUnusedFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2357
  for (const auto file_number : compact->allocated_file_numbers) {
2358 2359 2360 2361
    pending_outputs_.erase(file_number);
  }
}

J
jorlow@chromium.org 已提交
2362
Status DBImpl::OpenCompactionOutputFile(CompactionState* compact) {
2363 2364
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
J
jorlow@chromium.org 已提交
2365
  uint64_t file_number;
2366 2367 2368 2369 2370 2371 2372
  // If we have not yet exhausted the pre-allocated file numbers,
  // then use the one from the front. Otherwise, we have to acquire
  // the heavyweight lock and allocate a new file number.
  if (!compact->allocated_file_numbers.empty()) {
    file_number = compact->allocated_file_numbers.front();
    compact->allocated_file_numbers.pop_front();
  } else {
J
jorlow@chromium.org 已提交
2373 2374
    mutex_.Lock();
    file_number = versions_->NewFileNumber();
2375
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
J
jorlow@chromium.org 已提交
2376 2377
    mutex_.Unlock();
  }
2378 2379
  CompactionState::Output out;
  out.number = file_number;
2380
  out.path_id = compact->compaction->GetOutputPathId();
2381 2382
  out.smallest.Clear();
  out.largest.Clear();
2383
  out.smallest_seqno = out.largest_seqno = 0;
2384
  compact->outputs.push_back(out);
J
jorlow@chromium.org 已提交
2385 2386

  // Make the output file
2387 2388
  std::string fname = TableFileName(options_.db_paths, file_number,
                                    compact->compaction->GetOutputPathId());
2389
  Status s = env_->NewWritableFile(fname, &compact->outfile, storage_options_);
2390

J
jorlow@chromium.org 已提交
2391
  if (s.ok()) {
L
Lei Jin 已提交
2392
    compact->outfile->SetIOPriority(Env::IO_LOW);
2393
    compact->outfile->SetPreallocationBlockSize(
2394
        compact->compaction->OutputFilePreallocationSize());
2395

2396
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2397 2398 2399
    compact->builder.reset(NewTableBuilder(
        *cfd->options(), cfd->internal_comparator(), compact->outfile.get(),
        compact->compaction->OutputCompressionType()));
J
jorlow@chromium.org 已提交
2400
  }
I
Igor Canadi 已提交
2401
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
2402 2403 2404 2405 2406
  return s;
}

Status DBImpl::FinishCompactionOutputFile(CompactionState* compact,
                                          Iterator* input) {
2407
  assert(compact != nullptr);
2408
  assert(compact->outfile);
2409
  assert(compact->builder != nullptr);
J
jorlow@chromium.org 已提交
2410 2411

  const uint64_t output_number = compact->current_output()->number;
2412
  const uint32_t output_path_id = compact->current_output()->path_id;
J
jorlow@chromium.org 已提交
2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425
  assert(output_number != 0);

  // Check for iterator errors
  Status s = input->status();
  const uint64_t current_entries = compact->builder->NumEntries();
  if (s.ok()) {
    s = compact->builder->Finish();
  } else {
    compact->builder->Abandon();
  }
  const uint64_t current_bytes = compact->builder->FileSize();
  compact->current_output()->file_size = current_bytes;
  compact->total_bytes += current_bytes;
2426
  compact->builder.reset();
J
jorlow@chromium.org 已提交
2427 2428

  // Finish and check for file errors
2429
  if (s.ok() && !options_.disableDataSync) {
2430
    if (options_.use_fsync) {
L
Lei Jin 已提交
2431
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2432 2433
      s = compact->outfile->Fsync();
    } else {
L
Lei Jin 已提交
2434
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2435 2436
      s = compact->outfile->Sync();
    }
J
jorlow@chromium.org 已提交
2437 2438 2439 2440
  }
  if (s.ok()) {
    s = compact->outfile->Close();
  }
2441
  compact->outfile.reset();
J
jorlow@chromium.org 已提交
2442 2443 2444

  if (s.ok() && current_entries > 0) {
    // Verify that the table is usable
I
Igor Canadi 已提交
2445
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2446
    FileDescriptor fd(output_number, output_path_id, current_bytes);
I
Igor Canadi 已提交
2447
    Iterator* iter = cfd->table_cache()->NewIterator(
2448
        ReadOptions(), storage_options_, cfd->internal_comparator(), fd);
J
jorlow@chromium.org 已提交
2449 2450 2451
    s = iter->status();
    delete iter;
    if (s.ok()) {
2452 2453 2454 2455
      Log(options_.info_log, "[%s] Generated table #%" PRIu64 ": %" PRIu64
                             " keys, %" PRIu64 " bytes",
          cfd->GetName().c_str(), output_number, current_entries,
          current_bytes);
J
jorlow@chromium.org 已提交
2456 2457 2458 2459 2460 2461
    }
  }
  return s;
}


2462 2463
Status DBImpl::InstallCompactionResults(CompactionState* compact,
                                        LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
2464
  mutex_.AssertHeld();
2465 2466 2467 2468 2469

  // paranoia: verify that the files that we started with
  // still exist in the current version and in the same original level.
  // This ensures that a concurrent compaction did not erroneously
  // pick the same files to compact.
2470
  if (!versions_->VerifyCompactionFileConsistency(compact->compaction)) {
I
Igor Canadi 已提交
2471 2472 2473 2474 2475
    Log(options_.info_log, "[%s] Compaction %d@%d + %d@%d files aborted",
        compact->compaction->column_family_data()->GetName().c_str(),
        compact->compaction->num_input_files(0), compact->compaction->level(),
        compact->compaction->num_input_files(1),
        compact->compaction->output_level());
L
Lei Jin 已提交
2476
    return Status::Corruption("Compaction input files inconsistent");
2477 2478
  }

I
Igor Canadi 已提交
2479 2480
  LogToBuffer(log_buffer, "[%s] Compacted %d@%d + %d@%d files => %lld bytes",
              compact->compaction->column_family_data()->GetName().c_str(),
2481 2482 2483 2484 2485
              compact->compaction->num_input_files(0),
              compact->compaction->level(),
              compact->compaction->num_input_files(1),
              compact->compaction->output_level(),
              static_cast<long long>(compact->total_bytes));
J
jorlow@chromium.org 已提交
2486 2487 2488

  // Add compaction outputs
  compact->compaction->AddInputDeletions(compact->compaction->edit());
D
dgrogan@chromium.org 已提交
2489
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2490
    const CompactionState::Output& out = compact->outputs[i];
2491 2492 2493 2494
    compact->compaction->edit()->AddFile(compact->compaction->output_level(),
                                         out.number, out.path_id, out.file_size,
                                         out.smallest, out.largest,
                                         out.smallest_seqno, out.largest_seqno);
J
jorlow@chromium.org 已提交
2495
  }
I
Igor Canadi 已提交
2496 2497 2498
  return versions_->LogAndApply(compact->compaction->column_family_data(),
                                compact->compaction->edit(), &mutex_,
                                db_directory_.get());
J
jorlow@chromium.org 已提交
2499 2500
}

2501 2502 2503 2504 2505 2506 2507
// Given a sequence number, return the sequence number of the
// earliest snapshot that this sequence number is visible in.
// The snapshots themselves are arranged in ascending order of
// sequence numbers.
// Employ a sequential search because the total number of
// snapshots are typically small.
inline SequenceNumber DBImpl::findEarliestVisibleSnapshot(
2508 2509
  SequenceNumber in, std::vector<SequenceNumber>& snapshots,
  SequenceNumber* prev_snapshot) {
2510
  SequenceNumber prev __attribute__((unused)) = 0;
2511 2512 2513
  for (const auto cur : snapshots) {
    assert(prev <= cur);
    if (cur >= in) {
2514
      *prev_snapshot = prev;
2515
      return cur;
2516
    }
2517 2518
    prev = cur; // assignment
    assert(prev);
2519 2520
  }
  Log(options_.info_log,
2521 2522
      "Looking for seqid %" PRIu64 " but maxseqid is %" PRIu64 "", in,
      snapshots[snapshots.size() - 1]);
2523 2524 2525 2526
  assert(0);
  return 0;
}

I
Igor Canadi 已提交
2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545
uint64_t DBImpl::CallFlushDuringCompaction(ColumnFamilyData* cfd,
                                           DeletionState& deletion_state,
                                           LogBuffer* log_buffer) {
  if (cfd->imm()->imm_flush_needed.NoBarrier_Load() != nullptr) {
    const uint64_t imm_start = env_->NowMicros();
    mutex_.Lock();
    if (cfd->imm()->IsFlushPending()) {
      cfd->Ref();
      FlushMemTableToOutputFile(cfd, nullptr, deletion_state, log_buffer);
      cfd->Unref();
      bg_cv_.SignalAll();  // Wakeup MakeRoomForWrite() if necessary
    }
    mutex_.Unlock();
    log_buffer->FlushBufferToLog();
    return env_->NowMicros() - imm_start;
  }
  return 0;
}

D
Danny Guo 已提交
2546
Status DBImpl::ProcessKeyValueCompaction(
2547
    bool is_snapshot_supported,
D
Danny Guo 已提交
2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558
    SequenceNumber visible_at_tip,
    SequenceNumber earliest_snapshot,
    SequenceNumber latest_snapshot,
    DeletionState& deletion_state,
    bool bottommost_level,
    int64_t& imm_micros,
    Iterator* input,
    CompactionState* compact,
    bool is_compaction_v2,
    LogBuffer* log_buffer) {
  size_t combined_idx = 0;
J
jorlow@chromium.org 已提交
2559
  Status status;
D
Danny Guo 已提交
2560
  std::string compaction_filter_value;
J
jorlow@chromium.org 已提交
2561
  ParsedInternalKey ikey;
2562
  IterKey current_user_key;
J
jorlow@chromium.org 已提交
2563
  bool has_current_user_key = false;
2564
  IterKey delete_key;
2565 2566
  SequenceNumber last_sequence_for_key __attribute__((unused)) =
    kMaxSequenceNumber;
2567
  SequenceNumber visible_in_snapshot = kMaxSequenceNumber;
2568
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
I
Igor Canadi 已提交
2569 2570
  MergeHelper merge(
      cfd->user_comparator(), cfd->options()->merge_operator.get(),
2571 2572
      options_.info_log.get(), cfd->options()->min_partial_merge_operands,
      false /* internal key corruption is expected */);
I
Igor Canadi 已提交
2573
  auto compaction_filter = cfd->options()->compaction_filter;
2574 2575
  std::unique_ptr<CompactionFilter> compaction_filter_from_factory = nullptr;
  if (!compaction_filter) {
2576
    auto context = compact->GetFilterContextV1();
2577
    compaction_filter_from_factory =
I
Igor Canadi 已提交
2578 2579
        cfd->options()->compaction_filter_factory->CreateCompactionFilter(
            context);
2580 2581
    compaction_filter = compaction_filter_from_factory.get();
  }
2582

2583 2584
  while (input->Valid() && !shutting_down_.Acquire_Load() &&
         !cfd->IsDropped()) {
2585
    RecordCompactionIOStats();
2586 2587 2588 2589
    // FLUSH preempts compaction
    // TODO(icanadi) this currently only checks if flush is necessary on
    // compacting column family. we should also check if flush is necessary on
    // other column families, too
I
Igor Canadi 已提交
2590
    imm_micros += CallFlushDuringCompaction(cfd, deletion_state, log_buffer);
2591

D
Danny Guo 已提交
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612
    Slice key;
    Slice value;
    // If is_compaction_v2 is on, kv-pairs are reset to the prefix batch.
    // This prefix batch should contain results after calling
    // compaction_filter_v2.
    //
    // If is_compaction_v2 is off, this function will go through all the
    // kv-pairs in input.
    if (!is_compaction_v2) {
      key = input->key();
      value = input->value();
    } else {
      if (combined_idx >= compact->combined_key_buf_.size()) {
        break;
      }
      assert(combined_idx < compact->combined_key_buf_.size());
      key = compact->combined_key_buf_[combined_idx];
      value = compact->combined_value_buf_[combined_idx];

      ++combined_idx;
    }
H
Haobo Xu 已提交
2613

2614
    if (compact->compaction->ShouldStopBefore(key) &&
2615
        compact->builder != nullptr) {
D
Danny Guo 已提交
2616
      status = FinishCompactionOutputFile(compact, input);
2617 2618 2619 2620 2621 2622
      if (!status.ok()) {
        break;
      }
    }

    // Handle key/value, add to state, etc.
J
jorlow@chromium.org 已提交
2623
    bool drop = false;
2624
    bool current_entry_is_merging = false;
J
jorlow@chromium.org 已提交
2625 2626
    if (!ParseInternalKey(key, &ikey)) {
      // Do not hide error keys
2627 2628
      // TODO: error key stays in db forever? Figure out the intention/rationale
      // v10 error v8 : we cannot hide v8 even though it's pretty obvious.
2629
      current_user_key.Clear();
J
jorlow@chromium.org 已提交
2630 2631
      has_current_user_key = false;
      last_sequence_for_key = kMaxSequenceNumber;
2632
      visible_in_snapshot = kMaxSequenceNumber;
J
jorlow@chromium.org 已提交
2633 2634
    } else {
      if (!has_current_user_key ||
2635
          cfd->user_comparator()->Compare(ikey.user_key,
2636
                                          current_user_key.GetKey()) != 0) {
J
jorlow@chromium.org 已提交
2637
        // First occurrence of this user key
L
Lei Jin 已提交
2638
        current_user_key.SetKey(ikey.user_key);
J
jorlow@chromium.org 已提交
2639 2640
        has_current_user_key = true;
        last_sequence_for_key = kMaxSequenceNumber;
2641
        visible_in_snapshot = kMaxSequenceNumber;
H
Haobo Xu 已提交
2642
        // apply the compaction filter to the first occurrence of the user key
D
Danny Guo 已提交
2643
        if (compaction_filter && !is_compaction_v2 &&
H
Haobo Xu 已提交
2644 2645 2646 2647 2648 2649 2650 2651 2652
            ikey.type == kTypeValue &&
            (visible_at_tip || ikey.sequence > latest_snapshot)) {
          // If the user has specified a compaction filter and the sequence
          // number is greater than any external snapshot, then invoke the
          // filter.
          // If the return value of the compaction filter is true, replace
          // the entry with a delete marker.
          bool value_changed = false;
          compaction_filter_value.clear();
I
Igor Canadi 已提交
2653 2654 2655
          bool to_delete = compaction_filter->Filter(
              compact->compaction->level(), ikey.user_key, value,
              &compaction_filter_value, &value_changed);
H
Haobo Xu 已提交
2656
          if (to_delete) {
2657 2658 2659
            // make a copy of the original key and convert it to a delete
            delete_key.SetInternalKey(ExtractUserKey(key), ikey.sequence,
                                      kTypeDeletion);
H
Haobo Xu 已提交
2660
            // anchor the key again
2661
            key = delete_key.GetKey();
H
Haobo Xu 已提交
2662 2663 2664 2665
            // needed because ikey is backed by key
            ParseInternalKey(key, &ikey);
            // no value associated with delete
            value.clear();
L
Lei Jin 已提交
2666
            RecordTick(stats_, COMPACTION_KEY_DROP_USER);
H
Haobo Xu 已提交
2667 2668 2669 2670
          } else if (value_changed) {
            value = compaction_filter_value;
          }
        }
J
jorlow@chromium.org 已提交
2671 2672
      }

2673 2674 2675
      // If there are no snapshots, then this kv affect visibility at tip.
      // Otherwise, search though all existing snapshots to find
      // the earlist snapshot that is affected by this kv.
2676
      SequenceNumber prev_snapshot = 0; // 0 means no previous snapshot
2677 2678 2679 2680
      SequenceNumber visible = visible_at_tip ? visible_at_tip :
        is_snapshot_supported ?  findEarliestVisibleSnapshot(ikey.sequence,
                                  compact->existing_snapshots, &prev_snapshot)
                              : 0;
2681 2682 2683 2684 2685

      if (visible_in_snapshot == visible) {
        // If the earliest snapshot is which this key is visible in
        // is the same as the visibily of a previous instance of the
        // same key, then this kv is not visible in any snapshot.
J
jorlow@chromium.org 已提交
2686
        // Hidden by an newer entry for same user key
2687
        // TODO: why not > ?
2688
        assert(last_sequence_for_key >= ikey.sequence);
J
jorlow@chromium.org 已提交
2689
        drop = true;    // (A)
L
Lei Jin 已提交
2690
        RecordTick(stats_, COMPACTION_KEY_DROP_NEWER_ENTRY);
J
jorlow@chromium.org 已提交
2691
      } else if (ikey.type == kTypeDeletion &&
D
Danny Guo 已提交
2692
          ikey.sequence <= earliest_snapshot &&
2693
          compact->compaction->KeyNotExistsBeyondOutputLevel(ikey.user_key)) {
J
jorlow@chromium.org 已提交
2694 2695 2696 2697 2698 2699 2700 2701
        // For this user key:
        // (1) there is no data in higher levels
        // (2) data in lower levels will have larger sequence numbers
        // (3) data in layers that are being compacted here and have
        //     smaller sequence numbers will be dropped in the next
        //     few iterations of this loop (by rule (A) above).
        // Therefore this deletion marker is obsolete and can be dropped.
        drop = true;
L
Lei Jin 已提交
2702
        RecordTick(stats_, COMPACTION_KEY_DROP_OBSOLETE);
2703
      } else if (ikey.type == kTypeMerge) {
2704 2705 2706 2707 2708 2709
        if (!merge.HasOperator()) {
          LogToBuffer(log_buffer, "Options::merge_operator is null.");
          status = Status::InvalidArgument(
              "merge_operator is not properly initialized.");
          break;
        }
2710 2711 2712 2713 2714 2715
        // We know the merge type entry is not hidden, otherwise we would
        // have hit (A)
        // We encapsulate the merge related state machine in a different
        // object to minimize change to the existing flow. Turn out this
        // logic could also be nicely re-used for memtable flush purge
        // optimization in BuildTable.
D
Danny Guo 已提交
2716 2717 2718 2719 2720 2721
        int steps = 0;
        merge.MergeUntil(input, prev_snapshot, bottommost_level,
            options_.statistics.get(), &steps);
        // Skip the Merge ops
        combined_idx = combined_idx - 1 + steps;

2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739
        current_entry_is_merging = true;
        if (merge.IsSuccess()) {
          // Successfully found Put/Delete/(end-of-key-range) while merging
          // Get the merge result
          key = merge.key();
          ParseInternalKey(key, &ikey);
          value = merge.value();
        } else {
          // Did not find a Put/Delete/(end-of-key-range) while merging
          // We now have some stack of merge operands to write out.
          // NOTE: key,value, and ikey are now referring to old entries.
          //       These will be correctly set below.
          assert(!merge.keys().empty());
          assert(merge.keys().size() == merge.values().size());

          // Hack to make sure last_sequence_for_key is correct
          ParseInternalKey(merge.keys().front(), &ikey);
        }
J
jorlow@chromium.org 已提交
2740 2741 2742
      }

      last_sequence_for_key = ikey.sequence;
2743
      visible_in_snapshot = visible;
J
jorlow@chromium.org 已提交
2744 2745 2746
    }

    if (!drop) {
2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762
      // We may write a single key (e.g.: for Put/Delete or successful merge).
      // Or we may instead have to write a sequence/list of keys.
      // We have to write a sequence iff we have an unsuccessful merge
      bool has_merge_list = current_entry_is_merging && !merge.IsSuccess();
      const std::deque<std::string>* keys = nullptr;
      const std::deque<std::string>* values = nullptr;
      std::deque<std::string>::const_reverse_iterator key_iter;
      std::deque<std::string>::const_reverse_iterator value_iter;
      if (has_merge_list) {
        keys = &merge.keys();
        values = &merge.values();
        key_iter = keys->rbegin();    // The back (*rbegin()) is the first key
        value_iter = values->rbegin();

        key = Slice(*key_iter);
        value = Slice(*value_iter);
2763
      }
2764

2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775
      // If we have a list of keys to write, traverse the list.
      // If we have a single key to write, simply write that key.
      while (true) {
        // Invariant: key,value,ikey will always be the next entry to write
        char* kptr = (char*)key.data();
        std::string kstr;

        // Zeroing out the sequence number leads to better compression.
        // If this is the bottommost level (no files in lower levels)
        // and the earliest snapshot is larger than this seqno
        // then we can squash the seqno to zero.
2776
        if (bottommost_level && ikey.sequence < earliest_snapshot &&
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787
            ikey.type != kTypeMerge) {
          assert(ikey.type != kTypeDeletion);
          // make a copy because updating in place would cause problems
          // with the priority queue that is managing the input key iterator
          kstr.assign(key.data(), key.size());
          kptr = (char *)kstr.c_str();
          UpdateInternalKey(kptr, key.size(), (uint64_t)0, ikey.type);
        }

        Slice newkey(kptr, key.size());
        assert((key.clear(), 1)); // we do not need 'key' anymore
2788

2789 2790 2791 2792 2793 2794 2795
        // Open output file if necessary
        if (compact->builder == nullptr) {
          status = OpenCompactionOutputFile(compact);
          if (!status.ok()) {
            break;
          }
        }
2796 2797

        SequenceNumber seqno = GetInternalKeySeqno(newkey);
2798 2799
        if (compact->builder->NumEntries() == 0) {
          compact->current_output()->smallest.DecodeFrom(newkey);
2800 2801 2802 2803
          compact->current_output()->smallest_seqno = seqno;
        } else {
          compact->current_output()->smallest_seqno =
            std::min(compact->current_output()->smallest_seqno, seqno);
2804 2805 2806
        }
        compact->current_output()->largest.DecodeFrom(newkey);
        compact->builder->Add(newkey, value);
2807 2808
        compact->current_output()->largest_seqno =
          std::max(compact->current_output()->largest_seqno, seqno);
2809 2810 2811 2812

        // Close output file if it is big enough
        if (compact->builder->FileSize() >=
            compact->compaction->MaxOutputFileSize()) {
D
Danny Guo 已提交
2813
          status = FinishCompactionOutputFile(compact, input);
2814 2815 2816
          if (!status.ok()) {
            break;
          }
J
jorlow@chromium.org 已提交
2817 2818
        }

2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838
        // If we have a list of entries, move to next element
        // If we only had one entry, then break the loop.
        if (has_merge_list) {
          ++key_iter;
          ++value_iter;

          // If at end of list
          if (key_iter == keys->rend() || value_iter == values->rend()) {
            // Sanity Check: if one ends, then both end
            assert(key_iter == keys->rend() && value_iter == values->rend());
            break;
          }

          // Otherwise not at end of list. Update key, value, and ikey.
          key = Slice(*key_iter);
          value = Slice(*value_iter);
          ParseInternalKey(key, &ikey);

        } else{
          // Only had one item to begin with (Put/Delete)
J
jorlow@chromium.org 已提交
2839 2840 2841 2842 2843
          break;
        }
      }
    }

2844
    // MergeUntil has moved input to the next entry
2845
    if (!current_entry_is_merging) {
2846 2847
      input->Next();
    }
J
jorlow@chromium.org 已提交
2848 2849
  }

2850 2851
  RecordCompactionIOStats();

D
Danny Guo 已提交
2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897
  return status;
}

void DBImpl::CallCompactionFilterV2(CompactionState* compact,
  CompactionFilterV2* compaction_filter_v2) {
  if (compact == nullptr || compaction_filter_v2 == nullptr) {
    return;
  }

  std::vector<Slice> user_key_buf;
  for (const auto& key : compact->ikey_buf_) {
    user_key_buf.emplace_back(key.user_key);
  }

  // If the user has specified a compaction filter and the sequence
  // number is greater than any external snapshot, then invoke the
  // filter.
  // If the return value of the compaction filter is true, replace
  // the entry with a delete marker.
  compact->to_delete_buf_ = compaction_filter_v2->Filter(
      compact->compaction->level(),
      user_key_buf, compact->existing_value_buf_,
      &compact->new_value_buf_,
      &compact->value_changed_buf_);

  // new_value_buf_.size() <= to_delete__buf_.size(). "=" iff all
  // kv-pairs in this compaction run needs to be deleted.
  assert(compact->to_delete_buf_.size() ==
      compact->key_buf_.size());
  assert(compact->to_delete_buf_.size() ==
      compact->existing_value_buf_.size());
  assert(compact->to_delete_buf_.size() ==
      compact->value_changed_buf_.size());

  int new_value_idx = 0;
  for (unsigned int i = 0; i < compact->to_delete_buf_.size(); ++i) {
    if (compact->to_delete_buf_[i]) {
      // update the string buffer directly
      // the Slice buffer points to the updated buffer
      UpdateInternalKey(&compact->key_str_buf_[i][0],
          compact->key_str_buf_[i].size(),
          compact->ikey_buf_[i].sequence,
          kTypeDeletion);

      // no value associated with delete
      compact->existing_value_buf_[i].clear();
L
Lei Jin 已提交
2898
      RecordTick(stats_, COMPACTION_KEY_DROP_USER);
D
Danny Guo 已提交
2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911
    } else if (compact->value_changed_buf_[i]) {
      compact->existing_value_buf_[i] =
        Slice(compact->new_value_buf_[new_value_idx++]);
    }
  }  // for
}

Status DBImpl::DoCompactionWork(CompactionState* compact,
                                DeletionState& deletion_state,
                                LogBuffer* log_buffer) {
  assert(compact);
  compact->CleanupBatchBuffer();
  compact->CleanupMergedBuffer();
2912
  bool prefix_initialized = false;
D
Danny Guo 已提交
2913

F
Feng Zhu 已提交
2914 2915
  // Generate file_levels_ for compaction berfore making Iterator
  compact->compaction->GenerateFileLevels();
D
Danny Guo 已提交
2916
  int64_t imm_micros = 0;  // Micros spent doing imm_ compactions
2917
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
2918 2919
  LogToBuffer(
      log_buffer,
I
Igor Canadi 已提交
2920 2921
      "[%s] Compacting %d@%d + %d@%d files, score %.2f slots available %d",
      cfd->GetName().c_str(), compact->compaction->num_input_files(0),
2922 2923
      compact->compaction->level(), compact->compaction->num_input_files(1),
      compact->compaction->output_level(), compact->compaction->score(),
D
Danny Guo 已提交
2924 2925 2926
      options_.max_background_compactions - bg_compaction_scheduled_);
  char scratch[2345];
  compact->compaction->Summary(scratch, sizeof(scratch));
I
Igor Canadi 已提交
2927 2928
  LogToBuffer(log_buffer, "[%s] Compaction start summary: %s\n",
              cfd->GetName().c_str(), scratch);
D
Danny Guo 已提交
2929

2930
  assert(cfd->current()->NumLevelFiles(compact->compaction->level()) > 0);
D
Danny Guo 已提交
2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955
  assert(compact->builder == nullptr);
  assert(!compact->outfile);

  SequenceNumber visible_at_tip = 0;
  SequenceNumber earliest_snapshot;
  SequenceNumber latest_snapshot = 0;
  snapshots_.getAll(compact->existing_snapshots);
  if (compact->existing_snapshots.size() == 0) {
    // optimize for fast path if there are no snapshots
    visible_at_tip = versions_->LastSequence();
    earliest_snapshot = visible_at_tip;
  } else {
    latest_snapshot = compact->existing_snapshots.back();
    // Add the current seqno as the 'latest' virtual
    // snapshot to the end of this list.
    compact->existing_snapshots.push_back(versions_->LastSequence());
    earliest_snapshot = compact->existing_snapshots[0];
  }

  // Is this compaction producing files at the bottommost level?
  bool bottommost_level = compact->compaction->BottomMostLevel();

  // Allocate the output file numbers before we release the lock
  AllocateCompactionOutputFileNumbers(compact);

2956
  bool is_snapshot_supported = IsSnapshotSupported();
D
Danny Guo 已提交
2957 2958
  // Release mutex while we're actually doing the compaction work
  mutex_.Unlock();
2959
  log_buffer->FlushBufferToLog();
D
Danny Guo 已提交
2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973

  const uint64_t start_micros = env_->NowMicros();
  unique_ptr<Iterator> input(versions_->MakeInputIterator(compact->compaction));
  input->SeekToFirst();
  shared_ptr<Iterator> backup_input(
      versions_->MakeInputIterator(compact->compaction));
  backup_input->SeekToFirst();

  Status status;
  ParsedInternalKey ikey;
  std::unique_ptr<CompactionFilterV2> compaction_filter_from_factory_v2
    = nullptr;
  auto context = compact->GetFilterContext();
  compaction_filter_from_factory_v2 =
2974 2975
      cfd->options()->compaction_filter_factory_v2->CreateCompactionFilterV2(
          context);
D
Danny Guo 已提交
2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986
  auto compaction_filter_v2 =
    compaction_filter_from_factory_v2.get();

  // temp_backup_input always point to the start of the current buffer
  // temp_backup_input = backup_input;
  // iterate through input,
  // 1) buffer ineligible keys and value keys into 2 separate buffers;
  // 2) send value_buffer to compaction filter and alternate the values;
  // 3) merge value_buffer with ineligible_value_buffer;
  // 4) run the modified "compaction" using the old for loop.
  if (compaction_filter_v2) {
2987 2988
    while (backup_input->Valid() && !shutting_down_.Acquire_Load() &&
           !cfd->IsDropped()) {
I
Igor Canadi 已提交
2989 2990 2991 2992 2993 2994
      // FLUSH preempts compaction
      // TODO(icanadi) this currently only checks if flush is necessary on
      // compacting column family. we should also check if flush is necessary on
      // other column families, too
      imm_micros += CallFlushDuringCompaction(cfd, deletion_state, log_buffer);

D
Danny Guo 已提交
2995 2996 2997 2998
      Slice key = backup_input->key();
      Slice value = backup_input->value();

      const SliceTransform* transformer =
2999
          cfd->options()->compaction_filter_factory_v2->GetPrefixExtractor();
3000
      const auto key_prefix = transformer->Transform(key);
3001
      if (!prefix_initialized) {
3002
        compact->cur_prefix_ = key_prefix.ToString();
3003
        prefix_initialized = true;
D
Danny Guo 已提交
3004 3005 3006
      }
      if (!ParseInternalKey(key, &ikey)) {
        // log error
I
Igor Canadi 已提交
3007 3008
        Log(options_.info_log, "[%s] Failed to parse key: %s",
            cfd->GetName().c_str(), key.ToString().c_str());
D
Danny Guo 已提交
3009 3010 3011
        continue;
      } else {
        // If the prefix remains the same, keep buffering
3012
        if (key_prefix.compare(Slice(compact->cur_prefix_)) == 0) {
D
Danny Guo 已提交
3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032
          // Apply the compaction filter V2 to all the kv pairs sharing
          // the same prefix
          if (ikey.type == kTypeValue &&
              (visible_at_tip || ikey.sequence > latest_snapshot)) {
            // Buffer all keys sharing the same prefix for CompactionFilterV2
            // Iterate through keys to check prefix
            compact->BufferKeyValueSlices(key, value);
          } else {
            // buffer ineligible keys
            compact->BufferOtherKeyValueSlices(key, value);
          }
          backup_input->Next();
          continue;
          // finish changing values for eligible keys
        } else {
          // Now prefix changes, this batch is done.
          // Call compaction filter on the buffered values to change the value
          if (compact->key_buf_.size() > 0) {
            CallCompactionFilterV2(compact, compaction_filter_v2);
          }
3033
          compact->cur_prefix_ = key_prefix.ToString();
D
Danny Guo 已提交
3034 3035 3036 3037
        }
      }

      // Merge this batch of data (values + ineligible keys)
3038
      compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3039 3040 3041 3042

      // Done buffering for the current prefix. Spit it out to disk
      // Now just iterate through all the kv-pairs
      status = ProcessKeyValueCompaction(
3043
          is_snapshot_supported,
D
Danny Guo 已提交
3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075
          visible_at_tip,
          earliest_snapshot,
          latest_snapshot,
          deletion_state,
          bottommost_level,
          imm_micros,
          input.get(),
          compact,
          true,
          log_buffer);

      if (!status.ok()) {
        break;
      }

      // After writing the kv-pairs, we can safely remove the reference
      // to the string buffer and clean them up
      compact->CleanupBatchBuffer();
      compact->CleanupMergedBuffer();
      // Buffer the key that triggers the mismatch in prefix
      if (ikey.type == kTypeValue &&
        (visible_at_tip || ikey.sequence > latest_snapshot)) {
        compact->BufferKeyValueSlices(key, value);
      } else {
        compact->BufferOtherKeyValueSlices(key, value);
      }
      backup_input->Next();
      if (!backup_input->Valid()) {
        // If this is the single last value, we need to merge it.
        if (compact->key_buf_.size() > 0) {
          CallCompactionFilterV2(compact, compaction_filter_v2);
        }
3076
        compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3077 3078

        status = ProcessKeyValueCompaction(
3079
            is_snapshot_supported,
D
Danny Guo 已提交
3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098
            visible_at_tip,
            earliest_snapshot,
            latest_snapshot,
            deletion_state,
            bottommost_level,
            imm_micros,
            input.get(),
            compact,
            true,
            log_buffer);

        compact->CleanupBatchBuffer();
        compact->CleanupMergedBuffer();
      }
    }  // done processing all prefix batches
    // finish the last batch
    if (compact->key_buf_.size() > 0) {
      CallCompactionFilterV2(compact, compaction_filter_v2);
    }
3099
    compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3100
    status = ProcessKeyValueCompaction(
3101
        is_snapshot_supported,
D
Danny Guo 已提交
3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115
        visible_at_tip,
        earliest_snapshot,
        latest_snapshot,
        deletion_state,
        bottommost_level,
        imm_micros,
        input.get(),
        compact,
        true,
        log_buffer);
  }  // checking for compaction filter v2

  if (!compaction_filter_v2) {
    status = ProcessKeyValueCompaction(
3116
      is_snapshot_supported,
D
Danny Guo 已提交
3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128
      visible_at_tip,
      earliest_snapshot,
      latest_snapshot,
      deletion_state,
      bottommost_level,
      imm_micros,
      input.get(),
      compact,
      false,
      log_buffer);
  }

3129
  if (status.ok() && (shutting_down_.Acquire_Load() || cfd->IsDropped())) {
L
Lei Jin 已提交
3130
    status = Status::ShutdownInProgress(
3131
        "Database shutdown or Column family drop during compaction");
J
jorlow@chromium.org 已提交
3132
  }
3133
  if (status.ok() && compact->builder != nullptr) {
3134
    status = FinishCompactionOutputFile(compact, input.get());
J
jorlow@chromium.org 已提交
3135 3136 3137 3138
  }
  if (status.ok()) {
    status = input->status();
  }
3139
  input.reset();
J
jorlow@chromium.org 已提交
3140

3141 3142 3143
  if (!options_.disableDataSync) {
    db_directory_->Fsync();
  }
I
Igor Canadi 已提交
3144

L
Lei Jin 已提交
3145
  InternalStats::CompactionStats stats(1);
3146
  stats.micros = env_->NowMicros() - start_micros - imm_micros;
M
Mark Callaghan 已提交
3147 3148
  stats.files_in_leveln = compact->compaction->num_input_files(0);
  stats.files_in_levelnp1 = compact->compaction->num_input_files(1);
L
Lei Jin 已提交
3149
  MeasureTime(stats_, COMPACTION_TIME, stats.micros);
3150 3151

  int num_output_files = compact->outputs.size();
3152
  if (compact->builder != nullptr) {
P
Pascal Borreli 已提交
3153
    // An error occurred so ignore the last output.
3154 3155 3156 3157
    assert(num_output_files > 0);
    --num_output_files;
  }
  stats.files_out_levelnp1 = num_output_files;
M
Mark Callaghan 已提交
3158

3159
  for (int i = 0; i < compact->compaction->num_input_files(0); i++) {
3160
    stats.bytes_readn += compact->compaction->input(0, i)->fd.GetFileSize();
3161
  }
M
Mark Callaghan 已提交
3162

3163
  for (int i = 0; i < compact->compaction->num_input_files(1); i++) {
3164
    stats.bytes_readnp1 += compact->compaction->input(1, i)->fd.GetFileSize();
3165
  }
M
Mark Callaghan 已提交
3166

3167
  for (int i = 0; i < num_output_files; i++) {
3168 3169 3170
    stats.bytes_written += compact->outputs[i].file_size;
  }

3171 3172
  RecordCompactionIOStats();

I
Igor Canadi 已提交
3173
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
3174
  mutex_.Lock();
3175 3176
  cfd->internal_stats()->AddCompactionStats(
      compact->compaction->output_level(), stats);
J
jorlow@chromium.org 已提交
3177

3178 3179 3180 3181
  // if there were any unused file number (mostly in case of
  // compaction error), free up the entry from pending_putputs
  ReleaseCompactionUnusedFileNumbers(compact);

J
jorlow@chromium.org 已提交
3182
  if (status.ok()) {
3183
    status = InstallCompactionResults(compact, log_buffer);
I
Igor Canadi 已提交
3184
    InstallSuperVersion(cfd, deletion_state);
J
jorlow@chromium.org 已提交
3185
  }
3186
  Version::LevelSummaryStorage tmp;
3187 3188
  LogToBuffer(
      log_buffer,
I
Igor Canadi 已提交
3189
      "[%s] compacted to: %s, %.1f MB/sec, level %d, files in(%d, %d) out(%d) "
3190 3191
      "MB in(%.1f, %.1f) out(%.1f), read-write-amplify(%.1f) "
      "write-amplify(%.1f) %s\n",
I
Igor Canadi 已提交
3192
      cfd->GetName().c_str(), cfd->current()->LevelSummary(&tmp),
M
Mark Callaghan 已提交
3193
      (stats.bytes_readn + stats.bytes_readnp1 + stats.bytes_written) /
3194 3195 3196 3197
          (double)stats.micros,
      compact->compaction->output_level(), stats.files_in_leveln,
      stats.files_in_levelnp1, stats.files_out_levelnp1,
      stats.bytes_readn / 1048576.0, stats.bytes_readnp1 / 1048576.0,
M
Mark Callaghan 已提交
3198
      stats.bytes_written / 1048576.0,
3199
      (stats.bytes_written + stats.bytes_readnp1 + stats.bytes_readn) /
3200 3201
          (double)stats.bytes_readn,
      stats.bytes_written / (double)stats.bytes_readn,
3202
      status.ToString().c_str());
M
Mark Callaghan 已提交
3203

J
jorlow@chromium.org 已提交
3204 3205 3206
  return status;
}

3207 3208
namespace {
struct IterState {
3209 3210
  IterState(DBImpl* db, port::Mutex* mu, SuperVersion* super_version)
      : db(db), mu(mu), super_version(super_version) {}
3211 3212

  DBImpl* db;
3213
  port::Mutex* mu;
3214
  SuperVersion* super_version;
3215 3216 3217 3218
};

static void CleanupIteratorState(void* arg1, void* arg2) {
  IterState* state = reinterpret_cast<IterState*>(arg1);
3219

3220
  if (state->super_version->Unref()) {
3221 3222
    DBImpl::DeletionState deletion_state;

3223 3224 3225 3226 3227 3228
    state->mu->Lock();
    state->super_version->Cleanup();
    state->db->FindObsoleteFiles(deletion_state, false, true);
    state->mu->Unlock();

    delete state->super_version;
3229 3230 3231
    if (deletion_state.HaveSomethingToDelete()) {
      state->db->PurgeObsoleteFiles(deletion_state);
    }
I
Igor Canadi 已提交
3232
  }
T
Tomislav Novak 已提交
3233

3234 3235
  delete state;
}
H
Hans Wennborg 已提交
3236
}  // namespace
3237

J
jorlow@chromium.org 已提交
3238
Iterator* DBImpl::NewInternalIterator(const ReadOptions& options,
3239
                                      ColumnFamilyData* cfd,
3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267
                                      SuperVersion* super_version,
                                      Arena* arena) {
  Iterator* internal_iter;
  if (arena != nullptr) {
    // Need to create internal iterator from the arena.
    MergeIteratorBuilder merge_iter_builder(&cfd->internal_comparator(), arena);
    // Collect iterator for mutable mem
    merge_iter_builder.AddIterator(
        super_version->mem->NewIterator(options, false, arena));
    // Collect all needed child iterators for immutable memtables
    super_version->imm->AddIterators(options, &merge_iter_builder);
    // Collect iterators for files in L0 - Ln
    super_version->current->AddIterators(options, storage_options_,
                                         &merge_iter_builder);
    internal_iter = merge_iter_builder.Finish();
  } else {
    // Need to create internal iterator using malloc.
    std::vector<Iterator*> iterator_list;
    // Collect iterator for mutable mem
    iterator_list.push_back(super_version->mem->NewIterator(options));
    // Collect all needed child iterators for immutable memtables
    super_version->imm->AddIterators(options, &iterator_list);
    // Collect iterators for files in L0 - Ln
    super_version->current->AddIterators(options, storage_options_,
                                         &iterator_list);
    internal_iter = NewMergingIterator(&cfd->internal_comparator(),
                                       &iterator_list[0], iterator_list.size());
  }
3268
  IterState* cleanup = new IterState(this, &mutex_, super_version);
3269
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
3270 3271 3272 3273

  return internal_iter;
}

3274 3275 3276 3277
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

J
jorlow@chromium.org 已提交
3278
Status DBImpl::Get(const ReadOptions& options,
3279
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3280
                   std::string* value) {
3281
  return GetImpl(options, column_family, key, value);
3282 3283
}

I
Igor Canadi 已提交
3284 3285 3286
// DeletionState gets created and destructed outside of the lock -- we
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3287
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3288 3289 3290 3291 3292 3293
//
// However, if InstallSuperVersion() gets called twice with the same,
// deletion_state, we can't reuse the SuperVersion() that got malloced because
// first call already used it. In that rare case, we take a hit and create a
// new SuperVersion() inside of the mutex. We do similar thing
// for superversion_to_free
3294 3295
void DBImpl::InstallSuperVersion(ColumnFamilyData* cfd,
                                 DeletionState& deletion_state) {
3296
  mutex_.AssertHeld();
I
Igor Canadi 已提交
3297 3298 3299 3300
  // if new_superversion == nullptr, it means somebody already used it
  SuperVersion* new_superversion =
    (deletion_state.new_superversion != nullptr) ?
    deletion_state.new_superversion : new SuperVersion();
3301 3302
  SuperVersion* old_superversion =
      cfd->InstallSuperVersion(new_superversion, &mutex_);
I
Igor Canadi 已提交
3303
  deletion_state.new_superversion = nullptr;
3304
  deletion_state.superversions_to_free.push_back(old_superversion);
I
Igor Canadi 已提交
3305 3306
}

3307
Status DBImpl::GetImpl(const ReadOptions& options,
3308 3309
                       ColumnFamilyHandle* column_family, const Slice& key,
                       std::string* value, bool* value_found) {
L
Lei Jin 已提交
3310
  StopWatch sw(env_, stats_, DB_GET);
L
Lei Jin 已提交
3311
  PERF_TIMER_AUTO(get_snapshot_time);
3312

3313 3314 3315
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3316
  SequenceNumber snapshot;
3317
  if (options.snapshot != nullptr) {
3318 3319 3320
    snapshot = reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_;
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3321
  }
3322

3323 3324
  // Acquire SuperVersion
  SuperVersion* sv = nullptr;
3325
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
3326
  if (LIKELY(options_.allow_thread_local)) {
3327
    sv = cfd->GetThreadLocalSuperVersion(&mutex_);
3328 3329
  } else {
    mutex_.Lock();
3330
    sv = cfd->GetSuperVersion()->Ref();
3331 3332
    mutex_.Unlock();
  }
I
Igor Canadi 已提交
3333

3334
  // Prepare to store a list of merge operations if merge occurs.
3335
  MergeContext merge_context;
3336

3337
  Status s;
3338
  // First look in the memtable, then in the immutable memtable (if any).
3339
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3340
  // merge_operands will contain the sequence of merges in the latter case.
3341
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3342
  PERF_TIMER_STOP(get_snapshot_time);
I
Igor Canadi 已提交
3343
  if (sv->mem->Get(lkey, value, &s, merge_context, *cfd->options())) {
3344
    // Done
L
Lei Jin 已提交
3345
    RecordTick(stats_, MEMTABLE_HIT);
I
Igor Canadi 已提交
3346
  } else if (sv->imm->Get(lkey, value, &s, merge_context, *cfd->options())) {
3347
    // Done
L
Lei Jin 已提交
3348
    RecordTick(stats_, MEMTABLE_HIT);
3349
  } else {
L
Lei Jin 已提交
3350
    PERF_TIMER_START(get_from_output_files_time);
3351

I
Igor Canadi 已提交
3352
    sv->current->Get(options, lkey, value, &s, &merge_context, value_found);
L
Lei Jin 已提交
3353
    PERF_TIMER_STOP(get_from_output_files_time);
L
Lei Jin 已提交
3354
    RecordTick(stats_, MEMTABLE_MISS);
3355
  }
3356

L
Lei Jin 已提交
3357
  PERF_TIMER_START(get_post_process_time);
3358

3359
  bool unref_sv = true;
3360
  if (LIKELY(options_.allow_thread_local)) {
3361
    unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
3362 3363 3364 3365
  }

  if (unref_sv) {
    // Release SuperVersion
3366
    if (sv->Unref()) {
I
Igor Canadi 已提交
3367
      mutex_.Lock();
3368
      sv->Cleanup();
I
Igor Canadi 已提交
3369
      mutex_.Unlock();
3370
      delete sv;
L
Lei Jin 已提交
3371
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
I
Igor Canadi 已提交
3372
    }
L
Lei Jin 已提交
3373
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
3374
  }
3375

L
Lei Jin 已提交
3376 3377
  RecordTick(stats_, NUMBER_KEYS_READ);
  RecordTick(stats_, BYTES_READ, value->size());
L
Lei Jin 已提交
3378
  PERF_TIMER_STOP(get_post_process_time);
3379
  return s;
J
jorlow@chromium.org 已提交
3380 3381
}

3382 3383
std::vector<Status> DBImpl::MultiGet(
    const ReadOptions& options,
3384
    const std::vector<ColumnFamilyHandle*>& column_family,
3385
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3386

L
Lei Jin 已提交
3387
  StopWatch sw(env_, stats_, DB_MULTIGET);
L
Lei Jin 已提交
3388
  PERF_TIMER_AUTO(get_snapshot_time);
K
Kai Liu 已提交
3389

3390
  SequenceNumber snapshot;
3391

3392
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3393
    ColumnFamilyData* cfd;
3394 3395 3396 3397 3398
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3399 3400 3401 3402 3403 3404
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(cf);
    auto cfd = cfh->cfd();
    if (multiget_cf_data.find(cfd->GetID()) == multiget_cf_data.end()) {
      auto mgcfd = new MultiGetColumnFamilyData();
      mgcfd->cfd = cfd;
      multiget_cf_data.insert({cfd->GetID(), mgcfd});
3405 3406 3407
    }
  }

3408
  mutex_.Lock();
3409 3410 3411 3412 3413
  if (options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_;
  } else {
    snapshot = versions_->LastSequence();
  }
3414
  for (auto mgd_iter : multiget_cf_data) {
3415 3416
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3417
  }
3418
  mutex_.Unlock();
3419

3420 3421
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3422

3423
  // Note: this always resizes the values array
3424 3425 3426
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3427 3428

  // Keep track of bytes that we read for statistics-recording later
3429
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3430
  PERF_TIMER_STOP(get_snapshot_time);
3431 3432 3433 3434

  // For each of the given keys, apply the entire "get" process as follows:
  // First look in the memtable, then in the immutable memtable (if any).
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3435
  // merge_operands will contain the sequence of merges in the latter case.
3436
  for (size_t i = 0; i < num_keys; ++i) {
3437
    merge_context.Clear();
3438
    Status& s = stat_list[i];
3439 3440 3441
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3442 3443
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3444 3445 3446
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
I
Igor Canadi 已提交
3447 3448
    auto cfd = mgd->cfd;
    if (super_version->mem->Get(lkey, value, &s, merge_context,
I
Igor Canadi 已提交
3449
                                *cfd->options())) {
3450
      // Done
3451
    } else if (super_version->imm->Get(lkey, value, &s, merge_context,
I
Igor Canadi 已提交
3452
                                       *cfd->options())) {
3453 3454
      // Done
    } else {
I
Igor Canadi 已提交
3455
      super_version->current->Get(options, lkey, value, &s, &merge_context);
3456 3457 3458
    }

    if (s.ok()) {
3459
      bytes_read += value->size();
3460 3461 3462 3463
    }
  }

  // Post processing (decrement reference counts and record statistics)
L
Lei Jin 已提交
3464
  PERF_TIMER_START(get_post_process_time);
3465 3466
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
3467
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3468 3469 3470 3471 3472 3473
  mutex_.Lock();
  for (auto mgd_iter : multiget_cf_data) {
    auto mgd = mgd_iter.second;
    if (mgd->super_version->Unref()) {
      mgd->super_version->Cleanup();
      superversions_to_delete.push_back(mgd->super_version);
3474 3475
    }
  }
3476 3477 3478 3479 3480 3481 3482
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3483
  }
3484

L
Lei Jin 已提交
3485 3486 3487
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
L
Lei Jin 已提交
3488
  PERF_TIMER_STOP(get_post_process_time);
3489

3490
  return stat_list;
3491 3492
}

3493
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& options,
3494
                                  const std::string& column_family_name,
3495
                                  ColumnFamilyHandle** handle) {
I
Igor Canadi 已提交
3496 3497 3498
  *handle = nullptr;
  MutexLock l(&mutex_);

I
Igor Canadi 已提交
3499 3500
  if (versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name) !=
      nullptr) {
I
Igor Canadi 已提交
3501 3502
    return Status::InvalidArgument("Column family already exists");
  }
3503
  VersionEdit edit;
3504
  edit.AddColumnFamily(column_family_name);
3505 3506
  uint32_t new_id = versions_->GetColumnFamilySet()->GetNextColumnFamilyID();
  edit.SetColumnFamily(new_id);
I
Igor Canadi 已提交
3507
  edit.SetLogNumber(logfile_number_);
I
Igor Canadi 已提交
3508
  edit.SetComparatorName(options.comparator->Name());
3509

I
Igor Canadi 已提交
3510 3511
  // LogAndApply will both write the creation in MANIFEST and create
  // ColumnFamilyData object
3512 3513
  Status s = versions_->LogAndApply(nullptr, &edit, &mutex_,
                                    db_directory_.get(), false, &options);
3514
  if (s.ok()) {
3515
    single_column_family_mode_ = false;
3516 3517 3518
    auto cfd =
        versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
    assert(cfd != nullptr);
3519
    delete cfd->InstallSuperVersion(new SuperVersion(), &mutex_);
3520
    *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
I
Igor Canadi 已提交
3521
    Log(options_.info_log, "Created column family [%s] (ID %u)",
3522
        column_family_name.c_str(), (unsigned)cfd->GetID());
I
Igor Canadi 已提交
3523 3524
    max_total_in_memory_state_ += cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
3525
  } else {
I
Igor Canadi 已提交
3526
    Log(options_.info_log, "Creating column family [%s] FAILED -- %s",
3527 3528
        column_family_name.c_str(), s.ToString().c_str());
  }
3529
  return s;
3530 3531
}

3532 3533 3534 3535
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3536 3537
    return Status::InvalidArgument("Can't drop default column family");
  }
3538

I
Igor Canadi 已提交
3539 3540
  VersionEdit edit;
  edit.DropColumnFamily();
3541 3542
  edit.SetColumnFamily(cfd->GetID());

3543
  Status s;
3544 3545 3546 3547 3548 3549 3550 3551
  {
    MutexLock l(&mutex_);
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
      s = versions_->LogAndApply(cfd, &edit, &mutex_);
    }
3552
  }
3553

3554
  if (s.ok()) {
I
Igor Canadi 已提交
3555
    assert(cfd->IsDropped());
I
Igor Canadi 已提交
3556 3557
    max_total_in_memory_state_ -= cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
3558
    Log(options_.info_log, "Dropped column family with id %u\n", cfd->GetID());
3559
    // Flush the memtables. This will make all WAL files referencing dropped
I
Igor Canadi 已提交
3560
    // column family to be obsolete. They will be deleted once user deletes
3561 3562
    // column family handle
    Write(WriteOptions(), nullptr);  // ignore error
3563 3564 3565 3566 3567
  } else {
    Log(options_.info_log, "Dropping column family with id %u FAILED -- %s\n",
        cfd->GetID(), s.ToString().c_str());
  }

3568
  return s;
3569 3570
}

3571
bool DBImpl::KeyMayExist(const ReadOptions& options,
3572 3573
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
3574
  if (value_found != nullptr) {
K
Kai Liu 已提交
3575 3576
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
3577
  }
3578 3579
  ReadOptions roptions = options;
  roptions.read_tier = kBlockCacheTier; // read from block cache only
3580
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
3581 3582 3583 3584 3585

  // If options.block_cache != nullptr and the index block of the table didn't
  // not present in block_cache, the return value will be Status::Incomplete.
  // In this case, key may still exist in the table.
  return s.ok() || s.IsIncomplete();
3586 3587
}

3588
Iterator* DBImpl::NewIterator(const ReadOptions& options,
3589 3590 3591
                              ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
3592 3593

  if (options.tailing) {
I
Igor Canadi 已提交
3594 3595 3596 3597
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
L
Lei Jin 已提交
3598
    // TODO(ljin): remove tailing iterator
I
Igor Canadi 已提交
3599
    auto iter = new ForwardIterator(this, options, cfd);
3600 3601 3602
    return NewDBIterator(env_, *cfd->options(), cfd->user_comparator(), iter,
                         kMaxSequenceNumber);
// return new TailingIterator(env_, this, options, cfd);
I
Igor Canadi 已提交
3603
#endif
T
Tomislav Novak 已提交
3604
  } else {
3605 3606 3607 3608
    SequenceNumber latest_snapshot = versions_->LastSequence();
    SuperVersion* sv = nullptr;
    sv = cfd->GetReferencedSuperVersion(&mutex_);

I
Igor Canadi 已提交
3609 3610 3611 3612
    auto snapshot =
        options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_
            : latest_snapshot;
T
Tomislav Novak 已提交
3613

3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663
    // Try to generate a DB iterator tree in continuous memory area to be
    // cache friendly. Here is an example of result:
    // +-------------------------------+
    // |                               |
    // | ArenaWrappedDBIter            |
    // |  +                            |
    // |  +---> Inner Iterator   ------------+
    // |  |                            |     |
    // |  |    +-- -- -- -- -- -- -- --+     |
    // |  +--- | Arena                 |     |
    // |       |                       |     |
    // |          Allocated Memory:    |     |
    // |       |   +-------------------+     |
    // |       |   | DBIter            | <---+
    // |           |  +                |
    // |       |   |  +-> iter_  ------------+
    // |       |   |                   |     |
    // |       |   +-------------------+     |
    // |       |   | MergingIterator   | <---+
    // |           |  +                |
    // |       |   |  +->child iter1  ------------+
    // |       |   |  |                |          |
    // |           |  +->child iter2  ----------+ |
    // |       |   |  |                |        | |
    // |       |   |  +->child iter3  --------+ | |
    // |           |                   |      | | |
    // |       |   +-------------------+      | | |
    // |       |   | Iterator1         | <--------+
    // |       |   +-------------------+      | |
    // |       |   | Iterator2         | <------+
    // |       |   +-------------------+      |
    // |       |   | Iterator3         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
    // ArenaWrappedDBIter inlines an arena area where all the iterartor in the
    // the iterator tree is allocated in the order of being accessed when
    // querying.
    // Laying out the iterators in the order of being accessed makes it more
    // likely that any iterator pointer is close to the iterator it points to so
    // that they are likely to be in the same cache line and/or page.
    ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
        env_, *cfd->options(), cfd->user_comparator(), snapshot);
    Iterator* internal_iter =
        NewInternalIterator(options, cfd, sv, db_iter->GetArena());
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
J
jorlow@chromium.org 已提交
3664 3665
}

3666 3667
Status DBImpl::NewIterators(
    const ReadOptions& options,
I
Igor Canadi 已提交
3668
    const std::vector<ColumnFamilyHandle*>& column_families,
3669
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686
  iterators->clear();
  iterators->reserve(column_families.size());
  SequenceNumber latest_snapshot = 0;
  std::vector<SuperVersion*> super_versions;
  super_versions.reserve(column_families.size());

  if (!options.tailing) {
    mutex_.Lock();
    latest_snapshot = versions_->LastSequence();
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
      super_versions.push_back(cfd->GetSuperVersion()->Ref());
    }
    mutex_.Unlock();
  }

  if (options.tailing) {
I
Igor Canadi 已提交
3687 3688 3689 3690
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
3691 3692
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
L
Lei Jin 已提交
3693
      iterators->push_back(new TailingIterator(env_, this, options, cfd));
I
Igor Canadi 已提交
3694
    }
I
Igor Canadi 已提交
3695
#endif
I
Igor Canadi 已提交
3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706
  } else {
    for (size_t i = 0; i < column_families.size(); ++i) {
      auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_families[i]);
      auto cfd = cfh->cfd();

      auto snapshot =
          options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_
              : latest_snapshot;

      auto iter = NewInternalIterator(options, cfd, super_versions[i]);
L
Lei Jin 已提交
3707
      iter = NewDBIterator(env_, *cfd->options(),
I
Igor Canadi 已提交
3708 3709 3710 3711 3712 3713
                           cfd->user_comparator(), iter, snapshot);
      iterators->push_back(iter);
    }
  }

  return Status::OK();
3714 3715
}

3716 3717 3718 3719 3720 3721 3722 3723 3724
bool DBImpl::IsSnapshotSupported() const {
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (!cfd->mem()->IsSnapshotSupported()) {
      return false;
    }
  }
  return true;
}

J
jorlow@chromium.org 已提交
3725
const Snapshot* DBImpl::GetSnapshot() {
3726
  MutexLock l(&mutex_);
3727 3728
  // returns null if the underlying memtable does not support snapshot.
  if (!IsSnapshotSupported()) return nullptr;
3729
  return snapshots_.New(versions_->LastSequence());
J
jorlow@chromium.org 已提交
3730 3731 3732 3733
}

void DBImpl::ReleaseSnapshot(const Snapshot* s) {
  MutexLock l(&mutex_);
3734
  snapshots_.Delete(reinterpret_cast<const SnapshotImpl*>(s));
J
jorlow@chromium.org 已提交
3735 3736 3737
}

// Convenience methods
3738 3739
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
3740
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
3741 3742
}

3743 3744 3745 3746
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  if (!cfh->cfd()->options()->merge_operator) {
3747 3748
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
3749
    return DB::Merge(o, column_family, key, val);
3750 3751 3752
  }
}

3753
Status DBImpl::Delete(const WriteOptions& options,
3754
                      ColumnFamilyHandle* column_family, const Slice& key) {
3755
  return DB::Delete(options, column_family, key);
J
jorlow@chromium.org 已提交
3756 3757
}

3758
Status DBImpl::Write(const WriteOptions& options, WriteBatch* my_batch) {
L
Lei Jin 已提交
3759
  PERF_TIMER_AUTO(write_pre_and_post_process_time);
3760 3761 3762
  Writer w(&mutex_);
  w.batch = my_batch;
  w.sync = options.sync;
H
heyongqiang 已提交
3763
  w.disableWAL = options.disableWAL;
3764 3765 3766 3767 3768 3769 3770 3771 3772 3773
  w.in_batch_group = false;
  w.done = false;
  w.timeout_hint_us = options.timeout_hint_us;

  uint64_t expiration_time = 0;
  if (w.timeout_hint_us == 0) {
    w.timeout_hint_us = kNoTimeOut;
  } else {
    expiration_time = env_->NowMicros() + w.timeout_hint_us;
  }
3774
  w.done = false;
3775

I
Igor Canadi 已提交
3776
  mutex_.Lock();
3777 3778 3779 3780 3781
  // the following code block pushes the current writer "w" into the writer
  // queue "writers_" and wait until one of the following conditions met:
  // 1. the job of "w" has been done by some other writers.
  // 2. "w" becomes the first writer in "writers_"
  // 3. "w" timed-out.
3782
  writers_.push_back(&w);
3783 3784

  bool timed_out = false;
3785
  while (!w.done && &w != writers_.front()) {
3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798
    if (expiration_time == 0) {
      w.cv.Wait();
    } else if (w.cv.TimedWait(expiration_time)) {
      if (w.in_batch_group) {
        // then it means the front writer is currently doing the
        // write on behalf of this "timed-out" writer.  Then it
        // should wait until the write completes.
        expiration_time = 0;
      } else {
        timed_out = true;
        break;
      }
    }
3799
  }
3800 3801

  if (!options.disableWAL) {
L
Lei Jin 已提交
3802
    RecordTick(stats_, WRITE_WITH_WAL);
3803 3804
    default_cf_internal_stats_->AddDBStats(
        InternalStats::WRITE_WITH_WAL, 1);
3805 3806
  }

3807
  if (w.done) {
3808 3809
    default_cf_internal_stats_->AddDBStats(
        InternalStats::WRITE_DONE_BY_OTHER, 1);
I
Igor Canadi 已提交
3810
    mutex_.Unlock();
L
Lei Jin 已提交
3811
    RecordTick(stats_, WRITE_DONE_BY_OTHER);
3812
    return w.status;
3813
  } else if (timed_out) {
3814
#ifndef NDEBUG
3815
    bool found = false;
3816
#endif
3817 3818 3819
    for (auto iter = writers_.begin(); iter != writers_.end(); iter++) {
      if (*iter == &w) {
        writers_.erase(iter);
3820
#ifndef NDEBUG
3821
        found = true;
3822
#endif
3823 3824 3825
        break;
      }
    }
3826
#ifndef NDEBUG
3827
    assert(found);
3828
#endif
3829 3830 3831 3832 3833 3834 3835
    // writers_.front() might still be in cond_wait without a time-out.
    // As a result, we need to signal it to wake it up.  Otherwise no
    // one else will wake him up, and RocksDB will hang.
    if (!writers_.empty()) {
      writers_.front()->cv.Signal();
    }
    mutex_.Unlock();
L
Lei Jin 已提交
3836
    RecordTick(stats_, WRITE_TIMEDOUT);
3837
    return Status::TimedOut();
3838
  } else {
L
Lei Jin 已提交
3839
    RecordTick(stats_, WRITE_DONE_BY_SELF);
3840 3841
    default_cf_internal_stats_->AddDBStats(
        InternalStats::WRITE_DONE_BY_SELF, 1);
3842 3843
  }

3844 3845 3846 3847
  // Once reaches this point, the current writer "w" will try to do its write
  // job.  It may also pick up some of the remaining writers in the "writers_"
  // when it finds suitable, and finish them in the same write batch.
  // This is how a write job could be done by the other writer.
3848 3849 3850
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

I
Igor Canadi 已提交
3851
  uint64_t flush_column_family_if_log_file = 0;
I
Igor Canadi 已提交
3852
  uint64_t max_total_wal_size = (options_.max_total_wal_size == 0)
3853
                                    ? 4 * max_total_in_memory_state_
I
Igor Canadi 已提交
3854
                                    : options_.max_total_wal_size;
3855
  if (UNLIKELY(!single_column_family_mode_) &&
3856
      alive_log_files_.begin()->getting_flushed == false &&
I
Igor Canadi 已提交
3857 3858 3859 3860
      total_log_size_ > max_total_wal_size) {
    flush_column_family_if_log_file = alive_log_files_.begin()->number;
    alive_log_files_.begin()->getting_flushed = true;
    Log(options_.info_log,
3861 3862 3863
        "Flushing all column families with data in WAL number %" PRIu64
        ". Total log size is %" PRIu64 " while max_total_wal_size is %" PRIu64,
        flush_column_family_if_log_file, total_log_size_, max_total_wal_size);
I
Igor Canadi 已提交
3864 3865
  }

3866
  Status status;
3867 3868
  autovector<SuperVersion*> superversions_to_free;
  autovector<log::Writer*> logs_to_free;
3869 3870 3871

  if (LIKELY(single_column_family_mode_)) {
    // fast path
3872 3873 3874 3875
    status = MakeRoomForWrite(
        default_cf_handle_->cfd(), my_batch == nullptr,
        &superversions_to_free, &logs_to_free,
        expiration_time);
3876 3877 3878 3879 3880 3881 3882 3883 3884 3885
  } else {
    // refcounting cfd in iteration
    bool dead_cfd = false;
    for (auto cfd : *versions_->GetColumnFamilySet()) {
      cfd->Ref();
      bool force_flush =
          my_batch == nullptr ||
          (flush_column_family_if_log_file != 0 &&
           cfd->GetLogNumber() <= flush_column_family_if_log_file);
      // May temporarily unlock and wait.
3886 3887 3888
      status = MakeRoomForWrite(
          cfd, force_flush, &superversions_to_free, &logs_to_free,
          expiration_time);
3889 3890 3891 3892 3893 3894
      if (cfd->Unref()) {
        dead_cfd = true;
      }
      if (!status.ok()) {
        break;
      }
3895
    }
3896 3897
    if (dead_cfd) {
      versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
3898 3899
    }
  }
3900

D
dgrogan@chromium.org 已提交
3901
  uint64_t last_sequence = versions_->LastSequence();
3902
  Writer* last_writer = &w;
3903
  if (status.ok() && my_batch != nullptr) {  // nullptr batch is for compactions
3904 3905
    autovector<WriteBatch*> write_batch_group;
    BuildBatchGroup(&last_writer, &write_batch_group);
3906

3907 3908 3909
    // Add to log and apply to memtable.  We can release the lock
    // during this phase since &w is currently responsible for logging
    // and protects against concurrent loggers and concurrent writes
3910
    // into memtables
3911
    {
3912
      mutex_.Unlock();
3913 3914 3915 3916 3917 3918 3919 3920 3921 3922
      WriteBatch* updates = nullptr;
      if (write_batch_group.size() == 1) {
        updates = write_batch_group[0];
      } else {
        updates = &tmp_batch_;
        for (size_t i = 0; i < write_batch_group.size(); ++i) {
          WriteBatchInternal::Append(updates, write_batch_group[i]);
        }
      }

3923 3924 3925 3926
      const SequenceNumber current_sequence = last_sequence + 1;
      WriteBatchInternal::SetSequence(updates, current_sequence);
      int my_batch_count = WriteBatchInternal::Count(updates);
      last_sequence += my_batch_count;
3927
      const uint64_t batch_size = WriteBatchInternal::ByteSize(updates);
3928
      // Record statistics
L
Lei Jin 已提交
3929 3930
      RecordTick(stats_, NUMBER_KEYS_WRITTEN, my_batch_count);
      RecordTick(stats_, BYTES_WRITTEN, WriteBatchInternal::ByteSize(updates));
3931 3932
      if (options.disableWAL) {
        flush_on_destroy_ = true;
3933
      }
L
Lei Jin 已提交
3934
      PERF_TIMER_STOP(write_pre_and_post_process_time);
3935

3936
      uint64_t log_size = 0;
3937
      if (!options.disableWAL) {
L
Lei Jin 已提交
3938
        PERF_TIMER_START(write_wal_time);
3939 3940
        Slice log_entry = WriteBatchInternal::Contents(updates);
        status = log_->AddRecord(log_entry);
I
Igor Canadi 已提交
3941 3942
        total_log_size_ += log_entry.size();
        alive_log_files_.back().AddSize(log_entry.size());
3943
        log_empty_ = false;
3944
        log_size = log_entry.size();
L
Lei Jin 已提交
3945 3946
        RecordTick(stats_, WAL_FILE_SYNCED);
        RecordTick(stats_, WAL_FILE_BYTES, log_size);
H
heyongqiang 已提交
3947
        if (status.ok() && options.sync) {
3948
          if (options_.use_fsync) {
L
Lei Jin 已提交
3949
            StopWatch(env_, stats_, WAL_FILE_SYNC_MICROS);
3950
            status = log_->file()->Fsync();
3951
          } else {
L
Lei Jin 已提交
3952
            StopWatch(env_, stats_, WAL_FILE_SYNC_MICROS);
3953
            status = log_->file()->Sync();
3954
          }
H
heyongqiang 已提交
3955
        }
L
Lei Jin 已提交
3956
        PERF_TIMER_STOP(write_wal_time);
3957 3958
      }
      if (status.ok()) {
L
Lei Jin 已提交
3959
        PERF_TIMER_START(write_memtable_time);
Y
Yueh-Hsuan Chiang 已提交
3960

3961
        status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
3962
            updates, column_family_memtables_.get(), false, 0, this, false);
Y
Yueh-Hsuan Chiang 已提交
3963 3964 3965 3966 3967 3968 3969 3970
        // A non-OK status here indicates iteration failure (either in-memory
        // writebatch corruption (very bad), or the client specified invalid
        // column family).  This will later on trigger bg_error_.
        //
        // Note that existing logic was not sound. Any partial failure writing
        // into the memtable would result in a state that some write ops might
        // have succeeded in memtable but Status reports error for all writes.

L
Lei Jin 已提交
3971
        PERF_TIMER_STOP(write_memtable_time);
3972

L
Lei Jin 已提交
3973
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
3974
      }
L
Lei Jin 已提交
3975
      PERF_TIMER_START(write_pre_and_post_process_time);
3976 3977 3978
      if (updates == &tmp_batch_) {
        tmp_batch_.Clear();
      }
3979
      mutex_.Lock();
3980 3981 3982 3983 3984 3985 3986 3987 3988
      // internal stats
      default_cf_internal_stats_->AddDBStats(
          InternalStats::BYTES_WRITTEN, batch_size);
      if (!options.disableWAL) {
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_SYNCED, 1);
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_BYTES, log_size);
      }
3989
      if (status.ok()) {
3990
        versions_->SetLastSequence(last_sequence);
3991
      }
J
jorlow@chromium.org 已提交
3992 3993
    }
  }
3994 3995
  if (options_.paranoid_checks && !status.ok() &&
      !status.IsTimedOut() && bg_error_.ok()) {
I
Igor Canadi 已提交
3996 3997
    bg_error_ = status; // stop compaction & fail any further writes
  }
3998

3999 4000 4001
  // Pop out the current writer and all writers being pushed before the
  // current writer from the writer queue.
  while (!writers_.empty()) {
4002 4003 4004 4005 4006 4007
    Writer* ready = writers_.front();
    writers_.pop_front();
    if (ready != &w) {
      ready->status = status;
      ready->done = true;
      ready->cv.Signal();
4008
    }
4009 4010
    if (ready == last_writer) break;
  }
4011

4012 4013 4014
  // Notify new head of write queue
  if (!writers_.empty()) {
    writers_.front()->cv.Signal();
4015
  }
I
Igor Canadi 已提交
4016
  mutex_.Unlock();
4017

4018
  if (status.IsTimedOut()) {
L
Lei Jin 已提交
4019
    RecordTick(stats_, WRITE_TIMEDOUT);
4020 4021
  }

4022 4023 4024 4025 4026 4027 4028
  for (auto& sv : superversions_to_free) {
    delete sv;
  }
  for (auto& log : logs_to_free) {
    delete log;
  }

L
Lei Jin 已提交
4029
  PERF_TIMER_STOP(write_pre_and_post_process_time);
J
jorlow@chromium.org 已提交
4030 4031 4032
  return status;
}

4033 4034 4035
// This function will be called only when the first writer succeeds.
// All writers in the to-be-built batch group will be processed.
//
4036
// REQUIRES: Writer list must be non-empty
4037
// REQUIRES: First writer must have a non-nullptr batch
4038 4039
void DBImpl::BuildBatchGroup(Writer** last_writer,
                             autovector<WriteBatch*>* write_batch_group) {
4040 4041
  assert(!writers_.empty());
  Writer* first = writers_.front();
4042
  assert(first->batch != nullptr);
4043 4044

  size_t size = WriteBatchInternal::ByteSize(first->batch);
4045
  write_batch_group->push_back(first->batch);
4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064

  // Allow the group to grow up to a maximum size, but if the
  // original write is small, limit the growth so we do not slow
  // down the small write too much.
  size_t max_size = 1 << 20;
  if (size <= (128<<10)) {
    max_size = size + (128<<10);
  }

  *last_writer = first;
  std::deque<Writer*>::iterator iter = writers_.begin();
  ++iter;  // Advance past "first"
  for (; iter != writers_.end(); ++iter) {
    Writer* w = *iter;
    if (w->sync && !first->sync) {
      // Do not include a sync write into a batch handled by a non-sync write.
      break;
    }

H
heyongqiang 已提交
4065 4066 4067 4068 4069 4070
    if (!w->disableWAL && first->disableWAL) {
      // Do not include a write that needs WAL into a batch that has
      // WAL disabled.
      break;
    }

4071 4072 4073 4074 4075 4076
    if (w->timeout_hint_us < first->timeout_hint_us) {
      // Do not include those writes with shorter timeout.  Otherwise, we might
      // execute a write that should instead be aborted because of timeout.
      break;
    }

4077
    if (w->batch != nullptr) {
4078 4079 4080 4081 4082 4083
      size += WriteBatchInternal::ByteSize(w->batch);
      if (size > max_size) {
        // Do not make batch too big
        break;
      }

4084
      write_batch_group->push_back(w->batch);
4085
    }
4086
    w->in_batch_group = true;
4087 4088 4089 4090
    *last_writer = w;
  }
}

4091 4092 4093
// This function computes the amount of time in microseconds by which a write
// should be delayed based on the number of level-0 files according to the
// following formula:
J
Jim Paton 已提交
4094 4095 4096 4097
// if n < bottom, return 0;
// if n >= top, return 1000;
// otherwise, let r = (n - bottom) /
//                    (top - bottom)
4098 4099 4100 4101
//  and return r^2 * 1000.
// The goal of this formula is to gradually increase the rate at which writes
// are slowed. We also tried linear delay (r * 1000), but it seemed to do
// slightly worse. There is no other particular reason for choosing quadratic.
M
Mark Callaghan 已提交
4102
uint64_t DBImpl::SlowdownAmount(int n, double bottom, double top) {
4103
  uint64_t delay;
J
Jim Paton 已提交
4104
  if (n >= top) {
4105 4106
    delay = 1000;
  }
J
Jim Paton 已提交
4107
  else if (n < bottom) {
4108 4109 4110 4111
    delay = 0;
  }
  else {
    // If we are here, we know that:
J
Jim Paton 已提交
4112
    //   level0_start_slowdown <= n < level0_slowdown
4113
    // since the previous two conditions are false.
M
Mark Callaghan 已提交
4114 4115
    double how_much =
      (double) (n - bottom) /
J
Jim Paton 已提交
4116
              (top - bottom);
M
Mark Callaghan 已提交
4117
    delay = std::max(how_much * how_much * 1000, 100.0);
4118 4119 4120 4121 4122
  }
  assert(delay <= 1000);
  return delay;
}

4123
// REQUIRES: mutex_ is held
4124
// REQUIRES: this thread is currently at the front of the writer queue
4125 4126 4127
Status DBImpl::MakeRoomForWrite(
    ColumnFamilyData* cfd, bool force,
    autovector<SuperVersion*>* superversions_to_free,
4128 4129
    autovector<log::Writer*>* logs_to_free,
    uint64_t expiration_time) {
4130
  mutex_.AssertHeld();
4131
  assert(!writers_.empty());
4132
  bool allow_delay = !force;
J
Jim Paton 已提交
4133 4134
  bool allow_hard_rate_limit_delay = !force;
  bool allow_soft_rate_limit_delay = !force;
4135
  uint64_t rate_limit_delay_millis = 0;
4136
  Status s;
4137
  double score;
4138 4139 4140 4141
  // Once we schedule background work, we shouldn't schedule it again, since it
  // might generate a tight feedback loop, constantly scheduling more background
  // work, even if additional background work is not needed
  bool schedule_background_work = true;
4142
  bool has_timeout = (expiration_time > 0);
4143

4144 4145 4146 4147 4148
  while (true) {
    if (!bg_error_.ok()) {
      // Yield previous error
      s = bg_error_;
      break;
4149 4150 4151
    } else if (has_timeout && env_->NowMicros() > expiration_time) {
      s = Status::TimedOut();
      break;
4152
    } else if (allow_delay && cfd->NeedSlowdownForNumLevel0Files()) {
4153 4154 4155
      // We are getting close to hitting a hard limit on the number of
      // L0 files.  Rather than delaying a single write by several
      // seconds when we hit the hard limit, start delaying each
4156
      // individual write by 0-1ms to reduce latency variance.  Also,
4157 4158
      // this delay hands over some CPU to the compaction thread in
      // case it is sharing the same core as the writer.
4159
      uint64_t slowdown =
4160 4161 4162
          SlowdownAmount(cfd->current()->NumLevelFiles(0),
                         cfd->options()->level0_slowdown_writes_trigger,
                         cfd->options()->level0_stop_writes_trigger);
4163
      mutex_.Unlock();
4164
      uint64_t delayed;
J
Jim Paton 已提交
4165
      {
L
Lei Jin 已提交
4166
        StopWatch sw(env_, stats_, STALL_L0_SLOWDOWN_COUNT, &delayed);
4167
        env_->SleepForMicroseconds(slowdown);
J
Jim Paton 已提交
4168
      }
L
Lei Jin 已提交
4169
      RecordTick(stats_, STALL_L0_SLOWDOWN_MICROS, delayed);
4170 4171
      allow_delay = false;  // Do not delay a single write more than once
      mutex_.Lock();
4172 4173
      cfd->internal_stats()->AddCFStats(
          InternalStats::LEVEL0_SLOWDOWN, delayed);
4174
      delayed_writes_++;
4175
    } else if (!force && !cfd->mem()->ShouldFlush()) {
4176
      // There is room in current memtable
4177 4178 4179
      if (allow_delay) {
        DelayLoggingAndReset();
      }
4180
      break;
4181
    } else if (cfd->NeedWaitForNumMemtables()) {
4182
      // We have filled up the current memtable, but the previous
4183
      // ones are still being flushed, so we wait.
4184
      DelayLoggingAndReset();
I
Igor Canadi 已提交
4185 4186
      Log(options_.info_log, "[%s] wait for memtable flush...\n",
          cfd->GetName().c_str());
4187 4188 4189 4190
      if (schedule_background_work) {
        MaybeScheduleFlushOrCompaction();
        schedule_background_work = false;
      }
4191
      uint64_t stall;
J
Jim Paton 已提交
4192
      {
L
Lei Jin 已提交
4193
        StopWatch sw(env_, stats_, STALL_MEMTABLE_COMPACTION_COUNT, &stall);
4194 4195 4196 4197 4198
        if (!has_timeout) {
          bg_cv_.Wait();
        } else {
          bg_cv_.TimedWait(expiration_time);
        }
J
Jim Paton 已提交
4199
      }
L
Lei Jin 已提交
4200
      RecordTick(stats_, STALL_MEMTABLE_COMPACTION_MICROS, stall);
4201
      cfd->internal_stats()->AddCFStats(
4202
          InternalStats::MEMTABLE_COMPACTION, stall);
4203
    } else if (cfd->NeedWaitForNumLevel0Files()) {
4204
      DelayLoggingAndReset();
I
Igor Canadi 已提交
4205 4206
      Log(options_.info_log, "[%s] wait for fewer level0 files...\n",
          cfd->GetName().c_str());
4207
      uint64_t stall;
J
Jim Paton 已提交
4208
      {
L
Lei Jin 已提交
4209
        StopWatch sw(env_, stats_, STALL_L0_NUM_FILES_COUNT, &stall);
4210 4211 4212 4213 4214
        if (!has_timeout) {
          bg_cv_.Wait();
        } else {
          bg_cv_.TimedWait(expiration_time);
        }
J
Jim Paton 已提交
4215
      }
L
Lei Jin 已提交
4216
      RecordTick(stats_, STALL_L0_NUM_FILES_MICROS, stall);
4217 4218
      cfd->internal_stats()->AddCFStats(
          InternalStats::LEVEL0_NUM_FILES, stall);
4219
    } else if (allow_hard_rate_limit_delay && cfd->ExceedsHardRateLimit()) {
4220
      // Delay a write when the compaction score for any level is too large.
4221
      const int max_level = cfd->current()->MaxCompactionScoreLevel();
4222
      score = cfd->current()->MaxCompactionScore();
4223
      mutex_.Unlock();
4224
      uint64_t delayed;
J
Jim Paton 已提交
4225
      {
L
Lei Jin 已提交
4226
        StopWatch sw(env_, stats_, HARD_RATE_LIMIT_DELAY_COUNT, &delayed);
J
Jim Paton 已提交
4227 4228
        env_->SleepForMicroseconds(1000);
      }
4229
      // Make sure the following value doesn't round to zero.
4230 4231
      uint64_t rate_limit = std::max((delayed / 1000), (uint64_t) 1);
      rate_limit_delay_millis += rate_limit;
L
Lei Jin 已提交
4232
      RecordTick(stats_, RATE_LIMIT_DELAY_MILLIS, rate_limit);
4233
      if (cfd->options()->rate_limit_delay_max_milliseconds > 0 &&
J
Jim Paton 已提交
4234
          rate_limit_delay_millis >=
4235
              (unsigned)cfd->options()->rate_limit_delay_max_milliseconds) {
J
Jim Paton 已提交
4236
        allow_hard_rate_limit_delay = false;
4237
      }
4238
      mutex_.Lock();
4239
      cfd->internal_stats()->RecordLevelNSlowdown(max_level, delayed, false);
4240
    } else if (allow_soft_rate_limit_delay && cfd->ExceedsSoftRateLimit()) {
4241
      const int max_level = cfd->current()->MaxCompactionScoreLevel();
4242
      score = cfd->current()->MaxCompactionScore();
J
Jim Paton 已提交
4243 4244
      // Delay a write when the compaction score for any level is too large.
      // TODO: add statistics
4245 4246
      uint64_t slowdown = SlowdownAmount(score, cfd->options()->soft_rate_limit,
                                         cfd->options()->hard_rate_limit);
L
Lei Jin 已提交
4247
      uint64_t elapsed = 0;
J
Jim Paton 已提交
4248
      mutex_.Unlock();
J
Jim Paton 已提交
4249
      {
L
Lei Jin 已提交
4250
        StopWatch sw(env_, stats_, SOFT_RATE_LIMIT_DELAY_COUNT, &elapsed);
4251 4252
        env_->SleepForMicroseconds(slowdown);
        rate_limit_delay_millis += slowdown;
J
Jim Paton 已提交
4253
      }
J
Jim Paton 已提交
4254 4255
      allow_soft_rate_limit_delay = false;
      mutex_.Lock();
L
Lei Jin 已提交
4256
      cfd->internal_stats()->RecordLevelNSlowdown(max_level, elapsed, true);
4257
    } else {
4258
      unique_ptr<WritableFile> lfile;
S
sdong 已提交
4259
      log::Writer* new_log = nullptr;
K
kailiu 已提交
4260
      MemTable* new_mem = nullptr;
4261

4262
      // Attempt to switch to a new memtable and trigger flush of old.
4263
      // Do this without holding the dbmutex lock.
4264
      assert(versions_->PrevLogNumber() == 0);
I
Igor Canadi 已提交
4265 4266 4267
      bool creating_new_log = !log_empty_;
      uint64_t new_log_number =
          creating_new_log ? versions_->NewFileNumber() : logfile_number_;
I
Igor Canadi 已提交
4268
      SuperVersion* new_superversion = nullptr;
4269 4270 4271
      mutex_.Unlock();
      {
        DelayLoggingAndReset();
I
Igor Canadi 已提交
4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284
        if (creating_new_log) {
          s = env_->NewWritableFile(
              LogFileName(options_.wal_dir, new_log_number), &lfile,
              env_->OptimizeForLogWrite(storage_options_));
          if (s.ok()) {
            // Our final size should be less than write_buffer_size
            // (compression, etc) but err on the side of caution.
            lfile->SetPreallocationBlockSize(1.1 *
                                             cfd->options()->write_buffer_size);
            new_log = new log::Writer(std::move(lfile));
          }
        }

4285
        if (s.ok()) {
4286
          new_mem = new MemTable(cfd->internal_comparator(), *cfd->options());
4287
          new_superversion = new SuperVersion();
4288 4289 4290
        }
      }
      mutex_.Lock();
4291
      if (!s.ok()) {
I
Igor Canadi 已提交
4292 4293
        // how do we fail if we're not creating new log?
        assert(creating_new_log);
H
heyongqiang 已提交
4294
        // Avoid chewing through file number space in a tight loop.
4295
        versions_->ReuseLogFileNumber(new_log_number);
4296
        assert(!new_mem);
4297
        assert(!new_log);
4298 4299
        break;
      }
I
Igor Canadi 已提交
4300 4301 4302
      if (creating_new_log) {
        logfile_number_ = new_log_number;
        assert(new_log != nullptr);
4303
        logs_to_free->push_back(log_.release());
I
Igor Canadi 已提交
4304 4305
        log_.reset(new_log);
        log_empty_ = true;
I
Igor Canadi 已提交
4306
        alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
I
Igor Canadi 已提交
4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317
        for (auto cfd : *versions_->GetColumnFamilySet()) {
          // all this is just optimization to delete logs that
          // are no longer needed -- if CF is empty, that means it
          // doesn't need that particular log to stay alive, so we just
          // advance the log number. no need to persist this in the manifest
          if (cfd->mem()->GetFirstSequenceNumber() == 0 &&
              cfd->imm()->size() == 0) {
            cfd->SetLogNumber(logfile_number_);
          }
        }
      }
4318 4319
      cfd->mem()->SetNextLogNumber(logfile_number_);
      cfd->imm()->Add(cfd->mem());
4320
      if (force) {
4321
        cfd->imm()->FlushRequested();
4322
      }
4323 4324
      new_mem->Ref();
      cfd->SetMemtable(new_mem);
4325 4326 4327
      Log(options_.info_log,
          "[%s] New memtable created with log file: #%" PRIu64 "\n",
          cfd->GetName().c_str(), logfile_number_);
4328
      force = false;  // Do not force another compaction if have room
4329
      MaybeScheduleFlushOrCompaction();
4330 4331
      superversions_to_free->push_back(
          cfd->InstallSuperVersion(new_superversion, &mutex_));
4332 4333 4334 4335 4336
    }
  }
  return s;
}

I
Igor Canadi 已提交
4337
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4338 4339 4340 4341 4342
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4343 4344
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4345
  auto version = cfd->current();
4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

  // Decrement the ref count
  mutex_.Lock();
  version->Unref();
  mutex_.Unlock();

  return s;
}
I
Igor Canadi 已提交
4358
#endif  // ROCKSDB_LITE
4359

I
Igor Canadi 已提交
4360 4361 4362 4363
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4364 4365 4366 4367
Env* DBImpl::GetEnv() const {
  return env_;
}

4368 4369
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4370
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4371 4372
}

4373
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4374
                         const Slice& property, std::string* value) {
4375
  value->clear();
4376 4377
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4378
  DBPropertyType property_type = GetPropertyType(property);
J
jorlow@chromium.org 已提交
4379
  MutexLock l(&mutex_);
4380
  return cfd->internal_stats()->GetProperty(property_type, property, value);
J
jorlow@chromium.org 已提交
4381 4382
}

4383 4384 4385 4386 4387 4388 4389 4390 4391
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  DBPropertyType property_type = GetPropertyType(property);
  MutexLock l(&mutex_);
  return cfd->internal_stats()->GetIntProperty(property_type, property, value);
}

4392
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4393
                                 const Range* range, int n, uint64_t* sizes) {
J
jorlow@chromium.org 已提交
4394 4395
  // TODO(opt): better implementation
  Version* v;
4396 4397
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
J
jorlow@chromium.org 已提交
4398 4399
  {
    MutexLock l(&mutex_);
4400
    v = cfd->current();
4401
    v->Ref();
J
jorlow@chromium.org 已提交
4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418
  }

  for (int i = 0; i < n; i++) {
    // Convert user_key into a corresponding internal key.
    InternalKey k1(range[i].start, kMaxSequenceNumber, kValueTypeForSeek);
    InternalKey k2(range[i].limit, kMaxSequenceNumber, kValueTypeForSeek);
    uint64_t start = versions_->ApproximateOffsetOf(v, k1);
    uint64_t limit = versions_->ApproximateOffsetOf(v, k2);
    sizes[i] = (limit >= start ? limit - start : 0);
  }

  {
    MutexLock l(&mutex_);
    v->Unref();
  }
}

4419 4420 4421 4422 4423 4424 4425
inline void DBImpl::DelayLoggingAndReset() {
  if (delayed_writes_ > 0) {
    Log(options_.info_log, "delayed %d write...\n", delayed_writes_ );
    delayed_writes_ = 0;
  }
}

I
Igor Canadi 已提交
4426 4427 4428 4429 4430
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
4431
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
  //  Get all sorted Wal Files.
  //  Do binary search and open files and find the seq number.

  std::unique_ptr<VectorLogPtr> wal_files(new VectorLogPtr);
  Status s = GetSortedWalFiles(*wal_files);
  if (!s.ok()) {
    return s;
  }

  s = RetainProbableWalFiles(*wal_files, seq);
  if (!s.ok()) {
    return s;
  }
  iter->reset(new TransactionLogIteratorImpl(options_.wal_dir, &options_,
                                             read_options, storage_options_,
                                             seq, std::move(wal_files), this));
  return (*iter)->status();
}

4454 4455 4456
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4457 4458 4459 4460
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
    Log(options_.info_log, "DeleteFile %s failed.\n", name.c_str());
4461 4462 4463
    return Status::InvalidArgument("Invalid file name");
  }

4464 4465 4466 4467
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4468 4469
      Log(options_.info_log, "DeleteFile %s failed - not archived log.\n",
          name.c_str());
4470 4471 4472 4473
      return Status::NotSupported("Delete only supported for archived logs");
    }
    status = env_->DeleteFile(options_.wal_dir + "/" + name.c_str());
    if (!status.ok()) {
4474 4475
      Log(options_.info_log, "DeleteFile %s failed -- %s.\n",
          name.c_str(), status.ToString().c_str());
4476 4477 4478 4479
    }
    return status;
  }

4480
  int level;
I
Igor Canadi 已提交
4481
  FileMetaData* metadata;
4482
  ColumnFamilyData* cfd;
4483
  VersionEdit edit;
K
Kai Liu 已提交
4484
  DeletionState deletion_state(true);
D
Dhruba Borthakur 已提交
4485 4486
  {
    MutexLock l(&mutex_);
4487
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
4488
    if (!status.ok()) {
4489 4490
      Log(options_.info_log, "DeleteFile %s failed. File not found\n",
                             name.c_str());
D
Dhruba Borthakur 已提交
4491 4492
      return Status::InvalidArgument("File not found");
    }
I
Igor Canadi 已提交
4493
    assert((level > 0) && (level < cfd->NumberLevels()));
4494

D
Dhruba Borthakur 已提交
4495
    // If the file is being compacted no need to delete.
4496
    if (metadata->being_compacted) {
4497
      Log(options_.info_log,
4498
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
D
Dhruba Borthakur 已提交
4499
      return Status::OK();
4500 4501
    }

D
Dhruba Borthakur 已提交
4502 4503 4504
    // Only the files in the last level can be deleted externally.
    // This is to make sure that any deletion tombstones are not
    // lost. Check that the level passed is the last level.
I
Igor Canadi 已提交
4505
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
4506
      if (cfd->current()->NumLevelFiles(i) != 0) {
D
Dhruba Borthakur 已提交
4507
        Log(options_.info_log,
4508
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
D
Dhruba Borthakur 已提交
4509 4510 4511 4512
        return Status::InvalidArgument("File not in last level");
      }
    }
    edit.DeleteFile(level, number);
4513
    status = versions_->LogAndApply(cfd, &edit, &mutex_, db_directory_.get());
I
Igor Canadi 已提交
4514
    if (status.ok()) {
4515
      InstallSuperVersion(cfd, deletion_state);
I
Igor Canadi 已提交
4516
    }
I
Igor Canadi 已提交
4517
    FindObsoleteFiles(deletion_state, false);
D
Dhruba Borthakur 已提交
4518
  } // lock released here
I
Igor Canadi 已提交
4519
  LogFlush(options_.info_log);
I
Igor Canadi 已提交
4520
  // remove files outside the db-lock
4521 4522 4523
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
4524 4525 4526 4527 4528 4529
  {
    MutexLock l(&mutex_);
    // schedule flush if file deletion means we freed the space for flushes to
    // continue
    MaybeScheduleFlushOrCompaction();
  }
4530 4531 4532
  return status;
}

4533
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4534
  MutexLock l(&mutex_);
4535
  versions_->GetLiveFilesMetaData(metadata);
4536
}
I
Igor Canadi 已提交
4537
#endif  // ROCKSDB_LITE
4538

I
Igor Canadi 已提交
4539 4540 4541 4542 4543 4544 4545
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

  std::string corruption_messages;
  for (const auto& md : metadata) {
4546 4547
    std::string file_path = md.db_path + "/" + md.name;

I
Igor Canadi 已提交
4548 4549 4550 4551 4552 4553
    uint64_t fsize = 0;
    Status s = env_->GetFileSize(file_path, &fsize);
    if (!s.ok()) {
      corruption_messages +=
          "Can't access " + md.name + ": " + s.ToString() + "\n";
    } else if (fsize != md.size) {
4554
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566
                             ". Size recorded in manifest " +
                             std::to_string(md.size) + ", actual size " +
                             std::to_string(fsize) + "\n";
    }
  }
  if (corruption_messages.size() == 0) {
    return Status::OK();
  } else {
    return Status::Corruption(corruption_messages);
  }
}

4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593
Status DBImpl::GetDbIdentity(std::string& identity) {
  std::string idfilename = IdentityFileName(dbname_);
  unique_ptr<SequentialFile> idfile;
  const EnvOptions soptions;
  Status s = env_->NewSequentialFile(idfilename, &idfile, soptions);
  if (!s.ok()) {
    return s;
  }
  uint64_t file_size;
  s = env_->GetFileSize(idfilename, &file_size);
  if (!s.ok()) {
    return s;
  }
  char buffer[file_size];
  Slice id;
  s = idfile->Read(file_size, &id, buffer);
  if (!s.ok()) {
    return s;
  }
  identity.assign(id.ToString());
  // If last character is '\n' remove it from identity
  if (identity.size() > 0 && identity.back() == '\n') {
    identity.pop_back();
  }
  return s;
}

J
jorlow@chromium.org 已提交
4594 4595
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
4596
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
4597
               const Slice& key, const Slice& value) {
4598 4599 4600 4601
  // Pre-allocate size of write batch conservatively.
  // 8 bytes are taken by header, 4 bytes for count, 1 byte for type,
  // and we allocate 11 extra bytes for key length, as well as value length.
  WriteBatch batch(key.size() + value.size() + 24);
4602
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
4603 4604 4605
  return Write(opt, &batch);
}

4606 4607
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
4608
  WriteBatch batch;
4609
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
4610 4611 4612
  return Write(opt, &batch);
}

4613 4614
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
4615
  WriteBatch batch;
4616
  batch.Merge(column_family, key, value);
4617 4618 4619
  return Write(opt, &batch);
}

4620 4621
// Default implementation -- returns not supported status
Status DB::CreateColumnFamily(const ColumnFamilyOptions& options,
4622
                              const std::string& column_family_name,
4623
                              ColumnFamilyHandle** handle) {
4624
  return Status::NotSupported("");
4625
}
4626
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
4627
  return Status::NotSupported("");
4628 4629
}

J
jorlow@chromium.org 已提交
4630 4631
DB::~DB() { }

J
Jim Paton 已提交
4632
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
4633 4634 4635 4636
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
4637
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
4638 4639 4640 4641 4642 4643 4644 4645 4646
  std::vector<ColumnFamilyHandle*> handles;
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
  if (s.ok()) {
    assert(handles.size() == 1);
    // i can delete the handle since DBImpl is always holding a reference to
    // default column family
    delete handles[0];
  }
  return s;
4647 4648
}

4649 4650
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
4651
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
4652
  if (db_options.db_paths.size() > 1) {
4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664
    for (auto& cfd : column_families) {
      if (cfd.options.compaction_style != kCompactionStyleUniversal) {
        return Status::NotSupported(
            "More than one DB paths are only supported in "
            "universal compaction style. ");
      }
    }

    if (db_options.db_paths.size() > 4) {
      return Status::NotSupported(
        "More than four DB paths are not supported yet. ");
    }
4665 4666
  }

4667
  *dbptr = nullptr;
4668
  handles->clear();
J
jorlow@chromium.org 已提交
4669

I
Igor Canadi 已提交
4670 4671 4672 4673 4674 4675 4676 4677
  size_t max_write_buffer_size = 0;
  for (auto cf : column_families) {
    max_write_buffer_size =
        std::max(max_write_buffer_size, cf.options.write_buffer_size);
    if (cf.options.block_cache != nullptr && cf.options.no_block_cache) {
      return Status::InvalidArgument(
          "no_block_cache is true while block_cache is not nullptr");
    }
4678
  }
4679

I
Igor Canadi 已提交
4680
  DBImpl* impl = new DBImpl(db_options, dbname);
4681
  Status s = impl->env_->CreateDirIfMissing(impl->options_.wal_dir);
4682
  if (s.ok()) {
4683 4684
    for (auto db_path : impl->options_.db_paths) {
      s = impl->env_->CreateDirIfMissing(db_path.path);
4685 4686 4687 4688 4689 4690
      if (!s.ok()) {
        break;
      }
    }
  }

4691 4692 4693 4694 4695 4696
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
4697 4698 4699 4700
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
4701
  impl->mutex_.Lock();
4702 4703
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
4704
  if (s.ok()) {
4705
    uint64_t new_log_number = impl->versions_->NewFileNumber();
4706
    unique_ptr<WritableFile> lfile;
4707
    EnvOptions soptions(db_options);
4708
    s = impl->options_.env->NewWritableFile(
I
Igor Canadi 已提交
4709
        LogFileName(impl->options_.wal_dir, new_log_number), &lfile,
I
Igor Canadi 已提交
4710
        impl->options_.env->OptimizeForLogWrite(soptions));
J
jorlow@chromium.org 已提交
4711
    if (s.ok()) {
4712
      lfile->SetPreallocationBlockSize(1.1 * max_write_buffer_size);
4713
      impl->logfile_number_ = new_log_number;
4714
      impl->log_.reset(new log::Writer(std::move(lfile)));
I
Igor Canadi 已提交
4715

4716 4717
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
4718 4719
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738
        if (cfd != nullptr) {
          handles->push_back(
              new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
        } else {
          if (db_options.create_missing_column_families) {
            // missing column family, create it
            ColumnFamilyHandle* handle;
            impl->mutex_.Unlock();
            s = impl->CreateColumnFamily(cf.options, cf.name, &handle);
            impl->mutex_.Lock();
            if (s.ok()) {
              handles->push_back(handle);
            } else {
              break;
            }
          } else {
            s = Status::InvalidArgument("Column family not found: ", cf.name);
            break;
          }
I
Igor Canadi 已提交
4739
        }
4740
      }
I
Igor Canadi 已提交
4741 4742
    }
    if (s.ok()) {
4743
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
4744
        delete cfd->InstallSuperVersion(new SuperVersion(), &impl->mutex_);
4745
      }
I
Igor Canadi 已提交
4746 4747
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
4748
      impl->DeleteObsoleteFiles();
4749
      impl->MaybeScheduleFlushOrCompaction();
4750
      s = impl->db_directory_->Fsync();
J
jorlow@chromium.org 已提交
4751 4752
    }
  }
4753

I
Igor Canadi 已提交
4754 4755
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
4756 4757
      if (cfd->options()->compaction_style == kCompactionStyleUniversal ||
          cfd->options()->compaction_style == kCompactionStyleFIFO) {
I
Igor Canadi 已提交
4758 4759 4760 4761
        Version* current = cfd->current();
        for (int i = 1; i < current->NumberLevels(); ++i) {
          int num_files = current->NumLevelFiles(i);
          if (num_files > 0) {
I
Igor Canadi 已提交
4762 4763 4764
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
                "open with universal or FIFO compaction style.");
I
Igor Canadi 已提交
4765 4766 4767 4768
            break;
          }
        }
      }
4769 4770 4771 4772 4773 4774
      if (cfd->options()->merge_operator != nullptr &&
          !cfd->mem()->IsMergeOperatorSupported()) {
        s = Status::InvalidArgument(
            "The memtable of column family %s does not support merge operator "
            "its options.merge_operator is non-null", cfd->GetName().c_str());
      }
I
Igor Canadi 已提交
4775
      if (!s.ok()) {
4776 4777 4778 4779 4780
        break;
      }
    }
  }

4781 4782
  impl->mutex_.Unlock();

J
jorlow@chromium.org 已提交
4783
  if (s.ok()) {
4784
    impl->opened_successfully_ = true;
J
jorlow@chromium.org 已提交
4785 4786
    *dbptr = impl;
  } else {
4787 4788 4789
    for (auto h : *handles) {
      delete h;
    }
4790
    handles->clear();
J
jorlow@chromium.org 已提交
4791 4792 4793 4794 4795
    delete impl;
  }
  return s;
}

4796 4797 4798
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
4799
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
4800 4801
}

4802 4803 4804
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
4805
Status DestroyDB(const std::string& dbname, const Options& options) {
4806 4807 4808 4809 4810
  const InternalKeyComparator comparator(options.comparator);
  const InternalFilterPolicy filter_policy(options.filter_policy);
  const Options& soptions(SanitizeOptions(
    dbname, &comparator, &filter_policy, options));
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
4811
  std::vector<std::string> filenames;
4812 4813
  std::vector<std::string> archiveFiles;

4814
  std::string archivedir = ArchivalDirectory(dbname);
J
jorlow@chromium.org 已提交
4815 4816
  // Ignore error in case directory does not exist
  env->GetChildren(dbname, &filenames);
4817 4818 4819 4820 4821 4822 4823

  if (dbname != soptions.wal_dir) {
    std::vector<std::string> logfilenames;
    env->GetChildren(soptions.wal_dir, &logfilenames);
    filenames.insert(filenames.end(), logfilenames.begin(), logfilenames.end());
    archivedir = ArchivalDirectory(soptions.wal_dir);
  }
4824

J
jorlow@chromium.org 已提交
4825 4826 4827 4828 4829
  if (filenames.empty()) {
    return Status::OK();
  }

  FileLock* lock;
4830 4831
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
4832 4833 4834
  if (result.ok()) {
    uint64_t number;
    FileType type;
D
dgrogan@chromium.org 已提交
4835
    for (size_t i = 0; i < filenames.size(); i++) {
4836
      if (ParseFileName(filenames[i], &number, &type) &&
4837
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
4838 4839 4840
        Status del;
        if (type == kMetaDatabase) {
          del = DestroyDB(dbname + "/" + filenames[i], options);
4841 4842
        } else if (type == kLogFile) {
          del = env->DeleteFile(soptions.wal_dir + "/" + filenames[i]);
K
Kosie van der Merwe 已提交
4843 4844 4845
        } else {
          del = env->DeleteFile(dbname + "/" + filenames[i]);
        }
J
jorlow@chromium.org 已提交
4846 4847 4848 4849 4850
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4851

4852 4853
    for (auto& db_path : options.db_paths) {
      env->GetChildren(db_path.path, &filenames);
4854 4855 4856 4857 4858
      uint64_t number;
      FileType type;
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
4859
          Status del = env->DeleteFile(db_path.path + "/" + filenames[i]);
4860 4861 4862 4863 4864 4865 4866
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

4867
    env->GetChildren(archivedir, &archiveFiles);
4868 4869
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
4870 4871
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
4872
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
4873 4874 4875 4876 4877
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4878
    // ignore case where no archival directory is present.
4879
    env->DeleteDir(archivedir);
4880

J
jorlow@chromium.org 已提交
4881
    env->UnlockFile(lock);  // Ignore error since state is already gone
4882
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
4883
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
4884
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
4885 4886 4887 4888
  }
  return result;
}

4889 4890
//
// A global method that can dump out the build version
K
kailiu 已提交
4891
void DumpLeveldbBuildVersion(Logger * log) {
I
Igor Canadi 已提交
4892 4893
#if !defined(IOS_CROSS_COMPILE)
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't generate util/build_version.cc
4894
  Log(log, "Git sha %s", rocksdb_build_git_sha);
4895
  Log(log, "Compile time %s %s",
4896
      rocksdb_build_compile_time, rocksdb_build_compile_date);
I
Igor Canadi 已提交
4897
#endif
4898 4899
}

4900
}  // namespace rocksdb