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

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

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

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

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

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

S
Stanislau Hlebik 已提交
91 92 93 94 95 96 97 98 99 100 101 102 103 104
struct DBImpl::WriteContext {
  autovector<SuperVersion*> superversions_to_free_;
  autovector<log::Writer*> logs_to_free_;

  ~WriteContext() {
    for (auto& sv : superversions_to_free_) {
      delete sv;
    }
    for (auto& log : logs_to_free_) {
      delete log;
    }
  }
};

J
jorlow@chromium.org 已提交
105 106 107
struct DBImpl::CompactionState {
  Compaction* const compaction;

108 109 110 111 112
  // 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 已提交
113 114 115 116

  // Files produced by compaction
  struct Output {
    uint64_t number;
117
    uint32_t path_id;
J
jorlow@chromium.org 已提交
118 119
    uint64_t file_size;
    InternalKey smallest, largest;
120
    SequenceNumber smallest_seqno, largest_seqno;
J
jorlow@chromium.org 已提交
121 122
  };
  std::vector<Output> outputs;
123
  std::list<uint64_t> allocated_file_numbers;
J
jorlow@chromium.org 已提交
124 125

  // State kept for output being generated
126 127
  unique_ptr<WritableFile> outfile;
  unique_ptr<TableBuilder> builder;
J
jorlow@chromium.org 已提交
128 129 130 131 132 133 134 135 136

  uint64_t total_bytes;

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

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

138 139 140 141 142 143 144 145
  // 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;
  }

146
  // Create a client visible context of this compaction
D
Danny Guo 已提交
147 148
  CompactionFilterContext GetFilterContext() {
    CompactionFilterContext context;
149
    context.is_full_compaction = compaction->IsFullCompaction();
150
    context.is_manual_compaction = compaction->IsManualCompaction();
151 152
    return context;
  }
D
Danny Guo 已提交
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196

  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;
197
    size_t total_size = key_str_buf_.size() + other_key_str_buf_.size();
D
Danny Guo 已提交
198 199 200 201 202
    combined_key_buf_.reserve(total_size);
    combined_value_buf_.reserve(total_size);

    while (i + j < total_size) {
      int comp_res = 0;
203 204 205
      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 已提交
206
        comp_res = 1;
207
      } else if (j >= other_key_str_buf_.size() && i < key_str_buf_.size()) {
D
Danny Guo 已提交
208 209 210
        comp_res = -1;
      }
      if (comp_res > 0) {
211
        AddToCombinedKeyValueSlices(other_key_str_buf_[j], other_value_str_buf_[j]);
D
Danny Guo 已提交
212 213
        j++;
      } else if (comp_res < 0) {
214
        AddToCombinedKeyValueSlices(key_str_buf_[i], existing_value_str_buf_[i]);
D
Danny Guo 已提交
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
        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 已提交
245 246 247 248
};

Options SanitizeOptions(const std::string& dbname,
                        const InternalKeyComparator* icmp,
S
Sanjay Ghemawat 已提交
249
                        const InternalFilterPolicy* ipolicy,
J
jorlow@chromium.org 已提交
250
                        const Options& src) {
251 252 253 254 255 256 257
  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 已提交
258

259 260
  // result.max_open_files means an "infinite" open files.
  if (result.max_open_files != -1) {
261
    ClipToRange(&result.max_open_files, 20, 1000000);
262
  }
263

264
  if (result.info_log == nullptr) {
K
Kai Liu 已提交
265 266
    Status s = CreateLoggerFromOptions(dbname, result.db_log_dir, src.env,
                                       result, &result.info_log);
J
jorlow@chromium.org 已提交
267 268
    if (!s.ok()) {
      // No place suitable for logging
269
      result.info_log = nullptr;
J
jorlow@chromium.org 已提交
270 271
    }
  }
272

273 274 275 276 277 278
  if (!result.rate_limiter) {
    if (result.bytes_per_sync == 0) {
      result.bytes_per_sync = 1024 * 1024;
    }
  }

279 280 281 282
  if (result.wal_dir.empty()) {
    // Use dbname as default
    result.wal_dir = dbname;
  }
283
  if (result.wal_dir.back() == '/') {
I
Igor Canadi 已提交
284
    result.wal_dir = result.wal_dir.substr(0, result.wal_dir.size() - 1);
285
  }
286

287
  if (result.db_paths.size() == 0) {
288
    result.db_paths.emplace_back(dbname, std::numeric_limits<uint64_t>::max());
289 290
  }

J
jorlow@chromium.org 已提交
291 292 293
  return result;
}

294
namespace {
295 296 297 298 299 300 301
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;

302
  if (options.compaction_style == kCompactionStyleUniversal) {
303 304 305 306
    can_compress =
        (options.compaction_options_universal.compression_size_percent < 0);
  } else {
    // For leveled compress when min_level_to_compress == 0.
307 308
    can_compress = options.compression_per_level.empty() ||
                   options.compression_per_level[0] != kNoCompression;
309 310 311 312 313 314 315 316
  }

  if (can_compress) {
    return options.compression;
  } else {
    return kNoCompression;
  }
}
317
}  // namespace
318

I
Igor Canadi 已提交
319
DBImpl::DBImpl(const DBOptions& options, const std::string& dbname)
J
jorlow@chromium.org 已提交
320
    : env_(options.env),
H
heyongqiang 已提交
321
      dbname_(dbname),
I
Igor Canadi 已提交
322
      options_(SanitizeOptions(dbname, options)),
L
Lei Jin 已提交
323
      stats_(options_.statistics.get()),
324
      db_lock_(nullptr),
H
Haobo Xu 已提交
325
      mutex_(options.use_adaptive_mutex),
326
      shutting_down_(nullptr),
J
jorlow@chromium.org 已提交
327
      bg_cv_(&mutex_),
328
      logfile_number_(0),
I
Igor Canadi 已提交
329
      log_empty_(true),
330
      default_cf_handle_(nullptr),
I
Igor Canadi 已提交
331 332
      total_log_size_(0),
      max_total_in_memory_state_(0),
333
      tmp_batch_(),
334
      bg_schedule_needed_(false),
335
      bg_compaction_scheduled_(0),
336
      bg_manual_only_(0),
337
      bg_flush_scheduled_(0),
338
      manual_compaction_(nullptr),
339
      disable_delete_obsolete_files_(0),
I
Igor Canadi 已提交
340
      delete_obsolete_files_last_run_(options.env->NowMicros()),
341
      purge_wal_files_last_run_(0),
342
      last_stats_dump_time_microsec_(0),
343
      default_interval_to_delete_obsolete_WAL_(600),
344
      flush_on_destroy_(false),
345
      delayed_writes_(0),
346 347
      storage_options_(options),
      bg_work_gate_closed_(false),
348 349
      refitting_level_(false),
      opened_successfully_(false) {
H
heyongqiang 已提交
350
  env_->GetAbsolutePath(dbname, &db_absolute_path_);
351

J
jorlow@chromium.org 已提交
352
  // Reserve ten files or so for other uses and give the rest to TableCache.
353 354
  // Give a large number for setting of "infinite" open files.
  const int table_cache_size =
355 356 357 358 359 360
      (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 已提交
361 362
  versions_.reset(
      new VersionSet(dbname_, &options_, storage_options_, table_cache_.get()));
363 364
  column_family_memtables_.reset(
      new ColumnFamilyMemTablesImpl(versions_->GetColumnFamilySet()));
365

K
kailiu 已提交
366
  DumpLeveldbBuildVersion(options_.info_log.get());
367
  options_.Dump(options_.info_log.get());
368

I
Igor Canadi 已提交
369
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
370 371 372
}

DBImpl::~DBImpl() {
373 374 375 376 377 378 379 380
  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();
381
        cfd->Unref();
382 383
      }
    }
384
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
385
  }
I
Igor Canadi 已提交
386 387

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

I
Igor Canadi 已提交
393 394 395 396 397
  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();
398 399
  }

400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
  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;
415 416 417
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
418 419 420
    }
  }

421
  // versions need to be destroyed before table_cache since it can hold
422 423
  // references to table_cache.
  versions_.reset();
424
  mutex_.Unlock();
I
Igor Canadi 已提交
425 426 427
  if (db_lock_ != nullptr) {
    env_->UnlockFile(db_lock_);
  }
428

I
Igor Canadi 已提交
429
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
430 431 432
}

Status DBImpl::NewDB() {
433
  VersionEdit new_db;
434
  new_db.SetLogNumber(0);
J
jorlow@chromium.org 已提交
435 436 437
  new_db.SetNextFile(2);
  new_db.SetLastSequence(0);

438
  Log(options_.info_log, "Creating manifest 1 \n");
J
jorlow@chromium.org 已提交
439
  const std::string manifest = DescriptorFileName(dbname_, 1);
440
  unique_ptr<WritableFile> file;
I
Igor Canadi 已提交
441 442
  Status s = env_->NewWritableFile(
      manifest, &file, env_->OptimizeForManifestWrite(storage_options_));
J
jorlow@chromium.org 已提交
443 444 445
  if (!s.ok()) {
    return s;
  }
446
  file->SetPreallocationBlockSize(options_.manifest_preallocation_size);
J
jorlow@chromium.org 已提交
447
  {
448
    log::Writer log(std::move(file));
J
jorlow@chromium.org 已提交
449 450 451 452 453 454
    std::string record;
    new_db.EncodeTo(&record);
    s = log.AddRecord(record);
  }
  if (s.ok()) {
    // Make "CURRENT" file that points to the new manifest file.
455
    s = SetCurrentFile(env_, dbname_, 1, db_directory_.get());
J
jorlow@chromium.org 已提交
456 457 458 459 460 461 462 463 464 465
  } else {
    env_->DeleteFile(manifest);
  }
  return s;
}

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

471
const Status DBImpl::CreateArchivalDirectory() {
472
  if (options_.WAL_ttl_seconds > 0 || options_.WAL_size_limit_MB > 0) {
473
    std::string archivalPath = ArchivalDirectory(options_.wal_dir);
474 475 476 477 478
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

479
void DBImpl::PrintStatistics() {
480
  auto dbstats = options_.statistics.get();
481 482
  if (dbstats) {
    Log(options_.info_log,
483 484
        "STATISTCS:\n %s",
        dbstats->ToString().c_str());
485 486 487
  }
}

488
void DBImpl::MaybeDumpStats() {
H
Haobo Xu 已提交
489 490 491 492 493 494 495 496 497 498 499 500
  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;
501

502 503 504 505 506 507
    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 已提交
508
    std::string stats;
509 510 511
    {
      MutexLock l(&mutex_);
      for (auto cfd : *versions_->GetColumnFamilySet()) {
512 513
        cfd->internal_stats()->GetStringProperty(cf_property_type,
                                                 "rocksdb.cfstats", &stats);
514
      }
515 516
      default_cf_internal_stats_->GetStringProperty(db_property_type,
                                                    "rocksdb.dbstats", &stats);
517 518
    }
    Log(options_.info_log, "------- DUMPING STATS -------");
H
Haobo Xu 已提交
519
    Log(options_.info_log, "%s", stats.c_str());
520

521
    PrintStatistics();
522 523 524
  }
}

525
// Returns the list of live files in 'sst_live' and the list
K
kailiu 已提交
526
// of all files in the filesystem in 'candidate_files'.
I
Igor Canadi 已提交
527 528 529 530 531 532 533
// 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 已提交
534 535
  mutex_.AssertHeld();

536
  // if deletion is disabled, do nothing
537
  if (disable_delete_obsolete_files_ > 0) {
538 539 540
    return;
  }

541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
  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 已提交
557 558 559
  // get obsolete files
  versions_->GetObsoleteFiles(&deletion_state.sst_delete_files);

I
Igor Canadi 已提交
560 561
  // store the current filenum, lognum, etc
  deletion_state.manifest_file_number = versions_->ManifestFileNumber();
562 563
  deletion_state.pending_manifest_file_number =
      versions_->PendingManifestFileNumber();
564
  deletion_state.log_number = versions_->MinLogNumber();
I
Igor Canadi 已提交
565 566
  deletion_state.prev_log_number = versions_->PrevLogNumber();

567 568 569 570 571 572 573 574
  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
575 576 577 578 579
  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 已提交
580 581
  versions_->AddLiveFiles(&deletion_state.sst_live);

582
  if (doing_the_full_scan) {
583 584 585 586 587 588 589 590 591
    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);
      }
    }
592 593 594 595 596

    //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
597
      for (std::string log_file : log_files) {
598 599 600
        deletion_state.candidate_files.emplace_back(log_file, 0);
      }
    }
601
  }
602 603
}

604 605 606 607 608 609 610 611 612 613 614 615 616
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 已提交
617
// Diffs the files listed in filenames and those that do not
I
Igor Canadi 已提交
618
// belong to live files are posibly removed. Also, removes all the
619
// files in sst_delete_files and log_delete_files.
620
// It is not necessary to hold the mutex when invoking this method.
D
Dhruba Borthakur 已提交
621
void DBImpl::PurgeObsoleteFiles(DeletionState& state) {
622 623
  // we'd better have sth to delete
  assert(state.HaveSomethingToDelete());
624

I
Igor Canadi 已提交
625 626 627 628
  // 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 已提交
629 630
    return;
  }
631

632
  // Now, convert live list to an unordered map, WITHOUT mutex held;
633
  // set is slow.
634 635 636 637
  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 已提交
638

K
kailiu 已提交
639 640 641 642 643 644 645
  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 = "";
646
  for (auto file : state.sst_delete_files) {
647 648 649
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
650
    delete file;
I
Igor Canadi 已提交
651 652
  }

K
kailiu 已提交
653 654
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
655 656
      candidate_files.emplace_back(LogFileName(kDumbDbName, file_num).substr(1),
                                   0);
I
Igor Canadi 已提交
657 658
    }
  }
659

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

666 667
  std::vector<std::string> old_info_log_files;

668 669 670
  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 已提交
671 672 673 674 675 676
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
    if (!ParseFileName(to_delete, &number, &type)) {
      continue;
    }
J
jorlow@chromium.org 已提交
677

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

    if (keep) {
      continue;
    }

719
    std::string fname;
K
kailiu 已提交
720 721
    if (type == kTableFile) {
      // evict from cache
722
      TableCache::Evict(table_cache_.get(), number);
723 724 725 726
      fname = TableFileName(options_.db_paths, number, path_id);
    } else {
      fname =
          ((type == kLogFile) ? options_.wal_dir : dbname_) + "/" + to_delete;
K
kailiu 已提交
727
    }
728

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

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

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

I
Igor Canadi 已提交
778
#ifndef ROCKSDB_LITE
779 780 781 782 783 784 785 786
// 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
787
void DBImpl::PurgeObsoleteWALFiles() {
788 789 790 791 792 793
  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;
  }

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

805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
  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 已提交
843 844 845
          } else {
            MutexLock l(&read_first_record_cache_mutex_);
            read_first_record_cache_.erase(number);
846 847
          }
          continue;
848
        }
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
      }

      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 已提交
868 869 870
            } else {
              MutexLock l(&read_first_record_cache_mutex_);
              read_first_record_cache_.erase(number);
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
            }
          }
        }
      }
    }
  }

  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;
890
  GetSortedWalsOfType(archival_dir, archived_logs, kArchivedLogFile);
891 892 893 894 895 896 897 898 899 900 901 902 903 904

  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 已提交
905 906 907
    } else {
      MutexLock l(&read_first_record_cache_mutex_);
      read_first_record_cache_.erase(archived_logs[i]->LogNumber());
908 909
    }
  }
D
Dhruba Borthakur 已提交
910 911
}

912 913 914 915 916 917 918 919 920 921
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 已提交
922 923 924 925 926 927 928 929 930 931 932 933 934
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 已提交
935 936
      SequenceNumber sequence;
      Status s = ReadFirstRecord(log_type, number, &sequence);
I
Igor Canadi 已提交
937 938 939
      if (!s.ok()) {
        return s;
      }
I
Igor Canadi 已提交
940 941 942 943
      if (sequence == 0) {
        // empty file
        continue;
      }
I
Igor Canadi 已提交
944

945 946 947 948 949 950
      // 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 已提交
