db_impl.cc 173.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"
J
jorlow@chromium.org 已提交
36
#include "db/table_cache.h"
K
kailiu 已提交
37
#include "db/table_properties_collector.h"
T
Tomislav Novak 已提交
38
#include "db/tailing_iter.h"
L
Lei Jin 已提交
39
#include "db/forward_iterator.h"
40
#include "db/transaction_log_impl.h"
J
jorlow@chromium.org 已提交
41 42
#include "db/version_set.h"
#include "db/write_batch_internal.h"
43
#include "port/port.h"
I
Igor Canadi 已提交
44
#include "rocksdb/cache.h"
45
#include "port/likely.h"
46 47 48 49 50 51
#include "rocksdb/compaction_filter.h"
#include "rocksdb/db.h"
#include "rocksdb/env.h"
#include "rocksdb/merge_operator.h"
#include "rocksdb/statistics.h"
#include "rocksdb/status.h"
S
Siying Dong 已提交
52
#include "rocksdb/table.h"
J
jorlow@chromium.org 已提交
53
#include "table/block.h"
54
#include "table/block_based_table_factory.h"
J
jorlow@chromium.org 已提交
55
#include "table/merger.h"
K
kailiu 已提交
56
#include "table/table_builder.h"
J
jorlow@chromium.org 已提交
57
#include "table/two_level_iterator.h"
58
#include "util/auto_roll_logger.h"
K
kailiu 已提交
59
#include "util/autovector.h"
60
#include "util/build_version.h"
J
jorlow@chromium.org 已提交
61
#include "util/coding.h"
I
Igor Canadi 已提交
62
#include "util/hash_skiplist_rep.h"
63
#include "util/hash_linklist_rep.h"
J
jorlow@chromium.org 已提交
64
#include "util/logging.h"
H
Haobo Xu 已提交
65
#include "util/log_buffer.h"
J
jorlow@chromium.org 已提交
66
#include "util/mutexlock.h"
67
#include "util/perf_context_imp.h"
68
#include "util/iostats_context_imp.h"
69
#include "util/stop_watch.h"
70
#include "util/sync_point.h"
J
jorlow@chromium.org 已提交
71

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

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

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

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

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

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

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

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

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

  uint64_t total_bytes;

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

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

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

133
  // Create a client visible context of this compaction
D
Danny Guo 已提交
134 135
  CompactionFilterContext GetFilterContext() {
    CompactionFilterContext context;
136
    context.is_full_compaction = compaction->IsFullCompaction();
137
    context.is_manual_compaction = compaction->IsManualCompaction();
138 139
    return context;
  }
D
Danny Guo 已提交
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183

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

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

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

  // 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;
184
    size_t total_size = key_str_buf_.size() + other_key_str_buf_.size();
D
Danny Guo 已提交
185 186 187 188 189
    combined_key_buf_.reserve(total_size);
    combined_value_buf_.reserve(total_size);

    while (i + j < total_size) {
      int comp_res = 0;
190 191 192
      if (i < key_str_buf_.size() && j < other_key_str_buf_.size()) {
        comp_res = comparator->Compare(key_str_buf_[i], other_key_str_buf_[j]);
      } else if (i >= key_str_buf_.size() && j < other_key_str_buf_.size()) {
D
Danny Guo 已提交
193
        comp_res = 1;
194
      } else if (j >= other_key_str_buf_.size() && i < key_str_buf_.size()) {
D
Danny Guo 已提交
195 196 197
        comp_res = -1;
      }
      if (comp_res > 0) {
198
        AddToCombinedKeyValueSlices(other_key_str_buf_[j], other_value_str_buf_[j]);
D
Danny Guo 已提交
199 200
        j++;
      } else if (comp_res < 0) {
201
        AddToCombinedKeyValueSlices(key_str_buf_[i], existing_value_str_buf_[i]);
D
Danny Guo 已提交
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
        i++;
      }
    }
  }

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

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

    other_key_str_buf_.clear();
    other_value_str_buf_.clear();
    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 已提交
232 233 234 235
};

Options SanitizeOptions(const std::string& dbname,
                        const InternalKeyComparator* icmp,
S
Sanjay Ghemawat 已提交
236
                        const InternalFilterPolicy* ipolicy,
J
jorlow@chromium.org 已提交
237
                        const Options& src) {
238 239 240 241 242 243 244
  auto db_options = SanitizeOptions(dbname, DBOptions(src));
  auto cf_options = SanitizeOptions(icmp, ipolicy, ColumnFamilyOptions(src));
  return Options(db_options, cf_options);
}

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

246 247
  // result.max_open_files means an "infinite" open files.
  if (result.max_open_files != -1) {
248
    ClipToRange(&result.max_open_files, 20, 1000000);
249
  }
250

251
  if (result.info_log == nullptr) {
K
Kai Liu 已提交
252 253
    Status s = CreateLoggerFromOptions(dbname, result.db_log_dir, src.env,
                                       result, &result.info_log);
J
jorlow@chromium.org 已提交
254 255
    if (!s.ok()) {
      // No place suitable for logging
256
      result.info_log = nullptr;
J
jorlow@chromium.org 已提交
257 258
    }
  }
259 260 261 262 263

  if (result.wal_dir.empty()) {
    // Use dbname as default
    result.wal_dir = dbname;
  }
264
  if (result.wal_dir.back() == '/') {
I
Igor Canadi 已提交
265
    result.wal_dir = result.wal_dir.substr(0, result.wal_dir.size() - 1);
266
  }
267

268
  if (result.db_paths.size() == 0) {
269
    result.db_paths.emplace_back(dbname, std::numeric_limits<uint64_t>::max());
270 271
  }

J
jorlow@chromium.org 已提交
272 273 274
  return result;
}

275
namespace {
276 277 278 279 280 281 282
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;

283
  if (options.compaction_style == kCompactionStyleUniversal) {
284 285 286 287
    can_compress =
        (options.compaction_options_universal.compression_size_percent < 0);
  } else {
    // For leveled compress when min_level_to_compress == 0.
288 289
    can_compress = options.compression_per_level.empty() ||
                   options.compression_per_level[0] != kNoCompression;
290 291 292 293 294 295 296 297
  }

  if (can_compress) {
    return options.compression;
  } else {
    return kNoCompression;
  }
}
298
}  // namespace
299

I
Igor Canadi 已提交
300
DBImpl::DBImpl(const DBOptions& options, const std::string& dbname)
J
jorlow@chromium.org 已提交
301
    : env_(options.env),
H
heyongqiang 已提交
302
      dbname_(dbname),
I
Igor Canadi 已提交
303
      options_(SanitizeOptions(dbname, options)),
L
Lei Jin 已提交
304
      stats_(options_.statistics.get()),
305
      db_lock_(nullptr),
H
Haobo Xu 已提交
306
      mutex_(options.use_adaptive_mutex),
307
      shutting_down_(nullptr),
J
jorlow@chromium.org 已提交
308
      bg_cv_(&mutex_),
309
      logfile_number_(0),
I
Igor Canadi 已提交
310
      log_empty_(true),
311
      default_cf_handle_(nullptr),
I
Igor Canadi 已提交
312 313
      total_log_size_(0),
      max_total_in_memory_state_(0),
314
      tmp_batch_(),
315
      bg_schedule_needed_(false),
316
      bg_compaction_scheduled_(0),
317
      bg_manual_only_(0),
318
      bg_flush_scheduled_(0),
319
      manual_compaction_(nullptr),
320
      disable_delete_obsolete_files_(0),
I
Igor Canadi 已提交
321
      delete_obsolete_files_last_run_(options.env->NowMicros()),
322
      purge_wal_files_last_run_(0),
323
      last_stats_dump_time_microsec_(0),
324
      default_interval_to_delete_obsolete_WAL_(600),
325
      flush_on_destroy_(false),
326
      delayed_writes_(0),
327 328
      storage_options_(options),
      bg_work_gate_closed_(false),
329 330
      refitting_level_(false),
      opened_successfully_(false) {
H
heyongqiang 已提交
331
  env_->GetAbsolutePath(dbname, &db_absolute_path_);
332

J
jorlow@chromium.org 已提交
333
  // Reserve ten files or so for other uses and give the rest to TableCache.
334 335
  // Give a large number for setting of "infinite" open files.
  const int table_cache_size =
336 337 338 339 340 341
      (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 已提交
342 343
  versions_.reset(
      new VersionSet(dbname_, &options_, storage_options_, table_cache_.get()));
344 345
  column_family_memtables_.reset(
      new ColumnFamilyMemTablesImpl(versions_->GetColumnFamilySet()));
346

K
kailiu 已提交
347
  DumpLeveldbBuildVersion(options_.info_log.get());
348
  options_.Dump(options_.info_log.get());
349

I
Igor Canadi 已提交
350
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
351 352 353
}

DBImpl::~DBImpl() {
354 355 356 357 358 359 360 361
  mutex_.Lock();
  if (flush_on_destroy_) {
    for (auto cfd : *versions_->GetColumnFamilySet()) {
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
        cfd->Ref();
        mutex_.Unlock();
        FlushMemTable(cfd, FlushOptions());
        mutex_.Lock();
362
        cfd->Unref();
363 364
      }
    }
365
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
366
  }
I
Igor Canadi 已提交
367 368

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

I
Igor Canadi 已提交
374 375 376 377 378
  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();
379 380
  }

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
  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;
396 397 398
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
399 400 401
    }
  }

402
  // versions need to be destroyed before table_cache since it can hold
403 404
  // references to table_cache.
  versions_.reset();
405
  mutex_.Unlock();
I
Igor Canadi 已提交
406 407 408
  if (db_lock_ != nullptr) {
    env_->UnlockFile(db_lock_);
  }
409

I
Igor Canadi 已提交
410
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
411 412 413
}

Status DBImpl::NewDB() {
414
  VersionEdit new_db;
415
  new_db.SetLogNumber(0);
J
jorlow@chromium.org 已提交
416 417 418
  new_db.SetNextFile(2);
  new_db.SetLastSequence(0);

419
  Log(options_.info_log, "Creating manifest 1 \n");
J
jorlow@chromium.org 已提交
420
  const std::string manifest = DescriptorFileName(dbname_, 1);
421
  unique_ptr<WritableFile> file;
I
Igor Canadi 已提交
422 423
  Status s = env_->NewWritableFile(
      manifest, &file, env_->OptimizeForManifestWrite(storage_options_));
J
jorlow@chromium.org 已提交
424 425 426
  if (!s.ok()) {
    return s;
  }
427
  file->SetPreallocationBlockSize(options_.manifest_preallocation_size);
J
jorlow@chromium.org 已提交
428
  {
429
    log::Writer log(std::move(file));
J
jorlow@chromium.org 已提交
430 431 432 433 434 435
    std::string record;
    new_db.EncodeTo(&record);
    s = log.AddRecord(record);
  }
  if (s.ok()) {
    // Make "CURRENT" file that points to the new manifest file.
436
    s = SetCurrentFile(env_, dbname_, 1, db_directory_.get());
J
jorlow@chromium.org 已提交
437 438 439 440 441 442 443 444 445 446
  } else {
    env_->DeleteFile(manifest);
  }
  return s;
}

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

452
const Status DBImpl::CreateArchivalDirectory() {
453
  if (options_.WAL_ttl_seconds > 0 || options_.WAL_size_limit_MB > 0) {
454
    std::string archivalPath = ArchivalDirectory(options_.wal_dir);
455 456 457 458 459
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

460
void DBImpl::PrintStatistics() {
461
  auto dbstats = options_.statistics.get();
462 463
  if (dbstats) {
    Log(options_.info_log,
464 465
        "STATISTCS:\n %s",
        dbstats->ToString().c_str());
466 467 468
  }
}

469
void DBImpl::MaybeDumpStats() {
H
Haobo Xu 已提交
470 471 472 473 474 475 476 477 478 479 480 481
  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;
482

483 484 485 486 487 488
    bool tmp1 = false;
    bool tmp2 = false;
    DBPropertyType cf_property_type =
        GetPropertyType("rocksdb.cfstats", &tmp1, &tmp2);
    DBPropertyType db_property_type =
        GetPropertyType("rocksdb.dbstats", &tmp1, &tmp2);
H
Haobo Xu 已提交
489
    std::string stats;
490 491 492
    {
      MutexLock l(&mutex_);
      for (auto cfd : *versions_->GetColumnFamilySet()) {
493 494
        cfd->internal_stats()->GetStringProperty(cf_property_type,
                                                 "rocksdb.cfstats", &stats);
495
      }
496 497
      default_cf_internal_stats_->GetStringProperty(db_property_type,
                                                    "rocksdb.dbstats", &stats);
498 499
    }
    Log(options_.info_log, "------- DUMPING STATS -------");
H
Haobo Xu 已提交
500
    Log(options_.info_log, "%s", stats.c_str());
501

502
    PrintStatistics();
503 504 505
  }
}

506
// Returns the list of live files in 'sst_live' and the list
K
kailiu 已提交
507
// of all files in the filesystem in 'candidate_files'.
I
Igor Canadi 已提交
508 509 510 511 512 513 514
// 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 已提交
515 516
  mutex_.AssertHeld();

517
  // if deletion is disabled, do nothing
518
  if (disable_delete_obsolete_files_ > 0) {
519 520 521
    return;
  }

522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
  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 已提交
538 539 540
  // get obsolete files
  versions_->GetObsoleteFiles(&deletion_state.sst_delete_files);

I
Igor Canadi 已提交
541 542
  // store the current filenum, lognum, etc
  deletion_state.manifest_file_number = versions_->ManifestFileNumber();
543 544
  deletion_state.pending_manifest_file_number =
      versions_->PendingManifestFileNumber();
545
  deletion_state.log_number = versions_->MinLogNumber();
I
Igor Canadi 已提交
546 547
  deletion_state.prev_log_number = versions_->PrevLogNumber();

548 549 550 551 552 553 554 555
  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
556 557 558 559 560
  for (auto pair : pending_outputs_) {
    deletion_state.sst_live.emplace_back(pair.first, pair.second, 0);
  }
  /*  deletion_state.sst_live.insert(pending_outputs_.begin(),
                                   pending_outputs_.end());*/
I
Igor Canadi 已提交
561 562
  versions_->AddLiveFiles(&deletion_state.sst_live);

563
  if (doing_the_full_scan) {
564 565 566 567 568 569 570 571 572
    for (uint32_t path_id = 0; path_id < options_.db_paths.size(); path_id++) {
      // set of all files in the directory. We'll exclude files that are still
      // alive in the subsequent processings.
      std::vector<std::string> files;
      env_->GetChildren(dbname_, &files);  // Ignore errors
      for (std::string file : files) {
        deletion_state.candidate_files.emplace_back(file, path_id);
      }
    }
573 574 575 576 577

    //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
578 579 580
      for (std::string log_file : log_files) {
        deletion_state.candidate_files.emplace_back(log_file, 0);
      }
581
    }
582 583 584 585 586 587 588 589
    // Add info log files in db_log_dir
    if (options_.db_log_dir.empty() && options_.db_log_dir != dbname_) {
      std::vector<std::string> info_log_files;
      env_->GetChildren(options_.db_log_dir, &info_log_files);  // Ignore errors
      for (std::string log_file : info_log_files) {
        deletion_state.candidate_files.emplace_back(log_file, 0);
      }
    }
590
  }
591 592
}

593 594 595 596 597 598 599 600 601 602 603 604 605
namespace {
bool CompareCandidateFile(const rocksdb::DBImpl::CandidateFileInfo& first,
                          const rocksdb::DBImpl::CandidateFileInfo& second) {
  if (first.file_name > second.file_name) {
    return true;
  } else if (first.file_name < second.file_name) {
    return false;
  } else {
    return (first.path_id > first.path_id);
  }
}
};  // namespace

D
Dhruba Borthakur 已提交
606
// Diffs the files listed in filenames and those that do not
I
Igor Canadi 已提交
607
// belong to live files are posibly removed. Also, removes all the
608
// files in sst_delete_files and log_delete_files.
609
// It is not necessary to hold the mutex when invoking this method.
D
Dhruba Borthakur 已提交
610
void DBImpl::PurgeObsoleteFiles(DeletionState& state) {
611 612
  // we'd better have sth to delete
  assert(state.HaveSomethingToDelete());
613

I
Igor Canadi 已提交
614 615 616 617
  // 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 已提交
618 619
    return;
  }
620

621
  // Now, convert live list to an unordered map, WITHOUT mutex held;
622
  // set is slow.
623 624 625 626
  std::unordered_map<uint64_t, const FileDescriptor*> sst_live_map;
  for (FileDescriptor& fd : state.sst_live) {
    sst_live_map[fd.GetNumber()] = &fd;
  }
I
Igor Canadi 已提交
627

K
kailiu 已提交
628 629 630 631 632 633 634
  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 = "";
635
  for (auto file : state.sst_delete_files) {
636 637 638
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
639
    delete file;
I
Igor Canadi 已提交
640 641
  }

K
kailiu 已提交
642 643
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
644 645
      candidate_files.emplace_back(LogFileName(kDumbDbName, file_num).substr(1),
                                   0);
I
Igor Canadi 已提交
646 647
    }
  }
648

K
kailiu 已提交
649
  // dedup state.candidate_files so we don't try to delete the same
I
Igor Canadi 已提交
650
  // file twice
