db_impl.cc 174.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 249
};

Options SanitizeOptions(const std::string& dbname,
                        const InternalKeyComparator* icmp,
                        const Options& src) {
250
  auto db_options = SanitizeOptions(dbname, DBOptions(src));
251
  auto cf_options = SanitizeOptions(icmp, ColumnFamilyOptions(src));
252 253 254 255 256
  return Options(db_options, cf_options);
}

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

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

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

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

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

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

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

293 294 295 296 297 298 299 300 301 302 303 304 305
Status SanitizeDBOptionsByCFOptions(
    DBOptions* db_opts,
    const std::vector<ColumnFamilyDescriptor>& column_families) {
  Status s;
  for (auto cf : column_families) {
    s = cf.options.table_factory->SanitizeDBOptions(db_opts);
    if (!s.ok()) {
      return s;
    }
  }
  return Status::OK();
}

306
namespace {
307 308 309 310 311 312 313
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;

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

  if (can_compress) {
    return options.compression;
  } else {
    return kNoCompression;
  }
}
329
}  // namespace
330

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

J
jorlow@chromium.org 已提交
364
  // Reserve ten files or so for other uses and give the rest to TableCache.
365 366
  // Give a large number for setting of "infinite" open files.
  const int table_cache_size =
367 368 369 370 371 372
      (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 已提交
373 374
  versions_.reset(
      new VersionSet(dbname_, &options_, storage_options_, table_cache_.get()));
375 376
  column_family_memtables_.reset(
      new ColumnFamilyMemTablesImpl(versions_->GetColumnFamilySet()));
377

K
kailiu 已提交
378
  DumpLeveldbBuildVersion(options_.info_log.get());
F
Feng Zhu 已提交
379
  DumpDBFileSummary(options_, dbname_);
380
  options_.Dump(options_.info_log.get());
381

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

DBImpl::~DBImpl() {
386 387 388 389 390 391 392 393
  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();
394
        cfd->Unref();
395 396
      }
    }
397
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
398
  }
I
Igor Canadi 已提交
399 400

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

I
Igor Canadi 已提交
406 407 408 409 410
  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();
411 412
  }

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
  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;
428 429 430
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
431 432 433
    }
  }

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

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

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

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

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

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

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

501
void DBImpl::MaybeDumpStats() {
H
Haobo Xu 已提交
502 503 504 505 506 507 508 509 510 511 512 513
  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;
514

515 516 517 518 519 520
    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 已提交
521
    std::string stats;
522 523 524
    {
      MutexLock l(&mutex_);
      for (auto cfd : *versions_->GetColumnFamilySet()) {
525 526
        cfd->internal_stats()->GetStringProperty(cf_property_type,
                                                 "rocksdb.cfstats", &stats);
527
      }
528 529
      default_cf_internal_stats_->GetStringProperty(db_property_type,
                                                    "rocksdb.dbstats", &stats);
530 531
    }
    Log(options_.info_log, "------- DUMPING STATS -------");
H
Haobo Xu 已提交
532
    Log(options_.info_log, "%s", stats.c_str());
533

534
    PrintStatistics();
535 536 537
  }
}

538
// Returns the list of live files in 'sst_live' and the list
K
kailiu 已提交
539
// of all files in the filesystem in 'candidate_files'.
I
Igor Canadi 已提交
540 541 542 543 544 545 546
// 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 已提交
547 548
  mutex_.AssertHeld();

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

554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
  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 已提交
570 571 572
  // get obsolete files
  versions_->GetObsoleteFiles(&deletion_state.sst_delete_files);

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

580 581 582 583 584 585 586 587
  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
588 589 590 591 592
  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 已提交
593 594
  versions_->AddLiveFiles(&deletion_state.sst_live);

595
  if (doing_the_full_scan) {
596 597 598 599
    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;
600 601
      env_->GetChildren(options_.db_paths[path_id].path,
                        &files);  // Ignore errors
602 603 604 605
      for (std::string file : files) {
        deletion_state.candidate_files.emplace_back(file, path_id);
      }
    }
606 607 608 609 610

    //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
611
      for (std::string log_file : log_files) {
612 613 614
        deletion_state.candidate_files.emplace_back(log_file, 0);
      }
    }
615 616 617 618 619 620 621 622
    // Add info log files in db_log_dir
    if (!options_.db_log_dir.empty() && options_.db_log_dir != dbname_) {
      std::vector<std::string> info_log_files;
      env_->GetChildren(options_.db_log_dir, &info_log_files);  // Ignore errors
      for (std::string log_file : info_log_files) {
        deletion_state.candidate_files.emplace_back(log_file, 0);
      }
    }
623
  }
624 625
}

626 627 628 629 630 631 632 633 634 635 636 637 638
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 已提交
639
// Diffs the files listed in filenames and those that do not
I
Igor Canadi 已提交
640
// belong to live files are posibly removed. Also, removes all the
641
// files in sst_delete_files and log_delete_files.
642
// It is not necessary to hold the mutex when invoking this method.
D
Dhruba Borthakur 已提交
643
void DBImpl::PurgeObsoleteFiles(DeletionState& state) {
644 645
  // we'd better have sth to delete
  assert(state.HaveSomethingToDelete());
646

I
Igor Canadi 已提交
647 648 649 650
  // 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 已提交
651 652
    return;
  }
653

654
  // Now, convert live list to an unordered map, WITHOUT mutex held;
655
  // set is slow.
656 657 658 659
  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 已提交
660

K
kailiu 已提交
661 662 663 664 665 666 667
  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 = "";
668
  for (auto file : state.sst_delete_files) {
669 670 671
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
672
    delete file;
I
Igor Canadi 已提交
673 674
  }

K
kailiu 已提交
675 676
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
677 678
      candidate_files.emplace_back(LogFileName(kDumbDbName, file_num).substr(1),
                                   0);
I
Igor Canadi 已提交
679 680
    }
  }
681

K
kailiu 已提交
682
  // dedup state.candidate_files so we don't try to delete the same
I
Igor Canadi 已提交
683
  // file twice
684
  sort(candidate_files.begin(), candidate_files.end(), CompareCandidateFile);
685 686
  candidate_files.erase(unique(candidate_files.begin(), candidate_files.end()),
                        candidate_files.end());
J
jorlow@chromium.org 已提交
687

688
  std::vector<std::string> old_info_log_files;
689
  InfoLogPrefix info_log_prefix(!options_.db_log_dir.empty(), dbname_);
690 691 692
  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 已提交
693 694 695
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
696
    if (!ParseFileName(to_delete, &number, info_log_prefix.prefix, &type)) {
K
kailiu 已提交
697 698
      continue;
    }
J
jorlow@chromium.org 已提交
699

K
kailiu 已提交
700 701 702 703 704 705 706 707
    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'
708
        // (can happen during manifest roll)
K
kailiu 已提交
709 710 711
        keep = (number >= state.manifest_file_number);
        break;
      case kTableFile:
712
        keep = (sst_live_map.find(number) != sst_live_map.end());
K
kailiu 已提交
713 714 715
        break;
      case kTempFile:
        // Any temp files that are currently being written to must
716 717 718 719
        // 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
720
        keep = (sst_live_map.find(number) != sst_live_map.end()) ||
721
               (number == state.pending_manifest_file_number);
K
kailiu 已提交
722 723 724 725
        break;
      case kInfoLogFile:
        keep = true;
        if (number != 0) {
726
          old_info_log_files.push_back(to_delete);
J
jorlow@chromium.org 已提交
727
        }
K
kailiu 已提交
728 729 730 731 732 733 734 735 736 737 738 739 740
        break;
      case kCurrentFile:
      case kDBLockFile:
      case kIdentityFile:
      case kMetaDatabase:
        keep = true;
        break;
    }

    if (keep) {
      continue;
    }

741
    std::string fname;
K
kailiu 已提交
742 743
    if (type == kTableFile) {
      // evict from cache
744
      TableCache::Evict(table_cache_.get(), number);
745 746 747 748
      fname = TableFileName(options_.db_paths, number, path_id);
    } else {
      fname =
          ((type == kLogFile) ? options_.wal_dir : dbname_) + "/" + to_delete;
K
kailiu 已提交
749
    }
750

K
kailiu 已提交
751 752
    if (type == kLogFile &&
        (options_.WAL_ttl_seconds > 0 || options_.WAL_size_limit_MB > 0)) {
753
      auto archived_log_name = ArchivedLogFileName(options_.wal_dir, number);
754 755
      // The sync point below is used in (DBTest,TransactionLogIteratorRace)
      TEST_SYNC_POINT("DBImpl::PurgeObsoleteFiles:1");
756
      Status s = env_->RenameFile(fname, archived_log_name);
757 758
      // The sync point below is used in (DBTest,TransactionLogIteratorRace)
      TEST_SYNC_POINT("DBImpl::PurgeObsoleteFiles:2");
759 760 761
      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 已提交
762 763
    } else {
      Status s = env_->DeleteFile(fname);
764 765
      Log(options_.info_log, "Delete %s type=%d #%" PRIu64 " -- %s\n",
          fname.c_str(), type, number, s.ToString().c_str());
J
jorlow@chromium.org 已提交
766 767
    }
  }
H
heyongqiang 已提交
768

769
  // Delete old info log files.
770
  size_t old_info_log_file_count = old_info_log_files.size();
771
  if (old_info_log_file_count >= options_.keep_log_file_num) {
772 773
    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;
774
    for (unsigned int i = 0; i <= end; i++) {
775
      std::string& to_delete = old_info_log_files.at(i);
776 777 778 779 780 781
      std::string full_path_to_delete =
          (options_.db_log_dir.empty() ? dbname_ : options_.db_log_dir) + "/" +
          to_delete;
      Log(options_.info_log, "Delete info log file %s\n",
          full_path_to_delete.c_str());
      Status s = env_->DeleteFile(full_path_to_delete);
782 783 784 785
      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 已提交
786 787
    }
  }
788
  PurgeObsoleteWALFiles();
I
Igor Canadi 已提交
789
  LogFlush(options_.info_log);
D
Dhruba Borthakur 已提交
790 791 792 793 794
}

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
  DeletionState deletion_state;
I
Igor Canadi 已提交
795
  FindObsoleteFiles(deletion_state, true);
796 797 798
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
799 800
}

I
Igor Canadi 已提交
801
#ifndef ROCKSDB_LITE
802 803 804 805 806 807 808 809
// 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
810
void DBImpl::PurgeObsoleteWALFiles() {
811 812 813 814 815 816
  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;
  }

817 818
  int64_t current_time;
  Status s = env_->GetCurrentTime(&current_time);
819 820 821 822 823 824 825 826
  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_;
827

828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
  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 已提交
866 867 868
          } else {
            MutexLock l(&read_first_record_cache_mutex_);
            read_first_record_cache_.erase(number);
869 870
          }
          continue;
871
        }
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
      }

      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 已提交
891 892 893
            } else {
              MutexLock l(&read_first_record_cache_mutex_);
              read_first_record_cache_.erase(number);
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
            }
          }
        }
      }
    }
  }

  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;
913
  GetSortedWalsOfType(archival_dir, archived_logs, kArchivedLogFile);
914 915 916 917 918 919 920 921 922 923 924 925 926 927

  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 已提交
928 929 930
    } else {
      MutexLock l(&read_first_record_cache_mutex_);
      read_first_record_cache_.erase(archived_logs[i]->LogNumber());
931 932
    }
  }
D
Dhruba Borthakur 已提交
933 934
}

935 936 937 938 939 940 941 942 943 944
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 已提交
945 946 947 948 949 950 951 952 953 954 955 956 957
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 已提交
958 959
      SequenceNumber sequence;
      Status s = ReadFirstRecord(log_type, number, &sequence);
I
Igor Canadi 已提交
960 961 962
      if (!s.ok()) {
        return s;
      }
I
Igor Canadi 已提交
963 964 965 966
      if (sequence == 0) {
        // empty file
        continue;
      }
I
Igor Canadi 已提交
967

968 969 970 971 972 973
      // 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 已提交
974 975
      uint64_t size_bytes;
      s = env_->GetFileSize(LogFileName(path, number), &size_bytes);
976 977 978 979 980
      // 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 已提交
981 982 983 984 985
      if (!s.ok()) {
        return s;
      }

      log_files.push_back(std::move(unique_ptr<LogFile>(
I
Igor Canadi 已提交
986
          new LogFileImpl(number, log_type, sequence, size_bytes))));
I
Igor Canadi 已提交
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
    }
  }
  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 已提交
1011 1012
  // end could be -ve.
  size_t start_index = std::max(static_cast<int64_t>(0), end);
I
Igor Canadi 已提交
1013 1014 1015 1016 1017 1018
  // 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 已提交
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
                               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 已提交
1032 1033
  if (type == kAliveLogFile) {
    std::string fname = LogFileName(options_.wal_dir, number);
I
Igor Canadi 已提交
1034 1035 1036 1037
    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 已提交
1038
    }
I
Igor Canadi 已提交
1039
  }
I
Igor Canadi 已提交
1040

I
Igor Canadi 已提交
1041
  if (type == kArchivedLogFile || !s.ok()) {
I
Igor Canadi 已提交
1042 1043
    //  check if the file got moved to archive.
    std::string archived_file = ArchivedLogFileName(options_.wal_dir, number);
I
Igor Canadi 已提交
1044
    s = ReadFirstLine(archived_file, sequence);
I
Igor Canadi 已提交
1045
  }
I
Igor Canadi 已提交
1046 1047 1048 1049 1050 1051

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

I
Igor Canadi 已提交
1054 1055
// the function returns status.ok() and sequence == 0 if the file exists, but is
// empty
I
Igor Canadi 已提交
1056
Status DBImpl::ReadFirstLine(const std::string& fname,
I
Igor Canadi 已提交
1057
                             SequenceNumber* sequence) {
I
Igor Canadi 已提交
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
  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 已提交
1101 1102 1103
      WriteBatch batch;
      WriteBatchInternal::SetContents(&batch, record);
      *sequence = WriteBatchInternal::Sequence(&batch);
I
Igor Canadi 已提交
1104 1105 1106 1107
      return Status::OK();
    }
  }

I
Igor Canadi 已提交
1108 1109 1110
  // 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 已提交
1111 1112 1113 1114 1115
  return status;
}

#endif  // ROCKSDB_LITE

