db_impl.cc 173.2 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"

L
liuhuahang 已提交
12
#ifndef __STDC_FORMAT_MACROS
I
Igor Canadi 已提交
13
#define __STDC_FORMAT_MACROS
L
liuhuahang 已提交
14 15
#endif

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

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

75
namespace rocksdb {
J
jorlow@chromium.org 已提交
76

77
const std::string kDefaultColumnFamilyName("default");
78

I
Igor Canadi 已提交
79
void DumpRocksDBBuildVersion(Logger * log);
80

S
Stanislau Hlebik 已提交
81 82 83 84 85 86 87 88 89 90 91 92 93 94
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 已提交
95 96 97
struct DBImpl::CompactionState {
  Compaction* const compaction;

98 99 100 101 102
  // 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 已提交
103 104 105 106

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

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

  uint64_t total_bytes;

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

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

128 129 130 131 132 133 134 135
  // 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;
  }

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

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

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

Options SanitizeOptions(const std::string& dbname,
                        const InternalKeyComparator* icmp,
                        const Options& src) {
240
  auto db_options = SanitizeOptions(dbname, DBOptions(src));
241
  auto cf_options = SanitizeOptions(icmp, ColumnFamilyOptions(src));
242 243 244 245 246
  return Options(db_options, cf_options);
}

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

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

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

262 263 264 265 266 267
  if (!result.rate_limiter) {
    if (result.bytes_per_sync == 0) {
      result.bytes_per_sync = 1024 * 1024;
    }
  }

268 269 270 271
  if (result.wal_dir.empty()) {
    // Use dbname as default
    result.wal_dir = dbname;
  }
272
  if (result.wal_dir.back() == '/') {
I
Igor Canadi 已提交
273
    result.wal_dir = result.wal_dir.substr(0, result.wal_dir.size() - 1);
274
  }
275

276
  if (result.db_paths.size() == 0) {
277
    result.db_paths.emplace_back(dbname, std::numeric_limits<uint64_t>::max());
278 279
  }

J
jorlow@chromium.org 已提交
280 281 282
  return result;
}

283 284
namespace {

285 286
Status SanitizeOptionsByTable(
    const DBOptions& db_opts,
287 288 289
    const std::vector<ColumnFamilyDescriptor>& column_families) {
  Status s;
  for (auto cf : column_families) {
290
    s = cf.options.table_factory->SanitizeOptions(db_opts, cf.options);
291 292 293 294 295 296 297
    if (!s.ok()) {
      return s;
    }
  }
  return Status::OK();
}

298
CompressionType GetCompressionFlush(const ImmutableCFOptions& ioptions) {
299 300 301 302 303 304
  // 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;

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

  if (can_compress) {
315
    return ioptions.compression;
316 317 318 319
  } else {
    return kNoCompression;
  }
}
320
}  // namespace
321

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

J
jorlow@chromium.org 已提交
354
  // Reserve ten files or so for other uses and give the rest to TableCache.
355
  // Give a large number for setting of "infinite" open files.
356 357
  const int table_cache_size = (db_options_.max_open_files == -1) ?
        4194304 : db_options_.max_open_files - 10;
358 359
  // Reserve ten files or so for other uses and give the rest to TableCache.
  table_cache_ =
360 361
      NewLRUCache(table_cache_size, db_options_.table_cache_numshardbits,
                  db_options_.table_cache_remove_scan_count_limit);
362

363 364
  versions_.reset(new VersionSet(dbname_, &db_options_, env_options_,
                                 table_cache_.get(), &write_controller_));
I
Igor Canadi 已提交
365 366
  column_family_memtables_.reset(new ColumnFamilyMemTablesImpl(
      versions_->GetColumnFamilySet(), &flush_scheduler_));
367

I
Igor Canadi 已提交
368
  DumpRocksDBBuildVersion(db_options_.info_log.get());
369 370
  DumpDBFileSummary(db_options_, dbname_);
  db_options_.Dump(db_options_.info_log.get());
371

372
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
373 374 375
}

DBImpl::~DBImpl() {
376 377 378
  mutex_.Lock();
  if (flush_on_destroy_) {
    for (auto cfd : *versions_->GetColumnFamilySet()) {
379
      if (!cfd->mem()->IsEmpty()) {
380 381 382 383
        cfd->Ref();
        mutex_.Unlock();
        FlushMemTable(cfd, FlushOptions());
        mutex_.Lock();
384
        cfd->Unref();
385 386
      }
    }
387
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
388
  }
I
Igor Canadi 已提交
389 390

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

I
Igor Canadi 已提交
396 397
  flush_scheduler_.Clear();

I
Igor Canadi 已提交
398 399 400 401 402
  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();
403 404
  }

I
Igor Canadi 已提交
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
  // 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;
    if (deletion_state.HaveSomethingToDelete()) {
      PurgeObsoleteFiles(deletion_state);
421 422 423
    }
  }

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

432
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
433 434 435
}

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

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

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

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

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

491
void DBImpl::MaybeDumpStats() {
492
  if (db_options_.stats_dump_period_sec == 0) return;
H
Haobo Xu 已提交
493 494 495 496

  const uint64_t now_micros = env_->NowMicros();

  if (last_stats_dump_time_microsec_ +
497
      db_options_.stats_dump_period_sec * 1000000
H
Haobo Xu 已提交
498 499 500 501 502 503
      <= 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;
504

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

524
    PrintStatistics();
525 526 527
  }
}

528
// Returns the list of live files in 'sst_live' and the list
K
kailiu 已提交
529
// of all files in the filesystem in 'candidate_files'.
I
Igor Canadi 已提交
530 531
// no_full_scan = true -- never do the full scan using GetChildren()
// force = false -- don't force the full scan, except every
532
//  db_options_.delete_obsolete_files_period_micros
I
Igor Canadi 已提交
533 534 535 536
// force = true -- force the full scan
void DBImpl::FindObsoleteFiles(DeletionState& deletion_state,
                               bool force,
                               bool no_full_scan) {
D
Dhruba Borthakur 已提交
537 538
  mutex_.AssertHeld();

539
  // if deletion is disabled, do nothing
540
  if (disable_delete_obsolete_files_ > 0) {
541 542 543
    return;
  }

544 545 546 547 548
  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;
549
  } else if (force || db_options_.delete_obsolete_files_period_micros == 0) {
550 551 552 553
    doing_the_full_scan = true;
  } else {
    const uint64_t now_micros = env_->NowMicros();
    if (delete_obsolete_files_last_run_ +
554
        db_options_.delete_obsolete_files_period_micros < now_micros) {
555 556 557 558 559
      doing_the_full_scan = true;
      delete_obsolete_files_last_run_ = now_micros;
    }
  }

I
Igor Canadi 已提交
560 561 562
  // get obsolete files
  versions_->GetObsoleteFiles(&deletion_state.sst_delete_files);

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

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

585
  if (doing_the_full_scan) {
586 587
    for (uint32_t path_id = 0;
         path_id < db_options_.db_paths.size(); path_id++) {
588 589 590
      // set of all files in the directory. We'll exclude files that are still
      // alive in the subsequent processings.
      std::vector<std::string> files;
591
      env_->GetChildren(db_options_.db_paths[path_id].path,
592
                        &files);  // Ignore errors
593
      for (std::string file : files) {
I
Igor Canadi 已提交
594 595
        // TODO(icanadi) clean up this mess to avoid having one-off "/" prefixes
        deletion_state.candidate_files.emplace_back("/" + file, path_id);
596 597
      }
    }
598 599

    //Add log files in wal_dir
600
    if (db_options_.wal_dir != dbname_) {
601
      std::vector<std::string> log_files;
602
      env_->GetChildren(db_options_.wal_dir, &log_files);  // Ignore errors
603
      for (std::string log_file : log_files) {
604 605 606
        deletion_state.candidate_files.emplace_back(log_file, 0);
      }
    }
607
    // Add info log files in db_log_dir
608
    if (!db_options_.db_log_dir.empty() && db_options_.db_log_dir != dbname_) {
609
      std::vector<std::string> info_log_files;
610 611
      // Ignore errors
      env_->GetChildren(db_options_.db_log_dir, &info_log_files);
612 613 614 615
      for (std::string log_file : info_log_files) {
        deletion_state.candidate_files.emplace_back(log_file, 0);
      }
    }
616
  }
617 618
}

619 620 621 622 623 624 625 626
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 {
627
    return (first.path_id > second.path_id);
628 629 630 631
  }
}
};  // namespace

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

I
Igor Canadi 已提交
640 641 642 643
  // 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 已提交
644 645
    return;
  }
646

647
  // Now, convert live list to an unordered map, WITHOUT mutex held;
648
  // set is slow.
649 650 651 652
  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 已提交
653

K
kailiu 已提交
654 655 656 657 658 659 660
  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 = "";
661
  for (auto file : state.sst_delete_files) {
662 663 664
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
665
    delete file;
I
Igor Canadi 已提交
666 667
  }

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

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

681
  std::vector<std::string> old_info_log_files;
682
  InfoLogPrefix info_log_prefix(!db_options_.db_log_dir.empty(), dbname_);
683 684 685
  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 已提交
686 687 688
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
689
    if (!ParseFileName(to_delete, &number, info_log_prefix.prefix, &type)) {
K
kailiu 已提交
690 691
      continue;
    }
J
jorlow@chromium.org 已提交
692

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

    if (keep) {
      continue;
    }

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

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

763
  // Delete old info log files.
764
  size_t old_info_log_file_count = old_info_log_files.size();
765
  if (old_info_log_file_count >= db_options_.keep_log_file_num) {
766
    std::sort(old_info_log_files.begin(), old_info_log_files.end());
767
    size_t end = old_info_log_file_count - db_options_.keep_log_file_num;
768
    for (unsigned int i = 0; i <= end; i++) {
769
      std::string& to_delete = old_info_log_files.at(i);
770 771 772
      std::string full_path_to_delete = (db_options_.db_log_dir.empty() ?
           dbname_ : db_options_.db_log_dir) + "/" + to_delete;
      Log(db_options_.info_log, "Delete info log file %s\n",
773 774
          full_path_to_delete.c_str());
      Status s = env_->DeleteFile(full_path_to_delete);
775
      if (!s.ok()) {
776
        Log(db_options_.info_log, "Delete info log file %s FAILED -- %s\n",
777 778
            to_delete.c_str(), s.ToString().c_str());
      }
H
heyongqiang 已提交
779 780
    }
  }
781
  PurgeObsoleteWALFiles();
782
  LogFlush(db_options_.info_log);
D
Dhruba Borthakur 已提交
783 784 785 786 787
}

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
  DeletionState deletion_state;
I
Igor Canadi 已提交
788
  FindObsoleteFiles(deletion_state, true);
789 790 791
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
792 793
}

I
Igor Canadi 已提交
794
#ifndef ROCKSDB_LITE
795 796 797 798 799 800 801 802
// 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
803
void DBImpl::PurgeObsoleteWALFiles() {
804 805
  bool const ttl_enabled = db_options_.WAL_ttl_seconds > 0;
  bool const size_limit_enabled =  db_options_.WAL_size_limit_MB > 0;
806 807 808 809
  if (!ttl_enabled && !size_limit_enabled) {
    return;
  }

810 811
  int64_t current_time;
  Status s = env_->GetCurrentTime(&current_time);
812
  if (!s.ok()) {
813 814
    Log(db_options_.info_log, "Can't get current time: %s",
        s.ToString().c_str());
815 816 817 818 819
    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) ?
820
    db_options_.WAL_ttl_seconds / 2 : default_interval_to_delete_obsolete_WAL_;
821

822 823 824 825 826 827
  if (purge_wal_files_last_run_ + time_to_check > now_seconds) {
    return;
  }

  purge_wal_files_last_run_ = now_seconds;

828
  std::string archival_dir = ArchivalDirectory(db_options_.wal_dir);
829 830 831
  std::vector<std::string> files;
  s = env_->GetChildren(archival_dir, &files);
  if (!s.ok()) {
832 833
    Log(db_options_.info_log, "Can't get archive files: %s",
        s.ToString().c_str());
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
    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()) {
851
          Log(db_options_.info_log, "Can't get file mod time: %s: %s",
852 853 854
              file_path.c_str(), s.ToString().c_str());
          continue;
        }
855
        if (now_seconds - file_m_time > db_options_.WAL_ttl_seconds) {
856 857
          Status const s = env_->DeleteFile(file_path);
          if (!s.ok()) {
858
            Log(db_options_.info_log, "Can't delete file: %s: %s",
859 860
                file_path.c_str(), s.ToString().c_str());
            continue;
I
Igor Canadi 已提交
861 862 863
          } else {
            MutexLock l(&read_first_record_cache_mutex_);
            read_first_record_cache_.erase(number);
864 865
          }
          continue;
866
        }
867 868 869 870 871 872
      }

      if (size_limit_enabled) {
        uint64_t file_size;
        Status const s = env_->GetFileSize(file_path, &file_size);
        if (!s.ok()) {
873
          Log(db_options_.info_log, "Can't get file size: %s: %s",
874 875 876 877 878 879 880 881 882
              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()) {
883
              Log(db_options_.info_log, "Can't delete file: %s: %s",
884 885
                  file_path.c_str(), s.ToString().c_str());
              continue;
I
Igor Canadi 已提交
886 887 888
            } else {
              MutexLock l(&read_first_record_cache_mutex_);
              read_first_record_cache_.erase(number);
889 890 891 892 893 894 895 896 897 898 899
            }
          }
        }
      }
    }
  }

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

900
  size_t const files_keep_num = db_options_.WAL_size_limit_MB *
901 902 903 904 905 906 907
    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;
908
  GetSortedWalsOfType(archival_dir, archived_logs, kArchivedLogFile);
909 910

  if (files_del_num > archived_logs.size()) {
911
    Log(db_options_.info_log, "Trying to delete more archived log files than "
912 913 914 915 916 917 918 919
        "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()) {
920
      Log(db_options_.info_log, "Can't delete file: %s: %s",
921 922
          file_path.c_str(), s.ToString().c_str());
      continue;
I
Igor Canadi 已提交
923 924 925
    } else {
      MutexLock l(&read_first_record_cache_mutex_);
      read_first_record_cache_.erase(archived_logs[i]->LogNumber());
926 927
    }
  }
D
Dhruba Borthakur 已提交
928 929
}

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

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

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

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

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

I
Igor Canadi 已提交
1050 1051
// the function returns status.ok() and sequence == 0 if the file exists, but is
// empty
I
Igor Canadi 已提交
1052
Status DBImpl::ReadFirstLine(const std::string& fname,
I
Igor Canadi 已提交
1053
                             SequenceNumber* sequence) {
I
Igor Canadi 已提交
1054 1055 1056 1057 1058 1059
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
    Logger* info_log;
    const char* fname;

    Status* status;
1060
    bool ignore_error;  // true if db_options_.paranoid_checks==false
I
Igor Canadi 已提交
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
    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;
L
Lei Jin 已提交
1073
  Status status = env_->NewSequentialFile(fname, &file, env_options_);
I
Igor Canadi 已提交
1074 1075 1076 1077 1078 1079 1080

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

  LogReporter reporter;
  reporter.env = env_;
1081
  reporter.info_log = db_options_.info_log.get();
I
Igor Canadi 已提交
1082 1083
  reporter.fname = fname.c_str();
  reporter.status = &status;
1084
  reporter.ignore_error = !db_options_.paranoid_checks;
I
Igor Canadi 已提交
1085 1086 1087 1088 1089 1090
  log::Reader reader(std::move(file), &reporter, true /*checksum*/,
                     0 /*initial_offset*/);
  std::string scratch;
  Slice record;

  if (reader.ReadRecord(&record, &scratch) &&
1091
      (status.ok() || !db_options_.paranoid_checks)) {
I
Igor Canadi 已提交
1092 1093 1094 1095 1096
    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 已提交
1097 1098 1099
      WriteBatch batch;
      WriteBatchInternal::SetContents(&batch, record);
      *sequence = WriteBatchInternal::Sequence(&batch);
I
Igor Canadi 已提交
1100 1101 1102 1103
      return Status::OK();
    }
  }

I
Igor Canadi 已提交
1104 1105 1106
  // 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 已提交
1107 1108 1109 1110 1111
  return status;
}

#endif  // ROCKSDB_LITE

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

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

1132
    for (auto& db_path : db_options_.db_paths) {
1133
      s = env_->CreateDirIfMissing(db_path.path);
1134 1135 1136 1137 1138
      if (!s.ok()) {
        return s;
      }
    }

