db_impl.cc 163.1 KB
Newer Older
1 2 3 4 5
//  Copyright (c) 2013, Facebook, Inc.  All rights reserved.
//  This source code is licensed under the BSD-style license found in the
//  LICENSE file in the root directory of this source tree. An additional grant
//  of patent rights can be found in the PATENTS file in the same directory.
//
J
jorlow@chromium.org 已提交
6 7 8 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"
T
Tyler Harter 已提交
36
#include "db/prefix_filter_iterator.h"
J
jorlow@chromium.org 已提交
37
#include "db/table_cache.h"
K
kailiu 已提交
38
#include "db/table_properties_collector.h"
T
Tomislav Novak 已提交
39
#include "db/tailing_iter.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/stop_watch.h"
69
#include "util/sync_point.h"
J
jorlow@chromium.org 已提交
70

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

73
const std::string default_column_family_name("default");
74

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

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

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

J
jorlow@chromium.org 已提交
89 90 91
struct DBImpl::CompactionState {
  Compaction* const compaction;

92 93 94 95 96
  // 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 已提交
97 98 99 100 101 102

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

  // State kept for output being generated
109 110
  unique_ptr<WritableFile> outfile;
  unique_ptr<TableBuilder> builder;
J
jorlow@chromium.org 已提交
111 112 113 114 115 116 117 118 119

  uint64_t total_bytes;

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

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

121 122 123 124 125 126 127 128
  // 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;
  }

129
  // Create a client visible context of this compaction
D
Danny Guo 已提交
130 131
  CompactionFilterContext GetFilterContext() {
    CompactionFilterContext context;
132
    context.is_full_compaction = compaction->IsFullCompaction();
133
    context.is_manual_compaction = compaction->IsManualCompaction();
134 135
    return context;
  }
D
Danny Guo 已提交
136 137 138 139 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

  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 已提交
253 254
};

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

J
jorlow@chromium.org 已提交
264 265
Options SanitizeOptions(const std::string& dbname,
                        const InternalKeyComparator* icmp,
S
Sanjay Ghemawat 已提交
266
                        const InternalFilterPolicy* ipolicy,
J
jorlow@chromium.org 已提交
267
                        const Options& src) {
268 269 270 271 272 273 274
  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;
275 276
  // result.max_open_files means an "infinite" open files.
  if (result.max_open_files != -1) {
277
    ClipToRange(&result.max_open_files, 20, 1000000);
278
  }
279

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

  if (result.wal_dir.empty()) {
    // Use dbname as default
    result.wal_dir = dbname;
  }
293
  if (result.wal_dir.back() == '/') {
I
Igor Canadi 已提交
294
    result.wal_dir = result.wal_dir.substr(0, result.wal_dir.size() - 1);
295
  }
296

J
jorlow@chromium.org 已提交
297 298 299
  return result;
}

S
Siying Dong 已提交
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
CompressionType GetCompressionType(const Options& options, int level,
                                   const bool enable_compression) {
  if (!enable_compression) {
    // disable compression
    return kNoCompression;
  }
  // If the use has specified a different compression level for each level,
  // then pick the compresison for that level.
  if (!options.compression_per_level.empty()) {
    const int n = options.compression_per_level.size() - 1;
    // It is possible for level_ to be -1; in that case, we use level
    // 0's compression.  This occurs mostly in backwards compatibility
    // situations when the builder doesn't know what level the file
    // belongs to.  Likewise, if level_ is beyond the end of the
    // specified compression levels, use the last value.
    return options.compression_per_level[std::max(0, std::min(level, n))];
  } else {
    return options.compression;
  }
}

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
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;

  if  (options.compaction_style == kCompactionStyleUniversal) {
    can_compress =
        (options.compaction_options_universal.compression_size_percent < 0);
  } else {
    // For leveled compress when min_level_to_compress == 0.
    can_compress = (GetCompressionType(options, 0, true) != kNoCompression);
  }

  if (can_compress) {
    return options.compression;
  } else {
    return kNoCompression;
  }
}

I
Igor Canadi 已提交
343
DBImpl::DBImpl(const DBOptions& options, const std::string& dbname)
J
jorlow@chromium.org 已提交
344
    : env_(options.env),
H
heyongqiang 已提交
345
      dbname_(dbname),
I
Igor Canadi 已提交
346
      options_(SanitizeOptions(dbname, options)),
347
      db_lock_(nullptr),
H
Haobo Xu 已提交
348
      mutex_(options.use_adaptive_mutex),
349
      shutting_down_(nullptr),
J
jorlow@chromium.org 已提交
350
      bg_cv_(&mutex_),
351
      logfile_number_(0),
352
      default_cf_handle_(nullptr),
353
      tmp_batch_(),
354
      bg_schedule_needed_(false),
355
      bg_compaction_scheduled_(0),
356
      bg_manual_only_(0),
357
      bg_flush_scheduled_(0),
358
      bg_logstats_scheduled_(false),
359 360
      manual_compaction_(nullptr),
      logger_(nullptr),
361
      disable_delete_obsolete_files_(0),
I
Igor Canadi 已提交
362
      delete_obsolete_files_last_run_(options.env->NowMicros()),
363
      purge_wal_files_last_run_(0),
364
      last_stats_dump_time_microsec_(0),
365
      default_interval_to_delete_obsolete_WAL_(600),
366
      flush_on_destroy_(false),
367
      delayed_writes_(0),
368 369
      storage_options_(options),
      bg_work_gate_closed_(false),
370 371
      refitting_level_(false),
      opened_successfully_(false) {
H
heyongqiang 已提交
372
  env_->GetAbsolutePath(dbname, &db_absolute_path_);
373

J
jorlow@chromium.org 已提交
374
  // Reserve ten files or so for other uses and give the rest to TableCache.
375 376
  // Give a large number for setting of "infinite" open files.
  const int table_cache_size =
377 378 379 380 381 382
      (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 已提交
383 384
  versions_.reset(
      new VersionSet(dbname_, &options_, storage_options_, table_cache_.get()));
385 386
  column_family_memtables_.reset(
      new ColumnFamilyMemTablesImpl(versions_->GetColumnFamilySet()));
387

K
kailiu 已提交
388
  DumpLeveldbBuildVersion(options_.info_log.get());
389
  options_.Dump(options_.info_log.get());
390

391
  char name[100];
K
kailiu 已提交
392 393
  Status s = env_->GetHostName(name, 100L);
  if (s.ok()) {
394 395 396 397 398 399
    host_name_ = name;
  } else {
    Log(options_.info_log, "Can't get hostname, use localhost as host name.");
    host_name_ = "localhost";
  }
  last_log_ts = 0;
400

I
Igor Canadi 已提交
401
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
402 403 404
}

DBImpl::~DBImpl() {
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
  mutex_.Lock();
  if (flush_on_destroy_) {
    autovector<ColumnFamilyData*> to_delete;
    for (auto cfd : *versions_->GetColumnFamilySet()) {
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
        cfd->Ref();
        mutex_.Unlock();
        FlushMemTable(cfd, FlushOptions());
        mutex_.Lock();
        if (cfd->Unref()) {
          to_delete.push_back(cfd);
        }
      }
    }
    for (auto cfd : to_delete) {
      delete cfd;
421
    }
422
  }
I
Igor Canadi 已提交
423 424

  // Wait for background work to finish
425
  shutting_down_.Release_Store(this);  // Any non-nullptr value is ok
426 427 428
  while (bg_compaction_scheduled_ ||
         bg_flush_scheduled_ ||
         bg_logstats_scheduled_) {
H
hans@chromium.org 已提交
429
    bg_cv_.Wait();
J
jorlow@chromium.org 已提交
430
  }
431

I
Igor Canadi 已提交
432 433 434 435 436
  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();
437 438
  }

439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
  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;
454 455 456
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
457 458 459
    }
  }

460
  // versions need to be destroyed before table_cache since it can hold
461 462
  // references to table_cache.
  versions_.reset();
463
  mutex_.Unlock();
I
Igor Canadi 已提交
464 465 466
  if (db_lock_ != nullptr) {
    env_->UnlockFile(db_lock_);
  }
467

I
Igor Canadi 已提交
468
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
469 470
}

A
Abhishek Kona 已提交
471 472 473
uint64_t DBImpl::TEST_Current_Manifest_FileNo() {
  return versions_->ManifestFileNumber();
}
474

J
jorlow@chromium.org 已提交
475
Status DBImpl::NewDB() {
476
  VersionEdit new_db;
477
  new_db.SetLogNumber(0);
J
jorlow@chromium.org 已提交
478 479 480 481
  new_db.SetNextFile(2);
  new_db.SetLastSequence(0);

  const std::string manifest = DescriptorFileName(dbname_, 1);
482
  unique_ptr<WritableFile> file;
I
Igor Canadi 已提交
483 484
  Status s = env_->NewWritableFile(
      manifest, &file, env_->OptimizeForManifestWrite(storage_options_));
J
jorlow@chromium.org 已提交
485 486 487
  if (!s.ok()) {
    return s;
  }
488
  file->SetPreallocationBlockSize(options_.manifest_preallocation_size);
J
jorlow@chromium.org 已提交
489
  {
490
    log::Writer log(std::move(file));
J
jorlow@chromium.org 已提交
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
    std::string record;
    new_db.EncodeTo(&record);
    s = log.AddRecord(record);
  }
  if (s.ok()) {
    // Make "CURRENT" file that points to the new manifest file.
    s = SetCurrentFile(env_, dbname_, 1);
  } else {
    env_->DeleteFile(manifest);
  }
  return s;
}

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

513
const Status DBImpl::CreateArchivalDirectory() {
514
  if (options_.WAL_ttl_seconds > 0 || options_.WAL_size_limit_MB > 0) {
515
    std::string archivalPath = ArchivalDirectory(options_.wal_dir);
516 517 518 519 520
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

521
void DBImpl::PrintStatistics() {
522
  auto dbstats = options_.statistics.get();
523 524
  if (dbstats) {
    Log(options_.info_log,
525 526
        "STATISTCS:\n %s",
        dbstats->ToString().c_str());
527 528 529
  }
}

530
void DBImpl::MaybeDumpStats() {
H
Haobo Xu 已提交
531 532 533 534 535 536 537 538 539 540 541 542 543
  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;
    std::string stats;
544
    GetProperty("rocksdb.stats", &stats);
H
Haobo Xu 已提交
545
    Log(options_.info_log, "%s", stats.c_str());
546
    PrintStatistics();
547 548 549
  }
}

550
// Returns the list of live files in 'sst_live' and the list
K
kailiu 已提交
551
// of all files in the filesystem in 'candidate_files'.
I
Igor Canadi 已提交
552 553 554 555 556 557 558
// 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 已提交
559 560
  mutex_.AssertHeld();

561
  // if deletion is disabled, do nothing
562
  if (disable_delete_obsolete_files_ > 0) {
563 564 565
    return;
  }

566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
  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 已提交
582 583 584
  // get obsolete files
  versions_->GetObsoleteFiles(&deletion_state.sst_delete_files);

I
Igor Canadi 已提交
585 586
  // store the current filenum, lognum, etc
  deletion_state.manifest_file_number = versions_->ManifestFileNumber();
587 588
  deletion_state.pending_manifest_file_number =
      versions_->PendingManifestFileNumber();
589
  deletion_state.log_number = versions_->MinLogNumber();
I
Igor Canadi 已提交
590 591
  deletion_state.prev_log_number = versions_->PrevLogNumber();

592 593 594 595 596 597 598 599
  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
I
Igor Canadi 已提交
600 601 602 603
  deletion_state.sst_live.assign(pending_outputs_.begin(),
                                 pending_outputs_.end());
  versions_->AddLiveFiles(&deletion_state.sst_live);

604
  if (doing_the_full_scan) {
K
kailiu 已提交
605 606 607 608 609
    // set of all files in the directory. We'll exclude files that are still
    // alive in the subsequent processings.
    env_->GetChildren(
        dbname_, &deletion_state.candidate_files
    ); // Ignore errors
610 611 612 613 614

    //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
K
kailiu 已提交
615 616
      deletion_state.candidate_files.insert(
        deletion_state.candidate_files.end(),
617 618 619
        log_files.begin(),
        log_files.end()
      );
620
    }
621
  }
622 623
}

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

I
Igor Canadi 已提交
632 633 634 635
  // 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 已提交
636 637
    return;
  }
638

639 640
  // Now, convert live list to an unordered set, WITHOUT mutex held;
  // set is slow.
641 642
  std::unordered_set<uint64_t> sst_live(state.sst_live.begin(),
                                        state.sst_live.end());
I
Igor Canadi 已提交
643

K
kailiu 已提交
644 645 646 647 648 649 650
  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 = "";
651
  for (auto file : state.sst_delete_files) {
K
kailiu 已提交
652 653 654
    candidate_files.push_back(
        TableFileName(kDumbDbName, file->number).substr(1)
    );
655
    delete file;
I
Igor Canadi 已提交
656 657
  }

K
kailiu 已提交
658 659
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
660
      candidate_files.push_back(LogFileName(kDumbDbName, file_num).substr(1));
I
Igor Canadi 已提交
661 662
    }
  }
663

K
kailiu 已提交
664
  // dedup state.candidate_files so we don't try to delete the same
I
Igor Canadi 已提交
665
  // file twice
K
kailiu 已提交
666
  sort(candidate_files.begin(), candidate_files.end());
667 668
  candidate_files.erase(unique(candidate_files.begin(), candidate_files.end()),
                        candidate_files.end());
J
jorlow@chromium.org 已提交
669

670 671
  std::vector<std::string> old_info_log_files;

K
kailiu 已提交
672 673 674 675 676 677 678
  for (const auto& to_delete : candidate_files) {
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
    if (!ParseFileName(to_delete, &number, &type)) {
      continue;
    }
J
jorlow@chromium.org 已提交
679

K
kailiu 已提交
680 681 682 683 684 685 686 687
    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'
688
        // (can happen during manifest roll)
K
kailiu 已提交
689 690 691 692 693 694 695
        keep = (number >= state.manifest_file_number);
        break;
      case kTableFile:
        keep = (sst_live.find(number) != sst_live.end());
        break;
      case kTempFile:
        // Any temp files that are currently being written to must
696 697 698 699 700 701
        // 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
        keep = (sst_live.find(number) != sst_live.end()) ||
               (number == state.pending_manifest_file_number);
K
kailiu 已提交
702 703 704 705
        break;
      case kInfoLogFile:
        keep = true;
        if (number != 0) {
706
          old_info_log_files.push_back(to_delete);
J
jorlow@chromium.org 已提交
707
        }
K
kailiu 已提交
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
        break;
      case kCurrentFile:
      case kDBLockFile:
      case kIdentityFile:
      case kMetaDatabase:
        keep = true;
        break;
    }

    if (keep) {
      continue;
    }

    if (type == kTableFile) {
      // evict from cache
723
      TableCache::Evict(table_cache_.get(), number);
K
kailiu 已提交
724
    }
725

K
kailiu 已提交
726 727 728 729
    std::string fname = ((type == kLogFile) ? options_.wal_dir : dbname_) +
        "/" + to_delete;
    if (type == kLogFile &&
        (options_.WAL_ttl_seconds > 0 || options_.WAL_size_limit_MB > 0)) {
730
      auto archived_log_name = ArchivedLogFileName(options_.wal_dir, number);
731 732
      // The sync point below is used in (DBTest,TransactionLogIteratorRace)
      TEST_SYNC_POINT("DBImpl::PurgeObsoleteFiles:1");
733
      Status s = env_->RenameFile(fname, archived_log_name);
734 735
      // The sync point below is used in (DBTest,TransactionLogIteratorRace)
      TEST_SYNC_POINT("DBImpl::PurgeObsoleteFiles:2");
736 737 738
      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 已提交
739 740
    } else {
      Status s = env_->DeleteFile(fname);
741 742 743
      Log(options_.info_log, "Delete %s type=%d #%lu -- %s\n",
          fname.c_str(), type, (unsigned long)number,
          s.ToString().c_str());
J
jorlow@chromium.org 已提交
744 745
    }
  }
H
heyongqiang 已提交
746

747
  // Delete old info log files.
748
  size_t old_info_log_file_count = old_info_log_files.size();
K
Kai Liu 已提交
749 750
  // NOTE: Currently we only support log purge when options_.db_log_dir is
  // located in `dbname` directory.
751
  if (old_info_log_file_count >= options_.keep_log_file_num &&
K
Kai Liu 已提交
752
      options_.db_log_dir.empty()) {
753 754
    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;
755
    for (unsigned int i = 0; i <= end; i++) {
756 757 758 759 760 761 762
      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 已提交
763 764
    }
  }
765
  PurgeObsoleteWALFiles();
I
Igor Canadi 已提交
766
  LogFlush(options_.info_log);
D
Dhruba Borthakur 已提交
767 768 769 770 771
}

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
  DeletionState deletion_state;
I
Igor Canadi 已提交
772
  FindObsoleteFiles(deletion_state, true);
773 774 775
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
776 777
}

778 779 780 781 782 783 784 785
// 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
786
void DBImpl::PurgeObsoleteWALFiles() {
787 788 789 790 791 792
  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;
  }

793 794
  int64_t current_time;
  Status s = env_->GetCurrentTime(&current_time);
795 796 797 798 799 800 801 802
  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_;
803

804 805 806 807 808 809 810 811 812 813 814 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
  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;
          }
          continue;
844
        }
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
      }

      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;
            }
          }
        }
      }
    }
  }

  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;
883
  GetSortedWalsOfType(archival_dir, archived_logs, kArchivedLogFile);
884 885 886 887 888 889 890 891 892 893 894 895 896 897

  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;
898 899
    }
  }
D
Dhruba Borthakur 已提交
900 901
}

902
Status DBImpl::Recover(
903 904
    const std::vector<ColumnFamilyDescriptor>& column_families, bool read_only,
    bool error_if_log_file_exist) {
J
jorlow@chromium.org 已提交
905 906
  mutex_.AssertHeld();

907
  assert(db_lock_ == nullptr);
I
Igor Canadi 已提交
908
  if (!read_only) {
909 910 911 912 913 914 915 916 917 918 919 920
    // 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;
    }

921 922 923 924 925
    s = env_->NewDirectory(dbname_, &db_directory_);
    if (!s.ok()) {
      return s;
    }

926
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
927 928 929
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
930

931 932
    if (!env_->FileExists(CurrentFileName(dbname_))) {
      if (options_.create_if_missing) {
933
        // TODO: add merge_operator name check
934 935 936 937 938 939 940
        s = NewDB();
        if (!s.ok()) {
          return s;
        }
      } else {
        return Status::InvalidArgument(
            dbname_, "does not exist (create_if_missing is false)");
J
jorlow@chromium.org 已提交
941 942
      }
    } else {
943 944 945 946
      if (options_.error_if_exists) {
        return Status::InvalidArgument(
            dbname_, "exists (error_if_exists is true)");
      }
J
jorlow@chromium.org 已提交
947
    }
M
Mayank Agarwal 已提交
948 949 950 951 952 953 954
    // 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 已提交
955 956
  }