651
  sort(candidate_files.begin(), candidate_files.end(), CompareCandidateFile);
652 653
  candidate_files.erase(unique(candidate_files.begin(), candidate_files.end()),
                        candidate_files.end());
J
jorlow@chromium.org 已提交
654

655 656
  std::vector<std::string> old_info_log_files;

657 658 659
  for (const auto& candidate_file : candidate_files) {
    std::string to_delete = candidate_file.file_name;
    uint32_t path_id = candidate_file.path_id;
K
kailiu 已提交
660 661 662 663 664 665
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
    if (!ParseFileName(to_delete, &number, &type)) {
      continue;
    }
J
jorlow@chromium.org 已提交
666

K
kailiu 已提交
667 668 669 670 671 672 673 674
    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'
675
        // (can happen during manifest roll)
K
kailiu 已提交
676 677 678
        keep = (number >= state.manifest_file_number);
        break;
      case kTableFile:
679
        keep = (sst_live_map.find(number) != sst_live_map.end());
K
kailiu 已提交
680 681 682
        break;
      case kTempFile:
        // Any temp files that are currently being written to must
683 684 685 686
        // 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
687
        keep = (sst_live_map.find(number) != sst_live_map.end()) ||
688
               (number == state.pending_manifest_file_number);
K
kailiu 已提交
689 690 691 692
        break;
      case kInfoLogFile:
        keep = true;
        if (number != 0) {
693
          old_info_log_files.push_back(to_delete);
J
jorlow@chromium.org 已提交
694
        }
K
kailiu 已提交
695 696 697 698 699 700 701 702 703 704 705 706 707
        break;
      case kCurrentFile:
      case kDBLockFile:
      case kIdentityFile:
      case kMetaDatabase:
        keep = true;
        break;
    }

    if (keep) {
      continue;
    }

708
    std::string fname;
K
kailiu 已提交
709 710
    if (type == kTableFile) {
      // evict from cache
711
      TableCache::Evict(table_cache_.get(), number);
712 713 714 715
      fname = TableFileName(options_.db_paths, number, path_id);
    } else {
      fname =
          ((type == kLogFile) ? options_.wal_dir : dbname_) + "/" + to_delete;
K
kailiu 已提交
716
    }
717

K
kailiu 已提交
718 719
    if (type == kLogFile &&
        (options_.WAL_ttl_seconds > 0 || options_.WAL_size_limit_MB > 0)) {
720
      auto archived_log_name = ArchivedLogFileName(options_.wal_dir, number);
721 722
      // The sync point below is used in (DBTest,TransactionLogIteratorRace)
      TEST_SYNC_POINT("DBImpl::PurgeObsoleteFiles:1");
723
      Status s = env_->RenameFile(fname, archived_log_name);
724 725
      // The sync point below is used in (DBTest,TransactionLogIteratorRace)
      TEST_SYNC_POINT("DBImpl::PurgeObsoleteFiles:2");
726 727 728
      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 已提交
729 730
    } else {
      Status s = env_->DeleteFile(fname);
731 732
      Log(options_.info_log, "Delete %s type=%d #%" PRIu64 " -- %s\n",
          fname.c_str(), type, number, s.ToString().c_str());
J
jorlow@chromium.org 已提交
733 734
    }
  }
H
heyongqiang 已提交
735

736
  // Delete old info log files.
737
  size_t old_info_log_file_count = old_info_log_files.size();
K
Kai Liu 已提交
738 739
  // NOTE: Currently we only support log purge when options_.db_log_dir is
  // located in `dbname` directory.
740
  if (old_info_log_file_count >= options_.keep_log_file_num &&
K
Kai Liu 已提交
741
      options_.db_log_dir.empty()) {
742 743
    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;
744
    for (unsigned int i = 0; i <= end; i++) {
745 746 747 748 749 750 751
      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 已提交
752 753
    }
  }
754
  PurgeObsoleteWALFiles();
I
Igor Canadi 已提交
755
  LogFlush(options_.info_log);
D
Dhruba Borthakur 已提交
756 757 758 759 760
}

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
  DeletionState deletion_state;
I
Igor Canadi 已提交
761
  FindObsoleteFiles(deletion_state, true);
762 763 764
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
765 766
}

I
Igor Canadi 已提交
767
#ifndef ROCKSDB_LITE
768 769 770 771 772 773 774 775
// 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
776
void DBImpl::PurgeObsoleteWALFiles() {
777 778 779 780 781 782
  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;
  }

783 784
  int64_t current_time;
  Status s = env_->GetCurrentTime(&current_time);
785 786 787 788 789 790 791 792
  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_;
793

794 795 796 797 798 799 800 801 802 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
  if (purge_wal_files_last_run_ + time_to_check > now_seconds) {
    return;
  }

  purge_wal_files_last_run_ = now_seconds;

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

  size_t log_files_num = 0;
  uint64_t log_file_size = 0;

  for (auto& f : files) {
    uint64_t number;
    FileType type;
    if (ParseFileName(f, &number, &type) && type == kLogFile) {
      std::string const file_path = archival_dir + "/" + f;
      if (ttl_enabled) {
        uint64_t file_m_time;
        Status const s = env_->GetFileModificationTime(file_path,
          &file_m_time);
        if (!s.ok()) {
          Log(options_.info_log, "Can't get file mod time: %s: %s",
              file_path.c_str(), s.ToString().c_str());
          continue;
        }
        if (now_seconds - file_m_time > options_.WAL_ttl_seconds) {
          Status const s = env_->DeleteFile(file_path);
          if (!s.ok()) {
            Log(options_.info_log, "Can't delete file: %s: %s",
                file_path.c_str(), s.ToString().c_str());
            continue;
I
Igor Canadi 已提交
832 833 834
          } else {
            MutexLock l(&read_first_record_cache_mutex_);
            read_first_record_cache_.erase(number);
835 836
          }
          continue;
837
        }
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
      }

      if (size_limit_enabled) {
        uint64_t file_size;
        Status const s = env_->GetFileSize(file_path, &file_size);
        if (!s.ok()) {
          Log(options_.info_log, "Can't get file size: %s: %s",
              file_path.c_str(), s.ToString().c_str());
          return;
        } else {
          if (file_size > 0) {
            log_file_size = std::max(log_file_size, file_size);
            ++log_files_num;
          } else {
            Status s = env_->DeleteFile(file_path);
            if (!s.ok()) {
              Log(options_.info_log, "Can't delete file: %s: %s",
                  file_path.c_str(), s.ToString().c_str());
              continue;
I
Igor Canadi 已提交
857 858 859
            } else {
              MutexLock l(&read_first_record_cache_mutex_);
              read_first_record_cache_.erase(number);
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
            }
          }
        }
      }
    }
  }

  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;
879
  GetSortedWalsOfType(archival_dir, archived_logs, kArchivedLogFile);
880 881 882 883 884 885 886 887 888 889 890 891 892 893

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

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

901 902 903 904 905 906 907 908 909 910
namespace {
struct CompareLogByPointer {
  bool operator()(const unique_ptr<LogFile>& a, const unique_ptr<LogFile>& b) {
    LogFileImpl* a_impl = dynamic_cast<LogFileImpl*>(a.get());
    LogFileImpl* b_impl = dynamic_cast<LogFileImpl*>(b.get());
    return *a_impl < *b_impl;
  }
};
}

I
Igor Canadi 已提交
911 912 913 914 915 916 917 918 919 920 921 922 923
Status DBImpl::GetSortedWalsOfType(const std::string& path,
                                   VectorLogPtr& log_files,
                                   WalFileType log_type) {
  std::vector<std::string> all_files;
  const Status status = env_->GetChildren(path, &all_files);
  if (!status.ok()) {
    return status;
  }
  log_files.reserve(all_files.size());
  for (const auto& f : all_files) {
    uint64_t number;
    FileType type;
    if (ParseFileName(f, &number, &type) && type == kLogFile) {
I
Igor Canadi 已提交
924 925
      SequenceNumber sequence;
      Status s = ReadFirstRecord(log_type, number, &sequence);
I
Igor Canadi 已提交
926 927 928
      if (!s.ok()) {
        return s;
      }
I
Igor Canadi 已提交
929 930 931 932
      if (sequence == 0) {
        // empty file
        continue;
      }
I
Igor Canadi 已提交
933

934 935 936 937 938 939
      // Reproduce the race condition where a log file is moved
      // to archived dir, between these two sync points, used in
      // (DBTest,TransactionLogIteratorRace)
      TEST_SYNC_POINT("DBImpl::GetSortedWalsOfType:1");
      TEST_SYNC_POINT("DBImpl::GetSortedWalsOfType:2");

I
Igor Canadi 已提交
940 941
      uint64_t size_bytes;
      s = env_->GetFileSize(LogFileName(path, number), &size_bytes);
942 943 944 945 946
      // re-try in case the alive log file has been moved to archive.
      if (!s.ok() && log_type == kAliveLogFile &&
          env_->FileExists(ArchivedLogFileName(path, number))) {
        s = env_->GetFileSize(ArchivedLogFileName(path, number), &size_bytes);
      }
I
Igor Canadi 已提交
947 948 949 950 951
      if (!s.ok()) {
        return s;
      }

      log_files.push_back(std::move(unique_ptr<LogFile>(
I
Igor Canadi 已提交
952
          new LogFileImpl(number, log_type, sequence, size_bytes))));
I
Igor Canadi 已提交
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
    }
  }
  CompareLogByPointer compare_log_files;
  std::sort(log_files.begin(), log_files.end(), compare_log_files);
  return status;
}

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

Status DBImpl::ReadFirstRecord(const WalFileType type, const uint64_t number,
I
Igor Canadi 已提交
985 986 987 988 989 990 991 992 993 994 995 996 997
                               SequenceNumber* sequence) {
  if (type != kAliveLogFile && type != kArchivedLogFile) {
    return Status::NotSupported("File Type Not Known " + std::to_string(type));
  }
  {
    MutexLock l(&read_first_record_cache_mutex_);
    auto itr = read_first_record_cache_.find(number);
    if (itr != read_first_record_cache_.end()) {
      *sequence = itr->second;
      return Status::OK();
    }
  }
  Status s;
I
Igor Canadi 已提交
998 999
  if (type == kAliveLogFile) {
    std::string fname = LogFileName(options_.wal_dir, number);
I
Igor Canadi 已提交
1000 1001 1002 1003
    s = ReadFirstLine(fname, sequence);
    if (env_->FileExists(fname) && !s.ok()) {
      // return any error that is not caused by non-existing file
      return s;
I
Igor Canadi 已提交
1004
    }
I
Igor Canadi 已提交
1005
  }
I
Igor Canadi 已提交
1006

I
Igor Canadi 已提交
1007
  if (type == kArchivedLogFile || !s.ok()) {
I
Igor Canadi 已提交
1008 1009
    //  check if the file got moved to archive.
    std::string archived_file = ArchivedLogFileName(options_.wal_dir, number);
I
Igor Canadi 已提交
1010
    s = ReadFirstLine(archived_file, sequence);
I
Igor Canadi 已提交
1011
  }
I
Igor Canadi 已提交
1012 1013 1014 1015 1016 1017

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

I
Igor Canadi 已提交
1020 1021
// the function returns status.ok() and sequence == 0 if the file exists, but is
// empty
I
Igor Canadi 已提交
1022
Status DBImpl::ReadFirstLine(const std::string& fname,
I
Igor Canadi 已提交
1023
                             SequenceNumber* sequence) {
I
Igor Canadi 已提交
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
    Logger* info_log;
    const char* fname;

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

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

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

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

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

I
Igor Canadi 已提交
1074 1075 1076
  // ReadRecord returns false on EOF, which means that the log file is empty. we
  // return status.ok() in that case and set sequence number to 0
  *sequence = 0;
I
Igor Canadi 已提交
1077 1078 1079 1080 1081
  return status;
}

#endif  // ROCKSDB_LITE

1082
Status DBImpl::Recover(
1083 1084
    const std::vector<ColumnFamilyDescriptor>& column_families, bool read_only,
    bool error_if_log_file_exist) {
J
jorlow@chromium.org 已提交
1085 1086
  mutex_.AssertHeld();

1087
  bool is_new_db = false;
1088
  assert(db_lock_ == nullptr);
I
Igor Canadi 已提交
1089
  if (!read_only) {
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
    // 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;
    }

1102 1103
    for (auto& db_path : options_.db_paths) {
      s = env_->CreateDirIfMissing(db_path.path);
1104 1105 1106 1107 1108
      if (!s.ok()) {
        return s;
      }
    }

1109 1110 1111 1112 1113
    s = env_->NewDirectory(dbname_, &db_directory_);
    if (!s.ok()) {
      return s;
    }

1114
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
1115 1116 1117
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
1118

1119 1120 1121
    if (!env_->FileExists(CurrentFileName(dbname_))) {
      if (options_.create_if_missing) {
        s = NewDB();
1122
        is_new_db = true;
1123 1124 1125 1126 1127 1128
        if (!s.ok()) {
          return s;
        }
      } else {
        return Status::InvalidArgument(
            dbname_, "does not exist (create_if_missing is false)");
J
jorlow@chromium.org 已提交
1129 1130
      }
    } else {
1131 1132 1133 1134
      if (options_.error_if_exists) {
        return Status::InvalidArgument(
            dbname_, "exists (error_if_exists is true)");
      }
J
jorlow@chromium.org 已提交
1135
    }
M
Mayank Agarwal 已提交
1136 1137 1138 1139 1140 1141 1142
    // 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 已提交
1143 1144
  }

1145
  Status s = versions_->Recover(column_families, read_only);
I
Igor Canadi 已提交
1146 1147 1148
  if (options_.paranoid_checks && s.ok()) {
    s = CheckConsistency();
  }
J
jorlow@chromium.org 已提交
1149 1150
  if (s.ok()) {
    SequenceNumber max_sequence(0);
1151 1152
    default_cf_handle_ = new ColumnFamilyHandleImpl(
        versions_->GetColumnFamilySet()->GetDefault(), this, &mutex_);
1153
    default_cf_internal_stats_ = default_cf_handle_->cfd()->internal_stats();
1154 1155
    single_column_family_mode_ =
        versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1;
1156 1157 1158 1159 1160 1161 1162

    // 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
1163
    // produced by an older version of rocksdb.
1164
    const uint64_t min_log = versions_->MinLogNumber();
1165 1166
    const uint64_t prev_log = versions_->PrevLogNumber();
    std::vector<std::string> filenames;
1167
    s = env_->GetChildren(options_.wal_dir, &filenames);
1168 1169
    if (!s.ok()) {
      return s;
1170
    }
K
kailiu 已提交
1171

1172 1173
    std::vector<uint64_t> logs;
    for (size_t i = 0; i < filenames.size(); i++) {
K
kailiu 已提交
1174 1175
      uint64_t number;
      FileType type;
1176 1177 1178 1179 1180 1181 1182 1183 1184
      if (ParseFileName(filenames[i], &number, &type) && type == kLogFile) {
        if (is_new_db) {
          return Status::Corruption(
              "While creating a new Db, wal_dir contains "
              "existing log file: ",
              filenames[i]);
        } else if ((number >= min_log) || (number == prev_log)) {
          logs.push_back(number);
        }
1185
      }
J
jorlow@chromium.org 已提交
1186
    }
1187

H
heyongqiang 已提交
1188 1189 1190 1191 1192 1193
    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");
    }

1194 1195
    // Recover in the order in which the logs were generated
    std::sort(logs.begin(), logs.end());
K
kailiu 已提交
1196
    for (const auto& log : logs) {
1197 1198 1199
      // 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 已提交
1200
      versions_->MarkFileNumberUsed(log);
K
Kai Liu 已提交
1201
      s = RecoverLogFile(log, &max_sequence, read_only);
1202
    }
L
Lei Jin 已提交
1203
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1204 1205
  }

I
Igor Canadi 已提交
1206 1207 1208 1209 1210
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    max_total_in_memory_state_ += cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
  }

J
jorlow@chromium.org 已提交
1211 1212 1213
  return s;
}

I
Igor Canadi 已提交
1214 1215
Status DBImpl::RecoverLogFile(uint64_t log_number, SequenceNumber* max_sequence,
                              bool read_only) {
J
jorlow@chromium.org 已提交
1216 1217
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1218
    Logger* info_log;
J
jorlow@chromium.org 已提交
1219
    const char* fname;
1220 1221
    Status* status;  // nullptr if options_.paranoid_checks==false or
                     //            options_.skip_log_error_on_recovery==true
J
jorlow@chromium.org 已提交
1222
    virtual void Corruption(size_t bytes, const Status& s) {
1223
      Log(info_log, "%s%s: dropping %d bytes; %s",
1224
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1225
          fname, static_cast<int>(bytes), s.ToString().c_str());
1226
      if (this->status != nullptr && this->status->ok()) *this->status = s;
J
jorlow@chromium.org 已提交
1227 1228 1229 1230 1231
    }
  };

  mutex_.AssertHeld();

1232
  std::unordered_map<int, VersionEdit> version_edits;
1233
  // no need to refcount because iteration is under mutex
1234 1235
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    VersionEdit edit;
1236 1237
    edit.SetColumnFamily(cfd->GetID());
    version_edits.insert({cfd->GetID(), edit});
1238
  }
I
Igor Canadi 已提交
1239

J
jorlow@chromium.org 已提交
1240
  // Open the log file