1139 1140 1141 1142 1143
    s = env_->NewDirectory(dbname_, &db_directory_);
    if (!s.ok()) {
      return s;
    }

1144
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
1145 1146 1147
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
1148

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

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

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

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

H
heyongqiang 已提交
1218 1219 1220 1221 1222 1223
    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");
    }

S
Stanislau Hlebik 已提交
1224 1225 1226 1227 1228 1229 1230
    if (!logs.empty()) {
      // Recover in the order in which the logs were generated
      std::sort(logs.begin(), logs.end());
      s = RecoverLogFiles(logs, &max_sequence, read_only);
      if (!s.ok()) {
        // Clear memtables if recovery failed
        for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1231
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions());
S
Stanislau Hlebik 已提交
1232 1233
        }
      }
1234
    }
L
Lei Jin 已提交
1235
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1236 1237
  }

L
Lei Jin 已提交
1238 1239
  // Initial value
  max_total_in_memory_state_ = 0;
I
Igor Canadi 已提交
1240
  for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1241 1242 1243
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ += mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
I
Igor Canadi 已提交
1244 1245
  }

J
jorlow@chromium.org 已提交
1246 1247 1248
  return s;
}

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

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

S
Stanislau Hlebik 已提交
1276 1277 1278 1279 1280 1281 1282 1283 1284
  for (auto log_number : log_numbers) {
    // 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.
    versions_->MarkFileNumberUsed(log_number);
    // Open the log file
    std::string fname = LogFileName(db_options_.wal_dir, log_number);
    unique_ptr<SequentialFile> file;
    status = env_->NewSequentialFile(fname, &file, env_options_);
J
jorlow@chromium.org 已提交
1285
    if (!status.ok()) {
S
Stanislau Hlebik 已提交
1286 1287 1288 1289 1290 1291 1292 1293
      MaybeIgnoreError(&status);
      if (!status.ok()) {
        return status;
      } else {
        // Fail with one log file, but that's ok.
        // Try next one.
        continue;
      }
J
jorlow@chromium.org 已提交
1294 1295
    }

S
Stanislau Hlebik 已提交
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
    // Create the log reader.
    LogReporter reporter;
    reporter.env = env_;
    reporter.info_log = db_options_.info_log.get();
    reporter.fname = fname.c_str();
    reporter.status =
        (db_options_.paranoid_checks && !db_options_.skip_log_error_on_recovery
             ? &status
             : nullptr);
    // 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).
    log::Reader reader(std::move(file), &reporter, true /*checksum*/,
                       0 /*initial_offset*/);
    Log(db_options_.info_log, "Recovering log #%" PRIu64 "", log_number);

    // Read all the records and add to a memtable
    std::string scratch;
    Slice record;
    WriteBatch batch;
    while (reader.ReadRecord(&record, &scratch)) {
      if (record.size() < 12) {
        reporter.Corruption(record.size(),
                            Status::Corruption("log record too small"));
        continue;
      }
      WriteBatchInternal::SetContents(&batch, record);

      // If column family was not found, it might mean that the WAL write
      // batch references to the column family that was dropped after the
      // insert. We don't want to fail the whole write batch in that case --
      // we just ignore the update.
      // That's why we set ignore missing column families to true
      status = WriteBatchInternal::InsertInto(
          &batch, column_family_memtables_.get(), true, log_number);

      MaybeIgnoreError(&status);
      if (!status.ok()) {
        return status;
      }
      const SequenceNumber last_seq = WriteBatchInternal::Sequence(&batch) +
                                      WriteBatchInternal::Count(&batch) - 1;
      if (last_seq > *max_sequence) {
        *max_sequence = last_seq;
      }

      if (!read_only) {
I
Igor Canadi 已提交
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
        // we can do this because this is called before client has access to the
        // DB and there is only a single thread operating on DB
        ColumnFamilyData* cfd;

        while ((cfd = flush_scheduler_.GetNextColumnFamily()) != nullptr) {
          cfd->Unref();
          // If this asserts, it means that InsertInto failed in
          // filtering updates to already-flushed column families
          assert(cfd->GetLogNumber() <= log_number);
          auto iter = version_edits.find(cfd->GetID());
          assert(iter != version_edits.end());
          VersionEdit* edit = &iter->second;
          status = WriteLevel0TableForRecovery(cfd, cfd->mem(), edit);
          if (!status.ok()) {
            // Reflect errors immediately so that conditions like full
            // file-systems cause the DB::Open() to fail.
            return status;
1361
          }
L
Lei Jin 已提交
1362
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions());
1363
        }
J
jorlow@chromium.org 已提交
1364 1365 1366
      }
    }

I
Igor Canadi 已提交
1367
    flush_scheduler_.Clear();
S
Stanislau Hlebik 已提交
1368 1369 1370
    if (versions_->LastSequence() < *max_sequence) {
      versions_->SetLastSequence(*max_sequence);
    }
1371 1372
  }

1373
  if (!read_only) {
1374 1375
    // no need to refcount since client still doesn't have access
    // to the DB and can not drop column families while we iterate
S
Stanislau Hlebik 已提交
1376
    auto max_log_number = log_numbers.back();
1377
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1378
      auto iter = version_edits.find(cfd->GetID());
1379 1380 1381
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

S
Stanislau Hlebik 已提交
1382
      if (cfd->GetLogNumber() > max_log_number) {
1383
        // Column family cfd has already flushed the data
S
Stanislau Hlebik 已提交
1384
        // from all logs. Memtable has to be empty because
1385
        // we filter the updates based on log_number
1386
        // (in WriteBatch::InsertInto)
1387 1388 1389 1390 1391 1392 1393
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1394
        status = WriteLevel0TableForRecovery(cfd, cfd->mem(), edit);
S
Stanislau Hlebik 已提交
1395 1396 1397 1398
        if (!status.ok()) {
          // Recovery failed
          break;
        }
L
Lei Jin 已提交
1399
        cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions());
1400
      }
J
jorlow@chromium.org 已提交
1401

1402
      // write MANIFEST with update
S
Stanislau Hlebik 已提交
1403
      // writing log_number in the manifest means that any log file
1404 1405
      // with number strongly less than (log_number + 1) is already
      // recovered and should be ignored on next reincarnation.
S
Stanislau Hlebik 已提交
1406 1407 1408
      // Since we already recovered max_log_number, we want all logs
      // with numbers `<= max_log_number` (includes this one) to be ignored
      edit->SetLogNumber(max_log_number + 1);
1409 1410 1411
      // 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 已提交
1412
      // log number
S
Stanislau Hlebik 已提交
1413
      versions_->MarkFileNumberUsed(max_log_number + 1);
1414 1415
      status = versions_->LogAndApply(
          cfd, *cfd->GetLatestMutableCFOptions(), edit, &mutex_);
1416
      if (!status.ok()) {
S
Stanislau Hlebik 已提交
1417 1418
        // Recovery failed
        break;
1419 1420
      }
    }
1421
  }
I
Igor Canadi 已提交
1422

J
jorlow@chromium.org 已提交
1423 1424 1425
  return status;
}

1426 1427
Status DBImpl::WriteLevel0TableForRecovery(ColumnFamilyData* cfd, MemTable* mem,
                                           VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1428
  mutex_.AssertHeld();
1429
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1430
  FileMetaData meta;
1431 1432
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
  pending_outputs_[meta.fd.GetNumber()] = 0;  // path 0 for level 0 file.
1433 1434
  ReadOptions ro;
  ro.total_order_seek = true;
1435
  Arena arena;
1436 1437
  Status s;
  {
1438 1439 1440 1441
    ScopedArenaIterator iter(mem->NewIterator(ro, &arena));
    const SequenceNumber newest_snapshot = snapshots_.GetNewest();
    const SequenceNumber earliest_seqno_in_memtable =
        mem->GetFirstSequenceNumber();
1442
    Log(db_options_.info_log, "[%s] Level-0 table #%" PRIu64 ": started",
1443
        cfd->GetName().c_str(), meta.fd.GetNumber());
1444

1445 1446 1447 1448 1449
    {
      mutex_.Unlock();
      s = BuildTable(
          dbname_, env_, *cfd->ioptions(), env_options_, cfd->table_cache(),
          iter.get(), &meta, cfd->internal_comparator(), newest_snapshot,
1450 1451
          earliest_seqno_in_memtable, GetCompressionFlush(*cfd->ioptions()),
          cfd->ioptions()->compression_opts, Env::IO_HIGH);
1452
      LogFlush(db_options_.info_log);
1453 1454
      mutex_.Lock();
    }
1455

1456
    Log(db_options_.info_log,
1457 1458 1459 1460
        "[%s] Level-0 table #%" PRIu64 ": %" PRIu64 " bytes %s",
        cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
        s.ToString().c_str());
  }
1461
  pending_outputs_.erase(meta.fd.GetNumber());
1462 1463 1464 1465

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1466
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1467 1468 1469
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1470 1471
  }

L
Lei Jin 已提交
1472
  InternalStats::CompactionStats stats(1);
1473
  stats.micros = env_->NowMicros() - start_micros;
1474
  stats.bytes_written = meta.fd.GetFileSize();
M
Mark Callaghan 已提交
1475
  stats.files_out_levelnp1 = 1;
1476
  cfd->internal_stats()->AddCompactionStats(level, stats);
1477 1478
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1479
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1480 1481 1482
  return s;
}

1483
Status DBImpl::WriteLevel0Table(ColumnFamilyData* cfd,
1484 1485 1486
    const MutableCFOptions& mutable_cf_options,
    const autovector<MemTable*>& mems,
    VersionEdit* edit, uint64_t* filenumber, LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
1487
  mutex_.AssertHeld();
1488 1489
  const uint64_t start_micros = env_->NowMicros();
  FileMetaData meta;
1490 1491

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

1495 1496
  const SequenceNumber newest_snapshot = snapshots_.GetNewest();
  const SequenceNumber earliest_seqno_in_memtable =
1497
    mems[0]->GetFirstSequenceNumber();
1498
  Version* base = cfd->current();
1499
  base->Ref();          // it is likely that we do not need this reference
1500 1501 1502
  Status s;
  {
    mutex_.Unlock();
H
Haobo Xu 已提交
1503
    log_buffer->FlushBufferToLog();
K
Kai Liu 已提交
1504
    std::vector<Iterator*> memtables;
1505 1506
    ReadOptions ro;
    ro.total_order_seek = true;
1507
    Arena arena;
1508
    for (MemTable* m : mems) {
1509
      Log(db_options_.info_log,
1510 1511
          "[%s] Flushing memtable with next log file: %" PRIu64 "\n",
          cfd->GetName().c_str(), m->GetNextLogNumber());
1512 1513 1514 1515 1516 1517
      memtables.push_back(m->NewIterator(ro, &arena));
    }
    {
      ScopedArenaIterator iter(NewMergingIterator(&cfd->internal_comparator(),
                                                  &memtables[0],
                                                  memtables.size(), &arena));
1518 1519
      Log(db_options_.info_log,
           "[%s] Level-0 flush table #%" PRIu64 ": started",
1520 1521 1522 1523 1524
          cfd->GetName().c_str(), meta.fd.GetNumber());

      s = BuildTable(
          dbname_, env_, *cfd->ioptions(), env_options_, cfd->table_cache(),
          iter.get(), &meta, cfd->internal_comparator(), newest_snapshot,
1525 1526
          earliest_seqno_in_memtable, GetCompressionFlush(*cfd->ioptions()),
          cfd->ioptions()->compression_opts, Env::IO_HIGH);
1527
      LogFlush(db_options_.info_log);
1528
    }
1529
    Log(db_options_.info_log,
1530
        "[%s] Level-0 flush table #%" PRIu64 ": %" PRIu64 " bytes %s",
F
Feng Zhu 已提交
1531
        cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
1532
        s.ToString().c_str());
I
Igor Canadi 已提交
1533

1534
    if (!db_options_.disableDataSync) {
1535 1536
      db_directory_->Fsync();
    }
1537 1538
    mutex_.Lock();
  }
1539 1540
  base->Unref();

1541
  // re-acquire the most current version
1542
  base = cfd->current();
1543 1544 1545 1546 1547 1548

  // 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 已提交
1549
  // committed so that other threads can recognize this file as a
1550 1551 1552 1553 1554 1555
  // 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;
1556
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1557 1558 1559 1560 1561 1562
    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.
1563
    if (base != nullptr && db_options_.max_background_compactions <= 1 &&
I
Igor Canadi 已提交
1564
        db_options_.max_background_flushes == 0 &&
1565
        cfd->ioptions()->compaction_style == kCompactionStyleLevel) {
1566 1567
      level = base->PickLevelForMemTableOutput(
          mutable_cf_options, min_user_key, max_user_key);
1568
    }
1569 1570 1571
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
                  meta.smallest_seqno, meta.largest_seqno);
1572 1573
  }

L
Lei Jin 已提交
1574
  InternalStats::CompactionStats stats(1);
1575
  stats.micros = env_->NowMicros() - start_micros;
1576
  stats.bytes_written = meta.fd.GetFileSize();
1577
  cfd->internal_stats()->AddCompactionStats(level, stats);
1578 1579
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1580
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
1581 1582 1583
  return s;
}

1584 1585 1586
Status DBImpl::FlushMemTableToOutputFile(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
    bool* madeProgress, DeletionState& deletion_state, LogBuffer* log_buffer) {
1587
  mutex_.AssertHeld();
1588
  assert(cfd->imm()->size() != 0);
1589
  assert(cfd->imm()->IsFlushPending());
1590 1591 1592

  // Save the contents of the earliest memtable as a new Table
  uint64_t file_number;
K
Kai Liu 已提交
1593
  autovector<MemTable*> mems;
1594
  cfd->imm()->PickMemtablesToFlush(&mems);
1595
  if (mems.empty()) {
I
Igor Canadi 已提交
1596 1597
    LogToBuffer(log_buffer, "[%s] Nothing in memtable to flush",
                cfd->GetName().c_str());
L
Lei Jin 已提交
1598
    return Status::OK();
1599 1600 1601
  }

  // record the logfile_number_ before we release the mutex
1602 1603 1604
  // 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.
1605
  MemTable* m = mems[0];
1606 1607
  VersionEdit* edit = m->GetEdits();
  edit->SetPrevLogNumber(0);
1608 1609
  // SetLogNumber(log_num) indicates logs with number smaller than log_num
  // will no longer be picked up for recovery.
1610 1611
  edit->SetLogNumber(mems.back()->GetNextLogNumber());
  edit->SetColumnFamily(cfd->GetID());
1612

1613

1614
  // This will release and re-acquire the mutex.
1615 1616
  Status s = WriteLevel0Table(cfd, mutable_cf_options, mems, edit,
                              &file_number, log_buffer);
1617

1618
  if (s.ok() && (shutting_down_.Acquire_Load() || cfd->IsDropped())) {
L
Lei Jin 已提交
1619
    s = Status::ShutdownInProgress(
I
Igor Canadi 已提交
1620
        "Database shutdown or Column family drop during flush");
1621
  }
J
jorlow@chromium.org 已提交
1622

L
Lei Jin 已提交
1623
  if (!s.ok()) {
1624
    cfd->imm()->RollbackMemtableFlush(mems, file_number, &pending_outputs_);
1625 1626
  } else {
    // Replace immutable memtable with the generated Table
1627
    s = cfd->imm()->InstallMemtableFlushResults(
1628 1629 1630
        cfd, mutable_cf_options, mems, versions_.get(), &mutex_,
        db_options_.info_log.get(), file_number, &pending_outputs_,
        &deletion_state.memtables_to_free, db_directory_.get(), log_buffer);
1631
  }
J
jorlow@chromium.org 已提交
1632 1633

  if (s.ok()) {
1634
    InstallSuperVersion(cfd, deletion_state, mutable_cf_options);
1635 1636 1637
    if (madeProgress) {
      *madeProgress = 1;
    }
I
Igor Canadi 已提交
1638 1639 1640
    Version::LevelSummaryStorage tmp;
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
                cfd->current()->LevelSummary(&tmp));
1641

1642
    if (disable_delete_obsolete_files_ == 0) {
I
Igor Canadi 已提交
1643
      // add to deletion state
1644
      while (alive_log_files_.size() &&
I
Igor Canadi 已提交
1645 1646 1647 1648
             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;
1649 1650
        alive_log_files_.pop_front();
      }
1651
    }
J
jorlow@chromium.org 已提交
1652
  }