1116
Status DBImpl::Recover(
1117 1118
    const std::vector<ColumnFamilyDescriptor>& column_families, bool read_only,
    bool error_if_log_file_exist) {
J
jorlow@chromium.org 已提交
1119 1120
  mutex_.AssertHeld();

1121
  bool is_new_db = false;
1122
  assert(db_lock_ == nullptr);
I
Igor Canadi 已提交
1123
  if (!read_only) {
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
    // 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;
    }

1136 1137
    for (auto& db_path : options_.db_paths) {
      s = env_->CreateDirIfMissing(db_path.path);
1138 1139 1140 1141 1142
      if (!s.ok()) {
        return s;
      }
    }

1143 1144 1145 1146 1147
    s = env_->NewDirectory(dbname_, &db_directory_);
    if (!s.ok()) {
      return s;
    }

1148
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
1149 1150 1151
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
1152

1153 1154 1155
    if (!env_->FileExists(CurrentFileName(dbname_))) {
      if (options_.create_if_missing) {
        s = NewDB();
1156
        is_new_db = true;
1157 1158 1159 1160 1161 1162
        if (!s.ok()) {
          return s;
        }
      } else {
        return Status::InvalidArgument(
            dbname_, "does not exist (create_if_missing is false)");
J
jorlow@chromium.org 已提交
1163 1164
      }
    } else {
1165 1166 1167 1168
      if (options_.error_if_exists) {
        return Status::InvalidArgument(
            dbname_, "exists (error_if_exists is true)");
      }
J
jorlow@chromium.org 已提交
1169
    }
M
Mayank Agarwal 已提交
1170 1171 1172 1173 1174 1175 1176
    // 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 已提交
1177 1178
  }

1179
  Status s = versions_->Recover(column_families, read_only);
I
Igor Canadi 已提交
1180 1181 1182
  if (options_.paranoid_checks && s.ok()) {
    s = CheckConsistency();
  }
J
jorlow@chromium.org 已提交
1183 1184
  if (s.ok()) {
    SequenceNumber max_sequence(0);
1185 1186
    default_cf_handle_ = new ColumnFamilyHandleImpl(
        versions_->GetColumnFamilySet()->GetDefault(), this, &mutex_);
1187
    default_cf_internal_stats_ = default_cf_handle_->cfd()->internal_stats();
1188 1189
    single_column_family_mode_ =
        versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1;
1190 1191 1192 1193 1194 1195 1196

    // 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
1197
    // produced by an older version of rocksdb.
1198
    const uint64_t min_log = versions_->MinLogNumber();
1199 1200
    const uint64_t prev_log = versions_->PrevLogNumber();
    std::vector<std::string> filenames;
1201
    s = env_->GetChildren(options_.wal_dir, &filenames);
1202 1203
    if (!s.ok()) {
      return s;
1204
    }
K
kailiu 已提交
1205

1206 1207
    std::vector<uint64_t> logs;
    for (size_t i = 0; i < filenames.size(); i++) {
K
kailiu 已提交
1208 1209
      uint64_t number;
      FileType type;
1210 1211 1212 1213 1214 1215 1216 1217 1218
      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);
        }
1219
      }
J
jorlow@chromium.org 已提交
1220
    }
1221

H
heyongqiang 已提交
1222 1223 1224 1225 1226 1227
    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");
    }

1228 1229
    // Recover in the order in which the logs were generated
    std::sort(logs.begin(), logs.end());
K
kailiu 已提交
1230
    for (const auto& log : logs) {
1231 1232 1233
      // 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 已提交
1234
      versions_->MarkFileNumberUsed(log);
K
Kai Liu 已提交
1235
      s = RecoverLogFile(log, &max_sequence, read_only);
1236
    }
L
Lei Jin 已提交
1237
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1238 1239
  }

I
Igor Canadi 已提交
1240 1241 1242 1243 1244
  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 已提交
1245 1246 1247
  return s;
}

I
Igor Canadi 已提交
1248 1249
Status DBImpl::RecoverLogFile(uint64_t log_number, SequenceNumber* max_sequence,
                              bool read_only) {
J
jorlow@chromium.org 已提交
1250 1251
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1252
    Logger* info_log;
J
jorlow@chromium.org 已提交
1253
    const char* fname;
1254 1255
    Status* status;  // nullptr if options_.paranoid_checks==false or
                     //            options_.skip_log_error_on_recovery==true
J
jorlow@chromium.org 已提交
1256
    virtual void Corruption(size_t bytes, const Status& s) {
1257
      Log(info_log, "%s%s: dropping %d bytes; %s",
1258
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1259
          fname, static_cast<int>(bytes), s.ToString().c_str());
1260
      if (this->status != nullptr && this->status->ok()) *this->status = s;
J
jorlow@chromium.org 已提交
1261 1262 1263 1264 1265
    }
  };

  mutex_.AssertHeld();

1266
  std::unordered_map<int, VersionEdit> version_edits;
1267
  // no need to refcount because iteration is under mutex
1268 1269
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    VersionEdit edit;
1270 1271
    edit.SetColumnFamily(cfd->GetID());
    version_edits.insert({cfd->GetID(), edit});
1272
  }
I
Igor Canadi 已提交
1273

J
jorlow@chromium.org 已提交
1274
  // Open the log file
1275
  std::string fname = LogFileName(options_.wal_dir, log_number);
1276
  unique_ptr<SequentialFile> file;
1277
  Status status = env_->NewSequentialFile(fname, &file, storage_options_);
J
jorlow@chromium.org 已提交
1278 1279 1280 1281 1282 1283 1284 1285
  if (!status.ok()) {
    MaybeIgnoreError(&status);
    return status;
  }

  // Create the log reader.
  LogReporter reporter;
  reporter.env = env_;
1286
  reporter.info_log = options_.info_log.get();
J
jorlow@chromium.org 已提交
1287
  reporter.fname = fname.c_str();
1288 1289
  reporter.status = (options_.paranoid_checks &&
                     !options_.skip_log_error_on_recovery ? &status : nullptr);
J
jorlow@chromium.org 已提交
1290 1291 1292 1293
  // 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).
1294
  log::Reader reader(std::move(file), &reporter, true/*checksum*/,
1295
                     0/*initial_offset*/);
1296
  Log(options_.info_log, "Recovering log #%" PRIu64 "", log_number);
J
jorlow@chromium.org 已提交
1297 1298 1299 1300 1301

  // Read all the records and add to a memtable
  std::string scratch;
  Slice record;
  WriteBatch batch;
I
Igor Canadi 已提交
1302
  while (reader.ReadRecord(&record, &scratch)) {
J
jorlow@chromium.org 已提交
1303 1304 1305 1306 1307 1308 1309
    if (record.size() < 12) {
      reporter.Corruption(
          record.size(), Status::Corruption("log record too small"));
      continue;
    }
    WriteBatchInternal::SetContents(&batch, record);

1310
    status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
1311
        &batch, column_family_memtables_.get(), true, log_number);
1312

J
jorlow@chromium.org 已提交
1313 1314
    MaybeIgnoreError(&status);
    if (!status.ok()) {
I
Igor Canadi 已提交
1315
      return status;
J
jorlow@chromium.org 已提交
1316 1317 1318 1319 1320 1321 1322 1323
    }
    const SequenceNumber last_seq =
        WriteBatchInternal::Sequence(&batch) +
        WriteBatchInternal::Count(&batch) - 1;
    if (last_seq > *max_sequence) {
      *max_sequence = last_seq;
    }

1324
    if (!read_only) {
1325 1326
      // no need to refcount since client still doesn't have access
      // to the DB and can not drop column families while we iterate
1327
      for (auto cfd : *versions_->GetColumnFamilySet()) {
1328
        if (cfd->mem()->ShouldFlush()) {
1329
          // If this asserts, it means that InsertInto failed in
1330 1331
          // filtering updates to already-flushed column families
          assert(cfd->GetLogNumber() <= log_number);
1332
          auto iter = version_edits.find(cfd->GetID());
1333 1334
          assert(iter != version_edits.end());
          VersionEdit* edit = &iter->second;
1335
          status = WriteLevel0TableForRecovery(cfd, cfd->mem(), edit);
1336 1337 1338 1339 1340 1341 1342 1343
          // 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 已提交
1344 1345 1346 1347
      }
    }
  }

1348 1349 1350 1351
  if (versions_->LastSequence() < *max_sequence) {
    versions_->SetLastSequence(*max_sequence);
  }

1352
  if (!read_only) {
1353 1354
    // no need to refcount since client still doesn't have access
    // to the DB and can not drop column families while we iterate
1355
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1356
      auto iter = version_edits.find(cfd->GetID());
1357 1358 1359
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

1360 1361 1362 1363
      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
1364
        // (in WriteBatch::InsertInto)
1365 1366 1367 1368 1369 1370 1371
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1372
        status = WriteLevel0TableForRecovery(cfd, cfd->mem(), edit);
1373
      }
1374 1375 1376 1377 1378
      // we still want to clear the memtable, even if the recovery failed
      cfd->CreateNewMemtable();
      if (!status.ok()) {
        return status;
      }
J
jorlow@chromium.org 已提交
1379

1380 1381 1382 1383 1384 1385 1386
      // 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);
1387 1388 1389
      // 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 已提交
1390
      // log number
1391
      versions_->MarkFileNumberUsed(log_number + 1);
1392 1393 1394 1395 1396
      status = versions_->LogAndApply(cfd, edit, &mutex_);
      if (!status.ok()) {
        return status;
      }
    }
1397
  }
I
Igor Canadi 已提交
1398

J
jorlow@chromium.org 已提交
1399 1400 1401
  return status;
}

1402 1403
Status DBImpl::WriteLevel0TableForRecovery(ColumnFamilyData* cfd, MemTable* mem,
                                           VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1404
  mutex_.AssertHeld();
1405
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1406
  FileMetaData meta;
1407 1408
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
  pending_outputs_[meta.fd.GetNumber()] = 0;  // path 0 for level 0 file.
1409 1410 1411
  ReadOptions ro;
  ro.total_order_seek = true;
  Iterator* iter = mem->NewIterator(ro);
1412 1413 1414
  const SequenceNumber newest_snapshot = snapshots_.GetNewest();
  const SequenceNumber earliest_seqno_in_memtable =
    mem->GetFirstSequenceNumber();
1415 1416
  Log(options_.info_log, "[%s] Level-0 table #%" PRIu64 ": started",
      cfd->GetName().c_str(), meta.fd.GetNumber());
1417 1418 1419 1420

  Status s;
  {
    mutex_.Unlock();
I
Igor Canadi 已提交
1421
    s = BuildTable(dbname_, env_, *cfd->options(), storage_options_,
1422
                   cfd->table_cache(), iter, &meta, cfd->internal_comparator(),
1423
                   newest_snapshot, earliest_seqno_in_memtable,
L
Lei Jin 已提交
1424
                   GetCompressionFlush(*cfd->options()), Env::IO_HIGH);
I
Igor Canadi 已提交
1425
    LogFlush(options_.info_log);
1426 1427 1428
    mutex_.Lock();
  }

1429 1430 1431 1432
  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 已提交
1433
  delete iter;
1434

1435
  pending_outputs_.erase(meta.fd.GetNumber());
1436 1437 1438 1439

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1440
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1441 1442 1443
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1444 1445
  }

L
Lei Jin 已提交
1446
  InternalStats::CompactionStats stats(1);
1447
  stats.micros = env_->NowMicros() - start_micros;
1448
  stats.bytes_written = meta.fd.GetFileSize();
M
Mark Callaghan 已提交
1449
  stats.files_out_levelnp1 = 1;
1450
  cfd->internal_stats()->AddCompactionStats(level, stats);
1451 1452
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1453
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1454 1455 1456
  return s;
}

1457
Status DBImpl::WriteLevel0Table(ColumnFamilyData* cfd,
1458
                                autovector<MemTable*>& mems, VersionEdit* edit,
1459
                                uint64_t* filenumber, LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
1460
  mutex_.AssertHeld();
1461 1462
  const uint64_t start_micros = env_->NowMicros();
  FileMetaData meta;
1463 1464

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

1468 1469
  const SequenceNumber newest_snapshot = snapshots_.GetNewest();
  const SequenceNumber earliest_seqno_in_memtable =
1470
    mems[0]->GetFirstSequenceNumber();
1471
  Version* base = cfd->current();
1472
  base->Ref();          // it is likely that we do not need this reference
1473 1474 1475
  Status s;
  {
    mutex_.Unlock();
H
Haobo Xu 已提交
1476
    log_buffer->FlushBufferToLog();
K
Kai Liu 已提交
1477
    std::vector<Iterator*> memtables;
1478 1479
    ReadOptions ro;
    ro.total_order_seek = true;
1480
    for (MemTable* m : mems) {
1481 1482 1483
      Log(options_.info_log,
          "[%s] Flushing memtable with next log file: %" PRIu64 "\n",
          cfd->GetName().c_str(), m->GetNextLogNumber());
1484
      memtables.push_back(m->NewIterator(ro));
1485
    }
I
Igor Canadi 已提交
1486
    Iterator* iter = NewMergingIterator(&cfd->internal_comparator(),
1487
                                        &memtables[0], memtables.size());
1488 1489
    Log(options_.info_log, "[%s] Level-0 flush table #%" PRIu64 ": started",
        cfd->GetName().c_str(), meta.fd.GetNumber());
1490

I
Igor Canadi 已提交
1491
    s = BuildTable(dbname_, env_, *cfd->options(), storage_options_,
1492
                   cfd->table_cache(), iter, &meta, cfd->internal_comparator(),
1493
                   newest_snapshot, earliest_seqno_in_memtable,
L
Lei Jin 已提交
1494
                   GetCompressionFlush(*cfd->options()), Env::IO_HIGH);
I
Igor Canadi 已提交
1495
    LogFlush(options_.info_log);
1496
    delete iter;
1497 1498
    Log(options_.info_log,
        "[%s] Level-0 flush table #%" PRIu64 ": %" PRIu64 " bytes %s",
F
Feng Zhu 已提交
1499
        cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
1500
        s.ToString().c_str());
I
Igor Canadi 已提交
1501

1502 1503 1504
    if (!options_.disableDataSync) {
      db_directory_->Fsync();
    }
1505 1506
    mutex_.Lock();
  }
1507 1508
  base->Unref();

1509
  // re-acquire the most current version
1510
  base = cfd->current();
1511 1512 1513 1514 1515 1516

  // 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 已提交
1517
  // committed so that other threads can recognize this file as a
1518 1519 1520 1521 1522 1523
  // 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;
1524
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1525 1526 1527 1528 1529 1530
    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.
1531
    if (base != nullptr && options_.max_background_compactions <= 1 &&
1532
        cfd->options()->compaction_style == kCompactionStyleLevel) {
1533 1534
      level = base->PickLevelForMemTableOutput(min_user_key, max_user_key);
    }
1535 1536 1537
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1538 1539
  }

L
Lei Jin 已提交
1540
  InternalStats::CompactionStats stats(1);
1541
  stats.micros = env_->NowMicros() - start_micros;
1542
  stats.bytes_written = meta.fd.GetFileSize();
1543
  cfd->internal_stats()->AddCompactionStats(level, stats);
1544 1545
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1546
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
1547 1548 1549
  return s;
}