1241
  std::string fname = LogFileName(options_.wal_dir, log_number);
1242
  unique_ptr<SequentialFile> file;
1243
  Status status = env_->NewSequentialFile(fname, &file, storage_options_);
J
jorlow@chromium.org 已提交
1244 1245 1246 1247 1248 1249 1250 1251
  if (!status.ok()) {
    MaybeIgnoreError(&status);
    return status;
  }

  // Create the log reader.
  LogReporter reporter;
  reporter.env = env_;
1252
  reporter.info_log = options_.info_log.get();
J
jorlow@chromium.org 已提交
1253
  reporter.fname = fname.c_str();
1254 1255
  reporter.status = (options_.paranoid_checks &&
                     !options_.skip_log_error_on_recovery ? &status : nullptr);
J
jorlow@chromium.org 已提交
1256 1257 1258 1259
  // 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).
1260
  log::Reader reader(std::move(file), &reporter, true/*checksum*/,
1261
                     0/*initial_offset*/);
1262
  Log(options_.info_log, "Recovering log #%" PRIu64 "", log_number);
J
jorlow@chromium.org 已提交
1263 1264 1265 1266 1267

  // Read all the records and add to a memtable
  std::string scratch;
  Slice record;
  WriteBatch batch;
I
Igor Canadi 已提交
1268
  while (reader.ReadRecord(&record, &scratch)) {
J
jorlow@chromium.org 已提交
1269 1270 1271 1272 1273 1274 1275
    if (record.size() < 12) {
      reporter.Corruption(
          record.size(), Status::Corruption("log record too small"));
      continue;
    }
    WriteBatchInternal::SetContents(&batch, record);

1276
    status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
1277
        &batch, column_family_memtables_.get(), true, log_number);
1278

J
jorlow@chromium.org 已提交
1279 1280
    MaybeIgnoreError(&status);
    if (!status.ok()) {
I
Igor Canadi 已提交
1281
      return status;
J
jorlow@chromium.org 已提交
1282 1283 1284 1285 1286 1287 1288 1289
    }
    const SequenceNumber last_seq =
        WriteBatchInternal::Sequence(&batch) +
        WriteBatchInternal::Count(&batch) - 1;
    if (last_seq > *max_sequence) {
      *max_sequence = last_seq;
    }

1290
    if (!read_only) {
1291 1292
      // no need to refcount since client still doesn't have access
      // to the DB and can not drop column families while we iterate
1293
      for (auto cfd : *versions_->GetColumnFamilySet()) {
1294
        if (cfd->mem()->ShouldFlush()) {
1295
          // If this asserts, it means that InsertInto failed in
1296 1297
          // filtering updates to already-flushed column families
          assert(cfd->GetLogNumber() <= log_number);
1298
          auto iter = version_edits.find(cfd->GetID());
1299 1300
          assert(iter != version_edits.end());
          VersionEdit* edit = &iter->second;
1301
          status = WriteLevel0TableForRecovery(cfd, cfd->mem(), edit);
1302 1303 1304 1305 1306 1307 1308 1309
          // 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 已提交
1310 1311 1312 1313
      }
    }
  }

1314 1315 1316 1317
  if (versions_->LastSequence() < *max_sequence) {
    versions_->SetLastSequence(*max_sequence);
  }

1318
  if (!read_only) {
1319 1320
    // no need to refcount since client still doesn't have access
    // to the DB and can not drop column families while we iterate
1321
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1322
      auto iter = version_edits.find(cfd->GetID());
1323 1324 1325
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

1326 1327 1328 1329
      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
1330
        // (in WriteBatch::InsertInto)
1331 1332 1333 1334 1335 1336 1337
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1338
        status = WriteLevel0TableForRecovery(cfd, cfd->mem(), edit);
1339
      }
1340 1341 1342 1343 1344
      // we still want to clear the memtable, even if the recovery failed
      cfd->CreateNewMemtable();
      if (!status.ok()) {
        return status;
      }
J
jorlow@chromium.org 已提交
1345

1346 1347 1348 1349 1350 1351 1352
      // 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);
1353 1354 1355
      // 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 已提交
1356
      // log number
1357
      versions_->MarkFileNumberUsed(log_number + 1);
1358 1359 1360 1361 1362
      status = versions_->LogAndApply(cfd, edit, &mutex_);
      if (!status.ok()) {
        return status;
      }
    }
1363
  }
I
Igor Canadi 已提交
1364

J
jorlow@chromium.org 已提交
1365 1366 1367
  return status;
}

1368 1369
Status DBImpl::WriteLevel0TableForRecovery(ColumnFamilyData* cfd, MemTable* mem,
                                           VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1370
  mutex_.AssertHeld();
1371
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1372
  FileMetaData meta;
1373 1374
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
  pending_outputs_[meta.fd.GetNumber()] = 0;  // path 0 for level 0 file.
1375
  Iterator* iter = mem->NewIterator(ReadOptions(), true);
1376 1377 1378
  const SequenceNumber newest_snapshot = snapshots_.GetNewest();
  const SequenceNumber earliest_seqno_in_memtable =
    mem->GetFirstSequenceNumber();
1379 1380
  Log(options_.info_log, "[%s] Level-0 table #%" PRIu64 ": started",
      cfd->GetName().c_str(), meta.fd.GetNumber());
1381 1382 1383 1384

  Status s;
  {
    mutex_.Unlock();
I
Igor Canadi 已提交
1385
    s = BuildTable(dbname_, env_, *cfd->options(), storage_options_,
1386
                   cfd->table_cache(), iter, &meta, cfd->internal_comparator(),
1387
                   newest_snapshot, earliest_seqno_in_memtable,
L
Lei Jin 已提交
1388
                   GetCompressionFlush(*cfd->options()), Env::IO_HIGH);
I
Igor Canadi 已提交
1389
    LogFlush(options_.info_log);
1390 1391 1392
    mutex_.Lock();
  }

1393 1394 1395 1396
  Log(options_.info_log,
      "[%s] Level-0 table #%" PRIu64 ": %" PRIu64 " bytes %s",
      cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
      s.ToString().c_str());
J
jorlow@chromium.org 已提交
1397
  delete iter;
1398

1399
  pending_outputs_.erase(meta.fd.GetNumber());
1400 1401 1402 1403

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1404
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1405 1406 1407
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1408 1409
  }

L
Lei Jin 已提交
1410
  InternalStats::CompactionStats stats(1);
1411
  stats.micros = env_->NowMicros() - start_micros;
1412
  stats.bytes_written = meta.fd.GetFileSize();
M
Mark Callaghan 已提交
1413
  stats.files_out_levelnp1 = 1;
1414
  cfd->internal_stats()->AddCompactionStats(level, stats);
1415 1416
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1417
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1418 1419 1420
  return s;
}

1421
Status DBImpl::WriteLevel0Table(ColumnFamilyData* cfd,
1422
                                autovector<MemTable*>& mems, VersionEdit* edit,
1423
                                uint64_t* filenumber, LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
1424
  mutex_.AssertHeld();
1425 1426
  const uint64_t start_micros = env_->NowMicros();
  FileMetaData meta;
1427 1428

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

1432 1433
  const SequenceNumber newest_snapshot = snapshots_.GetNewest();
  const SequenceNumber earliest_seqno_in_memtable =
1434
    mems[0]->GetFirstSequenceNumber();
1435
  Version* base = cfd->current();
1436
  base->Ref();          // it is likely that we do not need this reference
1437 1438 1439
  Status s;
  {
    mutex_.Unlock();
H
Haobo Xu 已提交
1440
    log_buffer->FlushBufferToLog();
K
Kai Liu 已提交
1441
    std::vector<Iterator*> memtables;
1442
    for (MemTable* m : mems) {
1443 1444 1445
      Log(options_.info_log,
          "[%s] Flushing memtable with next log file: %" PRIu64 "\n",
          cfd->GetName().c_str(), m->GetNextLogNumber());
1446
      memtables.push_back(m->NewIterator(ReadOptions(), true));
1447
    }
I
Igor Canadi 已提交
1448
    Iterator* iter = NewMergingIterator(&cfd->internal_comparator(),
1449
                                        &memtables[0], memtables.size());
1450 1451
    Log(options_.info_log, "[%s] Level-0 flush table #%" PRIu64 ": started",
        cfd->GetName().c_str(), meta.fd.GetNumber());
1452

I
Igor Canadi 已提交
1453
    s = BuildTable(dbname_, env_, *cfd->options(), storage_options_,
1454
                   cfd->table_cache(), iter, &meta, cfd->internal_comparator(),
1455
                   newest_snapshot, earliest_seqno_in_memtable,
L
Lei Jin 已提交
1456
                   GetCompressionFlush(*cfd->options()), Env::IO_HIGH);
I
Igor Canadi 已提交
1457
    LogFlush(options_.info_log);
1458
    delete iter;
1459 1460
    Log(options_.info_log,
        "[%s] Level-0 flush table #%" PRIu64 ": %" PRIu64 " bytes %s",
F
Feng Zhu 已提交
1461
        cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
1462
        s.ToString().c_str());
I
Igor Canadi 已提交
1463

1464 1465 1466
    if (!options_.disableDataSync) {
      db_directory_->Fsync();
    }
1467 1468
    mutex_.Lock();
  }
1469 1470
  base->Unref();

1471
  // re-acquire the most current version
1472
  base = cfd->current();
1473 1474 1475 1476 1477 1478

  // 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 已提交
1479
  // committed so that other threads can recognize this file as a
1480 1481 1482 1483 1484 1485
  // 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;
1486
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1487 1488 1489 1490 1491 1492
    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.
1493
    if (base != nullptr && options_.max_background_compactions <= 1 &&
1494
        cfd->options()->compaction_style == kCompactionStyleLevel) {
1495 1496
      level = base->PickLevelForMemTableOutput(min_user_key, max_user_key);
    }
1497 1498 1499
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1500 1501
  }

L
Lei Jin 已提交
1502
  InternalStats::CompactionStats stats(1);
1503
  stats.micros = env_->NowMicros() - start_micros;
1504
  stats.bytes_written = meta.fd.GetFileSize();
1505
  cfd->internal_stats()->AddCompactionStats(level, stats);
1506 1507
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1508
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
1509 1510 1511
  return s;
}

1512 1513
Status DBImpl::FlushMemTableToOutputFile(ColumnFamilyData* cfd,
                                         bool* madeProgress,
H
Haobo Xu 已提交
1514 1515
                                         DeletionState& deletion_state,
                                         LogBuffer* log_buffer) {
1516
  mutex_.AssertHeld();
1517
  assert(cfd->imm()->size() != 0);
1518
  assert(cfd->imm()->IsFlushPending());
1519 1520 1521

  // Save the contents of the earliest memtable as a new Table
  uint64_t file_number;
K
Kai Liu 已提交
1522
  autovector<MemTable*> mems;
1523
  cfd->imm()->PickMemtablesToFlush(&mems);
1524
  if (mems.empty()) {
I
Igor Canadi 已提交
1525 1526
    LogToBuffer(log_buffer, "[%s] Nothing in memtable to flush",
                cfd->GetName().c_str());
L
Lei Jin 已提交
1527
    return Status::OK();
1528 1529 1530
  }

  // record the logfile_number_ before we release the mutex
1531 1532 1533
  // 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.
1534
  MemTable* m = mems[0];
1535 1536
  VersionEdit* edit = m->GetEdits();
  edit->SetPrevLogNumber(0);
1537 1538
  // SetLogNumber(log_num) indicates logs with number smaller than log_num
  // will no longer be picked up for recovery.
1539 1540
  edit->SetLogNumber(mems.back()->GetNextLogNumber());
  edit->SetColumnFamily(cfd->GetID());
1541

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

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

L
Lei Jin 已提交
1550
  if (!s.ok()) {
1551
    cfd->imm()->RollbackMemtableFlush(mems, file_number, &pending_outputs_);
1552 1553
  } else {
    // Replace immutable memtable with the generated Table
1554 1555
    s = cfd->imm()->InstallMemtableFlushResults(
        cfd, mems, versions_.get(), &mutex_, options_.info_log.get(),
1556
        file_number, &pending_outputs_, &deletion_state.memtables_to_free,
1557
        db_directory_.get(), log_buffer);
1558
  }
J
jorlow@chromium.org 已提交
1559 1560

  if (s.ok()) {
1561
    InstallSuperVersion(cfd, deletion_state);
1562 1563 1564
    if (madeProgress) {
      *madeProgress = 1;
    }
I
Igor Canadi 已提交
1565 1566 1567
    Version::LevelSummaryStorage tmp;
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
                cfd->current()->LevelSummary(&tmp));
1568

1569
    if (disable_delete_obsolete_files_ == 0) {
I
Igor Canadi 已提交
1570
      // add to deletion state
1571
      while (alive_log_files_.size() &&
I
Igor Canadi 已提交
1572 1573 1574 1575
             alive_log_files_.begin()->number < versions_->MinLogNumber()) {
        const auto& earliest = *alive_log_files_.begin();
        deletion_state.log_delete_files.push_back(earliest.number);
        total_log_size_ -= earliest.size;
1576 1577
        alive_log_files_.pop_front();
      }
1578
    }
J
jorlow@chromium.org 已提交
1579
  }
1580 1581 1582 1583 1584 1585 1586

  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;
  }
1587
  RecordFlushIOStats();
J
jorlow@chromium.org 已提交
1588 1589 1590
  return s;
}

1591
Status DBImpl::CompactRange(ColumnFamilyHandle* column_family,
1592
                            const Slice* begin, const Slice* end,
1593 1594 1595 1596 1597 1598
                            bool reduce_level, int target_level,
                            uint32_t target_path_id) {
  if (target_path_id >= options_.db_paths.size()) {
    return Status::InvalidArgument("Invalid target path ID");
  }

1599 1600
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
I
Igor Canadi 已提交
1601 1602

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
1603 1604 1605 1606 1607
  if (!s.ok()) {
    LogFlush(options_.info_log);
    return s;
  }

I
Igor Canadi 已提交
1608
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
1609 1610
  {
    MutexLock l(&mutex_);
I
Igor Canadi 已提交
1611 1612
    Version* base = cfd->current();
    for (int level = 1; level < cfd->NumberLevels(); level++) {
G
Gabor Cselle 已提交
1613 1614 1615 1616 1617
      if (base->OverlapInLevel(level, begin, end)) {
        max_level_with_files = level;
      }
    }
  }
1618 1619
  for (int level = 0; level <= max_level_with_files; level++) {
    // in case the compaction is unversal or if we're compacting the
1620 1621 1622
    // bottom-most level, the output level will be the same as input one.
    // level 0 can never be the bottommost level (i.e. if all files are in level
    // 0, we will compact to level 1)
I
Igor Canadi 已提交
1623
    if (cfd->options()->compaction_style == kCompactionStyleUniversal ||
I
Igor Canadi 已提交
1624
        cfd->options()->compaction_style == kCompactionStyleFIFO ||
1625
        (level == max_level_with_files && level > 0)) {
1626
      s = RunManualCompaction(cfd, level, level, target_path_id, begin, end);
1627
    } else {
1628 1629
      s = RunManualCompaction(cfd, level, level + 1, target_path_id, begin,
                              end);
L
Lei Jin 已提交
1630 1631 1632 1633
    }
    if (!s.ok()) {
      LogFlush(options_.info_log);
      return s;
1634
    }
G
Gabor Cselle 已提交
1635
  }
1636 1637

  if (reduce_level) {
I
Igor Canadi 已提交
1638
    s = ReFitLevel(cfd, max_level_with_files, target_level);
1639
  }
I
Igor Canadi 已提交
1640
  LogFlush(options_.info_log);
L
Lei Jin 已提交
1641 1642

  return s;
1643 1644 1645
}

// return the same level if it cannot be moved
I
Igor Canadi 已提交
1646
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd, int level) {
1647
  mutex_.AssertHeld();
I
Igor Canadi 已提交
1648
  Version* current = cfd->current();
1649
  int minimum_level = level;
1650
  for (int i = level - 1; i > 0; --i) {
1651
    // stop if level i is not empty
1652
    if (current->NumLevelFiles(i) > 0) break;
1653
    // stop if level i is too small (cannot fit the level files)
I
Igor Canadi 已提交
1654
    if (cfd->compaction_picker()->MaxBytesForLevel(i) <
1655 1656 1657
        current->NumLevelBytes(level)) {
      break;
    }
1658 1659 1660 1661 1662 1663

    minimum_level = i;
  }
  return minimum_level;
}

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

I
Igor Canadi 已提交
1667
  SuperVersion* superversion_to_free = nullptr;
1668
  SuperVersion* new_superversion = new SuperVersion();
I
Igor Canadi 已提交
1669 1670

  mutex_.Lock();
1671 1672 1673

  // only allow one thread refitting
  if (refitting_level_) {
I
Igor Canadi 已提交
1674
    mutex_.Unlock();
1675
    Log(options_.info_log, "ReFitLevel: another thread is refitting");
I
Igor Canadi 已提交
1676
    delete new_superversion;
L
Lei Jin 已提交
1677
    return Status::NotSupported("another thread is refitting");
1678 1679 1680 1681 1682
  }
  refitting_level_ = true;

  // wait for all background threads to stop
  bg_work_gate_closed_ = true;