1653

1654
  if (!s.ok() && !s.IsShutdownInProgress() && db_options_.paranoid_checks &&
1655 1656 1657 1658 1659
      bg_error_.ok()) {
    // if a bad error happened (not ShutdownInProgress) and paranoid_checks is
    // true, mark DB read-only
    bg_error_ = s;
  }
1660
  RecordFlushIOStats();
J
jorlow@chromium.org 已提交
1661 1662 1663
  return s;
}

1664
Status DBImpl::CompactRange(ColumnFamilyHandle* column_family,
1665
                            const Slice* begin, const Slice* end,
1666 1667
                            bool reduce_level, int target_level,
                            uint32_t target_path_id) {
1668
  if (target_path_id >= db_options_.db_paths.size()) {
1669 1670 1671
    return Status::InvalidArgument("Invalid target path ID");
  }

1672 1673
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
I
Igor Canadi 已提交
1674 1675

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
1676
  if (!s.ok()) {
1677
    LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1678 1679 1680
    return s;
  }

I
Igor Canadi 已提交
1681
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
1682 1683
  {
    MutexLock l(&mutex_);
I
Igor Canadi 已提交
1684 1685
    Version* base = cfd->current();
    for (int level = 1; level < cfd->NumberLevels(); level++) {
G
Gabor Cselle 已提交
1686 1687 1688 1689 1690
      if (base->OverlapInLevel(level, begin, end)) {
        max_level_with_files = level;
      }
    }
  }
1691 1692
  for (int level = 0; level <= max_level_with_files; level++) {
    // in case the compaction is unversal or if we're compacting the
1693 1694 1695
    // 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)
1696 1697
    if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
        cfd->ioptions()->compaction_style == kCompactionStyleFIFO ||
1698
        (level == max_level_with_files && level > 0)) {
1699
      s = RunManualCompaction(cfd, level, level, target_path_id, begin, end);
1700
    } else {
1701 1702
      s = RunManualCompaction(cfd, level, level + 1, target_path_id, begin,
                              end);
L
Lei Jin 已提交
1703 1704
    }
    if (!s.ok()) {
1705
      LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1706
      return s;
1707
    }
G
Gabor Cselle 已提交
1708
  }
1709 1710

  if (reduce_level) {
I
Igor Canadi 已提交
1711
    s = ReFitLevel(cfd, max_level_with_files, target_level);
1712
  }
1713
  LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1714

1715 1716 1717 1718 1719 1720 1721
  {
    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 已提交
1722
  return s;
1723 1724
}

1725 1726
bool DBImpl::SetOptions(ColumnFamilyHandle* column_family,
    const std::unordered_map<std::string, std::string>& options_map) {
L
Lei Jin 已提交
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757
  auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  if (options_map.empty()) {
    Log(db_options_.info_log, "SetOptions() on column family [%s], empty input",
        cfd->GetName().c_str());
    return false;
  }

  MutableCFOptions new_options;
  bool succeed = false;
  {
    MutexLock l(&mutex_);
    if (cfd->SetOptions(options_map)) {
      new_options = *cfd->GetLatestMutableCFOptions();
      succeed = true;
    }
  }

  Log(db_options_.info_log, "SetOptions() on column family [%s], inputs:",
      cfd->GetName().c_str());
  for (const auto& o : options_map) {
    Log(db_options_.info_log, "%s: %s\n", o.first.c_str(), o.second.c_str());
  }
  if (succeed) {
    Log(db_options_.info_log, "[%s] SetOptions succeeded",
        cfd->GetName().c_str());
    new_options.Dump(db_options_.info_log.get());
  } else {
    Log(db_options_.info_log, "[%s] SetOptions failed",
        cfd->GetName().c_str());
  }
  return succeed;
1758 1759
}

1760
// return the same level if it cannot be moved
1761 1762
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd,
    const MutableCFOptions& mutable_cf_options, int level) {
1763
  mutex_.AssertHeld();
I
Igor Canadi 已提交
1764
  Version* current = cfd->current();
1765
  int minimum_level = level;
1766
  for (int i = level - 1; i > 0; --i) {
1767
    // stop if level i is not empty
1768
    if (current->NumLevelFiles(i) > 0) break;
1769
    // stop if level i is too small (cannot fit the level files)
1770
    if (mutable_cf_options.MaxBytesForLevel(i) <
1771 1772 1773
        current->NumLevelBytes(level)) {
      break;
    }
1774 1775 1776 1777 1778 1779

    minimum_level = i;
  }
  return minimum_level;
}

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

I
Igor Canadi 已提交
1783
  SuperVersion* superversion_to_free = nullptr;
1784
  SuperVersion* new_superversion = new SuperVersion();
I
Igor Canadi 已提交
1785 1786

  mutex_.Lock();
1787 1788 1789

  // only allow one thread refitting
  if (refitting_level_) {
I
Igor Canadi 已提交
1790
    mutex_.Unlock();
1791
    Log(db_options_.info_log, "ReFitLevel: another thread is refitting");
I
Igor Canadi 已提交
1792
    delete new_superversion;
L
Lei Jin 已提交
1793
    return Status::NotSupported("another thread is refitting");
1794 1795 1796 1797 1798
  }
  refitting_level_ = true;

  // wait for all background threads to stop
  bg_work_gate_closed_ = true;
1799
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_) {
1800
    Log(db_options_.info_log,
1801 1802
        "RefitLevel: waiting for background threads to stop: %d %d",
        bg_compaction_scheduled_, bg_flush_scheduled_);
1803 1804 1805
    bg_cv_.Wait();
  }

1806 1807
  const MutableCFOptions mutable_cf_options =
    *cfd->GetLatestMutableCFOptions();
1808
  // move to a smaller level
1809 1810
  int to_level = target_level;
  if (target_level < 0) {
1811
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
1812
  }
1813 1814 1815

  assert(to_level <= level);

L
Lei Jin 已提交
1816
  Status status;
1817
  if (to_level < level) {
1818 1819
    Log(db_options_.info_log, "[%s] Before refitting:\n%s",
        cfd->GetName().c_str(), cfd->current()->DebugString().data());
1820

1821
    VersionEdit edit;
I
Igor Canadi 已提交
1822 1823
    edit.SetColumnFamily(cfd->GetID());
    for (const auto& f : cfd->current()->files_[level]) {
1824
      edit.DeleteFile(level, f->fd.GetNumber());
1825 1826 1827
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
                   f->smallest_seqno, f->largest_seqno);
1828
    }
1829
    Log(db_options_.info_log, "[%s] Apply version edit:\n%s",
I
Igor Canadi 已提交
1830
        cfd->GetName().c_str(), edit.DebugString().data());
1831

1832 1833
    status = versions_->LogAndApply(cfd,
        mutable_cf_options, &edit, &mutex_, db_directory_.get());
L
Lei Jin 已提交
1834 1835
    superversion_to_free = InstallSuperVersion(
        cfd, new_superversion, mutable_cf_options);
I
Igor Canadi 已提交
1836
    new_superversion = nullptr;
1837

1838
    Log(db_options_.info_log, "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
1839
        status.ToString().data());
1840 1841

    if (status.ok()) {
1842
      Log(db_options_.info_log, "[%s] After refitting:\n%s",
I
Igor Canadi 已提交
1843
          cfd->GetName().c_str(), cfd->current()->DebugString().data());
1844 1845 1846 1847 1848
    }
  }

  refitting_level_ = false;
  bg_work_gate_closed_ = false;
I
Igor Canadi 已提交
1849 1850 1851 1852

  mutex_.Unlock();
  delete superversion_to_free;
  delete new_superversion;
L
Lei Jin 已提交
1853
  return status;
G
Gabor Cselle 已提交
1854 1855
}

1856 1857 1858
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
1859 1860
}

1861 1862
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
1863 1864 1865
  MutexLock l(&mutex_);
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.max_mem_compaction_level;
1866 1867
}

1868 1869
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
1870 1871 1872
  MutexLock l(&mutex_);
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.level0_stop_writes_trigger;
1873 1874
}

L
Lei Jin 已提交
1875
Status DBImpl::Flush(const FlushOptions& flush_options,
1876 1877
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
1878
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
1879 1880
}

1881
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
1882 1883 1884
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
1885
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
1886 1887
                                   int output_level, uint32_t output_path_id,
                                   const Slice* begin, const Slice* end) {
1888
  assert(input_level >= 0);
1889

G
Gabor Cselle 已提交
1890 1891
  InternalKey begin_storage, end_storage;

H
hans@chromium.org 已提交
1892
  ManualCompaction manual;
I
Igor Canadi 已提交
1893
  manual.cfd = cfd;
1894 1895
  manual.input_level = input_level;
  manual.output_level = output_level;
1896
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
1897
  manual.done = false;
1898
  manual.in_progress = false;
1899 1900 1901
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
1902 1903
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
1904
    manual.begin = nullptr;
G
Gabor Cselle 已提交
1905 1906 1907 1908
  } else {
    begin_storage = InternalKey(*begin, kMaxSequenceNumber, kValueTypeForSeek);
    manual.begin = &begin_storage;
  }
1909
  if (end == nullptr ||
1910 1911
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
1912
    manual.end = nullptr;
G
Gabor Cselle 已提交
1913 1914 1915 1916 1917 1918
  } else {
    end_storage = InternalKey(*end, 0, static_cast<ValueType>(0));
    manual.end = &end_storage;
  }

  MutexLock l(&mutex_);
1919

1920 1921 1922 1923 1924 1925
  // 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
1926
  // RunManualCompaction(), i.e. during that time no other compaction will
1927 1928 1929
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
1930
  // RunManualCompaction() from getting to the second while loop below.
1931 1932 1933 1934 1935
  // 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) {
1936
    Log(db_options_.info_log,
I
Igor Canadi 已提交
1937 1938 1939
        "[%s] Manual compaction waiting for all other scheduled background "
        "compactions to finish",
        cfd->GetName().c_str());
1940 1941
    bg_cv_.Wait();
  }
1942

1943
  Log(db_options_.info_log, "[%s] Manual compaction starting",
I
Igor Canadi 已提交
1944
      cfd->GetName().c_str());
1945

1946 1947 1948 1949
  // We don't check bg_error_ here, because if we get the error in compaction,
  // the compaction will set manual.status to bg_error_ and set manual.done to
  // true.
  while (!manual.done) {
1950 1951 1952
    assert(bg_manual_only_ > 0);
    if (manual_compaction_ != nullptr) {
      // Running either this or some other manual compaction
G
Gabor Cselle 已提交
1953
      bg_cv_.Wait();
1954 1955
    } else {
      manual_compaction_ = &manual;
1956 1957
      bg_compaction_scheduled_++;
      env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW);
G
Gabor Cselle 已提交
1958
    }
H
hans@chromium.org 已提交
1959
  }
1960

1961 1962 1963
  assert(!manual.in_progress);
  assert(bg_manual_only_ > 0);
  --bg_manual_only_;
L
Lei Jin 已提交
1964
  return manual.status;
J
jorlow@chromium.org 已提交
1965 1966
}

1967
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
L
Lei Jin 已提交
1968
                             const FlushOptions& flush_options) {
S
Stanislau Hlebik 已提交
1969 1970 1971 1972
  Status s;
  {
    WriteContext context;
    MutexLock guard_lock(&mutex_);
1973 1974 1975 1976 1977 1978

    if (cfd->imm()->size() == 0 && cfd->mem()->IsEmpty()) {
      // Nothing to flush
      return Status::OK();
    }

I
Igor Canadi 已提交
1979 1980
    WriteThread::Writer w(&mutex_);
    s = write_thread_.EnterWriteThread(&w, 0);
S
Stanislau Hlebik 已提交
1981 1982 1983 1984 1985 1986 1987 1988
    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();

I
Igor Canadi 已提交
1989
    write_thread_.ExitWriteThread(&w, &w, s);
S
Stanislau Hlebik 已提交
1990
  }
S
Stanislau Hlebik 已提交
1991

L
Lei Jin 已提交
1992
  if (s.ok() && flush_options.wait) {
1993
    // Wait until the compaction completes
1994
    s = WaitForFlushMemTable(cfd);
1995 1996
  }
  return s;
J
jorlow@chromium.org 已提交
1997 1998
}

1999
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
2000 2001 2002
  Status s;
  // Wait until the compaction completes
  MutexLock l(&mutex_);
2003
  while (cfd->imm()->size() > 0 && bg_error_.ok()) {
2004 2005
    bg_cv_.Wait();
  }
2006
  if (!bg_error_.ok()) {
2007 2008 2009
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
2010 2011
}

2012
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
2013
  mutex_.AssertHeld();
2014
  bg_schedule_needed_ = false;
2015 2016
  if (bg_work_gate_closed_) {
    // gate closed for backgrond work
J
jorlow@chromium.org 已提交
2017 2018 2019
  } else if (shutting_down_.Acquire_Load()) {
    // DB is being deleted; no more background compactions
  } else {
2020
    bool is_flush_pending = false;
2021
    // no need to refcount since we're under a mutex
2022
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
2023
      if (cfd->imm()->IsFlushPending()) {
2024 2025 2026
        is_flush_pending = true;
      }
    }
2027
    if (is_flush_pending) {
2028
      // memtable flush needed
2029
      if (bg_flush_scheduled_ < db_options_.max_background_flushes) {
2030 2031
        bg_flush_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH);
2032
      } else if (db_options_.max_background_flushes > 0) {
2033
        bg_schedule_needed_ = true;
2034
      }
2035
    }
2036
    bool is_compaction_needed = false;
2037
    // no need to refcount since we're under a mutex
2038
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
2039
      if (cfd->current()->NeedsCompaction()) {
2040 2041 2042 2043
        is_compaction_needed = true;
        break;
      }
    }
2044

2045 2046
    // Schedule BGWorkCompaction if there's a compaction pending (or a memtable
    // flush, but the HIGH pool is not enabled)
2047 2048 2049 2050
    // Do it only if max_background_compactions hasn't been reached and
    // bg_manual_only_ == 0
    if (!bg_manual_only_ &&
        (is_compaction_needed ||
2051 2052
         (is_flush_pending && db_options_.max_background_flushes == 0))) {
      if (bg_compaction_scheduled_ < db_options_.max_background_compactions) {
2053 2054 2055 2056 2057
        bg_compaction_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW);
      } else {
        bg_schedule_needed_ = true;
      }
2058 2059 2060 2061
    }
  }
}

2062
void DBImpl::RecordFlushIOStats() {
I
Igor Canadi 已提交
2063
  RecordTick(stats_, FLUSH_WRITE_BYTES, IOSTATS(bytes_written));
2064 2065 2066 2067
  IOSTATS_RESET(bytes_written);
}

void DBImpl::RecordCompactionIOStats() {
L
Lei Jin 已提交
2068
  RecordTick(stats_, COMPACT_READ_BYTES, IOSTATS(bytes_read));
2069
  IOSTATS_RESET(bytes_read);
L
Lei Jin 已提交
2070
  RecordTick(stats_, COMPACT_WRITE_BYTES, IOSTATS(bytes_written));
2071 2072 2073
  IOSTATS_RESET(bytes_written);
}

2074
void DBImpl::BGWorkFlush(void* db) {
2075
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
2076 2077 2078 2079
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
}

void DBImpl::BGWorkCompaction(void* db) {
2080
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
2081 2082 2083
  reinterpret_cast<DBImpl*>(db)->BackgroundCallCompaction();
}

I
Igor Canadi 已提交
2084
Status DBImpl::BackgroundFlush(bool* madeProgress,
H
Haobo Xu 已提交
2085 2086
                               DeletionState& deletion_state,
                               LogBuffer* log_buffer) {
2087
  mutex_.AssertHeld();
2088 2089 2090 2091 2092

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

2093 2094 2095 2096 2097
  // 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
2098
  for (auto cfd : *versions_->GetColumnFamilySet()) {
2099 2100
    cfd->Ref();
    Status flush_status;
2101 2102
    const MutableCFOptions mutable_cf_options =
      *cfd->GetLatestMutableCFOptions();
2103
    while (flush_status.ok() && cfd->imm()->IsFlushPending()) {
2104 2105
      LogToBuffer(
          log_buffer,
2106
          "BackgroundCallFlush doing FlushMemTableToOutputFile with column "
I
Igor Canadi 已提交
2107 2108
          "family [%s], flush slots available %d",
          cfd->GetName().c_str(),
2109
          db_options_.max_background_flushes - bg_flush_scheduled_);
2110 2111
      flush_status = FlushMemTableToOutputFile(
          cfd, mutable_cf_options, madeProgress, deletion_state, log_buffer);
2112 2113 2114
    }
    if (call_status.ok() && !flush_status.ok()) {
      call_status = flush_status;
2115
    }
2116
    cfd->Unref();
J
jorlow@chromium.org 已提交
2117
  }
2118
  versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
2119
  return call_status;
J
jorlow@chromium.org 已提交
2120 2121
}