I
Igor Canadi 已提交
957
  Status s = versions_->Recover(column_families);
I
Igor Canadi 已提交
958 959 960
  if (options_.paranoid_checks && s.ok()) {
    s = CheckConsistency();
  }
J
jorlow@chromium.org 已提交
961 962
  if (s.ok()) {
    SequenceNumber max_sequence(0);
963 964
    default_cf_handle_ = new ColumnFamilyHandleImpl(
        versions_->GetColumnFamilySet()->GetDefault(), this, &mutex_);
965 966 967 968 969 970 971

    // 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
972
    // produced by an older version of rocksdb.
973
    const uint64_t min_log = versions_->MinLogNumber();
974 975
    const uint64_t prev_log = versions_->PrevLogNumber();
    std::vector<std::string> filenames;
976
    s = env_->GetChildren(options_.wal_dir, &filenames);
977 978
    if (!s.ok()) {
      return s;
979
    }
K
kailiu 已提交
980

981 982
    std::vector<uint64_t> logs;
    for (size_t i = 0; i < filenames.size(); i++) {
K
kailiu 已提交
983 984
      uint64_t number;
      FileType type;
985 986 987 988 989
      if (ParseFileName(filenames[i], &number, &type)
          && type == kLogFile
          && ((number >= min_log) || (number == prev_log))) {
        logs.push_back(number);
      }
J
jorlow@chromium.org 已提交
990
    }
991

H
heyongqiang 已提交
992 993 994 995 996 997
    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");
    }

998 999
    // Recover in the order in which the logs were generated
    std::sort(logs.begin(), logs.end());
K
kailiu 已提交
1000
    for (const auto& log : logs) {
1001 1002 1003
      // 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 已提交
1004
      versions_->MarkFileNumberUsed(log);
K
Kai Liu 已提交
1005
      s = RecoverLogFile(log, &max_sequence, read_only);
1006
    }
I
Igor Canadi 已提交
1007 1008
    SetTickerCount(options_.statistics.get(), SEQUENCE_NUMBER,
                   versions_->LastSequence());
J
jorlow@chromium.org 已提交
1009 1010 1011 1012 1013
  }

  return s;
}

I
Igor Canadi 已提交
1014 1015
Status DBImpl::RecoverLogFile(uint64_t log_number, SequenceNumber* max_sequence,
                              bool read_only) {
J
jorlow@chromium.org 已提交
1016 1017
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1018
    Logger* info_log;
J
jorlow@chromium.org 已提交
1019
    const char* fname;
1020 1021
    Status* status;  // nullptr if options_.paranoid_checks==false or
                     //            options_.skip_log_error_on_recovery==true
J
jorlow@chromium.org 已提交
1022
    virtual void Corruption(size_t bytes, const Status& s) {
1023
      Log(info_log, "%s%s: dropping %d bytes; %s",
1024
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1025
          fname, static_cast<int>(bytes), s.ToString().c_str());
1026
      if (this->status != nullptr && this->status->ok()) *this->status = s;
J
jorlow@chromium.org 已提交
1027 1028 1029 1030 1031
    }
  };

  mutex_.AssertHeld();

1032
  std::unordered_map<int, VersionEdit> version_edits;
1033
  // no need to refcount because iteration is under mutex
1034 1035
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    VersionEdit edit;
1036 1037
    edit.SetColumnFamily(cfd->GetID());
    version_edits.insert({cfd->GetID(), edit});
1038
  }
I
Igor Canadi 已提交
1039

J
jorlow@chromium.org 已提交
1040
  // Open the log file
1041
  std::string fname = LogFileName(options_.wal_dir, log_number);
1042
  unique_ptr<SequentialFile> file;
1043
  Status status = env_->NewSequentialFile(fname, &file, storage_options_);
J
jorlow@chromium.org 已提交
1044 1045 1046 1047 1048 1049 1050 1051
  if (!status.ok()) {
    MaybeIgnoreError(&status);
    return status;
  }

  // Create the log reader.
  LogReporter reporter;
  reporter.env = env_;
1052
  reporter.info_log = options_.info_log.get();
J
jorlow@chromium.org 已提交
1053
  reporter.fname = fname.c_str();
1054 1055
  reporter.status = (options_.paranoid_checks &&
                     !options_.skip_log_error_on_recovery ? &status : nullptr);
J
jorlow@chromium.org 已提交
1056 1057 1058 1059
  // 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).
1060
  log::Reader reader(std::move(file), &reporter, true/*checksum*/,
1061
                     0/*initial_offset*/);
K
Kai Liu 已提交
1062 1063
  Log(options_.info_log, "Recovering log #%lu",
      (unsigned long) log_number);
J
jorlow@chromium.org 已提交
1064 1065 1066 1067 1068

  // Read all the records and add to a memtable
  std::string scratch;
  Slice record;
  WriteBatch batch;
I
Igor Canadi 已提交
1069
  while (reader.ReadRecord(&record, &scratch)) {
J
jorlow@chromium.org 已提交
1070 1071 1072 1073 1074 1075 1076
    if (record.size() < 12) {
      reporter.Corruption(
          record.size(), Status::Corruption("log record too small"));
      continue;
    }
    WriteBatchInternal::SetContents(&batch, record);

1077
    status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
1078
        &batch, column_family_memtables_.get(), true, log_number);
1079

J
jorlow@chromium.org 已提交
1080 1081
    MaybeIgnoreError(&status);
    if (!status.ok()) {
I
Igor Canadi 已提交
1082
      return status;
J
jorlow@chromium.org 已提交
1083 1084 1085 1086 1087 1088 1089 1090
    }
    const SequenceNumber last_seq =
        WriteBatchInternal::Sequence(&batch) +
        WriteBatchInternal::Count(&batch) - 1;
    if (last_seq > *max_sequence) {
      *max_sequence = last_seq;
    }

1091
    if (!read_only) {
1092 1093
      // no need to refcount since client still doesn't have access
      // to the DB and can not drop column families while we iterate
1094
      for (auto cfd : *versions_->GetColumnFamilySet()) {
1095
        if (cfd->mem()->ShouldFlush()) {
1096
          // If this asserts, it means that InsertInto failed in
1097 1098
          // filtering updates to already-flushed column families
          assert(cfd->GetLogNumber() <= log_number);
1099
          auto iter = version_edits.find(cfd->GetID());
1100 1101
          assert(iter != version_edits.end());
          VersionEdit* edit = &iter->second;
1102
          status = WriteLevel0TableForRecovery(cfd, cfd->mem(), edit);
1103 1104 1105 1106 1107 1108 1109 1110
          // 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 已提交
1111 1112 1113 1114
      }
    }
  }

1115 1116 1117 1118
  if (versions_->LastSequence() < *max_sequence) {
    versions_->SetLastSequence(*max_sequence);
  }

1119
  if (!read_only) {
1120 1121
    // no need to refcount since client still doesn't have access
    // to the DB and can not drop column families while we iterate
1122
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1123
      auto iter = version_edits.find(cfd->GetID());
1124 1125 1126
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

1127 1128 1129 1130
      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
1131
        // (in WriteBatch::InsertInto)
1132 1133 1134 1135 1136 1137 1138
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1139
        status = WriteLevel0TableForRecovery(cfd, cfd->mem(), edit);
1140
      }
1141 1142 1143 1144 1145
      // we still want to clear the memtable, even if the recovery failed
      cfd->CreateNewMemtable();
      if (!status.ok()) {
        return status;
      }
J
jorlow@chromium.org 已提交
1146

1147 1148 1149 1150 1151 1152 1153
      // 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);
1154 1155 1156
      // 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 已提交
1157
      // log number
1158
      versions_->MarkFileNumberUsed(log_number + 1);
1159 1160 1161 1162 1163
      status = versions_->LogAndApply(cfd, edit, &mutex_);
      if (!status.ok()) {
        return status;
      }
    }
1164
  }
I
Igor Canadi 已提交
1165

J
jorlow@chromium.org 已提交
1166 1167 1168
  return status;
}

1169 1170
Status DBImpl::WriteLevel0TableForRecovery(ColumnFamilyData* cfd, MemTable* mem,
                                           VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1171
  mutex_.AssertHeld();
1172
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1173 1174 1175 1176
  FileMetaData meta;
  meta.number = versions_->NewFileNumber();
  pending_outputs_.insert(meta.number);
  Iterator* iter = mem->NewIterator();
1177 1178 1179
  const SequenceNumber newest_snapshot = snapshots_.GetNewest();
  const SequenceNumber earliest_seqno_in_memtable =
    mem->GetFirstSequenceNumber();
K
Kai Liu 已提交
1180 1181
  Log(options_.info_log, "Level-0 table #%lu: started",
      (unsigned long) meta.number);
1182 1183 1184 1185

  Status s;
  {
    mutex_.Unlock();
I
Igor Canadi 已提交
1186
    s = BuildTable(dbname_, env_, *cfd->options(), storage_options_,
1187
                   cfd->table_cache(), iter, &meta, cfd->internal_comparator(),
1188
                   newest_snapshot, earliest_seqno_in_memtable,
I
Igor Canadi 已提交
1189
                   GetCompressionFlush(*cfd->options()));
I
Igor Canadi 已提交
1190
    LogFlush(options_.info_log);
1191 1192 1193
    mutex_.Lock();
  }

K
Kai Liu 已提交
1194 1195 1196
  Log(options_.info_log, "Level-0 table #%lu: %lu bytes %s",
      (unsigned long) meta.number,
      (unsigned long) meta.file_size,
J
jorlow@chromium.org 已提交
1197 1198
      s.ToString().c_str());
  delete iter;
1199

1200
  pending_outputs_.erase(meta.number);
1201 1202 1203 1204 1205 1206

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
  if (s.ok() && meta.file_size > 0) {
    edit->AddFile(level, meta.number, meta.file_size,
1207 1208
                  meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1209 1210
  }

I
Igor Canadi 已提交
1211
  InternalStats::CompactionStats stats;
1212 1213
  stats.micros = env_->NowMicros() - start_micros;
  stats.bytes_written = meta.file_size;
M
Mark Callaghan 已提交
1214
  stats.files_out_levelnp1 = 1;
1215
  cfd->internal_stats()->AddCompactionStats(level, stats);
1216
  RecordTick(options_.statistics.get(), COMPACT_WRITE_BYTES, meta.file_size);
J
jorlow@chromium.org 已提交
1217 1218 1219
  return s;
}

1220
Status DBImpl::WriteLevel0Table(ColumnFamilyData* cfd,
1221
                                autovector<MemTable*>& mems, VersionEdit* edit,
1222
                                uint64_t* filenumber, LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
1223
  mutex_.AssertHeld();
1224 1225 1226 1227 1228
  const uint64_t start_micros = env_->NowMicros();
  FileMetaData meta;
  meta.number = versions_->NewFileNumber();
  *filenumber = meta.number;
  pending_outputs_.insert(meta.number);
1229

1230 1231
  const SequenceNumber newest_snapshot = snapshots_.GetNewest();
  const SequenceNumber earliest_seqno_in_memtable =
1232
    mems[0]->GetFirstSequenceNumber();
1233
  Version* base = cfd->current();
1234
  base->Ref();          // it is likely that we do not need this reference
1235 1236 1237
  Status s;
  {
    mutex_.Unlock();
H
Haobo Xu 已提交
1238
    log_buffer->FlushBufferToLog();
K
Kai Liu 已提交
1239
    std::vector<Iterator*> memtables;
1240
    for (MemTable* m : mems) {
1241 1242
      Log(options_.info_log,
          "[CF %u] Flushing memtable with next log file: %lu\n", cfd->GetID(),
1243
          (unsigned long)m->GetNextLogNumber());
K
Kai Liu 已提交
1244
      memtables.push_back(m->NewIterator());
1245
    }
1246 1247 1248
    Iterator* iter = NewMergingIterator(env_, &cfd->internal_comparator(),
                                        &memtables[0], memtables.size());
    Log(options_.info_log, "Level-0 flush table #%lu: started",
1249
        (unsigned long)meta.number);
1250

I
Igor Canadi 已提交
1251
    s = BuildTable(dbname_, env_, *cfd->options(), storage_options_,
1252
                   cfd->table_cache(), iter, &meta, cfd->internal_comparator(),
1253
                   newest_snapshot, earliest_seqno_in_memtable,
I
Igor Canadi 已提交
1254
                   GetCompressionFlush(*cfd->options()));
I
Igor Canadi 已提交
1255
    LogFlush(options_.info_log);
1256 1257 1258 1259 1260
    delete iter;
    Log(options_.info_log, "Level-0 flush table #%lu: %lu bytes %s",
        (unsigned long) meta.number,
        (unsigned long) meta.file_size,
        s.ToString().c_str());
1261 1262 1263
    if (!options_.disableDataSync) {
      db_directory_->Fsync();
    }
1264 1265
    mutex_.Lock();
  }
1266 1267
  base->Unref();

1268
  // re-acquire the most current version
1269
  base = cfd->current();
1270 1271 1272 1273 1274 1275

  // 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 已提交
1276
  // committed so that other threads can recognize this file as a
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
  // 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;
  if (s.ok() && meta.file_size > 0) {
    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.
1290
    if (base != nullptr && options_.max_background_compactions <= 1 &&
1291
        cfd->options()->compaction_style == kCompactionStyleLevel) {
1292 1293 1294
      level = base->PickLevelForMemTableOutput(min_user_key, max_user_key);
    }
    edit->AddFile(level, meta.number, meta.file_size,
1295 1296
                  meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1297 1298
  }

I
Igor Canadi 已提交
1299
  InternalStats::CompactionStats stats;
1300 1301
  stats.micros = env_->NowMicros() - start_micros;
  stats.bytes_written = meta.file_size;
1302
  cfd->internal_stats()->AddCompactionStats(level, stats);
1303
  RecordTick(options_.statistics.get(), COMPACT_WRITE_BYTES, meta.file_size);
1304 1305 1306
  return s;
}

1307 1308
Status DBImpl::FlushMemTableToOutputFile(ColumnFamilyData* cfd,
                                         bool* madeProgress,
H
Haobo Xu 已提交
1309 1310
                                         DeletionState& deletion_state,
                                         LogBuffer* log_buffer) {
1311
  mutex_.AssertHeld();
1312
  assert(cfd->imm()->size() != 0);
1313
  assert(cfd->imm()->IsFlushPending());
1314 1315 1316

  // Save the contents of the earliest memtable as a new Table
  uint64_t file_number;
K
Kai Liu 已提交
1317
  autovector<MemTable*> mems;
1318
  cfd->imm()->PickMemtablesToFlush(&mems);
1319
  if (mems.empty()) {
H
Haobo Xu 已提交
1320
    LogToBuffer(log_buffer, "Nothing in memstore to flush");
L
Lei Jin 已提交
1321
    return Status::OK();
1322 1323 1324
  }

  // record the logfile_number_ before we release the mutex
1325 1326 1327
  // 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.
1328
  MemTable* m = mems[0];
1329 1330
  VersionEdit* edit = m->GetEdits();
  edit->SetPrevLogNumber(0);
1331 1332
  // SetLogNumber(log_num) indicates logs with number smaller than log_num
  // will no longer be picked up for recovery.
1333 1334
  edit->SetLogNumber(mems.back()->GetNextLogNumber());
  edit->SetColumnFamily(cfd->GetID());
1335

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

1339
  if (s.ok() && shutting_down_.Acquire_Load() && cfd->IsDropped()) {
L
Lei Jin 已提交
1340
    s = Status::ShutdownInProgress(
1341
        "Column family closed during memtable flush");
1342
  }
J
jorlow@chromium.org 已提交
1343

L
Lei Jin 已提交
1344
  if (!s.ok()) {
1345
    cfd->imm()->RollbackMemtableFlush(mems, file_number, &pending_outputs_);
1346 1347
  } else {
    // Replace immutable memtable with the generated Table
1348 1349 1350
    s = cfd->imm()->InstallMemtableFlushResults(
        cfd, mems, versions_.get(), &mutex_, options_.info_log.get(),
        file_number, pending_outputs_, &deletion_state.memtables_to_free,
1351
        db_directory_.get(), log_buffer);
1352
  }
J
jorlow@chromium.org 已提交
1353 1354

  if (s.ok()) {
1355
    InstallSuperVersion(cfd, deletion_state);
1356 1357 1358
    if (madeProgress) {
      *madeProgress = 1;
    }
1359

1360
    MaybeScheduleLogDBDeployStats();
I
Igor Canadi 已提交
1361

1362
    if (disable_delete_obsolete_files_ == 0) {
I
Igor Canadi 已提交
1363
      // add to deletion state
1364 1365 1366 1367 1368
      while (alive_log_files_.size() &&
             *alive_log_files_.begin() < versions_->MinLogNumber()) {
        deletion_state.log_delete_files.push_back(*alive_log_files_.begin());
        alive_log_files_.pop_front();
      }
1369
    }
J
jorlow@chromium.org 已提交
1370
  }
1371 1372 1373 1374 1375 1376 1377

  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;
  }
J
jorlow@chromium.org 已提交
1378 1379 1380
  return s;
}

1381
Status DBImpl::CompactRange(ColumnFamilyHandle* column_family,
1382 1383
                            const Slice* begin, const Slice* end,
                            bool reduce_level, int target_level) {
1384 1385
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
I
Igor Canadi 已提交
1386 1387

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
1388 1389 1390 1391 1392
  if (!s.ok()) {
    LogFlush(options_.info_log);
    return s;
  }

G
Gabor Cselle 已提交
1393 1394 1395
  int max_level_with_files = 1;
  {
    MutexLock l(&mutex_);
I
Igor Canadi 已提交
1396 1397
    Version* base = cfd->current();
    for (int level = 1; level < cfd->NumberLevels(); level++) {
G
Gabor Cselle 已提交
1398 1399 1400 1401 1402
      if (base->OverlapInLevel(level, begin, end)) {
        max_level_with_files = level;
      }
    }
  }
1403 1404 1405
  for (int level = 0; level <= max_level_with_files; level++) {
    // in case the compaction is unversal or if we're compacting the
    // bottom-most level, the output level will be the same as input one
I
Igor Canadi 已提交
1406
    if (cfd->options()->compaction_style == kCompactionStyleUniversal ||
1407
        level == max_level_with_files) {
I
Igor Canadi 已提交
1408
      s = RunManualCompaction(cfd, level, level, begin, end);
1409
    } else {
I
Igor Canadi 已提交
1410
      s = RunManualCompaction(cfd, level, level + 1, begin, end);
L
Lei Jin 已提交
1411 1412 1413 1414
    }
    if (!s.ok()) {
      LogFlush(options_.info_log);
      return s;
1415
    }
G
Gabor Cselle 已提交
1416
  }
1417 1418

  if (reduce_level) {
I
Igor Canadi 已提交
1419
    s = ReFitLevel(cfd, max_level_with_files, target_level);
1420
  }
I
Igor Canadi 已提交
1421
  LogFlush(options_.info_log);
L
Lei Jin 已提交
1422 1423

  return s;
1424 1425 1426
}

// return the same level if it cannot be moved
I
Igor Canadi 已提交
1427
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd, int level) {
1428
  mutex_.AssertHeld();
I
Igor Canadi 已提交
1429
  Version* current = cfd->current();
1430
  int minimum_level = level;
1431
  for (int i = level - 1; i > 0; --i) {
1432
    // stop if level i is not empty
1433
    if (current->NumLevelFiles(i) > 0) break;
1434
    // stop if level i is too small (cannot fit the level files)
I
Igor Canadi 已提交
1435
    if (cfd->compaction_picker()->MaxBytesForLevel(i) <
1436 1437 1438
        current->NumLevelBytes(level)) {
      break;
    }
1439 1440 1441 1442 1443 1444

    minimum_level = i;
  }
  return minimum_level;
}

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