1683
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_) {
1684
    Log(options_.info_log,
1685 1686
        "RefitLevel: waiting for background threads to stop: %d %d",
        bg_compaction_scheduled_, bg_flush_scheduled_);
1687 1688 1689 1690
    bg_cv_.Wait();
  }

  // move to a smaller level
1691 1692
  int to_level = target_level;
  if (target_level < 0) {
I
Igor Canadi 已提交
1693
    to_level = FindMinimumEmptyLevelFitting(cfd, level);
1694
  }
1695 1696 1697

  assert(to_level <= level);

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

1703
    VersionEdit edit;
I
Igor Canadi 已提交
1704 1705
    edit.SetColumnFamily(cfd->GetID());
    for (const auto& f : cfd->current()->files_[level]) {
1706
      edit.DeleteFile(level, f->fd.GetNumber());
1707 1708 1709
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
                   f->smallest_seqno, f->largest_seqno);
1710
    }
I
Igor Canadi 已提交
1711 1712
    Log(options_.info_log, "[%s] Apply version edit:\n%s",
        cfd->GetName().c_str(), edit.DebugString().data());
1713

I
Igor Canadi 已提交
1714
    status = versions_->LogAndApply(cfd, &edit, &mutex_, db_directory_.get());
1715
    superversion_to_free = cfd->InstallSuperVersion(new_superversion, &mutex_);
I
Igor Canadi 已提交
1716
    new_superversion = nullptr;
1717

I
Igor Canadi 已提交
1718 1719
    Log(options_.info_log, "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
        status.ToString().data());
1720 1721

    if (status.ok()) {
I
Igor Canadi 已提交
1722 1723
      Log(options_.info_log, "[%s] After refitting:\n%s",
          cfd->GetName().c_str(), cfd->current()->DebugString().data());
1724 1725 1726 1727 1728
    }
  }

  refitting_level_ = false;
  bg_work_gate_closed_ = false;
I
Igor Canadi 已提交
1729 1730 1731 1732

  mutex_.Unlock();
  delete superversion_to_free;
  delete new_superversion;
L
Lei Jin 已提交
1733
  return status;
G
Gabor Cselle 已提交
1734 1735
}

1736 1737 1738
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
1739 1740
}

1741 1742 1743
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->options()->max_mem_compaction_level;
1744 1745
}

1746 1747 1748
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->options()->level0_stop_writes_trigger;
1749 1750
}

1751
Status DBImpl::Flush(const FlushOptions& options,
1752 1753 1754
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return FlushMemTable(cfh->cfd(), options);
H
heyongqiang 已提交
1755 1756
}

1757
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
1758 1759 1760
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
1761
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
1762 1763
                                   int output_level, uint32_t output_path_id,
                                   const Slice* begin, const Slice* end) {
1764
  assert(input_level >= 0);
1765

G
Gabor Cselle 已提交
1766 1767
  InternalKey begin_storage, end_storage;

H
hans@chromium.org 已提交
1768
  ManualCompaction manual;
I
Igor Canadi 已提交
1769
  manual.cfd = cfd;
1770 1771
  manual.input_level = input_level;
  manual.output_level = output_level;
1772
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
1773
  manual.done = false;
1774
  manual.in_progress = false;
1775 1776 1777
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
I
Igor Canadi 已提交
1778 1779
      cfd->options()->compaction_style == kCompactionStyleUniversal ||
      cfd->options()->compaction_style == kCompactionStyleFIFO) {
1780
    manual.begin = nullptr;
G
Gabor Cselle 已提交
1781 1782 1783 1784
  } else {
    begin_storage = InternalKey(*begin, kMaxSequenceNumber, kValueTypeForSeek);
    manual.begin = &begin_storage;
  }
1785
  if (end == nullptr ||
I
Igor Canadi 已提交
1786 1787
      cfd->options()->compaction_style == kCompactionStyleUniversal ||
      cfd->options()->compaction_style == kCompactionStyleFIFO) {
1788
    manual.end = nullptr;
G
Gabor Cselle 已提交
1789 1790 1791 1792 1793 1794
  } else {
    end_storage = InternalKey(*end, 0, static_cast<ValueType>(0));
    manual.end = &end_storage;
  }

  MutexLock l(&mutex_);
1795

1796 1797 1798 1799 1800 1801
  // 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
1802
  // RunManualCompaction(), i.e. during that time no other compaction will
1803 1804 1805
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
1806
  // RunManualCompaction() from getting to the second while loop below.
1807 1808 1809 1810 1811 1812
  // However, only one of them will actually schedule compaction, while
  // others will wait on a condition variable until it completes.

  ++bg_manual_only_;
  while (bg_compaction_scheduled_ > 0) {
    Log(options_.info_log,
I
Igor Canadi 已提交
1813 1814 1815
        "[%s] Manual compaction waiting for all other scheduled background "
        "compactions to finish",
        cfd->GetName().c_str());
1816 1817
    bg_cv_.Wait();
  }
1818

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

1822 1823 1824 1825
  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 已提交
1826
      bg_cv_.Wait();
1827 1828 1829
    } else {
      manual_compaction_ = &manual;
      MaybeScheduleFlushOrCompaction();
G
Gabor Cselle 已提交
1830
    }
H
hans@chromium.org 已提交
1831
  }
1832

1833 1834 1835
  assert(!manual.in_progress);
  assert(bg_manual_only_ > 0);
  --bg_manual_only_;
1836 1837 1838 1839 1840
  if (bg_manual_only_ == 0) {
    // an automatic compaction should have been scheduled might have be
    // preempted by the manual compactions. Need to schedule it back.
    MaybeScheduleFlushOrCompaction();
  }
L
Lei Jin 已提交
1841
  return manual.status;
J
jorlow@chromium.org 已提交
1842 1843
}

1844 1845
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
                             const FlushOptions& options) {
1846 1847
  // nullptr batch means just wait for earlier writes to be done
  Status s = Write(WriteOptions(), nullptr);
H
heyongqiang 已提交
1848
  if (s.ok() && options.wait) {
1849
    // Wait until the compaction completes
1850
    s = WaitForFlushMemTable(cfd);
1851 1852
  }
  return s;
J
jorlow@chromium.org 已提交
1853 1854
}

1855
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
1856 1857 1858
  Status s;
  // Wait until the compaction completes
  MutexLock l(&mutex_);
1859
  while (cfd->imm()->size() > 0 && bg_error_.ok()) {
1860 1861
    bg_cv_.Wait();
  }
1862
  if (!bg_error_.ok()) {
1863 1864 1865
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
1866 1867
}

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

1901 1902
    // Schedule BGWorkCompaction if there's a compaction pending (or a memtable
    // flush, but the HIGH pool is not enabled)
1903
    // Do it only if max_background_compactions hasn't been reached and, in case
1904
    // bg_manual_only_ > 0, if it's a manual compaction.
1905 1906
    if ((manual_compaction_ || is_compaction_needed ||
         (is_flush_pending && options_.max_background_flushes == 0)) &&
1907
        (!bg_manual_only_ || manual_compaction_)) {
1908 1909 1910 1911 1912 1913
      if (bg_compaction_scheduled_ < options_.max_background_compactions) {
        bg_compaction_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW);
      } else {
        bg_schedule_needed_ = true;
      }
1914 1915 1916 1917
    }
  }
}

1918
void DBImpl::RecordFlushIOStats() {
L
Lei Jin 已提交
1919
  RecordTick(stats_, FLUSH_WRITE_BYTES, iostats_context.bytes_written);
1920 1921 1922 1923
  IOSTATS_RESET(bytes_written);
}

void DBImpl::RecordCompactionIOStats() {
L
Lei Jin 已提交
1924
  RecordTick(stats_, COMPACT_READ_BYTES, IOSTATS(bytes_read));
1925
  IOSTATS_RESET(bytes_read);
L
Lei Jin 已提交
1926
  RecordTick(stats_, COMPACT_WRITE_BYTES, IOSTATS(bytes_written));
1927 1928 1929
  IOSTATS_RESET(bytes_written);
}

1930
void DBImpl::BGWorkFlush(void* db) {
1931
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
1932 1933 1934 1935
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
}

void DBImpl::BGWorkCompaction(void* db) {
1936
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
1937 1938 1939
  reinterpret_cast<DBImpl*>(db)->BackgroundCallCompaction();
}

I
Igor Canadi 已提交
1940
Status DBImpl::BackgroundFlush(bool* madeProgress,
H
Haobo Xu 已提交
1941 1942
                               DeletionState& deletion_state,
                               LogBuffer* log_buffer) {
1943 1944 1945 1946 1947 1948
  mutex_.AssertHeld();
  // call_status is failure if at least one flush was a failure. even if
  // flushing one column family reports a failure, we will continue flushing
  // other column families. however, call_status will be a failure in that case.
  Status call_status;
  // refcounting in iteration
1949
  for (auto cfd : *versions_->GetColumnFamilySet()) {
1950 1951 1952
    cfd->Ref();
    Status flush_status;
    while (flush_status.ok() && cfd->imm()->IsFlushPending()) {
1953 1954
      LogToBuffer(
          log_buffer,
1955
          "BackgroundCallFlush doing FlushMemTableToOutputFile with column "
I
Igor Canadi 已提交
1956 1957 1958
          "family [%s], flush slots available %d",
          cfd->GetName().c_str(),
          options_.max_background_flushes - bg_flush_scheduled_);
1959 1960
      flush_status = FlushMemTableToOutputFile(cfd, madeProgress,
                                               deletion_state, log_buffer);
1961 1962 1963
    }
    if (call_status.ok() && !flush_status.ok()) {
      call_status = flush_status;
1964
    }
1965
    cfd->Unref();
J
jorlow@chromium.org 已提交
1966
  }
1967
  versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
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_);

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

H
Haobo Xu 已提交
2021
    bg_flush_scheduled_--;
2022 2023 2024 2025 2026
    // 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 已提交
2027 2028
      MaybeScheduleFlushOrCompaction();
    }
I
Igor Canadi 已提交
2029
    RecordFlushIOStats();
H
Haobo Xu 已提交
2030
    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
void DBImpl::BackgroundCallCompaction() {
2039
  bool madeProgress = false;
K
Kai Liu 已提交
2040
  DeletionState deletion_state(true);
H
Haobo Xu 已提交
2041 2042

  MaybeDumpStats();
2043
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, options_.info_log.get());
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054
  {
    MutexLock l(&mutex_);
    assert(bg_compaction_scheduled_);
    Status s;
    if (!shutting_down_.Acquire_Load()) {
      s = BackgroundCompaction(&madeProgress, deletion_state, &log_buffer);
      if (!s.ok()) {
        // Wait a little bit before retrying background compaction in
        // case this is an environmental problem and we do not want to
        // chew up resources for failed compactions for the duration of
        // the problem.
2055 2056
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
2057 2058
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
H
Haobo Xu 已提交
2059
        log_buffer.FlushBufferToLog();
2060 2061 2062 2063
        Log(options_.info_log,
            "Waiting after background compaction error: %s, "
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
2064 2065 2066 2067 2068
        LogFlush(options_.info_log);
        env_->SleepForMicroseconds(1000000);
        mutex_.Lock();
      }
    }
H
Haobo Xu 已提交
2069

2070 2071 2072 2073 2074 2075 2076
    // 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
2077
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2078
      mutex_.Unlock();
2079 2080 2081 2082 2083
      // 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 已提交
2084
      log_buffer.FlushBufferToLog();
2085 2086 2087
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2088 2089
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
2090

2091
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2092

2093 2094
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

2095 2096 2097
    // Previous compaction may have produced too many files in a level,
    // So reschedule another compaction if we made progress in the
    // last compaction.
2098 2099 2100 2101 2102 2103
    //
    // 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_) {
2104 2105
      MaybeScheduleFlushOrCompaction();
    }
2106 2107 2108 2109 2110 2111 2112 2113 2114
    if (madeProgress || bg_compaction_scheduled_ == 0 || bg_manual_only_ > 0) {
      // signal if
      // * madeProgress -- need to wakeup MakeRoomForWrite
      // * bg_compaction_scheduled_ == 0 -- need to wakeup ~DBImpl
      // * bg_manual_only_ > 0 -- need to wakeup RunManualCompaction
      // If none of this is true, there is no need to signal since nobody is
      // waiting for it
      bg_cv_.SignalAll();
    }
I
Igor Canadi 已提交
2115 2116 2117 2118
    // 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.
2119
  }
J
jorlow@chromium.org 已提交
2120 2121
}

A
Abhishek Kona 已提交
2122
Status DBImpl::BackgroundCompaction(bool* madeProgress,
2123 2124
                                    DeletionState& deletion_state,
                                    LogBuffer* log_buffer) {
2125
  *madeProgress = false;
J
jorlow@chromium.org 已提交
2126
  mutex_.AssertHeld();
2127

2128 2129
  bool is_manual = (manual_compaction_ != nullptr) &&
                   (manual_compaction_->in_progress == false);
2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147

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

  // FLUSH preempts compaction
  Status flush_stat;
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    while (cfd->imm()->IsFlushPending()) {
      LogToBuffer(
          log_buffer,
          "BackgroundCompaction doing FlushMemTableToOutputFile, "
          "compaction slots available %d",
          options_.max_background_compactions - bg_compaction_scheduled_);
      cfd->Ref();
      flush_stat = FlushMemTableToOutputFile(cfd, madeProgress, deletion_state,
                                             log_buffer);
2148
      cfd->Unref();
2149 2150 2151 2152 2153 2154 2155
      if (!flush_stat.ok()) {
        if (is_manual) {
          manual_compaction_->status = flush_stat;
          manual_compaction_->done = true;
          manual_compaction_->in_progress = false;
          manual_compaction_ = nullptr;
        }
2156
        return flush_stat;
2157 2158 2159 2160 2161
      }
    }
  }

  unique_ptr<Compaction> c;
2162 2163
  InternalKey manual_end_storage;
  InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
2164
  if (is_manual) {
G
Gabor Cselle 已提交
2165
    ManualCompaction* m = manual_compaction_;
2166
    assert(m->in_progress);
2167 2168 2169
    c.reset(m->cfd->CompactRange(m->input_level, m->output_level,
                                 m->output_path_id, m->begin, m->end,
                                 &manual_end));
2170
    if (!c) {
2171
      m->done = true;
G
Gabor Cselle 已提交
2172
    }
I
Igor Canadi 已提交
2173 2174 2175 2176 2177 2178 2179 2180 2181
    LogToBuffer(log_buffer,
                "[%s] Manual compaction from level-%d to level-%d from %s .. "
                "%s; will stop at %s\n",
                m->cfd->GetName().c_str(), m->input_level, m->output_level,
                (m->begin ? m->begin->DebugString().c_str() : "(begin)"),
                (m->end ? m->end->DebugString().c_str() : "(end)"),
                ((m->done || manual_end == nullptr)
                     ? "(end)"
                     : manual_end->DebugString().c_str()));
I
Igor Canadi 已提交
2182
  } else {
2183
    // no need to refcount in iteration since it's always under a mutex
I
Igor Canadi 已提交
2184
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
2185
      if (!cfd->options()->disable_auto_compactions) {
2186
        c.reset(cfd->PickCompaction(log_buffer));
I
Igor Canadi 已提交
2187 2188
        if (c != nullptr) {
          // update statistics
L
Lei Jin 已提交
2189
          MeasureTime(stats_, NUM_FILES_IN_SINGLE_COMPACTION,
I
Igor Canadi 已提交
2190 2191 2192
                      c->inputs(0)->size());
          break;
        }
I
Igor Canadi 已提交
2193 2194
      }
    }
J
jorlow@chromium.org 已提交
2195 2196 2197
  }

  Status status;
2198
  if (!c) {
H
hans@chromium.org 已提交
2199
    // Nothing to do
2200
    LogToBuffer(log_buffer, "Compaction nothing to do");
I
Igor Canadi 已提交
2201 2202 2203 2204 2205 2206 2207 2208
  } else if (c->IsDeletionCompaction()) {
    // TODO(icanadi) Do we want to honor snapshots here? i.e. not delete old
    // file if there is alive snapshot pointing to it
    assert(c->num_input_files(1) == 0);
    assert(c->level() == 0);
    assert(c->column_family_data()->options()->compaction_style ==
           kCompactionStyleFIFO);
    for (const auto& f : *c->inputs(0)) {
2209
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
2210 2211 2212 2213 2214 2215 2216 2217 2218
    }
    status = versions_->LogAndApply(c->column_family_data(), c->edit(), &mutex_,
                                    db_directory_.get());
    InstallSuperVersion(c->column_family_data(), deletion_state);
    LogToBuffer(log_buffer, "[%s] Deleted %d files\n",
                c->column_family_data()->GetName().c_str(),
                c->num_input_files(0));
    c->ReleaseCompactionFiles(status);
    *madeProgress = true;
H
hans@chromium.org 已提交
2219
  } else if (!is_manual && c->IsTrivialMove()) {
J
jorlow@chromium.org 已提交
2220
    // Move file to next level
2221
    assert(c->num_input_files(0) == 1);
J
jorlow@chromium.org 已提交
2222
    FileMetaData* f = c->input(0, 0);
2223
    c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
2224 2225 2226
    c->edit()->AddFile(c->level() + 1, f->fd.GetNumber(), f->fd.GetPathId(),
                       f->fd.GetFileSize(), f->smallest, f->largest,
                       f->smallest_seqno, f->largest_seqno);
I
Igor Canadi 已提交
2227
    status = versions_->LogAndApply(c->column_family_data(), c->edit(), &mutex_,
2228
                                    db_directory_.get());
I
Igor Canadi 已提交
2229
    InstallSuperVersion(c->column_family_data(), deletion_state);
2230

2231
    Version::LevelSummaryStorage tmp;
2232 2233 2234 2235 2236 2237
    LogToBuffer(
        log_buffer, "[%s] Moved #%lld to level-%d %lld bytes %s: %s\n",
        c->column_family_data()->GetName().c_str(),
        static_cast<unsigned long long>(f->fd.GetNumber()), c->level() + 1,
        static_cast<unsigned long long>(f->fd.GetFileSize()),
        status.ToString().c_str(), c->input_version()->LevelSummary(&tmp));
I
Igor Canadi 已提交
2238
    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
    Log(InfoLogLevel::WARN_LEVEL, options_.info_log, "Compaction error: %s",
2257
        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.
I
Igor Canadi 已提交
2288
      // Universal and FIFO compactions should always compact the whole range
I
Igor Canadi 已提交
2289
      assert(m->cfd->options()->compaction_style != kCompactionStyleUniversal);
I
Igor Canadi 已提交
2290
      assert(m->cfd->options()->compaction_style != kCompactionStyleFIFO);
2291
      m->tmp_storage = *manual_end;
G
Gabor Cselle 已提交
2292 2293
      m->begin = &m->tmp_storage;
    }
2294
    m->in_progress = false; // not being processed anymore
2295
    manual_compaction_ = nullptr;
H
hans@chromium.org 已提交
2296
  }