2122
void DBImpl::BackgroundCallFlush() {
2123
  bool madeProgress = false;
K
Kai Liu 已提交
2124
  DeletionState deletion_state(true);
2125 2126
  assert(bg_flush_scheduled_);

2127
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
H
Haobo Xu 已提交
2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138
  {
    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.
2139 2140
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
H
Haobo Xu 已提交
2141 2142
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
2143
        Log(db_options_.info_log,
2144 2145 2146
            "Waiting after background flush error: %s"
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
H
Haobo Xu 已提交
2147
        log_buffer.FlushBufferToLog();
2148
        LogFlush(db_options_.info_log);
H
Haobo Xu 已提交
2149 2150 2151 2152 2153 2154 2155 2156 2157
        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
2158
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2159
      mutex_.Unlock();
2160 2161 2162 2163 2164
      // 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 已提交
2165
      log_buffer.FlushBufferToLog();
2166 2167 2168
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2169 2170
      mutex_.Lock();
    }
I
Igor Canadi 已提交
2171

H
Haobo Xu 已提交
2172
    bg_flush_scheduled_--;
2173 2174 2175 2176 2177
    // 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 已提交
2178 2179
      MaybeScheduleFlushOrCompaction();
    }
I
Igor Canadi 已提交
2180
    RecordFlushIOStats();
H
Haobo Xu 已提交
2181
    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
}

2189
void DBImpl::BackgroundCallCompaction() {
2190
  bool madeProgress = false;
K
Kai Liu 已提交
2191
  DeletionState deletion_state(true);
H
Haobo Xu 已提交
2192 2193

  MaybeDumpStats();
2194
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205
  {
    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.
2206 2207
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
2208 2209
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
H
Haobo Xu 已提交
2210
        log_buffer.FlushBufferToLog();
2211
        Log(db_options_.info_log,
2212 2213 2214
            "Waiting after background compaction error: %s, "
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
2215
        LogFlush(db_options_.info_log);
2216 2217 2218 2219
        env_->SleepForMicroseconds(1000000);
        mutex_.Lock();
      }
    }
H
Haobo Xu 已提交
2220

2221 2222 2223 2224 2225 2226 2227
    // 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
2228
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2229
      mutex_.Unlock();
2230 2231 2232 2233 2234
      // 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 已提交
2235
      log_buffer.FlushBufferToLog();
2236 2237 2238
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2239 2240
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
2241

2242
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2243

2244 2245
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

2246 2247 2248
    // Previous compaction may have produced too many files in a level,
    // So reschedule another compaction if we made progress in the
    // last compaction.
2249 2250 2251 2252 2253 2254
    //
    // 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_) {
2255 2256
      MaybeScheduleFlushOrCompaction();
    }
2257 2258
    if (madeProgress || bg_compaction_scheduled_ == 0 || bg_manual_only_ > 0) {
      // signal if
I
Igor Canadi 已提交
2259
      // * madeProgress -- need to wakeup DelayWrite
2260 2261 2262 2263 2264 2265
      // * 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 已提交
2266 2267 2268 2269
    // 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.
2270
  }
J
jorlow@chromium.org 已提交
2271 2272
}

A
Abhishek Kona 已提交
2273
Status DBImpl::BackgroundCompaction(bool* madeProgress,
2274 2275
                                    DeletionState& deletion_state,
                                    LogBuffer* log_buffer) {
2276
  *madeProgress = false;
J
jorlow@chromium.org 已提交
2277
  mutex_.AssertHeld();
2278

2279 2280
  bool is_manual = (manual_compaction_ != nullptr) &&
                   (manual_compaction_->in_progress == false);
2281

2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
  if (!bg_error_.ok()) {
    if (is_manual) {
      manual_compaction_->status = bg_error_;
      manual_compaction_->done = true;
      manual_compaction_->in_progress = false;
      manual_compaction_ = nullptr;
    }
    return bg_error_;
  }

2292 2293 2294
  if (is_manual) {
    // another thread cannot pick up the same work
    manual_compaction_->in_progress = true;
2295 2296 2297 2298
  } else if (manual_compaction_ != nullptr) {
    // there should be no automatic compactions running when manual compaction
    // is running
    return Status::OK();
2299 2300 2301 2302 2303
  }

  // FLUSH preempts compaction
  Status flush_stat;
  for (auto cfd : *versions_->GetColumnFamilySet()) {
2304 2305
    const MutableCFOptions mutable_cf_options =
      *cfd->GetLatestMutableCFOptions();
2306 2307 2308 2309 2310
    while (cfd->imm()->IsFlushPending()) {
      LogToBuffer(
          log_buffer,
          "BackgroundCompaction doing FlushMemTableToOutputFile, "
          "compaction slots available %d",
2311
          db_options_.max_background_compactions - bg_compaction_scheduled_);
2312
      cfd->Ref();
2313 2314
      flush_stat = FlushMemTableToOutputFile(
          cfd, mutable_cf_options, madeProgress, deletion_state, log_buffer);
2315
      cfd->Unref();
2316 2317 2318 2319 2320 2321 2322
      if (!flush_stat.ok()) {
        if (is_manual) {
          manual_compaction_->status = flush_stat;
          manual_compaction_->done = true;
          manual_compaction_->in_progress = false;
          manual_compaction_ = nullptr;
        }
2323
        return flush_stat;
2324 2325 2326 2327
      }
    }
  }

2328 2329 2330
  // Compaction makes a copy of the latest MutableCFOptions. It should be used
  // throughout the compaction procedure to make sure consistency. It will
  // eventually be installed into SuperVersion
2331
  unique_ptr<Compaction> c;
2332 2333
  InternalKey manual_end_storage;
  InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
2334
  if (is_manual) {
G
Gabor Cselle 已提交
2335
    ManualCompaction* m = manual_compaction_;
2336
    assert(m->in_progress);
2337 2338 2339
    c.reset(m->cfd->CompactRange(
          *m->cfd->GetLatestMutableCFOptions(), m->input_level, m->output_level,
          m->output_path_id, m->begin, m->end, &manual_end));
2340
    if (!c) {
2341
      m->done = true;
G
Gabor Cselle 已提交
2342
    }
I
Igor Canadi 已提交
2343 2344 2345 2346 2347 2348 2349 2350 2351
    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 已提交
2352
  } else {
2353
    // no need to refcount in iteration since it's always under a mutex
I
Igor Canadi 已提交
2354
    for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
2355 2356 2357 2358
      // Pick up latest mutable CF Options and use it throughout the
      // compaction job
      auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
      if (!mutable_cf_options->disable_auto_compactions) {
2359 2360 2361
        // NOTE: try to avoid unnecessary copy of MutableCFOptions if
        // compaction is not necessary. Need to make sure mutex is held
        // until we make a copy in the following code
L
Lei Jin 已提交
2362
        c.reset(cfd->PickCompaction(*mutable_cf_options, log_buffer));
I
Igor Canadi 已提交
2363 2364
        if (c != nullptr) {
          // update statistics
L
Lei Jin 已提交
2365
          MeasureTime(stats_, NUM_FILES_IN_SINGLE_COMPACTION,
I
Igor Canadi 已提交
2366 2367 2368
                      c->inputs(0)->size());
          break;
        }
I
Igor Canadi 已提交
2369 2370
      }
    }
J
jorlow@chromium.org 已提交
2371 2372 2373
  }

  Status status;
2374
  if (!c) {
H
hans@chromium.org 已提交
2375
    // Nothing to do
2376
    LogToBuffer(log_buffer, "Compaction nothing to do");
I
Igor Canadi 已提交
2377 2378 2379 2380 2381
  } 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);
2382
    assert(c->column_family_data()->ioptions()->compaction_style ==
I
Igor Canadi 已提交
2383 2384
           kCompactionStyleFIFO);
    for (const auto& f : *c->inputs(0)) {
2385
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
2386
    }
2387 2388 2389 2390 2391
    status = versions_->LogAndApply(
        c->column_family_data(), *c->mutable_cf_options(), c->edit(),
        &mutex_, db_directory_.get());
    InstallSuperVersion(c->column_family_data(), deletion_state,
                        *c->mutable_cf_options());
I
Igor Canadi 已提交
2392 2393 2394 2395 2396
    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 已提交
2397
  } else if (!is_manual && c->IsTrivialMove()) {
J
jorlow@chromium.org 已提交
2398
    // Move file to next level
2399
    assert(c->num_input_files(0) == 1);
J
jorlow@chromium.org 已提交
2400
    FileMetaData* f = c->input(0, 0);
2401
    c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
2402 2403 2404
    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);
2405 2406 2407
    status = versions_->LogAndApply(c->column_family_data(),
                                    *c->mutable_cf_options(),
                                    c->edit(), &mutex_, db_directory_.get());
2408
    // Use latest MutableCFOptions
2409 2410
    InstallSuperVersion(c->column_family_data(), deletion_state,
                        *c->mutable_cf_options());
2411

2412
    Version::LevelSummaryStorage tmp;
2413
    LogToBuffer(
2414 2415
        log_buffer,
        "[%s] Moved #%" PRIu64 " to level-%d %" PRIu64 " bytes %s: %s\n",
2416
        c->column_family_data()->GetName().c_str(),
2417 2418
        f->fd.GetNumber(), c->level() + 1,
        f->fd.GetFileSize(),
2419
        status.ToString().c_str(), c->input_version()->LevelSummary(&tmp));
I
Igor Canadi 已提交
2420
    c->ReleaseCompactionFiles(status);
2421
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2422
  } else {
2423
    MaybeScheduleFlushOrCompaction(); // do more compaction work in parallel.
2424
    CompactionState* compact = new CompactionState(c.get());
2425 2426
    status = DoCompactionWork(compact, *c->mutable_cf_options(),
                              deletion_state, log_buffer);
2427
    CleanupCompaction(compact, status);
I
Igor Canadi 已提交
2428
    c->ReleaseCompactionFiles(status);
2429
    c->ReleaseInputs();
2430
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2431
  }
2432
  c.reset();
J
jorlow@chromium.org 已提交
2433 2434 2435

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
2436
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
2437 2438
    // Ignore compaction errors found during shutting down
  } else {
2439
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log, "Compaction error: %s",
2440
        status.ToString().c_str());
2441
    if (db_options_.paranoid_checks && bg_error_.ok()) {
J
jorlow@chromium.org 已提交
2442 2443 2444
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
2445 2446

  if (is_manual) {
G
Gabor Cselle 已提交
2447
    ManualCompaction* m = manual_compaction_;
2448
    if (!status.ok()) {
L
Lei Jin 已提交
2449
      m->status = status;
2450 2451
      m->done = true;
    }
2452 2453 2454 2455 2456 2457 2458 2459 2460
    // 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.
2461 2462 2463 2464 2465
    //
    // 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) {
2466 2467
      m->done = true;
    }
G
Gabor Cselle 已提交
2468 2469 2470
    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 已提交
2471
      // Universal and FIFO compactions should always compact the whole range
2472 2473
      assert(m->cfd->ioptions()->compaction_style != kCompactionStyleUniversal);
      assert(m->cfd->ioptions()->compaction_style != kCompactionStyleFIFO);
2474
      m->tmp_storage = *manual_end;
G
Gabor Cselle 已提交
2475 2476
      m->begin = &m->tmp_storage;
    }
2477
    m->in_progress = false; // not being processed anymore
2478
    manual_compaction_ = nullptr;
H
hans@chromium.org 已提交
2479
  }
2480
  return status;
J
jorlow@chromium.org 已提交
2481 2482
}

2483
void DBImpl::CleanupCompaction(CompactionState* compact, Status status) {
J
jorlow@chromium.org 已提交
2484
  mutex_.AssertHeld();
2485
  if (compact->builder != nullptr) {
J
jorlow@chromium.org 已提交
2486 2487
    // May happen if we get a shutdown call in the middle of compaction
    compact->builder->Abandon();
2488
    compact->builder.reset();
J
jorlow@chromium.org 已提交
2489
  } else {
2490
    assert(compact->outfile == nullptr);
J
jorlow@chromium.org 已提交
2491
  }
D
dgrogan@chromium.org 已提交
2492
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2493 2494
    const CompactionState::Output& out = compact->outputs[i];
    pending_outputs_.erase(out.number);
2495 2496 2497 2498

    // 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 已提交
2499
      TableCache::Evict(table_cache_.get(), out.number);
2500
    }
J
jorlow@chromium.org 已提交
2501 2502 2503 2504
  }
  delete compact;
}

2505
// Allocate the file numbers for the output file. We allocate as
2506
// many output file numbers as there are files in level+1 (at least one)
2507 2508 2509
// Insert them into pending_outputs so that they do not get deleted.
void DBImpl::AllocateCompactionOutputFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2510 2511
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
2512
  int filesNeeded = compact->compaction->num_input_files(1);
2513
  for (int i = 0; i < std::max(filesNeeded, 1); i++) {
2514
    uint64_t file_number = versions_->NewFileNumber();
2515
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
2516 2517 2518 2519 2520 2521 2522
    compact->allocated_file_numbers.push_back(file_number);
  }
}

// Frees up unused file number.
void DBImpl::ReleaseCompactionUnusedFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2523
  for (const auto file_number : compact->allocated_file_numbers) {
2524 2525 2526 2527
    pending_outputs_.erase(file_number);
  }
}

2528 2529
Status DBImpl::OpenCompactionOutputFile(
    CompactionState* compact, const MutableCFOptions& mutable_cf_options) {
2530 2531
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
J
jorlow@chromium.org 已提交
2532
  uint64_t file_number;
2533 2534 2535 2536 2537 2538 2539
  // 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 已提交
2540 2541
    mutex_.Lock();
    file_number = versions_->NewFileNumber();
2542
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
J
jorlow@chromium.org 已提交
2543 2544
    mutex_.Unlock();
  }
2545 2546
  CompactionState::Output out;
  out.number = file_number;
2547
  out.path_id = compact->compaction->GetOutputPathId();
2548 2549
  out.smallest.Clear();
  out.largest.Clear();
2550
  out.smallest_seqno = out.largest_seqno = 0;
2551
  compact->outputs.push_back(out);
J
jorlow@chromium.org 已提交
2552 2553

  // Make the output file
2554
  std::string fname = TableFileName(db_options_.db_paths, file_number,
2555
                                    compact->compaction->GetOutputPathId());
L
Lei Jin 已提交
2556
  Status s = env_->NewWritableFile(fname, &compact->outfile, env_options_);
2557

J
jorlow@chromium.org 已提交
2558
  if (s.ok()) {
L
Lei Jin 已提交
2559
    compact->outfile->SetIOPriority(Env::IO_LOW);
2560
    compact->outfile->SetPreallocationBlockSize(
2561
        compact->compaction->OutputFilePreallocationSize(mutable_cf_options));
2562

2563
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2564
    compact->builder.reset(NewTableBuilder(
L
Lei Jin 已提交
2565 2566
        *cfd->ioptions(), cfd->internal_comparator(), compact->outfile.get(),
        compact->compaction->OutputCompressionType(),
2567
        cfd->ioptions()->compression_opts));
J
jorlow@chromium.org 已提交
2568
  }
2569
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
2570 2571 2572 2573 2574
  return s;
}