951 952
      uint64_t size_bytes;
      s = env_->GetFileSize(LogFileName(path, number), &size_bytes);
953 954 955 956 957
      // 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 已提交
958 959 960 961 962
      if (!s.ok()) {
        return s;
      }

      log_files.push_back(std::move(unique_ptr<LogFile>(
I
Igor Canadi 已提交
963
          new LogFileImpl(number, log_type, sequence, size_bytes))));
I
Igor Canadi 已提交
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987
    }
  }
  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 已提交
988 989
  // end could be -ve.
  size_t start_index = std::max(static_cast<int64_t>(0), end);
I
Igor Canadi 已提交
990 991 992 993 994 995
  // 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 已提交
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
                               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 已提交
1009 1010
  if (type == kAliveLogFile) {
    std::string fname = LogFileName(options_.wal_dir, number);
I
Igor Canadi 已提交
1011 1012 1013 1014
    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 已提交
1015
    }
I
Igor Canadi 已提交
1016
  }
I
Igor Canadi 已提交
1017

I
Igor Canadi 已提交
1018
  if (type == kArchivedLogFile || !s.ok()) {
I
Igor Canadi 已提交
1019 1020
    //  check if the file got moved to archive.
    std::string archived_file = ArchivedLogFileName(options_.wal_dir, number);
I
Igor Canadi 已提交
1021
    s = ReadFirstLine(archived_file, sequence);
I
Igor Canadi 已提交
1022
  }
I
Igor Canadi 已提交
1023 1024 1025 1026 1027 1028

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

I
Igor Canadi 已提交
1031 1032
// the function returns status.ok() and sequence == 0 if the file exists, but is
// empty
I
Igor Canadi 已提交
1033
Status DBImpl::ReadFirstLine(const std::string& fname,
I
Igor Canadi 已提交
1034
                             SequenceNumber* sequence) {
I
Igor Canadi 已提交
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 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
  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 已提交
1078 1079 1080
      WriteBatch batch;
      WriteBatchInternal::SetContents(&batch, record);
      *sequence = WriteBatchInternal::Sequence(&batch);
I
Igor Canadi 已提交
1081 1082 1083 1084
      return Status::OK();
    }
  }

I
Igor Canadi 已提交
1085 1086 1087
  // 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 已提交
1088 1089 1090 1091 1092
  return status;
}

#endif  // ROCKSDB_LITE

1093
Status DBImpl::Recover(
1094 1095
    const std::vector<ColumnFamilyDescriptor>& column_families, bool read_only,
    bool error_if_log_file_exist) {
J
jorlow@chromium.org 已提交
1096 1097
  mutex_.AssertHeld();

1098
  bool is_new_db = false;
1099
  assert(db_lock_ == nullptr);
I
Igor Canadi 已提交
1100
  if (!read_only) {
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
    // 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;
    }

1113 1114
    for (auto& db_path : options_.db_paths) {
      s = env_->CreateDirIfMissing(db_path.path);
1115 1116 1117 1118 1119
      if (!s.ok()) {
        return s;
      }
    }

1120 1121 1122 1123 1124
    s = env_->NewDirectory(dbname_, &db_directory_);
    if (!s.ok()) {
      return s;
    }

1125
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
1126 1127 1128
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
1129

1130 1131 1132
    if (!env_->FileExists(CurrentFileName(dbname_))) {
      if (options_.create_if_missing) {
        s = NewDB();
1133
        is_new_db = true;
1134 1135 1136 1137 1138 1139
        if (!s.ok()) {
          return s;
        }
      } else {
        return Status::InvalidArgument(
            dbname_, "does not exist (create_if_missing is false)");
J
jorlow@chromium.org 已提交
1140 1141
      }
    } else {
1142 1143 1144 1145
      if (options_.error_if_exists) {
        return Status::InvalidArgument(
            dbname_, "exists (error_if_exists is true)");
      }
J
jorlow@chromium.org 已提交
1146
    }
M
Mayank Agarwal 已提交
1147 1148 1149 1150 1151 1152 1153
    // 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 已提交
1154 1155
  }

1156
  Status s = versions_->Recover(column_families, read_only);
I
Igor Canadi 已提交
1157 1158 1159
  if (options_.paranoid_checks && s.ok()) {
    s = CheckConsistency();
  }
J
jorlow@chromium.org 已提交
1160 1161
  if (s.ok()) {
    SequenceNumber max_sequence(0);
1162 1163
    default_cf_handle_ = new ColumnFamilyHandleImpl(
        versions_->GetColumnFamilySet()->GetDefault(), this, &mutex_);
1164
    default_cf_internal_stats_ = default_cf_handle_->cfd()->internal_stats();
1165 1166
    single_column_family_mode_ =
        versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1;
1167 1168 1169 1170 1171 1172 1173

    // 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
1174
    // produced by an older version of rocksdb.
1175
    const uint64_t min_log = versions_->MinLogNumber();
1176 1177
    const uint64_t prev_log = versions_->PrevLogNumber();
    std::vector<std::string> filenames;
1178
    s = env_->GetChildren(options_.wal_dir, &filenames);
1179 1180
    if (!s.ok()) {
      return s;
1181
    }
K
kailiu 已提交
1182

1183 1184
    std::vector<uint64_t> logs;
    for (size_t i = 0; i < filenames.size(); i++) {
K
kailiu 已提交
1185 1186
      uint64_t number;
      FileType type;
1187 1188 1189 1190 1191 1192 1193 1194 1195
      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);
        }
1196
      }
J
jorlow@chromium.org 已提交
1197
    }
1198

H
heyongqiang 已提交
1199 1200 1201 1202 1203 1204
    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");
    }

1205 1206
    // Recover in the order in which the logs were generated
    std::sort(logs.begin(), logs.end());
K
kailiu 已提交
1207
    for (const auto& log : logs) {
1208 1209 1210
      // 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 已提交
1211
      versions_->MarkFileNumberUsed(log);
K
Kai Liu 已提交
1212
      s = RecoverLogFile(log, &max_sequence, read_only);
1213
    }
L
Lei Jin 已提交
1214
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1215 1216
  }

I
Igor Canadi 已提交
1217 1218 1219 1220 1221
  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 已提交
1222 1223 1224
  return s;
}

I
Igor Canadi 已提交
1225 1226
Status DBImpl::RecoverLogFile(uint64_t log_number, SequenceNumber* max_sequence,
                              bool read_only) {
J
jorlow@chromium.org 已提交
1227 1228
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1229
    Logger* info_log;
J
jorlow@chromium.org 已提交
1230
    const char* fname;
1231 1232
    Status* status;  // nullptr if options_.paranoid_checks==false or
                     //            options_.skip_log_error_on_recovery==true
J
jorlow@chromium.org 已提交
1233
    virtual void Corruption(size_t bytes, const Status& s) {
1234
      Log(info_log, "%s%s: dropping %d bytes; %s",
1235
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1236
          fname, static_cast<int>(bytes), s.ToString().c_str());
1237
      if (this->status != nullptr && this->status->ok()) *this->status = s;
J
jorlow@chromium.org 已提交
1238 1239 1240 1241 1242
    }
  };

  mutex_.AssertHeld();

1243
  std::unordered_map<int, VersionEdit> version_edits;
1244
  // no need to refcount because iteration is under mutex
1245 1246
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    VersionEdit edit;
1247 1248
    edit.SetColumnFamily(cfd->GetID());
    version_edits.insert({cfd->GetID(), edit});
1249
  }
I
Igor Canadi 已提交
1250

J
jorlow@chromium.org 已提交
1251
  // Open the log file
1252
  std::string fname = LogFileName(options_.wal_dir, log_number);
1253
  unique_ptr<SequentialFile> file;
1254
  Status status = env_->NewSequentialFile(fname, &file, storage_options_);
J
jorlow@chromium.org 已提交
1255 1256 1257 1258 1259 1260 1261 1262
  if (!status.ok()) {
    MaybeIgnoreError(&status);
    return status;
  }

  // Create the log reader.
  LogReporter reporter;
  reporter.env = env_;
1263
  reporter.info_log = options_.info_log.get();
J
jorlow@chromium.org 已提交
1264
  reporter.fname = fname.c_str();
1265 1266
  reporter.status = (options_.paranoid_checks &&
                     !options_.skip_log_error_on_recovery ? &status : nullptr);
J
jorlow@chromium.org 已提交
1267 1268 1269 1270
  // 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).
1271
  log::Reader reader(std::move(file), &reporter, true/*checksum*/,
1272
                     0/*initial_offset*/);
1273
  Log(options_.info_log, "Recovering log #%" PRIu64 "", log_number);
J
jorlow@chromium.org 已提交
1274 1275 1276 1277 1278

  // Read all the records and add to a memtable
  std::string scratch;
  Slice record;
  WriteBatch batch;
I
Igor Canadi 已提交
1279
  while (reader.ReadRecord(&record, &scratch)) {
J
jorlow@chromium.org 已提交
1280 1281 1282 1283 1284 1285 1286
    if (record.size() < 12) {
      reporter.Corruption(
          record.size(), Status::Corruption("log record too small"));
      continue;
    }
    WriteBatchInternal::SetContents(&batch, record);

1287
    status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
1288
        &batch, column_family_memtables_.get(), true, log_number);
1289

J
jorlow@chromium.org 已提交
1290 1291
    MaybeIgnoreError(&status);
    if (!status.ok()) {
I
Igor Canadi 已提交
1292
      return status;
J
jorlow@chromium.org 已提交
1293 1294 1295 1296 1297 1298 1299 1300
    }
    const SequenceNumber last_seq =
        WriteBatchInternal::Sequence(&batch) +
        WriteBatchInternal::Count(&batch) - 1;
    if (last_seq > *max_sequence) {
      *max_sequence = last_seq;
    }

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

1325 1326 1327 1328
  if (versions_->LastSequence() < *max_sequence) {
    versions_->SetLastSequence(*max_sequence);
  }

1329
  if (!read_only) {
1330 1331
    // no need to refcount since client still doesn't have access
    // to the DB and can not drop column families while we iterate
1332
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1333
      auto iter = version_edits.find(cfd->GetID());
1334 1335 1336
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

1337 1338 1339 1340
      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
1341
        // (in WriteBatch::InsertInto)
1342 1343 1344 1345 1346 1347 1348
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1349
        status = WriteLevel0TableForRecovery(cfd, cfd->mem(), edit);
1350
      }
1351 1352 1353 1354 1355
      // we still want to clear the memtable, even if the recovery failed
      cfd->CreateNewMemtable();
      if (!status.ok()) {
        return status;
      }
J
jorlow@chromium.org 已提交
1356

1357 1358 1359 1360 1361 1362 1363
      // 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);
1364 1365 1366
      // 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 已提交
1367
      // log number
1368
      versions_->MarkFileNumberUsed(log_number + 1);
1369 1370 1371 1372 1373
      status = versions_->LogAndApply(cfd, edit, &mutex_);
      if (!status.ok()) {
        return status;
      }
    }
1374
  }
I
Igor Canadi 已提交
1375

J
jorlow@chromium.org 已提交
1376 1377 1378
  return status;
}

1379 1380
Status DBImpl::WriteLevel0TableForRecovery(ColumnFamilyData* cfd, MemTable* mem,
                                           VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1381
  mutex_.AssertHeld();
1382
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1383
  FileMetaData meta;
1384 1385
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
  pending_outputs_[meta.fd.GetNumber()] = 0;  // path 0 for level 0 file.
1386
  Iterator* iter = mem->NewIterator(ReadOptions(), true);
1387 1388 1389
  const SequenceNumber newest_snapshot = snapshots_.GetNewest();
  const SequenceNumber earliest_seqno_in_memtable =
    mem->GetFirstSequenceNumber();
1390 1391
  Log(options_.info_log, "[%s] Level-0 table #%" PRIu64 ": started",
      cfd->GetName().c_str(), meta.fd.GetNumber());
1392 1393 1394 1395

  Status s;
  {
    mutex_.Unlock();
I
Igor Canadi 已提交
1396
    s = BuildTable(dbname_, env_, *cfd->options(), storage_options_,
1397
                   cfd->table_cache(), iter, &meta, cfd->internal_comparator(),
1398
                   newest_snapshot, earliest_seqno_in_memtable,
L
Lei Jin 已提交
1399
                   GetCompressionFlush(*cfd->options()), Env::IO_HIGH);
I
Igor Canadi 已提交
1400
    LogFlush(options_.info_log);
1401 1402 1403
    mutex_.Lock();
  }

1404 1405 1406 1407
  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 已提交
1408
  delete iter;
1409

1410
  pending_outputs_.erase(meta.fd.GetNumber());
1411 1412 1413 1414

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1415
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1416 1417 1418
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1419 1420
  }

L
Lei Jin 已提交
1421
  InternalStats::CompactionStats stats(1);
1422
  stats.micros = env_->NowMicros() - start_micros;
1423
  stats.bytes_written = meta.fd.GetFileSize();
M
Mark Callaghan 已提交
1424
  stats.files_out_levelnp1 = 1;
1425
  cfd->internal_stats()->AddCompactionStats(level, stats);
1426 1427
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1428
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1429 1430 1431
  return s;
}

1432
Status DBImpl::WriteLevel0Table(ColumnFamilyData* cfd,
1433
                                autovector<MemTable*>& mems, VersionEdit* edit,
1434
                                uint64_t* filenumber, LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
1435
  mutex_.AssertHeld();
1436 1437
  const uint64_t start_micros = env_->NowMicros();
  FileMetaData meta;
1438 1439

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

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

I
Igor Canadi 已提交
1464
    s = BuildTable(dbname_, env_, *cfd->options(), storage_options_,
1465
                   cfd->table_cache(), iter, &meta, cfd->internal_comparator(),
1466
                   newest_snapshot, earliest_seqno_in_memtable,
L
Lei Jin 已提交
1467
                   GetCompressionFlush(*cfd->options()), Env::IO_HIGH);
I
Igor Canadi 已提交
1468
    LogFlush(options_.info_log);
1469
    delete iter;
1470 1471
    Log(options_.info_log,
        "[%s] Level-0 flush table #%" PRIu64 ": %" PRIu64 " bytes %s",
F
Feng Zhu 已提交
1472
        cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
1473
        s.ToString().c_str());
I
Igor Canadi 已提交
1474

1475 1476 1477
    if (!options_.disableDataSync) {
      db_directory_->Fsync();
    }
1478 1479
    mutex_.Lock();
  }
1480 1481
  base->Unref();

1482
  // re-acquire the most current version
1483
  base = cfd->current();
1484 1485 1486 1487 1488 1489

  // 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 已提交
1490
  // committed so that other threads can recognize this file as a
1491 1492 1493 1494 1495 1496
  // 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;
1497
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1498 1499 1500 1501 1502 1503
    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.
1504
    if (base != nullptr && options_.max_background_compactions <= 1 &&
1505
        cfd->options()->compaction_style == kCompactionStyleLevel) {
1506 1507
      level = base->PickLevelForMemTableOutput(min_user_key, max_user_key);
    }
1508 1509 1510
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1511 1512
  }

L
Lei Jin 已提交
1513
  InternalStats::CompactionStats stats(1);
1514
  stats.micros = env_->NowMicros() - start_micros;
1515
  stats.bytes_written = meta.fd.GetFileSize();
1516
  cfd->internal_stats()->AddCompactionStats(level, stats);
1517 1518
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1519
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
1520 1521 1522
  return s;
}