2297
  return status;
J
jorlow@chromium.org 已提交
2298 2299
}

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

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

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

// Frees up unused file number.
void DBImpl::ReleaseCompactionUnusedFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2340
  for (const auto file_number : compact->allocated_file_numbers) {
2341 2342 2343 2344
    pending_outputs_.erase(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
    mutex_.Lock();
    file_number = versions_->NewFileNumber();
2358
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
J
jorlow@chromium.org 已提交
2359 2360
    mutex_.Unlock();
  }
2361 2362
  CompactionState::Output out;
  out.number = file_number;
2363
  out.path_id = compact->compaction->GetOutputPathId();
2364 2365
  out.smallest.Clear();
  out.largest.Clear();
2366
  out.smallest_seqno = out.largest_seqno = 0;
2367
  compact->outputs.push_back(out);
J
jorlow@chromium.org 已提交
2368 2369

  // Make the output file
2370 2371
  std::string fname = TableFileName(options_.db_paths, file_number,
                                    compact->compaction->GetOutputPathId());
2372
  Status s = env_->NewWritableFile(fname, &compact->outfile, storage_options_);
2373

J
jorlow@chromium.org 已提交
2374
  if (s.ok()) {
L
Lei Jin 已提交
2375
    compact->outfile->SetIOPriority(Env::IO_LOW);
2376
    compact->outfile->SetPreallocationBlockSize(
2377
        compact->compaction->OutputFilePreallocationSize());
2378

2379
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2380 2381 2382
    compact->builder.reset(NewTableBuilder(
        *cfd->options(), cfd->internal_comparator(), compact->outfile.get(),
        compact->compaction->OutputCompressionType()));
J
jorlow@chromium.org 已提交
2383
  }
I
Igor Canadi 已提交
2384
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
2385 2386 2387 2388 2389
  return s;
}

Status DBImpl::FinishCompactionOutputFile(CompactionState* compact,
                                          Iterator* input) {
2390
  assert(compact != nullptr);
2391
  assert(compact->outfile);
2392
  assert(compact->builder != nullptr);
J
jorlow@chromium.org 已提交
2393 2394

  const uint64_t output_number = compact->current_output()->number;
2395
  const uint32_t output_path_id = compact->current_output()->path_id;
J
jorlow@chromium.org 已提交
2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408
  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;
2409
  compact->builder.reset();
J
jorlow@chromium.org 已提交
2410 2411

  // Finish and check for file errors
2412
  if (s.ok() && !options_.disableDataSync) {
2413
    if (options_.use_fsync) {
L
Lei Jin 已提交
2414
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2415 2416
      s = compact->outfile->Fsync();
    } else {
L
Lei Jin 已提交
2417
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2418 2419
      s = compact->outfile->Sync();
    }
J
jorlow@chromium.org 已提交
2420 2421 2422 2423
  }
  if (s.ok()) {
    s = compact->outfile->Close();
  }
2424
  compact->outfile.reset();
J
jorlow@chromium.org 已提交
2425 2426 2427

  if (s.ok() && current_entries > 0) {
    // Verify that the table is usable
I
Igor Canadi 已提交
2428
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2429
    FileDescriptor fd(output_number, output_path_id, current_bytes);
I
Igor Canadi 已提交
2430
    Iterator* iter = cfd->table_cache()->NewIterator(
2431
        ReadOptions(), storage_options_, cfd->internal_comparator(), fd);
J
jorlow@chromium.org 已提交
2432 2433 2434
    s = iter->status();
    delete iter;
    if (s.ok()) {
2435 2436 2437 2438
      Log(options_.info_log, "[%s] Generated table #%" PRIu64 ": %" PRIu64
                             " keys, %" PRIu64 " bytes",
          cfd->GetName().c_str(), output_number, current_entries,
          current_bytes);
J
jorlow@chromium.org 已提交
2439 2440 2441 2442 2443 2444
    }
  }
  return s;
}


2445 2446
Status DBImpl::InstallCompactionResults(CompactionState* compact,
                                        LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
2447
  mutex_.AssertHeld();
2448 2449 2450 2451 2452

  // 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.
2453
  if (!versions_->VerifyCompactionFileConsistency(compact->compaction)) {
I
Igor Canadi 已提交
2454 2455 2456 2457 2458
    Log(options_.info_log, "[%s] Compaction %d@%d + %d@%d files aborted",
        compact->compaction->column_family_data()->GetName().c_str(),
        compact->compaction->num_input_files(0), compact->compaction->level(),
        compact->compaction->num_input_files(1),
        compact->compaction->output_level());
L
Lei Jin 已提交
2459
    return Status::Corruption("Compaction input files inconsistent");
2460 2461
  }

I
Igor Canadi 已提交
2462 2463
  LogToBuffer(log_buffer, "[%s] Compacted %d@%d + %d@%d files => %lld bytes",
              compact->compaction->column_family_data()->GetName().c_str(),
2464 2465 2466 2467 2468
              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 已提交
2469 2470 2471

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

2484 2485 2486 2487 2488 2489 2490
// 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(
2491 2492
  SequenceNumber in, std::vector<SequenceNumber>& snapshots,
  SequenceNumber* prev_snapshot) {
2493
  SequenceNumber prev __attribute__((unused)) = 0;
2494 2495 2496
  for (const auto cur : snapshots) {
    assert(prev <= cur);
    if (cur >= in) {
2497
      *prev_snapshot = prev;
2498
      return cur;
2499
    }
2500 2501
    prev = cur; // assignment
    assert(prev);
2502 2503
  }
  Log(options_.info_log,
2504 2505
      "Looking for seqid %" PRIu64 " but maxseqid is %" PRIu64 "", in,
      snapshots[snapshots.size() - 1]);
2506 2507 2508 2509
  assert(0);
  return 0;
}

I
Igor Canadi 已提交
2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528
uint64_t DBImpl::CallFlushDuringCompaction(ColumnFamilyData* cfd,
                                           DeletionState& deletion_state,
                                           LogBuffer* log_buffer) {
  if (cfd->imm()->imm_flush_needed.NoBarrier_Load() != nullptr) {
    const uint64_t imm_start = env_->NowMicros();
    mutex_.Lock();
    if (cfd->imm()->IsFlushPending()) {
      cfd->Ref();
      FlushMemTableToOutputFile(cfd, nullptr, deletion_state, log_buffer);
      cfd->Unref();
      bg_cv_.SignalAll();  // Wakeup MakeRoomForWrite() if necessary
    }
    mutex_.Unlock();
    log_buffer->FlushBufferToLog();
    return env_->NowMicros() - imm_start;
  }
  return 0;
}

D
Danny Guo 已提交
2529
Status DBImpl::ProcessKeyValueCompaction(
2530
    bool is_snapshot_supported,
D
Danny Guo 已提交
2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541
    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 已提交
2542
  Status status;
D
Danny Guo 已提交
2543
  std::string compaction_filter_value;
J
jorlow@chromium.org 已提交
2544
  ParsedInternalKey ikey;
2545
  IterKey current_user_key;
J
jorlow@chromium.org 已提交
2546
  bool has_current_user_key = false;
2547
  IterKey delete_key;
2548 2549
  SequenceNumber last_sequence_for_key __attribute__((unused)) =
    kMaxSequenceNumber;
2550
  SequenceNumber visible_in_snapshot = kMaxSequenceNumber;
2551
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
I
Igor Canadi 已提交
2552 2553
  MergeHelper merge(
      cfd->user_comparator(), cfd->options()->merge_operator.get(),
2554 2555
      options_.info_log.get(), cfd->options()->min_partial_merge_operands,
      false /* internal key corruption is expected */);
I
Igor Canadi 已提交
2556
  auto compaction_filter = cfd->options()->compaction_filter;
2557 2558
  std::unique_ptr<CompactionFilter> compaction_filter_from_factory = nullptr;
  if (!compaction_filter) {
2559
    auto context = compact->GetFilterContextV1();
2560
    compaction_filter_from_factory =
I
Igor Canadi 已提交
2561 2562
        cfd->options()->compaction_filter_factory->CreateCompactionFilter(
            context);
2563 2564
    compaction_filter = compaction_filter_from_factory.get();
  }
2565

2566 2567
  while (input->Valid() && !shutting_down_.Acquire_Load() &&
         !cfd->IsDropped()) {
2568
    RecordCompactionIOStats();
2569 2570 2571 2572
    // FLUSH preempts compaction
    // TODO(icanadi) this currently only checks if flush is necessary on
    // compacting column family. we should also check if flush is necessary on
    // other column families, too
I
Igor Canadi 已提交
2573
    imm_micros += CallFlushDuringCompaction(cfd, deletion_state, log_buffer);
2574

D
Danny Guo 已提交
2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595
    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 已提交
2596

2597
    if (compact->compaction->ShouldStopBefore(key) &&
2598
        compact->builder != nullptr) {
D
Danny Guo 已提交
2599
      status = FinishCompactionOutputFile(compact, input);
2600 2601 2602 2603 2604 2605
      if (!status.ok()) {
        break;
      }
    }

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

2656 2657 2658
      // 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.
2659
      SequenceNumber prev_snapshot = 0; // 0 means no previous snapshot
2660 2661 2662 2663
      SequenceNumber visible = visible_at_tip ? visible_at_tip :
        is_snapshot_supported ?  findEarliestVisibleSnapshot(ikey.sequence,
                                  compact->existing_snapshots, &prev_snapshot)
                              : 0;
2664 2665 2666 2667 2668

      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 已提交
2669
        // Hidden by an newer entry for same user key
2670
        // TODO: why not > ?
2671
        assert(last_sequence_for_key >= ikey.sequence);
J
jorlow@chromium.org 已提交
2672
        drop = true;    // (A)
L
Lei Jin 已提交
2673
        RecordTick(stats_, COMPACTION_KEY_DROP_NEWER_ENTRY);
J
jorlow@chromium.org 已提交
2674
      } else if (ikey.type == kTypeDeletion &&
D
Danny Guo 已提交
2675
          ikey.sequence <= earliest_snapshot &&
2676
          compact->compaction->KeyNotExistsBeyondOutputLevel(ikey.user_key)) {
J
jorlow@chromium.org 已提交
2677 2678 2679 2680 2681 2682 2683 2684
        // For this user key:
        // (1) there is no data in higher levels
        // (2) data in lower levels will have larger sequence numbers
        // (3) data in layers that are being compacted here and have
        //     smaller sequence numbers will be dropped in the next
        //     few iterations of this loop (by rule (A) above).
        // Therefore this deletion marker is obsolete and can be dropped.
        drop = true;
L
Lei Jin 已提交
2685
        RecordTick(stats_, COMPACTION_KEY_DROP_OBSOLETE);
2686
      } else if (ikey.type == kTypeMerge) {
2687 2688 2689 2690 2691 2692
        if (!merge.HasOperator()) {
          LogToBuffer(log_buffer, "Options::merge_operator is null.");
          status = Status::InvalidArgument(
              "merge_operator is not properly initialized.");
          break;
        }
2693 2694 2695 2696 2697 2698
        // 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 已提交
2699 2700 2701 2702 2703 2704
        int steps = 0;
        merge.MergeUntil(input, prev_snapshot, bottommost_level,
            options_.statistics.get(), &steps);
        // Skip the Merge ops
        combined_idx = combined_idx - 1 + steps;

2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722
        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 已提交
2723 2724 2725
      }

      last_sequence_for_key = ikey.sequence;
2726
      visible_in_snapshot = visible;
J
jorlow@chromium.org 已提交
2727 2728 2729
    }

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

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

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

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

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

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

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

2833 2834
  RecordCompactionIOStats();

D
Danny Guo 已提交
2835 2836 2837 2838 2839 2840 2841 2842 2843
  return status;
}

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

2844
  // Assemble slice vectors for user keys and existing values.
2845
  // We also keep track of our parsed internal key structs because
2846 2847 2848
  // we may need to access the sequence number in the event that
  // keys are garbage collected during the filter process.
  std::vector<ParsedInternalKey> ikey_buf;
D
Danny Guo 已提交
2849
  std::vector<Slice> user_key_buf;
2850 2851 2852 2853 2854 2855 2856 2857 2858 2859
  std::vector<Slice> existing_value_buf;

  for (const auto& key : compact->key_str_buf_) {
    ParsedInternalKey ikey;
    ParseInternalKey(Slice(key), &ikey);
    ikey_buf.emplace_back(ikey);
    user_key_buf.emplace_back(ikey.user_key);
  }
  for (const auto& value : compact->existing_value_str_buf_) {
    existing_value_buf.emplace_back(Slice(value));
D
Danny Guo 已提交
2860 2861 2862 2863 2864 2865 2866 2867 2868
  }

  // 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(),
2869
      user_key_buf, existing_value_buf,
D
Danny Guo 已提交
2870 2871 2872 2873 2874 2875
      &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() ==
2876
      compact->key_str_buf_.size());
D
Danny Guo 已提交
2877
  assert(compact->to_delete_buf_.size() ==
2878
      compact->existing_value_str_buf_.size());
D
Danny Guo 已提交
2879 2880 2881 2882 2883 2884 2885 2886 2887
  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],
2888 2889 2890
                        compact->key_str_buf_[i].size(),
                        ikey_buf[i].sequence,
                        kTypeDeletion);
D
Danny Guo 已提交
2891 2892

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

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

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

2926
  assert(cfd->current()->NumLevelFiles(compact->compaction->level()) > 0);
D
Danny Guo 已提交
2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951
  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);

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

  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 =
2970 2971
      cfd->options()->compaction_filter_factory_v2->CreateCompactionFilterV2(
          context);