1550 1551
Status DBImpl::FlushMemTableToOutputFile(ColumnFamilyData* cfd,
                                         bool* madeProgress,
H
Haobo Xu 已提交
1552 1553
                                         DeletionState& deletion_state,
                                         LogBuffer* log_buffer) {
1554
  mutex_.AssertHeld();
1555
  assert(cfd->imm()->size() != 0);
1556
  assert(cfd->imm()->IsFlushPending());
1557 1558 1559

  // Save the contents of the earliest memtable as a new Table
  uint64_t file_number;
K
Kai Liu 已提交
1560
  autovector<MemTable*> mems;
1561
  cfd->imm()->PickMemtablesToFlush(&mems);
1562
  if (mems.empty()) {
I
Igor Canadi 已提交
1563 1564
    LogToBuffer(log_buffer, "[%s] Nothing in memtable to flush",
                cfd->GetName().c_str());
L
Lei Jin 已提交
1565
    return Status::OK();
1566 1567 1568
  }

  // record the logfile_number_ before we release the mutex
1569 1570 1571
  // 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.
1572
  MemTable* m = mems[0];
1573 1574
  VersionEdit* edit = m->GetEdits();
  edit->SetPrevLogNumber(0);
1575 1576
  // SetLogNumber(log_num) indicates logs with number smaller than log_num
  // will no longer be picked up for recovery.
1577 1578
  edit->SetLogNumber(mems.back()->GetNextLogNumber());
  edit->SetColumnFamily(cfd->GetID());
1579

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

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

L
Lei Jin 已提交
1588
  if (!s.ok()) {
1589
    cfd->imm()->RollbackMemtableFlush(mems, file_number, &pending_outputs_);
1590 1591
  } else {
    // Replace immutable memtable with the generated Table
1592 1593
    s = cfd->imm()->InstallMemtableFlushResults(
        cfd, mems, versions_.get(), &mutex_, options_.info_log.get(),
1594
        file_number, &pending_outputs_, &deletion_state.memtables_to_free,
1595
        db_directory_.get(), log_buffer);
1596
  }
J
jorlow@chromium.org 已提交
1597 1598

  if (s.ok()) {
1599
    InstallSuperVersion(cfd, deletion_state);
1600 1601 1602
    if (madeProgress) {
      *madeProgress = 1;
    }
I
Igor Canadi 已提交
1603 1604 1605
    Version::LevelSummaryStorage tmp;
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
                cfd->current()->LevelSummary(&tmp));
1606

1607
    if (disable_delete_obsolete_files_ == 0) {
I
Igor Canadi 已提交
1608
      // add to deletion state
1609
      while (alive_log_files_.size() &&
I
Igor Canadi 已提交
1610 1611 1612 1613
             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;
1614 1615
        alive_log_files_.pop_front();
      }
1616
    }
J
jorlow@chromium.org 已提交
1617
  }
1618 1619 1620 1621 1622 1623 1624

  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;
  }
1625
  RecordFlushIOStats();
J
jorlow@chromium.org 已提交
1626 1627 1628
  return s;
}

1629
Status DBImpl::CompactRange(ColumnFamilyHandle* column_family,
1630
                            const Slice* begin, const Slice* end,
1631 1632 1633 1634 1635 1636
                            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");
  }

1637 1638
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
I
Igor Canadi 已提交
1639 1640

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
1641 1642 1643 1644 1645
  if (!s.ok()) {
    LogFlush(options_.info_log);
    return s;
  }

I
Igor Canadi 已提交
1646
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
1647 1648
  {
    MutexLock l(&mutex_);
I
Igor Canadi 已提交
1649 1650
    Version* base = cfd->current();
    for (int level = 1; level < cfd->NumberLevels(); level++) {
G
Gabor Cselle 已提交
1651 1652 1653 1654 1655
      if (base->OverlapInLevel(level, begin, end)) {
        max_level_with_files = level;
      }
    }
  }
1656 1657
  for (int level = 0; level <= max_level_with_files; level++) {
    // in case the compaction is unversal or if we're compacting the
1658 1659 1660
    // 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 已提交
1661
    if (cfd->options()->compaction_style == kCompactionStyleUniversal ||
I
Igor Canadi 已提交
1662
        cfd->options()->compaction_style == kCompactionStyleFIFO ||
1663
        (level == max_level_with_files && level > 0)) {
1664
      s = RunManualCompaction(cfd, level, level, target_path_id, begin, end);
1665
    } else {
1666 1667
      s = RunManualCompaction(cfd, level, level + 1, target_path_id, begin,
                              end);
L
Lei Jin 已提交
1668 1669 1670 1671
    }
    if (!s.ok()) {
      LogFlush(options_.info_log);
      return s;
1672
    }
G
Gabor Cselle 已提交
1673
  }
1674 1675

  if (reduce_level) {
I
Igor Canadi 已提交
1676
    s = ReFitLevel(cfd, max_level_with_files, target_level);
1677
  }
I
Igor Canadi 已提交
1678
  LogFlush(options_.info_log);
L
Lei Jin 已提交
1679

1680 1681 1682 1683 1684 1685 1686
  {
    MutexLock l(&mutex_);
    // an automatic compaction that has been scheduled might have been
    // preempted by the manual compactions. Need to schedule it back.
    MaybeScheduleFlushOrCompaction();
  }

L
Lei Jin 已提交
1687
  return s;
1688 1689 1690
}

// return the same level if it cannot be moved
I
Igor Canadi 已提交
1691
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd, int level) {
1692
  mutex_.AssertHeld();
I
Igor Canadi 已提交
1693
  Version* current = cfd->current();
1694
  int minimum_level = level;
1695
  for (int i = level - 1; i > 0; --i) {
1696
    // stop if level i is not empty
1697
    if (current->NumLevelFiles(i) > 0) break;
1698
    // stop if level i is too small (cannot fit the level files)
I
Igor Canadi 已提交
1699
    if (cfd->compaction_picker()->MaxBytesForLevel(i) <
1700 1701 1702
        current->NumLevelBytes(level)) {
      break;
    }
1703 1704 1705 1706 1707 1708

    minimum_level = i;
  }
  return minimum_level;
}

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

I
Igor Canadi 已提交
1712
  SuperVersion* superversion_to_free = nullptr;
1713
  SuperVersion* new_superversion = new SuperVersion();
I
Igor Canadi 已提交
1714 1715

  mutex_.Lock();
1716 1717 1718

  // only allow one thread refitting
  if (refitting_level_) {
I
Igor Canadi 已提交
1719
    mutex_.Unlock();
1720
    Log(options_.info_log, "ReFitLevel: another thread is refitting");
I
Igor Canadi 已提交
1721
    delete new_superversion;
L
Lei Jin 已提交
1722
    return Status::NotSupported("another thread is refitting");
1723 1724 1725 1726 1727
  }
  refitting_level_ = true;

  // wait for all background threads to stop
  bg_work_gate_closed_ = true;
1728
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_) {
1729
    Log(options_.info_log,
1730 1731
        "RefitLevel: waiting for background threads to stop: %d %d",
        bg_compaction_scheduled_, bg_flush_scheduled_);
1732 1733 1734 1735
    bg_cv_.Wait();
  }

  // move to a smaller level
1736 1737
  int to_level = target_level;
  if (target_level < 0) {
I
Igor Canadi 已提交
1738
    to_level = FindMinimumEmptyLevelFitting(cfd, level);
1739
  }
1740 1741 1742

  assert(to_level <= level);

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

1748
    VersionEdit edit;
I
Igor Canadi 已提交
1749 1750
    edit.SetColumnFamily(cfd->GetID());
    for (const auto& f : cfd->current()->files_[level]) {
1751
      edit.DeleteFile(level, f->fd.GetNumber());
1752 1753 1754
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
                   f->smallest_seqno, f->largest_seqno);
1755
    }
I
Igor Canadi 已提交
1756 1757
    Log(options_.info_log, "[%s] Apply version edit:\n%s",
        cfd->GetName().c_str(), edit.DebugString().data());
1758

I
Igor Canadi 已提交
1759
    status = versions_->LogAndApply(cfd, &edit, &mutex_, db_directory_.get());
1760
    superversion_to_free = cfd->InstallSuperVersion(new_superversion, &mutex_);
I
Igor Canadi 已提交
1761
    new_superversion = nullptr;
1762

I
Igor Canadi 已提交
1763 1764
    Log(options_.info_log, "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
        status.ToString().data());
1765 1766

    if (status.ok()) {
I
Igor Canadi 已提交
1767 1768
      Log(options_.info_log, "[%s] After refitting:\n%s",
          cfd->GetName().c_str(), cfd->current()->DebugString().data());
1769 1770 1771 1772 1773
    }
  }

  refitting_level_ = false;
  bg_work_gate_closed_ = false;
I
Igor Canadi 已提交
1774 1775 1776 1777

  mutex_.Unlock();
  delete superversion_to_free;
  delete new_superversion;
L
Lei Jin 已提交
1778
  return status;
G
Gabor Cselle 已提交
1779 1780
}

1781 1782 1783
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
1784 1785
}

1786 1787 1788
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->options()->max_mem_compaction_level;
1789 1790
}

1791 1792 1793
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->options()->level0_stop_writes_trigger;
1794 1795
}

1796
Status DBImpl::Flush(const FlushOptions& options,
1797 1798 1799
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return FlushMemTable(cfh->cfd(), options);
H
heyongqiang 已提交
1800 1801
}

1802
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
1803 1804 1805
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
1806
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
1807 1808
                                   int output_level, uint32_t output_path_id,
                                   const Slice* begin, const Slice* end) {
1809
  assert(input_level >= 0);
1810

G
Gabor Cselle 已提交
1811 1812
  InternalKey begin_storage, end_storage;

H
hans@chromium.org 已提交
1813
  ManualCompaction manual;
I
Igor Canadi 已提交
1814
  manual.cfd = cfd;
1815 1816
  manual.input_level = input_level;
  manual.output_level = output_level;
1817
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
1818
  manual.done = false;
1819
  manual.in_progress = false;
1820 1821 1822
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
I
Igor Canadi 已提交
1823 1824
      cfd->options()->compaction_style == kCompactionStyleUniversal ||
      cfd->options()->compaction_style == kCompactionStyleFIFO) {
1825
    manual.begin = nullptr;
G
Gabor Cselle 已提交
1826 1827 1828 1829
  } else {
    begin_storage = InternalKey(*begin, kMaxSequenceNumber, kValueTypeForSeek);
    manual.begin = &begin_storage;
  }
1830
  if (end == nullptr ||
I
Igor Canadi 已提交
1831 1832
      cfd->options()->compaction_style == kCompactionStyleUniversal ||
      cfd->options()->compaction_style == kCompactionStyleFIFO) {
1833
    manual.end = nullptr;
G
Gabor Cselle 已提交
1834 1835 1836 1837 1838 1839
  } else {
    end_storage = InternalKey(*end, 0, static_cast<ValueType>(0));
    manual.end = &end_storage;
  }

  MutexLock l(&mutex_);
1840

1841 1842 1843 1844 1845 1846
  // 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
1847
  // RunManualCompaction(), i.e. during that time no other compaction will
1848 1849 1850
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
1851
  // RunManualCompaction() from getting to the second while loop below.
1852 1853 1854 1855 1856 1857
  // 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 已提交
1858 1859 1860
        "[%s] Manual compaction waiting for all other scheduled background "
        "compactions to finish",
        cfd->GetName().c_str());
1861 1862
    bg_cv_.Wait();
  }
1863

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

1867 1868 1869 1870
  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 已提交
1871
      bg_cv_.Wait();
1872 1873
    } else {
      manual_compaction_ = &manual;
1874 1875 1876
      assert(bg_compaction_scheduled_ == 0);
      bg_compaction_scheduled_++;
      env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW);
G
Gabor Cselle 已提交
1877
    }
H
hans@chromium.org 已提交
1878
  }
1879

1880 1881 1882
  assert(!manual.in_progress);
  assert(bg_manual_only_ > 0);
  --bg_manual_only_;
L
Lei Jin 已提交
1883
  return manual.status;
J
jorlow@chromium.org 已提交
1884 1885
}

1886 1887
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
                             const FlushOptions& options) {
S
Stanislau Hlebik 已提交
1888 1889 1890 1891 1892 1893 1894 1895
  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 已提交
1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
  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 已提交
1913 1914


H
heyongqiang 已提交
1915
  if (s.ok() && options.wait) {
1916
    // Wait until the compaction completes
1917
    s = WaitForFlushMemTable(cfd);
1918 1919
  }
  return s;
J
jorlow@chromium.org 已提交
1920 1921
}

1922
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
1923 1924 1925
  Status s;
  // Wait until the compaction completes
  MutexLock l(&mutex_);
1926
  while (cfd->imm()->size() > 0 && bg_error_.ok()) {
1927 1928
    bg_cv_.Wait();
  }
1929
  if (!bg_error_.ok()) {
1930 1931 1932
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
1933 1934
}

1935
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
1936
  mutex_.AssertHeld();
1937
  bg_schedule_needed_ = false;
1938 1939
  if (bg_work_gate_closed_) {
    // gate closed for backgrond work
J
jorlow@chromium.org 已提交
1940 1941 1942
  } else if (shutting_down_.Acquire_Load()) {
    // DB is being deleted; no more background compactions
  } else {
1943
    bool is_flush_pending = false;
1944
    // no need to refcount since we're under a mutex
1945
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
1946
      if (cfd->imm()->IsFlushPending()) {
1947 1948 1949
        is_flush_pending = true;
      }
    }
1950
    if (is_flush_pending) {
1951
      // memtable flush needed
1952 1953 1954
      if (bg_flush_scheduled_ < options_.max_background_flushes) {
        bg_flush_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH);
1955
      } else if (options_.max_background_flushes > 0) {
1956
        bg_schedule_needed_ = true;
1957
      }
1958
    }
1959
    bool is_compaction_needed = false;
1960
    // no need to refcount since we're under a mutex
1961
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
1962
      if (cfd->current()->NeedsCompaction()) {
1963 1964 1965 1966
        is_compaction_needed = true;
        break;
      }
    }
1967

1968 1969
    // Schedule BGWorkCompaction if there's a compaction pending (or a memtable
    // flush, but the HIGH pool is not enabled)
1970 1971 1972 1973 1974
    // Do it only if max_background_compactions hasn't been reached and
    // bg_manual_only_ == 0
    if (!bg_manual_only_ &&
        (is_compaction_needed ||
         (is_flush_pending && options_.max_background_flushes == 0))) {
1975 1976 1977 1978 1979 1980
      if (bg_compaction_scheduled_ < options_.max_background_compactions) {
        bg_compaction_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW);
      } else {
        bg_schedule_needed_ = true;
      }
1981 1982 1983 1984
    }
  }
}

1985
void DBImpl::RecordFlushIOStats() {
I
Igor Canadi 已提交
1986
  RecordTick(stats_, FLUSH_WRITE_BYTES, IOSTATS(bytes_written));
1987 1988 1989 1990
  IOSTATS_RESET(bytes_written);
}

void DBImpl::RecordCompactionIOStats() {
L
Lei Jin 已提交
1991
  RecordTick(stats_, COMPACT_READ_BYTES, IOSTATS(bytes_read));
1992
  IOSTATS_RESET(bytes_read);
L
Lei Jin 已提交
1993
  RecordTick(stats_, COMPACT_WRITE_BYTES, IOSTATS(bytes_written));
1994 1995 1996
  IOSTATS_RESET(bytes_written);
}