1523 1524
Status DBImpl::FlushMemTableToOutputFile(ColumnFamilyData* cfd,
                                         bool* madeProgress,
H
Haobo Xu 已提交
1525 1526
                                         DeletionState& deletion_state,
                                         LogBuffer* log_buffer) {
1527
  mutex_.AssertHeld();
1528
  assert(cfd->imm()->size() != 0);
1529
  assert(cfd->imm()->IsFlushPending());
1530 1531 1532

  // Save the contents of the earliest memtable as a new Table
  uint64_t file_number;
K
Kai Liu 已提交
1533
  autovector<MemTable*> mems;
1534
  cfd->imm()->PickMemtablesToFlush(&mems);
1535
  if (mems.empty()) {
I
Igor Canadi 已提交
1536 1537
    LogToBuffer(log_buffer, "[%s] Nothing in memtable to flush",
                cfd->GetName().c_str());
L
Lei Jin 已提交
1538
    return Status::OK();
1539 1540 1541
  }

  // record the logfile_number_ before we release the mutex
1542 1543 1544
  // 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.
1545
  MemTable* m = mems[0];
1546 1547
  VersionEdit* edit = m->GetEdits();
  edit->SetPrevLogNumber(0);
1548 1549
  // SetLogNumber(log_num) indicates logs with number smaller than log_num
  // will no longer be picked up for recovery.
1550 1551
  edit->SetLogNumber(mems.back()->GetNextLogNumber());
  edit->SetColumnFamily(cfd->GetID());
1552

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

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

L
Lei Jin 已提交
1561
  if (!s.ok()) {
1562
    cfd->imm()->RollbackMemtableFlush(mems, file_number, &pending_outputs_);
1563 1564
  } else {
    // Replace immutable memtable with the generated Table
1565 1566
    s = cfd->imm()->InstallMemtableFlushResults(
        cfd, mems, versions_.get(), &mutex_, options_.info_log.get(),
1567
        file_number, &pending_outputs_, &deletion_state.memtables_to_free,
1568
        db_directory_.get(), log_buffer);
1569
  }
J
jorlow@chromium.org 已提交
1570 1571

  if (s.ok()) {
1572
    InstallSuperVersion(cfd, deletion_state);
1573 1574 1575
    if (madeProgress) {
      *madeProgress = 1;
    }
I
Igor Canadi 已提交
1576 1577 1578
    Version::LevelSummaryStorage tmp;
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
                cfd->current()->LevelSummary(&tmp));
1579

1580
    if (disable_delete_obsolete_files_ == 0) {
I
Igor Canadi 已提交
1581
      // add to deletion state
1582
      while (alive_log_files_.size() &&
I
Igor Canadi 已提交
1583 1584 1585 1586
             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;
1587 1588
        alive_log_files_.pop_front();
      }
1589
    }
J
jorlow@chromium.org 已提交
1590
  }
1591 1592 1593 1594 1595 1596 1597

  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;
  }
1598
  RecordFlushIOStats();
J
jorlow@chromium.org 已提交
1599 1600 1601
  return s;
}

1602
Status DBImpl::CompactRange(ColumnFamilyHandle* column_family,
1603
                            const Slice* begin, const Slice* end,
1604 1605 1606 1607 1608 1609
                            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");
  }

1610 1611
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
I
Igor Canadi 已提交
1612 1613

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
1614 1615 1616 1617 1618
  if (!s.ok()) {
    LogFlush(options_.info_log);
    return s;
  }

I
Igor Canadi 已提交
1619
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
1620 1621
  {
    MutexLock l(&mutex_);
I
Igor Canadi 已提交
1622 1623
    Version* base = cfd->current();
    for (int level = 1; level < cfd->NumberLevels(); level++) {
G
Gabor Cselle 已提交
1624 1625 1626 1627 1628
      if (base->OverlapInLevel(level, begin, end)) {
        max_level_with_files = level;
      }
    }
  }
1629 1630
  for (int level = 0; level <= max_level_with_files; level++) {
    // in case the compaction is unversal or if we're compacting the
1631 1632 1633
    // 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 已提交
1634
    if (cfd->options()->compaction_style == kCompactionStyleUniversal ||
I
Igor Canadi 已提交
1635
        cfd->options()->compaction_style == kCompactionStyleFIFO ||
1636
        (level == max_level_with_files && level > 0)) {
1637
      s = RunManualCompaction(cfd, level, level, target_path_id, begin, end);
1638
    } else {
1639 1640
      s = RunManualCompaction(cfd, level, level + 1, target_path_id, begin,
                              end);
L
Lei Jin 已提交
1641 1642 1643 1644
    }
    if (!s.ok()) {
      LogFlush(options_.info_log);
      return s;
1645
    }
G
Gabor Cselle 已提交
1646
  }
1647 1648

  if (reduce_level) {
I
Igor Canadi 已提交
1649
    s = ReFitLevel(cfd, max_level_with_files, target_level);
1650
  }
I
Igor Canadi 已提交
1651
  LogFlush(options_.info_log);
L
Lei Jin 已提交
1652 1653

  return s;
1654 1655 1656
}

// return the same level if it cannot be moved
I
Igor Canadi 已提交
1657
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd, int level) {
1658
  mutex_.AssertHeld();
I
Igor Canadi 已提交
1659
  Version* current = cfd->current();
1660
  int minimum_level = level;
1661
  for (int i = level - 1; i > 0; --i) {
1662
    // stop if level i is not empty
1663
    if (current->NumLevelFiles(i) > 0) break;
1664
    // stop if level i is too small (cannot fit the level files)
I
Igor Canadi 已提交
1665
    if (cfd->compaction_picker()->MaxBytesForLevel(i) <
1666 1667 1668
        current->NumLevelBytes(level)) {
      break;
    }
1669 1670 1671 1672 1673 1674

    minimum_level = i;
  }
  return minimum_level;
}

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

I
Igor Canadi 已提交
1678
  SuperVersion* superversion_to_free = nullptr;
1679
  SuperVersion* new_superversion = new SuperVersion();
I
Igor Canadi 已提交
1680 1681

  mutex_.Lock();
1682 1683 1684

  // only allow one thread refitting
  if (refitting_level_) {
I
Igor Canadi 已提交
1685
    mutex_.Unlock();
1686
    Log(options_.info_log, "ReFitLevel: another thread is refitting");
I
Igor Canadi 已提交
1687
    delete new_superversion;
L
Lei Jin 已提交
1688
    return Status::NotSupported("another thread is refitting");
1689 1690 1691 1692 1693
  }
  refitting_level_ = true;

  // wait for all background threads to stop
  bg_work_gate_closed_ = true;
1694
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_) {
1695
    Log(options_.info_log,
1696 1697
        "RefitLevel: waiting for background threads to stop: %d %d",
        bg_compaction_scheduled_, bg_flush_scheduled_);
1698 1699 1700 1701
    bg_cv_.Wait();
  }

  // move to a smaller level
1702 1703
  int to_level = target_level;
  if (target_level < 0) {
I
Igor Canadi 已提交
1704
    to_level = FindMinimumEmptyLevelFitting(cfd, level);
1705
  }
1706 1707 1708

  assert(to_level <= level);

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

1714
    VersionEdit edit;
I
Igor Canadi 已提交
1715 1716
    edit.SetColumnFamily(cfd->GetID());
    for (const auto& f : cfd->current()->files_[level]) {
1717
      edit.DeleteFile(level, f->fd.GetNumber());
1718 1719 1720
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
                   f->smallest_seqno, f->largest_seqno);
1721
    }
I
Igor Canadi 已提交
1722 1723
    Log(options_.info_log, "[%s] Apply version edit:\n%s",
        cfd->GetName().c_str(), edit.DebugString().data());
1724

I
Igor Canadi 已提交
1725
    status = versions_->LogAndApply(cfd, &edit, &mutex_, db_directory_.get());
1726
    superversion_to_free = cfd->InstallSuperVersion(new_superversion, &mutex_);
I
Igor Canadi 已提交
1727
    new_superversion = nullptr;
1728

I
Igor Canadi 已提交
1729 1730
    Log(options_.info_log, "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
        status.ToString().data());
1731 1732

    if (status.ok()) {
I
Igor Canadi 已提交
1733 1734
      Log(options_.info_log, "[%s] After refitting:\n%s",
          cfd->GetName().c_str(), cfd->current()->DebugString().data());
1735 1736 1737 1738 1739
    }
  }

  refitting_level_ = false;
  bg_work_gate_closed_ = false;
I
Igor Canadi 已提交
1740 1741 1742 1743

  mutex_.Unlock();
  delete superversion_to_free;
  delete new_superversion;
L
Lei Jin 已提交
1744
  return status;
G
Gabor Cselle 已提交
1745 1746
}

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

1752 1753 1754
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->options()->max_mem_compaction_level;
1755 1756
}

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

1762
Status DBImpl::Flush(const FlushOptions& options,
1763 1764 1765
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return FlushMemTable(cfh->cfd(), options);
H
heyongqiang 已提交
1766 1767
}

1768
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
1769 1770 1771
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
1772
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
1773 1774
                                   int output_level, uint32_t output_path_id,
                                   const Slice* begin, const Slice* end) {
1775
  assert(input_level >= 0);
1776

G
Gabor Cselle 已提交
1777 1778
  InternalKey begin_storage, end_storage;

H
hans@chromium.org 已提交
1779
  ManualCompaction manual;
I
Igor Canadi 已提交
1780
  manual.cfd = cfd;
1781 1782
  manual.input_level = input_level;
  manual.output_level = output_level;
1783
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
1784
  manual.done = false;
1785
  manual.in_progress = false;
1786 1787 1788
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
I
Igor Canadi 已提交
1789 1790
      cfd->options()->compaction_style == kCompactionStyleUniversal ||
      cfd->options()->compaction_style == kCompactionStyleFIFO) {
1791
    manual.begin = nullptr;
G
Gabor Cselle 已提交
1792 1793 1794 1795
  } else {
    begin_storage = InternalKey(*begin, kMaxSequenceNumber, kValueTypeForSeek);
    manual.begin = &begin_storage;
  }
1796
  if (end == nullptr ||
I
Igor Canadi 已提交
1797 1798
      cfd->options()->compaction_style == kCompactionStyleUniversal ||
      cfd->options()->compaction_style == kCompactionStyleFIFO) {
1799
    manual.end = nullptr;
G
Gabor Cselle 已提交
1800 1801 1802 1803 1804 1805
  } else {
    end_storage = InternalKey(*end, 0, static_cast<ValueType>(0));
    manual.end = &end_storage;
  }

  MutexLock l(&mutex_);
1806

1807 1808 1809 1810 1811 1812
  // 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
1813
  // RunManualCompaction(), i.e. during that time no other compaction will
1814 1815 1816
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
1817
  // RunManualCompaction() from getting to the second while loop below.
1818 1819 1820 1821 1822 1823
  // 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 已提交
1824 1825 1826
        "[%s] Manual compaction waiting for all other scheduled background "
        "compactions to finish",
        cfd->GetName().c_str());
1827 1828
    bg_cv_.Wait();
  }
1829

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

1833 1834 1835 1836
  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 已提交
1837
      bg_cv_.Wait();
1838 1839 1840
    } else {
      manual_compaction_ = &manual;
      MaybeScheduleFlushOrCompaction();
G
Gabor Cselle 已提交
1841
    }
H
hans@chromium.org 已提交
1842
  }
1843

1844 1845 1846
  assert(!manual.in_progress);
  assert(bg_manual_only_ > 0);
  --bg_manual_only_;
1847 1848 1849 1850 1851
  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 已提交
1852
  return manual.status;
J
jorlow@chromium.org 已提交
1853 1854
}

1855 1856
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
                             const FlushOptions& options) {
S
Stanislau Hlebik 已提交
1857 1858 1859 1860 1861 1862 1863 1864
  Writer w(&mutex_);
  w.batch = nullptr;
  w.sync = false;
  w.disableWAL = false;
  w.in_batch_group = false;
  w.done = false;
  w.timeout_hint_us = kNoTimeOut;

S
Stanislau Hlebik 已提交
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
  Status s;
  {
    WriteContext context;
    MutexLock guard_lock(&mutex_);
    s = BeginWrite(&w, 0);
    assert(s.ok() && !w.done);  // No timeout and nobody should do our job

    // SetNewMemtableAndNewLogFile() will release and reacquire mutex
    // during execution
    s = SetNewMemtableAndNewLogFile(cfd, &context);
    cfd->imm()->FlushRequested();
    MaybeScheduleFlushOrCompaction();

    assert(!writers_.empty());
    assert(writers_.front() == &w);
    EndWrite(&w, &w, s);
  }
S
Stanislau Hlebik 已提交
1882 1883


H
heyongqiang 已提交
1884
  if (s.ok() && options.wait) {
1885
    // Wait until the compaction completes
1886
    s = WaitForFlushMemTable(cfd);
1887 1888
  }
  return s;
J
jorlow@chromium.org 已提交
1889 1890
}

1891
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
1892 1893 1894
  Status s;
  // Wait until the compaction completes
  MutexLock l(&mutex_);
1895
  while (cfd->imm()->size() > 0 && bg_error_.ok()) {
1896 1897
    bg_cv_.Wait();
  }
1898
  if (!bg_error_.ok()) {
1899 1900 1901
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
1902 1903
}

1904
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
1905
  mutex_.AssertHeld();
1906
  bg_schedule_needed_ = false;
1907 1908
  if (bg_work_gate_closed_) {
    // gate closed for backgrond work
J
jorlow@chromium.org 已提交
1909 1910 1911
  } else if (shutting_down_.Acquire_Load()) {
    // DB is being deleted; no more background compactions
  } else {
1912
    bool is_flush_pending = false;
1913
    // no need to refcount since we're under a mutex
1914
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
1915
      if (cfd->imm()->IsFlushPending()) {
1916 1917 1918
        is_flush_pending = true;
      }
    }
1919
    if (is_flush_pending) {
1920
      // memtable flush needed
1921 1922 1923
      if (bg_flush_scheduled_ < options_.max_background_flushes) {
        bg_flush_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH);
1924
      } else if (options_.max_background_flushes > 0) {
1925
        bg_schedule_needed_ = true;
1926
      }
1927
    }
1928
    bool is_compaction_needed = false;
1929
    // no need to refcount since we're under a mutex
1930
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
1931
      if (cfd->current()->NeedsCompaction()) {
1932 1933 1934 1935
        is_compaction_needed = true;
        break;
      }
    }
1936

1937 1938
    // Schedule BGWorkCompaction if there's a compaction pending (or a memtable
    // flush, but the HIGH pool is not enabled)
1939
    // Do it only if max_background_compactions hasn't been reached and, in case
1940
    // bg_manual_only_ > 0, if it's a manual compaction.
1941 1942
    if ((manual_compaction_ || is_compaction_needed ||
         (is_flush_pending && options_.max_background_flushes == 0)) &&
1943
        (!bg_manual_only_ || manual_compaction_)) {
1944 1945 1946 1947 1948 1949
      if (bg_compaction_scheduled_ < options_.max_background_compactions) {
        bg_compaction_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW);
      } else {
        bg_schedule_needed_ = true;
      }
1950 1951 1952 1953
    }
  }
}

1954
void DBImpl::RecordFlushIOStats() {
L
Lei Jin 已提交
1955
  RecordTick(stats_, FLUSH_WRITE_BYTES, iostats_context.bytes_written);
1956 1957 1958 1959
  IOSTATS_RESET(bytes_written);
}

void DBImpl::RecordCompactionIOStats() {
L
Lei Jin 已提交
1960
  RecordTick(stats_, COMPACT_READ_BYTES, IOSTATS(bytes_read));
1961
  IOSTATS_RESET(bytes_read);
L
Lei Jin 已提交
1962
  RecordTick(stats_, COMPACT_WRITE_BYTES, IOSTATS(bytes_written));
1963 1964 1965
  IOSTATS_RESET(bytes_written);
}

1966
void DBImpl::BGWorkFlush(void* db) {
1967
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
1968 1969 1970 1971
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
}

void DBImpl::BGWorkCompaction(void* db) {
1972
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
1973 1974 1975
  reinterpret_cast<DBImpl*>(db)->BackgroundCallCompaction();
}

I
Igor Canadi 已提交
1976
Status DBImpl::BackgroundFlush(bool* madeProgress,
H
Haobo Xu 已提交
1977 1978
                               DeletionState& deletion_state,
                               LogBuffer* log_buffer) {
1979 1980 1981 1982 1983 1984
  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
1985
  for (auto cfd : *versions_->GetColumnFamilySet()) {
1986 1987 1988
    cfd->Ref();
    Status flush_status;
    while (flush_status.ok() && cfd->imm()->IsFlushPending()) {
1989 1990
      LogToBuffer(
          log_buffer,
1991
          "BackgroundCallFlush doing FlushMemTableToOutputFile with column "
I
Igor Canadi 已提交
1992 1993 1994
          "family [%s], flush slots available %d",
          cfd->GetName().c_str(),
          options_.max_background_flushes - bg_flush_scheduled_);
1995 1996
      flush_status = FlushMemTableToOutputFile(cfd, madeProgress,
                                               deletion_state, log_buffer);
1997 1998 1999
    }
    if (call_status.ok() && !flush_status.ok()) {
      call_status = flush_status;
2000
    }
2001
    cfd->Unref();
J
jorlow@chromium.org 已提交
2002
  }
2003
  versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
2004
  return call_status;
J
jorlow@chromium.org 已提交
2005 2006
}