D
Danny Guo 已提交
2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982
  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) {
2983 2984
    while (backup_input->Valid() && !shutting_down_.Acquire_Load() &&
           !cfd->IsDropped()) {
I
Igor Canadi 已提交
2985 2986 2987 2988 2989 2990
      // FLUSH preempts compaction
      // TODO(icanadi) this currently only checks if flush is necessary on
      // compacting column family. we should also check if flush is necessary on
      // other column families, too
      imm_micros += CallFlushDuringCompaction(cfd, deletion_state, log_buffer);

D
Danny Guo 已提交
2991 2992 2993 2994
      Slice key = backup_input->key();
      Slice value = backup_input->value();

      const SliceTransform* transformer =
2995
          cfd->options()->compaction_filter_factory_v2->GetPrefixExtractor();
2996
      const auto key_prefix = transformer->Transform(key);
2997
      if (!prefix_initialized) {
2998
        compact->cur_prefix_ = key_prefix.ToString();
2999
        prefix_initialized = true;
D
Danny Guo 已提交
3000 3001 3002
      }
      if (!ParseInternalKey(key, &ikey)) {
        // log error
I
Igor Canadi 已提交
3003 3004
        Log(options_.info_log, "[%s] Failed to parse key: %s",
            cfd->GetName().c_str(), key.ToString().c_str());
D
Danny Guo 已提交
3005 3006 3007
        continue;
      } else {
        // If the prefix remains the same, keep buffering
3008
        if (key_prefix.compare(Slice(compact->cur_prefix_)) == 0) {
D
Danny Guo 已提交
3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025
          // 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
3026
          if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3027 3028
            CallCompactionFilterV2(compact, compaction_filter_v2);
          }
3029
          compact->cur_prefix_ = key_prefix.ToString();
D
Danny Guo 已提交
3030 3031 3032 3033
        }
      }

      // Merge this batch of data (values + ineligible keys)
3034
      compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3035 3036 3037 3038

      // Done buffering for the current prefix. Spit it out to disk
      // Now just iterate through all the kv-pairs
      status = ProcessKeyValueCompaction(
3039
          is_snapshot_supported,
D
Danny Guo 已提交
3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068
          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.
3069
        if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3070 3071
          CallCompactionFilterV2(compact, compaction_filter_v2);
        }
3072
        compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3073 3074

        status = ProcessKeyValueCompaction(
3075
            is_snapshot_supported,
D
Danny Guo 已提交
3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091
            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
3092
    if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3093 3094
      CallCompactionFilterV2(compact, compaction_filter_v2);
    }
3095
    compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3096
    status = ProcessKeyValueCompaction(
3097
        is_snapshot_supported,
D
Danny Guo 已提交
3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111
        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(
3112
      is_snapshot_supported,
D
Danny Guo 已提交
3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124
      visible_at_tip,
      earliest_snapshot,
      latest_snapshot,
      deletion_state,
      bottommost_level,
      imm_micros,
      input.get(),
      compact,
      false,
      log_buffer);
  }

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

3137 3138 3139
  if (!options_.disableDataSync) {
    db_directory_->Fsync();
  }
I
Igor Canadi 已提交
3140

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

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

3155
  for (int i = 0; i < compact->compaction->num_input_files(0); i++) {
3156
    stats.bytes_readn += compact->compaction->input(0, i)->fd.GetFileSize();
3157
  }
M
Mark Callaghan 已提交
3158

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

3163
  for (int i = 0; i < num_output_files; i++) {
3164 3165 3166
    stats.bytes_written += compact->outputs[i].file_size;
  }

3167 3168
  RecordCompactionIOStats();

I
Igor Canadi 已提交
3169
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
3170
  mutex_.Lock();
3171 3172
  cfd->internal_stats()->AddCompactionStats(
      compact->compaction->output_level(), stats);
J
jorlow@chromium.org 已提交
3173

3174 3175 3176 3177
  // 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 已提交
3178
  if (status.ok()) {
3179
    status = InstallCompactionResults(compact, log_buffer);
I
Igor Canadi 已提交
3180
    InstallSuperVersion(cfd, deletion_state);
J
jorlow@chromium.org 已提交
3181
  }
3182
  Version::LevelSummaryStorage tmp;
3183 3184
  LogToBuffer(
      log_buffer,
I
Igor Canadi 已提交
3185
      "[%s] compacted to: %s, %.1f MB/sec, level %d, files in(%d, %d) out(%d) "
3186 3187
      "MB in(%.1f, %.1f) out(%.1f), read-write-amplify(%.1f) "
      "write-amplify(%.1f) %s\n",
I
Igor Canadi 已提交
3188
      cfd->GetName().c_str(), cfd->current()->LevelSummary(&tmp),
M
Mark Callaghan 已提交
3189
      (stats.bytes_readn + stats.bytes_readnp1 + stats.bytes_written) /
3190 3191 3192 3193
          (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 已提交
3194
      stats.bytes_written / 1048576.0,
3195
      (stats.bytes_written + stats.bytes_readnp1 + stats.bytes_readn) /
3196 3197
          (double)stats.bytes_readn,
      stats.bytes_written / (double)stats.bytes_readn,
3198
      status.ToString().c_str());
M
Mark Callaghan 已提交
3199

J
jorlow@chromium.org 已提交
3200 3201 3202
  return status;
}

3203 3204
namespace {
struct IterState {
3205 3206
  IterState(DBImpl* db, port::Mutex* mu, SuperVersion* super_version)
      : db(db), mu(mu), super_version(super_version) {}
3207 3208

  DBImpl* db;
3209
  port::Mutex* mu;
3210
  SuperVersion* super_version;
3211 3212 3213 3214
};

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

3216
  if (state->super_version->Unref()) {
3217 3218
    DBImpl::DeletionState deletion_state;

3219 3220 3221 3222 3223 3224
    state->mu->Lock();
    state->super_version->Cleanup();
    state->db->FindObsoleteFiles(deletion_state, false, true);
    state->mu->Unlock();

    delete state->super_version;
3225 3226 3227
    if (deletion_state.HaveSomethingToDelete()) {
      state->db->PurgeObsoleteFiles(deletion_state);
    }
I
Igor Canadi 已提交
3228
  }
T
Tomislav Novak 已提交
3229

3230 3231
  delete state;
}
H
Hans Wennborg 已提交
3232
}  // namespace
3233

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

  return internal_iter;
}

3270 3271 3272 3273
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

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

I
Igor Canadi 已提交
3280 3281 3282
// DeletionState gets created and destructed outside of the lock -- we
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3283
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3284 3285 3286 3287 3288 3289
//
// 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
3290 3291
void DBImpl::InstallSuperVersion(ColumnFamilyData* cfd,
                                 DeletionState& deletion_state) {
3292
  mutex_.AssertHeld();
I
Igor Canadi 已提交
3293 3294 3295 3296
  // if new_superversion == nullptr, it means somebody already used it
  SuperVersion* new_superversion =
    (deletion_state.new_superversion != nullptr) ?
    deletion_state.new_superversion : new SuperVersion();
3297 3298
  SuperVersion* old_superversion =
      cfd->InstallSuperVersion(new_superversion, &mutex_);
I
Igor Canadi 已提交
3299
  deletion_state.new_superversion = nullptr;
3300
  deletion_state.superversions_to_free.push_back(old_superversion);
I
Igor Canadi 已提交
3301 3302
}

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

3309 3310 3311
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

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

3319
  // Acquire SuperVersion
3320
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
I
Igor Canadi 已提交
3321

3322
  // Prepare to store a list of merge operations if merge occurs.
3323
  MergeContext merge_context;
3324

3325
  Status s;
3326
  // First look in the memtable, then in the immutable memtable (if any).
3327
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3328
  // merge_operands will contain the sequence of merges in the latter case.
3329
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3330
  PERF_TIMER_STOP(get_snapshot_time);
I
Igor Canadi 已提交
3331
  if (sv->mem->Get(lkey, value, &s, merge_context, *cfd->options())) {
3332
    // Done
L
Lei Jin 已提交
3333
    RecordTick(stats_, MEMTABLE_HIT);
I
Igor Canadi 已提交
3334
  } else if (sv->imm->Get(lkey, value, &s, merge_context, *cfd->options())) {
3335
    // Done
L
Lei Jin 已提交
3336
    RecordTick(stats_, MEMTABLE_HIT);
3337
  } else {
L
Lei Jin 已提交
3338
    PERF_TIMER_START(get_from_output_files_time);
3339

I
Igor Canadi 已提交
3340
    sv->current->Get(options, lkey, value, &s, &merge_context, value_found);
L
Lei Jin 已提交
3341
    PERF_TIMER_STOP(get_from_output_files_time);
L
Lei Jin 已提交
3342
    RecordTick(stats_, MEMTABLE_MISS);
3343
  }
3344

L
Lei Jin 已提交
3345
  PERF_TIMER_START(get_post_process_time);
3346

3347
  ReturnAndCleanupSuperVersion(cfd, sv);
3348

L
Lei Jin 已提交
3349 3350
  RecordTick(stats_, NUMBER_KEYS_READ);
  RecordTick(stats_, BYTES_READ, value->size());
L
Lei Jin 已提交
3351
  PERF_TIMER_STOP(get_post_process_time);
3352
  return s;
J
jorlow@chromium.org 已提交
3353 3354
}

3355 3356
std::vector<Status> DBImpl::MultiGet(
    const ReadOptions& options,
3357
    const std::vector<ColumnFamilyHandle*>& column_family,
3358
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3359

L
Lei Jin 已提交
3360
  StopWatch sw(env_, stats_, DB_MULTIGET);
L
Lei Jin 已提交
3361
  PERF_TIMER_AUTO(get_snapshot_time);
K
Kai Liu 已提交
3362

3363
  SequenceNumber snapshot;
3364

3365
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3366
    ColumnFamilyData* cfd;
3367 3368 3369 3370 3371
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3372 3373 3374 3375 3376 3377
    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});
3378 3379 3380
    }
  }

3381
  mutex_.Lock();
3382 3383 3384 3385 3386
  if (options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_;
  } else {
    snapshot = versions_->LastSequence();
  }
3387
  for (auto mgd_iter : multiget_cf_data) {
3388 3389
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3390
  }
3391
  mutex_.Unlock();
3392

3393 3394
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3395

3396
  // Note: this always resizes the values array
3397 3398 3399
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3400 3401

  // Keep track of bytes that we read for statistics-recording later
3402
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3403
  PERF_TIMER_STOP(get_snapshot_time);
3404 3405 3406 3407

  // 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.
3408
  // merge_operands will contain the sequence of merges in the latter case.
3409
  for (size_t i = 0; i < num_keys; ++i) {
3410
    merge_context.Clear();
3411
    Status& s = stat_list[i];
3412 3413 3414
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3415 3416
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3417 3418 3419
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
I
Igor Canadi 已提交
3420 3421
    auto cfd = mgd->cfd;
    if (super_version->mem->Get(lkey, value, &s, merge_context,
I
Igor Canadi 已提交
3422
                                *cfd->options())) {
3423
      // Done
3424
    } else if (super_version->imm->Get(lkey, value, &s, merge_context,
I
Igor Canadi 已提交
3425
                                       *cfd->options())) {
3426 3427
      // Done
    } else {
I
Igor Canadi 已提交
3428
      super_version->current->Get(options, lkey, value, &s, &merge_context);
3429 3430 3431
    }

    if (s.ok()) {
3432
      bytes_read += value->size();
3433 3434 3435 3436
    }
  }

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

I
Igor Canadi 已提交
3440
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3441 3442 3443 3444 3445 3446
  mutex_.Lock();
  for (auto mgd_iter : multiget_cf_data) {
    auto mgd = mgd_iter.second;
    if (mgd->super_version->Unref()) {
      mgd->super_version->Cleanup();
      superversions_to_delete.push_back(mgd->super_version);
3447 3448
    }
  }
3449 3450 3451 3452 3453 3454 3455
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3456
  }
3457

L
Lei Jin 已提交
3458 3459 3460
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
L
Lei Jin 已提交
3461
  PERF_TIMER_STOP(get_post_process_time);
3462

3463
  return stat_list;
3464 3465
}

3466
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& options,
3467
                                  const std::string& column_family_name,
3468
                                  ColumnFamilyHandle** handle) {
I
Igor Canadi 已提交
3469 3470 3471
  *handle = nullptr;
  MutexLock l(&mutex_);

I
Igor Canadi 已提交
3472 3473
  if (versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name) !=
      nullptr) {
I
Igor Canadi 已提交
3474 3475
    return Status::InvalidArgument("Column family already exists");
  }
3476
  VersionEdit edit;
3477
  edit.AddColumnFamily(column_family_name);
3478 3479
  uint32_t new_id = versions_->GetColumnFamilySet()->GetNextColumnFamilyID();
  edit.SetColumnFamily(new_id);
I
Igor Canadi 已提交
3480
  edit.SetLogNumber(logfile_number_);
I
Igor Canadi 已提交
3481
  edit.SetComparatorName(options.comparator->Name());
3482

I
Igor Canadi 已提交
3483 3484
  // LogAndApply will both write the creation in MANIFEST and create
  // ColumnFamilyData object
3485 3486
  Status s = versions_->LogAndApply(nullptr, &edit, &mutex_,
                                    db_directory_.get(), false, &options);
3487
  if (s.ok()) {
3488
    single_column_family_mode_ = false;
3489 3490 3491
    auto cfd =
        versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
    assert(cfd != nullptr);
3492
    delete cfd->InstallSuperVersion(new SuperVersion(), &mutex_);
3493
    *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
I
Igor Canadi 已提交
3494
    Log(options_.info_log, "Created column family [%s] (ID %u)",
3495
        column_family_name.c_str(), (unsigned)cfd->GetID());
I
Igor Canadi 已提交
3496 3497
    max_total_in_memory_state_ += cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
3498
  } else {
I
Igor Canadi 已提交
3499
    Log(options_.info_log, "Creating column family [%s] FAILED -- %s",
3500 3501
        column_family_name.c_str(), s.ToString().c_str());
  }
3502
  return s;
3503 3504
}

3505 3506 3507 3508
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3509 3510
    return Status::InvalidArgument("Can't drop default column family");
  }
3511

I
Igor Canadi 已提交
3512 3513
  VersionEdit edit;
  edit.DropColumnFamily();
3514 3515
  edit.SetColumnFamily(cfd->GetID());

3516
  Status s;
3517 3518 3519 3520 3521 3522 3523 3524
  {
    MutexLock l(&mutex_);
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
      s = versions_->LogAndApply(cfd, &edit, &mutex_);
    }
3525
  }
3526

3527
  if (s.ok()) {
I
Igor Canadi 已提交
3528
    assert(cfd->IsDropped());
I
Igor Canadi 已提交
3529 3530
    max_total_in_memory_state_ -= cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
3531
    Log(options_.info_log, "Dropped column family with id %u\n", cfd->GetID());
3532
    // Flush the memtables. This will make all WAL files referencing dropped
I
Igor Canadi 已提交
3533
    // column family to be obsolete. They will be deleted once user deletes
3534 3535
    // column family handle
    Write(WriteOptions(), nullptr);  // ignore error
3536 3537 3538 3539 3540
  } else {
    Log(options_.info_log, "Dropping column family with id %u FAILED -- %s\n",
        cfd->GetID(), s.ToString().c_str());
  }

3541
  return s;
3542 3543
}

3544
bool DBImpl::KeyMayExist(const ReadOptions& options,
3545 3546
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
3547
  if (value_found != nullptr) {
K
Kai Liu 已提交
3548 3549
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
3550
  }
3551 3552
  ReadOptions roptions = options;
  roptions.read_tier = kBlockCacheTier; // read from block cache only
3553
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
3554 3555 3556 3557 3558

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

3561
Iterator* DBImpl::NewIterator(const ReadOptions& options,
3562 3563 3564
                              ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
3565 3566

  if (options.tailing) {
I
Igor Canadi 已提交
3567 3568 3569 3570
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
L
Lei Jin 已提交
3571
    // TODO(ljin): remove tailing iterator
I
Igor Canadi 已提交
3572
    auto iter = new ForwardIterator(this, options, cfd);
3573 3574 3575
    return NewDBIterator(env_, *cfd->options(), cfd->user_comparator(), iter,
                         kMaxSequenceNumber);
// return new TailingIterator(env_, this, options, cfd);
I
Igor Canadi 已提交
3576
#endif
T
Tomislav Novak 已提交
3577
  } else {
3578 3579 3580 3581
    SequenceNumber latest_snapshot = versions_->LastSequence();
    SuperVersion* sv = nullptr;
    sv = cfd->GetReferencedSuperVersion(&mutex_);

I
Igor Canadi 已提交
3582 3583 3584 3585
    auto snapshot =
        options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_
            : latest_snapshot;
T
Tomislav Novak 已提交
3586

3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636
    // Try to generate a DB iterator tree in continuous memory area to be
    // cache friendly. Here is an example of result:
    // +-------------------------------+
    // |                               |
    // | ArenaWrappedDBIter            |
    // |  +                            |
    // |  +---> Inner Iterator   ------------+
    // |  |                            |     |
    // |  |    +-- -- -- -- -- -- -- --+     |
    // |  +--- | Arena                 |     |
    // |       |                       |     |
    // |          Allocated Memory:    |     |
    // |       |   +-------------------+     |
    // |       |   | DBIter            | <---+
    // |           |  +                |
    // |       |   |  +-> iter_  ------------+
    // |       |   |                   |     |
    // |       |   +-------------------+     |
    // |       |   | MergingIterator   | <---+
    // |           |  +                |
    // |       |   |  +->child iter1  ------------+
    // |       |   |  |                |          |
    // |           |  +->child iter2  ----------+ |
    // |       |   |  |                |        | |
    // |       |   |  +->child iter3  --------+ | |
    // |           |                   |      | | |
    // |       |   +-------------------+      | | |
    // |       |   | Iterator1         | <--------+
    // |       |   +-------------------+      | |
    // |       |   | Iterator2         | <------+
    // |       |   +-------------------+      |
    // |       |   | Iterator3         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
    // ArenaWrappedDBIter inlines an arena area where all the iterartor in the
    // the iterator tree is allocated in the order of being accessed when
    // querying.
    // Laying out the iterators in the order of being accessed makes it more
    // likely that any iterator pointer is close to the iterator it points to so
    // that they are likely to be in the same cache line and/or page.
    ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
        env_, *cfd->options(), cfd->user_comparator(), snapshot);
    Iterator* internal_iter =
        NewInternalIterator(options, cfd, sv, db_iter->GetArena());
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
J
jorlow@chromium.org 已提交
3637 3638
}

3639 3640
Status DBImpl::NewIterators(
    const ReadOptions& options,
I
Igor Canadi 已提交
3641
    const std::vector<ColumnFamilyHandle*>& column_families,
3642
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659
  iterators->clear();
  iterators->reserve(column_families.size());
  SequenceNumber latest_snapshot = 0;
  std::vector<SuperVersion*> super_versions;
  super_versions.reserve(column_families.size());

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

  if (options.tailing) {
I
Igor Canadi 已提交
3660 3661 3662 3663
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
3664 3665
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
L
Lei Jin 已提交
3666
      iterators->push_back(new TailingIterator(env_, this, options, cfd));
I
Igor Canadi 已提交
3667
    }
I
Igor Canadi 已提交
3668
#endif
I
Igor Canadi 已提交
3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679
  } else {
    for (size_t i = 0; i < column_families.size(); ++i) {
      auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_families[i]);
      auto cfd = cfh->cfd();

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

      auto iter = NewInternalIterator(options, cfd, super_versions[i]);
L
Lei Jin 已提交
3680
      iter = NewDBIterator(env_, *cfd->options(),
I
Igor Canadi 已提交
3681 3682 3683 3684 3685 3686
                           cfd->user_comparator(), iter, snapshot);
      iterators->push_back(iter);
    }
  }

  return Status::OK();