Status DBImpl::FinishCompactionOutputFile(CompactionState* compact,
                                          Iterator* input) {
2575
  assert(compact != nullptr);
2576
  assert(compact->outfile);
2577
  assert(compact->builder != nullptr);
J
jorlow@chromium.org 已提交
2578 2579

  const uint64_t output_number = compact->current_output()->number;
2580
  const uint32_t output_path_id = compact->current_output()->path_id;
J
jorlow@chromium.org 已提交
2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593
  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;
2594
  compact->builder.reset();
J
jorlow@chromium.org 已提交
2595 2596

  // Finish and check for file errors
2597 2598
  if (s.ok() && !db_options_.disableDataSync) {
    if (db_options_.use_fsync) {
L
Lei Jin 已提交
2599
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2600 2601
      s = compact->outfile->Fsync();
    } else {
L
Lei Jin 已提交
2602
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2603 2604
      s = compact->outfile->Sync();
    }
J
jorlow@chromium.org 已提交
2605 2606 2607 2608
  }
  if (s.ok()) {
    s = compact->outfile->Close();
  }
2609
  compact->outfile.reset();
J
jorlow@chromium.org 已提交
2610 2611 2612

  if (s.ok() && current_entries > 0) {
    // Verify that the table is usable
I
Igor Canadi 已提交
2613
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2614
    FileDescriptor fd(output_number, output_path_id, current_bytes);
I
Igor Canadi 已提交
2615
    Iterator* iter = cfd->table_cache()->NewIterator(
L
Lei Jin 已提交
2616
        ReadOptions(), env_options_, cfd->internal_comparator(), fd);
J
jorlow@chromium.org 已提交
2617 2618 2619
    s = iter->status();
    delete iter;
    if (s.ok()) {
2620
      Log(db_options_.info_log, "[%s] Generated table #%" PRIu64 ": %" PRIu64
2621 2622 2623
                             " keys, %" PRIu64 " bytes",
          cfd->GetName().c_str(), output_number, current_entries,
          current_bytes);
J
jorlow@chromium.org 已提交
2624 2625 2626 2627 2628 2629
    }
  }
  return s;
}


2630
Status DBImpl::InstallCompactionResults(CompactionState* compact,
2631
    const MutableCFOptions& mutable_cf_options, LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
2632
  mutex_.AssertHeld();
2633 2634 2635 2636 2637

  // 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.
2638
  if (!versions_->VerifyCompactionFileConsistency(compact->compaction)) {
2639
    Log(db_options_.info_log, "[%s] Compaction %d@%d + %d@%d files aborted",
I
Igor Canadi 已提交
2640 2641 2642 2643
        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 已提交
2644
    return Status::Corruption("Compaction input files inconsistent");
2645 2646
  }

I
Igor Canadi 已提交
2647 2648
  LogToBuffer(log_buffer, "[%s] Compacted %d@%d + %d@%d files => %lld bytes",
              compact->compaction->column_family_data()->GetName().c_str(),
2649 2650 2651 2652 2653
              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 已提交
2654 2655 2656

  // Add compaction outputs
  compact->compaction->AddInputDeletions(compact->compaction->edit());
D
dgrogan@chromium.org 已提交
2657
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2658
    const CompactionState::Output& out = compact->outputs[i];
2659 2660 2661 2662
    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 已提交
2663
  }
I
Igor Canadi 已提交
2664
  return versions_->LogAndApply(compact->compaction->column_family_data(),
2665
                                mutable_cf_options,
I
Igor Canadi 已提交
2666 2667
                                compact->compaction->edit(), &mutex_,
                                db_directory_.get());
J
jorlow@chromium.org 已提交
2668 2669
}

2670 2671 2672 2673 2674 2675 2676
// 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(
2677 2678
  SequenceNumber in, std::vector<SequenceNumber>& snapshots,
  SequenceNumber* prev_snapshot) {
2679
  SequenceNumber prev __attribute__((unused)) = 0;
2680 2681 2682
  for (const auto cur : snapshots) {
    assert(prev <= cur);
    if (cur >= in) {
2683
      *prev_snapshot = prev;
2684
      return cur;
2685
    }
2686 2687
    prev = cur; // assignment
    assert(prev);
2688
  }
2689
  Log(db_options_.info_log,
2690 2691
      "Looking for seqid %" PRIu64 " but maxseqid is %" PRIu64 "", in,
      snapshots[snapshots.size() - 1]);
2692 2693 2694 2695
  assert(0);
  return 0;
}

I
Igor Canadi 已提交
2696
uint64_t DBImpl::CallFlushDuringCompaction(ColumnFamilyData* cfd,
2697 2698
    const MutableCFOptions& mutable_cf_options, DeletionState& deletion_state,
    LogBuffer* log_buffer) {
2699
  if (db_options_.max_background_flushes > 0) {
2700 2701 2702
    // flush thread will take care of this
    return 0;
  }
I
Igor Canadi 已提交
2703 2704 2705 2706 2707
  if (cfd->imm()->imm_flush_needed.NoBarrier_Load() != nullptr) {
    const uint64_t imm_start = env_->NowMicros();
    mutex_.Lock();
    if (cfd->imm()->IsFlushPending()) {
      cfd->Ref();
2708 2709
      FlushMemTableToOutputFile(cfd, mutable_cf_options, nullptr,
                                deletion_state, log_buffer);
I
Igor Canadi 已提交
2710
      cfd->Unref();
I
Igor Canadi 已提交
2711
      bg_cv_.SignalAll();  // Wakeup DelayWrite() if necessary
I
Igor Canadi 已提交
2712 2713 2714 2715 2716 2717 2718 2719
    }
    mutex_.Unlock();
    log_buffer->FlushBufferToLog();
    return env_->NowMicros() - imm_start;
  }
  return 0;
}

D
Danny Guo 已提交
2720
Status DBImpl::ProcessKeyValueCompaction(
2721
    const MutableCFOptions& mutable_cf_options,
2722
    bool is_snapshot_supported,
D
Danny Guo 已提交
2723 2724 2725 2726 2727 2728 2729 2730 2731
    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,
2732
    int* num_output_records,
D
Danny Guo 已提交
2733
    LogBuffer* log_buffer) {
2734 2735
  assert(num_output_records != nullptr);

D
Danny Guo 已提交
2736
  size_t combined_idx = 0;
J
jorlow@chromium.org 已提交
2737
  Status status;
D
Danny Guo 已提交
2738
  std::string compaction_filter_value;
J
jorlow@chromium.org 已提交
2739
  ParsedInternalKey ikey;
2740
  IterKey current_user_key;
J
jorlow@chromium.org 已提交
2741
  bool has_current_user_key = false;
2742
  IterKey delete_key;
2743 2744
  SequenceNumber last_sequence_for_key __attribute__((unused)) =
    kMaxSequenceNumber;
2745
  SequenceNumber visible_in_snapshot = kMaxSequenceNumber;
2746
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
I
Igor Canadi 已提交
2747
  MergeHelper merge(
2748
      cfd->user_comparator(), cfd->ioptions()->merge_operator,
L
Lei Jin 已提交
2749
      db_options_.info_log.get(), cfd->ioptions()->min_partial_merge_operands,
2750
      false /* internal key corruption is expected */);
2751
  auto compaction_filter = cfd->ioptions()->compaction_filter;
2752 2753
  std::unique_ptr<CompactionFilter> compaction_filter_from_factory = nullptr;
  if (!compaction_filter) {
2754
    auto context = compact->GetFilterContextV1();
2755
    compaction_filter_from_factory =
2756
        cfd->ioptions()->compaction_filter_factory->CreateCompactionFilter(
I
Igor Canadi 已提交
2757
            context);
2758 2759
    compaction_filter = compaction_filter_from_factory.get();
  }
2760

2761 2762 2763 2764
  int64_t key_drop_user = 0;
  int64_t key_drop_newer_entry = 0;
  int64_t key_drop_obsolete = 0;
  int64_t loop_cnt = 0;
2765 2766
  while (input->Valid() && !shutting_down_.Acquire_Load() &&
         !cfd->IsDropped()) {
2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783
    if (++loop_cnt > 1000) {
      if (key_drop_user > 0) {
        RecordTick(stats_, COMPACTION_KEY_DROP_USER, key_drop_user);
        key_drop_user = 0;
      }
      if (key_drop_newer_entry > 0) {
        RecordTick(stats_, COMPACTION_KEY_DROP_NEWER_ENTRY,
                   key_drop_newer_entry);
        key_drop_newer_entry = 0;
      }
      if (key_drop_obsolete > 0) {
        RecordTick(stats_, COMPACTION_KEY_DROP_OBSOLETE, key_drop_obsolete);
        key_drop_obsolete = 0;
      }
      RecordCompactionIOStats();
      loop_cnt = 0;
    }
2784 2785 2786 2787
    // 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
2788 2789
    imm_micros += CallFlushDuringCompaction(
        cfd, mutable_cf_options, deletion_state, log_buffer);
2790

D
Danny Guo 已提交
2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811
    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 已提交
2812

2813
    if (compact->compaction->ShouldStopBefore(key) &&
2814
        compact->builder != nullptr) {
D
Danny Guo 已提交
2815
      status = FinishCompactionOutputFile(compact, input);
2816 2817 2818 2819 2820 2821
      if (!status.ok()) {
        break;
      }
    }

    // Handle key/value, add to state, etc.
J
jorlow@chromium.org 已提交
2822
    bool drop = false;
2823
    bool current_entry_is_merging = false;
J
jorlow@chromium.org 已提交
2824 2825
    if (!ParseInternalKey(key, &ikey)) {
      // Do not hide error keys
2826 2827
      // 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.
2828
      current_user_key.Clear();
J
jorlow@chromium.org 已提交
2829 2830
      has_current_user_key = false;
      last_sequence_for_key = kMaxSequenceNumber;
2831
      visible_in_snapshot = kMaxSequenceNumber;
J
jorlow@chromium.org 已提交
2832 2833
    } else {
      if (!has_current_user_key ||
2834
          cfd->user_comparator()->Compare(ikey.user_key,
2835
                                          current_user_key.GetKey()) != 0) {
J
jorlow@chromium.org 已提交
2836
        // First occurrence of this user key
L
Lei Jin 已提交
2837
        current_user_key.SetKey(ikey.user_key);
J
jorlow@chromium.org 已提交
2838 2839
        has_current_user_key = true;
        last_sequence_for_key = kMaxSequenceNumber;
2840
        visible_in_snapshot = kMaxSequenceNumber;
H
Haobo Xu 已提交
2841
        // apply the compaction filter to the first occurrence of the user key
D
Danny Guo 已提交
2842
        if (compaction_filter && !is_compaction_v2 &&
H
Haobo Xu 已提交
2843 2844 2845 2846 2847 2848 2849 2850 2851
            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 已提交
2852 2853 2854
          bool to_delete = compaction_filter->Filter(
              compact->compaction->level(), ikey.user_key, value,
              &compaction_filter_value, &value_changed);
H
Haobo Xu 已提交
2855
          if (to_delete) {
2856 2857 2858
            // make a copy of the original key and convert it to a delete
            delete_key.SetInternalKey(ExtractUserKey(key), ikey.sequence,
                                      kTypeDeletion);
H
Haobo Xu 已提交
2859
            // anchor the key again
2860
            key = delete_key.GetKey();
H
Haobo Xu 已提交
2861 2862 2863 2864
            // needed because ikey is backed by key
            ParseInternalKey(key, &ikey);
            // no value associated with delete
            value.clear();
2865
            ++key_drop_user;
H
Haobo Xu 已提交
2866 2867 2868 2869
          } else if (value_changed) {
            value = compaction_filter_value;
          }
        }
J
jorlow@chromium.org 已提交
2870 2871
      }

2872 2873 2874
      // 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.
2875
      SequenceNumber prev_snapshot = 0; // 0 means no previous snapshot
2876 2877 2878 2879
      SequenceNumber visible = visible_at_tip ? visible_at_tip :
        is_snapshot_supported ?  findEarliestVisibleSnapshot(ikey.sequence,
                                  compact->existing_snapshots, &prev_snapshot)
                              : 0;
2880 2881 2882 2883 2884

      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 已提交
2885
        // Hidden by an newer entry for same user key
2886
        // TODO: why not > ?
2887
        assert(last_sequence_for_key >= ikey.sequence);
J
jorlow@chromium.org 已提交
2888
        drop = true;    // (A)
2889
        ++key_drop_newer_entry;
J
jorlow@chromium.org 已提交
2890
      } else if (ikey.type == kTypeDeletion &&
D
Danny Guo 已提交
2891
          ikey.sequence <= earliest_snapshot &&
2892
          compact->compaction->KeyNotExistsBeyondOutputLevel(ikey.user_key)) {
J
jorlow@chromium.org 已提交
2893 2894 2895 2896 2897 2898 2899 2900
        // 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;
2901
        ++key_drop_obsolete;
2902
      } else if (ikey.type == kTypeMerge) {
2903 2904 2905 2906 2907 2908
        if (!merge.HasOperator()) {
          LogToBuffer(log_buffer, "Options::merge_operator is null.");
          status = Status::InvalidArgument(
              "merge_operator is not properly initialized.");
          break;
        }
2909 2910 2911 2912 2913 2914
        // 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 已提交
2915 2916
        int steps = 0;
        merge.MergeUntil(input, prev_snapshot, bottommost_level,
2917
            db_options_.statistics.get(), &steps);
D
Danny Guo 已提交
2918 2919 2920
        // Skip the Merge ops
        combined_idx = combined_idx - 1 + steps;

2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938
        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 已提交
2939 2940 2941
      }

      last_sequence_for_key = ikey.sequence;
2942
      visible_in_snapshot = visible;
J
jorlow@chromium.org 已提交
2943 2944 2945
    }

    if (!drop) {
2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961
      // 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);
2962
      }
2963

2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974
      // 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.
2975
        if (bottommost_level && ikey.sequence < earliest_snapshot &&
2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986
            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
2987

2988 2989
        // Open output file if necessary
        if (compact->builder == nullptr) {
2990
          status = OpenCompactionOutputFile(compact, mutable_cf_options);
2991 2992 2993 2994
          if (!status.ok()) {
            break;
          }
        }
2995 2996

        SequenceNumber seqno = GetInternalKeySeqno(newkey);
2997 2998
        if (compact->builder->NumEntries() == 0) {
          compact->current_output()->smallest.DecodeFrom(newkey);
2999 3000 3001 3002
          compact->current_output()->smallest_seqno = seqno;
        } else {
          compact->current_output()->smallest_seqno =
            std::min(compact->current_output()->smallest_seqno, seqno);
3003 3004 3005
        }
        compact->current_output()->largest.DecodeFrom(newkey);
        compact->builder->Add(newkey, value);
3006
        (*num_output_records)++,
3007 3008
        compact->current_output()->largest_seqno =
          std::max(compact->current_output()->largest_seqno, seqno);
3009 3010 3011 3012

        // Close output file if it is big enough
        if (compact->builder->FileSize() >=
            compact->compaction->MaxOutputFileSize()) {
D
Danny Guo 已提交
3013
          status = FinishCompactionOutputFile(compact, input);
3014 3015 3016
          if (!status.ok()) {
            break;
          }
J
jorlow@chromium.org 已提交
3017 3018
        }

3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038
        // 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 已提交
3039 3040 3041 3042 3043
          break;
        }
      }
    }

3044
    // MergeUntil has moved input to the next entry
3045
    if (!current_entry_is_merging) {
3046 3047
      input->Next();
    }
J
jorlow@chromium.org 已提交
3048
  }
3049 3050 3051 3052 3053 3054 3055 3056 3057
  if (key_drop_user > 0) {
    RecordTick(stats_, COMPACTION_KEY_DROP_USER, key_drop_user);
  }
  if (key_drop_newer_entry > 0) {
    RecordTick(stats_, COMPACTION_KEY_DROP_NEWER_ENTRY, key_drop_newer_entry);
  }
  if (key_drop_obsolete > 0) {
    RecordTick(stats_, COMPACTION_KEY_DROP_OBSOLETE, key_drop_obsolete);
  }
3058 3059
  RecordCompactionIOStats();

D
Danny Guo 已提交
3060 3061 3062 3063 3064 3065 3066 3067 3068
  return status;
}

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

3069
  // Assemble slice vectors for user keys and existing values.
3070
  // We also keep track of our parsed internal key structs because
3071 3072 3073
  // 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 已提交
3074
  std::vector<Slice> user_key_buf;
3075 3076 3077 3078 3079 3080 3081 3082 3083 3084
  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 已提交
3085 3086 3087 3088 3089 3090 3091 3092 3093
  }

  // 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(),
3094
      user_key_buf, existing_value_buf,
D
Danny Guo 已提交
3095 3096 3097 3098 3099 3100
      &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() ==
3101
      compact->key_str_buf_.size());
D
Danny Guo 已提交
3102
  assert(compact->to_delete_buf_.size() ==
3103
      compact->existing_value_str_buf_.size());
D
Danny Guo 已提交
3104 3105 3106 3107 3108 3109 3110 3111 3112
  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],
3113 3114 3115
                        compact->key_str_buf_[i].size(),
                        ikey_buf[i].sequence,
                        kTypeDeletion);