I
Igor Canadi 已提交
1448
  SuperVersion* superversion_to_free = nullptr;
1449
  SuperVersion* new_superversion = new SuperVersion();
I
Igor Canadi 已提交
1450 1451

  mutex_.Lock();
1452 1453 1454

  // only allow one thread refitting
  if (refitting_level_) {
I
Igor Canadi 已提交
1455
    mutex_.Unlock();
1456
    Log(options_.info_log, "ReFitLevel: another thread is refitting");
I
Igor Canadi 已提交
1457
    delete new_superversion;
L
Lei Jin 已提交
1458
    return Status::NotSupported("another thread is refitting");
1459 1460 1461 1462 1463
  }
  refitting_level_ = true;

  // wait for all background threads to stop
  bg_work_gate_closed_ = true;
1464
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_) {
1465
    Log(options_.info_log,
1466 1467
        "RefitLevel: waiting for background threads to stop: %d %d",
        bg_compaction_scheduled_, bg_flush_scheduled_);
1468 1469 1470 1471
    bg_cv_.Wait();
  }

  // move to a smaller level
1472 1473
  int to_level = target_level;
  if (target_level < 0) {
I
Igor Canadi 已提交
1474
    to_level = FindMinimumEmptyLevelFitting(cfd, level);
1475
  }
1476 1477 1478

  assert(to_level <= level);

L
Lei Jin 已提交
1479
  Status status;
1480 1481
  if (to_level < level) {
    Log(options_.info_log, "Before refitting:\n%s",
I
Igor Canadi 已提交
1482
        cfd->current()->DebugString().data());
1483

1484
    VersionEdit edit;
I
Igor Canadi 已提交
1485 1486
    edit.SetColumnFamily(cfd->GetID());
    for (const auto& f : cfd->current()->files_[level]) {
1487
      edit.DeleteFile(level, f->number);
1488 1489
      edit.AddFile(to_level, f->number, f->file_size, f->smallest, f->largest,
                   f->smallest_seqno, f->largest_seqno);
1490 1491 1492 1493
    }
    Log(options_.info_log, "Apply version edit:\n%s",
        edit.DebugString().data());

I
Igor Canadi 已提交
1494
    status = versions_->LogAndApply(cfd, &edit, &mutex_, db_directory_.get());
1495
    superversion_to_free = cfd->InstallSuperVersion(new_superversion, &mutex_);
I
Igor Canadi 已提交
1496
    new_superversion = nullptr;
1497 1498 1499 1500 1501

    Log(options_.info_log, "LogAndApply: %s\n", status.ToString().data());

    if (status.ok()) {
      Log(options_.info_log, "After refitting:\n%s",
I
Igor Canadi 已提交
1502
          cfd->current()->DebugString().data());
1503 1504 1505 1506 1507
    }
  }

  refitting_level_ = false;
  bg_work_gate_closed_ = false;
I
Igor Canadi 已提交
1508 1509 1510 1511

  mutex_.Unlock();
  delete superversion_to_free;
  delete new_superversion;
L
Lei Jin 已提交
1512
  return status;
G
Gabor Cselle 已提交
1513 1514
}

1515 1516 1517
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
1518 1519
}

1520 1521 1522
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->options()->max_mem_compaction_level;
1523 1524
}

1525 1526 1527
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->options()->level0_stop_writes_trigger;
1528 1529
}

1530
Status DBImpl::Flush(const FlushOptions& options,
1531 1532 1533
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return FlushMemTable(cfh->cfd(), options);
H
heyongqiang 已提交
1534 1535
}

1536
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
1537 1538 1539
  return versions_->LastSequence();
}

1540 1541 1542
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {
1543

1544
  RecordTick(options_.statistics.get(), GET_UPDATES_SINCE_CALLS);
1545
  if (seq > versions_->LastSequence()) {
L
Lei Jin 已提交
1546 1547
    return Status::NotFound(
        "Requested sequence not yet written in the db");
1548 1549
  }
  //  Get all sorted Wal Files.
1550 1551
  //  Do binary search and open files and find the seq number.

1552 1553
  std::unique_ptr<VectorLogPtr> wal_files(new VectorLogPtr);
  Status s = GetSortedWalFiles(*wal_files);
1554 1555 1556 1557
  if (!s.ok()) {
    return s;
  }

1558
  s = RetainProbableWalFiles(*wal_files, seq);
1559 1560
  if (!s.ok()) {
    return s;
1561
  }
1562 1563 1564
  iter->reset(new TransactionLogIteratorImpl(options_.wal_dir, &options_,
                                             read_options, storage_options_,
                                             seq, std::move(wal_files), this));
1565
  return (*iter)->status();
1566 1567
}

1568 1569
Status DBImpl::RetainProbableWalFiles(VectorLogPtr& all_logs,
                                      const SequenceNumber target) {
1570
  long start = 0; // signed to avoid overflow when target is < first file.
1571
  long end = static_cast<long>(all_logs.size()) - 1;
1572
  // Binary Search. avoid opening all files.
1573 1574
  while (end >= start) {
    long mid = start + (end - start) / 2;  // Avoid overflow.
1575 1576
    SequenceNumber current_seq_num = all_logs.at(mid)->StartSequence();
    if (current_seq_num == target) {
1577
      end = mid;
1578
      break;
1579
    } else if (current_seq_num < target) {
1580
      start = mid + 1;
1581
    } else {
1582
      end = mid - 1;
1583 1584
    }
  }
1585 1586 1587
  size_t start_index = std::max(0l, end); // end could be -ve.
  // The last wal file is always included
  all_logs.erase(all_logs.begin(), all_logs.begin() + start_index);
1588 1589 1590
  return Status::OK();
}

1591 1592 1593
bool DBImpl::CheckWalFileExistsAndEmpty(const WalFileType type,
                                        const uint64_t number) {
  const std::string fname = (type == kAliveLogFile) ?
1594 1595
    LogFileName(options_.wal_dir, number) :
    ArchivedLogFileName(options_.wal_dir, number);
1596 1597
  uint64_t file_size;
  Status s = env_->GetFileSize(fname, &file_size);
1598
  return (s.ok() && (file_size == 0));
1599 1600
}

1601 1602
Status DBImpl::ReadFirstRecord(const WalFileType type, const uint64_t number,
                               WriteBatch* const result) {
1603

1604
  if (type == kAliveLogFile) {
1605
    std::string fname = LogFileName(options_.wal_dir, number);
1606
    Status status = ReadFirstLine(fname, result);
L
Lei Jin 已提交
1607 1608 1609
    if (status.ok() || env_->FileExists(fname)) {
      // return OK or any error that is not caused non-existing file
      return status;
1610
    }
L
Lei Jin 已提交
1611 1612 1613 1614 1615 1616 1617 1618 1619

    //  check if the file got moved to archive.
    std::string archived_file =
      ArchivedLogFileName(options_.wal_dir, number);
    Status s = ReadFirstLine(archived_file, result);
    if (s.ok() || env_->FileExists(archived_file)) {
      return s;
    }
    return Status::NotFound("Log File has been deleted: " + archived_file);
1620
  } else if (type == kArchivedLogFile) {
1621
    std::string fname = ArchivedLogFileName(options_.wal_dir, number);
1622 1623 1624
    Status status = ReadFirstLine(fname, result);
    return status;
  }
1625
  return Status::NotSupported("File Type Not Known: " + std::to_string(type));
1626 1627 1628 1629 1630 1631 1632 1633
}

Status DBImpl::ReadFirstLine(const std::string& fname,
                             WriteBatch* const batch) {
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
    Logger* info_log;
    const char* fname;
L
Lei Jin 已提交
1634 1635 1636

    Status* status;
    bool ignore_error;  // true if options_.paranoid_checks==false
1637 1638
    virtual void Corruption(size_t bytes, const Status& s) {
      Log(info_log, "%s%s: dropping %d bytes; %s",
L
Lei Jin 已提交
1639
          (this->ignore_error ? "(ignoring error) " : ""),
1640
          fname, static_cast<int>(bytes), s.ToString().c_str());
L
Lei Jin 已提交
1641 1642 1643 1644
      if (this->status->ok()) {
        // only keep the first error
        *this->status = s;
      }
1645 1646 1647
    }
  };

1648
  unique_ptr<SequentialFile> file;
1649
  Status status = env_->NewSequentialFile(fname, &file, storage_options_);
1650 1651 1652 1653 1654 1655 1656 1657

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


  LogReporter reporter;
  reporter.env = env_;
1658
  reporter.info_log = options_.info_log.get();
1659
  reporter.fname = fname.c_str();
L
Lei Jin 已提交
1660 1661
  reporter.status = &status;
  reporter.ignore_error = !options_.paranoid_checks;
1662
  log::Reader reader(std::move(file), &reporter, true/*checksum*/,
1663 1664 1665
                     0/*initial_offset*/);
  std::string scratch;
  Slice record;
1666

L
Lei Jin 已提交
1667 1668
  if (reader.ReadRecord(&record, &scratch) &&
      (status.ok() || !options_.paranoid_checks)) {
1669 1670 1671 1672
    if (record.size() < 12) {
      reporter.Corruption(
          record.size(), Status::Corruption("log record too small"));
      //  TODO read record's till the first no corrupt entry?
L
Lei Jin 已提交
1673 1674 1675
    } else {
      WriteBatchInternal::SetContents(batch, record);
      return Status::OK();
1676 1677
    }
  }
L
Lei Jin 已提交
1678 1679 1680 1681 1682 1683

  // ReadRecord returns false on EOF, which is deemed as OK() by Reader
  if (status.ok()) {
    status = Status::Corruption("eof reached");
  }
  return status;
1684 1685
}

1686 1687 1688 1689 1690 1691 1692 1693 1694
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;
  }
};

1695
Status DBImpl::GetSortedWalsOfType(const std::string& path,
1696 1697 1698
    VectorLogPtr& log_files, WalFileType log_type) {
  std::vector<std::string> all_files;
  const Status status = env_->GetChildren(path, &all_files);
1699 1700 1701
  if (!status.ok()) {
    return status;
  }
1702
  log_files.reserve(all_files.size());
1703
  for (const auto& f : all_files) {
1704 1705
    uint64_t number;
    FileType type;
1706
    if (ParseFileName(f, &number, &type) && type == kLogFile){
1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724

      WriteBatch batch;
      Status s = ReadFirstRecord(log_type, number, &batch);
      if (!s.ok()) {
        if (CheckWalFileExistsAndEmpty(log_type, number)) {
          continue;
        }
        return s;
      }

      uint64_t size_bytes;
      s = env_->GetFileSize(LogFileName(path, number), &size_bytes);
      if (!s.ok()) {
        return s;
      }

      log_files.push_back(std::move(unique_ptr<LogFile>(new LogFileImpl(
        number, log_type, WriteBatchInternal::Sequence(&batch), size_bytes))));
1725 1726
    }
  }
1727
  CompareLogByPointer compare_log_files;
1728
  std::sort(log_files.begin(), log_files.end(), compare_log_files);
1729 1730 1731
  return status;
}

I
Igor Canadi 已提交
1732 1733
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
                                   int output_level, const Slice* begin,
L
Lei Jin 已提交
1734
                                   const Slice* end) {
1735
  assert(input_level >= 0);
1736

G
Gabor Cselle 已提交
1737 1738
  InternalKey begin_storage, end_storage;

H
hans@chromium.org 已提交
1739
  ManualCompaction manual;
I
Igor Canadi 已提交
1740
  manual.cfd = cfd;
1741 1742
  manual.input_level = input_level;
  manual.output_level = output_level;
G
Gabor Cselle 已提交
1743
  manual.done = false;
1744
  manual.in_progress = false;
1745 1746 1747
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
I
Igor Canadi 已提交
1748
      cfd->options()->compaction_style == kCompactionStyleUniversal) {
1749
    manual.begin = nullptr;
G
Gabor Cselle 已提交
1750 1751 1752 1753
  } else {
    begin_storage = InternalKey(*begin, kMaxSequenceNumber, kValueTypeForSeek);
    manual.begin = &begin_storage;
  }
1754
  if (end == nullptr ||
I
Igor Canadi 已提交
1755
      cfd->options()->compaction_style == kCompactionStyleUniversal) {
1756
    manual.end = nullptr;
G
Gabor Cselle 已提交
1757 1758 1759 1760 1761 1762
  } else {
    end_storage = InternalKey(*end, 0, static_cast<ValueType>(0));
    manual.end = &end_storage;
  }

  MutexLock l(&mutex_);
1763

1764 1765 1766 1767 1768 1769
  // 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
1770
  // RunManualCompaction(), i.e. during that time no other compaction will
1771 1772 1773
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
1774
  // RunManualCompaction() from getting to the second while loop below.
1775 1776 1777 1778 1779 1780 1781 1782
  // 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,
        "Manual compaction waiting for all other scheduled background "
        "compactions to finish");
1783 1784
    bg_cv_.Wait();
  }
1785

1786 1787
  Log(options_.info_log, "Manual compaction starting");

1788 1789 1790 1791
  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 已提交
1792
      bg_cv_.Wait();
1793 1794 1795
    } else {
      manual_compaction_ = &manual;
      MaybeScheduleFlushOrCompaction();
G
Gabor Cselle 已提交
1796
    }
H
hans@chromium.org 已提交
1797
  }
1798

1799 1800 1801
  assert(!manual.in_progress);
  assert(bg_manual_only_ > 0);
  --bg_manual_only_;
L
Lei Jin 已提交
1802
  return manual.status;
J
jorlow@chromium.org 已提交
1803 1804
}

1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
Status DBImpl::TEST_CompactRange(int level, const Slice* begin,
                                 const Slice* end,
                                 ColumnFamilyHandle* column_family) {
  ColumnFamilyData* cfd;
  if (column_family == nullptr) {
    cfd = default_cf_handle_->cfd();
  } else {
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
    cfd = cfh->cfd();
  }
I
Igor Canadi 已提交
1815
  int output_level =
1816
      (cfd->options()->compaction_style == kCompactionStyleUniversal)
I
Igor Canadi 已提交
1817 1818
          ? level
          : level + 1;
1819
  return RunManualCompaction(cfd, level, output_level, begin, end);
1820 1821
}

1822 1823
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
                             const FlushOptions& options) {
1824 1825
  // nullptr batch means just wait for earlier writes to be done
  Status s = Write(WriteOptions(), nullptr);
H
heyongqiang 已提交
1826
  if (s.ok() && options.wait) {
1827
    // Wait until the compaction completes
1828
    s = WaitForFlushMemTable(cfd);
1829 1830
  }
  return s;
J
jorlow@chromium.org 已提交
1831 1832
}

1833
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
1834 1835 1836
  Status s;
  // Wait until the compaction completes
  MutexLock l(&mutex_);
1837
  while (cfd->imm()->size() > 0 && bg_error_.ok()) {
1838 1839
    bg_cv_.Wait();
  }
1840
  if (!bg_error_.ok()) {
1841 1842 1843
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
1844 1845
}

1846 1847 1848
Status DBImpl::TEST_FlushMemTable(bool wait) {
  FlushOptions fo;
  fo.wait = wait;
1849
  return FlushMemTable(default_cf_handle_->cfd(), fo);
H
heyongqiang 已提交
1850 1851
}

1852 1853 1854 1855 1856 1857 1858 1859 1860
Status DBImpl::TEST_WaitForFlushMemTable(ColumnFamilyHandle* column_family) {
  ColumnFamilyData* cfd;
  if (column_family == nullptr) {
    cfd = default_cf_handle_->cfd();
  } else {
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
    cfd = cfh->cfd();
  }
  return WaitForFlushMemTable(cfd);
1861 1862 1863
}

Status DBImpl::TEST_WaitForCompact() {
1864
  // Wait until the compaction completes
1865 1866 1867 1868 1869

  // TODO: a bug here. This function actually does not necessarily
  // wait for compact. It actually waits for scheduled compaction
  // OR flush to finish.

1870
  MutexLock l(&mutex_);
1871 1872
  while ((bg_compaction_scheduled_ || bg_flush_scheduled_) &&
         bg_error_.ok()) {
1873 1874 1875
    bg_cv_.Wait();
  }
  return bg_error_;
1876 1877
}

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

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

void DBImpl::BGWorkFlush(void* db) {
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
}

void DBImpl::BGWorkCompaction(void* db) {
  reinterpret_cast<DBImpl*>(db)->BackgroundCallCompaction();
}