3687 3688
}

3689 3690 3691 3692 3693 3694 3695 3696 3697
bool DBImpl::IsSnapshotSupported() const {
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (!cfd->mem()->IsSnapshotSupported()) {
      return false;
    }
  }
  return true;
}

J
jorlow@chromium.org 已提交
3698
const Snapshot* DBImpl::GetSnapshot() {
3699
  MutexLock l(&mutex_);
3700 3701
  // returns null if the underlying memtable does not support snapshot.
  if (!IsSnapshotSupported()) return nullptr;
3702
  return snapshots_.New(versions_->LastSequence());
J
jorlow@chromium.org 已提交
3703 3704 3705 3706
}

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

// Convenience methods
3711 3712
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
3713
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
3714 3715
}

3716 3717 3718 3719
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) {
3720 3721
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
3722
    return DB::Merge(o, column_family, key, val);
3723 3724 3725
  }
}

3726
Status DBImpl::Delete(const WriteOptions& options,
3727
                      ColumnFamilyHandle* column_family, const Slice& key) {
3728
  return DB::Delete(options, column_family, key);
J
jorlow@chromium.org 已提交
3729 3730
}

3731
Status DBImpl::Write(const WriteOptions& options, WriteBatch* my_batch) {
L
Lei Jin 已提交
3732
  PERF_TIMER_AUTO(write_pre_and_post_process_time);
3733 3734 3735
  Writer w(&mutex_);
  w.batch = my_batch;
  w.sync = options.sync;
H
heyongqiang 已提交
3736
  w.disableWAL = options.disableWAL;
3737 3738 3739 3740 3741 3742 3743 3744 3745 3746
  w.in_batch_group = false;
  w.done = false;
  w.timeout_hint_us = options.timeout_hint_us;

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

I
Igor Canadi 已提交
3749
  mutex_.Lock();
3750 3751 3752 3753 3754
  // the following code block pushes the current writer "w" into the writer
  // queue "writers_" and wait until one of the following conditions met:
  // 1. the job of "w" has been done by some other writers.
  // 2. "w" becomes the first writer in "writers_"
  // 3. "w" timed-out.
3755
  writers_.push_back(&w);
3756 3757

  bool timed_out = false;
3758
  while (!w.done && &w != writers_.front()) {
3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771
    if (expiration_time == 0) {
      w.cv.Wait();
    } else if (w.cv.TimedWait(expiration_time)) {
      if (w.in_batch_group) {
        // then it means the front writer is currently doing the
        // write on behalf of this "timed-out" writer.  Then it
        // should wait until the write completes.
        expiration_time = 0;
      } else {
        timed_out = true;
        break;
      }
    }
3772
  }
3773 3774

  if (!options.disableWAL) {
L
Lei Jin 已提交
3775
    RecordTick(stats_, WRITE_WITH_WAL);
3776 3777
    default_cf_internal_stats_->AddDBStats(
        InternalStats::WRITE_WITH_WAL, 1);
3778 3779
  }

3780
  if (w.done) {
3781 3782
    default_cf_internal_stats_->AddDBStats(
        InternalStats::WRITE_DONE_BY_OTHER, 1);
I
Igor Canadi 已提交
3783
    mutex_.Unlock();
L
Lei Jin 已提交
3784
    RecordTick(stats_, WRITE_DONE_BY_OTHER);
3785
    return w.status;
3786
  } else if (timed_out) {
3787
#ifndef NDEBUG
3788
    bool found = false;
3789
#endif
3790 3791 3792
    for (auto iter = writers_.begin(); iter != writers_.end(); iter++) {
      if (*iter == &w) {
        writers_.erase(iter);
3793
#ifndef NDEBUG
3794
        found = true;
3795
#endif
3796 3797 3798
        break;
      }
    }
3799
#ifndef NDEBUG
3800
    assert(found);
3801
#endif
3802 3803 3804 3805 3806 3807 3808
    // writers_.front() might still be in cond_wait without a time-out.
    // As a result, we need to signal it to wake it up.  Otherwise no
    // one else will wake him up, and RocksDB will hang.
    if (!writers_.empty()) {
      writers_.front()->cv.Signal();
    }
    mutex_.Unlock();
L
Lei Jin 已提交
3809
    RecordTick(stats_, WRITE_TIMEDOUT);
3810
    return Status::TimedOut();
3811
  } else {
L
Lei Jin 已提交
3812
    RecordTick(stats_, WRITE_DONE_BY_SELF);
3813 3814
    default_cf_internal_stats_->AddDBStats(
        InternalStats::WRITE_DONE_BY_SELF, 1);
3815 3816
  }

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

I
Igor Canadi 已提交
3824
  uint64_t flush_column_family_if_log_file = 0;
I
Igor Canadi 已提交
3825
  uint64_t max_total_wal_size = (options_.max_total_wal_size == 0)
3826
                                    ? 4 * max_total_in_memory_state_
I
Igor Canadi 已提交
3827
                                    : options_.max_total_wal_size;
3828
  if (UNLIKELY(!single_column_family_mode_) &&
3829
      alive_log_files_.begin()->getting_flushed == false &&
I
Igor Canadi 已提交
3830 3831 3832 3833
      total_log_size_ > max_total_wal_size) {
    flush_column_family_if_log_file = alive_log_files_.begin()->number;
    alive_log_files_.begin()->getting_flushed = true;
    Log(options_.info_log,
3834 3835 3836
        "Flushing all column families with data in WAL number %" PRIu64
        ". Total log size is %" PRIu64 " while max_total_wal_size is %" PRIu64,
        flush_column_family_if_log_file, total_log_size_, max_total_wal_size);
I
Igor Canadi 已提交
3837 3838
  }

3839
  Status status;
3840 3841
  autovector<SuperVersion*> superversions_to_free;
  autovector<log::Writer*> logs_to_free;
3842 3843 3844

  if (LIKELY(single_column_family_mode_)) {
    // fast path
3845 3846 3847 3848
    status = MakeRoomForWrite(
        default_cf_handle_->cfd(), my_batch == nullptr,
        &superversions_to_free, &logs_to_free,
        expiration_time);
3849 3850 3851 3852 3853 3854 3855 3856 3857 3858
  } else {
    // refcounting cfd in iteration
    bool dead_cfd = false;
    for (auto cfd : *versions_->GetColumnFamilySet()) {
      cfd->Ref();
      bool force_flush =
          my_batch == nullptr ||
          (flush_column_family_if_log_file != 0 &&
           cfd->GetLogNumber() <= flush_column_family_if_log_file);
      // May temporarily unlock and wait.
3859 3860 3861
      status = MakeRoomForWrite(
          cfd, force_flush, &superversions_to_free, &logs_to_free,
          expiration_time);
3862 3863 3864 3865 3866 3867
      if (cfd->Unref()) {
        dead_cfd = true;
      }
      if (!status.ok()) {
        break;
      }
3868
    }
3869 3870
    if (dead_cfd) {
      versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
3871 3872
    }
  }
3873

D
dgrogan@chromium.org 已提交
3874
  uint64_t last_sequence = versions_->LastSequence();
3875
  Writer* last_writer = &w;
3876
  if (status.ok() && my_batch != nullptr) {  // nullptr batch is for compactions
3877 3878
    autovector<WriteBatch*> write_batch_group;
    BuildBatchGroup(&last_writer, &write_batch_group);
3879

3880 3881 3882
    // 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
3883
    // into memtables
3884
    {
3885
      mutex_.Unlock();
3886 3887 3888 3889 3890 3891 3892 3893 3894 3895
      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]);
        }
      }

3896 3897 3898 3899
      const SequenceNumber current_sequence = last_sequence + 1;
      WriteBatchInternal::SetSequence(updates, current_sequence);
      int my_batch_count = WriteBatchInternal::Count(updates);
      last_sequence += my_batch_count;
3900
      const uint64_t batch_size = WriteBatchInternal::ByteSize(updates);
3901
      // Record statistics
L
Lei Jin 已提交
3902 3903
      RecordTick(stats_, NUMBER_KEYS_WRITTEN, my_batch_count);
      RecordTick(stats_, BYTES_WRITTEN, WriteBatchInternal::ByteSize(updates));
3904 3905
      if (options.disableWAL) {
        flush_on_destroy_ = true;
3906
      }
L
Lei Jin 已提交
3907
      PERF_TIMER_STOP(write_pre_and_post_process_time);
3908

3909
      uint64_t log_size = 0;
3910
      if (!options.disableWAL) {
L
Lei Jin 已提交
3911
        PERF_TIMER_START(write_wal_time);
3912 3913
        Slice log_entry = WriteBatchInternal::Contents(updates);
        status = log_->AddRecord(log_entry);
I
Igor Canadi 已提交
3914 3915
        total_log_size_ += log_entry.size();
        alive_log_files_.back().AddSize(log_entry.size());
3916
        log_empty_ = false;
3917
        log_size = log_entry.size();
L
Lei Jin 已提交
3918 3919
        RecordTick(stats_, WAL_FILE_SYNCED);
        RecordTick(stats_, WAL_FILE_BYTES, log_size);
H
heyongqiang 已提交
3920
        if (status.ok() && options.sync) {
3921
          if (options_.use_fsync) {
L
Lei Jin 已提交
3922
            StopWatch(env_, stats_, WAL_FILE_SYNC_MICROS);
3923
            status = log_->file()->Fsync();
3924
          } else {
L
Lei Jin 已提交
3925
            StopWatch(env_, stats_, WAL_FILE_SYNC_MICROS);
3926
            status = log_->file()->Sync();
3927
          }
H
heyongqiang 已提交
3928
        }
L
Lei Jin 已提交
3929
        PERF_TIMER_STOP(write_wal_time);
3930 3931
      }
      if (status.ok()) {
L
Lei Jin 已提交
3932
        PERF_TIMER_START(write_memtable_time);
Y
Yueh-Hsuan Chiang 已提交
3933

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

L
Lei Jin 已提交
3944
        PERF_TIMER_STOP(write_memtable_time);
3945

L
Lei Jin 已提交
3946
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
3947
      }
L
Lei Jin 已提交
3948
      PERF_TIMER_START(write_pre_and_post_process_time);
3949 3950 3951
      if (updates == &tmp_batch_) {
        tmp_batch_.Clear();
      }
3952
      mutex_.Lock();
3953 3954 3955 3956 3957 3958 3959 3960 3961
      // internal stats
      default_cf_internal_stats_->AddDBStats(
          InternalStats::BYTES_WRITTEN, batch_size);
      if (!options.disableWAL) {
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_SYNCED, 1);
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_BYTES, log_size);
      }
3962
      if (status.ok()) {
3963
        versions_->SetLastSequence(last_sequence);
3964
      }
J
jorlow@chromium.org 已提交
3965 3966
    }
  }
3967 3968
  if (options_.paranoid_checks && !status.ok() &&
      !status.IsTimedOut() && bg_error_.ok()) {
I
Igor Canadi 已提交
3969 3970
    bg_error_ = status; // stop compaction & fail any further writes
  }
3971

3972 3973 3974
  // Pop out the current writer and all writers being pushed before the
  // current writer from the writer queue.
  while (!writers_.empty()) {
3975 3976 3977 3978 3979 3980
    Writer* ready = writers_.front();
    writers_.pop_front();
    if (ready != &w) {
      ready->status = status;
      ready->done = true;
      ready->cv.Signal();
3981
    }
3982 3983
    if (ready == last_writer) break;
  }
3984

3985 3986 3987
  // Notify new head of write queue
  if (!writers_.empty()) {
    writers_.front()->cv.Signal();
3988
  }
I
Igor Canadi 已提交
3989
  mutex_.Unlock();
3990

3991
  if (status.IsTimedOut()) {
L
Lei Jin 已提交
3992
    RecordTick(stats_, WRITE_TIMEDOUT);
3993 3994
  }

3995 3996 3997 3998 3999 4000 4001
  for (auto& sv : superversions_to_free) {
    delete sv;
  }
  for (auto& log : logs_to_free) {
    delete log;
  }

L
Lei Jin 已提交
4002
  PERF_TIMER_STOP(write_pre_and_post_process_time);
J
jorlow@chromium.org 已提交
4003 4004 4005
  return status;
}

4006 4007 4008
// This function will be called only when the first writer succeeds.
// All writers in the to-be-built batch group will be processed.
//
4009
// REQUIRES: Writer list must be non-empty
4010
// REQUIRES: First writer must have a non-nullptr batch
4011 4012
void DBImpl::BuildBatchGroup(Writer** last_writer,
                             autovector<WriteBatch*>* write_batch_group) {
4013 4014
  assert(!writers_.empty());
  Writer* first = writers_.front();
4015
  assert(first->batch != nullptr);
4016 4017

  size_t size = WriteBatchInternal::ByteSize(first->batch);
4018
  write_batch_group->push_back(first->batch);
4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037

  // 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 已提交
4038 4039 4040 4041 4042 4043
    if (!w->disableWAL && first->disableWAL) {
      // Do not include a write that needs WAL into a batch that has
      // WAL disabled.
      break;
    }

4044 4045 4046 4047 4048 4049
    if (w->timeout_hint_us < first->timeout_hint_us) {
      // Do not include those writes with shorter timeout.  Otherwise, we might
      // execute a write that should instead be aborted because of timeout.
      break;
    }

4050
    if (w->batch != nullptr) {
4051 4052 4053 4054 4055 4056
      size += WriteBatchInternal::ByteSize(w->batch);
      if (size > max_size) {
        // Do not make batch too big
        break;
      }

4057
      write_batch_group->push_back(w->batch);
4058
    }
4059
    w->in_batch_group = true;
4060 4061 4062 4063
    *last_writer = w;
  }
}

4064 4065 4066
// 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 已提交
4067 4068 4069 4070
// if n < bottom, return 0;
// if n >= top, return 1000;
// otherwise, let r = (n - bottom) /
//                    (top - bottom)
4071 4072 4073 4074
//  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 已提交
4075
uint64_t DBImpl::SlowdownAmount(int n, double bottom, double top) {
4076
  uint64_t delay;
J
Jim Paton 已提交
4077
  if (n >= top) {
4078 4079
    delay = 1000;
  }
J
Jim Paton 已提交
4080
  else if (n < bottom) {
4081 4082 4083 4084
    delay = 0;
  }
  else {
    // If we are here, we know that:
J
Jim Paton 已提交
4085
    //   level0_start_slowdown <= n < level0_slowdown
4086
    // since the previous two conditions are false.
M
Mark Callaghan 已提交
4087 4088
    double how_much =
      (double) (n - bottom) /
J
Jim Paton 已提交
4089
              (top - bottom);
M
Mark Callaghan 已提交
4090
    delay = std::max(how_much * how_much * 1000, 100.0);
4091 4092 4093 4094 4095
  }
  assert(delay <= 1000);
  return delay;
}

4096
// REQUIRES: mutex_ is held
4097
// REQUIRES: this thread is currently at the front of the writer queue
4098 4099 4100
Status DBImpl::MakeRoomForWrite(
    ColumnFamilyData* cfd, bool force,
    autovector<SuperVersion*>* superversions_to_free,
4101 4102
    autovector<log::Writer*>* logs_to_free,
    uint64_t expiration_time) {
4103
  mutex_.AssertHeld();
4104
  assert(!writers_.empty());
4105
  bool allow_delay = !force;
J
Jim Paton 已提交
4106 4107
  bool allow_hard_rate_limit_delay = !force;
  bool allow_soft_rate_limit_delay = !force;
4108
  uint64_t rate_limit_delay_millis = 0;
4109
  Status s;
4110
  double score;
4111 4112 4113 4114
  // Once we schedule background work, we shouldn't schedule it again, since it
  // might generate a tight feedback loop, constantly scheduling more background
  // work, even if additional background work is not needed
  bool schedule_background_work = true;
4115
  bool has_timeout = (expiration_time > 0);
4116

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

4235
      // Attempt to switch to a new memtable and trigger flush of old.
4236
      // Do this without holding the dbmutex lock.
4237
      assert(versions_->PrevLogNumber() == 0);
I
Igor Canadi 已提交
4238 4239 4240
      bool creating_new_log = !log_empty_;
      uint64_t new_log_number =
          creating_new_log ? versions_->NewFileNumber() : logfile_number_;
I
Igor Canadi 已提交
4241
      SuperVersion* new_superversion = nullptr;
4242 4243 4244
      mutex_.Unlock();
      {
        DelayLoggingAndReset();
I
Igor Canadi 已提交
4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257
        if (creating_new_log) {
          s = env_->NewWritableFile(
              LogFileName(options_.wal_dir, new_log_number), &lfile,
              env_->OptimizeForLogWrite(storage_options_));
          if (s.ok()) {
            // Our final size should be less than write_buffer_size
            // (compression, etc) but err on the side of caution.
            lfile->SetPreallocationBlockSize(1.1 *
                                             cfd->options()->write_buffer_size);
            new_log = new log::Writer(std::move(lfile));
          }
        }

4258
        if (s.ok()) {
4259
          new_mem = new MemTable(cfd->internal_comparator(), *cfd->options());
4260
          new_superversion = new SuperVersion();
4261 4262 4263
        }
      }
      mutex_.Lock();
4264
      if (!s.ok()) {
I
Igor Canadi 已提交
4265 4266
        // how do we fail if we're not creating new log?
        assert(creating_new_log);
H
heyongqiang 已提交
4267
        // Avoid chewing through file number space in a tight loop.
4268
        versions_->ReuseLogFileNumber(new_log_number);
4269
        assert(!new_mem);
4270
        assert(!new_log);
4271 4272
        break;
      }
I
Igor Canadi 已提交
4273 4274 4275
      if (creating_new_log) {
        logfile_number_ = new_log_number;
        assert(new_log != nullptr);
4276
        logs_to_free->push_back(log_.release());
I
Igor Canadi 已提交
4277 4278
        log_.reset(new_log);
        log_empty_ = true;
I
Igor Canadi 已提交
4279
        alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
I
Igor Canadi 已提交
4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290
        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_);
          }
        }
      }