D
Danny Guo 已提交
3116 3117

      // no value associated with delete
3118
      compact->existing_value_str_buf_[i].clear();
L
Lei Jin 已提交
3119
      RecordTick(stats_, COMPACTION_KEY_DROP_USER);
D
Danny Guo 已提交
3120
    } else if (compact->value_changed_buf_[i]) {
3121 3122
      compact->existing_value_str_buf_[i] =
          compact->new_value_buf_[new_value_idx++];
D
Danny Guo 已提交
3123 3124 3125 3126 3127
    }
  }  // for
}

Status DBImpl::DoCompactionWork(CompactionState* compact,
3128
                                const MutableCFOptions& mutable_cf_options,
D
Danny Guo 已提交
3129 3130 3131 3132 3133 3134
                                DeletionState& deletion_state,
                                LogBuffer* log_buffer) {
  assert(compact);
  compact->CleanupBatchBuffer();
  compact->CleanupMergedBuffer();

F
Feng Zhu 已提交
3135 3136
  // Generate file_levels_ for compaction berfore making Iterator
  compact->compaction->GenerateFileLevels();
D
Danny Guo 已提交
3137
  int64_t imm_micros = 0;  // Micros spent doing imm_ compactions
3138
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
3139 3140
  LogToBuffer(
      log_buffer,
I
Igor Canadi 已提交
3141 3142
      "[%s] Compacting %d@%d + %d@%d files, score %.2f slots available %d",
      cfd->GetName().c_str(), compact->compaction->num_input_files(0),
3143 3144
      compact->compaction->level(), compact->compaction->num_input_files(1),
      compact->compaction->output_level(), compact->compaction->score(),
3145
      db_options_.max_background_compactions - bg_compaction_scheduled_);
D
Danny Guo 已提交
3146 3147
  char scratch[2345];
  compact->compaction->Summary(scratch, sizeof(scratch));
I
Igor Canadi 已提交
3148 3149
  LogToBuffer(log_buffer, "[%s] Compaction start summary: %s\n",
              cfd->GetName().c_str(), scratch);
D
Danny Guo 已提交
3150

3151
  assert(cfd->current()->NumLevelFiles(compact->compaction->level()) > 0);
D
Danny Guo 已提交
3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176
  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);

3177
  bool is_snapshot_supported = IsSnapshotSupported();
D
Danny Guo 已提交
3178 3179
  // Release mutex while we're actually doing the compaction work
  mutex_.Unlock();
3180
  log_buffer->FlushBufferToLog();
D
Danny Guo 已提交
3181

3182
  int num_output_records = 0;
D
Danny Guo 已提交
3183 3184 3185 3186 3187 3188 3189 3190 3191 3192
  const uint64_t start_micros = env_->NowMicros();
  unique_ptr<Iterator> input(versions_->MakeInputIterator(compact->compaction));
  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 =
3193 3194
      cfd->ioptions()->compaction_filter_factory_v2->
          CreateCompactionFilterV2(context);
D
Danny Guo 已提交
3195 3196 3197
  auto compaction_filter_v2 =
    compaction_filter_from_factory_v2.get();

3198 3199
  if (!compaction_filter_v2) {
    status = ProcessKeyValueCompaction(
3200
      mutable_cf_options,
3201 3202 3203 3204 3205 3206 3207 3208 3209 3210
      is_snapshot_supported,
      visible_at_tip,
      earliest_snapshot,
      latest_snapshot,
      deletion_state,
      bottommost_level,
      imm_micros,
      input.get(),
      compact,
      false,
3211
      &num_output_records,
3212 3213 3214 3215 3216 3217 3218 3219 3220
      log_buffer);
  } else {
    // 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.
3221
    bool prefix_initialized = false;
3222 3223 3224
    shared_ptr<Iterator> backup_input(
        versions_->MakeInputIterator(compact->compaction));
    backup_input->SeekToFirst();
3225 3226
    while (backup_input->Valid() && !shutting_down_.Acquire_Load() &&
           !cfd->IsDropped()) {
I
Igor Canadi 已提交
3227 3228 3229 3230
      // 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
3231 3232
      imm_micros += CallFlushDuringCompaction(cfd, mutable_cf_options,
          deletion_state, log_buffer);
I
Igor Canadi 已提交
3233

D
Danny Guo 已提交
3234 3235 3236 3237 3238
      Slice key = backup_input->key();
      Slice value = backup_input->value();

      if (!ParseInternalKey(key, &ikey)) {
        // log error
3239
        Log(db_options_.info_log, "[%s] Failed to parse key: %s",
I
Igor Canadi 已提交
3240
            cfd->GetName().c_str(), key.ToString().c_str());
D
Danny Guo 已提交
3241 3242
        continue;
      } else {
3243
        const SliceTransform* transformer =
3244
            cfd->ioptions()->compaction_filter_factory_v2->GetPrefixExtractor();
3245 3246 3247 3248 3249
        const auto key_prefix = transformer->Transform(ikey.user_key);
        if (!prefix_initialized) {
          compact->cur_prefix_ = key_prefix.ToString();
          prefix_initialized = true;
        }
D
Danny Guo 已提交
3250
        // If the prefix remains the same, keep buffering
3251
        if (key_prefix.compare(Slice(compact->cur_prefix_)) == 0) {
D
Danny Guo 已提交
3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268
          // 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
3269
          if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3270 3271
            CallCompactionFilterV2(compact, compaction_filter_v2);
          }
3272
          compact->cur_prefix_ = key_prefix.ToString();
D
Danny Guo 已提交
3273 3274 3275 3276
        }
      }

      // Merge this batch of data (values + ineligible keys)
3277
      compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3278 3279 3280 3281

      // Done buffering for the current prefix. Spit it out to disk
      // Now just iterate through all the kv-pairs
      status = ProcessKeyValueCompaction(
3282
          mutable_cf_options,
3283
          is_snapshot_supported,
D
Danny Guo 已提交
3284 3285 3286 3287 3288 3289 3290 3291 3292
          visible_at_tip,
          earliest_snapshot,
          latest_snapshot,
          deletion_state,
          bottommost_level,
          imm_micros,
          input.get(),
          compact,
          true,
3293
          &num_output_records,
D
Danny Guo 已提交
3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313
          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.
3314
        if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3315 3316
          CallCompactionFilterV2(compact, compaction_filter_v2);
        }
3317
        compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3318 3319

        status = ProcessKeyValueCompaction(
3320
            mutable_cf_options,
3321
            is_snapshot_supported,
D
Danny Guo 已提交
3322 3323 3324 3325 3326 3327 3328 3329 3330
            visible_at_tip,
            earliest_snapshot,
            latest_snapshot,
            deletion_state,
            bottommost_level,
            imm_micros,
            input.get(),
            compact,
            true,
3331
            &num_output_records,
D
Danny Guo 已提交
3332 3333 3334 3335 3336 3337 3338
            log_buffer);

        compact->CleanupBatchBuffer();
        compact->CleanupMergedBuffer();
      }
    }  // done processing all prefix batches
    // finish the last batch
3339
    if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3340 3341
      CallCompactionFilterV2(compact, compaction_filter_v2);
    }
3342
    compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3343
    status = ProcessKeyValueCompaction(
3344
        mutable_cf_options,
3345
        is_snapshot_supported,
D
Danny Guo 已提交
3346 3347 3348 3349 3350 3351 3352 3353 3354
        visible_at_tip,
        earliest_snapshot,
        latest_snapshot,
        deletion_state,
        bottommost_level,
        imm_micros,
        input.get(),
        compact,
        true,
3355
        &num_output_records,
D
Danny Guo 已提交
3356 3357 3358
        log_buffer);
  }  // checking for compaction filter v2

3359
  if (status.ok() && (shutting_down_.Acquire_Load() || cfd->IsDropped())) {
L
Lei Jin 已提交
3360
    status = Status::ShutdownInProgress(
3361
        "Database shutdown or Column family drop during compaction");
J
jorlow@chromium.org 已提交
3362
  }
3363
  if (status.ok() && compact->builder != nullptr) {
3364
    status = FinishCompactionOutputFile(compact, input.get());
J
jorlow@chromium.org 已提交
3365 3366 3367 3368
  }
  if (status.ok()) {
    status = input->status();
  }
3369
  input.reset();
J
jorlow@chromium.org 已提交
3370

3371
  if (!db_options_.disableDataSync) {
3372 3373
    db_directory_->Fsync();
  }
I
Igor Canadi 已提交
3374

L
Lei Jin 已提交
3375
  InternalStats::CompactionStats stats(1);
3376
  stats.micros = env_->NowMicros() - start_micros - imm_micros;
M
Mark Callaghan 已提交
3377 3378
  stats.files_in_leveln = compact->compaction->num_input_files(0);
  stats.files_in_levelnp1 = compact->compaction->num_input_files(1);
L
Lei Jin 已提交
3379
  MeasureTime(stats_, COMPACTION_TIME, stats.micros);
3380 3381

  int num_output_files = compact->outputs.size();
3382
  if (compact->builder != nullptr) {
P
Pascal Borreli 已提交
3383
    // An error occurred so ignore the last output.
3384 3385 3386 3387
    assert(num_output_files > 0);
    --num_output_files;
  }
  stats.files_out_levelnp1 = num_output_files;
M
Mark Callaghan 已提交
3388

3389 3390
  uint64_t num_input_records = 0;

3391
  for (int i = 0; i < compact->compaction->num_input_files(0); i++) {
3392
    stats.bytes_readn += compact->compaction->input(0, i)->fd.GetFileSize();
3393 3394
    stats.num_input_records += compact->compaction->input(0, i)->num_entries;
    num_input_records += compact->compaction->input(0, i)->num_entries;
3395
  }
M
Mark Callaghan 已提交
3396

3397
  for (int i = 0; i < compact->compaction->num_input_files(1); i++) {
3398
    stats.bytes_readnp1 += compact->compaction->input(1, i)->fd.GetFileSize();
3399
    num_input_records += compact->compaction->input(1, i)->num_entries;
3400
  }
M
Mark Callaghan 已提交
3401

3402
  for (int i = 0; i < num_output_files; i++) {
3403 3404
    stats.bytes_written += compact->outputs[i].file_size;
  }
3405 3406
  stats.num_dropped_records =
      static_cast<int>(num_input_records) - num_output_records;
3407

3408 3409
  RecordCompactionIOStats();

3410
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
3411
  mutex_.Lock();
3412 3413
  cfd->internal_stats()->AddCompactionStats(
      compact->compaction->output_level(), stats);
J
jorlow@chromium.org 已提交
3414

3415 3416 3417 3418
  // 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 已提交
3419
  if (status.ok()) {
3420 3421
    status = InstallCompactionResults(compact, mutable_cf_options, log_buffer);
    InstallSuperVersion(cfd, deletion_state, mutable_cf_options);
J
jorlow@chromium.org 已提交
3422
  }
3423
  Version::LevelSummaryStorage tmp;
3424 3425
  LogToBuffer(
      log_buffer,
3426 3427
      "[%s] compacted to: %s, MB/sec: %.1f rd, %.1f wr, level %d, "
      "files in(%d, %d) out(%d) "
3428
      "MB in(%.1f, %.1f) out(%.1f), read-write-amplify(%.1f) "
3429
      "write-amplify(%.1f) %s, records in: %d, records dropped: %d\n",
I
Igor Canadi 已提交
3430
      cfd->GetName().c_str(), cfd->current()->LevelSummary(&tmp),
3431 3432 3433
      (stats.bytes_readn + stats.bytes_readnp1) /
          static_cast<double>(stats.micros),
      stats.bytes_written / static_cast<double>(stats.micros),
3434 3435 3436
      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 已提交
3437
      stats.bytes_written / 1048576.0,
3438
      (stats.bytes_written + stats.bytes_readnp1 + stats.bytes_readn) /
3439 3440
          (double)stats.bytes_readn,
      stats.bytes_written / (double)stats.bytes_readn,
3441 3442
      status.ToString().c_str(), stats.num_input_records,
      stats.num_dropped_records);
M
Mark Callaghan 已提交
3443

J
jorlow@chromium.org 已提交
3444 3445 3446
  return status;
}

3447 3448
namespace {
struct IterState {
3449 3450
  IterState(DBImpl* db, port::Mutex* mu, SuperVersion* super_version)
      : db(db), mu(mu), super_version(super_version) {}
3451 3452

  DBImpl* db;
3453
  port::Mutex* mu;
3454
  SuperVersion* super_version;
3455 3456 3457 3458
};

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

3460
  if (state->super_version->Unref()) {
3461 3462
    DBImpl::DeletionState deletion_state;

3463 3464 3465 3466 3467 3468
    state->mu->Lock();
    state->super_version->Cleanup();
    state->db->FindObsoleteFiles(deletion_state, false, true);
    state->mu->Unlock();

    delete state->super_version;
3469 3470 3471
    if (deletion_state.HaveSomethingToDelete()) {
      state->db->PurgeObsoleteFiles(deletion_state);
    }
I
Igor Canadi 已提交
3472
  }
T
Tomislav Novak 已提交
3473

3474 3475
  delete state;
}
H
Hans Wennborg 已提交
3476
}  // namespace
3477

L
Lei Jin 已提交
3478
Iterator* DBImpl::NewInternalIterator(const ReadOptions& read_options,
3479
                                      ColumnFamilyData* cfd,
3480 3481 3482
                                      SuperVersion* super_version,
                                      Arena* arena) {
  Iterator* internal_iter;
3483 3484 3485 3486 3487
  assert(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(
L
Lei Jin 已提交
3488
      super_version->mem->NewIterator(read_options, arena));
3489
  // Collect all needed child iterators for immutable memtables
L
Lei Jin 已提交
3490
  super_version->imm->AddIterators(read_options, &merge_iter_builder);
3491
  // Collect iterators for files in L0 - Ln
L
Lei Jin 已提交
3492
  super_version->current->AddIterators(read_options, env_options_,
3493 3494
                                       &merge_iter_builder);
  internal_iter = merge_iter_builder.Finish();
3495
  IterState* cleanup = new IterState(this, &mutex_, super_version);
3496
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
3497 3498 3499 3500

  return internal_iter;
}

3501 3502 3503 3504
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
3505
Status DBImpl::Get(const ReadOptions& read_options,
3506
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3507
                   std::string* value) {
L
Lei Jin 已提交
3508
  return GetImpl(read_options, column_family, key, value);
3509 3510
}

I
Igor Canadi 已提交
3511 3512 3513
// DeletionState gets created and destructed outside of the lock -- we
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3514
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3515 3516 3517 3518 3519 3520
//
// 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
3521 3522 3523
void DBImpl::InstallSuperVersion(
    ColumnFamilyData* cfd, DeletionState& deletion_state,
    const MutableCFOptions& mutable_cf_options) {
3524
  mutex_.AssertHeld();
3525
  SuperVersion* old_superversion =
L
Lei Jin 已提交
3526 3527
      InstallSuperVersion(cfd, deletion_state.new_superversion,
                          mutable_cf_options);
I
Igor Canadi 已提交
3528
  deletion_state.new_superversion = nullptr;
3529
  deletion_state.superversions_to_free.push_back(old_superversion);
I
Igor Canadi 已提交
3530 3531
}

L
Lei Jin 已提交
3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557
SuperVersion* DBImpl::InstallSuperVersion(
    ColumnFamilyData* cfd, SuperVersion* new_sv,
    const MutableCFOptions& mutable_cf_options) {
  mutex_.AssertHeld();
  auto* old = cfd->InstallSuperVersion(
      new_sv ? new_sv : new SuperVersion(), &mutex_, mutable_cf_options);

  // We want to schedule potential flush or compactions since new options may
  // have been picked up in this new version. New options may cause flush
  // compaction trigger condition to change.
  MaybeScheduleFlushOrCompaction();

  // Update max_total_in_memory_state_
  auto old_memtable_size = 0;
  if (old) {
    old_memtable_size = old->mutable_cf_options.write_buffer_size *
                        old->mutable_cf_options.max_write_buffer_number;
  }
  max_total_in_memory_state_ =
      max_total_in_memory_state_ - old_memtable_size +
      mutable_cf_options.write_buffer_size *
      mutable_cf_options.max_write_buffer_number;
  return old;
}

Status DBImpl::GetImpl(const ReadOptions& read_options,
3558 3559
                       ColumnFamilyHandle* column_family, const Slice& key,
                       std::string* value, bool* value_found) {
L
Lei Jin 已提交
3560
  StopWatch sw(env_, stats_, DB_GET);
3561
  PERF_TIMER_GUARD(get_snapshot_time);
3562

3563 3564 3565
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3566
  SequenceNumber snapshot;
L
Lei Jin 已提交
3567 3568 3569
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3570 3571
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3572
  }
3573

3574
  // Acquire SuperVersion
3575
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
I
Igor Canadi 已提交
3576

3577
  // Prepare to store a list of merge operations if merge occurs.
3578
  MergeContext merge_context;
3579

3580
  Status s;
3581
  // First look in the memtable, then in the immutable memtable (if any).
3582
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3583
  // merge_operands will contain the sequence of merges in the latter case.
3584
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3585
  PERF_TIMER_STOP(get_snapshot_time);
3586

3587
  if (sv->mem->Get(lkey, value, &s, &merge_context)) {
3588
    // Done
L
Lei Jin 已提交
3589
    RecordTick(stats_, MEMTABLE_HIT);
3590
  } else if (sv->imm->Get(lkey, value, &s, &merge_context)) {
3591
    // Done
L
Lei Jin 已提交
3592
    RecordTick(stats_, MEMTABLE_HIT);
3593
  } else {
3594
    PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3595 3596
    sv->current->Get(read_options, lkey, value, &s, &merge_context,
                     value_found);
L
Lei Jin 已提交
3597
    RecordTick(stats_, MEMTABLE_MISS);
3598
  }
3599

3600 3601
  {
    PERF_TIMER_GUARD(get_post_process_time);
3602

3603
    ReturnAndCleanupSuperVersion(cfd, sv);
3604

3605 3606 3607
    RecordTick(stats_, NUMBER_KEYS_READ);
    RecordTick(stats_, BYTES_READ, value->size());
  }
3608
  return s;
J
jorlow@chromium.org 已提交
3609 3610
}