1997
void DBImpl::BGWorkFlush(void* db) {
1998
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
1999 2000 2001 2002
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
}

void DBImpl::BGWorkCompaction(void* db) {
2003
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
2004 2005 2006
  reinterpret_cast<DBImpl*>(db)->BackgroundCallCompaction();
}

I
Igor Canadi 已提交
2007
Status DBImpl::BackgroundFlush(bool* madeProgress,
H
Haobo Xu 已提交
2008 2009
                               DeletionState& deletion_state,
                               LogBuffer* log_buffer) {
2010 2011 2012 2013 2014 2015
  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
2016
  for (auto cfd : *versions_->GetColumnFamilySet()) {
2017 2018 2019
    cfd->Ref();
    Status flush_status;
    while (flush_status.ok() && cfd->imm()->IsFlushPending()) {
2020 2021
      LogToBuffer(
          log_buffer,
2022
          "BackgroundCallFlush doing FlushMemTableToOutputFile with column "
I
Igor Canadi 已提交
2023 2024 2025
          "family [%s], flush slots available %d",
          cfd->GetName().c_str(),
          options_.max_background_flushes - bg_flush_scheduled_);
2026 2027
      flush_status = FlushMemTableToOutputFile(cfd, madeProgress,
                                               deletion_state, log_buffer);
2028 2029 2030
    }
    if (call_status.ok() && !flush_status.ok()) {
      call_status = flush_status;
2031
    }
2032
    cfd->Unref();
J
jorlow@chromium.org 已提交
2033
  }
2034
  versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
2035
  return call_status;
J
jorlow@chromium.org 已提交
2036 2037
}

2038
void DBImpl::BackgroundCallFlush() {
2039
  bool madeProgress = false;
K
Kai Liu 已提交
2040
  DeletionState deletion_state(true);
2041 2042
  assert(bg_flush_scheduled_);

2043
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, options_.info_log.get());
H
Haobo Xu 已提交
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054
  {
    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.
2055 2056
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
H
Haobo Xu 已提交
2057 2058
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
2059 2060 2061 2062
        Log(options_.info_log,
            "Waiting after background flush error: %s"
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
H
Haobo Xu 已提交
2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073
        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
2074
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2075
      mutex_.Unlock();
2076 2077 2078 2079 2080
      // 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 已提交
2081
      log_buffer.FlushBufferToLog();
2082 2083 2084
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2085 2086
      mutex_.Lock();
    }
I
Igor Canadi 已提交
2087

H
Haobo Xu 已提交
2088
    bg_flush_scheduled_--;
2089 2090 2091 2092 2093
    // 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 已提交
2094 2095
      MaybeScheduleFlushOrCompaction();
    }
I
Igor Canadi 已提交
2096
    RecordFlushIOStats();
H
Haobo Xu 已提交
2097
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
2098 2099 2100 2101
    // 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.
2102
  }
J
jorlow@chromium.org 已提交
2103 2104
}

2105
void DBImpl::BackgroundCallCompaction() {
2106
  bool madeProgress = false;
K
Kai Liu 已提交
2107
  DeletionState deletion_state(true);
H
Haobo Xu 已提交
2108 2109

  MaybeDumpStats();
2110
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, options_.info_log.get());
2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121
  {
    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.
2122 2123
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
2124 2125
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
H
Haobo Xu 已提交
2126
        log_buffer.FlushBufferToLog();
2127 2128 2129 2130
        Log(options_.info_log,
            "Waiting after background compaction error: %s, "
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
2131 2132 2133 2134 2135
        LogFlush(options_.info_log);
        env_->SleepForMicroseconds(1000000);
        mutex_.Lock();
      }
    }
H
Haobo Xu 已提交
2136

2137 2138 2139 2140 2141 2142 2143
    // 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
2144
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2145
      mutex_.Unlock();
2146 2147 2148 2149 2150
      // 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 已提交
2151
      log_buffer.FlushBufferToLog();
2152 2153 2154
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2155 2156
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
2157

2158
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2159

2160 2161
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

2162 2163 2164
    // Previous compaction may have produced too many files in a level,
    // So reschedule another compaction if we made progress in the
    // last compaction.
2165 2166 2167 2168 2169 2170
    //
    // 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_) {
2171 2172
      MaybeScheduleFlushOrCompaction();
    }
2173 2174 2175 2176 2177 2178 2179 2180 2181
    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 已提交
2182 2183 2184 2185
    // 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.
2186
  }
J
jorlow@chromium.org 已提交
2187 2188
}

A
Abhishek Kona 已提交
2189
Status DBImpl::BackgroundCompaction(bool* madeProgress,
2190 2191
                                    DeletionState& deletion_state,
                                    LogBuffer* log_buffer) {
2192
  *madeProgress = false;
J
jorlow@chromium.org 已提交
2193
  mutex_.AssertHeld();
2194

2195 2196
  bool is_manual = (manual_compaction_ != nullptr) &&
                   (manual_compaction_->in_progress == false);
2197 2198 2199 2200

  if (is_manual) {
    // another thread cannot pick up the same work
    manual_compaction_->in_progress = true;
2201 2202 2203 2204
  } else if (manual_compaction_ != nullptr) {
    // there should be no automatic compactions running when manual compaction
    // is running
    return Status::OK();
2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218
  }

  // 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);
2219
      cfd->Unref();
2220 2221 2222 2223 2224 2225 2226
      if (!flush_stat.ok()) {
        if (is_manual) {
          manual_compaction_->status = flush_stat;
          manual_compaction_->done = true;
          manual_compaction_->in_progress = false;
          manual_compaction_ = nullptr;
        }
2227
        return flush_stat;
2228 2229 2230 2231 2232
      }
    }
  }

  unique_ptr<Compaction> c;
2233 2234
  InternalKey manual_end_storage;
  InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
2235
  if (is_manual) {
G
Gabor Cselle 已提交
2236
    ManualCompaction* m = manual_compaction_;
2237
    assert(m->in_progress);
2238 2239 2240
    c.reset(m->cfd->CompactRange(m->input_level, m->output_level,
                                 m->output_path_id, m->begin, m->end,
                                 &manual_end));
2241
    if (!c) {
2242
      m->done = true;
G
Gabor Cselle 已提交
2243
    }
I
Igor Canadi 已提交
2244 2245 2246 2247 2248 2249 2250 2251 2252
    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 已提交
2253
  } else {
2254
    // no need to refcount in iteration since it's always under a mutex
I
Igor Canadi 已提交
2255
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
2256
      if (!cfd->options()->disable_auto_compactions) {
2257
        c.reset(cfd->PickCompaction(log_buffer));
I
Igor Canadi 已提交
2258 2259
        if (c != nullptr) {
          // update statistics
L
Lei Jin 已提交
2260
          MeasureTime(stats_, NUM_FILES_IN_SINGLE_COMPACTION,
I
Igor Canadi 已提交
2261 2262 2263
                      c->inputs(0)->size());
          break;
        }
I
Igor Canadi 已提交
2264 2265
      }
    }
J
jorlow@chromium.org 已提交
2266 2267 2268
  }

  Status status;
2269
  if (!c) {
H
hans@chromium.org 已提交
2270
    // Nothing to do
2271
    LogToBuffer(log_buffer, "Compaction nothing to do");
I
Igor Canadi 已提交
2272 2273 2274 2275 2276 2277 2278 2279
  } 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)) {
2280
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
2281 2282 2283 2284 2285 2286 2287 2288 2289
    }
    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 已提交
2290
  } else if (!is_manual && c->IsTrivialMove()) {
J
jorlow@chromium.org 已提交
2291
    // Move file to next level
2292
    assert(c->num_input_files(0) == 1);
J
jorlow@chromium.org 已提交
2293
    FileMetaData* f = c->input(0, 0);
2294
    c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
2295 2296 2297
    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 已提交
2298
    status = versions_->LogAndApply(c->column_family_data(), c->edit(), &mutex_,
2299
                                    db_directory_.get());
I
Igor Canadi 已提交
2300
    InstallSuperVersion(c->column_family_data(), deletion_state);
2301

2302
    Version::LevelSummaryStorage tmp;
2303 2304 2305 2306 2307 2308
    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 已提交
2309
    c->ReleaseCompactionFiles(status);
2310
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2311
  } else {
2312
    MaybeScheduleFlushOrCompaction(); // do more compaction work in parallel.
2313
    CompactionState* compact = new CompactionState(c.get());
H
Haobo Xu 已提交
2314
    status = DoCompactionWork(compact, deletion_state, log_buffer);
2315
    CleanupCompaction(compact, status);
I
Igor Canadi 已提交
2316
    c->ReleaseCompactionFiles(status);
2317
    c->ReleaseInputs();
2318
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2319
  }
2320
  c.reset();
J
jorlow@chromium.org 已提交
2321 2322 2323 2324 2325 2326

  if (status.ok()) {
    // Done
  } else if (shutting_down_.Acquire_Load()) {
    // Ignore compaction errors found during shutting down
  } else {
2327
    Log(InfoLogLevel::WARN_LEVEL, options_.info_log, "Compaction error: %s",
2328
        status.ToString().c_str());
J
jorlow@chromium.org 已提交
2329 2330 2331 2332
    if (options_.paranoid_checks && bg_error_.ok()) {
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
2333 2334

  if (is_manual) {
G
Gabor Cselle 已提交
2335
    ManualCompaction* m = manual_compaction_;
2336
    if (!status.ok()) {
L
Lei Jin 已提交
2337
      m->status = status;
2338 2339
      m->done = true;
    }
2340 2341 2342 2343 2344 2345 2346 2347 2348
    // 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.
2349 2350 2351 2352 2353
    //
    // 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) {
2354 2355
      m->done = true;
    }
G
Gabor Cselle 已提交
2356 2357 2358
    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 已提交
2359
      // Universal and FIFO compactions should always compact the whole range
I
Igor Canadi 已提交
2360
      assert(m->cfd->options()->compaction_style != kCompactionStyleUniversal);
I
Igor Canadi 已提交
2361
      assert(m->cfd->options()->compaction_style != kCompactionStyleFIFO);
2362
      m->tmp_storage = *manual_end;
G
Gabor Cselle 已提交
2363 2364
      m->begin = &m->tmp_storage;
    }
2365
    m->in_progress = false; // not being processed anymore
2366
    manual_compaction_ = nullptr;
H
hans@chromium.org 已提交
2367
  }
2368
  return status;
J
jorlow@chromium.org 已提交
2369 2370
}

2371
void DBImpl::CleanupCompaction(CompactionState* compact, Status status) {
J
jorlow@chromium.org 已提交
2372
  mutex_.AssertHeld();
2373
  if (compact->builder != nullptr) {
J
jorlow@chromium.org 已提交
2374 2375
    // May happen if we get a shutdown call in the middle of compaction
    compact->builder->Abandon();
2376
    compact->builder.reset();
J
jorlow@chromium.org 已提交
2377
  } else {
2378
    assert(compact->outfile == nullptr);
J
jorlow@chromium.org 已提交
2379
  }
D
dgrogan@chromium.org 已提交
2380
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2381 2382
    const CompactionState::Output& out = compact->outputs[i];
    pending_outputs_.erase(out.number);
2383 2384 2385 2386

    // 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 已提交
2387
      TableCache::Evict(table_cache_.get(), out.number);
2388
    }
J
jorlow@chromium.org 已提交
2389 2390 2391 2392
  }
  delete compact;
}

2393
// Allocate the file numbers for the output file. We allocate as
2394
// many output file numbers as there are files in level+1 (at least one)
2395 2396 2397
// Insert them into pending_outputs so that they do not get deleted.
void DBImpl::AllocateCompactionOutputFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2398 2399
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
2400
  int filesNeeded = compact->compaction->num_input_files(1);
2401
  for (int i = 0; i < std::max(filesNeeded, 1); i++) {
2402
    uint64_t file_number = versions_->NewFileNumber();
2403
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
2404 2405 2406 2407 2408 2409 2410
    compact->allocated_file_numbers.push_back(file_number);
  }
}

// Frees up unused file number.
void DBImpl::ReleaseCompactionUnusedFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2411
  for (const auto file_number : compact->allocated_file_numbers) {
2412 2413 2414 2415
    pending_outputs_.erase(file_number);
  }
}

J
jorlow@chromium.org 已提交
2416
Status DBImpl::OpenCompactionOutputFile(CompactionState* compact) {
2417 2418
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
J
jorlow@chromium.org 已提交
2419
  uint64_t file_number;
2420 2421 2422 2423 2424 2425 2426
  // 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 已提交
2427 2428
    mutex_.Lock();
    file_number = versions_->NewFileNumber();
2429
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
J
jorlow@chromium.org 已提交
2430 2431
    mutex_.Unlock();
  }
2432 2433
  CompactionState::Output out;
  out.number = file_number;
2434
  out.path_id = compact->compaction->GetOutputPathId();
2435 2436
  out.smallest.Clear();
  out.largest.Clear();
2437
  out.smallest_seqno = out.largest_seqno = 0;
2438
  compact->outputs.push_back(out);
J
jorlow@chromium.org 已提交
2439 2440

  // Make the output file
2441 2442
  std::string fname = TableFileName(options_.db_paths, file_number,
                                    compact->compaction->GetOutputPathId());
2443
  Status s = env_->NewWritableFile(fname, &compact->outfile, storage_options_);
2444

J
jorlow@chromium.org 已提交
2445
  if (s.ok()) {
L
Lei Jin 已提交
2446
    compact->outfile->SetIOPriority(Env::IO_LOW);
2447
    compact->outfile->SetPreallocationBlockSize(
2448
        compact->compaction->OutputFilePreallocationSize());
2449

2450
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2451 2452 2453
    compact->builder.reset(NewTableBuilder(
        *cfd->options(), cfd->internal_comparator(), compact->outfile.get(),
        compact->compaction->OutputCompressionType()));
J
jorlow@chromium.org 已提交
2454
  }
I
Igor Canadi 已提交
2455
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
2456 2457 2458 2459 2460
  return s;
}

Status DBImpl::FinishCompactionOutputFile(CompactionState* compact,
                                          Iterator* input) {
2461
  assert(compact != nullptr);
2462
  assert(compact->outfile);
2463
  assert(compact->builder != nullptr);
J
jorlow@chromium.org 已提交
2464 2465

  const uint64_t output_number = compact->current_output()->number;
2466
  const uint32_t output_path_id = compact->current_output()->path_id;
J
jorlow@chromium.org 已提交
2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479
  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;
2480
  compact->builder.reset();
J
jorlow@chromium.org 已提交
2481 2482

  // Finish and check for file errors
2483
  if (s.ok() && !options_.disableDataSync) {
2484
    if (options_.use_fsync) {
L
Lei Jin 已提交
2485
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2486 2487
      s = compact->outfile->Fsync();
    } else {
L
Lei Jin 已提交
2488
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2489 2490
      s = compact->outfile->Sync();
    }
J
jorlow@chromium.org 已提交
2491 2492 2493 2494
  }
  if (s.ok()) {
    s = compact->outfile->Close();
  }
2495
  compact->outfile.reset();
J
jorlow@chromium.org 已提交
2496 2497 2498

  if (s.ok() && current_entries > 0) {
    // Verify that the table is usable
I
Igor Canadi 已提交
2499
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2500
    FileDescriptor fd(output_number, output_path_id, current_bytes);
I
Igor Canadi 已提交
2501
    Iterator* iter = cfd->table_cache()->NewIterator(
2502
        ReadOptions(), storage_options_, cfd->internal_comparator(), fd);
J
jorlow@chromium.org 已提交
2503 2504 2505
    s = iter->status();
    delete iter;
    if (s.ok()) {
2506 2507 2508 2509
      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 已提交
2510 2511 2512 2513 2514 2515
    }
  }
  return s;
}