I
Igor Canadi 已提交
1936
Status DBImpl::BackgroundFlush(bool* madeProgress,
H
Haobo Xu 已提交
1937 1938
                               DeletionState& deletion_state,
                               LogBuffer* log_buffer) {
1939 1940 1941 1942 1943 1944 1945
  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;
  autovector<ColumnFamilyData*> to_delete;
  // refcounting in iteration
1946
  for (auto cfd : *versions_->GetColumnFamilySet()) {
1947 1948 1949
    cfd->Ref();
    Status flush_status;
    while (flush_status.ok() && cfd->imm()->IsFlushPending()) {
1950 1951
      LogToBuffer(
          log_buffer,
1952 1953 1954
          "BackgroundCallFlush doing FlushMemTableToOutputFile with column "
          "family %u, flush slots available %d",
          cfd->GetID(), options_.max_background_flushes - bg_flush_scheduled_);
1955 1956
      flush_status = FlushMemTableToOutputFile(cfd, madeProgress,
                                               deletion_state, log_buffer);
1957 1958 1959
    }
    if (call_status.ok() && !flush_status.ok()) {
      call_status = flush_status;
1960
    }
1961 1962 1963 1964 1965 1966
    if (cfd->Unref()) {
      to_delete.push_back(cfd);
    }
  }
  for (auto cfd : to_delete) {
    delete cfd;
J
jorlow@chromium.org 已提交
1967
  }
1968
  return call_status;
J
jorlow@chromium.org 已提交
1969 1970
}

1971
void DBImpl::BackgroundCallFlush() {
1972
  bool madeProgress = false;
K
Kai Liu 已提交
1973
  DeletionState deletion_state(true);
1974 1975
  assert(bg_flush_scheduled_);

H
Haobo Xu 已提交
1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987
  LogBuffer log_buffer(INFO, options_.info_log.get());
  {
    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.
1988 1989 1990
        uint64_t error_cnt = default_cf_handle_->cfd()
                                 ->internal_stats()
                                 ->BumpAndGetBackgroundErrorCount();
H
Haobo Xu 已提交
1991 1992
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
1993 1994 1995 1996
        Log(options_.info_log,
            "Waiting after background flush error: %s"
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
H
Haobo Xu 已提交
1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
        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
2008
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2009
      mutex_.Unlock();
2010 2011 2012 2013 2014
      // 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 已提交
2015
      log_buffer.FlushBufferToLog();
2016 2017 2018
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2019 2020
      mutex_.Lock();
    }
I
Igor Canadi 已提交
2021

H
Haobo Xu 已提交
2022
    bg_flush_scheduled_--;
2023 2024 2025 2026 2027
    // 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 已提交
2028 2029 2030
      MaybeScheduleFlushOrCompaction();
    }
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
2031 2032 2033 2034
    // 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.
2035
  }
J
jorlow@chromium.org 已提交
2036 2037
}

2038

2039 2040 2041 2042
void DBImpl::TEST_PurgeObsoleteteWAL() {
  PurgeObsoleteWALFiles();
}

2043 2044
uint64_t DBImpl::TEST_GetLevel0TotalSize() {
  MutexLock l(&mutex_);
2045
  return default_cf_handle_->cfd()->current()->NumLevelBytes(0);
2046 2047
}

2048
void DBImpl::BackgroundCallCompaction() {
2049
  bool madeProgress = false;
K
Kai Liu 已提交
2050
  DeletionState deletion_state(true);
H
Haobo Xu 已提交
2051 2052

  MaybeDumpStats();
H
Haobo Xu 已提交
2053
  LogBuffer log_buffer(INFO, options_.info_log.get());
2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066
  {
    MutexLock l(&mutex_);
    // Log(options_.info_log, "XXX BG Thread %llx process new work item",
    //     pthread_self());
    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.
2067 2068 2069
        uint64_t error_cnt = default_cf_handle_->cfd()
                                 ->internal_stats()
                                 ->BumpAndGetBackgroundErrorCount();
2070 2071
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
H
Haobo Xu 已提交
2072
        log_buffer.FlushBufferToLog();
2073 2074 2075 2076
        Log(options_.info_log,
            "Waiting after background compaction error: %s, "
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
2077 2078 2079 2080 2081
        LogFlush(options_.info_log);
        env_->SleepForMicroseconds(1000000);
        mutex_.Lock();
      }
    }
H
Haobo Xu 已提交
2082

2083 2084 2085 2086 2087 2088 2089
    // 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
2090
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2091
      mutex_.Unlock();
2092 2093 2094 2095 2096
      // 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 已提交
2097
      log_buffer.FlushBufferToLog();
2098 2099 2100
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2101 2102
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
2103

2104
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2105

2106
    MaybeScheduleLogDBDeployStats();
2107

2108 2109 2110
    // Previous compaction may have produced too many files in a level,
    // So reschedule another compaction if we made progress in the
    // last compaction.
2111 2112 2113 2114 2115 2116
    //
    // 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_) {
2117 2118 2119
      MaybeScheduleFlushOrCompaction();
    }
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
2120 2121 2122 2123
    // 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.
2124
  }
J
jorlow@chromium.org 已提交
2125 2126
}

A
Abhishek Kona 已提交
2127
Status DBImpl::BackgroundCompaction(bool* madeProgress,
2128 2129
                                    DeletionState& deletion_state,
                                    LogBuffer* log_buffer) {
2130
  *madeProgress = false;
J
jorlow@chromium.org 已提交
2131
  mutex_.AssertHeld();
2132

2133 2134
  bool is_manual = (manual_compaction_ != nullptr) &&
                   (manual_compaction_->in_progress == false);
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178

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

  // FLUSH preempts compaction
  autovector<ColumnFamilyData*> to_delete;
  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);
      if (cfd->Unref()) {
        to_delete.push_back(cfd);
      }
      if (!flush_stat.ok()) {
        if (is_manual) {
          manual_compaction_->status = flush_stat;
          manual_compaction_->done = true;
          manual_compaction_->in_progress = false;
          manual_compaction_ = nullptr;
        }
        break;
      }
    }
    if (!flush_stat.ok()) {
      break;
    }
  }
  for (auto cfd : to_delete) {
    delete cfd;
  }
  if (!flush_stat.ok()) {
    return flush_stat;
  }

  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);
I
Igor Canadi 已提交
2184 2185
    c.reset(m->cfd->CompactRange(m->input_level, m->output_level, m->begin,
                                 m->end, &manual_end));
2186
    if (!c) {
2187
      m->done = true;
G
Gabor Cselle 已提交
2188
    }
2189 2190
    LogToBuffer(
        log_buffer,
2191 2192
        "Manual compaction from level-%d to level-%d from %s .. %s; will stop "
        "at %s\n",
2193
        m->input_level, m->output_level,
G
Gabor Cselle 已提交
2194 2195
        (m->begin ? m->begin->DebugString().c_str() : "(begin)"),
        (m->end ? m->end->DebugString().c_str() : "(end)"),
2196 2197 2198
        ((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 2206 2207 2208 2209
        if (c != nullptr) {
          // update statistics
          MeasureTime(options_.statistics.get(), NUM_FILES_IN_SINGLE_COMPACTION,
                      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");
H
hans@chromium.org 已提交
2218
  } else if (!is_manual && c->IsTrivialMove()) {
J
jorlow@chromium.org 已提交
2219
    // Move file to next level
2220
    assert(c->num_input_files(0) == 1);
J
jorlow@chromium.org 已提交
2221 2222 2223
    FileMetaData* f = c->input(0, 0);
    c->edit()->DeleteFile(c->level(), f->number);
    c->edit()->AddFile(c->level() + 1, f->number, f->file_size,
2224 2225
                       f->smallest, f->largest,
                       f->smallest_seqno, f->largest_seqno);
I
Igor Canadi 已提交
2226
    status = versions_->LogAndApply(c->column_family_data(), c->edit(), &mutex_,
2227
                                    db_directory_.get());
I
Igor Canadi 已提交
2228
    InstallSuperVersion(c->column_family_data(), deletion_state);
2229 2230 2231
    if (options_.allow_thread_local) {
      c->column_family_data()->ResetThreadLocalSuperVersions();
    }
2232

2233
    Version::LevelSummaryStorage tmp;
2234
    LogToBuffer(log_buffer, "Moved #%lld to level-%d %lld bytes %s: %s\n",
2235
        static_cast<unsigned long long>(f->number), c->level() + 1,
J
jorlow@chromium.org 已提交
2236
        static_cast<unsigned long long>(f->file_size),
I
Igor Canadi 已提交
2237 2238
        status.ToString().c_str(), c->input_version()->LevelSummary(&tmp));
    c->ReleaseCompactionFiles(status);
2239
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2240
  } else {
2241
    MaybeScheduleFlushOrCompaction(); // do more compaction work in parallel.
2242
    CompactionState* compact = new CompactionState(c.get());
H
Haobo Xu 已提交
2243
    status = DoCompactionWork(compact, deletion_state, log_buffer);
2244
    CleanupCompaction(compact, status);
I
Igor Canadi 已提交
2245
    c->ReleaseCompactionFiles(status);
2246
    c->ReleaseInputs();
2247
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2248
  }
2249
  c.reset();
J
jorlow@chromium.org 已提交
2250 2251 2252 2253 2254 2255

  if (status.ok()) {
    // Done
  } else if (shutting_down_.Acquire_Load()) {
    // Ignore compaction errors found during shutting down
  } else {
2256 2257
    Log(WARN, options_.info_log, "Compaction error: %s",
        status.ToString().c_str());
J
jorlow@chromium.org 已提交
2258 2259 2260 2261
    if (options_.paranoid_checks && bg_error_.ok()) {
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
2262 2263

  if (is_manual) {
G
Gabor Cselle 已提交
2264
    ManualCompaction* m = manual_compaction_;
2265
    if (!status.ok()) {
L
Lei Jin 已提交
2266
      m->status = status;
2267 2268
      m->done = true;
    }
2269 2270 2271 2272 2273 2274 2275 2276 2277
    // 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.
2278 2279 2280 2281 2282
    //
    // 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) {
2283 2284
      m->done = true;
    }
G
Gabor Cselle 已提交
2285 2286 2287
    if (!m->done) {
      // We only compacted part of the requested range.  Update *m
      // to the range that is left to be compacted.
2288
      // Universal compaction should always compact the whole range
I
Igor Canadi 已提交
2289
      assert(m->cfd->options()->compaction_style != kCompactionStyleUniversal);
2290
      m->tmp_storage = *manual_end;
G
Gabor Cselle 已提交
2291 2292
      m->begin = &m->tmp_storage;
    }
2293
    m->in_progress = false; // not being processed anymore
2294
    manual_compaction_ = nullptr;
H
hans@chromium.org 已提交
2295
  }
2296
  return status;
J
jorlow@chromium.org 已提交
2297 2298
}

2299
void DBImpl::CleanupCompaction(CompactionState* compact, Status status) {
J
jorlow@chromium.org 已提交
2300
  mutex_.AssertHeld();
2301
  if (compact->builder != nullptr) {
J
jorlow@chromium.org 已提交
2302 2303
    // May happen if we get a shutdown call in the middle of compaction
    compact->builder->Abandon();
2304
    compact->builder.reset();
J
jorlow@chromium.org 已提交
2305
  } else {
2306
    assert(compact->outfile == nullptr);
J
jorlow@chromium.org 已提交
2307
  }
D
dgrogan@chromium.org 已提交
2308
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2309 2310
    const CompactionState::Output& out = compact->outputs[i];
    pending_outputs_.erase(out.number);
2311 2312 2313 2314

    // 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 已提交
2315
      TableCache::Evict(table_cache_.get(), out.number);
2316
    }
J
jorlow@chromium.org 已提交
2317 2318 2319 2320
  }
  delete compact;
}

2321
// Allocate the file numbers for the output file. We allocate as
2322
// many output file numbers as there are files in level+1 (at least one)
2323 2324 2325
// Insert them into pending_outputs so that they do not get deleted.
void DBImpl::AllocateCompactionOutputFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2326 2327
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
2328
  int filesNeeded = compact->compaction->num_input_files(1);
2329
  for (int i = 0; i < std::max(filesNeeded, 1); i++) {
2330 2331 2332 2333 2334 2335 2336 2337 2338
    uint64_t file_number = versions_->NewFileNumber();
    pending_outputs_.insert(file_number);
    compact->allocated_file_numbers.push_back(file_number);
  }
}

// Frees up unused file number.
void DBImpl::ReleaseCompactionUnusedFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2339
  for (const auto file_number : compact->allocated_file_numbers) {
2340 2341 2342 2343 2344
    pending_outputs_.erase(file_number);
    // Log(options_.info_log, "XXX releasing unused file num %d", file_number);
  }
}

J
jorlow@chromium.org 已提交
2345
Status DBImpl::OpenCompactionOutputFile(CompactionState* compact) {
2346 2347
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
J
jorlow@chromium.org 已提交
2348
  uint64_t file_number;
2349 2350 2351 2352 2353 2354 2355
  // 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 已提交
2356 2357 2358 2359 2360
    mutex_.Lock();
    file_number = versions_->NewFileNumber();
    pending_outputs_.insert(file_number);
    mutex_.Unlock();
  }
2361 2362 2363 2364
  CompactionState::Output out;
  out.number = file_number;
  out.smallest.Clear();
  out.largest.Clear();
2365
  out.smallest_seqno = out.largest_seqno = 0;
2366
  compact->outputs.push_back(out);
J
jorlow@chromium.org 已提交
2367 2368 2369

  // Make the output file
  std::string fname = TableFileName(dbname_, file_number);
2370
  Status s = env_->NewWritableFile(fname, &compact->outfile, storage_options_);
2371

J
jorlow@chromium.org 已提交
2372
  if (s.ok()) {
2373 2374
    // Over-estimate slightly so we don't end up just barely crossing
    // the threshold.
I
Igor Canadi 已提交
2375
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2376
    compact->outfile->SetPreallocationBlockSize(
I
Igor Canadi 已提交
2377
        1.1 * cfd->compaction_picker()->MaxFileSizeForLevel(
2378
                  compact->compaction->output_level()));
2379

I
Igor Canadi 已提交
2380 2381 2382
    CompressionType compression_type =
        GetCompressionType(*cfd->options(), compact->compaction->output_level(),
                           compact->compaction->enable_compression());
S
Siying Dong 已提交
2383

2384
    compact->builder.reset(
I
Igor Canadi 已提交
2385
        NewTableBuilder(*cfd->options(), cfd->internal_comparator(),
2386
                        compact->outfile.get(), compression_type));
J
jorlow@chromium.org 已提交
2387
  }
I
Igor Canadi 已提交
2388
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
2389 2390 2391 2392 2393
  return s;
}

Status DBImpl::FinishCompactionOutputFile(CompactionState* compact,
                                          Iterator* input) {
2394
  assert(compact != nullptr);
2395
  assert(compact->outfile);
2396
  assert(compact->builder != nullptr);
J
jorlow@chromium.org 已提交
2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411

  const uint64_t output_number = compact->current_output()->number;
  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;
2412
  compact->builder.reset();
J
jorlow@chromium.org 已提交
2413 2414

  // Finish and check for file errors
2415
  if (s.ok() && !options_.disableDataSync) {
2416
    if (options_.use_fsync) {
2417
      StopWatch sw(env_, options_.statistics.get(),
2418
                   COMPACTION_OUTFILE_SYNC_MICROS, false);
2419 2420
      s = compact->outfile->Fsync();
    } else {
2421
      StopWatch sw(env_, options_.statistics.get(),
2422
                   COMPACTION_OUTFILE_SYNC_MICROS, false);
2423 2424
      s = compact->outfile->Sync();
    }
J
jorlow@chromium.org 已提交
2425 2426 2427 2428
  }
  if (s.ok()) {
    s = compact->outfile->Close();
  }
2429
  compact->outfile.reset();
J
jorlow@chromium.org 已提交
2430 2431 2432

  if (s.ok() && current_entries > 0) {
    // Verify that the table is usable
I
Igor Canadi 已提交
2433
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2434
    FileMetaData meta(output_number, current_bytes);
I
Igor Canadi 已提交
2435
    Iterator* iter = cfd->table_cache()->NewIterator(
2436
        ReadOptions(), storage_options_, cfd->internal_comparator(), meta);
J
jorlow@chromium.org 已提交
2437 2438 2439
    s = iter->status();
    delete iter;
    if (s.ok()) {
2440
      Log(options_.info_log,
K
Kai Liu 已提交
2441 2442 2443 2444
          "Generated table #%lu: %lu keys, %lu bytes",
          (unsigned long) output_number,
          (unsigned long) current_entries,
          (unsigned long) current_bytes);
J
jorlow@chromium.org 已提交
2445 2446 2447 2448 2449 2450
    }
  }
  return s;
}


2451 2452
Status DBImpl::InstallCompactionResults(CompactionState* compact,
                                        LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
2453
  mutex_.AssertHeld();
2454 2455 2456 2457 2458

  // 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.
2459
  if (!versions_->VerifyCompactionFileConsistency(compact->compaction)) {
2460 2461 2462 2463
    Log(options_.info_log,  "Compaction %d@%d + %d@%d files aborted",
      compact->compaction->num_input_files(0),
      compact->compaction->level(),
      compact->compaction->num_input_files(1),
I
Igor Canadi 已提交
2464
      compact->compaction->output_level());
L
Lei Jin 已提交
2465
    return Status::Corruption("Compaction input files inconsistent");
2466 2467
  }

2468 2469 2470 2471 2472 2473
  LogToBuffer(log_buffer, "Compacted %d@%d + %d@%d files => %lld bytes",
              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 已提交
2474 2475 2476

  // Add compaction outputs
  compact->compaction->AddInputDeletions(compact->compaction->edit());
D
dgrogan@chromium.org 已提交
2477
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2478 2479
    const CompactionState::Output& out = compact->outputs[i];
    compact->compaction->edit()->AddFile(
2480 2481
        compact->compaction->output_level(), out.number, out.file_size,
        out.smallest, out.largest, out.smallest_seqno, out.largest_seqno);
J
jorlow@chromium.org 已提交
2482
  }
I
Igor Canadi 已提交
2483 2484 2485
  return versions_->LogAndApply(compact->compaction->column_family_data(),
                                compact->compaction->edit(), &mutex_,
                                db_directory_.get());
J
jorlow@chromium.org 已提交
2486 2487
}