4291 4292
      cfd->mem()->SetNextLogNumber(logfile_number_);
      cfd->imm()->Add(cfd->mem());
4293
      if (force) {
4294
        cfd->imm()->FlushRequested();
4295
      }
4296 4297
      new_mem->Ref();
      cfd->SetMemtable(new_mem);
4298 4299 4300
      Log(options_.info_log,
          "[%s] New memtable created with log file: #%" PRIu64 "\n",
          cfd->GetName().c_str(), logfile_number_);
4301
      force = false;  // Do not force another compaction if have room
4302
      MaybeScheduleFlushOrCompaction();
4303 4304
      superversions_to_free->push_back(
          cfd->InstallSuperVersion(new_superversion, &mutex_));
4305 4306 4307 4308 4309
    }
  }
  return s;
}

I
Igor Canadi 已提交
4310
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4311 4312 4313 4314 4315
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4316 4317
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4318
  auto version = cfd->current();
4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
I
Igor Canadi 已提交
4331
#endif  // ROCKSDB_LITE
4332

I
Igor Canadi 已提交
4333 4334 4335 4336
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4337 4338 4339 4340
Env* DBImpl::GetEnv() const {
  return env_;
}

4341 4342
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4343
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4344 4345
}

4346
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4347
                         const Slice& property, std::string* value) {
4348 4349
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4350 4351 4352
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);

4353
  value->clear();
4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368
  if (is_int_property) {
    uint64_t int_value;
    bool ret_value = GetIntPropertyInternal(column_family, property_type,
                                            need_out_of_mutex, &int_value);
    if (ret_value) {
      *value = std::to_string(int_value);
    }
    return ret_value;
  } else {
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
    auto cfd = cfh->cfd();
    MutexLock l(&mutex_);
    return cfd->internal_stats()->GetStringProperty(property_type, property,
                                                    value);
  }
J
jorlow@chromium.org 已提交
4369 4370
}

4371 4372
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
4373 4374
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);
  if (!is_int_property) {
    return false;
  }
  return GetIntPropertyInternal(column_family, property_type, need_out_of_mutex,
                                value);
}

bool DBImpl::GetIntPropertyInternal(ColumnFamilyHandle* column_family,
                                    DBPropertyType property_type,
                                    bool need_out_of_mutex, uint64_t* value) {
4387 4388
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 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

  if (!need_out_of_mutex) {
    MutexLock l(&mutex_);
    return cfd->internal_stats()->GetIntProperty(property_type, value);
  } else {
    SuperVersion* sv = GetAndRefSuperVersion(cfd);

    bool ret = cfd->internal_stats()->GetIntPropertyOutOfMutex(
        property_type, sv->current, value);

    ReturnAndCleanupSuperVersion(cfd, sv);

    return ret;
  }
}

SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
  if (LIKELY(options_.allow_thread_local)) {
    return cfd->GetThreadLocalSuperVersion(&mutex_);
  } else {
    MutexLock l(&mutex_);
    return cfd->GetSuperVersion()->Ref();
  }
}

void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
  bool unref_sv = true;
  if (LIKELY(options_.allow_thread_local)) {
    unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
  }

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
        MutexLock l(&mutex_);
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
4434 4435
}

4436
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4437
                                 const Range* range, int n, uint64_t* sizes) {
J
jorlow@chromium.org 已提交
4438 4439
  // TODO(opt): better implementation
  Version* v;
4440 4441
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
J
jorlow@chromium.org 已提交
4442 4443
  {
    MutexLock l(&mutex_);
4444
    v = cfd->current();
4445
    v->Ref();
J
jorlow@chromium.org 已提交
4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462
  }

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

4463 4464 4465 4466 4467 4468 4469
inline void DBImpl::DelayLoggingAndReset() {
  if (delayed_writes_ > 0) {
    Log(options_.info_log, "delayed %d write...\n", delayed_writes_ );
    delayed_writes_ = 0;
  }
}

I
Igor Canadi 已提交
4470 4471 4472 4473 4474
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
4475
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
  //  Get all sorted Wal Files.
  //  Do binary search and open files and find the seq number.

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

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

4498 4499 4500
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4501 4502 4503 4504
  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());
4505 4506 4507
    return Status::InvalidArgument("Invalid file name");
  }

4508 4509 4510 4511
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4512 4513
      Log(options_.info_log, "DeleteFile %s failed - not archived log.\n",
          name.c_str());
4514 4515 4516 4517
      return Status::NotSupported("Delete only supported for archived logs");
    }
    status = env_->DeleteFile(options_.wal_dir + "/" + name.c_str());
    if (!status.ok()) {
4518 4519
      Log(options_.info_log, "DeleteFile %s failed -- %s.\n",
          name.c_str(), status.ToString().c_str());
4520 4521 4522 4523
    }
    return status;
  }

4524
  int level;
I
Igor Canadi 已提交
4525
  FileMetaData* metadata;
4526
  ColumnFamilyData* cfd;
4527
  VersionEdit edit;
K
Kai Liu 已提交
4528
  DeletionState deletion_state(true);
D
Dhruba Borthakur 已提交
4529 4530
  {
    MutexLock l(&mutex_);
4531
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
4532
    if (!status.ok()) {
4533 4534
      Log(options_.info_log, "DeleteFile %s failed. File not found\n",
                             name.c_str());
D
Dhruba Borthakur 已提交
4535 4536
      return Status::InvalidArgument("File not found");
    }
I
Igor Canadi 已提交
4537
    assert((level > 0) && (level < cfd->NumberLevels()));
4538

D
Dhruba Borthakur 已提交
4539
    // If the file is being compacted no need to delete.
4540
    if (metadata->being_compacted) {
4541
      Log(options_.info_log,
4542
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
D
Dhruba Borthakur 已提交
4543
      return Status::OK();
4544 4545
    }

D
Dhruba Borthakur 已提交
4546 4547 4548
    // 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 已提交
4549
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
4550
      if (cfd->current()->NumLevelFiles(i) != 0) {
D
Dhruba Borthakur 已提交
4551
        Log(options_.info_log,
4552
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
D
Dhruba Borthakur 已提交
4553 4554 4555 4556
        return Status::InvalidArgument("File not in last level");
      }
    }
    edit.DeleteFile(level, number);
4557
    status = versions_->LogAndApply(cfd, &edit, &mutex_, db_directory_.get());
I
Igor Canadi 已提交
4558
    if (status.ok()) {
4559
      InstallSuperVersion(cfd, deletion_state);
I
Igor Canadi 已提交
4560
    }
I
Igor Canadi 已提交
4561
    FindObsoleteFiles(deletion_state, false);
D
Dhruba Borthakur 已提交
4562
  } // lock released here
I
Igor Canadi 已提交
4563
  LogFlush(options_.info_log);
I
Igor Canadi 已提交
4564
  // remove files outside the db-lock
4565 4566 4567
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
4568 4569 4570 4571 4572 4573
  {
    MutexLock l(&mutex_);
    // schedule flush if file deletion means we freed the space for flushes to
    // continue
    MaybeScheduleFlushOrCompaction();
  }
4574 4575 4576
  return status;
}

4577
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4578
  MutexLock l(&mutex_);
4579
  versions_->GetLiveFilesMetaData(metadata);
4580
}
I
Igor Canadi 已提交
4581
#endif  // ROCKSDB_LITE
4582

I
Igor Canadi 已提交
4583 4584 4585 4586 4587 4588 4589
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
4592 4593 4594 4595 4596 4597
    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) {
4598
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610
                             ". 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);
  }
}

4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637
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 已提交
4638 4639
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
4640
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
4641
               const Slice& key, const Slice& value) {
4642 4643 4644 4645
  // 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);
4646
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
4647 4648 4649
  return Write(opt, &batch);
}

4650 4651
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
4652
  WriteBatch batch;
4653
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
4654 4655 4656
  return Write(opt, &batch);
}

4657 4658
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
4659
  WriteBatch batch;
4660
  batch.Merge(column_family, key, value);
4661 4662 4663
  return Write(opt, &batch);
}

4664 4665
// Default implementation -- returns not supported status
Status DB::CreateColumnFamily(const ColumnFamilyOptions& options,
4666
                              const std::string& column_family_name,
4667
                              ColumnFamilyHandle** handle) {
4668
  return Status::NotSupported("");
4669
}
4670
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
4671
  return Status::NotSupported("");
4672 4673
}

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

J
Jim Paton 已提交
4676
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
4677 4678 4679 4680
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
4681
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
4682 4683 4684 4685 4686 4687 4688 4689 4690
  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;
4691 4692
}

4693 4694
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
4695
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
4696
  if (db_options.db_paths.size() > 1) {
4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708
    for (auto& cfd : column_families) {
      if (cfd.options.compaction_style != kCompactionStyleUniversal) {
        return Status::NotSupported(
            "More than one DB paths are only supported in "
            "universal compaction style. ");
      }
    }

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

4711
  *dbptr = nullptr;
4712
  handles->clear();
J
jorlow@chromium.org 已提交
4713

I
Igor Canadi 已提交
4714 4715 4716 4717 4718 4719 4720 4721
  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");
    }
4722
  }
4723

I
Igor Canadi 已提交
4724
  DBImpl* impl = new DBImpl(db_options, dbname);
4725
  Status s = impl->env_->CreateDirIfMissing(impl->options_.wal_dir);
4726
  if (s.ok()) {
4727 4728
    for (auto db_path : impl->options_.db_paths) {
      s = impl->env_->CreateDirIfMissing(db_path.path);
4729 4730 4731 4732 4733 4734
      if (!s.ok()) {
        break;
      }
    }
  }

4735 4736 4737 4738 4739 4740
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
4741 4742 4743 4744
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
4745
  impl->mutex_.Lock();
4746 4747
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
4748
  if (s.ok()) {
4749
    uint64_t new_log_number = impl->versions_->NewFileNumber();
4750
    unique_ptr<WritableFile> lfile;
4751
    EnvOptions soptions(db_options);
4752
    s = impl->options_.env->NewWritableFile(
I
Igor Canadi 已提交
4753
        LogFileName(impl->options_.wal_dir, new_log_number), &lfile,
I
Igor Canadi 已提交
4754
        impl->options_.env->OptimizeForLogWrite(soptions));
J
jorlow@chromium.org 已提交
4755
    if (s.ok()) {
4756
      lfile->SetPreallocationBlockSize(1.1 * max_write_buffer_size);
4757
      impl->logfile_number_ = new_log_number;
4758
      impl->log_.reset(new log::Writer(std::move(lfile)));
I
Igor Canadi 已提交
4759

4760 4761
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
4762 4763
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782
        if (cfd != nullptr) {
          handles->push_back(
              new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
        } else {
          if (db_options.create_missing_column_families) {
            // missing column family, create it
            ColumnFamilyHandle* handle;
            impl->mutex_.Unlock();
            s = impl->CreateColumnFamily(cf.options, cf.name, &handle);
            impl->mutex_.Lock();
            if (s.ok()) {
              handles->push_back(handle);
            } else {
              break;
            }
          } else {
            s = Status::InvalidArgument("Column family not found: ", cf.name);
            break;
          }
I
Igor Canadi 已提交
4783
        }
4784
      }
I
Igor Canadi 已提交
4785 4786
    }
    if (s.ok()) {
4787
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
4788
        delete cfd->InstallSuperVersion(new SuperVersion(), &impl->mutex_);
4789
      }
I
Igor Canadi 已提交
4790 4791
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
4792
      impl->DeleteObsoleteFiles();
4793
      impl->MaybeScheduleFlushOrCompaction();
4794
      s = impl->db_directory_->Fsync();
J
jorlow@chromium.org 已提交
4795 4796
    }
  }
4797

I
Igor Canadi 已提交
4798 4799
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
4800 4801
      if (cfd->options()->compaction_style == kCompactionStyleUniversal ||
          cfd->options()->compaction_style == kCompactionStyleFIFO) {
I
Igor Canadi 已提交
4802 4803 4804 4805
        Version* current = cfd->current();
        for (int i = 1; i < current->NumberLevels(); ++i) {
          int num_files = current->NumLevelFiles(i);
          if (num_files > 0) {
I
Igor Canadi 已提交
4806 4807 4808
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
                "open with universal or FIFO compaction style.");
I
Igor Canadi 已提交
4809 4810 4811 4812
            break;
          }
        }
      }
4813 4814 4815 4816 4817 4818
      if (cfd->options()->merge_operator != nullptr &&
          !cfd->mem()->IsMergeOperatorSupported()) {
        s = Status::InvalidArgument(
            "The memtable of column family %s does not support merge operator "
            "its options.merge_operator is non-null", cfd->GetName().c_str());
      }
I
Igor Canadi 已提交
4819
      if (!s.ok()) {
4820 4821 4822 4823 4824
        break;
      }
    }
  }

4825 4826
  impl->mutex_.Unlock();

J
jorlow@chromium.org 已提交
4827
  if (s.ok()) {
4828
    impl->opened_successfully_ = true;
J
jorlow@chromium.org 已提交
4829 4830
    *dbptr = impl;
  } else {
4831 4832 4833
    for (auto h : *handles) {
      delete h;
    }
4834
    handles->clear();
J
jorlow@chromium.org 已提交
4835 4836 4837 4838 4839
    delete impl;
  }
  return s;
}

4840 4841 4842
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
4843
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
4844 4845
}

4846 4847 4848
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
4849
Status DestroyDB(const std::string& dbname, const Options& options) {
4850 4851 4852 4853 4854
  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 已提交
4855
  std::vector<std::string> filenames;
4856 4857
  std::vector<std::string> archiveFiles;

4858
  std::string archivedir = ArchivalDirectory(dbname);
J
jorlow@chromium.org 已提交
4859 4860
  // Ignore error in case directory does not exist
  env->GetChildren(dbname, &filenames);
4861 4862 4863 4864 4865 4866 4867

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

J
jorlow@chromium.org 已提交
4869 4870 4871 4872 4873
  if (filenames.empty()) {
    return Status::OK();
  }

  FileLock* lock;
4874 4875
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
4876 4877 4878
  if (result.ok()) {
    uint64_t number;
    FileType type;
D
dgrogan@chromium.org 已提交
4879
    for (size_t i = 0; i < filenames.size(); i++) {
4880
      if (ParseFileName(filenames[i], &number, &type) &&
4881
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
4882 4883 4884
        Status del;
        if (type == kMetaDatabase) {
          del = DestroyDB(dbname + "/" + filenames[i], options);
4885 4886
        } else if (type == kLogFile) {
          del = env->DeleteFile(soptions.wal_dir + "/" + filenames[i]);
K
Kosie van der Merwe 已提交
4887 4888 4889
        } else {
          del = env->DeleteFile(dbname + "/" + filenames[i]);
        }
J
jorlow@chromium.org 已提交
4890 4891 4892 4893 4894
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4895

4896 4897
    for (auto& db_path : options.db_paths) {
      env->GetChildren(db_path.path, &filenames);
4898 4899 4900 4901 4902
      uint64_t number;
      FileType type;
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
4903
          Status del = env->DeleteFile(db_path.path + "/" + filenames[i]);
4904 4905 4906 4907 4908 4909 4910
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

4911
    env->GetChildren(archivedir, &archiveFiles);
4912 4913
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
4914 4915
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
4916
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
4917 4918 4919 4920 4921
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4922
    // ignore case where no archival directory is present.
4923
    env->DeleteDir(archivedir);
4924

J
jorlow@chromium.org 已提交
4925
    env->UnlockFile(lock);  // Ignore error since state is already gone
4926
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
4927
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
4928
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
4929 4930 4931 4932
  }
  return result;
}

4933 4934
//
// A global method that can dump out the build version
K
kailiu 已提交
4935
void DumpLeveldbBuildVersion(Logger * log) {
I
Igor Canadi 已提交
4936 4937
#if !defined(IOS_CROSS_COMPILE)
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't generate util/build_version.cc
4938
  Log(log, "Git sha %s", rocksdb_build_git_sha);
4939
  Log(log, "Compile time %s %s",
4940
      rocksdb_build_compile_time, rocksdb_build_compile_date);
I
Igor Canadi 已提交
4941
#endif
4942 4943
}

4944
}  // namespace rocksdb