2007
void DBImpl::BackgroundCallFlush() {
2008
  bool madeProgress = false;
K
Kai Liu 已提交
2009
  DeletionState deletion_state(true);
2010 2011
  assert(bg_flush_scheduled_);

2012
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, options_.info_log.get());
H
Haobo Xu 已提交
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
  {
    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.
2024 2025
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
H
Haobo Xu 已提交
2026 2027
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
2028 2029 2030 2031
        Log(options_.info_log,
            "Waiting after background flush error: %s"
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
H
Haobo Xu 已提交
2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042
        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
2043
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2044
      mutex_.Unlock();
2045 2046 2047 2048 2049
      // 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 已提交
2050
      log_buffer.FlushBufferToLog();
2051 2052 2053
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2054 2055
      mutex_.Lock();
    }
I
Igor Canadi 已提交
2056

H
Haobo Xu 已提交
2057
    bg_flush_scheduled_--;
2058 2059 2060 2061 2062
    // 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 已提交
2063 2064
      MaybeScheduleFlushOrCompaction();
    }
I
Igor Canadi 已提交
2065
    RecordFlushIOStats();
H
Haobo Xu 已提交
2066
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
2067 2068 2069 2070
    // 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.
2071
  }
J
jorlow@chromium.org 已提交
2072 2073
}

2074
void DBImpl::BackgroundCallCompaction() {
2075
  bool madeProgress = false;
K
Kai Liu 已提交
2076
  DeletionState deletion_state(true);
H
Haobo Xu 已提交
2077 2078

  MaybeDumpStats();
2079
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, options_.info_log.get());
2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090
  {
    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.
2091 2092
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
2093 2094
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
H
Haobo Xu 已提交
2095
        log_buffer.FlushBufferToLog();
2096 2097 2098 2099
        Log(options_.info_log,
            "Waiting after background compaction error: %s, "
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
2100 2101 2102 2103 2104
        LogFlush(options_.info_log);
        env_->SleepForMicroseconds(1000000);
        mutex_.Lock();
      }
    }
H
Haobo Xu 已提交
2105

2106 2107 2108 2109 2110 2111 2112
    // 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
2113
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2114
      mutex_.Unlock();
2115 2116 2117 2118 2119
      // 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 已提交
2120
      log_buffer.FlushBufferToLog();
2121 2122 2123
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2124 2125
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
2126

2127
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2128

2129 2130
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

2131 2132 2133
    // Previous compaction may have produced too many files in a level,
    // So reschedule another compaction if we made progress in the
    // last compaction.
2134 2135 2136 2137 2138 2139
    //
    // 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_) {
2140 2141
      MaybeScheduleFlushOrCompaction();
    }
2142 2143 2144 2145 2146 2147 2148 2149 2150
    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 已提交
2151 2152 2153 2154
    // 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.
2155
  }
J
jorlow@chromium.org 已提交
2156 2157
}

A
Abhishek Kona 已提交
2158
Status DBImpl::BackgroundCompaction(bool* madeProgress,
2159 2160
                                    DeletionState& deletion_state,
                                    LogBuffer* log_buffer) {
2161
  *madeProgress = false;
J
jorlow@chromium.org 已提交
2162
  mutex_.AssertHeld();
2163

2164 2165
  bool is_manual = (manual_compaction_ != nullptr) &&
                   (manual_compaction_->in_progress == false);
2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183

  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);
2184
      cfd->Unref();
2185 2186 2187 2188 2189 2190 2191
      if (!flush_stat.ok()) {
        if (is_manual) {
          manual_compaction_->status = flush_stat;
          manual_compaction_->done = true;
          manual_compaction_->in_progress = false;
          manual_compaction_ = nullptr;
        }
2192
        return flush_stat;
2193 2194 2195 2196 2197
      }
    }
  }

  unique_ptr<Compaction> c;
2198 2199
  InternalKey manual_end_storage;
  InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
2200
  if (is_manual) {
G
Gabor Cselle 已提交
2201
    ManualCompaction* m = manual_compaction_;
2202
    assert(m->in_progress);
2203 2204 2205
    c.reset(m->cfd->CompactRange(m->input_level, m->output_level,
                                 m->output_path_id, m->begin, m->end,
                                 &manual_end));
2206
    if (!c) {
2207
      m->done = true;
G
Gabor Cselle 已提交
2208
    }
I
Igor Canadi 已提交
2209 2210 2211 2212 2213 2214 2215 2216 2217
    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 已提交
2218
  } else {
2219
    // no need to refcount in iteration since it's always under a mutex
I
Igor Canadi 已提交
2220
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
2221
      if (!cfd->options()->disable_auto_compactions) {
2222
        c.reset(cfd->PickCompaction(log_buffer));
I
Igor Canadi 已提交
2223 2224
        if (c != nullptr) {
          // update statistics
L
Lei Jin 已提交
2225
          MeasureTime(stats_, NUM_FILES_IN_SINGLE_COMPACTION,
I
Igor Canadi 已提交
2226 2227 2228
                      c->inputs(0)->size());
          break;
        }
I
Igor Canadi 已提交
2229 2230
      }
    }
J
jorlow@chromium.org 已提交
2231 2232 2233
  }

  Status status;
2234
  if (!c) {
H
hans@chromium.org 已提交
2235
    // Nothing to do
2236
    LogToBuffer(log_buffer, "Compaction nothing to do");
I
Igor Canadi 已提交
2237 2238 2239 2240 2241 2242 2243 2244
  } 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)) {
2245
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
2246 2247 2248 2249 2250 2251 2252 2253 2254
    }
    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 已提交
2255
  } else if (!is_manual && c->IsTrivialMove()) {
J
jorlow@chromium.org 已提交
2256
    // Move file to next level
2257
    assert(c->num_input_files(0) == 1);
J
jorlow@chromium.org 已提交
2258
    FileMetaData* f = c->input(0, 0);
2259
    c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
2260 2261 2262
    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 已提交
2263
    status = versions_->LogAndApply(c->column_family_data(), c->edit(), &mutex_,
2264
                                    db_directory_.get());
I
Igor Canadi 已提交
2265
    InstallSuperVersion(c->column_family_data(), deletion_state);
2266

2267
    Version::LevelSummaryStorage tmp;
2268 2269 2270 2271 2272 2273
    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 已提交
2274
    c->ReleaseCompactionFiles(status);
2275
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2276
  } else {
2277
    MaybeScheduleFlushOrCompaction(); // do more compaction work in parallel.
2278
    CompactionState* compact = new CompactionState(c.get());
H
Haobo Xu 已提交
2279
    status = DoCompactionWork(compact, deletion_state, log_buffer);
2280
    CleanupCompaction(compact, status);
I
Igor Canadi 已提交
2281
    c->ReleaseCompactionFiles(status);
2282
    c->ReleaseInputs();
2283
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2284
  }
2285
  c.reset();
J
jorlow@chromium.org 已提交
2286 2287 2288 2289 2290 2291

  if (status.ok()) {
    // Done
  } else if (shutting_down_.Acquire_Load()) {
    // Ignore compaction errors found during shutting down
  } else {
2292
    Log(InfoLogLevel::WARN_LEVEL, options_.info_log, "Compaction error: %s",
2293
        status.ToString().c_str());
J
jorlow@chromium.org 已提交
2294 2295 2296 2297
    if (options_.paranoid_checks && bg_error_.ok()) {
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
2298 2299

  if (is_manual) {
G
Gabor Cselle 已提交
2300
    ManualCompaction* m = manual_compaction_;
2301
    if (!status.ok()) {
L
Lei Jin 已提交
2302
      m->status = status;
2303 2304
      m->done = true;
    }
2305 2306 2307 2308 2309 2310 2311 2312 2313
    // 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.
2314 2315 2316 2317 2318
    //
    // 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) {
2319 2320
      m->done = true;
    }
G
Gabor Cselle 已提交
2321 2322 2323
    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 已提交
2324
      // Universal and FIFO compactions should always compact the whole range
I
Igor Canadi 已提交
2325
      assert(m->cfd->options()->compaction_style != kCompactionStyleUniversal);
I
Igor Canadi 已提交
2326
      assert(m->cfd->options()->compaction_style != kCompactionStyleFIFO);
2327
      m->tmp_storage = *manual_end;
G
Gabor Cselle 已提交
2328 2329
      m->begin = &m->tmp_storage;
    }
2330
    m->in_progress = false; // not being processed anymore
2331
    manual_compaction_ = nullptr;
H
hans@chromium.org 已提交
2332
  }
2333
  return status;
J
jorlow@chromium.org 已提交
2334 2335
}

2336
void DBImpl::CleanupCompaction(CompactionState* compact, Status status) {
J
jorlow@chromium.org 已提交
2337
  mutex_.AssertHeld();
2338
  if (compact->builder != nullptr) {
J
jorlow@chromium.org 已提交
2339 2340
    // May happen if we get a shutdown call in the middle of compaction
    compact->builder->Abandon();
2341
    compact->builder.reset();
J
jorlow@chromium.org 已提交
2342
  } else {
2343
    assert(compact->outfile == nullptr);
J
jorlow@chromium.org 已提交
2344
  }
D
dgrogan@chromium.org 已提交
2345
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2346 2347
    const CompactionState::Output& out = compact->outputs[i];
    pending_outputs_.erase(out.number);
2348 2349 2350 2351

    // 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 已提交
2352
      TableCache::Evict(table_cache_.get(), out.number);
2353
    }
J
jorlow@chromium.org 已提交
2354 2355 2356 2357
  }
  delete compact;
}

2358
// Allocate the file numbers for the output file. We allocate as
2359
// many output file numbers as there are files in level+1 (at least one)
2360 2361 2362
// Insert them into pending_outputs so that they do not get deleted.
void DBImpl::AllocateCompactionOutputFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2363 2364
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
2365
  int filesNeeded = compact->compaction->num_input_files(1);
2366
  for (int i = 0; i < std::max(filesNeeded, 1); i++) {
2367
    uint64_t file_number = versions_->NewFileNumber();
2368
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
2369 2370 2371 2372 2373 2374 2375
    compact->allocated_file_numbers.push_back(file_number);
  }
}

// Frees up unused file number.
void DBImpl::ReleaseCompactionUnusedFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2376
  for (const auto file_number : compact->allocated_file_numbers) {
2377 2378 2379 2380
    pending_outputs_.erase(file_number);
  }
}

J
jorlow@chromium.org 已提交
2381
Status DBImpl::OpenCompactionOutputFile(CompactionState* compact) {
2382 2383
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
J
jorlow@chromium.org 已提交
2384
  uint64_t file_number;
2385 2386 2387 2388 2389 2390 2391
  // 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 已提交
2392 2393
    mutex_.Lock();
    file_number = versions_->NewFileNumber();
2394
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
J
jorlow@chromium.org 已提交
2395 2396
    mutex_.Unlock();
  }
2397 2398
  CompactionState::Output out;
  out.number = file_number;
2399
  out.path_id = compact->compaction->GetOutputPathId();
2400 2401
  out.smallest.Clear();
  out.largest.Clear();
2402
  out.smallest_seqno = out.largest_seqno = 0;
2403
  compact->outputs.push_back(out);
J
jorlow@chromium.org 已提交
2404 2405

  // Make the output file
2406 2407
  std::string fname = TableFileName(options_.db_paths, file_number,
                                    compact->compaction->GetOutputPathId());
2408
  Status s = env_->NewWritableFile(fname, &compact->outfile, storage_options_);
2409

J
jorlow@chromium.org 已提交
2410
  if (s.ok()) {
L
Lei Jin 已提交
2411
    compact->outfile->SetIOPriority(Env::IO_LOW);
2412
    compact->outfile->SetPreallocationBlockSize(
2413
        compact->compaction->OutputFilePreallocationSize());
2414

2415
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2416 2417 2418
    compact->builder.reset(NewTableBuilder(
        *cfd->options(), cfd->internal_comparator(), compact->outfile.get(),
        compact->compaction->OutputCompressionType()));
J
jorlow@chromium.org 已提交
2419
  }
I
Igor Canadi 已提交
2420
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
2421 2422 2423 2424 2425
  return s;
}

Status DBImpl::FinishCompactionOutputFile(CompactionState* compact,
                                          Iterator* input) {
2426
  assert(compact != nullptr);
2427
  assert(compact->outfile);
2428
  assert(compact->builder != nullptr);
J
jorlow@chromium.org 已提交
2429 2430

  const uint64_t output_number = compact->current_output()->number;
2431
  const uint32_t output_path_id = compact->current_output()->path_id;
J
jorlow@chromium.org 已提交
2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444
  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;
2445
  compact->builder.reset();
J
jorlow@chromium.org 已提交
2446 2447

  // Finish and check for file errors
2448
  if (s.ok() && !options_.disableDataSync) {
2449
    if (options_.use_fsync) {
L
Lei Jin 已提交
2450
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2451 2452
      s = compact->outfile->Fsync();
    } else {
L
Lei Jin 已提交
2453
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2454 2455
      s = compact->outfile->Sync();
    }
J
jorlow@chromium.org 已提交
2456 2457 2458 2459
  }
  if (s.ok()) {
    s = compact->outfile->Close();
  }
2460
  compact->outfile.reset();
J
jorlow@chromium.org 已提交
2461 2462 2463

  if (s.ok() && current_entries > 0) {
    // Verify that the table is usable
I
Igor Canadi 已提交
2464
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2465
    FileDescriptor fd(output_number, output_path_id, current_bytes);
I
Igor Canadi 已提交
2466
    Iterator* iter = cfd->table_cache()->NewIterator(
2467
        ReadOptions(), storage_options_, cfd->internal_comparator(), fd);
J
jorlow@chromium.org 已提交
2468 2469 2470
    s = iter->status();
    delete iter;
    if (s.ok()) {
2471 2472 2473 2474
      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 已提交
2475 2476 2477 2478 2479 2480
    }
  }
  return s;
}


2481 2482
Status DBImpl::InstallCompactionResults(CompactionState* compact,
                                        LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
2483
  mutex_.AssertHeld();
2484 2485 2486 2487 2488

  // 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.
2489
  if (!versions_->VerifyCompactionFileConsistency(compact->compaction)) {
I
Igor Canadi 已提交
2490 2491 2492 2493 2494
    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 已提交
2495
    return Status::Corruption("Compaction input files inconsistent");
2496 2497
  }

I
Igor Canadi 已提交
2498 2499
  LogToBuffer(log_buffer, "[%s] Compacted %d@%d + %d@%d files => %lld bytes",
              compact->compaction->column_family_data()->GetName().c_str(),
2500 2501 2502 2503 2504
              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 已提交
2505 2506 2507

  // Add compaction outputs
  compact->compaction->AddInputDeletions(compact->compaction->edit());
D
dgrogan@chromium.org 已提交
2508
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2509
    const CompactionState::Output& out = compact->outputs[i];
2510 2511 2512 2513
    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 已提交
2514
  }
I
Igor Canadi 已提交
2515 2516 2517
  return versions_->LogAndApply(compact->compaction->column_family_data(),
                                compact->compaction->edit(), &mutex_,
                                db_directory_.get());
J
jorlow@chromium.org 已提交
2518 2519
}

2520 2521 2522 2523 2524 2525 2526
// 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(
2527 2528
  SequenceNumber in, std::vector<SequenceNumber>& snapshots,
  SequenceNumber* prev_snapshot) {
2529
  SequenceNumber prev __attribute__((unused)) = 0;
2530 2531 2532
  for (const auto cur : snapshots) {
    assert(prev <= cur);
    if (cur >= in) {
2533
      *prev_snapshot = prev;
2534
      return cur;
2535
    }
2536 2537
    prev = cur; // assignment
    assert(prev);
2538 2539
  }
  Log(options_.info_log,
2540 2541
      "Looking for seqid %" PRIu64 " but maxseqid is %" PRIu64 "", in,
      snapshots[snapshots.size() - 1]);
2542 2543 2544 2545
  assert(0);
  return 0;
}