2488 2489 2490 2491 2492 2493 2494 2495
//
// 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(
2496 2497
  SequenceNumber in, std::vector<SequenceNumber>& snapshots,
  SequenceNumber* prev_snapshot) {
2498
  SequenceNumber prev __attribute__((unused)) = 0;
2499 2500 2501
  for (const auto cur : snapshots) {
    assert(prev <= cur);
    if (cur >= in) {
2502
      *prev_snapshot = prev;
2503
      return cur;
2504
    }
2505 2506
    prev = cur; // assignment
    assert(prev);
2507 2508
  }
  Log(options_.info_log,
K
Kai Liu 已提交
2509 2510 2511
      "Looking for seqid %lu but maxseqid is %lu",
      (unsigned long)in,
      (unsigned long)snapshots[snapshots.size()-1]);
2512 2513 2514 2515
  assert(0);
  return 0;
}

D
Danny Guo 已提交
2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527
Status DBImpl::ProcessKeyValueCompaction(
    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 已提交
2528
  Status status;
D
Danny Guo 已提交
2529
  std::string compaction_filter_value;
J
jorlow@chromium.org 已提交
2530 2531 2532
  ParsedInternalKey ikey;
  std::string current_user_key;
  bool has_current_user_key = false;
D
Danny Guo 已提交
2533
  std::vector<char> delete_key;   // for compaction filter
2534 2535
  SequenceNumber last_sequence_for_key __attribute__((unused)) =
    kMaxSequenceNumber;
2536
  SequenceNumber visible_in_snapshot = kMaxSequenceNumber;
2537
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
I
Igor Canadi 已提交
2538 2539
  MergeHelper merge(
      cfd->user_comparator(), cfd->options()->merge_operator.get(),
2540 2541
      options_.info_log.get(), cfd->options()->min_partial_merge_operands,
      false /* internal key corruption is expected */);
I
Igor Canadi 已提交
2542
  auto compaction_filter = cfd->options()->compaction_filter;
2543 2544
  std::unique_ptr<CompactionFilter> compaction_filter_from_factory = nullptr;
  if (!compaction_filter) {
2545
    auto context = compact->GetFilterContextV1();
2546
    compaction_filter_from_factory =
I
Igor Canadi 已提交
2547 2548
        cfd->options()->compaction_filter_factory->CreateCompactionFilter(
            context);
2549 2550
    compaction_filter = compaction_filter_from_factory.get();
  }
2551

2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568
  while (input->Valid() && !shutting_down_.Acquire_Load() &&
         !cfd->IsDropped()) {
    // 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
    if (cfd->imm()->imm_flush_needed.NoBarrier_Load() != nullptr) {
      const uint64_t imm_start = env_->NowMicros();
      mutex_.Lock();
      if (cfd->imm()->IsFlushPending()) {
        FlushMemTableToOutputFile(cfd, nullptr, deletion_state, log_buffer);
        bg_cv_.SignalAll();  // Wakeup MakeRoomForWrite() if necessary
      }
      mutex_.Unlock();
      imm_micros += (env_->NowMicros() - imm_start);
    }

D
Danny Guo 已提交
2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589
    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 已提交
2590

2591
    if (compact->compaction->ShouldStopBefore(key) &&
2592
        compact->builder != nullptr) {
D
Danny Guo 已提交
2593
      status = FinishCompactionOutputFile(compact, input);
2594 2595 2596 2597 2598 2599
      if (!status.ok()) {
        break;
      }
    }

    // Handle key/value, add to state, etc.
J
jorlow@chromium.org 已提交
2600
    bool drop = false;
2601
    bool current_entry_is_merging = false;
J
jorlow@chromium.org 已提交
2602 2603
    if (!ParseInternalKey(key, &ikey)) {
      // Do not hide error keys
2604 2605
      // 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.
J
jorlow@chromium.org 已提交
2606 2607 2608
      current_user_key.clear();
      has_current_user_key = false;
      last_sequence_for_key = kMaxSequenceNumber;
2609
      visible_in_snapshot = kMaxSequenceNumber;
J
jorlow@chromium.org 已提交
2610 2611
    } else {
      if (!has_current_user_key ||
2612 2613
          cfd->user_comparator()->Compare(ikey.user_key,
                                          Slice(current_user_key)) != 0) {
J
jorlow@chromium.org 已提交
2614 2615 2616 2617
        // First occurrence of this user key
        current_user_key.assign(ikey.user_key.data(), ikey.user_key.size());
        has_current_user_key = true;
        last_sequence_for_key = kMaxSequenceNumber;
2618
        visible_in_snapshot = kMaxSequenceNumber;
H
Haobo Xu 已提交
2619
        // apply the compaction filter to the first occurrence of the user key
D
Danny Guo 已提交
2620
        if (compaction_filter && !is_compaction_v2 &&
H
Haobo Xu 已提交
2621 2622 2623 2624 2625 2626 2627 2628 2629
            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 已提交
2630 2631 2632
          bool to_delete = compaction_filter->Filter(
              compact->compaction->level(), ikey.user_key, value,
              &compaction_filter_value, &value_changed);
H
Haobo Xu 已提交
2633 2634 2635 2636 2637
          if (to_delete) {
            // make a copy of the original key
            delete_key.assign(key.data(), key.data() + key.size());
            // convert it to a delete
            UpdateInternalKey(&delete_key[0], delete_key.size(),
D
Danny Guo 已提交
2638
                ikey.sequence, kTypeDeletion);
H
Haobo Xu 已提交
2639 2640 2641 2642 2643 2644
            // anchor the key again
            key = Slice(&delete_key[0], delete_key.size());
            // needed because ikey is backed by key
            ParseInternalKey(key, &ikey);
            // no value associated with delete
            value.clear();
2645
            RecordTick(options_.statistics.get(), COMPACTION_KEY_DROP_USER);
H
Haobo Xu 已提交
2646 2647 2648 2649
          } else if (value_changed) {
            value = compaction_filter_value;
          }
        }
J
jorlow@chromium.org 已提交
2650 2651
      }

2652 2653 2654
      // 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.
2655 2656 2657 2658
      SequenceNumber prev_snapshot = 0; // 0 means no previous snapshot
      SequenceNumber visible = visible_at_tip ?
        visible_at_tip :
        findEarliestVisibleSnapshot(ikey.sequence,
D
Danny Guo 已提交
2659 2660
            compact->existing_snapshots,
            &prev_snapshot);
2661 2662 2663 2664 2665

      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 已提交
2666
        // Hidden by an newer entry for same user key
2667
        // TODO: why not > ?
2668
        assert(last_sequence_for_key >= ikey.sequence);
J
jorlow@chromium.org 已提交
2669
        drop = true;    // (A)
2670
        RecordTick(options_.statistics.get(), COMPACTION_KEY_DROP_NEWER_ENTRY);
J
jorlow@chromium.org 已提交
2671
      } else if (ikey.type == kTypeDeletion &&
D
Danny Guo 已提交
2672 2673
          ikey.sequence <= earliest_snapshot &&
          compact->compaction->IsBaseLevelForKey(ikey.user_key)) {
J
jorlow@chromium.org 已提交
2674 2675 2676 2677 2678 2679 2680 2681
        // 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;
2682
        RecordTick(options_.statistics.get(), COMPACTION_KEY_DROP_OBSOLETE);
2683 2684 2685 2686 2687 2688 2689
      } else if (ikey.type == kTypeMerge) {
        // 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 已提交
2690 2691 2692 2693 2694 2695
        int steps = 0;
        merge.MergeUntil(input, prev_snapshot, bottommost_level,
            options_.statistics.get(), &steps);
        // Skip the Merge ops
        combined_idx = combined_idx - 1 + steps;

2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713
        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 已提交
2714 2715 2716
      }

      last_sequence_for_key = ikey.sequence;
2717
      visible_in_snapshot = visible;
J
jorlow@chromium.org 已提交
2718 2719
    }
#if 0
2720
    Log(options_.info_log,
J
jorlow@chromium.org 已提交
2721
        "  Compact: %s, seq %d, type: %d %d, drop: %d, is_base: %d, "
2722
        "%d smallest_snapshot: %d level: %d bottommost %d",
J
jorlow@chromium.org 已提交
2723
        ikey.user_key.ToString().c_str(),
D
dgrogan@chromium.org 已提交
2724
        (int)ikey.sequence, ikey.type, kTypeValue, drop,
J
jorlow@chromium.org 已提交
2725
        compact->compaction->IsBaseLevelForKey(ikey.user_key),
2726 2727
        (int)last_sequence_for_key, (int)earliest_snapshot,
        compact->compaction->level(), bottommost_level);
J
jorlow@chromium.org 已提交
2728 2729 2730
#endif

    if (!drop) {
2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746
      // 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);
2747
      }
2748

2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759
      // 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.
2760
        if (bottommost_level && ikey.sequence < earliest_snapshot &&
2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771
            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
2772

2773 2774 2775 2776 2777 2778 2779
        // Open output file if necessary
        if (compact->builder == nullptr) {
          status = OpenCompactionOutputFile(compact);
          if (!status.ok()) {
            break;
          }
        }
2780 2781

        SequenceNumber seqno = GetInternalKeySeqno(newkey);
2782 2783
        if (compact->builder->NumEntries() == 0) {
          compact->current_output()->smallest.DecodeFrom(newkey);
2784 2785 2786 2787
          compact->current_output()->smallest_seqno = seqno;
        } else {
          compact->current_output()->smallest_seqno =
            std::min(compact->current_output()->smallest_seqno, seqno);
2788 2789 2790
        }
        compact->current_output()->largest.DecodeFrom(newkey);
        compact->builder->Add(newkey, value);
2791 2792
        compact->current_output()->largest_seqno =
          std::max(compact->current_output()->largest_seqno, seqno);
2793 2794 2795 2796

        // Close output file if it is big enough
        if (compact->builder->FileSize() >=
            compact->compaction->MaxOutputFileSize()) {
D
Danny Guo 已提交
2797
          status = FinishCompactionOutputFile(compact, input);
2798 2799 2800
          if (!status.ok()) {
            break;
          }
J
jorlow@chromium.org 已提交
2801 2802
        }

2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822
        // 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 已提交
2823 2824 2825 2826 2827
          break;
        }
      }
    }

2828
    // MergeUntil has moved input to the next entry
2829
    if (!current_entry_is_merging) {
2830 2831
      input->Next();
    }
J
jorlow@chromium.org 已提交
2832 2833
  }

D
Danny Guo 已提交
2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 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
  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();
      RecordTick(options_.statistics.get(), COMPACTION_KEY_DROP_USER);
    } 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();
2894
  bool prefix_initialized = false;
D
Danny Guo 已提交
2895 2896

  int64_t imm_micros = 0;  // Micros spent doing imm_ compactions
2897
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
2898 2899
  LogToBuffer(
      log_buffer,
2900 2901 2902 2903
      "[CF %u] Compacting %d@%d + %d@%d files, score %.2f slots available %d",
      cfd->GetID(), compact->compaction->num_input_files(0),
      compact->compaction->level(), compact->compaction->num_input_files(1),
      compact->compaction->output_level(), compact->compaction->score(),
D
Danny Guo 已提交
2904 2905 2906
      options_.max_background_compactions - bg_compaction_scheduled_);
  char scratch[2345];
  compact->compaction->Summary(scratch, sizeof(scratch));
2907
  LogToBuffer(log_buffer, "Compaction start summary: %s\n", scratch);
D
Danny Guo 已提交
2908

2909
  assert(cfd->current()->NumLevelFiles(compact->compaction->level()) > 0);
D
Danny Guo 已提交
2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936
  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);

  // Release mutex while we're actually doing the compaction work
  mutex_.Unlock();
2937
  log_buffer->FlushBufferToLog();
D
Danny Guo 已提交
2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951

  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 =
2952 2953
      cfd->options()->compaction_filter_factory_v2->CreateCompactionFilterV2(
          context);
D
Danny Guo 已提交
2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964
  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) {
2965 2966
    while (backup_input->Valid() && !shutting_down_.Acquire_Load() &&
           !cfd->IsDropped()) {
D
Danny Guo 已提交
2967 2968 2969 2970
      Slice key = backup_input->key();
      Slice value = backup_input->value();

      const SliceTransform* transformer =
2971
          cfd->options()->compaction_filter_factory_v2->GetPrefixExtractor();
D
Danny Guo 已提交
2972
      std::string key_prefix = transformer->Transform(key).ToString();
2973
      if (!prefix_initialized) {
D
Danny Guo 已提交
2974
        compact->cur_prefix_ = key_prefix;
2975
        prefix_initialized = true;
D
Danny Guo 已提交
2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009
      }
      if (!ParseInternalKey(key, &ikey)) {
        // log error
        Log(options_.info_log, "Failed to parse key: %s",
            key.ToString().c_str());
        continue;
      } else {
        // If the prefix remains the same, keep buffering
        if (key_prefix == compact->cur_prefix_) {
          // 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);
          }
          compact->cur_prefix_ = key_prefix;
        }
      }

      // Merge this batch of data (values + ineligible keys)
3010
      compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046

      // Done buffering for the current prefix. Spit it out to disk
      // Now just iterate through all the kv-pairs
      status = ProcessKeyValueCompaction(
          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);
        }
3047
        compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068

        status = ProcessKeyValueCompaction(
            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);
    }
3069
    compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096
    status = ProcessKeyValueCompaction(
        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(
      visible_at_tip,
      earliest_snapshot,
      latest_snapshot,
      deletion_state,
      bottommost_level,
      imm_micros,
      input.get(),
      compact,
      false,
      log_buffer);
  }

3097
  if (status.ok() && (shutting_down_.Acquire_Load() || cfd->IsDropped())) {
L
Lei Jin 已提交
3098
    status = Status::ShutdownInProgress(
3099
        "Database shutdown or Column family drop during compaction");
J
jorlow@chromium.org 已提交
3100
  }
3101
  if (status.ok() && compact->builder != nullptr) {
3102
    status = FinishCompactionOutputFile(compact, input.get());
J
jorlow@chromium.org 已提交
3103 3104 3105 3106
  }
  if (status.ok()) {
    status = input->status();
  }
3107
  input.reset();
J
jorlow@chromium.org 已提交
3108

3109 3110 3111
  if (!options_.disableDataSync) {
    db_directory_->Fsync();
  }
I
Igor Canadi 已提交
3112 3113

  InternalStats::CompactionStats stats;
3114
  stats.micros = env_->NowMicros() - start_micros - imm_micros;
I
Igor Canadi 已提交
3115
  MeasureTime(options_.statistics.get(), COMPACTION_TIME, stats.micros);
M
Mark Callaghan 已提交
3116 3117
  stats.files_in_leveln = compact->compaction->num_input_files(0);
  stats.files_in_levelnp1 = compact->compaction->num_input_files(1);
3118 3119

  int num_output_files = compact->outputs.size();
3120
  if (compact->builder != nullptr) {
P
Pascal Borreli 已提交
3121
    // An error occurred so ignore the last output.
3122 3123 3124 3125
    assert(num_output_files > 0);
    --num_output_files;
  }
  stats.files_out_levelnp1 = num_output_files;
M
Mark Callaghan 已提交
3126

3127
  for (int i = 0; i < compact->compaction->num_input_files(0); i++) {
M
Mark Callaghan 已提交
3128
    stats.bytes_readn += compact->compaction->input(0, i)->file_size;
3129 3130 3131
    RecordTick(options_.statistics.get(), COMPACT_READ_BYTES,
               compact->compaction->input(0, i)->file_size);
  }
M
Mark Callaghan 已提交
3132

3133
  for (int i = 0; i < compact->compaction->num_input_files(1); i++) {
M
Mark Callaghan 已提交
3134
    stats.bytes_readnp1 += compact->compaction->input(1, i)->file_size;
3135 3136 3137
    RecordTick(options_.statistics.get(), COMPACT_READ_BYTES,
               compact->compaction->input(1, i)->file_size);
  }
M
Mark Callaghan 已提交
3138

3139
  for (int i = 0; i < num_output_files; i++) {
3140
    stats.bytes_written += compact->outputs[i].file_size;
3141 3142
    RecordTick(options_.statistics.get(), COMPACT_WRITE_BYTES,
               compact->outputs[i].file_size);
3143 3144
  }

I
Igor Canadi 已提交
3145
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
3146
  mutex_.Lock();
3147 3148
  cfd->internal_stats()->AddCompactionStats(compact->compaction->output_level(),
                                            stats);
J
jorlow@chromium.org 已提交
3149

3150 3151 3152 3153
  // 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 已提交
3154
  if (status.ok()) {
3155
    status = InstallCompactionResults(compact, log_buffer);
I
Igor Canadi 已提交
3156
    InstallSuperVersion(cfd, deletion_state);
J
jorlow@chromium.org 已提交
3157
  }
3158
  Version::LevelSummaryStorage tmp;
3159 3160
  LogToBuffer(
      log_buffer,
M
Mark Callaghan 已提交
3161
      "compacted to: %s, %.1f MB/sec, level %d, files in(%d, %d) out(%d) "
3162 3163
      "MB in(%.1f, %.1f) out(%.1f), read-write-amplify(%.1f) "
      "write-amplify(%.1f) %s\n",
3164
      cfd->current()->LevelSummary(&tmp),
M
Mark Callaghan 已提交
3165
      (stats.bytes_readn + stats.bytes_readnp1 + stats.bytes_written) /
3166 3167 3168 3169
          (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 已提交
3170
      stats.bytes_written / 1048576.0,
3171
      (stats.bytes_written + stats.bytes_readnp1 + stats.bytes_readn) /
3172 3173
          (double)stats.bytes_readn,
      stats.bytes_written / (double)stats.bytes_readn,
3174
      status.ToString().c_str());
M
Mark Callaghan 已提交
3175

J
jorlow@chromium.org 已提交
3176 3177 3178
  return status;
}

3179 3180
namespace {
struct IterState {
3181 3182
  IterState(DBImpl* db, port::Mutex* mu, SuperVersion* super_version)
      : db(db), mu(mu), super_version(super_version) {}
3183 3184

  DBImpl* db;
3185
  port::Mutex* mu;
3186
  SuperVersion* super_version;
3187 3188 3189 3190
};

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