2516 2517
Status DBImpl::InstallCompactionResults(CompactionState* compact,
                                        LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
2518
  mutex_.AssertHeld();
2519 2520 2521 2522 2523

  // 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.
2524
  if (!versions_->VerifyCompactionFileConsistency(compact->compaction)) {
I
Igor Canadi 已提交
2525 2526 2527 2528 2529
    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 已提交
2530
    return Status::Corruption("Compaction input files inconsistent");
2531 2532
  }

I
Igor Canadi 已提交
2533 2534
  LogToBuffer(log_buffer, "[%s] Compacted %d@%d + %d@%d files => %lld bytes",
              compact->compaction->column_family_data()->GetName().c_str(),
2535 2536 2537 2538 2539
              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 已提交
2540 2541 2542

  // Add compaction outputs
  compact->compaction->AddInputDeletions(compact->compaction->edit());
D
dgrogan@chromium.org 已提交
2543
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2544
    const CompactionState::Output& out = compact->outputs[i];
2545 2546 2547 2548
    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 已提交
2549
  }
I
Igor Canadi 已提交
2550 2551 2552
  return versions_->LogAndApply(compact->compaction->column_family_data(),
                                compact->compaction->edit(), &mutex_,
                                db_directory_.get());
J
jorlow@chromium.org 已提交
2553 2554
}

2555 2556 2557 2558 2559 2560 2561
// 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(
2562 2563
  SequenceNumber in, std::vector<SequenceNumber>& snapshots,
  SequenceNumber* prev_snapshot) {
2564
  SequenceNumber prev __attribute__((unused)) = 0;
2565 2566 2567
  for (const auto cur : snapshots) {
    assert(prev <= cur);
    if (cur >= in) {
2568
      *prev_snapshot = prev;
2569
      return cur;
2570
    }
2571 2572
    prev = cur; // assignment
    assert(prev);
2573 2574
  }
  Log(options_.info_log,
2575 2576
      "Looking for seqid %" PRIu64 " but maxseqid is %" PRIu64 "", in,
      snapshots[snapshots.size() - 1]);
2577 2578 2579 2580
  assert(0);
  return 0;
}

I
Igor Canadi 已提交
2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599
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 已提交
2600
Status DBImpl::ProcessKeyValueCompaction(
2601
    bool is_snapshot_supported,
D
Danny Guo 已提交
2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612
    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 已提交
2613
  Status status;
D
Danny Guo 已提交
2614
  std::string compaction_filter_value;
J
jorlow@chromium.org 已提交
2615
  ParsedInternalKey ikey;
2616
  IterKey current_user_key;
J
jorlow@chromium.org 已提交
2617
  bool has_current_user_key = false;
2618
  IterKey delete_key;
2619 2620
  SequenceNumber last_sequence_for_key __attribute__((unused)) =
    kMaxSequenceNumber;
2621
  SequenceNumber visible_in_snapshot = kMaxSequenceNumber;
2622
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
I
Igor Canadi 已提交
2623 2624
  MergeHelper merge(
      cfd->user_comparator(), cfd->options()->merge_operator.get(),
2625 2626
      options_.info_log.get(), cfd->options()->min_partial_merge_operands,
      false /* internal key corruption is expected */);
I
Igor Canadi 已提交
2627
  auto compaction_filter = cfd->options()->compaction_filter;
2628 2629
  std::unique_ptr<CompactionFilter> compaction_filter_from_factory = nullptr;
  if (!compaction_filter) {
2630
    auto context = compact->GetFilterContextV1();
2631
    compaction_filter_from_factory =
I
Igor Canadi 已提交
2632 2633
        cfd->options()->compaction_filter_factory->CreateCompactionFilter(
            context);
2634 2635
    compaction_filter = compaction_filter_from_factory.get();
  }
2636

2637 2638
  while (input->Valid() && !shutting_down_.Acquire_Load() &&
         !cfd->IsDropped()) {
2639
    RecordCompactionIOStats();
2640 2641 2642 2643
    // 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 已提交
2644
    imm_micros += CallFlushDuringCompaction(cfd, deletion_state, log_buffer);
2645

D
Danny Guo 已提交
2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666
    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 已提交
2667

2668
    if (compact->compaction->ShouldStopBefore(key) &&
2669
        compact->builder != nullptr) {
D
Danny Guo 已提交
2670
      status = FinishCompactionOutputFile(compact, input);
2671 2672 2673 2674 2675 2676
      if (!status.ok()) {
        break;
      }
    }

    // Handle key/value, add to state, etc.
J
jorlow@chromium.org 已提交
2677
    bool drop = false;
2678
    bool current_entry_is_merging = false;
J
jorlow@chromium.org 已提交
2679 2680
    if (!ParseInternalKey(key, &ikey)) {
      // Do not hide error keys
2681 2682
      // 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.
2683
      current_user_key.Clear();
J
jorlow@chromium.org 已提交
2684 2685
      has_current_user_key = false;
      last_sequence_for_key = kMaxSequenceNumber;
2686
      visible_in_snapshot = kMaxSequenceNumber;
J
jorlow@chromium.org 已提交
2687 2688
    } else {
      if (!has_current_user_key ||
2689
          cfd->user_comparator()->Compare(ikey.user_key,
2690
                                          current_user_key.GetKey()) != 0) {
J
jorlow@chromium.org 已提交
2691
        // First occurrence of this user key
L
Lei Jin 已提交
2692
        current_user_key.SetKey(ikey.user_key);
J
jorlow@chromium.org 已提交
2693 2694
        has_current_user_key = true;
        last_sequence_for_key = kMaxSequenceNumber;
2695
        visible_in_snapshot = kMaxSequenceNumber;
H
Haobo Xu 已提交
2696
        // apply the compaction filter to the first occurrence of the user key
D
Danny Guo 已提交
2697
        if (compaction_filter && !is_compaction_v2 &&
H
Haobo Xu 已提交
2698 2699 2700 2701 2702 2703 2704 2705 2706
            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 已提交
2707 2708 2709
          bool to_delete = compaction_filter->Filter(
              compact->compaction->level(), ikey.user_key, value,
              &compaction_filter_value, &value_changed);
H
Haobo Xu 已提交
2710
          if (to_delete) {
2711 2712 2713
            // make a copy of the original key and convert it to a delete
            delete_key.SetInternalKey(ExtractUserKey(key), ikey.sequence,
                                      kTypeDeletion);
H
Haobo Xu 已提交
2714
            // anchor the key again
2715
            key = delete_key.GetKey();
H
Haobo Xu 已提交
2716 2717 2718 2719
            // needed because ikey is backed by key
            ParseInternalKey(key, &ikey);
            // no value associated with delete
            value.clear();
L
Lei Jin 已提交
2720
            RecordTick(stats_, COMPACTION_KEY_DROP_USER);
H
Haobo Xu 已提交
2721 2722 2723 2724
          } else if (value_changed) {
            value = compaction_filter_value;
          }
        }
J
jorlow@chromium.org 已提交
2725 2726
      }

2727 2728 2729
      // 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.
2730
      SequenceNumber prev_snapshot = 0; // 0 means no previous snapshot
2731 2732 2733 2734
      SequenceNumber visible = visible_at_tip ? visible_at_tip :
        is_snapshot_supported ?  findEarliestVisibleSnapshot(ikey.sequence,
                                  compact->existing_snapshots, &prev_snapshot)
                              : 0;
2735 2736 2737 2738 2739

      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 已提交
2740
        // Hidden by an newer entry for same user key
2741
        // TODO: why not > ?
2742
        assert(last_sequence_for_key >= ikey.sequence);
J
jorlow@chromium.org 已提交
2743
        drop = true;    // (A)
L
Lei Jin 已提交
2744
        RecordTick(stats_, COMPACTION_KEY_DROP_NEWER_ENTRY);
J
jorlow@chromium.org 已提交
2745
      } else if (ikey.type == kTypeDeletion &&
D
Danny Guo 已提交
2746
          ikey.sequence <= earliest_snapshot &&
2747
          compact->compaction->KeyNotExistsBeyondOutputLevel(ikey.user_key)) {
J
jorlow@chromium.org 已提交
2748 2749 2750 2751 2752 2753 2754 2755
        // 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 已提交
2756
        RecordTick(stats_, COMPACTION_KEY_DROP_OBSOLETE);
2757
      } else if (ikey.type == kTypeMerge) {
2758 2759 2760 2761 2762 2763
        if (!merge.HasOperator()) {
          LogToBuffer(log_buffer, "Options::merge_operator is null.");
          status = Status::InvalidArgument(
              "merge_operator is not properly initialized.");
          break;
        }
2764 2765 2766 2767 2768 2769
        // 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 已提交
2770 2771 2772 2773 2774 2775
        int steps = 0;
        merge.MergeUntil(input, prev_snapshot, bottommost_level,
            options_.statistics.get(), &steps);
        // Skip the Merge ops
        combined_idx = combined_idx - 1 + steps;

2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793
        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 已提交
2794 2795 2796
      }

      last_sequence_for_key = ikey.sequence;
2797
      visible_in_snapshot = visible;
J
jorlow@chromium.org 已提交
2798 2799 2800
    }

    if (!drop) {
2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816
      // 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);
2817
      }
2818

2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829
      // 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.
2830
        if (bottommost_level && ikey.sequence < earliest_snapshot &&
2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841
            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
2842

2843 2844 2845 2846 2847 2848 2849
        // Open output file if necessary
        if (compact->builder == nullptr) {
          status = OpenCompactionOutputFile(compact);
          if (!status.ok()) {
            break;
          }
        }
2850 2851

        SequenceNumber seqno = GetInternalKeySeqno(newkey);
2852 2853
        if (compact->builder->NumEntries() == 0) {
          compact->current_output()->smallest.DecodeFrom(newkey);
2854 2855 2856 2857
          compact->current_output()->smallest_seqno = seqno;
        } else {
          compact->current_output()->smallest_seqno =
            std::min(compact->current_output()->smallest_seqno, seqno);
2858 2859 2860
        }
        compact->current_output()->largest.DecodeFrom(newkey);
        compact->builder->Add(newkey, value);
2861 2862
        compact->current_output()->largest_seqno =
          std::max(compact->current_output()->largest_seqno, seqno);
2863 2864 2865 2866

        // Close output file if it is big enough
        if (compact->builder->FileSize() >=
            compact->compaction->MaxOutputFileSize()) {
D
Danny Guo 已提交
2867
          status = FinishCompactionOutputFile(compact, input);
2868 2869 2870
          if (!status.ok()) {
            break;
          }
J
jorlow@chromium.org 已提交
2871 2872
        }

2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892
        // 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 已提交
2893 2894 2895 2896 2897
          break;
        }
      }
    }

2898
    // MergeUntil has moved input to the next entry
2899
    if (!current_entry_is_merging) {
2900 2901
      input->Next();
    }
J
jorlow@chromium.org 已提交
2902 2903
  }

2904 2905
  RecordCompactionIOStats();

D
Danny Guo 已提交
2906 2907 2908 2909 2910 2911 2912 2913 2914
  return status;
}

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

2915
  // Assemble slice vectors for user keys and existing values.
2916
  // We also keep track of our parsed internal key structs because
2917 2918 2919
  // 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 已提交
2920
  std::vector<Slice> user_key_buf;
2921 2922 2923 2924 2925 2926 2927 2928 2929 2930
  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 已提交
2931 2932 2933 2934 2935 2936 2937 2938 2939
  }

  // 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(),
2940
      user_key_buf, existing_value_buf,
D
Danny Guo 已提交
2941 2942 2943 2944 2945 2946
      &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() ==
2947
      compact->key_str_buf_.size());
D
Danny Guo 已提交
2948
  assert(compact->to_delete_buf_.size() ==
2949
      compact->existing_value_str_buf_.size());
D
Danny Guo 已提交
2950 2951 2952 2953 2954 2955 2956 2957 2958
  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],
2959 2960 2961
                        compact->key_str_buf_[i].size(),
                        ikey_buf[i].sequence,
                        kTypeDeletion);
D
Danny Guo 已提交
2962 2963

      // no value associated with delete
2964
      compact->existing_value_str_buf_[i].clear();
L
Lei Jin 已提交
2965
      RecordTick(stats_, COMPACTION_KEY_DROP_USER);
D
Danny Guo 已提交
2966
    } else if (compact->value_changed_buf_[i]) {
2967 2968
      compact->existing_value_str_buf_[i] =
          compact->new_value_buf_[new_value_idx++];
D
Danny Guo 已提交
2969 2970 2971 2972 2973 2974 2975 2976 2977 2978
    }
  }  // for
}

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

F
Feng Zhu 已提交
2981 2982
  // Generate file_levels_ for compaction berfore making Iterator
  compact->compaction->GenerateFileLevels();
D
Danny Guo 已提交
2983
  int64_t imm_micros = 0;  // Micros spent doing imm_ compactions
2984
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
2985 2986
  LogToBuffer(
      log_buffer,
I
Igor Canadi 已提交
2987 2988
      "[%s] Compacting %d@%d + %d@%d files, score %.2f slots available %d",
      cfd->GetName().c_str(), compact->compaction->num_input_files(0),
2989 2990
      compact->compaction->level(), compact->compaction->num_input_files(1),
      compact->compaction->output_level(), compact->compaction->score(),
D
Danny Guo 已提交
2991 2992 2993
      options_.max_background_compactions - bg_compaction_scheduled_);
  char scratch[2345];
  compact->compaction->Summary(scratch, sizeof(scratch));
I
Igor Canadi 已提交
2994 2995
  LogToBuffer(log_buffer, "[%s] Compaction start summary: %s\n",
              cfd->GetName().c_str(), scratch);
D
Danny Guo 已提交
2996

2997
  assert(cfd->current()->NumLevelFiles(compact->compaction->level()) > 0);
D
Danny Guo 已提交
2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022
  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);

3023
  bool is_snapshot_supported = IsSnapshotSupported();
D
Danny Guo 已提交
3024 3025
  // Release mutex while we're actually doing the compaction work
  mutex_.Unlock();
3026
  log_buffer->FlushBufferToLog();
D
Danny Guo 已提交
3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040

  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 =
3041 3042
      cfd->options()->compaction_filter_factory_v2->CreateCompactionFilterV2(
          context);