I
Igor Canadi 已提交
2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564
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 已提交
2565
Status DBImpl::ProcessKeyValueCompaction(
2566
    bool is_snapshot_supported,
D
Danny Guo 已提交
2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577
    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 已提交
2578
  Status status;
D
Danny Guo 已提交
2579
  std::string compaction_filter_value;
J
jorlow@chromium.org 已提交
2580
  ParsedInternalKey ikey;
2581
  IterKey current_user_key;
J
jorlow@chromium.org 已提交
2582
  bool has_current_user_key = false;
2583
  IterKey delete_key;
2584 2585
  SequenceNumber last_sequence_for_key __attribute__((unused)) =
    kMaxSequenceNumber;
2586
  SequenceNumber visible_in_snapshot = kMaxSequenceNumber;
2587
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
I
Igor Canadi 已提交
2588 2589
  MergeHelper merge(
      cfd->user_comparator(), cfd->options()->merge_operator.get(),
2590 2591
      options_.info_log.get(), cfd->options()->min_partial_merge_operands,
      false /* internal key corruption is expected */);
I
Igor Canadi 已提交
2592
  auto compaction_filter = cfd->options()->compaction_filter;
2593 2594
  std::unique_ptr<CompactionFilter> compaction_filter_from_factory = nullptr;
  if (!compaction_filter) {
2595
    auto context = compact->GetFilterContextV1();
2596
    compaction_filter_from_factory =
I
Igor Canadi 已提交
2597 2598
        cfd->options()->compaction_filter_factory->CreateCompactionFilter(
            context);
2599 2600
    compaction_filter = compaction_filter_from_factory.get();
  }
2601

2602 2603
  while (input->Valid() && !shutting_down_.Acquire_Load() &&
         !cfd->IsDropped()) {
2604
    RecordCompactionIOStats();
2605 2606 2607 2608
    // 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 已提交
2609
    imm_micros += CallFlushDuringCompaction(cfd, deletion_state, log_buffer);
2610

D
Danny Guo 已提交
2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631
    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 已提交
2632

2633
    if (compact->compaction->ShouldStopBefore(key) &&
2634
        compact->builder != nullptr) {
D
Danny Guo 已提交
2635
      status = FinishCompactionOutputFile(compact, input);
2636 2637 2638 2639 2640 2641
      if (!status.ok()) {
        break;
      }
    }

    // Handle key/value, add to state, etc.
J
jorlow@chromium.org 已提交
2642
    bool drop = false;
2643
    bool current_entry_is_merging = false;
J
jorlow@chromium.org 已提交
2644 2645
    if (!ParseInternalKey(key, &ikey)) {
      // Do not hide error keys
2646 2647
      // 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.
2648
      current_user_key.Clear();
J
jorlow@chromium.org 已提交
2649 2650
      has_current_user_key = false;
      last_sequence_for_key = kMaxSequenceNumber;
2651
      visible_in_snapshot = kMaxSequenceNumber;
J
jorlow@chromium.org 已提交
2652 2653
    } else {
      if (!has_current_user_key ||
2654
          cfd->user_comparator()->Compare(ikey.user_key,
2655
                                          current_user_key.GetKey()) != 0) {
J
jorlow@chromium.org 已提交
2656
        // First occurrence of this user key
L
Lei Jin 已提交
2657
        current_user_key.SetKey(ikey.user_key);
J
jorlow@chromium.org 已提交
2658 2659
        has_current_user_key = true;
        last_sequence_for_key = kMaxSequenceNumber;
2660
        visible_in_snapshot = kMaxSequenceNumber;
H
Haobo Xu 已提交
2661
        // apply the compaction filter to the first occurrence of the user key
D
Danny Guo 已提交
2662
        if (compaction_filter && !is_compaction_v2 &&
H
Haobo Xu 已提交
2663 2664 2665 2666 2667 2668 2669 2670 2671
            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 已提交
2672 2673 2674
          bool to_delete = compaction_filter->Filter(
              compact->compaction->level(), ikey.user_key, value,
              &compaction_filter_value, &value_changed);
H
Haobo Xu 已提交
2675
          if (to_delete) {
2676 2677 2678
            // make a copy of the original key and convert it to a delete
            delete_key.SetInternalKey(ExtractUserKey(key), ikey.sequence,
                                      kTypeDeletion);
H
Haobo Xu 已提交
2679
            // anchor the key again
2680
            key = delete_key.GetKey();
H
Haobo Xu 已提交
2681 2682 2683 2684
            // needed because ikey is backed by key
            ParseInternalKey(key, &ikey);
            // no value associated with delete
            value.clear();
L
Lei Jin 已提交
2685
            RecordTick(stats_, COMPACTION_KEY_DROP_USER);
H
Haobo Xu 已提交
2686 2687 2688 2689
          } else if (value_changed) {
            value = compaction_filter_value;
          }
        }
J
jorlow@chromium.org 已提交
2690 2691
      }

2692 2693 2694
      // 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.
2695
      SequenceNumber prev_snapshot = 0; // 0 means no previous snapshot
2696 2697 2698 2699
      SequenceNumber visible = visible_at_tip ? visible_at_tip :
        is_snapshot_supported ?  findEarliestVisibleSnapshot(ikey.sequence,
                                  compact->existing_snapshots, &prev_snapshot)
                              : 0;
2700 2701 2702 2703 2704

      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 已提交
2705
        // Hidden by an newer entry for same user key
2706
        // TODO: why not > ?
2707
        assert(last_sequence_for_key >= ikey.sequence);
J
jorlow@chromium.org 已提交
2708
        drop = true;    // (A)
L
Lei Jin 已提交
2709
        RecordTick(stats_, COMPACTION_KEY_DROP_NEWER_ENTRY);
J
jorlow@chromium.org 已提交
2710
      } else if (ikey.type == kTypeDeletion &&
D
Danny Guo 已提交
2711
          ikey.sequence <= earliest_snapshot &&
2712
          compact->compaction->KeyNotExistsBeyondOutputLevel(ikey.user_key)) {
J
jorlow@chromium.org 已提交
2713 2714 2715 2716 2717 2718 2719 2720
        // 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 已提交
2721
        RecordTick(stats_, COMPACTION_KEY_DROP_OBSOLETE);
2722
      } else if (ikey.type == kTypeMerge) {
2723 2724 2725 2726 2727 2728
        if (!merge.HasOperator()) {
          LogToBuffer(log_buffer, "Options::merge_operator is null.");
          status = Status::InvalidArgument(
              "merge_operator is not properly initialized.");
          break;
        }
2729 2730 2731 2732 2733 2734
        // 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 已提交
2735 2736 2737 2738 2739 2740
        int steps = 0;
        merge.MergeUntil(input, prev_snapshot, bottommost_level,
            options_.statistics.get(), &steps);
        // Skip the Merge ops
        combined_idx = combined_idx - 1 + steps;

2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758
        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 已提交
2759 2760 2761
      }

      last_sequence_for_key = ikey.sequence;
2762
      visible_in_snapshot = visible;
J
jorlow@chromium.org 已提交
2763 2764 2765
    }

    if (!drop) {
2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781
      // 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);
2782
      }
2783

2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794
      // 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.
2795
        if (bottommost_level && ikey.sequence < earliest_snapshot &&
2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806
            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
2807

2808 2809 2810 2811 2812 2813 2814
        // Open output file if necessary
        if (compact->builder == nullptr) {
          status = OpenCompactionOutputFile(compact);
          if (!status.ok()) {
            break;
          }
        }
2815 2816

        SequenceNumber seqno = GetInternalKeySeqno(newkey);
2817 2818
        if (compact->builder->NumEntries() == 0) {
          compact->current_output()->smallest.DecodeFrom(newkey);
2819 2820 2821 2822
          compact->current_output()->smallest_seqno = seqno;
        } else {
          compact->current_output()->smallest_seqno =
            std::min(compact->current_output()->smallest_seqno, seqno);
2823 2824 2825
        }
        compact->current_output()->largest.DecodeFrom(newkey);
        compact->builder->Add(newkey, value);
2826 2827
        compact->current_output()->largest_seqno =
          std::max(compact->current_output()->largest_seqno, seqno);
2828 2829 2830 2831

        // Close output file if it is big enough
        if (compact->builder->FileSize() >=
            compact->compaction->MaxOutputFileSize()) {
D
Danny Guo 已提交
2832
          status = FinishCompactionOutputFile(compact, input);
2833 2834 2835
          if (!status.ok()) {
            break;
          }
J
jorlow@chromium.org 已提交
2836 2837
        }

2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857
        // 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 已提交
2858 2859 2860 2861 2862
          break;
        }
      }
    }

2863
    // MergeUntil has moved input to the next entry
2864
    if (!current_entry_is_merging) {
2865 2866
      input->Next();
    }
J
jorlow@chromium.org 已提交
2867 2868
  }

2869 2870
  RecordCompactionIOStats();

D
Danny Guo 已提交
2871 2872 2873 2874 2875 2876 2877 2878 2879
  return status;
}

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

2880
  // Assemble slice vectors for user keys and existing values.
2881
  // We also keep track of our parsed internal key structs because
2882 2883 2884
  // 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 已提交
2885
  std::vector<Slice> user_key_buf;
2886 2887 2888 2889 2890 2891 2892 2893 2894 2895
  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 已提交
2896 2897 2898 2899 2900 2901 2902 2903 2904
  }

  // 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(),
2905
      user_key_buf, existing_value_buf,
D
Danny Guo 已提交
2906 2907 2908 2909 2910 2911
      &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() ==
2912
      compact->key_str_buf_.size());
D
Danny Guo 已提交
2913
  assert(compact->to_delete_buf_.size() ==
2914
      compact->existing_value_str_buf_.size());
D
Danny Guo 已提交
2915 2916 2917 2918 2919 2920 2921 2922 2923
  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],
2924 2925 2926
                        compact->key_str_buf_[i].size(),
                        ikey_buf[i].sequence,
                        kTypeDeletion);
D
Danny Guo 已提交
2927 2928

      // no value associated with delete
2929
      compact->existing_value_str_buf_[i].clear();
L
Lei Jin 已提交
2930
      RecordTick(stats_, COMPACTION_KEY_DROP_USER);
D
Danny Guo 已提交
2931
    } else if (compact->value_changed_buf_[i]) {
2932 2933
      compact->existing_value_str_buf_[i] =
          compact->new_value_buf_[new_value_idx++];
D
Danny Guo 已提交
2934 2935 2936 2937 2938 2939 2940 2941 2942 2943
    }
  }  // for
}

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

F
Feng Zhu 已提交
2946 2947
  // Generate file_levels_ for compaction berfore making Iterator
  compact->compaction->GenerateFileLevels();
D
Danny Guo 已提交
2948
  int64_t imm_micros = 0;  // Micros spent doing imm_ compactions
2949
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
2950 2951
  LogToBuffer(
      log_buffer,
I
Igor Canadi 已提交
2952 2953
      "[%s] Compacting %d@%d + %d@%d files, score %.2f slots available %d",
      cfd->GetName().c_str(), compact->compaction->num_input_files(0),
2954 2955
      compact->compaction->level(), compact->compaction->num_input_files(1),
      compact->compaction->output_level(), compact->compaction->score(),
D
Danny Guo 已提交
2956 2957 2958
      options_.max_background_compactions - bg_compaction_scheduled_);
  char scratch[2345];
  compact->compaction->Summary(scratch, sizeof(scratch));
I
Igor Canadi 已提交
2959 2960
  LogToBuffer(log_buffer, "[%s] Compaction start summary: %s\n",
              cfd->GetName().c_str(), scratch);
D
Danny Guo 已提交
2961

2962
  assert(cfd->current()->NumLevelFiles(compact->compaction->level()) > 0);
D
Danny Guo 已提交
2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987
  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);

2988
  bool is_snapshot_supported = IsSnapshotSupported();
D
Danny Guo 已提交
2989 2990
  // Release mutex while we're actually doing the compaction work
  mutex_.Unlock();
2991
  log_buffer->FlushBufferToLog();
D
Danny Guo 已提交
2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005

  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 =
3006 3007
      cfd->options()->compaction_filter_factory_v2->CreateCompactionFilterV2(
          context);
D
Danny Guo 已提交
3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018
  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) {
3019 3020
    while (backup_input->Valid() && !shutting_down_.Acquire_Load() &&
           !cfd->IsDropped()) {
I
Igor Canadi 已提交
3021 3022 3023 3024 3025 3026
      // 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 已提交
3027 3028 3029 3030
      Slice key = backup_input->key();
      Slice value = backup_input->value();

      const SliceTransform* transformer =
3031
          cfd->options()->compaction_filter_factory_v2->GetPrefixExtractor();
3032
      const auto key_prefix = transformer->Transform(key);
3033
      if (!prefix_initialized) {
3034
        compact->cur_prefix_ = key_prefix.ToString();
3035
        prefix_initialized = true;
D
Danny Guo 已提交
3036 3037 3038
      }
      if (!ParseInternalKey(key, &ikey)) {
        // log error
I
Igor Canadi 已提交
3039 3040
        Log(options_.info_log, "[%s] Failed to parse key: %s",
            cfd->GetName().c_str(), key.ToString().c_str());
D
Danny Guo 已提交
3041 3042 3043
        continue;
      } else {
        // If the prefix remains the same, keep buffering
3044
        if (key_prefix.compare(Slice(compact->cur_prefix_)) == 0) {
D
Danny Guo 已提交
3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061
          // 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
3062
          if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3063 3064
            CallCompactionFilterV2(compact, compaction_filter_v2);
          }
3065
          compact->cur_prefix_ = key_prefix.ToString();
D
Danny Guo 已提交
3066 3067 3068 3069
        }
      }

      // Merge this batch of data (values + ineligible keys)
3070
      compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3071 3072 3073 3074

      // Done buffering for the current prefix. Spit it out to disk
      // Now just iterate through all the kv-pairs
      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 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104
          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.
3105
        if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3106 3107
          CallCompactionFilterV2(compact, compaction_filter_v2);
        }
3108
        compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3109 3110

        status = ProcessKeyValueCompaction(
3111
            is_snapshot_supported,
D
Danny Guo 已提交
3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127
            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
3128
    if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3129 3130
      CallCompactionFilterV2(compact, compaction_filter_v2);
    }
3131
    compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3132
    status = ProcessKeyValueCompaction(
3133
        is_snapshot_supported,
D
Danny Guo 已提交
3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147
        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(
3148
      is_snapshot_supported,
D
Danny Guo 已提交
3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160
      visible_at_tip,
      earliest_snapshot,
      latest_snapshot,
      deletion_state,
      bottommost_level,
      imm_micros,
      input.get(),
      compact,
      false,
      log_buffer);
  }

3161
  if (status.ok() && (shutting_down_.Acquire_Load() || cfd->IsDropped())) {
L
Lei Jin 已提交
3162
    status = Status::ShutdownInProgress(
3163
        "Database shutdown or Column family drop during compaction");
J
jorlow@chromium.org 已提交
3164
  }
3165
  if (status.ok() && compact->builder != nullptr) {
3166
    status = FinishCompactionOutputFile(compact, input.get());
J
jorlow@chromium.org 已提交
3167 3168 3169 3170
  }
  if (status.ok()) {
    status = input->status();
  }
3171
  input.reset();
J
jorlow@chromium.org 已提交
3172

3173 3174 3175
  if (!options_.disableDataSync) {
    db_directory_->Fsync();
  }
I
Igor Canadi 已提交
3176

L
Lei Jin 已提交
3177
  InternalStats::CompactionStats stats(1);
3178
  stats.micros = env_->NowMicros() - start_micros - imm_micros;
M
Mark Callaghan 已提交
3179 3180
  stats.files_in_leveln = compact->compaction->num_input_files(0);
  stats.files_in_levelnp1 = compact->compaction->num_input_files(1);
L
Lei Jin 已提交
3181
  MeasureTime(stats_, COMPACTION_TIME, stats.micros);