  bool need_cleanup = state->super_version->Unref();
  if (need_cleanup) {
3194 3195
    DBImpl::DeletionState deletion_state;

3196 3197 3198 3199 3200 3201
    state->mu->Lock();
    state->super_version->Cleanup();
    state->db->FindObsoleteFiles(deletion_state, false, true);
    state->mu->Unlock();

    delete state->super_version;
3202 3203 3204
    if (deletion_state.HaveSomethingToDelete()) {
      state->db->PurgeObsoleteFiles(deletion_state);
    }
I
Igor Canadi 已提交
3205
  }
T
Tomislav Novak 已提交
3206

3207 3208
  delete state;
}
H
Hans Wennborg 已提交
3209
}  // namespace
3210

J
jorlow@chromium.org 已提交
3211
Iterator* DBImpl::NewInternalIterator(const ReadOptions& options,
3212 3213
                                      ColumnFamilyData* cfd,
                                      SuperVersion* super_version) {
I
Igor Canadi 已提交
3214
  std::vector<Iterator*> iterator_list;
3215 3216
  // Collect iterator for mutable mem
  iterator_list.push_back(super_version->mem->NewIterator(options));
T
Tomislav Novak 已提交
3217
  // Collect all needed child iterators for immutable memtables
3218
  super_version->imm->AddIterators(options, &iterator_list);
T
Tomislav Novak 已提交
3219
  // Collect iterators for files in L0 - Ln
3220 3221
  super_version->current->AddIterators(options, storage_options_,
                                       &iterator_list);
3222 3223 3224
  Iterator* internal_iter =
      NewMergingIterator(env_, &cfd->internal_comparator(), &iterator_list[0],
                         iterator_list.size());
3225 3226

  IterState* cleanup = new IterState(this, &mutex_, super_version);
3227
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
3228 3229 3230 3231

  return internal_iter;
}

3232 3233 3234 3235
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

3236 3237 3238 3239 3240 3241 3242 3243 3244
Iterator* DBImpl::TEST_NewInternalIterator(ColumnFamilyHandle* column_family) {
  ColumnFamilyData* cfd;
  if (column_family == nullptr) {
    cfd = default_cf_handle_->cfd();
  } else {
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
    cfd = cfh->cfd();
  }

3245
  mutex_.Lock();
3246
  SuperVersion* super_version = cfd->GetSuperVersion()->Ref();
3247
  mutex_.Unlock();
I
Igor Canadi 已提交
3248 3249 3250
  ReadOptions roptions;
  roptions.prefix_seek = true;
  return NewInternalIterator(roptions, cfd, super_version);
J
jorlow@chromium.org 已提交
3251 3252
}

T
Tomislav Novak 已提交
3253
std::pair<Iterator*, Iterator*> DBImpl::GetTailingIteratorPair(
3254
    const ReadOptions& options, ColumnFamilyData* cfd,
T
Tomislav Novak 已提交
3255 3256 3257
    uint64_t* superversion_number) {

  mutex_.Lock();
3258
  SuperVersion* super_version = cfd->GetSuperVersion()->Ref();
T
Tomislav Novak 已提交
3259
  if (superversion_number != nullptr) {
3260
    *superversion_number = cfd->GetSuperVersionNumber();
T
Tomislav Novak 已提交
3261 3262 3263
  }
  mutex_.Unlock();

3264
  Iterator* mutable_iter = super_version->mem->NewIterator(options);
T
Tomislav Novak 已提交
3265
  // create a DBIter that only uses memtable content; see NewIterator()
I
Igor Canadi 已提交
3266
  mutable_iter =
I
Igor Canadi 已提交
3267 3268
      NewDBIterator(&dbname_, env_, *cfd->options(), cfd->user_comparator(),
                    mutable_iter, kMaxSequenceNumber);
T
Tomislav Novak 已提交
3269 3270

  std::vector<Iterator*> list;
3271 3272
  super_version->imm->AddIterators(options, &list);
  super_version->current->AddIterators(options, storage_options_, &list);
3273 3274
  Iterator* immutable_iter = NewMergingIterator(
      env_, &cfd->internal_comparator(), &list[0], list.size());
T
Tomislav Novak 已提交
3275 3276

  // create a DBIter that only uses memtable content; see NewIterator()
3277
  immutable_iter =
I
Igor Canadi 已提交
3278 3279
      NewDBIterator(&dbname_, env_, *cfd->options(), cfd->user_comparator(),
                    immutable_iter, kMaxSequenceNumber);
T
Tomislav Novak 已提交
3280

3281 3282 3283 3284 3285 3286 3287 3288
  // register cleanups
  mutable_iter->RegisterCleanup(CleanupIteratorState,
    new IterState(this, &mutex_, super_version), nullptr);

  // bump the ref one more time since it will be Unref'ed twice
  immutable_iter->RegisterCleanup(CleanupIteratorState,
    new IterState(this, &mutex_, super_version->Ref()), nullptr);

T
Tomislav Novak 已提交
3289 3290 3291
  return std::make_pair(mutable_iter, immutable_iter);
}

3292 3293 3294 3295 3296 3297 3298 3299 3300
int64_t DBImpl::TEST_MaxNextLevelOverlappingBytes(
    ColumnFamilyHandle* column_family) {
  ColumnFamilyData* cfd;
  if (column_family == nullptr) {
    cfd = default_cf_handle_->cfd();
  } else {
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
    cfd = cfh->cfd();
  }
3301
  MutexLock l(&mutex_);
3302
  return cfd->current()->MaxNextLevelOverlappingBytes();
3303 3304
}

J
jorlow@chromium.org 已提交
3305
Status DBImpl::Get(const ReadOptions& options,
3306
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3307
                   std::string* value) {
3308
  return GetImpl(options, column_family, key, value);
3309 3310
}

I
Igor Canadi 已提交
3311 3312 3313
// DeletionState gets created and destructed outside of the lock -- we
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3314
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3315 3316 3317 3318 3319 3320
//
// 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
3321 3322
void DBImpl::InstallSuperVersion(ColumnFamilyData* cfd,
                                 DeletionState& deletion_state) {
3323
  mutex_.AssertHeld();
I
Igor Canadi 已提交
3324 3325 3326 3327
  // if new_superversion == nullptr, it means somebody already used it
  SuperVersion* new_superversion =
    (deletion_state.new_superversion != nullptr) ?
    deletion_state.new_superversion : new SuperVersion();
3328 3329
  SuperVersion* old_superversion =
      cfd->InstallSuperVersion(new_superversion, &mutex_);
I
Igor Canadi 已提交
3330
  deletion_state.new_superversion = nullptr;
3331
  deletion_state.superversions_to_free.push_back(old_superversion);
3332 3333
  // Reset SuperVersions cached in thread local storage
  if (options_.allow_thread_local) {
3334
    cfd->ResetThreadLocalSuperVersions();
3335
  }
I
Igor Canadi 已提交
3336 3337
}

3338
Status DBImpl::GetImpl(const ReadOptions& options,
3339 3340
                       ColumnFamilyHandle* column_family, const Slice& key,
                       std::string* value, bool* value_found) {
3341
  StopWatch sw(env_, options_.statistics.get(), DB_GET, false);
3342 3343
  StopWatchNano snapshot_timer(env_, false);
  StartPerfTimer(&snapshot_timer);
3344

3345 3346 3347
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3348
  SequenceNumber snapshot;
3349
  if (options.snapshot != nullptr) {
3350 3351 3352
    snapshot = reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_;
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3353
  }
3354

3355 3356
  // Acquire SuperVersion
  SuperVersion* sv = nullptr;
3357
  ThreadLocalPtr* thread_local_sv = nullptr;
3358 3359 3360 3361 3362 3363 3364 3365
  if (LIKELY(options_.allow_thread_local)) {
    // The SuperVersion is cached in thread local storage to avoid acquiring
    // mutex when SuperVersion does not change since the last use. When a new
    // SuperVersion is installed, the compaction or flush thread cleans up
    // cached SuperVersion in all existing thread local storage. To avoid
    // acquiring mutex for this operation, we use atomic Swap() on the thread
    // local pointer to guarantee exclusive access. If the thread local pointer
    // is being used while a new SuperVersion is installed, the cached
3366 3367 3368 3369
    // SuperVersion can become stale. In that case, the background thread would
    // have swapped in kSVObsolete. We re-check the value at the end of
    // Get, with an atomic compare and swap. The superversion will be released
    // if detected to be stale.
3370 3371
    thread_local_sv = cfd->GetThreadLocalSuperVersion();
    void* ptr = thread_local_sv->Swap(SuperVersion::kSVInUse);
3372 3373 3374 3375 3376 3377 3378
    // Invariant:
    // (1) Scrape (always) installs kSVObsolete in ThreadLocal storage
    // (2) the Swap above (always) installs kSVInUse, ThreadLocal storage
    // should only keep kSVInUse during a GetImpl.
    assert(ptr != SuperVersion::kSVInUse);
    sv = static_cast<SuperVersion*>(ptr);
    if (sv == SuperVersion::kSVObsolete ||
3379
        sv->version_number != cfd->GetSuperVersionNumber()) {
3380
      RecordTick(options_.statistics.get(), NUMBER_SUPERVERSION_ACQUIRES);
3381 3382 3383
      SuperVersion* sv_to_delete = nullptr;

      if (sv && sv->Unref()) {
3384
        RecordTick(options_.statistics.get(), NUMBER_SUPERVERSION_CLEANUPS);
3385
        mutex_.Lock();
3386 3387
        // TODO underlying resources held by superversion (sst files) might
        // not be released until the next background job.
3388 3389 3390 3391 3392
        sv->Cleanup();
        sv_to_delete = sv;
      } else {
        mutex_.Lock();
      }
3393
      sv = cfd->GetSuperVersion()->Ref();
3394 3395 3396 3397 3398 3399
      mutex_.Unlock();

      delete sv_to_delete;
    }
  } else {
    mutex_.Lock();
3400
    sv = cfd->GetSuperVersion()->Ref();
3401 3402
    mutex_.Unlock();
  }
I
Igor Canadi 已提交
3403

3404
  bool have_stat_update = false;
3405
  Version::GetStats stats;
3406

3407
  // Prepare to store a list of merge operations if merge occurs.
3408
  MergeContext merge_context;
3409

3410
  Status s;
3411
  // First look in the memtable, then in the immutable memtable (if any).
3412
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3413
  // merge_operands will contain the sequence of merges in the latter case.
3414
  LookupKey lkey(key, snapshot);
3415
  BumpPerfTime(&perf_context.get_snapshot_time, &snapshot_timer);
I
Igor Canadi 已提交
3416
  if (sv->mem->Get(lkey, value, &s, merge_context, *cfd->options())) {
3417
    // Done
3418
    RecordTick(options_.statistics.get(), MEMTABLE_HIT);
I
Igor Canadi 已提交
3419
  } else if (sv->imm->Get(lkey, value, &s, merge_context, *cfd->options())) {
3420
    // Done
3421
    RecordTick(options_.statistics.get(), MEMTABLE_HIT);
3422
  } else {
3423
    // Done
3424 3425 3426
    StopWatchNano from_files_timer(env_, false);
    StartPerfTimer(&from_files_timer);

3427
    sv->current->Get(options, lkey, value, &s, &merge_context, &stats,
I
Igor Canadi 已提交
3428
                     *cfd->options(), value_found);
3429
    have_stat_update = true;
3430
    BumpPerfTime(&perf_context.get_from_output_files_time, &from_files_timer);
3431
    RecordTick(options_.statistics.get(), MEMTABLE_MISS);
3432
  }
3433

3434 3435
  StopWatchNano post_process_timer(env_, false);
  StartPerfTimer(&post_process_timer);
3436

I
Igor Canadi 已提交
3437
  if (!cfd->options()->disable_seek_compaction && have_stat_update) {
I
Igor Canadi 已提交
3438
    mutex_.Lock();
3439
    if (sv->current->UpdateStats(stats)) {
I
Igor Canadi 已提交
3440 3441 3442
      MaybeScheduleFlushOrCompaction();
    }
    mutex_.Unlock();
3443 3444
  }

3445
  bool unref_sv = true;
3446 3447
  if (LIKELY(options_.allow_thread_local)) {
    // Put the SuperVersion back
3448
    void* expected = SuperVersion::kSVInUse;
3449
    if (thread_local_sv->CompareAndSwap(static_cast<void*>(sv), expected)) {
3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463
      // When we see kSVInUse in the ThreadLocal, we are sure ThreadLocal
      // storage has not been altered and no Scrape has happend. The
      // SuperVersion is still current.
      unref_sv = false;
    } else {
      // ThreadLocal scrape happened in the process of this GetImpl call (after
      // thread local Swap() at the beginning and before CompareAndSwap()).
      // This means the SuperVersion it holds is obsolete.
      assert(expected == SuperVersion::kSVObsolete);
    }
  }

  if (unref_sv) {
    // Release SuperVersion
3464
    if (sv->Unref()) {
I
Igor Canadi 已提交
3465
      mutex_.Lock();
3466
      sv->Cleanup();
I
Igor Canadi 已提交
3467
      mutex_.Unlock();
3468
      delete sv;
3469
      RecordTick(options_.statistics.get(), NUMBER_SUPERVERSION_CLEANUPS);
I
Igor Canadi 已提交
3470
    }
3471
    RecordTick(options_.statistics.get(), NUMBER_SUPERVERSION_RELEASES);
3472
  }
3473

3474 3475
  RecordTick(options_.statistics.get(), NUMBER_KEYS_READ);
  RecordTick(options_.statistics.get(), BYTES_READ, value->size());
K
Kai Liu 已提交
3476
  BumpPerfTime(&perf_context.get_post_process_time, &post_process_timer);
3477
  return s;
J
jorlow@chromium.org 已提交
3478 3479
}

3480 3481
std::vector<Status> DBImpl::MultiGet(
    const ReadOptions& options,
3482
    const std::vector<ColumnFamilyHandle*>& column_family,
3483
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3484

3485
  StopWatch sw(env_, options_.statistics.get(), DB_MULTIGET, false);
3486 3487
  StopWatchNano snapshot_timer(env_, false);
  StartPerfTimer(&snapshot_timer);
K
Kai Liu 已提交
3488

3489
  SequenceNumber snapshot;
3490

3491
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3492
    ColumnFamilyData* cfd;
3493 3494 3495 3496 3497 3498 3499
    SuperVersion* super_version;
    Version::GetStats stats;
    bool have_stat_update = false;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3500 3501 3502 3503 3504 3505
    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});
3506 3507 3508
    }
  }

3509
  mutex_.Lock();
3510 3511 3512 3513 3514
  if (options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_;
  } else {
    snapshot = versions_->LastSequence();
  }
3515
  for (auto mgd_iter : multiget_cf_data) {
3516 3517
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3518
  }
3519
  mutex_.Unlock();
3520

3521 3522
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3523

3524
  // Note: this always resizes the values array
3525 3526 3527
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3528 3529

  // Keep track of bytes that we read for statistics-recording later
3530
  uint64_t bytes_read = 0;
3531
  BumpPerfTime(&perf_context.get_snapshot_time, &snapshot_timer);
3532 3533 3534 3535

  // 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.
3536
  // merge_operands will contain the sequence of merges in the latter case.
3537
  for (size_t i = 0; i < num_keys; ++i) {
3538
    merge_context.Clear();
3539
    Status& s = stat_list[i];
3540 3541 3542
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3543 3544
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3545 3546 3547
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
I
Igor Canadi 已提交
3548 3549
    auto cfd = mgd->cfd;
    if (super_version->mem->Get(lkey, value, &s, merge_context,
I
Igor Canadi 已提交
3550
                                *cfd->options())) {
3551
      // Done
3552
    } else if (super_version->imm->Get(lkey, value, &s, merge_context,
I
Igor Canadi 已提交
3553
                                       *cfd->options())) {
3554 3555
      // Done
    } else {
3556
      super_version->current->Get(options, lkey, value, &s, &merge_context,
I
Igor Canadi 已提交
3557
                                  &mgd->stats, *cfd->options());
3558
      mgd->have_stat_update = true;
3559 3560 3561
    }

    if (s.ok()) {
3562
      bytes_read += value->size();
3563 3564 3565 3566
    }
  }

  // Post processing (decrement reference counts and record statistics)
3567 3568
  StopWatchNano post_process_timer(env_, false);
  StartPerfTimer(&post_process_timer);
3569 3570 3571 3572 3573 3574
  autovector<SuperVersion*> superversions_to_delete;

  bool schedule_flush_or_compaction = false;
  mutex_.Lock();
  for (auto mgd_iter : multiget_cf_data) {
    auto mgd = mgd_iter.second;
I
Igor Canadi 已提交
3575 3576
    auto cfd = mgd->cfd;
    if (!cfd->options()->disable_seek_compaction && mgd->have_stat_update) {
3577 3578 3579
      if (mgd->super_version->current->UpdateStats(mgd->stats)) {
        schedule_flush_or_compaction = true;
      }
3580
    }
3581 3582 3583
    if (mgd->super_version->Unref()) {
      mgd->super_version->Cleanup();
      superversions_to_delete.push_back(mgd->super_version);
3584 3585
    }
  }
3586 3587 3588 3589 3590 3591 3592 3593 3594 3595
  if (schedule_flush_or_compaction) {
    MaybeScheduleFlushOrCompaction();
  }
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3596
  }
3597

3598
  RecordTick(options_.statistics.get(), NUMBER_MULTIGET_CALLS);
3599 3600
  RecordTick(options_.statistics.get(), NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(options_.statistics.get(), NUMBER_MULTIGET_BYTES_READ, bytes_read);
3601
  BumpPerfTime(&perf_context.get_post_process_time, &post_process_timer);
3602

3603
  return stat_list;
3604 3605
}

3606
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& options,
3607
                                  const std::string& column_family_name,
3608
                                  ColumnFamilyHandle** handle) {
I
Igor Canadi 已提交
3609 3610 3611
  *handle = nullptr;
  MutexLock l(&mutex_);

I
Igor Canadi 已提交
3612 3613
  if (versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name) !=
      nullptr) {
I
Igor Canadi 已提交
3614 3615
    return Status::InvalidArgument("Column family already exists");
  }
3616
  VersionEdit edit;
3617
  edit.AddColumnFamily(column_family_name);
3618 3619
  uint32_t new_id = versions_->GetColumnFamilySet()->GetNextColumnFamilyID();
  edit.SetColumnFamily(new_id);
I
Igor Canadi 已提交
3620
  edit.SetLogNumber(logfile_number_);
I
Igor Canadi 已提交
3621
  edit.SetComparatorName(options.comparator->Name());
3622

I
Igor Canadi 已提交
3623 3624
  // LogAndApply will both write the creation in MANIFEST and create
  // ColumnFamilyData object