D
Danny Guo 已提交
3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053
  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) {
3054 3055
    while (backup_input->Valid() && !shutting_down_.Acquire_Load() &&
           !cfd->IsDropped()) {
I
Igor Canadi 已提交
3056 3057 3058 3059 3060 3061
      // 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 已提交
3062 3063 3064 3065 3066
      Slice key = backup_input->key();
      Slice value = backup_input->value();

      if (!ParseInternalKey(key, &ikey)) {
        // log error
I
Igor Canadi 已提交
3067 3068
        Log(options_.info_log, "[%s] Failed to parse key: %s",
            cfd->GetName().c_str(), key.ToString().c_str());
D
Danny Guo 已提交
3069 3070
        continue;
      } else {
3071 3072 3073 3074 3075 3076 3077
        const SliceTransform* transformer =
            cfd->options()->compaction_filter_factory_v2->GetPrefixExtractor();
        const auto key_prefix = transformer->Transform(ikey.user_key);
        if (!prefix_initialized) {
          compact->cur_prefix_ = key_prefix.ToString();
          prefix_initialized = true;
        }
D
Danny Guo 已提交
3078
        // If the prefix remains the same, keep buffering
3079
        if (key_prefix.compare(Slice(compact->cur_prefix_)) == 0) {
D
Danny Guo 已提交
3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096
          // 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
3097
          if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3098 3099
            CallCompactionFilterV2(compact, compaction_filter_v2);
          }
3100
          compact->cur_prefix_ = key_prefix.ToString();
D
Danny Guo 已提交
3101 3102 3103 3104
        }
      }

      // Merge this batch of data (values + ineligible keys)
3105
      compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3106 3107 3108 3109

      // Done buffering for the current prefix. Spit it out to disk
      // Now just iterate through all the kv-pairs
      status = ProcessKeyValueCompaction(
3110
          is_snapshot_supported,
D
Danny Guo 已提交
3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139
          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.
3140
        if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3141 3142
          CallCompactionFilterV2(compact, compaction_filter_v2);
        }
3143
        compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3144 3145

        status = ProcessKeyValueCompaction(
3146
            is_snapshot_supported,
D
Danny Guo 已提交
3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162
            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
3163
    if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3164 3165
      CallCompactionFilterV2(compact, compaction_filter_v2);
    }
3166
    compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3167
    status = ProcessKeyValueCompaction(
3168
        is_snapshot_supported,
D
Danny Guo 已提交
3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182
        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(
3183
      is_snapshot_supported,
D
Danny Guo 已提交
3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195
      visible_at_tip,
      earliest_snapshot,
      latest_snapshot,
      deletion_state,
      bottommost_level,
      imm_micros,
      input.get(),
      compact,
      false,
      log_buffer);
  }

3196
  if (status.ok() && (shutting_down_.Acquire_Load() || cfd->IsDropped())) {
L
Lei Jin 已提交
3197
    status = Status::ShutdownInProgress(
3198
        "Database shutdown or Column family drop during compaction");
J
jorlow@chromium.org 已提交
3199
  }
3200
  if (status.ok() && compact->builder != nullptr) {
3201
    status = FinishCompactionOutputFile(compact, input.get());
J
jorlow@chromium.org 已提交
3202 3203 3204 3205
  }
  if (status.ok()) {
    status = input->status();
  }
3206
  input.reset();
J
jorlow@chromium.org 已提交
3207

3208 3209 3210
  if (!options_.disableDataSync) {
    db_directory_->Fsync();
  }
I
Igor Canadi 已提交
3211

L
Lei Jin 已提交
3212
  InternalStats::CompactionStats stats(1);
3213
  stats.micros = env_->NowMicros() - start_micros - imm_micros;
M
Mark Callaghan 已提交
3214 3215
  stats.files_in_leveln = compact->compaction->num_input_files(0);
  stats.files_in_levelnp1 = compact->compaction->num_input_files(1);
L
Lei Jin 已提交
3216
  MeasureTime(stats_, COMPACTION_TIME, stats.micros);
3217 3218

  int num_output_files = compact->outputs.size();
3219
  if (compact->builder != nullptr) {
P
Pascal Borreli 已提交
3220
    // An error occurred so ignore the last output.
3221 3222 3223 3224
    assert(num_output_files > 0);
    --num_output_files;
  }
  stats.files_out_levelnp1 = num_output_files;
M
Mark Callaghan 已提交
3225

3226
  for (int i = 0; i < compact->compaction->num_input_files(0); i++) {
3227
    stats.bytes_readn += compact->compaction->input(0, i)->fd.GetFileSize();
3228
  }
M
Mark Callaghan 已提交
3229

3230
  for (int i = 0; i < compact->compaction->num_input_files(1); i++) {
3231
    stats.bytes_readnp1 += compact->compaction->input(1, i)->fd.GetFileSize();
3232
  }
M
Mark Callaghan 已提交
3233

3234
  for (int i = 0; i < num_output_files; i++) {
3235 3236 3237
    stats.bytes_written += compact->outputs[i].file_size;
  }

3238 3239
  RecordCompactionIOStats();

I
Igor Canadi 已提交
3240
  LogFlush(options_.info_log);
J
jorlow@chromium.org 已提交
3241
  mutex_.Lock();
3242 3243
  cfd->internal_stats()->AddCompactionStats(
      compact->compaction->output_level(), stats);
J
jorlow@chromium.org 已提交
3244

3245 3246 3247 3248
  // 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 已提交
3249
  if (status.ok()) {
3250
    status = InstallCompactionResults(compact, log_buffer);
I
Igor Canadi 已提交
3251
    InstallSuperVersion(cfd, deletion_state);
J
jorlow@chromium.org 已提交
3252
  }
3253
  Version::LevelSummaryStorage tmp;
3254 3255
  LogToBuffer(
      log_buffer,
I
Igor Canadi 已提交
3256
      "[%s] compacted to: %s, %.1f MB/sec, level %d, files in(%d, %d) out(%d) "
3257 3258
      "MB in(%.1f, %.1f) out(%.1f), read-write-amplify(%.1f) "
      "write-amplify(%.1f) %s\n",
I
Igor Canadi 已提交
3259
      cfd->GetName().c_str(), cfd->current()->LevelSummary(&tmp),
M
Mark Callaghan 已提交
3260
      (stats.bytes_readn + stats.bytes_readnp1 + stats.bytes_written) /
3261 3262 3263 3264
          (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 已提交
3265
      stats.bytes_written / 1048576.0,
3266
      (stats.bytes_written + stats.bytes_readnp1 + stats.bytes_readn) /
3267 3268
          (double)stats.bytes_readn,
      stats.bytes_written / (double)stats.bytes_readn,
3269
      status.ToString().c_str());
M
Mark Callaghan 已提交
3270

J
jorlow@chromium.org 已提交
3271 3272 3273
  return status;
}

3274 3275
namespace {
struct IterState {
3276 3277
  IterState(DBImpl* db, port::Mutex* mu, SuperVersion* super_version)
      : db(db), mu(mu), super_version(super_version) {}
3278 3279

  DBImpl* db;
3280
  port::Mutex* mu;
3281
  SuperVersion* super_version;
3282 3283 3284 3285
};

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

3287
  if (state->super_version->Unref()) {
3288 3289
    DBImpl::DeletionState deletion_state;

3290 3291 3292 3293 3294 3295
    state->mu->Lock();
    state->super_version->Cleanup();
    state->db->FindObsoleteFiles(deletion_state, false, true);
    state->mu->Unlock();

    delete state->super_version;
3296 3297 3298
    if (deletion_state.HaveSomethingToDelete()) {
      state->db->PurgeObsoleteFiles(deletion_state);
    }
I
Igor Canadi 已提交
3299
  }
T
Tomislav Novak 已提交
3300

3301 3302
  delete state;
}
H
Hans Wennborg 已提交
3303
}  // namespace
3304

J
jorlow@chromium.org 已提交
3305
Iterator* DBImpl::NewInternalIterator(const ReadOptions& options,
3306
                                      ColumnFamilyData* cfd,
3307 3308 3309 3310 3311 3312 3313 3314
                                      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(
3315
        super_version->mem->NewIterator(options, arena));
3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334
    // 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());
  }
3335
  IterState* cleanup = new IterState(this, &mutex_, super_version);
3336
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
3337 3338 3339 3340

  return internal_iter;
}

3341 3342 3343 3344
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

J
jorlow@chromium.org 已提交
3345
Status DBImpl::Get(const ReadOptions& options,
3346
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3347
                   std::string* value) {
3348
  return GetImpl(options, column_family, key, value);
3349 3350
}

I
Igor Canadi 已提交
3351 3352 3353
// DeletionState gets created and destructed outside of the lock -- we
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3354
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3355 3356 3357 3358 3359 3360
//
// 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
3361 3362
void DBImpl::InstallSuperVersion(ColumnFamilyData* cfd,
                                 DeletionState& deletion_state) {
3363
  mutex_.AssertHeld();
I
Igor Canadi 已提交
3364 3365 3366 3367
  // if new_superversion == nullptr, it means somebody already used it
  SuperVersion* new_superversion =
    (deletion_state.new_superversion != nullptr) ?
    deletion_state.new_superversion : new SuperVersion();
3368 3369
  SuperVersion* old_superversion =
      cfd->InstallSuperVersion(new_superversion, &mutex_);
I
Igor Canadi 已提交
3370
  deletion_state.new_superversion = nullptr;
3371
  deletion_state.superversions_to_free.push_back(old_superversion);
I
Igor Canadi 已提交
3372 3373
}

3374
Status DBImpl::GetImpl(const ReadOptions& options,
3375 3376
                       ColumnFamilyHandle* column_family, const Slice& key,
                       std::string* value, bool* value_found) {
L
Lei Jin 已提交
3377
  StopWatch sw(env_, stats_, DB_GET);
L
Lei Jin 已提交
3378
  PERF_TIMER_AUTO(get_snapshot_time);
3379

3380 3381 3382
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3383
  SequenceNumber snapshot;
3384
  if (options.snapshot != nullptr) {
3385 3386 3387
    snapshot = reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_;
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3388
  }
3389

3390
  // Acquire SuperVersion
3391
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
I
Igor Canadi 已提交
3392

3393
  // Prepare to store a list of merge operations if merge occurs.
3394
  MergeContext merge_context;
3395

3396
  Status s;
3397
  // First look in the memtable, then in the immutable memtable (if any).
3398
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3399
  // merge_operands will contain the sequence of merges in the latter case.
3400
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3401
  PERF_TIMER_STOP(get_snapshot_time);
I
Igor Canadi 已提交
3402
  if (sv->mem->Get(lkey, value, &s, merge_context, *cfd->options())) {
3403
    // Done
L
Lei Jin 已提交
3404
    RecordTick(stats_, MEMTABLE_HIT);
I
Igor Canadi 已提交
3405
  } else if (sv->imm->Get(lkey, value, &s, merge_context, *cfd->options())) {
3406
    // Done
L
Lei Jin 已提交
3407
    RecordTick(stats_, MEMTABLE_HIT);
3408
  } else {
L
Lei Jin 已提交
3409
    PERF_TIMER_START(get_from_output_files_time);
3410

I
Igor Canadi 已提交
3411
    sv->current->Get(options, lkey, value, &s, &merge_context, value_found);
L
Lei Jin 已提交
3412
    PERF_TIMER_STOP(get_from_output_files_time);
L
Lei Jin 已提交
3413
    RecordTick(stats_, MEMTABLE_MISS);
3414
  }
3415

L
Lei Jin 已提交
3416
  PERF_TIMER_START(get_post_process_time);
3417

3418
  ReturnAndCleanupSuperVersion(cfd, sv);
3419

L
Lei Jin 已提交
3420 3421
  RecordTick(stats_, NUMBER_KEYS_READ);
  RecordTick(stats_, BYTES_READ, value->size());
L
Lei Jin 已提交
3422
  PERF_TIMER_STOP(get_post_process_time);
3423
  return s;
J
jorlow@chromium.org 已提交
3424 3425
}

3426 3427
std::vector<Status> DBImpl::MultiGet(
    const ReadOptions& options,
3428
    const std::vector<ColumnFamilyHandle*>& column_family,
3429
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3430

L
Lei Jin 已提交
3431
  StopWatch sw(env_, stats_, DB_MULTIGET);
L
Lei Jin 已提交
3432
  PERF_TIMER_AUTO(get_snapshot_time);
K
Kai Liu 已提交
3433

3434
  SequenceNumber snapshot;
3435

3436
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3437
    ColumnFamilyData* cfd;
3438 3439 3440 3441 3442
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3443 3444 3445 3446 3447 3448
    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});
3449 3450 3451
    }
  }

3452
  mutex_.Lock();
3453 3454 3455 3456 3457
  if (options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_;
  } else {
    snapshot = versions_->LastSequence();
  }
3458
  for (auto mgd_iter : multiget_cf_data) {
3459 3460
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3461
  }
3462
  mutex_.Unlock();
3463

3464 3465
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3466

3467
  // Note: this always resizes the values array
3468 3469 3470
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3471 3472

  // Keep track of bytes that we read for statistics-recording later
3473
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3474
  PERF_TIMER_STOP(get_snapshot_time);
3475 3476 3477 3478

  // 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.
3479
  // merge_operands will contain the sequence of merges in the latter case.
3480
  for (size_t i = 0; i < num_keys; ++i) {
3481
    merge_context.Clear();
3482
    Status& s = stat_list[i];
3483 3484 3485
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3486 3487
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3488 3489 3490
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
I
Igor Canadi 已提交
3491 3492
    auto cfd = mgd->cfd;
    if (super_version->mem->Get(lkey, value, &s, merge_context,
I
Igor Canadi 已提交
3493
                                *cfd->options())) {
3494
      // Done
3495
    } else if (super_version->imm->Get(lkey, value, &s, merge_context,
I
Igor Canadi 已提交
3496
                                       *cfd->options())) {
3497 3498
      // Done
    } else {
I
Igor Canadi 已提交
3499
      super_version->current->Get(options, lkey, value, &s, &merge_context);
3500 3501 3502
    }

    if (s.ok()) {
3503
      bytes_read += value->size();
3504 3505 3506 3507
    }
  }

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

I
Igor Canadi 已提交
3511
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3512 3513 3514 3515 3516 3517
  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);
3518 3519
    }
  }
3520 3521 3522 3523 3524 3525 3526
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3527
  }
3528

L
Lei Jin 已提交
3529 3530 3531
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
L
Lei Jin 已提交
3532
  PERF_TIMER_STOP(get_post_process_time);
3533

3534
  return stat_list;
3535 3536
}

3537
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& options,
3538
                                  const std::string& column_family_name,
3539
                                  ColumnFamilyHandle** handle) {
I
Igor Canadi 已提交
3540 3541 3542
  *handle = nullptr;
  MutexLock l(&mutex_);

I
Igor Canadi 已提交
3543 3544
  if (versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name) !=
      nullptr) {
I
Igor Canadi 已提交
3545 3546
    return Status::InvalidArgument("Column family already exists");
  }
3547
  VersionEdit edit;
3548
  edit.AddColumnFamily(column_family_name);