3182 3183

  int num_output_files = compact->outputs.size();
3184
  if (compact->builder != nullptr) {
P
Pascal Borreli 已提交
3185
    // An error occurred so ignore the last output.
3186 3187 3188 3189
    assert(num_output_files > 0);
    --num_output_files;
  }
  stats.files_out_levelnp1 = num_output_files;
M
Mark Callaghan 已提交
3190

3191
  for (int i = 0; i < compact->compaction->num_input_files(0); i++) {
3192
    stats.bytes_readn += compact->compaction->input(0, i)->fd.GetFileSize();
3193
  }
M
Mark Callaghan 已提交
3194

3195
  for (int i = 0; i < compact->compaction->num_input_files(1); i++) {
3196
    stats.bytes_readnp1 += compact->compaction->input(1, i)->fd.GetFileSize();
3197
  }
M
Mark Callaghan 已提交
3198

3199
  for (int i = 0; i < num_output_files; i++) {
3200 3201 3202
    stats.bytes_written += compact->outputs[i].file_size;
  }

3203 3204
  RecordCompactionIOStats();

I
Igor Canadi 已提交
3205
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
3206
  mutex_.Lock();
3207 3208
  cfd->internal_stats()->AddCompactionStats(
      compact->compaction->output_level(), stats);
J
jorlow@chromium.org 已提交
3209

3210 3211 3212 3213
  // 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 已提交
3214
  if (status.ok()) {
3215
    status = InstallCompactionResults(compact, log_buffer);
I
Igor Canadi 已提交
3216
    InstallSuperVersion(cfd, deletion_state);
J
jorlow@chromium.org 已提交
3217
  }
3218
  Version::LevelSummaryStorage tmp;
3219 3220
  LogToBuffer(
      log_buffer,
I
Igor Canadi 已提交
3221
      "[%s] compacted to: %s, %.1f MB/sec, level %d, files in(%d, %d) out(%d) "
3222 3223
      "MB in(%.1f, %.1f) out(%.1f), read-write-amplify(%.1f) "
      "write-amplify(%.1f) %s\n",
I
Igor Canadi 已提交
3224
      cfd->GetName().c_str(), cfd->current()->LevelSummary(&tmp),
M
Mark Callaghan 已提交
3225
      (stats.bytes_readn + stats.bytes_readnp1 + stats.bytes_written) /
3226 3227 3228 3229
          (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 已提交
3230
      stats.bytes_written / 1048576.0,
3231
      (stats.bytes_written + stats.bytes_readnp1 + stats.bytes_readn) /
3232 3233
          (double)stats.bytes_readn,
      stats.bytes_written / (double)stats.bytes_readn,
3234
      status.ToString().c_str());
M
Mark Callaghan 已提交
3235

J
jorlow@chromium.org 已提交
3236 3237 3238
  return status;
}

3239 3240
namespace {
struct IterState {
3241 3242
  IterState(DBImpl* db, port::Mutex* mu, SuperVersion* super_version)
      : db(db), mu(mu), super_version(super_version) {}
3243 3244

  DBImpl* db;
3245
  port::Mutex* mu;
3246
  SuperVersion* super_version;
3247 3248 3249 3250
};

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

3252
  if (state->super_version->Unref()) {
3253 3254
    DBImpl::DeletionState deletion_state;

3255 3256 3257 3258 3259 3260
    state->mu->Lock();
    state->super_version->Cleanup();
    state->db->FindObsoleteFiles(deletion_state, false, true);
    state->mu->Unlock();

    delete state->super_version;
3261 3262 3263
    if (deletion_state.HaveSomethingToDelete()) {
      state->db->PurgeObsoleteFiles(deletion_state);
    }
I
Igor Canadi 已提交
3264
  }
T
Tomislav Novak 已提交
3265

3266 3267
  delete state;
}
H
Hans Wennborg 已提交
3268
}  // namespace
3269

J
jorlow@chromium.org 已提交
3270
Iterator* DBImpl::NewInternalIterator(const ReadOptions& options,
3271
                                      ColumnFamilyData* cfd,
3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299
                                      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());
  }
3300
  IterState* cleanup = new IterState(this, &mutex_, super_version);
3301
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
3302 3303 3304 3305

  return internal_iter;
}

3306 3307 3308 3309
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

J
jorlow@chromium.org 已提交
3310
Status DBImpl::Get(const ReadOptions& options,
3311
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3312
                   std::string* value) {
3313
  return GetImpl(options, column_family, key, value);
3314 3315
}

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

3339
Status DBImpl::GetImpl(const ReadOptions& options,
3340 3341
                       ColumnFamilyHandle* column_family, const Slice& key,
                       std::string* value, bool* value_found) {
L
Lei Jin 已提交
3342
  StopWatch sw(env_, stats_, DB_GET);
L
Lei Jin 已提交
3343
  PERF_TIMER_AUTO(get_snapshot_time);
3344

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

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

3355
  // Acquire SuperVersion
3356
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
I
Igor Canadi 已提交
3357

3358
  // Prepare to store a list of merge operations if merge occurs.
3359
  MergeContext merge_context;
3360

3361
  Status s;
3362
  // First look in the memtable, then in the immutable memtable (if any).
3363
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3364
  // merge_operands will contain the sequence of merges in the latter case.
3365
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3366
  PERF_TIMER_STOP(get_snapshot_time);
I
Igor Canadi 已提交
3367
  if (sv->mem->Get(lkey, value, &s, merge_context, *cfd->options())) {
3368
    // Done
L
Lei Jin 已提交
3369
    RecordTick(stats_, MEMTABLE_HIT);
I
Igor Canadi 已提交
3370
  } else if (sv->imm->Get(lkey, value, &s, merge_context, *cfd->options())) {
3371
    // Done
L
Lei Jin 已提交
3372
    RecordTick(stats_, MEMTABLE_HIT);
3373
  } else {
L
Lei Jin 已提交
3374
    PERF_TIMER_START(get_from_output_files_time);
3375

I
Igor Canadi 已提交
3376
    sv->current->Get(options, lkey, value, &s, &merge_context, value_found);
L
Lei Jin 已提交
3377
    PERF_TIMER_STOP(get_from_output_files_time);
L
Lei Jin 已提交
3378
    RecordTick(stats_, MEMTABLE_MISS);
3379
  }
3380

L
Lei Jin 已提交
3381
  PERF_TIMER_START(get_post_process_time);
3382

3383
  ReturnAndCleanupSuperVersion(cfd, sv);
3384

L
Lei Jin 已提交
3385 3386
  RecordTick(stats_, NUMBER_KEYS_READ);
  RecordTick(stats_, BYTES_READ, value->size());
L
Lei Jin 已提交
3387
  PERF_TIMER_STOP(get_post_process_time);
3388
  return s;
J
jorlow@chromium.org 已提交
3389 3390
}

3391 3392
std::vector<Status> DBImpl::MultiGet(
    const ReadOptions& options,
3393
    const std::vector<ColumnFamilyHandle*>& column_family,
3394
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3395

L
Lei Jin 已提交
3396
  StopWatch sw(env_, stats_, DB_MULTIGET);
L
Lei Jin 已提交
3397
  PERF_TIMER_AUTO(get_snapshot_time);
K
Kai Liu 已提交
3398

3399
  SequenceNumber snapshot;
3400

3401
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3402
    ColumnFamilyData* cfd;
3403 3404 3405 3406 3407
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3408 3409 3410 3411 3412 3413
    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});
3414 3415 3416
    }
  }

3417
  mutex_.Lock();
3418 3419 3420 3421 3422
  if (options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_;
  } else {
    snapshot = versions_->LastSequence();
  }
3423
  for (auto mgd_iter : multiget_cf_data) {
3424 3425
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3426
  }
3427
  mutex_.Unlock();
3428

3429 3430
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3431

3432
  // Note: this always resizes the values array
3433 3434 3435
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3436 3437

  // Keep track of bytes that we read for statistics-recording later
3438
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3439
  PERF_TIMER_STOP(get_snapshot_time);
3440 3441 3442 3443

  // 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.
3444
  // merge_operands will contain the sequence of merges in the latter case.
3445
  for (size_t i = 0; i < num_keys; ++i) {
3446
    merge_context.Clear();
3447
    Status& s = stat_list[i];
3448 3449 3450
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3451 3452
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3453 3454 3455
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
I
Igor Canadi 已提交
3456 3457
    auto cfd = mgd->cfd;
    if (super_version->mem->Get(lkey, value, &s, merge_context,
I
Igor Canadi 已提交
3458
                                *cfd->options())) {
3459
      // Done
3460
    } else if (super_version->imm->Get(lkey, value, &s, merge_context,
I
Igor Canadi 已提交
3461
                                       *cfd->options())) {
3462 3463
      // Done
    } else {
I
Igor Canadi 已提交
3464
      super_version->current->Get(options, lkey, value, &s, &merge_context);
3465 3466 3467
    }

    if (s.ok()) {
3468
      bytes_read += value->size();
3469 3470 3471 3472
    }
  }

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

I
Igor Canadi 已提交
3476
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3477 3478 3479 3480 3481 3482
  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);
3483 3484
    }
  }
3485 3486 3487 3488 3489 3490 3491
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3492
  }
3493

L
Lei Jin 已提交
3494 3495 3496
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
L
Lei Jin 已提交
3497
  PERF_TIMER_STOP(get_post_process_time);
3498

3499
  return stat_list;
3500 3501
}

3502
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& options,
3503
                                  const std::string& column_family_name,
3504
                                  ColumnFamilyHandle** handle) {
I
Igor Canadi 已提交
3505 3506 3507
  *handle = nullptr;
  MutexLock l(&mutex_);

I
Igor Canadi 已提交
3508 3509
  if (versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name) !=
      nullptr) {
I
Igor Canadi 已提交
3510 3511
    return Status::InvalidArgument("Column family already exists");
  }
3512
  VersionEdit edit;
3513
  edit.AddColumnFamily(column_family_name);
3514 3515
  uint32_t new_id = versions_->GetColumnFamilySet()->GetNextColumnFamilyID();
  edit.SetColumnFamily(new_id);
I
Igor Canadi 已提交
3516
  edit.SetLogNumber(logfile_number_);
I
Igor Canadi 已提交
3517
  edit.SetComparatorName(options.comparator->Name());
3518

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

3541 3542 3543 3544
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3545 3546
    return Status::InvalidArgument("Can't drop default column family");
  }
3547

I
Igor Canadi 已提交
3548 3549
  VersionEdit edit;
  edit.DropColumnFamily();
3550 3551
  edit.SetColumnFamily(cfd->GetID());

3552
  Status s;
3553 3554 3555 3556 3557 3558 3559 3560
  {
    MutexLock l(&mutex_);
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
      s = versions_->LogAndApply(cfd, &edit, &mutex_);
    }
3561
  }
3562

3563
  if (s.ok()) {
I
Igor Canadi 已提交
3564
    assert(cfd->IsDropped());
I
Igor Canadi 已提交
3565 3566
    max_total_in_memory_state_ -= cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
3567 3568 3569 3570 3571 3572
    Log(options_.info_log, "Dropped column family with id %u\n", cfd->GetID());
  } else {
    Log(options_.info_log, "Dropping column family with id %u FAILED -- %s\n",
        cfd->GetID(), s.ToString().c_str());
  }

3573
  return s;
3574 3575
}

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

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

3593
Iterator* DBImpl::NewIterator(const ReadOptions& options,
3594 3595 3596
                              ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
3597 3598

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

I
Igor Canadi 已提交
3614 3615 3616 3617
    auto snapshot =
        options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_
            : latest_snapshot;
T
Tomislav Novak 已提交
3618

3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668
    // 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 已提交
3669 3670
}

3671 3672
Status DBImpl::NewIterators(
    const ReadOptions& options,
I
Igor Canadi 已提交
3673
    const std::vector<ColumnFamilyHandle*>& column_families,
3674
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691
  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 已提交
3692 3693 3694 3695
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
3696 3697
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
L
Lei Jin 已提交
3698 3699 3700 3701
      auto iter = new ForwardIterator(this, options, cfd);
      iterators->push_back(
          NewDBIterator(env_, *cfd->options(), cfd->user_comparator(), iter,
                        kMaxSequenceNumber));
I
Igor Canadi 已提交
3702
    }
I
Igor Canadi 已提交
3703
#endif
I
Igor Canadi 已提交
3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714
  } 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 已提交
3715
      iter = NewDBIterator(env_, *cfd->options(),
I
Igor Canadi 已提交
3716 3717 3718 3719 3720 3721
                           cfd->user_comparator(), iter, snapshot);
      iterators->push_back(iter);
    }
  }

  return Status::OK();
3722 3723
}

3724 3725 3726 3727 3728 3729 3730 3731 3732
bool DBImpl::IsSnapshotSupported() const {
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (!cfd->mem()->IsSnapshotSupported()) {
      return false;
    }
  }
  return true;
}

J
jorlow@chromium.org 已提交
3733
const Snapshot* DBImpl::GetSnapshot() {
3734
  MutexLock l(&mutex_);
3735 3736
  // returns null if the underlying memtable does not support snapshot.
  if (!IsSnapshotSupported()) return nullptr;
3737
  return snapshots_.New(versions_->LastSequence());
J
jorlow@chromium.org 已提交
3738 3739 3740 3741
}

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

// Convenience methods
3746 3747
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
3748
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
3749 3750
}

3751 3752 3753 3754
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) {
3755 3756
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
3757
    return DB::Merge(o, column_family, key, val);
3758 3759 3760
  }
}

3761
Status DBImpl::Delete(const WriteOptions& options,
3762
                      ColumnFamilyHandle* column_family, const Slice& key) {
3763
  return DB::Delete(options, column_family, key);
J
jorlow@chromium.org 已提交
3764 3765
}

S
Stanislau Hlebik 已提交
3766 3767
// REQUIRES: mutex_ is held
Status DBImpl::BeginWrite(Writer* w, uint64_t expiration_time) {
3768 3769 3770 3771 3772
  // 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.
S
Stanislau Hlebik 已提交
3773 3774
  mutex_.AssertHeld();
  writers_.push_back(w);
3775 3776

  bool timed_out = false;
S
Stanislau Hlebik 已提交
3777
  while (!w->done && w != writers_.front()) {
3778
    if (expiration_time == 0) {
S
Stanislau Hlebik 已提交
3779 3780 3781
      w->cv.Wait();
    } else if (w->cv.TimedWait(expiration_time)) {
      if (w->in_batch_group) {
3782 3783 3784 3785 3786 3787 3788 3789 3790
        // 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;
      }
    }
3791
  }
3792

S
Stanislau Hlebik 已提交
3793
  if (timed_out) {
3794
#ifndef NDEBUG
3795
    bool found = false;
3796
#endif
3797
    for (auto iter = writers_.begin(); iter != writers_.end(); iter++) {
S
Stanislau Hlebik 已提交
3798
      if (*iter == w) {
3799
        writers_.erase(iter);
3800
#ifndef NDEBUG
3801
        found = true;
3802
#endif
3803 3804 3805
        break;
      }
    }
3806
#ifndef NDEBUG
3807
    assert(found);
3808
#endif
3809 3810 3811 3812 3813 3814
    // 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();
    }
S
Stanislau Hlebik 已提交
3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871
    return Status::TimedOut();
  }
  return Status::OK();
}

// REQUIRES: mutex_ is held
void DBImpl::EndWrite(Writer* w, Writer* last_writer, Status status) {
  // Pop out the current writer and all writers being pushed before the
  // current writer from the writer queue.
  mutex_.AssertHeld();
  while (!writers_.empty()) {
    Writer* ready = writers_.front();
    writers_.pop_front();
    if (ready != w) {
      ready->status = status;
      ready->done = true;
      ready->cv.Signal();
    }
    if (ready == last_writer) break;
  }

  // Notify new head of write queue
  if (!writers_.empty()) {
    writers_.front()->cv.Signal();
  }
}