3611
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
3612
    const ReadOptions& read_options,
3613
    const std::vector<ColumnFamilyHandle*>& column_family,
3614
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3615

L
Lei Jin 已提交
3616
  StopWatch sw(env_, stats_, DB_MULTIGET);
3617
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
3618

3619
  SequenceNumber snapshot;
3620

3621
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3622
    ColumnFamilyData* cfd;
3623 3624 3625 3626 3627
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3628 3629 3630 3631 3632 3633
    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});
3634 3635 3636
    }
  }

3637
  mutex_.Lock();
L
Lei Jin 已提交
3638 3639 3640
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3641 3642 3643
  } else {
    snapshot = versions_->LastSequence();
  }
3644
  for (auto mgd_iter : multiget_cf_data) {
3645 3646
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3647
  }
3648
  mutex_.Unlock();
3649

3650 3651
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3652

3653
  // Note: this always resizes the values array
3654 3655 3656
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3657 3658

  // Keep track of bytes that we read for statistics-recording later
3659
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3660
  PERF_TIMER_STOP(get_snapshot_time);
3661 3662 3663 3664

  // 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.
3665
  // merge_operands will contain the sequence of merges in the latter case.
3666
  for (size_t i = 0; i < num_keys; ++i) {
3667
    merge_context.Clear();
3668
    Status& s = stat_list[i];
3669 3670 3671
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3672 3673
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3674 3675 3676
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
3677
    if (super_version->mem->Get(lkey, value, &s, &merge_context)) {
3678
      // Done
3679
    } else if (super_version->imm->Get(lkey, value, &s, &merge_context)) {
3680 3681
      // Done
    } else {
3682
      PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3683 3684
      super_version->current->Get(read_options, lkey, value, &s,
                                  &merge_context);
3685 3686 3687
    }

    if (s.ok()) {
3688
      bytes_read += value->size();
3689 3690 3691 3692
    }
  }

  // Post processing (decrement reference counts and record statistics)
3693
  PERF_TIMER_GUARD(get_post_process_time);
3694 3695
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
3696
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3697 3698 3699 3700 3701 3702
  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);
3703 3704
    }
  }
3705 3706 3707 3708 3709 3710 3711
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3712
  }
3713

L
Lei Jin 已提交
3714 3715 3716
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
L
Lei Jin 已提交
3717
  PERF_TIMER_STOP(get_post_process_time);
3718

3719
  return stat_list;
3720 3721
}

L
Lei Jin 已提交
3722
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
3723
                                  const std::string& column_family_name,
3724
                                  ColumnFamilyHandle** handle) {
I
Igor Canadi 已提交
3725 3726 3727
  *handle = nullptr;
  MutexLock l(&mutex_);

I
Igor Canadi 已提交
3728 3729
  if (versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name) !=
      nullptr) {
I
Igor Canadi 已提交
3730 3731
    return Status::InvalidArgument("Column family already exists");
  }
3732
  VersionEdit edit;
3733
  edit.AddColumnFamily(column_family_name);
3734 3735
  uint32_t new_id = versions_->GetColumnFamilySet()->GetNextColumnFamilyID();
  edit.SetColumnFamily(new_id);
I
Igor Canadi 已提交
3736
  edit.SetLogNumber(logfile_number_);
L
Lei Jin 已提交
3737
  edit.SetComparatorName(cf_options.comparator->Name());
3738

I
Igor Canadi 已提交
3739 3740
  // LogAndApply will both write the creation in MANIFEST and create
  // ColumnFamilyData object
L
Lei Jin 已提交
3741
  Options opt(db_options_, cf_options);
3742 3743
  Status s = versions_->LogAndApply(nullptr,
      MutableCFOptions(opt, ImmutableCFOptions(opt)),
L
Lei Jin 已提交
3744
      &edit, &mutex_, db_directory_.get(), false, &cf_options);
3745
  if (s.ok()) {
3746
    single_column_family_mode_ = false;
3747 3748 3749
    auto cfd =
        versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
    assert(cfd != nullptr);
L
Lei Jin 已提交
3750
    delete InstallSuperVersion(cfd, nullptr, *cfd->GetLatestMutableCFOptions());
3751
    *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
3752
    Log(db_options_.info_log, "Created column family [%s] (ID %u)",
3753 3754
        column_family_name.c_str(), (unsigned)cfd->GetID());
  } else {
3755
    Log(db_options_.info_log, "Creating column family [%s] FAILED -- %s",
3756 3757
        column_family_name.c_str(), s.ToString().c_str());
  }
3758
  return s;
3759 3760
}

3761 3762 3763 3764
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3765 3766
    return Status::InvalidArgument("Can't drop default column family");
  }
3767

I
Igor Canadi 已提交
3768 3769
  VersionEdit edit;
  edit.DropColumnFamily();
3770 3771
  edit.SetColumnFamily(cfd->GetID());

3772
  Status s;
3773 3774 3775 3776 3777 3778
  {
    MutexLock l(&mutex_);
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
3779
      // we drop column family from a single write thread
I
Igor Canadi 已提交
3780 3781
      WriteThread::Writer w(&mutex_);
      s = write_thread_.EnterWriteThread(&w, 0);
3782
      assert(s.ok() && !w.done);  // No timeout and nobody should do our job
3783 3784
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
I
Igor Canadi 已提交
3785
      write_thread_.ExitWriteThread(&w, &w, s);
3786
    }
3787
  }
3788

3789
  if (s.ok()) {
I
Igor Canadi 已提交
3790
    assert(cfd->IsDropped());
L
Lei Jin 已提交
3791 3792 3793
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ -= mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
3794 3795
    Log(db_options_.info_log, "Dropped column family with id %u\n",
        cfd->GetID());
3796
  } else {
3797 3798
    Log(db_options_.info_log,
        "Dropping column family with id %u FAILED -- %s\n",
3799 3800 3801
        cfd->GetID(), s.ToString().c_str());
  }

3802
  return s;
3803 3804
}

L
Lei Jin 已提交
3805
bool DBImpl::KeyMayExist(const ReadOptions& read_options,
3806 3807
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
3808
  if (value_found != nullptr) {
K
Kai Liu 已提交
3809 3810
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
3811
  }
L
Lei Jin 已提交
3812
  ReadOptions roptions = read_options;
3813
  roptions.read_tier = kBlockCacheTier; // read from block cache only
3814
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
3815

3816
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
3817 3818 3819
  // 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();
3820 3821
}

3822
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
3823 3824 3825
                              ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
3826

3827
  if (read_options.tailing) {
I
Igor Canadi 已提交
3828 3829 3830 3831
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
3832 3833
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
    auto iter = new ForwardIterator(this, read_options, cfd, sv);
3834
    return NewDBIterator(env_, *cfd->ioptions(), cfd->user_comparator(), iter,
3835 3836 3837
        kMaxSequenceNumber,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
        read_options.iterate_upper_bound);
I
Igor Canadi 已提交
3838
#endif
T
Tomislav Novak 已提交
3839
  } else {
3840
    SequenceNumber latest_snapshot = versions_->LastSequence();
3841
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
3842

I
Igor Canadi 已提交
3843
    auto snapshot =
3844 3845 3846
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
3847
            : latest_snapshot;
T
Tomislav Novak 已提交
3848

3849 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
    // 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(
3892
        env_, *cfd->ioptions(), cfd->user_comparator(),
3893
        snapshot, sv->mutable_cf_options.max_sequential_skip_in_iterations,
3894
        read_options.iterate_upper_bound);
3895

3896
    Iterator* internal_iter =
3897
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
3898 3899 3900 3901
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
3902 3903
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
3904 3905
}

3906
Status DBImpl::NewIterators(
3907
    const ReadOptions& read_options,
I
Igor Canadi 已提交
3908
    const std::vector<ColumnFamilyHandle*>& column_families,
3909
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3910 3911 3912
  iterators->clear();
  iterators->reserve(column_families.size());

3913
  if (read_options.tailing) {
I
Igor Canadi 已提交
3914 3915 3916 3917
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
3918 3919
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
3920 3921
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
      auto iter = new ForwardIterator(this, read_options, cfd, sv);
L
Lei Jin 已提交
3922
      iterators->push_back(
3923
          NewDBIterator(env_, *cfd->ioptions(), cfd->user_comparator(), iter,
3924 3925
              kMaxSequenceNumber,
              sv->mutable_cf_options.max_sequential_skip_in_iterations));
I
Igor Canadi 已提交
3926
    }
I
Igor Canadi 已提交
3927
#endif
I
Igor Canadi 已提交
3928
  } else {
3929 3930
    SequenceNumber latest_snapshot = versions_->LastSequence();

I
Igor Canadi 已提交
3931
    for (size_t i = 0; i < column_families.size(); ++i) {
3932 3933 3934
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
3935 3936

      auto snapshot =
3937 3938 3939
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
3940 3941
              : latest_snapshot;

3942
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
3943
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
3944
          sv->mutable_cf_options.max_sequential_skip_in_iterations);
3945
      Iterator* internal_iter = NewInternalIterator(
3946
          read_options, cfd, sv, db_iter->GetArena());
3947 3948
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
3949 3950 3951 3952
    }
  }

  return Status::OK();
3953 3954
}

3955 3956 3957 3958 3959 3960 3961 3962 3963
bool DBImpl::IsSnapshotSupported() const {
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (!cfd->mem()->IsSnapshotSupported()) {
      return false;
    }
  }
  return true;
}

J
jorlow@chromium.org 已提交
3964
const Snapshot* DBImpl::GetSnapshot() {
3965
  MutexLock l(&mutex_);
3966 3967
  // returns null if the underlying memtable does not support snapshot.
  if (!IsSnapshotSupported()) return nullptr;
3968
  return snapshots_.New(versions_->LastSequence());
J
jorlow@chromium.org 已提交
3969 3970 3971 3972
}

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

// Convenience methods
3977 3978
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
3979
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
3980 3981
}

3982 3983 3984
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
3985
  if (!cfh->cfd()->ioptions()->merge_operator) {
3986 3987
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
3988
    return DB::Merge(o, column_family, key, val);
3989 3990 3991
  }
}

L
Lei Jin 已提交
3992
Status DBImpl::Delete(const WriteOptions& write_options,
3993
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
3994
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
3995 3996
}

L
Lei Jin 已提交
3997
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
S
Stanislau Hlebik 已提交
3998 3999 4000
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
4001
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
I
Igor Canadi 已提交
4002
  WriteThread::Writer w(&mutex_);
S
Stanislau Hlebik 已提交
4003
  w.batch = my_batch;
L
Lei Jin 已提交
4004 4005
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
S
Stanislau Hlebik 已提交
4006 4007
  w.in_batch_group = false;
  w.done = false;
L
Lei Jin 已提交
4008
  w.timeout_hint_us = write_options.timeout_hint_us;
S
Stanislau Hlebik 已提交
4009 4010

  uint64_t expiration_time = 0;
I
Igor Canadi 已提交
4011
  bool has_timeout = false;
S
Stanislau Hlebik 已提交
4012
  if (w.timeout_hint_us == 0) {
I
Igor Canadi 已提交
4013
    w.timeout_hint_us = WriteThread::kNoTimeOut;
S
Stanislau Hlebik 已提交
4014 4015
  } else {
    expiration_time = env_->NowMicros() + w.timeout_hint_us;
I
Igor Canadi 已提交
4016
    has_timeout = true;
S
Stanislau Hlebik 已提交
4017 4018
  }

L
Lei Jin 已提交
4019
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4020 4021 4022 4023 4024 4025
    RecordTick(stats_, WRITE_WITH_WAL);
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_WITH_WAL, 1);
  }

  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4026
  Status status = write_thread_.EnterWriteThread(&w, expiration_time);
S
Stanislau Hlebik 已提交
4027 4028
  assert(status.ok() || status.IsTimedOut());
  if (status.IsTimedOut()) {
4029
    mutex_.Unlock();
L
Lei Jin 已提交
4030
    RecordTick(stats_, WRITE_TIMEDOUT);
4031
    return Status::TimedOut();
4032
  }
S
Stanislau Hlebik 已提交
4033 4034 4035 4036 4037 4038 4039 4040 4041 4042
  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);
4043

4044 4045 4046 4047
  // 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.
4048 4049 4050
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

4051
  uint64_t max_total_wal_size = (db_options_.max_total_wal_size == 0)
4052
                                    ? 4 * max_total_in_memory_state_
4053
                                    : db_options_.max_total_wal_size;
4054
  if (UNLIKELY(!single_column_family_mode_) &&
4055
      alive_log_files_.begin()->getting_flushed == false &&
I
Igor Canadi 已提交
4056
      total_log_size_ > max_total_wal_size) {
I
Igor Canadi 已提交
4057
    uint64_t flush_column_family_if_log_file = alive_log_files_.begin()->number;
I
Igor Canadi 已提交
4058
    alive_log_files_.begin()->getting_flushed = true;
4059
    Log(db_options_.info_log,
4060 4061 4062
        "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 已提交
4063 4064
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4065
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
4066
      if (cfd->GetLogNumber() <= flush_column_family_if_log_file) {
S
Stanislau Hlebik 已提交
4067
        status = SetNewMemtableAndNewLogFile(cfd, &context);
I
Igor Canadi 已提交
4068 4069 4070
        if (!status.ok()) {
          break;
        }
S
Stanislau Hlebik 已提交
4071
        cfd->imm()->FlushRequested();
4072
      }
4073
    }
I
Igor Canadi 已提交
4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086
    MaybeScheduleFlushOrCompaction();
  }

  if (UNLIKELY(status.ok() && !bg_error_.ok())) {
    status = bg_error_;
  }

  if (UNLIKELY(status.ok() && !flush_scheduler_.Empty())) {
    status = ScheduleFlushes(&context);
  }

  if (UNLIKELY(status.ok()) &&
      (write_controller_.IsStopped() || write_controller_.GetDelay() > 0)) {
I
Igor Canadi 已提交
4087
    status = DelayWrite(expiration_time);
I
Igor Canadi 已提交
4088 4089 4090 4091 4092
  }

  if (UNLIKELY(status.ok() && has_timeout &&
               env_->NowMicros() > expiration_time)) {
    status = Status::TimedOut();
4093
  }
4094

D
dgrogan@chromium.org 已提交
4095
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4096
  WriteThread::Writer* last_writer = &w;
S
Stanislau Hlebik 已提交
4097
  if (status.ok()) {
4098
    autovector<WriteBatch*> write_batch_group;
I
Igor Canadi 已提交
4099
    write_thread_.BuildBatchGroup(&last_writer, &write_batch_group);
4100

4101 4102 4103
    // 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
4104
    // into memtables
4105
    {
4106
      mutex_.Unlock();
4107 4108 4109 4110 4111 4112 4113 4114 4115 4116
      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]);
        }
      }