3625 3626
  Status s = versions_->LogAndApply(nullptr, &edit, &mutex_,
                                    db_directory_.get(), false, &options);
3627
  if (s.ok()) {
3628 3629 3630
    auto cfd =
        versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
    assert(cfd != nullptr);
3631
    delete cfd->InstallSuperVersion(new SuperVersion(), &mutex_);
3632
    *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
3633 3634 3635 3636 3637 3638
    Log(options_.info_log, "Created column family \"%s\" (ID %u)",
        column_family_name.c_str(), (unsigned)cfd->GetID());
  } else {
    Log(options_.info_log, "Creating column family \"%s\" FAILED -- %s",
        column_family_name.c_str(), s.ToString().c_str());
  }
3639
  return s;
3640 3641
}

3642 3643 3644 3645
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3646 3647
    return Status::InvalidArgument("Can't drop default column family");
  }
3648

I
Igor Canadi 已提交
3649 3650
  VersionEdit edit;
  edit.DropColumnFamily();
3651 3652
  edit.SetColumnFamily(cfd->GetID());

3653
  Status s;
3654 3655 3656 3657 3658 3659 3660 3661
  {
    MutexLock l(&mutex_);
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
      s = versions_->LogAndApply(cfd, &edit, &mutex_);
    }
3662
  }
3663

3664
  if (s.ok()) {
I
Igor Canadi 已提交
3665
    assert(cfd->IsDropped());
3666
    Log(options_.info_log, "Dropped column family with id %u\n", cfd->GetID());
3667
    // Flush the memtables. This will make all WAL files referencing dropped
I
Igor Canadi 已提交
3668
    // column family to be obsolete. They will be deleted once user deletes
3669 3670
    // column family handle
    Write(WriteOptions(), nullptr);  // ignore error
3671 3672 3673 3674 3675
  } else {
    Log(options_.info_log, "Dropping column family with id %u FAILED -- %s\n",
        cfd->GetID(), s.ToString().c_str());
  }

3676
  return s;
3677 3678
}

3679
bool DBImpl::KeyMayExist(const ReadOptions& options,
3680 3681
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
3682
  if (value_found != nullptr) {
K
Kai Liu 已提交
3683 3684
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
3685
  }
3686 3687
  ReadOptions roptions = options;
  roptions.read_tier = kBlockCacheTier; // read from block cache only
3688
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
3689 3690 3691 3692 3693

  // 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();
3694 3695
}

3696
Iterator* DBImpl::NewIterator(const ReadOptions& options,
3697
                              ColumnFamilyHandle* column_family) {
3698 3699
  SequenceNumber latest_snapshot = 0;
  SuperVersion* super_version = nullptr;
3700 3701
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
3702
  if (!options.tailing) {
I
Igor Canadi 已提交
3703
    mutex_.Lock();
3704 3705
    super_version = cfd->GetSuperVersion()->Ref();
    latest_snapshot = versions_->LastSequence();
I
Igor Canadi 已提交
3706
    mutex_.Unlock();
3707
  }
T
Tomislav Novak 已提交
3708

3709
  Iterator* iter;
T
Tomislav Novak 已提交
3710
  if (options.tailing) {
3711
    iter = new TailingIterator(this, options, cfd);
T
Tomislav Novak 已提交
3712
  } else {
3713
    iter = NewInternalIterator(options, cfd, super_version);
T
Tomislav Novak 已提交
3714

I
Igor Canadi 已提交
3715 3716 3717 3718
    auto snapshot =
        options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_
            : latest_snapshot;
I
Igor Canadi 已提交
3719
    iter = NewDBIterator(&dbname_, env_, *cfd->options(),
I
Igor Canadi 已提交
3720
                         cfd->user_comparator(), iter, snapshot);
T
Tomislav Novak 已提交
3721 3722
  }

T
Tyler Harter 已提交
3723 3724 3725 3726
  if (options.prefix) {
    // use extra wrapper to exclude any keys from the results which
    // don't begin with the prefix
    iter = new PrefixFilterIterator(iter, *options.prefix,
3727
                                    cfd->options()->prefix_extractor.get());
T
Tyler Harter 已提交
3728 3729
  }
  return iter;
J
jorlow@chromium.org 已提交
3730 3731
}

3732 3733
Status DBImpl::NewIterators(
    const ReadOptions& options,
I
Igor Canadi 已提交
3734
    const std::vector<ColumnFamilyHandle*>& column_families,
3735
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773

  if (options.prefix) {
    return Status::NotSupported(
        "NewIterators doesn't support ReadOptions::prefix");
  }

  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) {
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
      iterators->push_back(new TailingIterator(this, options, cfd));
    }
  } 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]);
I
Igor Canadi 已提交
3774
      iter = NewDBIterator(&dbname_, env_, *cfd->options(),
I
Igor Canadi 已提交
3775 3776 3777 3778 3779 3780
                           cfd->user_comparator(), iter, snapshot);
      iterators->push_back(iter);
    }
  }

  return Status::OK();
3781 3782
}

J
jorlow@chromium.org 已提交
3783 3784
const Snapshot* DBImpl::GetSnapshot() {
  MutexLock l(&mutex_);
3785
  return snapshots_.New(versions_->LastSequence());
J
jorlow@chromium.org 已提交
3786 3787 3788 3789
}

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

// Convenience methods
3794 3795
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
3796
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
3797 3798
}

3799 3800 3801 3802
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) {
3803 3804
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
3805
    return DB::Merge(o, column_family, key, val);
3806 3807 3808
  }
}

3809
Status DBImpl::Delete(const WriteOptions& options,
3810
                      ColumnFamilyHandle* column_family, const Slice& key) {
3811
  return DB::Delete(options, column_family, key);
J
jorlow@chromium.org 已提交
3812 3813
}

3814
Status DBImpl::Write(const WriteOptions& options, WriteBatch* my_batch) {
3815 3816
  StopWatchNano pre_post_process_timer(env_, false);
  StartPerfTimer(&pre_post_process_timer);
3817 3818 3819
  Writer w(&mutex_);
  w.batch = my_batch;
  w.sync = options.sync;
H
heyongqiang 已提交
3820
  w.disableWAL = options.disableWAL;
3821
  w.done = false;
3822

3823
  StopWatch sw(env_, options_.statistics.get(), DB_WRITE, false);
I
Igor Canadi 已提交
3824
  mutex_.Lock();
3825 3826 3827 3828
  writers_.push_back(&w);
  while (!w.done && &w != writers_.front()) {
    w.cv.Wait();
  }
3829 3830 3831 3832 3833

  if (!options.disableWAL) {
    RecordTick(options_.statistics.get(), WRITE_WITH_WAL, 1);
  }

3834
  if (w.done) {
I
Igor Canadi 已提交
3835
    mutex_.Unlock();
3836
    RecordTick(options_.statistics.get(), WRITE_DONE_BY_OTHER, 1);
3837
    return w.status;
3838 3839
  } else {
    RecordTick(options_.statistics.get(), WRITE_DONE_BY_SELF, 1);
3840 3841
  }

3842
  Status status;
3843 3844
  autovector<ColumnFamilyData*> to_delete;
  // refcounting cfd in iteration
3845
  for (auto cfd : *versions_->GetColumnFamilySet()) {
3846
    cfd->Ref();
3847 3848
    // May temporarily unlock and wait.
    status = MakeRoomForWrite(cfd, my_batch == nullptr);
3849 3850 3851
    if (cfd->Unref()) {
      to_delete.push_back(cfd);
    }
3852 3853 3854 3855
    if (!status.ok()) {
      break;
    }
  }
3856 3857 3858
  for (auto cfd : to_delete) {
    delete cfd;
  }
D
dgrogan@chromium.org 已提交
3859
  uint64_t last_sequence = versions_->LastSequence();
3860
  Writer* last_writer = &w;
3861
  if (status.ok() && my_batch != nullptr) {  // nullptr batch is for compactions
3862 3863
    autovector<WriteBatch*> write_batch_group;
    BuildBatchGroup(&last_writer, &write_batch_group);
3864

3865 3866 3867
    // 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
3868
    // into memtables
3869
    {
3870
      mutex_.Unlock();
3871 3872 3873 3874 3875 3876 3877 3878 3879 3880
      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]);
        }
      }

3881 3882 3883 3884 3885
      const SequenceNumber current_sequence = last_sequence + 1;
      WriteBatchInternal::SetSequence(updates, current_sequence);
      int my_batch_count = WriteBatchInternal::Count(updates);
      last_sequence += my_batch_count;
      // Record statistics
3886 3887 3888
      RecordTick(options_.statistics.get(),
                 NUMBER_KEYS_WRITTEN, my_batch_count);
      RecordTick(options_.statistics.get(),
3889 3890
                 BYTES_WRITTEN,
                 WriteBatchInternal::ByteSize(updates));
3891 3892
      if (options.disableWAL) {
        flush_on_destroy_ = true;
3893
      }
3894 3895
      BumpPerfTime(&perf_context.write_pre_and_post_process_time,
                   &pre_post_process_timer);
3896 3897

      if (!options.disableWAL) {
3898 3899
        StopWatchNano timer(env_);
        StartPerfTimer(&timer);
3900 3901 3902 3903
        Slice log_entry = WriteBatchInternal::Contents(updates);
        status = log_->AddRecord(log_entry);
        RecordTick(options_.statistics.get(), WAL_FILE_SYNCED, 1);
        RecordTick(options_.statistics.get(), WAL_FILE_BYTES, log_entry.size());
H
heyongqiang 已提交
3904
        if (status.ok() && options.sync) {
3905
          if (options_.use_fsync) {
3906
            StopWatch(env_, options_.statistics.get(), WAL_FILE_SYNC_MICROS);
3907
            status = log_->file()->Fsync();
3908
          } else {
3909
            StopWatch(env_, options_.statistics.get(), WAL_FILE_SYNC_MICROS);
3910
            status = log_->file()->Sync();
3911
          }
H
heyongqiang 已提交
3912
        }
3913
        BumpPerfTime(&perf_context.write_wal_time, &timer);
3914 3915
      }
      if (status.ok()) {
3916
        StopWatchNano write_memtable_timer(env_, false);
3917

3918
        StartPerfTimer(&write_memtable_timer);
3919
        status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
3920
            updates, column_family_memtables_.get(), false, 0, this, false);
3921
        BumpPerfTime(&perf_context.write_memtable_time, &write_memtable_timer);
3922

3923
        if (!status.ok()) {
3924 3925 3926
          // Iteration failed (either in-memory writebatch corruption (very
          // bad), or the client specified invalid column family). Return
          // failure.
3927 3928 3929
          // 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.
3930
          return status;
3931
        }
I
Igor Canadi 已提交
3932 3933
        SetTickerCount(options_.statistics.get(), SEQUENCE_NUMBER,
                       last_sequence);
3934
      }
3935
      StartPerfTimer(&pre_post_process_timer);
3936
      if (updates == &tmp_batch_) tmp_batch_.Clear();
3937 3938
      mutex_.Lock();
      if (status.ok()) {
3939
        versions_->SetLastSequence(last_sequence);
3940
      }
J
jorlow@chromium.org 已提交
3941 3942
    }
  }
I
Igor Canadi 已提交
3943 3944 3945
  if (options_.paranoid_checks && !status.ok() && bg_error_.ok()) {
    bg_error_ = status; // stop compaction & fail any further writes
  }
3946

3947 3948 3949 3950 3951 3952 3953
  while (true) {
    Writer* ready = writers_.front();
    writers_.pop_front();
    if (ready != &w) {
      ready->status = status;
      ready->done = true;
      ready->cv.Signal();
3954
    }
3955 3956
    if (ready == last_writer) break;
  }
3957

3958 3959 3960
  // Notify new head of write queue
  if (!writers_.empty()) {
    writers_.front()->cv.Signal();
3961
  }
I
Igor Canadi 已提交
3962
  mutex_.Unlock();
3963 3964
  BumpPerfTime(&perf_context.write_pre_and_post_process_time,
               &pre_post_process_timer);
J
jorlow@chromium.org 已提交
3965 3966 3967
  return status;
}

3968
// REQUIRES: Writer list must be non-empty
3969
// REQUIRES: First writer must have a non-nullptr batch
3970 3971
void DBImpl::BuildBatchGroup(Writer** last_writer,
                             autovector<WriteBatch*>* write_batch_group) {
3972 3973
  assert(!writers_.empty());
  Writer* first = writers_.front();
3974
  assert(first->batch != nullptr);
3975 3976

  size_t size = WriteBatchInternal::ByteSize(first->batch);
3977
  write_batch_group->push_back(first->batch);
3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996

  // 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 已提交
3997 3998 3999 4000 4001 4002
    if (!w->disableWAL && first->disableWAL) {
      // Do not include a write that needs WAL into a batch that has
      // WAL disabled.
      break;
    }

4003
    if (w->batch != nullptr) {
4004 4005 4006 4007 4008 4009
      size += WriteBatchInternal::ByteSize(w->batch);
      if (size > max_size) {
        // Do not make batch too big
        break;
      }

4010
      write_batch_group->push_back(w->batch);
4011 4012 4013 4014 4015
    }
    *last_writer = w;
  }
}

4016 4017 4018
// 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 已提交
4019 4020 4021 4022
// if n < bottom, return 0;
// if n >= top, return 1000;
// otherwise, let r = (n - bottom) /
//                    (top - bottom)
4023 4024 4025 4026
//  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 已提交
4027
uint64_t DBImpl::SlowdownAmount(int n, double bottom, double top) {
4028
  uint64_t delay;
J
Jim Paton 已提交
4029
  if (n >= top) {
4030 4031
    delay = 1000;
  }
J
Jim Paton 已提交
4032
  else if (n < bottom) {
4033 4034 4035 4036
    delay = 0;
  }
  else {
    // If we are here, we know that:
J
Jim Paton 已提交
4037
    //   level0_start_slowdown <= n < level0_slowdown
4038
    // since the previous two conditions are false.
M
Mark Callaghan 已提交
4039 4040
    double how_much =
      (double) (n - bottom) /
J
Jim Paton 已提交
4041
              (top - bottom);
M
Mark Callaghan 已提交
4042
    delay = std::max(how_much * how_much * 1000, 100.0);
4043 4044 4045 4046 4047
  }
  assert(delay <= 1000);
  return delay;
}