3549 3550
  uint32_t new_id = versions_->GetColumnFamilySet()->GetNextColumnFamilyID();
  edit.SetColumnFamily(new_id);
I
Igor Canadi 已提交
3551
  edit.SetLogNumber(logfile_number_);
I
Igor Canadi 已提交
3552
  edit.SetComparatorName(options.comparator->Name());
3553

I
Igor Canadi 已提交
3554 3555
  // LogAndApply will both write the creation in MANIFEST and create
  // ColumnFamilyData object
3556 3557
  Status s = versions_->LogAndApply(nullptr, &edit, &mutex_,
                                    db_directory_.get(), false, &options);
3558
  if (s.ok()) {
3559
    single_column_family_mode_ = false;
3560 3561 3562
    auto cfd =
        versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
    assert(cfd != nullptr);
3563
    delete cfd->InstallSuperVersion(new SuperVersion(), &mutex_);
3564
    *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
I
Igor Canadi 已提交
3565
    Log(options_.info_log, "Created column family [%s] (ID %u)",
3566
        column_family_name.c_str(), (unsigned)cfd->GetID());
I
Igor Canadi 已提交
3567 3568
    max_total_in_memory_state_ += cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
3569
  } else {
I
Igor Canadi 已提交
3570
    Log(options_.info_log, "Creating column family [%s] FAILED -- %s",
3571 3572
        column_family_name.c_str(), s.ToString().c_str());
  }
3573
  return s;
3574 3575
}

3576 3577 3578 3579
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3580 3581
    return Status::InvalidArgument("Can't drop default column family");
  }
3582

I
Igor Canadi 已提交
3583 3584
  VersionEdit edit;
  edit.DropColumnFamily();
3585 3586
  edit.SetColumnFamily(cfd->GetID());

3587
  Status s;
3588 3589 3590 3591 3592 3593 3594 3595
  {
    MutexLock l(&mutex_);
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
      s = versions_->LogAndApply(cfd, &edit, &mutex_);
    }
3596
  }
3597

3598
  if (s.ok()) {
I
Igor Canadi 已提交
3599
    assert(cfd->IsDropped());
I
Igor Canadi 已提交
3600 3601
    max_total_in_memory_state_ -= cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
3602 3603 3604 3605 3606 3607
    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());
  }

3608
  return s;
3609 3610
}

3611
bool DBImpl::KeyMayExist(const ReadOptions& options,
3612 3613
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
3614
  if (value_found != nullptr) {
K
Kai Liu 已提交
3615 3616
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
3617
  }
3618 3619
  ReadOptions roptions = options;
  roptions.read_tier = kBlockCacheTier; // read from block cache only
3620
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
3621

3622
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
3623 3624 3625
  // 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();
3626 3627
}

3628
Iterator* DBImpl::NewIterator(const ReadOptions& options,
3629 3630 3631
                              ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
3632 3633

  if (options.tailing) {
I
Igor Canadi 已提交
3634 3635 3636 3637
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
L
Lei Jin 已提交
3638
    // TODO(ljin): remove tailing iterator
I
Igor Canadi 已提交
3639
    auto iter = new ForwardIterator(this, options, cfd);
3640 3641 3642
    return NewDBIterator(env_, *cfd->options(), cfd->user_comparator(), iter,
                         kMaxSequenceNumber);
// return new TailingIterator(env_, this, options, cfd);
I
Igor Canadi 已提交
3643
#endif
T
Tomislav Novak 已提交
3644
  } else {
3645 3646 3647 3648
    SequenceNumber latest_snapshot = versions_->LastSequence();
    SuperVersion* sv = nullptr;
    sv = cfd->GetReferencedSuperVersion(&mutex_);

I
Igor Canadi 已提交
3649 3650 3651 3652
    auto snapshot =
        options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_
            : latest_snapshot;
T
Tomislav Novak 已提交
3653

3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703
    // 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 已提交
3704 3705
}

3706 3707
Status DBImpl::NewIterators(
    const ReadOptions& options,
I
Igor Canadi 已提交
3708
    const std::vector<ColumnFamilyHandle*>& column_families,
3709
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726
  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 已提交
3727 3728 3729 3730
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
3731 3732
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
L
Lei Jin 已提交
3733 3734 3735 3736
      auto iter = new ForwardIterator(this, options, cfd);
      iterators->push_back(
          NewDBIterator(env_, *cfd->options(), cfd->user_comparator(), iter,
                        kMaxSequenceNumber));
I
Igor Canadi 已提交
3737
    }
I
Igor Canadi 已提交
3738
#endif
I
Igor Canadi 已提交
3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749
  } 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 已提交
3750
      iter = NewDBIterator(env_, *cfd->options(),
I
Igor Canadi 已提交
3751 3752 3753 3754 3755 3756
                           cfd->user_comparator(), iter, snapshot);
      iterators->push_back(iter);
    }
  }

  return Status::OK();
3757 3758
}

3759 3760 3761 3762 3763 3764 3765 3766 3767
bool DBImpl::IsSnapshotSupported() const {
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (!cfd->mem()->IsSnapshotSupported()) {
      return false;
    }
  }
  return true;
}

J
jorlow@chromium.org 已提交
3768
const Snapshot* DBImpl::GetSnapshot() {
3769
  MutexLock l(&mutex_);
3770 3771
  // returns null if the underlying memtable does not support snapshot.
  if (!IsSnapshotSupported()) return nullptr;
3772
  return snapshots_.New(versions_->LastSequence());
J
jorlow@chromium.org 已提交
3773 3774 3775 3776
}

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

// Convenience methods
3781 3782
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
3783
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
3784 3785
}

3786 3787 3788 3789
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) {
3790 3791
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
3792
    return DB::Merge(o, column_family, key, val);
3793 3794 3795
  }
}

3796
Status DBImpl::Delete(const WriteOptions& options,
3797
                      ColumnFamilyHandle* column_family, const Slice& key) {
3798
  return DB::Delete(options, column_family, key);
J
jorlow@chromium.org 已提交
3799 3800
}

S
Stanislau Hlebik 已提交
3801 3802
// REQUIRES: mutex_ is held
Status DBImpl::BeginWrite(Writer* w, uint64_t expiration_time) {
3803 3804 3805 3806 3807
  // 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 已提交
3808 3809
  mutex_.AssertHeld();
  writers_.push_back(w);
3810 3811

  bool timed_out = false;
S
Stanislau Hlebik 已提交
3812
  while (!w->done && w != writers_.front()) {
3813
    if (expiration_time == 0) {
S
Stanislau Hlebik 已提交
3814 3815 3816
      w->cv.Wait();
    } else if (w->cv.TimedWait(expiration_time)) {
      if (w->in_batch_group) {
3817 3818 3819 3820 3821 3822 3823 3824 3825
        // 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;
      }
    }
3826
  }
3827

S
Stanislau Hlebik 已提交
3828
  if (timed_out) {
3829
#ifndef NDEBUG
3830
    bool found = false;
3831
#endif
3832
    for (auto iter = writers_.begin(); iter != writers_.end(); iter++) {
S
Stanislau Hlebik 已提交
3833
      if (*iter == w) {
3834
        writers_.erase(iter);
3835
#ifndef NDEBUG
3836
        found = true;
3837
#endif
3838 3839 3840
        break;
      }
    }
3841
#ifndef NDEBUG
3842
    assert(found);
3843
#endif
3844 3845 3846 3847 3848 3849
    // 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 已提交
3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906
    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()) {
3907
    mutex_.Unlock();
L
Lei Jin 已提交
3908
    RecordTick(stats_, WRITE_TIMEDOUT);
3909
    return Status::TimedOut();
3910
  }
S
Stanislau Hlebik 已提交
3911 3912 3913 3914 3915 3916 3917 3918 3919 3920
  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);
3921

3922 3923 3924 3925
  // 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.
3926 3927 3928
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

I
Igor Canadi 已提交
3929
  uint64_t flush_column_family_if_log_file = 0;
I
Igor Canadi 已提交
3930
  uint64_t max_total_wal_size = (options_.max_total_wal_size == 0)
3931
                                    ? 4 * max_total_in_memory_state_
I
Igor Canadi 已提交
3932
                                    : options_.max_total_wal_size;
3933
  if (UNLIKELY(!single_column_family_mode_) &&
3934
      alive_log_files_.begin()->getting_flushed == false &&
I
Igor Canadi 已提交
3935 3936 3937 3938
      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,
3939 3940 3941
        "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 已提交
3942 3943
  }

3944 3945
  if (LIKELY(single_column_family_mode_)) {
    // fast path
S
Stanislau Hlebik 已提交
3946 3947
    status = MakeRoomForWrite(default_cf_handle_->cfd(),
                              &context, expiration_time);
3948 3949 3950 3951 3952
  } else {
    // refcounting cfd in iteration
    bool dead_cfd = false;
    for (auto cfd : *versions_->GetColumnFamilySet()) {
      cfd->Ref();
S
Stanislau Hlebik 已提交
3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964
      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);
      }

3965 3966 3967 3968 3969 3970
      if (cfd->Unref()) {
        dead_cfd = true;
      }
      if (!status.ok()) {
        break;
      }
3971
    }
3972 3973
    if (dead_cfd) {
      versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
3974 3975
    }
  }
3976

D
dgrogan@chromium.org 已提交
3977
  uint64_t last_sequence = versions_->LastSequence();
3978
  Writer* last_writer = &w;
S
Stanislau Hlebik 已提交
3979
  if (status.ok()) {
3980 3981
    autovector<WriteBatch*> write_batch_group;
    BuildBatchGroup(&last_writer, &write_batch_group);
3982

3983 3984 3985
    // 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
3986
    // into memtables
3987
    {
3988
      mutex_.Unlock();
3989 3990 3991 3992 3993 3994 3995 3996 3997 3998
      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]);
        }
      }

3999 4000 4001 4002
      const SequenceNumber current_sequence = last_sequence + 1;
      WriteBatchInternal::SetSequence(updates, current_sequence);
      int my_batch_count = WriteBatchInternal::Count(updates);
      last_sequence += my_batch_count;
4003
      const uint64_t batch_size = WriteBatchInternal::ByteSize(updates);
4004
      // Record statistics
L
Lei Jin 已提交
4005 4006
      RecordTick(stats_, NUMBER_KEYS_WRITTEN, my_batch_count);
      RecordTick(stats_, BYTES_WRITTEN, WriteBatchInternal::ByteSize(updates));
4007 4008
      if (options.disableWAL) {
        flush_on_destroy_ = true;
4009
      }
L
Lei Jin 已提交
4010
      PERF_TIMER_STOP(write_pre_and_post_process_time);
4011

4012
      uint64_t log_size = 0;
4013
      if (!options.disableWAL) {
L
Lei Jin 已提交
4014
        PERF_TIMER_START(write_wal_time);
4015 4016
        Slice log_entry = WriteBatchInternal::Contents(updates);
        status = log_->AddRecord(log_entry);
I
Igor Canadi 已提交
4017 4018
        total_log_size_ += log_entry.size();
        alive_log_files_.back().AddSize(log_entry.size());
4019
        log_empty_ = false;
4020
        log_size = log_entry.size();
L
Lei Jin 已提交
4021 4022
        RecordTick(stats_, WAL_FILE_SYNCED);
        RecordTick(stats_, WAL_FILE_BYTES, log_size);
H
heyongqiang 已提交
4023
        if (status.ok() && options.sync) {
4024
          if (options_.use_fsync) {
L
Lei Jin 已提交
4025
            StopWatch(env_, stats_, WAL_FILE_SYNC_MICROS);
4026
            status = log_->file()->Fsync();
4027
          } else {
L
Lei Jin 已提交
4028
            StopWatch(env_, stats_, WAL_FILE_SYNC_MICROS);
4029
            status = log_->file()->Sync();
4030
          }
H
heyongqiang 已提交
4031
        }
L
Lei Jin 已提交
4032
        PERF_TIMER_STOP(write_wal_time);
4033 4034
      }
      if (status.ok()) {
L
Lei Jin 已提交
4035
        PERF_TIMER_START(write_memtable_time);
Y
Yueh-Hsuan Chiang 已提交
4036

4037
        status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
4038
            updates, column_family_memtables_.get(), false, 0, this, false);
Y
Yueh-Hsuan Chiang 已提交
4039 4040 4041 4042 4043 4044 4045 4046
        // 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 已提交
4047
        PERF_TIMER_STOP(write_memtable_time);
4048

L
Lei Jin 已提交
4049
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
4050
      }
L
Lei Jin 已提交
4051
      PERF_TIMER_START(write_pre_and_post_process_time);
4052 4053 4054
      if (updates == &tmp_batch_) {
        tmp_batch_.Clear();
      }
4055
      mutex_.Lock();
4056 4057 4058 4059 4060 4061 4062 4063 4064
      // 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);
      }
4065
      if (status.ok()) {
4066
        versions_->SetLastSequence(last_sequence);
4067
      }
J
jorlow@chromium.org 已提交
4068 4069
    }
  }
4070 4071
  if (options_.paranoid_checks && !status.ok() &&
      !status.IsTimedOut() && bg_error_.ok()) {
I
Igor Canadi 已提交
4072 4073
    bg_error_ = status; // stop compaction & fail any further writes
  }
4074

S
Stanislau Hlebik 已提交
4075
  EndWrite(&w, last_writer, status);
I
Igor Canadi 已提交
4076
  mutex_.Unlock();
4077

4078
  if (status.IsTimedOut()) {
L
Lei Jin 已提交
4079
    RecordTick(stats_, WRITE_TIMEDOUT);
4080 4081
  }

L
Lei Jin 已提交
4082
  PERF_TIMER_STOP(write_pre_and_post_process_time);
J
jorlow@chromium.org 已提交
4083 4084 4085
  return status;
}

4086 4087 4088
// This function will be called only when the first writer succeeds.
// All writers in the to-be-built batch group will be processed.
//
4089
// REQUIRES: Writer list must be non-empty
4090
// REQUIRES: First writer must have a non-nullptr batch
4091 4092
void DBImpl::BuildBatchGroup(Writer** last_writer,
                             autovector<WriteBatch*>* write_batch_group) {
4093 4094
  assert(!writers_.empty());
  Writer* first = writers_.front();
4095
  assert(first->batch != nullptr);
4096 4097

  size_t size = WriteBatchInternal::ByteSize(first->batch);
4098
  write_batch_group->push_back(first->batch);
4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117

  // 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 已提交
4118 4119 4120 4121 4122 4123
    if (!w->disableWAL && first->disableWAL) {
      // Do not include a write that needs WAL into a batch that has
      // WAL disabled.
      break;
    }

4124 4125 4126 4127 4128 4129
    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;
    }

4130
    if (w->batch != nullptr) {
4131 4132 4133 4134 4135 4136
      size += WriteBatchInternal::ByteSize(w->batch);
      if (size > max_size) {
        // Do not make batch too big
        break;
      }

4137
      write_batch_group->push_back(w->batch);
4138
    }
4139
    w->in_batch_group = true;
4140 4141 4142 4143
    *last_writer = w;
  }
}