4117 4118 4119 4120
      const SequenceNumber current_sequence = last_sequence + 1;
      WriteBatchInternal::SetSequence(updates, current_sequence);
      int my_batch_count = WriteBatchInternal::Count(updates);
      last_sequence += my_batch_count;
4121
      const uint64_t batch_size = WriteBatchInternal::ByteSize(updates);
4122
      // Record statistics
L
Lei Jin 已提交
4123
      RecordTick(stats_, NUMBER_KEYS_WRITTEN, my_batch_count);
S
sdong 已提交
4124
      RecordTick(stats_, BYTES_WRITTEN, batch_size);
L
Lei Jin 已提交
4125
      if (write_options.disableWAL) {
4126
        flush_on_destroy_ = true;
4127
      }
L
Lei Jin 已提交
4128
      PERF_TIMER_STOP(write_pre_and_post_process_time);
4129

4130
      uint64_t log_size = 0;
L
Lei Jin 已提交
4131
      if (!write_options.disableWAL) {
4132
        PERF_TIMER_GUARD(write_wal_time);
4133 4134
        Slice log_entry = WriteBatchInternal::Contents(updates);
        status = log_->AddRecord(log_entry);
I
Igor Canadi 已提交
4135 4136
        total_log_size_ += log_entry.size();
        alive_log_files_.back().AddSize(log_entry.size());
4137
        log_empty_ = false;
4138
        log_size = log_entry.size();
L
Lei Jin 已提交
4139
        RecordTick(stats_, WAL_FILE_BYTES, log_size);
L
Lei Jin 已提交
4140
        if (status.ok() && write_options.sync) {
I
Igor Canadi 已提交
4141
          RecordTick(stats_, WAL_FILE_SYNCED);
4142
          StopWatch sw(env_, stats_, WAL_FILE_SYNC_MICROS);
4143
          if (db_options_.use_fsync) {
4144
            status = log_->file()->Fsync();
4145
          } else {
4146
            status = log_->file()->Sync();
4147
          }
H
heyongqiang 已提交
4148
        }
4149 4150
      }
      if (status.ok()) {
4151
        PERF_TIMER_GUARD(write_memtable_time);
Y
Yueh-Hsuan Chiang 已提交
4152

4153
        status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
4154
            updates, column_family_memtables_.get(),
L
Lei Jin 已提交
4155
            write_options.ignore_missing_column_families, 0, this, false);
Y
Yueh-Hsuan Chiang 已提交
4156 4157 4158 4159 4160 4161 4162 4163
        // 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 已提交
4164
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
4165
      }
L
Lei Jin 已提交
4166
      PERF_TIMER_START(write_pre_and_post_process_time);
4167 4168 4169
      if (updates == &tmp_batch_) {
        tmp_batch_.Clear();
      }
4170
      mutex_.Lock();
4171 4172 4173
      // internal stats
      default_cf_internal_stats_->AddDBStats(
          InternalStats::BYTES_WRITTEN, batch_size);
S
sdong 已提交
4174 4175
      default_cf_internal_stats_->AddDBStats(InternalStats::NUMBER_KEYS_WRITTEN,
                                             my_batch_count);
L
Lei Jin 已提交
4176
      if (!write_options.disableWAL) {
4177 4178 4179 4180 4181
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_SYNCED, 1);
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_BYTES, log_size);
      }
4182
      if (status.ok()) {
4183
        versions_->SetLastSequence(last_sequence);
4184
      }
J
jorlow@chromium.org 已提交
4185 4186
    }
  }
4187
  if (db_options_.paranoid_checks && !status.ok() &&
4188
      !status.IsTimedOut() && bg_error_.ok()) {
I
Igor Canadi 已提交
4189 4190
    bg_error_ = status; // stop compaction & fail any further writes
  }
4191

I
Igor Canadi 已提交
4192
  write_thread_.ExitWriteThread(&w, last_writer, status);
I
Igor Canadi 已提交
4193
  mutex_.Unlock();
4194

4195
  if (status.IsTimedOut()) {
L
Lei Jin 已提交
4196
    RecordTick(stats_, WRITE_TIMEDOUT);
4197 4198
  }

J
jorlow@chromium.org 已提交
4199 4200 4201
  return status;
}

4202 4203
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
4204
Status DBImpl::DelayWrite(uint64_t expiration_time) {
4205 4206 4207 4208 4209 4210 4211 4212 4213
  StopWatch sw(env_, stats_, WRITE_STALL);
  bool has_timeout = (expiration_time > 0);
  auto delay = write_controller_.GetDelay();
  if (write_controller_.IsStopped() == false && delay > 0) {
    mutex_.Unlock();
    env_->SleepForMicroseconds(delay);
    mutex_.Lock();
  }

I
Igor Canadi 已提交
4214
  while (bg_error_.ok() && write_controller_.IsStopped()) {
4215 4216 4217
    if (has_timeout) {
      bg_cv_.TimedWait(expiration_time);
      if (env_->NowMicros() > expiration_time) {
I
Igor Canadi 已提交
4218
        return Status::TimedOut();
4219 4220 4221 4222 4223
      }
    } else {
      bg_cv_.Wait();
    }
  }
I
Igor Canadi 已提交
4224 4225

  return bg_error_;
4226 4227
}

I
Igor Canadi 已提交
4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238
Status DBImpl::ScheduleFlushes(WriteContext* context) {
  bool schedule_bg_work = false;
  ColumnFamilyData* cfd;
  while ((cfd = flush_scheduler_.GetNextColumnFamily()) != nullptr) {
    schedule_bg_work = true;
    auto status = SetNewMemtableAndNewLogFile(cfd, context);
    if (cfd->Unref()) {
      delete cfd;
    }
    if (!status.ok()) {
      return status;
S
Stanislau Hlebik 已提交
4239 4240
    }
  }
I
Igor Canadi 已提交
4241 4242 4243 4244
  if (schedule_bg_work) {
    MaybeScheduleFlushOrCompaction();
  }
  return Status::OK();
S
Stanislau Hlebik 已提交
4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262
}

// 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;
4263
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
S
Stanislau Hlebik 已提交
4264 4265 4266 4267
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
4268 4269 4270
      s = env_->NewWritableFile(
          LogFileName(db_options_.wal_dir, new_log_number),
          &lfile, env_->OptimizeForLogWrite(env_options_));
S
Stanislau Hlebik 已提交
4271 4272 4273
      if (s.ok()) {
        // Our final size should be less than write_buffer_size
        // (compression, etc) but err on the side of caution.
L
Lei Jin 已提交
4274 4275
        lfile->SetPreallocationBlockSize(
            1.1 * mutable_cf_options.write_buffer_size);
S
Stanislau Hlebik 已提交
4276
        new_log = new log::Writer(std::move(lfile));
I
Igor Canadi 已提交
4277
      }
S
Stanislau Hlebik 已提交
4278 4279 4280
    }

    if (s.ok()) {
L
Lei Jin 已提交
4281 4282
      new_mem = new MemTable(cfd->internal_comparator(), *cfd->ioptions(),
                             mutable_cf_options);
S
Stanislau Hlebik 已提交
4283 4284 4285
      new_superversion = new SuperVersion();
    }
  }
I
Igor Canadi 已提交
4286 4287 4288
  Log(db_options_.info_log,
      "[%s] New memtable created with log file: #%" PRIu64 "\n",
      cfd->GetName().c_str(), new_log_number);
S
Stanislau Hlebik 已提交
4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313
  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_);
4314
      }
4315 4316
    }
  }
S
Stanislau Hlebik 已提交
4317 4318 4319 4320 4321
  cfd->mem()->SetNextLogNumber(logfile_number_);
  cfd->imm()->Add(cfd->mem());
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
  context->superversions_to_free_.push_back(
L
Lei Jin 已提交
4322
      InstallSuperVersion(cfd, new_superversion, mutable_cf_options));
4323 4324 4325
  return s;
}

I
Igor Canadi 已提交
4326
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4327 4328 4329 4330 4331
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4332 4333
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4334
  auto version = cfd->current();
4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
I
Igor Canadi 已提交
4347
#endif  // ROCKSDB_LITE
4348

I
Igor Canadi 已提交
4349 4350 4351 4352
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4353 4354 4355 4356
Env* DBImpl::GetEnv() const {
  return env_;
}

4357 4358
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4359
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4360 4361
}

4362
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4363
                         const Slice& property, std::string* value) {
4364 4365
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4366 4367 4368
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);

4369
  value->clear();
4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384
  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 已提交
4385 4386
}

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

  if (!need_out_of_mutex) {
    MutexLock l(&mutex_);
4408
    return cfd->internal_stats()->GetIntProperty(property_type, value, this);
4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422
  } 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
I
Igor Canadi 已提交
4423
  return cfd->GetThreadLocalSuperVersion(&mutex_);
4424 4425 4426 4427
}

void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
4428
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441

  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);
  }
4442 4443
}

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

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

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

L
Lei Jin 已提交
4476
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492
  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;
  }
4493
  iter->reset(new TransactionLogIteratorImpl(db_options_.wal_dir, &db_options_,
L
Lei Jin 已提交
4494
                                             read_options, env_options_,
I
Igor Canadi 已提交
4495 4496 4497 4498
                                             seq, std::move(wal_files), this));
  return (*iter)->status();
}

4499 4500 4501
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4502 4503 4504
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
4505
    Log(db_options_.info_log, "DeleteFile %s failed.\n", name.c_str());
4506 4507 4508
    return Status::InvalidArgument("Invalid file name");
  }

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

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

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

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

4586
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4587
  MutexLock l(&mutex_);
4588
  versions_->GetLiveFilesMetaData(metadata);
4589
}
I
Igor Canadi 已提交
4590
#endif  // ROCKSDB_LITE
4591

I
Igor Canadi 已提交
4592 4593 4594 4595 4596 4597 4598
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
4601 4602 4603 4604 4605 4606
    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) {
4607
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619
                             ". 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);
  }
}

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

4659 4660
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
4661
  WriteBatch batch;
4662
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
4663 4664 4665
  return Write(opt, &batch);
}

4666 4667
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
4668
  WriteBatch batch;
4669
  batch.Merge(column_family, key, value);
4670 4671 4672
  return Write(opt, &batch);
}

4673
// Default implementation -- returns not supported status
L
Lei Jin 已提交
4674
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
4675
                              const std::string& column_family_name,
4676
                              ColumnFamilyHandle** handle) {
4677
  return Status::NotSupported("");
4678
}
4679
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
4680
  return Status::NotSupported("");
4681 4682
}

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

J
Jim Paton 已提交
4685
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
4686 4687 4688 4689
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
4690
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
4691
  std::vector<ColumnFamilyHandle*> handles;
4692
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
4693 4694 4695 4696 4697 4698 4699
  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;
4700 4701
}

4702 4703
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
4704
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
4705
  Status s = SanitizeOptionsByTable(db_options, column_families);
4706 4707 4708
  if (!s.ok()) {
    return s;
  }
4709
  if (db_options.db_paths.size() > 1) {
4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721
    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. ");
    }
4722 4723
  }

4724
  *dbptr = nullptr;
4725
  handles->clear();
J
jorlow@chromium.org 已提交
4726

I
Igor Canadi 已提交
4727 4728 4729 4730
  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);
4731
  }
4732

I
Igor Canadi 已提交
4733
  DBImpl* impl = new DBImpl(db_options, dbname);
4734
  s = impl->env_->CreateDirIfMissing(impl->db_options_.wal_dir);
4735
  if (s.ok()) {
4736
    for (auto db_path : impl->db_options_.db_paths) {
4737
      s = impl->env_->CreateDirIfMissing(db_path.path);
4738 4739 4740 4741 4742 4743
      if (!s.ok()) {
        break;
      }
    }
  }

4744 4745 4746 4747 4748 4749
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
4750 4751 4752 4753
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
4754
  impl->mutex_.Lock();
4755 4756
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
4757
  if (s.ok()) {
4758
    uint64_t new_log_number = impl->versions_->NewFileNumber();
4759
    unique_ptr<WritableFile> lfile;
4760
    EnvOptions soptions(db_options);
4761 4762 4763
    s = impl->db_options_.env->NewWritableFile(
        LogFileName(impl->db_options_.wal_dir, new_log_number), &lfile,
        impl->db_options_.env->OptimizeForLogWrite(soptions));
J
jorlow@chromium.org 已提交
4764
    if (s.ok()) {
4765
      lfile->SetPreallocationBlockSize(1.1 * max_write_buffer_size);
4766
      impl->logfile_number_ = new_log_number;
4767
      impl->log_.reset(new log::Writer(std::move(lfile)));
I
Igor Canadi 已提交
4768

4769 4770
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
4771 4772
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791
        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 已提交
4792
        }
4793
      }
I
Igor Canadi 已提交
4794 4795
    }
    if (s.ok()) {
4796
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
4797 4798
        delete impl->InstallSuperVersion(
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
4799
      }
I
Igor Canadi 已提交
4800 4801
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
4802
      impl->DeleteObsoleteFiles();
4803
      impl->MaybeScheduleFlushOrCompaction();
4804
      s = impl->db_directory_->Fsync();
J
jorlow@chromium.org 已提交
4805 4806
    }
  }
4807

I
Igor Canadi 已提交
4808 4809
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
4810 4811
      if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
          cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
I
Igor Canadi 已提交
4812 4813 4814 4815
        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 已提交
4816 4817 4818
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
                "open with universal or FIFO compaction style.");
I
Igor Canadi 已提交
4819 4820 4821 4822
            break;
          }
        }
      }
4823
      if (cfd->ioptions()->merge_operator != nullptr &&
4824 4825 4826 4827 4828
          !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 已提交
4829
      if (!s.ok()) {
4830 4831 4832 4833 4834
        break;
      }
    }
  }

4835 4836
  impl->mutex_.Unlock();

J
jorlow@chromium.org 已提交
4837
  if (s.ok()) {
4838
    impl->opened_successfully_ = true;
J
jorlow@chromium.org 已提交
4839 4840
    *dbptr = impl;
  } else {
4841 4842 4843
    for (auto h : *handles) {
      delete h;
    }
4844
    handles->clear();
J
jorlow@chromium.org 已提交
4845 4846 4847 4848 4849
    delete impl;
  }
  return s;
}

4850 4851 4852
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
4853
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
4854 4855
}

4856 4857 4858
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
4859
Status DestroyDB(const std::string& dbname, const Options& options) {
4860
  const InternalKeyComparator comparator(options.comparator);
4861
  const Options& soptions(SanitizeOptions(dbname, &comparator, options));
4862
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
4863
  std::vector<std::string> filenames;
4864 4865
  std::vector<std::string> archiveFiles;

4866
  std::string archivedir = ArchivalDirectory(dbname);
J
jorlow@chromium.org 已提交
4867 4868
  // Ignore error in case directory does not exist
  env->GetChildren(dbname, &filenames);
4869 4870 4871 4872 4873 4874 4875

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

J
jorlow@chromium.org 已提交
4877 4878 4879 4880 4881
  if (filenames.empty()) {
    return Status::OK();
  }

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

4905 4906
    for (auto& db_path : options.db_paths) {
      env->GetChildren(db_path.path, &filenames);
4907 4908 4909 4910 4911
      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
4912
          Status del = env->DeleteFile(db_path.path + "/" + filenames[i]);
4913 4914 4915 4916 4917 4918 4919
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

4920
    env->GetChildren(archivedir, &archiveFiles);
4921 4922
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
4923 4924
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
4925
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
4926 4927 4928 4929 4930
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4931
    // ignore case where no archival directory is present.
4932
    env->DeleteDir(archivedir);
4933

J
jorlow@chromium.org 已提交
4934
    env->UnlockFile(lock);  // Ignore error since state is already gone
4935
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
4936
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
4937
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
4938 4939 4940 4941
  }
  return result;
}

4942 4943
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
4944
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
4945
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
4946 4947 4948 4949
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
  Log(log, "RocksDB version: %d.%d.%d\n", ROCKSDB_MAJOR, ROCKSDB_MINOR,
      ROCKSDB_PATCH);
4950
  Log(log, "Git sha %s", rocksdb_build_git_sha);
4951
  Log(log, "Compile time %s %s",
4952
      rocksdb_build_compile_time, rocksdb_build_compile_date);
I
Igor Canadi 已提交
4953
#endif
4954 4955
}

4956
}  // namespace rocksdb