4048
// REQUIRES: mutex_ is held
4049
// REQUIRES: this thread is currently at the front of the writer queue
4050
Status DBImpl::MakeRoomForWrite(ColumnFamilyData* cfd, bool force) {
4051
  mutex_.AssertHeld();
4052
  assert(!writers_.empty());
4053
  bool allow_delay = !force;
J
Jim Paton 已提交
4054 4055
  bool allow_hard_rate_limit_delay = !force;
  bool allow_soft_rate_limit_delay = !force;
4056
  uint64_t rate_limit_delay_millis = 0;
4057
  Status s;
4058
  double score;
4059

4060 4061 4062 4063 4064
  while (true) {
    if (!bg_error_.ok()) {
      // Yield previous error
      s = bg_error_;
      break;
I
Igor Canadi 已提交
4065 4066
    } else if (cfd->IsDropped()) {
      break;
4067
    } else if (allow_delay && cfd->NeedSlowdownForNumLevel0Files()) {
4068 4069 4070
      // 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
4071
      // individual write by 0-1ms to reduce latency variance.  Also,
4072 4073
      // this delay hands over some CPU to the compaction thread in
      // case it is sharing the same core as the writer.
4074
      uint64_t slowdown =
4075 4076 4077
          SlowdownAmount(cfd->current()->NumLevelFiles(0),
                         cfd->options()->level0_slowdown_writes_trigger,
                         cfd->options()->level0_stop_writes_trigger);
4078
      mutex_.Unlock();
4079
      uint64_t delayed;
J
Jim Paton 已提交
4080
      {
4081
        StopWatch sw(env_, options_.statistics.get(), STALL_L0_SLOWDOWN_COUNT);
4082
        env_->SleepForMicroseconds(slowdown);
4083
        delayed = sw.ElapsedMicros();
J
Jim Paton 已提交
4084
      }
4085
      RecordTick(options_.statistics.get(), STALL_L0_SLOWDOWN_MICROS, delayed);
4086 4087
      cfd->internal_stats()->RecordWriteStall(InternalStats::LEVEL0_SLOWDOWN,
                                              delayed);
4088 4089
      allow_delay = false;  // Do not delay a single write more than once
      mutex_.Lock();
4090
      delayed_writes_++;
4091
    } else if (!force && !cfd->mem()->ShouldFlush()) {
4092
      // There is room in current memtable
4093 4094 4095
      if (allow_delay) {
        DelayLoggingAndReset();
      }
4096
      break;
4097 4098
    } else if (cfd->imm()->size() ==
               cfd->options()->max_write_buffer_number - 1) {
4099
      // We have filled up the current memtable, but the previous
4100
      // ones are still being flushed, so we wait.
4101
      DelayLoggingAndReset();
4102 4103
      Log(options_.info_log, "wait for memtable flush...\n");
      MaybeScheduleFlushOrCompaction();
4104
      uint64_t stall;
J
Jim Paton 已提交
4105
      {
4106
        StopWatch sw(env_, options_.statistics.get(),
4107
                     STALL_MEMTABLE_COMPACTION_COUNT);
J
Jim Paton 已提交
4108
        bg_cv_.Wait();
4109
        stall = sw.ElapsedMicros();
J
Jim Paton 已提交
4110
      }
4111 4112
      RecordTick(options_.statistics.get(),
                 STALL_MEMTABLE_COMPACTION_MICROS, stall);
4113 4114
      cfd->internal_stats()->RecordWriteStall(
          InternalStats::MEMTABLE_COMPACTION, stall);
4115 4116
    } else if (cfd->current()->NumLevelFiles(0) >=
               cfd->options()->level0_stop_writes_trigger) {
4117
      // There are too many level-0 files.
4118 4119
      DelayLoggingAndReset();
      Log(options_.info_log, "wait for fewer level0 files...\n");
4120
      uint64_t stall;
J
Jim Paton 已提交
4121
      {
4122 4123
        StopWatch sw(env_, options_.statistics.get(),
                     STALL_L0_NUM_FILES_COUNT);
J
Jim Paton 已提交
4124
        bg_cv_.Wait();
4125
        stall = sw.ElapsedMicros();
J
Jim Paton 已提交
4126
      }
4127
      RecordTick(options_.statistics.get(), STALL_L0_NUM_FILES_MICROS, stall);
4128 4129
      cfd->internal_stats()->RecordWriteStall(InternalStats::LEVEL0_NUM_FILES,
                                              stall);
I
Igor Canadi 已提交
4130 4131
    } else if (allow_hard_rate_limit_delay &&
               cfd->options()->hard_rate_limit > 1.0 &&
4132 4133
               (score = cfd->current()->MaxCompactionScore()) >
                   cfd->options()->hard_rate_limit) {
4134
      // Delay a write when the compaction score for any level is too large.
4135
      int max_level = cfd->current()->MaxCompactionScoreLevel();
4136
      mutex_.Unlock();
4137
      uint64_t delayed;
J
Jim Paton 已提交
4138
      {
4139 4140
        StopWatch sw(env_, options_.statistics.get(),
                     HARD_RATE_LIMIT_DELAY_COUNT);
J
Jim Paton 已提交
4141
        env_->SleepForMicroseconds(1000);
4142
        delayed = sw.ElapsedMicros();
J
Jim Paton 已提交
4143
      }
4144
      cfd->internal_stats()->RecordLevelNSlowdown(max_level, delayed);
4145
      // Make sure the following value doesn't round to zero.
4146 4147
      uint64_t rate_limit = std::max((delayed / 1000), (uint64_t) 1);
      rate_limit_delay_millis += rate_limit;
4148 4149
      RecordTick(options_.statistics.get(),
                 RATE_LIMIT_DELAY_MILLIS, rate_limit);
4150
      if (cfd->options()->rate_limit_delay_max_milliseconds > 0 &&
J
Jim Paton 已提交
4151
          rate_limit_delay_millis >=
4152
              (unsigned)cfd->options()->rate_limit_delay_max_milliseconds) {
J
Jim Paton 已提交
4153
        allow_hard_rate_limit_delay = false;
4154
      }
4155
      mutex_.Lock();
4156 4157 4158 4159
    } else if (allow_soft_rate_limit_delay &&
               cfd->options()->soft_rate_limit > 0.0 &&
               (score = cfd->current()->MaxCompactionScore()) >
                   cfd->options()->soft_rate_limit) {
J
Jim Paton 已提交
4160 4161 4162
      // Delay a write when the compaction score for any level is too large.
      // TODO: add statistics
      mutex_.Unlock();
J
Jim Paton 已提交
4163
      {
4164 4165
        StopWatch sw(env_, options_.statistics.get(),
                     SOFT_RATE_LIMIT_DELAY_COUNT);
4166 4167 4168
        env_->SleepForMicroseconds(
            SlowdownAmount(score, cfd->options()->soft_rate_limit,
                           cfd->options()->hard_rate_limit));
J
Jim Paton 已提交
4169 4170
        rate_limit_delay_millis += sw.ElapsedMicros();
      }
J
Jim Paton 已提交
4171 4172
      allow_soft_rate_limit_delay = false;
      mutex_.Lock();
4173

4174
    } else {
4175
      unique_ptr<WritableFile> lfile;
S
sdong 已提交
4176
      log::Writer* new_log = nullptr;
K
kailiu 已提交
4177
      MemTable* new_mem = nullptr;
4178

4179
      // Attempt to switch to a new memtable and trigger flush of old.
4180
      // Do this without holding the dbmutex lock.
4181 4182
      assert(versions_->PrevLogNumber() == 0);
      uint64_t new_log_number = versions_->NewFileNumber();
I
Igor Canadi 已提交
4183
      SuperVersion* new_superversion = nullptr;
4184 4185 4186
      mutex_.Unlock();
      {
        DelayLoggingAndReset();
4187
        s = env_->NewWritableFile(LogFileName(options_.wal_dir, new_log_number),
I
Igor Canadi 已提交
4188 4189
                                  &lfile,
                                  env_->OptimizeForLogWrite(storage_options_));
4190 4191 4192
        if (s.ok()) {
          // Our final size should be less than write_buffer_size
          // (compression, etc) but err on the side of caution.
4193 4194
          lfile->SetPreallocationBlockSize(1.1 *
                                           cfd->options()->write_buffer_size);
S
sdong 已提交
4195
          new_log = new log::Writer(std::move(lfile));
4196
          new_mem = new MemTable(cfd->internal_comparator(), *cfd->options());
4197
          new_superversion = new SuperVersion();
4198
        }
S
sdong 已提交
4199 4200 4201
        Log(options_.info_log,
            "New memtable created with log file: #%lu\n",
            (unsigned long)new_log_number);
4202 4203
      }
      mutex_.Lock();
4204
      if (!s.ok()) {
H
heyongqiang 已提交
4205
        // Avoid chewing through file number space in a tight loop.
4206
        versions_->ReuseFileNumber(new_log_number);
4207
        assert(!new_mem);
4208
        assert(!new_log);
4209 4210
        break;
      }
4211
      logfile_number_ = new_log_number;
S
sdong 已提交
4212
      assert(new_log != nullptr);
4213 4214
      // TODO(icanadi) delete outside of mutex
      delete log_.release();
S
sdong 已提交
4215
      log_.reset(new_log);
4216 4217
      cfd->mem()->SetNextLogNumber(logfile_number_);
      cfd->imm()->Add(cfd->mem());
4218
      if (force) {
4219
        cfd->imm()->FlushRequested();
4220
      }
4221
      new_mem->Ref();
4222
      alive_log_files_.push_back(logfile_number_);
4223 4224 4225 4226 4227 4228 4229 4230 4231 4232
      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_);
        }
      }
4233
      cfd->SetMemtable(new_mem);
I
Igor Canadi 已提交
4234 4235 4236
      Log(options_.info_log,
          "[CF %" PRIu32 "] New memtable created with log file: #%lu\n",
          cfd->GetID(), (unsigned long)logfile_number_);
4237
      force = false;  // Do not force another compaction if have room
4238
      MaybeScheduleFlushOrCompaction();
4239
      // TODO(icanadi) delete outside of mutex)
4240
      delete cfd->InstallSuperVersion(new_superversion, &mutex_);
4241 4242 4243 4244 4245
    }
  }
  return s;
}

I
Igor Canadi 已提交
4246 4247 4248 4249 4250
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4251 4252
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4253
  auto version = cfd->current();
4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}

I
Igor Canadi 已提交
4267 4268 4269 4270
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4271 4272 4273 4274
Env* DBImpl::GetEnv() const {
  return env_;
}

4275 4276
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4277
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4278 4279
}

4280
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4281
                         const Slice& property, std::string* value) {
4282
  value->clear();
4283 4284
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4285
  DBPropertyType property_type = GetPropertyType(property);
J
jorlow@chromium.org 已提交
4286
  MutexLock l(&mutex_);
4287 4288
  return cfd->internal_stats()->GetProperty(property_type, property, value,
                                            cfd);
J
jorlow@chromium.org 已提交
4289 4290
}

4291
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4292
                                 const Range* range, int n, uint64_t* sizes) {
J
jorlow@chromium.org 已提交
4293 4294
  // TODO(opt): better implementation
  Version* v;
4295 4296
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
J
jorlow@chromium.org 已提交
4297 4298
  {
    MutexLock l(&mutex_);
4299
    v = cfd->current();
4300
    v->Ref();
J
jorlow@chromium.org 已提交
4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317
  }

  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();
  }
}

4318 4319 4320 4321 4322 4323 4324
inline void DBImpl::DelayLoggingAndReset() {
  if (delayed_writes_ > 0) {
    Log(options_.info_log, "delayed %d write...\n", delayed_writes_ );
    delayed_writes_ = 0;
  }
}

4325 4326 4327
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4328 4329 4330 4331
  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());
4332 4333 4334
    return Status::InvalidArgument("Invalid file name");
  }

4335 4336 4337 4338
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4339 4340
      Log(options_.info_log, "DeleteFile %s failed - not archived log.\n",
          name.c_str());
4341 4342 4343 4344
      return Status::NotSupported("Delete only supported for archived logs");
    }
    status = env_->DeleteFile(options_.wal_dir + "/" + name.c_str());
    if (!status.ok()) {
4345 4346
      Log(options_.info_log, "DeleteFile %s failed -- %s.\n",
          name.c_str(), status.ToString().c_str());
4347 4348 4349 4350
    }
    return status;
  }

4351
  int level;
4352
  FileMetaData *metadata;
4353
  ColumnFamilyData* cfd;
4354
  VersionEdit edit;
K
Kai Liu 已提交
4355
  DeletionState deletion_state(true);
D
Dhruba Borthakur 已提交
4356 4357
  {
    MutexLock l(&mutex_);
4358
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
4359
    if (!status.ok()) {
4360 4361
      Log(options_.info_log, "DeleteFile %s failed. File not found\n",
                             name.c_str());
D
Dhruba Borthakur 已提交
4362 4363
      return Status::InvalidArgument("File not found");
    }
I
Igor Canadi 已提交
4364
    assert((level > 0) && (level < cfd->NumberLevels()));
4365

D
Dhruba Borthakur 已提交
4366
    // If the file is being compacted no need to delete.
4367
    if (metadata->being_compacted) {
4368
      Log(options_.info_log,
4369
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
D
Dhruba Borthakur 已提交
4370
      return Status::OK();
4371 4372
    }

D
Dhruba Borthakur 已提交
4373 4374 4375
    // 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 已提交
4376
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
4377
      if (cfd->current()->NumLevelFiles(i) != 0) {
D
Dhruba Borthakur 已提交
4378
        Log(options_.info_log,
4379
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
D
Dhruba Borthakur 已提交
4380 4381 4382 4383
        return Status::InvalidArgument("File not in last level");
      }
    }
    edit.DeleteFile(level, number);
4384
    status = versions_->LogAndApply(cfd, &edit, &mutex_, db_directory_.get());
I
Igor Canadi 已提交
4385
    if (status.ok()) {
4386
      InstallSuperVersion(cfd, deletion_state);
I
Igor Canadi 已提交
4387
    }
I
Igor Canadi 已提交
4388
    FindObsoleteFiles(deletion_state, false);
D
Dhruba Borthakur 已提交
4389
  } // lock released here
I
Igor Canadi 已提交
4390
  LogFlush(options_.info_log);
I
Igor Canadi 已提交
4391
  // remove files outside the db-lock
4392 4393 4394
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
4395 4396 4397 4398 4399 4400
  {
    MutexLock l(&mutex_);
    // schedule flush if file deletion means we freed the space for flushes to
    // continue
    MaybeScheduleFlushOrCompaction();
  }
4401 4402 4403
  return status;
}

4404
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4405
  MutexLock l(&mutex_);
4406
  versions_->GetLiveFilesMetaData(metadata);
4407 4408
}

I
Igor Canadi 已提交
4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

  std::string corruption_messages;
  for (const auto& md : metadata) {
    std::string file_path = dbname_ + md.name;
    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) {
      corruption_messages += "Sst file size mismatch: " + md.name +
                             ". 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);
  }
}

4436
void DBImpl::TEST_GetFilesMetaData(
4437
    ColumnFamilyHandle* column_family,
4438
    std::vector<std::vector<FileMetaData>>* metadata) {
4439 4440
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4441 4442 4443
  MutexLock l(&mutex_);
  metadata->resize(NumberLevels());
  for (int level = 0; level < NumberLevels(); level++) {
4444
    const std::vector<FileMetaData*>& files = cfd->current()->files_[level];
4445 4446 4447 4448 4449 4450 4451 4452

    (*metadata)[level].clear();
    for (const auto& f : files) {
      (*metadata)[level].push_back(*f);
    }
  }
}

4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479
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 已提交
4480 4481
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
4482
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
4483
               const Slice& key, const Slice& value) {
4484 4485 4486 4487
  // 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);
4488
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
4489 4490 4491
  return Write(opt, &batch);
}

4492 4493
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
4494
  WriteBatch batch;
4495
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
4496 4497 4498
  return Write(opt, &batch);
}

4499 4500
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
4501
  WriteBatch batch;
4502
  batch.Merge(column_family, key, value);
4503 4504 4505
  return Write(opt, &batch);
}

4506 4507
// Default implementation -- returns not supported status
Status DB::CreateColumnFamily(const ColumnFamilyOptions& options,
4508
                              const std::string& column_family_name,
4509
                              ColumnFamilyHandle** handle) {
4510
  return Status::NotSupported("");
4511
}
4512
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
4513
  return Status::NotSupported("");
4514 4515
}

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

J
Jim Paton 已提交
4518
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
4519 4520 4521 4522 4523
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
      ColumnFamilyDescriptor(default_column_family_name, cf_options));
4524 4525 4526 4527 4528 4529 4530 4531 4532
  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;
4533 4534
}

4535 4536
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
4537
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
4538
  *dbptr = nullptr;
4539
  handles->clear();
J
jorlow@chromium.org 已提交
4540

I
Igor Canadi 已提交
4541 4542 4543 4544 4545 4546 4547 4548
  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");
    }
4549
  }
4550

I
Igor Canadi 已提交
4551
  DBImpl* impl = new DBImpl(db_options, dbname);
4552 4553 4554 4555 4556 4557 4558
  Status s = impl->env_->CreateDirIfMissing(impl->options_.wal_dir);
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
4559 4560 4561 4562
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
4563
  impl->mutex_.Lock();
4564 4565
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
4566
  if (s.ok()) {
4567
    uint64_t new_log_number = impl->versions_->NewFileNumber();
4568
    unique_ptr<WritableFile> lfile;
4569
    EnvOptions soptions(db_options);
4570
    s = impl->options_.env->NewWritableFile(
I
Igor Canadi 已提交
4571
        LogFileName(impl->options_.wal_dir, new_log_number), &lfile,
I
Igor Canadi 已提交
4572
        impl->options_.env->OptimizeForLogWrite(soptions));
J
jorlow@chromium.org 已提交
4573
    if (s.ok()) {
4574
      lfile->SetPreallocationBlockSize(1.1 * max_write_buffer_size);
4575
      impl->logfile_number_ = new_log_number;
4576
      impl->log_.reset(new log::Writer(std::move(lfile)));
I
Igor Canadi 已提交
4577

4578 4579
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
4580 4581 4582
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
        if (cfd == nullptr) {
I
Igor Canadi 已提交
4583 4584 4585
          s = Status::InvalidArgument("Column family not found: ", cf.name);
          break;
        }
4586 4587
        handles->push_back(
            new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
4588
      }
I
Igor Canadi 已提交
4589 4590
    }
    if (s.ok()) {
4591
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
4592
        delete cfd->InstallSuperVersion(new SuperVersion(), &impl->mutex_);
4593
        impl->alive_log_files_.push_back(impl->logfile_number_);
4594
      }
J
jorlow@chromium.org 已提交
4595
      impl->DeleteObsoleteFiles();
4596
      impl->MaybeScheduleFlushOrCompaction();
4597
      impl->MaybeScheduleLogDBDeployStats();
4598
      s = impl->db_directory_->Fsync();
J
jorlow@chromium.org 已提交
4599 4600
    }
  }
4601

I
Igor Canadi 已提交
4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
      if (cfd->options()->compaction_style == kCompactionStyleUniversal) {
        Version* current = cfd->current();
        for (int i = 1; i < current->NumberLevels(); ++i) {
          int num_files = current->NumLevelFiles(i);
          if (num_files > 0) {
            s = Status::InvalidArgument("Not all files are at level 0. Cannot "
                "open with universal compaction style.");
            break;
          }
        }
      }
      if (!s.ok()) {
4616 4617 4618 4619 4620
        break;
      }
    }
  }

4621 4622
  impl->mutex_.Unlock();

J
jorlow@chromium.org 已提交
4623
  if (s.ok()) {
4624
    impl->opened_successfully_ = true;
J
jorlow@chromium.org 已提交
4625 4626
    *dbptr = impl;
  } else {
4627 4628 4629
    for (auto h : *handles) {
      delete h;
    }
4630
    handles->clear();
J
jorlow@chromium.org 已提交
4631 4632 4633 4634 4635
    delete impl;
  }
  return s;
}

4636 4637 4638
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
4639
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
4640 4641
}

4642 4643 4644
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
4645
Status DestroyDB(const std::string& dbname, const Options& options) {
4646 4647 4648 4649 4650
  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 已提交
4651
  std::vector<std::string> filenames;
4652 4653
  std::vector<std::string> archiveFiles;

4654
  std::string archivedir = ArchivalDirectory(dbname);
J
jorlow@chromium.org 已提交
4655 4656
  // Ignore error in case directory does not exist
  env->GetChildren(dbname, &filenames);
4657 4658 4659 4660 4661 4662 4663

  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);
  }
4664

J
jorlow@chromium.org 已提交
4665 4666 4667 4668 4669
  if (filenames.empty()) {
    return Status::OK();
  }

  FileLock* lock;
4670 4671
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
4672 4673 4674
  if (result.ok()) {
    uint64_t number;
    FileType type;
D
dgrogan@chromium.org 已提交
4675
    for (size_t i = 0; i < filenames.size(); i++) {
4676
      if (ParseFileName(filenames[i], &number, &type) &&
4677
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
4678 4679 4680
        Status del;
        if (type == kMetaDatabase) {
          del = DestroyDB(dbname + "/" + filenames[i], options);
4681 4682
        } else if (type == kLogFile) {
          del = env->DeleteFile(soptions.wal_dir + "/" + filenames[i]);
K
Kosie van der Merwe 已提交
4683 4684 4685
        } else {
          del = env->DeleteFile(dbname + "/" + filenames[i]);
        }
J
jorlow@chromium.org 已提交
4686 4687 4688 4689 4690
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4691

4692
    env->GetChildren(archivedir, &archiveFiles);
4693 4694
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
4695 4696
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
4697
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
4698 4699 4700 4701 4702
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4703
    // ignore case where no archival directory is present.
4704
    env->DeleteDir(archivedir);
4705

J
jorlow@chromium.org 已提交
4706
    env->UnlockFile(lock);  // Ignore error since state is already gone
4707
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
4708
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
4709
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
4710 4711 4712 4713
  }
  return result;
}

4714 4715
//
// A global method that can dump out the build version
K
kailiu 已提交
4716
void DumpLeveldbBuildVersion(Logger * log) {
4717
  Log(log, "Git sha %s", rocksdb_build_git_sha);
4718
  Log(log, "Compile time %s %s",
4719
      rocksdb_build_compile_time, rocksdb_build_compile_date);
4720 4721
}

4722
}  // namespace rocksdb