Status DBImpl::Write(const WriteOptions& options, WriteBatch* my_batch) {
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
  PERF_TIMER_AUTO(write_pre_and_post_process_time);
  Writer w(&mutex_);
  w.batch = my_batch;
  w.sync = options.sync;
  w.disableWAL = options.disableWAL;
  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;
  }

  if (!options.disableWAL) {
    RecordTick(stats_, WRITE_WITH_WAL);
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_WITH_WAL, 1);
  }

  WriteContext context;
  mutex_.Lock();
  Status status = BeginWrite(&w, expiration_time);
  assert(status.ok() || status.IsTimedOut());
  if (status.IsTimedOut()) {
3872
    mutex_.Unlock();
L
Lei Jin 已提交
3873
    RecordTick(stats_, WRITE_TIMEDOUT);
3874
    return Status::TimedOut();
3875
  }
S
Stanislau Hlebik 已提交
3876 3877 3878 3879 3880 3881 3882 3883 3884 3885
  if (w.done) {  // write was done by someone else
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_OTHER,
                                           1);
    mutex_.Unlock();
    RecordTick(stats_, WRITE_DONE_BY_OTHER);
    return w.status;
  }

  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
3886

3887 3888 3889 3890
  // 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.
3891 3892 3893
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

I
Igor Canadi 已提交
3894
  uint64_t flush_column_family_if_log_file = 0;
I
Igor Canadi 已提交
3895
  uint64_t max_total_wal_size = (options_.max_total_wal_size == 0)
3896
                                    ? 4 * max_total_in_memory_state_
I
Igor Canadi 已提交
3897
                                    : options_.max_total_wal_size;
3898
  if (UNLIKELY(!single_column_family_mode_) &&
3899
      alive_log_files_.begin()->getting_flushed == false &&
I
Igor Canadi 已提交
3900 3901 3902 3903
      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,
3904 3905 3906
        "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 已提交
3907 3908
  }

3909 3910
  if (LIKELY(single_column_family_mode_)) {
    // fast path
S
Stanislau Hlebik 已提交
3911 3912
    status = MakeRoomForWrite(default_cf_handle_->cfd(),
                              &context, expiration_time);
3913 3914 3915 3916 3917
  } else {
    // refcounting cfd in iteration
    bool dead_cfd = false;
    for (auto cfd : *versions_->GetColumnFamilySet()) {
      cfd->Ref();
S
Stanislau Hlebik 已提交
3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929
      if (flush_column_family_if_log_file != 0 &&
          cfd->GetLogNumber() <= flush_column_family_if_log_file) {
        // log size excedded limit and we need to do flush
        // SetNewMemtableAndNewLogFie may temporarily unlock and wait
        status = SetNewMemtableAndNewLogFile(cfd, &context);
        cfd->imm()->FlushRequested();
        MaybeScheduleFlushOrCompaction();
      } else {
        // May temporarily unlock and wait.
        status = MakeRoomForWrite(cfd, &context, expiration_time);
      }

3930 3931 3932 3933 3934 3935
      if (cfd->Unref()) {
        dead_cfd = true;
      }
      if (!status.ok()) {
        break;
      }
3936
    }
3937 3938
    if (dead_cfd) {
      versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
3939 3940
    }
  }
3941

D
dgrogan@chromium.org 已提交
3942
  uint64_t last_sequence = versions_->LastSequence();
3943
  Writer* last_writer = &w;
S
Stanislau Hlebik 已提交
3944
  if (status.ok()) {
3945 3946
    autovector<WriteBatch*> write_batch_group;
    BuildBatchGroup(&last_writer, &write_batch_group);
3947

3948 3949 3950
    // 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
3951
    // into memtables
3952
    {
3953
      mutex_.Unlock();
3954 3955 3956 3957 3958 3959 3960 3961 3962 3963
      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]);
        }
      }

3964 3965 3966 3967
      const SequenceNumber current_sequence = last_sequence + 1;
      WriteBatchInternal::SetSequence(updates, current_sequence);
      int my_batch_count = WriteBatchInternal::Count(updates);
      last_sequence += my_batch_count;
3968
      const uint64_t batch_size = WriteBatchInternal::ByteSize(updates);
3969
      // Record statistics
L
Lei Jin 已提交
3970 3971
      RecordTick(stats_, NUMBER_KEYS_WRITTEN, my_batch_count);
      RecordTick(stats_, BYTES_WRITTEN, WriteBatchInternal::ByteSize(updates));
3972 3973
      if (options.disableWAL) {
        flush_on_destroy_ = true;
3974
      }
L
Lei Jin 已提交
3975
      PERF_TIMER_STOP(write_pre_and_post_process_time);
3976

3977
      uint64_t log_size = 0;
3978
      if (!options.disableWAL) {
L
Lei Jin 已提交
3979
        PERF_TIMER_START(write_wal_time);
3980 3981
        Slice log_entry = WriteBatchInternal::Contents(updates);
        status = log_->AddRecord(log_entry);
I
Igor Canadi 已提交
3982 3983
        total_log_size_ += log_entry.size();
        alive_log_files_.back().AddSize(log_entry.size());
3984
        log_empty_ = false;
3985
        log_size = log_entry.size();
L
Lei Jin 已提交
3986 3987
        RecordTick(stats_, WAL_FILE_SYNCED);
        RecordTick(stats_, WAL_FILE_BYTES, log_size);
H
heyongqiang 已提交
3988
        if (status.ok() && options.sync) {
3989
          if (options_.use_fsync) {
L
Lei Jin 已提交
3990
            StopWatch(env_, stats_, WAL_FILE_SYNC_MICROS);
3991
            status = log_->file()->Fsync();
3992
          } else {
L
Lei Jin 已提交
3993
            StopWatch(env_, stats_, WAL_FILE_SYNC_MICROS);
3994
            status = log_->file()->Sync();
3995
          }
H
heyongqiang 已提交
3996
        }
L
Lei Jin 已提交
3997
        PERF_TIMER_STOP(write_wal_time);
3998 3999
      }
      if (status.ok()) {
L
Lei Jin 已提交
4000
        PERF_TIMER_START(write_memtable_time);
Y
Yueh-Hsuan Chiang 已提交
4001

4002
        status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
4003
            updates, column_family_memtables_.get(), false, 0, this, false);
Y
Yueh-Hsuan Chiang 已提交
4004 4005 4006 4007 4008 4009 4010 4011
        // 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 已提交
4012
        PERF_TIMER_STOP(write_memtable_time);
4013

L
Lei Jin 已提交
4014
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
4015
      }
L
Lei Jin 已提交
4016
      PERF_TIMER_START(write_pre_and_post_process_time);
4017 4018 4019
      if (updates == &tmp_batch_) {
        tmp_batch_.Clear();
      }
4020
      mutex_.Lock();
4021 4022 4023 4024 4025 4026 4027 4028 4029
      // 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);
      }
4030
      if (status.ok()) {
4031
        versions_->SetLastSequence(last_sequence);
4032
      }
J
jorlow@chromium.org 已提交
4033 4034
    }
  }
4035 4036
  if (options_.paranoid_checks && !status.ok() &&
      !status.IsTimedOut() && bg_error_.ok()) {
I
Igor Canadi 已提交
4037 4038
    bg_error_ = status; // stop compaction & fail any further writes
  }
4039

S
Stanislau Hlebik 已提交
4040
  EndWrite(&w, last_writer, status);
I
Igor Canadi 已提交
4041
  mutex_.Unlock();
4042

4043
  if (status.IsTimedOut()) {
L
Lei Jin 已提交
4044
    RecordTick(stats_, WRITE_TIMEDOUT);
4045 4046
  }

L
Lei Jin 已提交
4047
  PERF_TIMER_STOP(write_pre_and_post_process_time);
J
jorlow@chromium.org 已提交
4048 4049 4050
  return status;
}

4051 4052 4053
// This function will be called only when the first writer succeeds.
// All writers in the to-be-built batch group will be processed.
//
4054
// REQUIRES: Writer list must be non-empty
4055
// REQUIRES: First writer must have a non-nullptr batch
4056 4057
void DBImpl::BuildBatchGroup(Writer** last_writer,
                             autovector<WriteBatch*>* write_batch_group) {
4058 4059
  assert(!writers_.empty());
  Writer* first = writers_.front();
4060
  assert(first->batch != nullptr);
4061 4062

  size_t size = WriteBatchInternal::ByteSize(first->batch);
4063
  write_batch_group->push_back(first->batch);
4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082

  // 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 已提交
4083 4084 4085 4086 4087 4088
    if (!w->disableWAL && first->disableWAL) {
      // Do not include a write that needs WAL into a batch that has
      // WAL disabled.
      break;
    }

4089 4090 4091 4092 4093 4094
    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;
    }

4095
    if (w->batch != nullptr) {
4096 4097 4098 4099 4100 4101
      size += WriteBatchInternal::ByteSize(w->batch);
      if (size > max_size) {
        // Do not make batch too big
        break;
      }

4102
      write_batch_group->push_back(w->batch);
4103
    }
4104
    w->in_batch_group = true;
4105 4106 4107 4108
    *last_writer = w;
  }
}

4109 4110 4111
// 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 已提交
4112 4113 4114 4115
// if n < bottom, return 0;
// if n >= top, return 1000;
// otherwise, let r = (n - bottom) /
//                    (top - bottom)
4116 4117 4118 4119
//  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 已提交
4120
uint64_t DBImpl::SlowdownAmount(int n, double bottom, double top) {
4121
  uint64_t delay;
J
Jim Paton 已提交
4122
  if (n >= top) {
4123 4124
    delay = 1000;
  }
J
Jim Paton 已提交
4125
  else if (n < bottom) {
4126 4127 4128 4129
    delay = 0;
  }
  else {
    // If we are here, we know that:
J
Jim Paton 已提交
4130
    //   level0_start_slowdown <= n < level0_slowdown
4131
    // since the previous two conditions are false.
M
Mark Callaghan 已提交
4132 4133
    double how_much =
      (double) (n - bottom) /
J
Jim Paton 已提交
4134
              (top - bottom);
M
Mark Callaghan 已提交
4135
    delay = std::max(how_much * how_much * 1000, 100.0);
4136 4137 4138 4139 4140
  }
  assert(delay <= 1000);
  return delay;
}

4141
// REQUIRES: mutex_ is held
4142
// REQUIRES: this thread is currently at the front of the writer queue
S
Stanislau Hlebik 已提交
4143 4144 4145
Status DBImpl::MakeRoomForWrite(ColumnFamilyData* cfd,
                                WriteContext* context,
                                uint64_t expiration_time) {
4146
  mutex_.AssertHeld();
4147
  assert(!writers_.empty());
S
Stanislau Hlebik 已提交
4148 4149 4150
  bool allow_delay = true;
  bool allow_hard_rate_limit_delay = true;
  bool allow_soft_rate_limit_delay = true;
4151
  uint64_t rate_limit_delay_millis = 0;
4152
  Status s;
4153
  double score;
4154 4155 4156 4157
  // 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;
4158
  bool has_timeout = (expiration_time > 0);
4159

4160 4161 4162 4163 4164
  while (true) {
    if (!bg_error_.ok()) {
      // Yield previous error
      s = bg_error_;
      break;
4165 4166 4167
    } else if (has_timeout && env_->NowMicros() > expiration_time) {
      s = Status::TimedOut();
      break;
4168
    } else if (allow_delay && cfd->NeedSlowdownForNumLevel0Files()) {
4169 4170 4171
      // 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
4172
      // individual write by 0-1ms to reduce latency variance.  Also,
4173 4174
      // this delay hands over some CPU to the compaction thread in
      // case it is sharing the same core as the writer.
4175
      uint64_t slowdown =
4176 4177 4178
          SlowdownAmount(cfd->current()->NumLevelFiles(0),
                         cfd->options()->level0_slowdown_writes_trigger,
                         cfd->options()->level0_stop_writes_trigger);
4179
      mutex_.Unlock();
4180
      uint64_t delayed;
J
Jim Paton 已提交
4181
      {
L
Lei Jin 已提交
4182
        StopWatch sw(env_, stats_, STALL_L0_SLOWDOWN_COUNT, &delayed);
4183
        env_->SleepForMicroseconds(slowdown);
J
Jim Paton 已提交
4184
      }
L
Lei Jin 已提交
4185
      RecordTick(stats_, STALL_L0_SLOWDOWN_MICROS, delayed);
4186 4187
      allow_delay = false;  // Do not delay a single write more than once
      mutex_.Lock();
4188 4189
      cfd->internal_stats()->AddCFStats(
          InternalStats::LEVEL0_SLOWDOWN, delayed);
4190
      delayed_writes_++;
S
Stanislau Hlebik 已提交
4191
    } else if (!cfd->mem()->ShouldFlush()) {
4192
      // There is room in current memtable
4193 4194 4195
      if (allow_delay) {
        DelayLoggingAndReset();
      }
4196
      break;
4197
    } else if (cfd->NeedWaitForNumMemtables()) {
4198
      // We have filled up the current memtable, but the previous
4199
      // ones are still being flushed, so we wait.
4200
      DelayLoggingAndReset();
I
Igor Canadi 已提交
4201 4202
      Log(options_.info_log, "[%s] wait for memtable flush...\n",
          cfd->GetName().c_str());
4203 4204 4205 4206
      if (schedule_background_work) {
        MaybeScheduleFlushOrCompaction();
        schedule_background_work = false;
      }
4207
      uint64_t stall;
J
Jim Paton 已提交
4208
      {
L
Lei Jin 已提交
4209
        StopWatch sw(env_, stats_, STALL_MEMTABLE_COMPACTION_COUNT, &stall);
4210 4211 4212 4213 4214
        if (!has_timeout) {
          bg_cv_.Wait();
        } else {
          bg_cv_.TimedWait(expiration_time);
        }
J
Jim Paton 已提交
4215
      }
L
Lei Jin 已提交
4216
      RecordTick(stats_, STALL_MEMTABLE_COMPACTION_MICROS, stall);
4217
      cfd->internal_stats()->AddCFStats(
4218
          InternalStats::MEMTABLE_COMPACTION, stall);
4219
    } else if (cfd->NeedWaitForNumLevel0Files()) {
4220
      DelayLoggingAndReset();
I
Igor Canadi 已提交
4221 4222
      Log(options_.info_log, "[%s] wait for fewer level0 files...\n",
          cfd->GetName().c_str());
4223
      uint64_t stall;
J
Jim Paton 已提交
4224
      {
L
Lei Jin 已提交
4225
        StopWatch sw(env_, stats_, STALL_L0_NUM_FILES_COUNT, &stall);
4226 4227 4228 4229 4230
        if (!has_timeout) {
          bg_cv_.Wait();
        } else {
          bg_cv_.TimedWait(expiration_time);
        }
J
Jim Paton 已提交
4231
      }
L
Lei Jin 已提交
4232
      RecordTick(stats_, STALL_L0_NUM_FILES_MICROS, stall);
4233 4234
      cfd->internal_stats()->AddCFStats(
          InternalStats::LEVEL0_NUM_FILES, stall);
4235
    } else if (allow_hard_rate_limit_delay && cfd->ExceedsHardRateLimit()) {
4236
      // Delay a write when the compaction score for any level is too large.
4237
      const int max_level = cfd->current()->MaxCompactionScoreLevel();
4238
      score = cfd->current()->MaxCompactionScore();
4239
      mutex_.Unlock();
4240
      uint64_t delayed;
J
Jim Paton 已提交
4241
      {
L
Lei Jin 已提交
4242
        StopWatch sw(env_, stats_, HARD_RATE_LIMIT_DELAY_COUNT, &delayed);
J
Jim Paton 已提交
4243 4244
        env_->SleepForMicroseconds(1000);
      }
4245
      // Make sure the following value doesn't round to zero.
4246 4247
      uint64_t rate_limit = std::max((delayed / 1000), (uint64_t) 1);
      rate_limit_delay_millis += rate_limit;
L
Lei Jin 已提交
4248
      RecordTick(stats_, RATE_LIMIT_DELAY_MILLIS, rate_limit);
4249
      if (cfd->options()->rate_limit_delay_max_milliseconds > 0 &&
J
Jim Paton 已提交
4250
          rate_limit_delay_millis >=
4251
              (unsigned)cfd->options()->rate_limit_delay_max_milliseconds) {
J
Jim Paton 已提交
4252
        allow_hard_rate_limit_delay = false;
4253
      }
4254
      mutex_.Lock();
4255
      cfd->internal_stats()->RecordLevelNSlowdown(max_level, delayed, false);
4256
    } else if (allow_soft_rate_limit_delay && cfd->ExceedsSoftRateLimit()) {
4257
      const int max_level = cfd->current()->MaxCompactionScoreLevel();
4258
      score = cfd->current()->MaxCompactionScore();
J
Jim Paton 已提交
4259 4260
      // Delay a write when the compaction score for any level is too large.
      // TODO: add statistics
4261 4262
      uint64_t slowdown = SlowdownAmount(score, cfd->options()->soft_rate_limit,
                                         cfd->options()->hard_rate_limit);
L
Lei Jin 已提交
4263
      uint64_t elapsed = 0;
J
Jim Paton 已提交
4264
      mutex_.Unlock();
J
Jim Paton 已提交
4265
      {
L
Lei Jin 已提交
4266
        StopWatch sw(env_, stats_, SOFT_RATE_LIMIT_DELAY_COUNT, &elapsed);
4267 4268
        env_->SleepForMicroseconds(slowdown);
        rate_limit_delay_millis += slowdown;
J
Jim Paton 已提交
4269
      }
J
Jim Paton 已提交
4270 4271
      allow_soft_rate_limit_delay = false;
      mutex_.Lock();
L
Lei Jin 已提交
4272
      cfd->internal_stats()->RecordLevelNSlowdown(max_level, elapsed, true);
4273
    } else {
S
Stanislau Hlebik 已提交
4274
      s = SetNewMemtableAndNewLogFile(cfd, context);
4275 4276 4277
      if (!s.ok()) {
        break;
      }
S
Stanislau Hlebik 已提交
4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313
      MaybeScheduleFlushOrCompaction();
    }
  }
  return s;
}

// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
Status DBImpl::SetNewMemtableAndNewLogFile(ColumnFamilyData* cfd,
                                           WriteContext* context) {
  mutex_.AssertHeld();
  unique_ptr<WritableFile> lfile;
  log::Writer* new_log = nullptr;
  MemTable* new_mem = nullptr;

  // Attempt to switch to a new memtable and trigger flush of old.
  // Do this without holding the dbmutex lock.
  assert(versions_->PrevLogNumber() == 0);
  bool creating_new_log = !log_empty_;
  uint64_t new_log_number =
      creating_new_log ? versions_->NewFileNumber() : logfile_number_;
  SuperVersion* new_superversion = nullptr;
  mutex_.Unlock();
  Status s;
  {
    DelayLoggingAndReset();
    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));
I
Igor Canadi 已提交
4314
      }
S
Stanislau Hlebik 已提交
4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346
    }

    if (s.ok()) {
      new_mem = new MemTable(cfd->internal_comparator(), *cfd->options());
      new_superversion = new SuperVersion();
    }
  }
  mutex_.Lock();
  if (!s.ok()) {
    // how do we fail if we're not creating new log?
    assert(creating_new_log);
    // Avoid chewing through file number space in a tight loop.
    versions_->ReuseLogFileNumber(new_log_number);
    assert(!new_mem);
    assert(!new_log);
    return s;
  }
  if (creating_new_log) {
    logfile_number_ = new_log_number;
    assert(new_log != nullptr);
    context->logs_to_free_.push_back(log_.release());
    log_.reset(new_log);
    log_empty_ = true;
    alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
    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_);
4347
      }
4348 4349
    }
  }
S
Stanislau Hlebik 已提交
4350 4351 4352 4353 4354 4355 4356 4357 4358
  cfd->mem()->SetNextLogNumber(logfile_number_);
  cfd->imm()->Add(cfd->mem());
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
  Log(options_.info_log,
      "[%s] New memtable created with log file: #%" PRIu64 "\n",
      cfd->GetName().c_str(), logfile_number_);
  context->superversions_to_free_.push_back(
      cfd->InstallSuperVersion(new_superversion, &mutex_));
4359 4360 4361
  return s;
}

I
Igor Canadi 已提交
4362
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4363 4364 4365 4366 4367
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4368 4369
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4370
  auto version = cfd->current();
4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
I
Igor Canadi 已提交
4383
#endif  // ROCKSDB_LITE
4384

I
Igor Canadi 已提交
4385 4386 4387 4388
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4389 4390 4391 4392
Env* DBImpl::GetEnv() const {
  return env_;
}

4393 4394
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4395
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4396 4397
}

4398
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4399
                         const Slice& property, std::string* value) {
4400 4401
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4402 4403 4404
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);

4405
  value->clear();
4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420
  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 已提交
4421 4422
}

4423 4424
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
4425 4426
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438
  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) {
4439 4440
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485

  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);
  }
4486 4487
}

4488
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4489
                                 const Range* range, int n, uint64_t* sizes) {
J
jorlow@chromium.org 已提交
4490 4491
  // TODO(opt): better implementation
  Version* v;
4492 4493
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
J
jorlow@chromium.org 已提交
4494 4495
  {
    MutexLock l(&mutex_);
4496
    v = cfd->current();
4497
    v->Ref();
J
jorlow@chromium.org 已提交
4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514
  }

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

4515 4516 4517 4518 4519 4520 4521
inline void DBImpl::DelayLoggingAndReset() {
  if (delayed_writes_ > 0) {
    Log(options_.info_log, "delayed %d write...\n", delayed_writes_ );
    delayed_writes_ = 0;
  }
}

I
Igor Canadi 已提交
4522 4523 4524 4525 4526
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
4527
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549
  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();
}

4550 4551 4552
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4553 4554 4555 4556
  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());
4557 4558 4559
    return Status::InvalidArgument("Invalid file name");
  }

4560 4561 4562 4563
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4564 4565
      Log(options_.info_log, "DeleteFile %s failed - not archived log.\n",
          name.c_str());
4566 4567 4568 4569
      return Status::NotSupported("Delete only supported for archived logs");
    }
    status = env_->DeleteFile(options_.wal_dir + "/" + name.c_str());
    if (!status.ok()) {
4570 4571
      Log(options_.info_log, "DeleteFile %s failed -- %s.\n",
          name.c_str(), status.ToString().c_str());
4572 4573 4574 4575
    }
    return status;
  }

4576
  int level;
I
Igor Canadi 已提交
4577
  FileMetaData* metadata;
4578
  ColumnFamilyData* cfd;
4579
  VersionEdit edit;
K
Kai Liu 已提交
4580
  DeletionState deletion_state(true);
D
Dhruba Borthakur 已提交
4581 4582
  {
    MutexLock l(&mutex_);
4583
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
4584
    if (!status.ok()) {
4585 4586
      Log(options_.info_log, "DeleteFile %s failed. File not found\n",
                             name.c_str());
D
Dhruba Borthakur 已提交
4587 4588
      return Status::InvalidArgument("File not found");
    }
I
Igor Canadi 已提交
4589
    assert((level > 0) && (level < cfd->NumberLevels()));
4590

D
Dhruba Borthakur 已提交
4591
    // If the file is being compacted no need to delete.
4592
    if (metadata->being_compacted) {
4593
      Log(options_.info_log,
4594
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
D
Dhruba Borthakur 已提交
4595
      return Status::OK();
4596 4597
    }

D
Dhruba Borthakur 已提交
4598 4599 4600
    // 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 已提交
4601
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
4602
      if (cfd->current()->NumLevelFiles(i) != 0) {
D
Dhruba Borthakur 已提交
4603
        Log(options_.info_log,
4604
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
D
Dhruba Borthakur 已提交
4605 4606 4607 4608
        return Status::InvalidArgument("File not in last level");
      }
    }
    edit.DeleteFile(level, number);
4609
    status = versions_->LogAndApply(cfd, &edit, &mutex_, db_directory_.get());
I
Igor Canadi 已提交
4610
    if (status.ok()) {
4611
      InstallSuperVersion(cfd, deletion_state);
I
Igor Canadi 已提交
4612
    }
I
Igor Canadi 已提交
4613
    FindObsoleteFiles(deletion_state, false);
D
Dhruba Borthakur 已提交
4614
  } // lock released here
I
Igor Canadi 已提交
4615
  LogFlush(options_.info_log);
I
Igor Canadi 已提交
4616
  // remove files outside the db-lock
4617 4618 4619
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
4620 4621 4622 4623 4624 4625
  {
    MutexLock l(&mutex_);
    // schedule flush if file deletion means we freed the space for flushes to
    // continue
    MaybeScheduleFlushOrCompaction();
  }
4626 4627 4628
  return status;
}

4629
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4630
  MutexLock l(&mutex_);
4631
  versions_->GetLiveFilesMetaData(metadata);
4632
}
I
Igor Canadi 已提交
4633
#endif  // ROCKSDB_LITE
4634

I
Igor Canadi 已提交
4635 4636 4637 4638 4639 4640 4641
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
4644 4645 4646 4647 4648 4649
    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) {
4650
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662
                             ". 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);
  }
}

4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689
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 已提交
4690 4691
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
4692
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
4693
               const Slice& key, const Slice& value) {
4694 4695 4696 4697
  // 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);
4698
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
4699 4700 4701
  return Write(opt, &batch);
}

4702 4703
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
4704
  WriteBatch batch;
4705
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
4706 4707 4708
  return Write(opt, &batch);
}

4709 4710
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
4711
  WriteBatch batch;
4712
  batch.Merge(column_family, key, value);
4713 4714 4715
  return Write(opt, &batch);
}

4716 4717
// Default implementation -- returns not supported status
Status DB::CreateColumnFamily(const ColumnFamilyOptions& options,
4718
                              const std::string& column_family_name,
4719
                              ColumnFamilyHandle** handle) {
4720
  return Status::NotSupported("");
4721
}
4722
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
4723
  return Status::NotSupported("");
4724 4725
}

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

J
Jim Paton 已提交
4728
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
4729 4730 4731 4732
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
4733
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
4734 4735 4736 4737 4738 4739 4740 4741 4742
  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;
4743 4744
}

4745 4746
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
4747
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
4748
  if (db_options.db_paths.size() > 1) {
4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760
    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. ");
    }
4761 4762
  }

4763
  *dbptr = nullptr;
4764
  handles->clear();
J
jorlow@chromium.org 已提交
4765

I
Igor Canadi 已提交
4766 4767 4768 4769 4770 4771 4772 4773
  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");
    }
4774
  }
4775

I
Igor Canadi 已提交
4776
  DBImpl* impl = new DBImpl(db_options, dbname);
4777
  Status s = impl->env_->CreateDirIfMissing(impl->options_.wal_dir);
4778
  if (s.ok()) {
4779 4780
    for (auto db_path : impl->options_.db_paths) {
      s = impl->env_->CreateDirIfMissing(db_path.path);
4781 4782 4783 4784 4785 4786
      if (!s.ok()) {
        break;
      }
    }
  }

4787 4788 4789 4790 4791 4792
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
4793 4794 4795 4796
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
4797
  impl->mutex_.Lock();
4798 4799
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
4800
  if (s.ok()) {
4801
    uint64_t new_log_number = impl->versions_->NewFileNumber();
4802
    unique_ptr<WritableFile> lfile;
4803
    EnvOptions soptions(db_options);
4804
    s = impl->options_.env->NewWritableFile(
I
Igor Canadi 已提交
4805
        LogFileName(impl->options_.wal_dir, new_log_number), &lfile,
I
Igor Canadi 已提交
4806
        impl->options_.env->OptimizeForLogWrite(soptions));
J
jorlow@chromium.org 已提交
4807
    if (s.ok()) {
4808
      lfile->SetPreallocationBlockSize(1.1 * max_write_buffer_size);
4809
      impl->logfile_number_ = new_log_number;
4810
      impl->log_.reset(new log::Writer(std::move(lfile)));
I
Igor Canadi 已提交
4811

4812 4813
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
4814 4815
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834
        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 已提交
4835
        }
4836
      }
I
Igor Canadi 已提交
4837 4838
    }
    if (s.ok()) {
4839
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
4840
        delete cfd->InstallSuperVersion(new SuperVersion(), &impl->mutex_);
4841
      }
I
Igor Canadi 已提交
4842 4843
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
4844
      impl->DeleteObsoleteFiles();
4845
      impl->MaybeScheduleFlushOrCompaction();
4846
      s = impl->db_directory_->Fsync();
J
jorlow@chromium.org 已提交
4847 4848
    }
  }
4849

I
Igor Canadi 已提交
4850 4851
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
4852 4853
      if (cfd->options()->compaction_style == kCompactionStyleUniversal ||
          cfd->options()->compaction_style == kCompactionStyleFIFO) {
I
Igor Canadi 已提交
4854 4855 4856 4857
        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 已提交
4858 4859 4860
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
                "open with universal or FIFO compaction style.");
I
Igor Canadi 已提交
4861 4862 4863 4864
            break;
          }
        }
      }
4865 4866 4867 4868 4869 4870
      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 已提交
4871
      if (!s.ok()) {
4872 4873 4874 4875 4876
        break;
      }
    }
  }

4877 4878
  impl->mutex_.Unlock();

J
jorlow@chromium.org 已提交
4879
  if (s.ok()) {
4880
    impl->opened_successfully_ = true;
J
jorlow@chromium.org 已提交
4881 4882
    *dbptr = impl;
  } else {
4883 4884 4885
    for (auto h : *handles) {
      delete h;
    }
4886
    handles->clear();
J
jorlow@chromium.org 已提交
4887 4888 4889 4890 4891
    delete impl;
  }
  return s;
}

4892 4893 4894
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
4895
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
4896 4897
}

4898 4899 4900
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
4901
Status DestroyDB(const std::string& dbname, const Options& options) {
4902 4903 4904 4905 4906
  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 已提交
4907
  std::vector<std::string> filenames;
4908 4909
  std::vector<std::string> archiveFiles;

4910
  std::string archivedir = ArchivalDirectory(dbname);
J
jorlow@chromium.org 已提交
4911 4912
  // Ignore error in case directory does not exist
  env->GetChildren(dbname, &filenames);
4913 4914 4915 4916 4917 4918 4919

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

J
jorlow@chromium.org 已提交
4921 4922 4923 4924 4925
  if (filenames.empty()) {
    return Status::OK();
  }

  FileLock* lock;
4926 4927
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
4928 4929 4930
  if (result.ok()) {
    uint64_t number;
    FileType type;
D
dgrogan@chromium.org 已提交
4931
    for (size_t i = 0; i < filenames.size(); i++) {
4932
      if (ParseFileName(filenames[i], &number, &type) &&
4933
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
4934 4935 4936
        Status del;
        if (type == kMetaDatabase) {
          del = DestroyDB(dbname + "/" + filenames[i], options);
4937 4938
        } else if (type == kLogFile) {
          del = env->DeleteFile(soptions.wal_dir + "/" + filenames[i]);
K
Kosie van der Merwe 已提交
4939 4940 4941
        } else {
          del = env->DeleteFile(dbname + "/" + filenames[i]);
        }
J
jorlow@chromium.org 已提交
4942 4943 4944 4945 4946
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4947

4948 4949
    for (auto& db_path : options.db_paths) {
      env->GetChildren(db_path.path, &filenames);
4950 4951 4952 4953 4954
      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
4955
          Status del = env->DeleteFile(db_path.path + "/" + filenames[i]);
4956 4957 4958 4959 4960 4961 4962
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

4963
    env->GetChildren(archivedir, &archiveFiles);
4964 4965
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
4966 4967
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
4968
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
4969 4970 4971 4972 4973
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4974
    // ignore case where no archival directory is present.
4975
    env->DeleteDir(archivedir);
4976

J
jorlow@chromium.org 已提交
4977
    env->UnlockFile(lock);  // Ignore error since state is already gone
4978
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
4979
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
4980
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
4981 4982 4983 4984
  }
  return result;
}

4985 4986
//
// A global method that can dump out the build version
K
kailiu 已提交
4987
void DumpLeveldbBuildVersion(Logger * log) {
I
Igor Canadi 已提交
4988 4989
#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
4990
  Log(log, "Git sha %s", rocksdb_build_git_sha);
4991
  Log(log, "Compile time %s %s",
4992
      rocksdb_build_compile_time, rocksdb_build_compile_date);
I
Igor Canadi 已提交
4993
#endif
4994 4995
}

4996
}  // namespace rocksdb