4144 4145 4146
// 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 已提交
4147 4148 4149 4150
// if n < bottom, return 0;
// if n >= top, return 1000;
// otherwise, let r = (n - bottom) /
//                    (top - bottom)
4151 4152 4153 4154
//  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 已提交
4155
uint64_t DBImpl::SlowdownAmount(int n, double bottom, double top) {
4156
  uint64_t delay;
J
Jim Paton 已提交
4157
  if (n >= top) {
4158 4159
    delay = 1000;
  }
J
Jim Paton 已提交
4160
  else if (n < bottom) {
4161 4162 4163 4164
    delay = 0;
  }
  else {
    // If we are here, we know that:
J
Jim Paton 已提交
4165
    //   level0_start_slowdown <= n < level0_slowdown
4166
    // since the previous two conditions are false.
M
Mark Callaghan 已提交
4167 4168
    double how_much =
      (double) (n - bottom) /
J
Jim Paton 已提交
4169
              (top - bottom);
M
Mark Callaghan 已提交
4170
    delay = std::max(how_much * how_much * 1000, 100.0);
4171 4172 4173 4174 4175
  }
  assert(delay <= 1000);
  return delay;
}

4176
// REQUIRES: mutex_ is held
4177
// REQUIRES: this thread is currently at the front of the writer queue
S
Stanislau Hlebik 已提交
4178 4179 4180
Status DBImpl::MakeRoomForWrite(ColumnFamilyData* cfd,
                                WriteContext* context,
                                uint64_t expiration_time) {
4181
  mutex_.AssertHeld();
4182
  assert(!writers_.empty());
S
Stanislau Hlebik 已提交
4183 4184 4185
  bool allow_delay = true;
  bool allow_hard_rate_limit_delay = true;
  bool allow_soft_rate_limit_delay = true;
4186
  uint64_t rate_limit_delay_millis = 0;
4187
  Status s;
4188
  double score;
4189 4190 4191 4192
  // 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;
4193
  bool has_timeout = (expiration_time > 0);
4194

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

    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_);
4382
      }
4383 4384
    }
  }
S
Stanislau Hlebik 已提交
4385 4386 4387 4388 4389 4390 4391 4392 4393
  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_));
4394 4395 4396
  return s;
}

I
Igor Canadi 已提交
4397
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4398 4399 4400 4401 4402
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4403 4404
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4405
  auto version = cfd->current();
4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
I
Igor Canadi 已提交
4418
#endif  // ROCKSDB_LITE
4419

I
Igor Canadi 已提交
4420 4421 4422 4423
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4424 4425 4426 4427
Env* DBImpl::GetEnv() const {
  return env_;
}

4428 4429
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4430
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4431 4432
}

4433
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4434
                         const Slice& property, std::string* value) {
4435 4436
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4437 4438 4439
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);

4440
  value->clear();
4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455
  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 已提交
4456 4457
}

4458 4459
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
4460 4461
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473
  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) {
4474 4475
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4476 4477 4478

  if (!need_out_of_mutex) {
    MutexLock l(&mutex_);
4479
    return cfd->internal_stats()->GetIntProperty(property_type, value, this);
4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520
  } 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);
  }
4521 4522
}

4523
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4524
                                 const Range* range, int n, uint64_t* sizes) {
J
jorlow@chromium.org 已提交
4525 4526
  // TODO(opt): better implementation
  Version* v;
4527 4528
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
J
jorlow@chromium.org 已提交
4529 4530
  {
    MutexLock l(&mutex_);
4531
    v = cfd->current();
4532
    v->Ref();
J
jorlow@chromium.org 已提交
4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549
  }

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

4550 4551 4552 4553 4554 4555 4556
inline void DBImpl::DelayLoggingAndReset() {
  if (delayed_writes_ > 0) {
    Log(options_.info_log, "delayed %d write...\n", delayed_writes_ );
    delayed_writes_ = 0;
  }
}

I
Igor Canadi 已提交
4557 4558 4559 4560 4561
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
4562
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584
  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();
}

4585 4586 4587
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4588 4589 4590 4591
  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());
4592 4593 4594
    return Status::InvalidArgument("Invalid file name");
  }

4595 4596 4597 4598
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4599 4600
      Log(options_.info_log, "DeleteFile %s failed - not archived log.\n",
          name.c_str());
4601 4602 4603 4604
      return Status::NotSupported("Delete only supported for archived logs");
    }
    status = env_->DeleteFile(options_.wal_dir + "/" + name.c_str());
    if (!status.ok()) {
4605 4606
      Log(options_.info_log, "DeleteFile %s failed -- %s.\n",
          name.c_str(), status.ToString().c_str());
4607 4608 4609 4610
    }
    return status;
  }

4611
  int level;
I
Igor Canadi 已提交
4612
  FileMetaData* metadata;
4613
  ColumnFamilyData* cfd;
4614
  VersionEdit edit;
K
Kai Liu 已提交
4615
  DeletionState deletion_state(true);
D
Dhruba Borthakur 已提交
4616 4617
  {
    MutexLock l(&mutex_);
4618
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
4619
    if (!status.ok()) {
4620 4621
      Log(options_.info_log, "DeleteFile %s failed. File not found\n",
                             name.c_str());
D
Dhruba Borthakur 已提交
4622 4623
      return Status::InvalidArgument("File not found");
    }
I
Igor Canadi 已提交
4624
    assert((level > 0) && (level < cfd->NumberLevels()));
4625

D
Dhruba Borthakur 已提交
4626
    // If the file is being compacted no need to delete.
4627
    if (metadata->being_compacted) {
4628
      Log(options_.info_log,
4629
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
D
Dhruba Borthakur 已提交
4630
      return Status::OK();
4631 4632
    }

D
Dhruba Borthakur 已提交
4633 4634 4635
    // 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 已提交
4636
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
4637
      if (cfd->current()->NumLevelFiles(i) != 0) {
D
Dhruba Borthakur 已提交
4638
        Log(options_.info_log,
4639
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
D
Dhruba Borthakur 已提交
4640 4641 4642 4643
        return Status::InvalidArgument("File not in last level");
      }
    }
    edit.DeleteFile(level, number);
4644
    status = versions_->LogAndApply(cfd, &edit, &mutex_, db_directory_.get());
I
Igor Canadi 已提交
4645
    if (status.ok()) {
4646
      InstallSuperVersion(cfd, deletion_state);
I
Igor Canadi 已提交
4647
    }
I
Igor Canadi 已提交
4648
    FindObsoleteFiles(deletion_state, false);
D
Dhruba Borthakur 已提交
4649
  } // lock released here
I
Igor Canadi 已提交
4650
  LogFlush(options_.info_log);
I
Igor Canadi 已提交
4651
  // remove files outside the db-lock
4652 4653 4654
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
4655 4656 4657 4658 4659 4660
  {
    MutexLock l(&mutex_);
    // schedule flush if file deletion means we freed the space for flushes to
    // continue
    MaybeScheduleFlushOrCompaction();
  }
4661 4662 4663
  return status;
}

4664
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4665
  MutexLock l(&mutex_);
4666
  versions_->GetLiveFilesMetaData(metadata);
4667
}
I
Igor Canadi 已提交
4668
#endif  // ROCKSDB_LITE
4669

I
Igor Canadi 已提交
4670 4671 4672 4673 4674 4675 4676
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
4679 4680 4681 4682 4683 4684
    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) {
4685
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697
                             ". 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);
  }
}

4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724
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 已提交
4725 4726
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
4727
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
4728
               const Slice& key, const Slice& value) {
4729 4730 4731 4732
  // 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);
4733
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
4734 4735 4736
  return Write(opt, &batch);
}

4737 4738
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
4739
  WriteBatch batch;
4740
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
4741 4742 4743
  return Write(opt, &batch);
}

4744 4745
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
4746
  WriteBatch batch;
4747
  batch.Merge(column_family, key, value);
4748 4749 4750
  return Write(opt, &batch);
}

4751 4752
// Default implementation -- returns not supported status
Status DB::CreateColumnFamily(const ColumnFamilyOptions& options,
4753
                              const std::string& column_family_name,
4754
                              ColumnFamilyHandle** handle) {
4755
  return Status::NotSupported("");
4756
}
4757
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
4758
  return Status::NotSupported("");
4759 4760
}

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

J
Jim Paton 已提交
4763
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
4764 4765 4766 4767
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
4768
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
4769
  std::vector<ColumnFamilyHandle*> handles;
4770 4771 4772 4773 4774
  Status s = SanitizeDBOptionsByCFOptions(&db_options, column_families);
  if (!s.ok()) {
    return s;
  }
  s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
4775 4776 4777 4778 4779 4780 4781
  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;
4782 4783
}

4784 4785
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
4786
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
4787
  if (db_options.db_paths.size() > 1) {
4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799
    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. ");
    }
4800 4801
  }

4802
  *dbptr = nullptr;
4803
  handles->clear();
J
jorlow@chromium.org 已提交
4804

I
Igor Canadi 已提交
4805 4806 4807 4808
  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);
4809
  }
4810

I
Igor Canadi 已提交
4811
  DBImpl* impl = new DBImpl(db_options, dbname);
4812
  Status s = impl->env_->CreateDirIfMissing(impl->options_.wal_dir);
4813
  if (s.ok()) {
4814 4815
    for (auto db_path : impl->options_.db_paths) {
      s = impl->env_->CreateDirIfMissing(db_path.path);
4816 4817 4818 4819 4820 4821
      if (!s.ok()) {
        break;
      }
    }
  }

4822 4823 4824 4825 4826 4827
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
4828 4829 4830 4831
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
4832
  impl->mutex_.Lock();
4833 4834
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
4835
  if (s.ok()) {
4836
    uint64_t new_log_number = impl->versions_->NewFileNumber();
4837
    unique_ptr<WritableFile> lfile;
4838
    EnvOptions soptions(db_options);
4839
    s = impl->options_.env->NewWritableFile(
I
Igor Canadi 已提交
4840
        LogFileName(impl->options_.wal_dir, new_log_number), &lfile,
I
Igor Canadi 已提交
4841
        impl->options_.env->OptimizeForLogWrite(soptions));
J
jorlow@chromium.org 已提交
4842
    if (s.ok()) {
4843
      lfile->SetPreallocationBlockSize(1.1 * max_write_buffer_size);
4844
      impl->logfile_number_ = new_log_number;
4845
      impl->log_.reset(new log::Writer(std::move(lfile)));
I
Igor Canadi 已提交
4846

4847 4848
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
4849 4850
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869
        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 已提交
4870
        }
4871
      }
I
Igor Canadi 已提交
4872 4873
    }
    if (s.ok()) {
4874
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
4875
        delete cfd->InstallSuperVersion(new SuperVersion(), &impl->mutex_);
4876
      }
I
Igor Canadi 已提交
4877 4878
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
4879
      impl->DeleteObsoleteFiles();
4880
      impl->MaybeScheduleFlushOrCompaction();
4881
      s = impl->db_directory_->Fsync();
J
jorlow@chromium.org 已提交
4882 4883
    }
  }
4884

I
Igor Canadi 已提交
4885 4886
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
4887 4888
      if (cfd->options()->compaction_style == kCompactionStyleUniversal ||
          cfd->options()->compaction_style == kCompactionStyleFIFO) {
I
Igor Canadi 已提交
4889 4890 4891 4892
        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 已提交
4893 4894 4895
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
                "open with universal or FIFO compaction style.");
I
Igor Canadi 已提交
4896 4897 4898 4899
            break;
          }
        }
      }
4900 4901 4902 4903 4904 4905
      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 已提交
4906
      if (!s.ok()) {
4907 4908 4909 4910 4911
        break;
      }
    }
  }

4912 4913
  impl->mutex_.Unlock();

J
jorlow@chromium.org 已提交
4914
  if (s.ok()) {
4915
    impl->opened_successfully_ = true;
J
jorlow@chromium.org 已提交
4916 4917
    *dbptr = impl;
  } else {
4918 4919 4920
    for (auto h : *handles) {
      delete h;
    }
4921
    handles->clear();
J
jorlow@chromium.org 已提交
4922 4923 4924 4925 4926
    delete impl;
  }
  return s;
}

4927 4928 4929
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
4930
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
4931 4932
}

4933 4934 4935
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
4936
Status DestroyDB(const std::string& dbname, const Options& options) {
4937
  const InternalKeyComparator comparator(options.comparator);
4938
  const Options& soptions(SanitizeOptions(dbname, &comparator, options));
4939
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
4940
  std::vector<std::string> filenames;
4941 4942
  std::vector<std::string> archiveFiles;

4943
  std::string archivedir = ArchivalDirectory(dbname);
J
jorlow@chromium.org 已提交
4944 4945
  // Ignore error in case directory does not exist
  env->GetChildren(dbname, &filenames);
4946 4947 4948 4949 4950 4951 4952

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

J
jorlow@chromium.org 已提交
4954 4955 4956 4957 4958
  if (filenames.empty()) {
    return Status::OK();
  }

  FileLock* lock;
4959 4960
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
4961 4962 4963
  if (result.ok()) {
    uint64_t number;
    FileType type;
4964
    InfoLogPrefix info_log_prefix(!options.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
4965
    for (size_t i = 0; i < filenames.size(); i++) {
4966
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
4967
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
4968 4969 4970
        Status del;
        if (type == kMetaDatabase) {
          del = DestroyDB(dbname + "/" + filenames[i], options);
4971 4972
        } else if (type == kLogFile) {
          del = env->DeleteFile(soptions.wal_dir + "/" + filenames[i]);
K
Kosie van der Merwe 已提交
4973 4974 4975
        } else {
          del = env->DeleteFile(dbname + "/" + filenames[i]);
        }
J
jorlow@chromium.org 已提交
4976 4977 4978 4979 4980
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4981

4982 4983
    for (auto& db_path : options.db_paths) {
      env->GetChildren(db_path.path, &filenames);
4984 4985 4986 4987 4988
      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
4989
          Status del = env->DeleteFile(db_path.path + "/" + filenames[i]);
4990 4991 4992 4993 4994 4995 4996
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

4997
    env->GetChildren(archivedir, &archiveFiles);
4998 4999
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
5000 5001
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
5002
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
5003 5004 5005 5006 5007
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
5008
    // ignore case where no archival directory is present.
5009
    env->DeleteDir(archivedir);
5010

J
jorlow@chromium.org 已提交
5011
    env->UnlockFile(lock);  // Ignore error since state is already gone
5012
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
5013
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
5014
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
5015 5016 5017 5018
  }
  return result;
}

5019 5020
//
// A global method that can dump out the build version
K
kailiu 已提交
5021
void DumpLeveldbBuildVersion(Logger * log) {
I
Igor Canadi 已提交
5022 5023
#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
5024
  Log(log, "Git sha %s", rocksdb_build_git_sha);
5025
  Log(log, "Compile time %s %s",
5026
      rocksdb_build_compile_time, rocksdb_build_compile_date);
I
Igor Canadi 已提交
5027
#endif
5028 5029
}

5030
}  // namespace rocksdb