db_impl.cc 172.3 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
Status SanitizeDBOptionsByCFOptions(
286
    const DBOptions* db_opts,
287 288 289 290 291 292 293 294 295 296 297
    const std::vector<ColumnFamilyDescriptor>& column_families) {
  Status s;
  for (auto cf : column_families) {
    s = cf.options.table_factory->SanitizeDBOptions(db_opts);
    if (!s.ok()) {
      return s;
    }
  }
  return Status::OK();
}

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()) {
1231 1232
          cfd->CreateNewMemtable(MemTableOptions(
              *cfd->GetLatestMutableCFOptions(), *cfd->options()));
S
Stanislau Hlebik 已提交
1233 1234
        }
      }
1235
    }
L
Lei Jin 已提交
1236
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1237 1238
  }

L
Lei Jin 已提交
1239 1240
  // Initial value
  max_total_in_memory_state_ = 0;
I
Igor Canadi 已提交
1241
  for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1242 1243 1244
    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 已提交
1245 1246
  }

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

S
Stanislau Hlebik 已提交
1250 1251 1252
// 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 已提交
1253 1254
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1255
    Logger* info_log;
J
jorlow@chromium.org 已提交
1256
    const char* fname;
1257 1258
    Status* status;  // nullptr if db_options_.paranoid_checks==false or
                     //            db_options_.skip_log_error_on_recovery==true
J
jorlow@chromium.org 已提交
1259
    virtual void Corruption(size_t bytes, const Status& s) {
1260
      Log(info_log, "%s%s: dropping %d bytes; %s",
1261
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1262
          fname, static_cast<int>(bytes), s.ToString().c_str());
1263
      if (this->status != nullptr && this->status->ok()) *this->status = s;
J
jorlow@chromium.org 已提交
1264 1265 1266 1267
    }
  };

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

S
Stanislau Hlebik 已提交
1277 1278 1279 1280 1281 1282 1283 1284 1285
  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 已提交
1286
    if (!status.ok()) {
S
Stanislau Hlebik 已提交
1287 1288 1289 1290 1291 1292 1293 1294
      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 已提交
1295 1296
    }

S
Stanislau Hlebik 已提交
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 1344
    // 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 已提交
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
        // 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;
1362
          }
1363 1364
          cfd->CreateNewMemtable(MemTableOptions(
              *cfd->GetLatestMutableCFOptions(), *cfd->options()));
1365
        }
J
jorlow@chromium.org 已提交
1366 1367 1368
      }
    }

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

1375
  if (!read_only) {
1376 1377
    // 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 已提交
1378
    auto max_log_number = log_numbers.back();
1379
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1380
      auto iter = version_edits.find(cfd->GetID());
1381 1382 1383
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

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

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

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

J
jorlow@chromium.org 已提交
1426 1427 1428
  return status;
}

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

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

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

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

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

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

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

1498 1499
  const SequenceNumber newest_snapshot = snapshots_.GetNewest();
  const SequenceNumber earliest_seqno_in_memtable =
1500
    mems[0]->GetFirstSequenceNumber();
1501
  Version* base = cfd->current();
1502
  base->Ref();          // it is likely that we do not need this reference
1503 1504 1505
  Status s;
  {
    mutex_.Unlock();
H
Haobo Xu 已提交
1506
    log_buffer->FlushBufferToLog();
K
Kai Liu 已提交
1507
    std::vector<Iterator*> memtables;
1508 1509
    ReadOptions ro;
    ro.total_order_seek = true;
1510
    Arena arena;
1511
    for (MemTable* m : mems) {
1512
      Log(db_options_.info_log,
1513 1514
          "[%s] Flushing memtable with next log file: %" PRIu64 "\n",
          cfd->GetName().c_str(), m->GetNextLogNumber());
1515 1516 1517 1518 1519 1520
      memtables.push_back(m->NewIterator(ro, &arena));
    }
    {
      ScopedArenaIterator iter(NewMergingIterator(&cfd->internal_comparator(),
                                                  &memtables[0],
                                                  memtables.size(), &arena));
1521 1522
      Log(db_options_.info_log,
           "[%s] Level-0 flush table #%" PRIu64 ": started",
1523 1524 1525 1526 1527
          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,
1528 1529
          earliest_seqno_in_memtable, GetCompressionFlush(*cfd->ioptions()),
          cfd->ioptions()->compression_opts, Env::IO_HIGH);
1530
      LogFlush(db_options_.info_log);
1531
    }
1532
    Log(db_options_.info_log,
1533
        "[%s] Level-0 flush table #%" PRIu64 ": %" PRIu64 " bytes %s",
F
Feng Zhu 已提交
1534
        cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
1535
        s.ToString().c_str());
I
Igor Canadi 已提交
1536

1537
    if (!db_options_.disableDataSync) {
1538 1539
      db_directory_->Fsync();
    }
1540 1541
    mutex_.Lock();
  }
1542 1543
  base->Unref();

1544
  // re-acquire the most current version
1545
  base = cfd->current();
1546 1547 1548 1549 1550 1551

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

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

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

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

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

1616

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

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

L
Lei Jin 已提交
1626
  if (!s.ok()) {
1627
    cfd->imm()->RollbackMemtableFlush(mems, file_number, &pending_outputs_);
1628 1629
  } else {
    // Replace immutable memtable with the generated Table
1630
    s = cfd->imm()->InstallMemtableFlushResults(
1631 1632 1633
        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);
1634
  }
J
jorlow@chromium.org 已提交
1635 1636

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

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

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

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

1675 1676
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
I
Igor Canadi 已提交
1677 1678

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

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

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

1718 1719 1720 1721 1722 1723 1724
  {
    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 已提交
1725
  return s;
1726 1727
}

1728 1729 1730 1731 1732 1733 1734
bool DBImpl::SetOptions(ColumnFamilyHandle* column_family,
    const std::unordered_map<std::string, std::string>& options_map) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  MutexLock l(&mutex_);
  return cfh->cfd()->SetOptions(options_map);
}

1735
// return the same level if it cannot be moved
1736 1737
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd,
    const MutableCFOptions& mutable_cf_options, int level) {
1738
  mutex_.AssertHeld();
I
Igor Canadi 已提交
1739
  Version* current = cfd->current();
1740
  int minimum_level = level;
1741
  for (int i = level - 1; i > 0; --i) {
1742
    // stop if level i is not empty
1743
    if (current->NumLevelFiles(i) > 0) break;
1744
    // stop if level i is too small (cannot fit the level files)
1745
    if (mutable_cf_options.MaxBytesForLevel(i) <
1746 1747 1748
        current->NumLevelBytes(level)) {
      break;
    }
1749 1750 1751 1752 1753 1754

    minimum_level = i;
  }
  return minimum_level;
}

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

I
Igor Canadi 已提交
1758
  SuperVersion* superversion_to_free = nullptr;
1759
  SuperVersion* new_superversion = new SuperVersion();
I
Igor Canadi 已提交
1760 1761

  mutex_.Lock();
1762 1763 1764

  // only allow one thread refitting
  if (refitting_level_) {
I
Igor Canadi 已提交
1765
    mutex_.Unlock();
1766
    Log(db_options_.info_log, "ReFitLevel: another thread is refitting");
I
Igor Canadi 已提交
1767
    delete new_superversion;
L
Lei Jin 已提交
1768
    return Status::NotSupported("another thread is refitting");
1769 1770 1771 1772 1773
  }
  refitting_level_ = true;

  // wait for all background threads to stop
  bg_work_gate_closed_ = true;
1774
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_) {
1775
    Log(db_options_.info_log,
1776 1777
        "RefitLevel: waiting for background threads to stop: %d %d",
        bg_compaction_scheduled_, bg_flush_scheduled_);
1778 1779 1780
    bg_cv_.Wait();
  }

1781 1782
  const MutableCFOptions mutable_cf_options =
    *cfd->GetLatestMutableCFOptions();
1783
  // move to a smaller level
1784 1785
  int to_level = target_level;
  if (target_level < 0) {
1786
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
1787
  }
1788 1789 1790

  assert(to_level <= level);

L
Lei Jin 已提交
1791
  Status status;
1792
  if (to_level < level) {
1793 1794
    Log(db_options_.info_log, "[%s] Before refitting:\n%s",
        cfd->GetName().c_str(), cfd->current()->DebugString().data());
1795

1796
    VersionEdit edit;
I
Igor Canadi 已提交
1797 1798
    edit.SetColumnFamily(cfd->GetID());
    for (const auto& f : cfd->current()->files_[level]) {
1799
      edit.DeleteFile(level, f->fd.GetNumber());
1800 1801 1802
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
                   f->smallest_seqno, f->largest_seqno);
1803
    }
1804
    Log(db_options_.info_log, "[%s] Apply version edit:\n%s",
I
Igor Canadi 已提交
1805
        cfd->GetName().c_str(), edit.DebugString().data());
1806

1807 1808
    status = versions_->LogAndApply(cfd,
        mutable_cf_options, &edit, &mutex_, db_directory_.get());
L
Lei Jin 已提交
1809 1810
    superversion_to_free = InstallSuperVersion(
        cfd, new_superversion, mutable_cf_options);
I
Igor Canadi 已提交
1811
    new_superversion = nullptr;
1812

1813
    Log(db_options_.info_log, "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
1814
        status.ToString().data());
1815 1816

    if (status.ok()) {
1817
      Log(db_options_.info_log, "[%s] After refitting:\n%s",
I
Igor Canadi 已提交
1818
          cfd->GetName().c_str(), cfd->current()->DebugString().data());
1819 1820 1821 1822 1823
    }
  }

  refitting_level_ = false;
  bg_work_gate_closed_ = false;
I
Igor Canadi 已提交
1824 1825 1826 1827

  mutex_.Unlock();
  delete superversion_to_free;
  delete new_superversion;
L
Lei Jin 已提交
1828
  return status;
G
Gabor Cselle 已提交
1829 1830
}

1831 1832 1833
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
1834 1835
}

1836 1837 1838
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->options()->max_mem_compaction_level;
1839 1840
}

1841 1842 1843
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->options()->level0_stop_writes_trigger;
1844 1845
}

L
Lei Jin 已提交
1846
Status DBImpl::Flush(const FlushOptions& flush_options,
1847 1848
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
1849
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
1850 1851
}

1852
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
1853 1854 1855
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
1856
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
1857 1858
                                   int output_level, uint32_t output_path_id,
                                   const Slice* begin, const Slice* end) {
1859
  assert(input_level >= 0);
1860

G
Gabor Cselle 已提交
1861 1862
  InternalKey begin_storage, end_storage;

H
hans@chromium.org 已提交
1863
  ManualCompaction manual;
I
Igor Canadi 已提交
1864
  manual.cfd = cfd;
1865 1866
  manual.input_level = input_level;
  manual.output_level = output_level;
1867
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
1868
  manual.done = false;
1869
  manual.in_progress = false;
1870 1871 1872
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
1873 1874
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
1875
    manual.begin = nullptr;
G
Gabor Cselle 已提交
1876 1877 1878 1879
  } else {
    begin_storage = InternalKey(*begin, kMaxSequenceNumber, kValueTypeForSeek);
    manual.begin = &begin_storage;
  }
1880
  if (end == nullptr ||
1881 1882
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
1883
    manual.end = nullptr;
G
Gabor Cselle 已提交
1884 1885 1886 1887 1888 1889
  } else {
    end_storage = InternalKey(*end, 0, static_cast<ValueType>(0));
    manual.end = &end_storage;
  }

  MutexLock l(&mutex_);
1890

1891 1892 1893 1894 1895 1896
  // 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
1897
  // RunManualCompaction(), i.e. during that time no other compaction will
1898 1899 1900
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
1901
  // RunManualCompaction() from getting to the second while loop below.
1902 1903 1904 1905 1906
  // 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) {
1907
    Log(db_options_.info_log,
I
Igor Canadi 已提交
1908 1909 1910
        "[%s] Manual compaction waiting for all other scheduled background "
        "compactions to finish",
        cfd->GetName().c_str());
1911 1912
    bg_cv_.Wait();
  }
1913

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

1917 1918 1919 1920
  // 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) {
1921 1922 1923
    assert(bg_manual_only_ > 0);
    if (manual_compaction_ != nullptr) {
      // Running either this or some other manual compaction
G
Gabor Cselle 已提交
1924
      bg_cv_.Wait();
1925 1926
    } else {
      manual_compaction_ = &manual;
1927 1928
      bg_compaction_scheduled_++;
      env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW);
G
Gabor Cselle 已提交
1929
    }
H
hans@chromium.org 已提交
1930
  }
1931

1932 1933 1934
  assert(!manual.in_progress);
  assert(bg_manual_only_ > 0);
  --bg_manual_only_;
L
Lei Jin 已提交
1935
  return manual.status;
J
jorlow@chromium.org 已提交
1936 1937
}

1938
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
L
Lei Jin 已提交
1939
                             const FlushOptions& flush_options) {
S
Stanislau Hlebik 已提交
1940 1941 1942 1943
  Status s;
  {
    WriteContext context;
    MutexLock guard_lock(&mutex_);
1944 1945 1946 1947 1948 1949

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

I
Igor Canadi 已提交
1950 1951
    WriteThread::Writer w(&mutex_);
    s = write_thread_.EnterWriteThread(&w, 0);
S
Stanislau Hlebik 已提交
1952 1953 1954 1955 1956 1957 1958 1959
    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 已提交
1960
    write_thread_.ExitWriteThread(&w, &w, s);
S
Stanislau Hlebik 已提交
1961
  }
S
Stanislau Hlebik 已提交
1962

L
Lei Jin 已提交
1963
  if (s.ok() && flush_options.wait) {
1964
    // Wait until the compaction completes
1965
    s = WaitForFlushMemTable(cfd);
1966 1967
  }
  return s;
J
jorlow@chromium.org 已提交
1968 1969
}

1970
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
1971 1972 1973
  Status s;
  // Wait until the compaction completes
  MutexLock l(&mutex_);
1974
  while (cfd->imm()->size() > 0 && bg_error_.ok()) {
1975 1976
    bg_cv_.Wait();
  }
1977
  if (!bg_error_.ok()) {
1978 1979 1980
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
1981 1982
}

1983
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
1984
  mutex_.AssertHeld();
1985
  bg_schedule_needed_ = false;
1986 1987
  if (bg_work_gate_closed_) {
    // gate closed for backgrond work
J
jorlow@chromium.org 已提交
1988 1989 1990
  } else if (shutting_down_.Acquire_Load()) {
    // DB is being deleted; no more background compactions
  } else {
1991
    bool is_flush_pending = false;
1992
    // no need to refcount since we're under a mutex
1993
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
1994
      if (cfd->imm()->IsFlushPending()) {
1995 1996 1997
        is_flush_pending = true;
      }
    }
1998
    if (is_flush_pending) {
1999
      // memtable flush needed
2000
      if (bg_flush_scheduled_ < db_options_.max_background_flushes) {
2001 2002
        bg_flush_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH);
2003
      } else if (db_options_.max_background_flushes > 0) {
2004
        bg_schedule_needed_ = true;
2005
      }
2006
    }
2007
    bool is_compaction_needed = false;
2008
    // no need to refcount since we're under a mutex
2009
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
2010
      if (cfd->current()->NeedsCompaction()) {
2011 2012 2013 2014
        is_compaction_needed = true;
        break;
      }
    }
2015

2016 2017
    // Schedule BGWorkCompaction if there's a compaction pending (or a memtable
    // flush, but the HIGH pool is not enabled)
2018 2019 2020 2021
    // Do it only if max_background_compactions hasn't been reached and
    // bg_manual_only_ == 0
    if (!bg_manual_only_ &&
        (is_compaction_needed ||
2022 2023
         (is_flush_pending && db_options_.max_background_flushes == 0))) {
      if (bg_compaction_scheduled_ < db_options_.max_background_compactions) {
2024 2025 2026 2027 2028
        bg_compaction_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW);
      } else {
        bg_schedule_needed_ = true;
      }
2029 2030 2031 2032
    }
  }
}

2033
void DBImpl::RecordFlushIOStats() {
I
Igor Canadi 已提交
2034
  RecordTick(stats_, FLUSH_WRITE_BYTES, IOSTATS(bytes_written));
2035 2036 2037 2038
  IOSTATS_RESET(bytes_written);
}

void DBImpl::RecordCompactionIOStats() {
L
Lei Jin 已提交
2039
  RecordTick(stats_, COMPACT_READ_BYTES, IOSTATS(bytes_read));
2040
  IOSTATS_RESET(bytes_read);
L
Lei Jin 已提交
2041
  RecordTick(stats_, COMPACT_WRITE_BYTES, IOSTATS(bytes_written));
2042 2043 2044
  IOSTATS_RESET(bytes_written);
}

2045
void DBImpl::BGWorkFlush(void* db) {
2046
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
2047 2048 2049 2050
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
}

void DBImpl::BGWorkCompaction(void* db) {
2051
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
2052 2053 2054
  reinterpret_cast<DBImpl*>(db)->BackgroundCallCompaction();
}

I
Igor Canadi 已提交
2055
Status DBImpl::BackgroundFlush(bool* madeProgress,
H
Haobo Xu 已提交
2056 2057
                               DeletionState& deletion_state,
                               LogBuffer* log_buffer) {
2058
  mutex_.AssertHeld();
2059 2060 2061 2062 2063

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

2064 2065 2066 2067 2068
  // 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
2069
  for (auto cfd : *versions_->GetColumnFamilySet()) {
2070 2071
    cfd->Ref();
    Status flush_status;
2072 2073
    const MutableCFOptions mutable_cf_options =
      *cfd->GetLatestMutableCFOptions();
2074
    while (flush_status.ok() && cfd->imm()->IsFlushPending()) {
2075 2076
      LogToBuffer(
          log_buffer,
2077
          "BackgroundCallFlush doing FlushMemTableToOutputFile with column "
I
Igor Canadi 已提交
2078 2079
          "family [%s], flush slots available %d",
          cfd->GetName().c_str(),
2080
          db_options_.max_background_flushes - bg_flush_scheduled_);
2081 2082
      flush_status = FlushMemTableToOutputFile(
          cfd, mutable_cf_options, madeProgress, deletion_state, log_buffer);
2083 2084 2085
    }
    if (call_status.ok() && !flush_status.ok()) {
      call_status = flush_status;
2086
    }
2087
    cfd->Unref();
J
jorlow@chromium.org 已提交
2088
  }
2089
  versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
2090
  return call_status;
J
jorlow@chromium.org 已提交
2091 2092
}

2093
void DBImpl::BackgroundCallFlush() {
2094
  bool madeProgress = false;
K
Kai Liu 已提交
2095
  DeletionState deletion_state(true);
2096 2097
  assert(bg_flush_scheduled_);

2098
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
H
Haobo Xu 已提交
2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109
  {
    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.
2110 2111
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
H
Haobo Xu 已提交
2112 2113
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
2114
        Log(db_options_.info_log,
2115 2116 2117
            "Waiting after background flush error: %s"
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
H
Haobo Xu 已提交
2118
        log_buffer.FlushBufferToLog();
2119
        LogFlush(db_options_.info_log);
H
Haobo Xu 已提交
2120 2121 2122 2123 2124 2125 2126 2127 2128
        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
2129
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2130
      mutex_.Unlock();
2131 2132 2133 2134 2135
      // 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 已提交
2136
      log_buffer.FlushBufferToLog();
2137 2138 2139
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2140 2141
      mutex_.Lock();
    }
I
Igor Canadi 已提交
2142

H
Haobo Xu 已提交
2143
    bg_flush_scheduled_--;
2144 2145 2146 2147 2148
    // 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 已提交
2149 2150
      MaybeScheduleFlushOrCompaction();
    }
I
Igor Canadi 已提交
2151
    RecordFlushIOStats();
H
Haobo Xu 已提交
2152
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
2153 2154 2155 2156
    // 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.
2157
  }
J
jorlow@chromium.org 已提交
2158 2159
}

2160
void DBImpl::BackgroundCallCompaction() {
2161
  bool madeProgress = false;
K
Kai Liu 已提交
2162
  DeletionState deletion_state(true);
H
Haobo Xu 已提交
2163 2164

  MaybeDumpStats();
2165
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176
  {
    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.
2177 2178
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
2179 2180
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
H
Haobo Xu 已提交
2181
        log_buffer.FlushBufferToLog();
2182
        Log(db_options_.info_log,
2183 2184 2185
            "Waiting after background compaction error: %s, "
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
2186
        LogFlush(db_options_.info_log);
2187 2188 2189 2190
        env_->SleepForMicroseconds(1000000);
        mutex_.Lock();
      }
    }
H
Haobo Xu 已提交
2191

2192 2193 2194 2195 2196 2197 2198
    // 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
2199
    if (deletion_state.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2200
      mutex_.Unlock();
2201 2202 2203 2204 2205
      // 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 已提交
2206
      log_buffer.FlushBufferToLog();
2207 2208 2209
      if (deletion_state.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(deletion_state);
      }
2210 2211
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
2212

2213
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2214

2215 2216
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

2217 2218 2219
    // Previous compaction may have produced too many files in a level,
    // So reschedule another compaction if we made progress in the
    // last compaction.
2220 2221 2222 2223 2224 2225
    //
    // 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_) {
2226 2227
      MaybeScheduleFlushOrCompaction();
    }
2228 2229
    if (madeProgress || bg_compaction_scheduled_ == 0 || bg_manual_only_ > 0) {
      // signal if
I
Igor Canadi 已提交
2230
      // * madeProgress -- need to wakeup DelayWrite
2231 2232 2233 2234 2235 2236
      // * 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 已提交
2237 2238 2239 2240
    // 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.
2241
  }
J
jorlow@chromium.org 已提交
2242 2243
}

A
Abhishek Kona 已提交
2244
Status DBImpl::BackgroundCompaction(bool* madeProgress,
2245 2246
                                    DeletionState& deletion_state,
                                    LogBuffer* log_buffer) {
2247
  *madeProgress = false;
J
jorlow@chromium.org 已提交
2248
  mutex_.AssertHeld();
2249

2250 2251
  bool is_manual = (manual_compaction_ != nullptr) &&
                   (manual_compaction_->in_progress == false);
2252

2253 2254 2255 2256 2257 2258 2259 2260 2261 2262
  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_;
  }

2263 2264 2265
  if (is_manual) {
    // another thread cannot pick up the same work
    manual_compaction_->in_progress = true;
2266 2267 2268 2269
  } else if (manual_compaction_ != nullptr) {
    // there should be no automatic compactions running when manual compaction
    // is running
    return Status::OK();
2270 2271 2272 2273 2274
  }

  // FLUSH preempts compaction
  Status flush_stat;
  for (auto cfd : *versions_->GetColumnFamilySet()) {
2275 2276
    const MutableCFOptions mutable_cf_options =
      *cfd->GetLatestMutableCFOptions();
2277 2278 2279 2280 2281
    while (cfd->imm()->IsFlushPending()) {
      LogToBuffer(
          log_buffer,
          "BackgroundCompaction doing FlushMemTableToOutputFile, "
          "compaction slots available %d",
2282
          db_options_.max_background_compactions - bg_compaction_scheduled_);
2283
      cfd->Ref();
2284 2285
      flush_stat = FlushMemTableToOutputFile(
          cfd, mutable_cf_options, madeProgress, deletion_state, log_buffer);
2286
      cfd->Unref();
2287 2288 2289 2290 2291 2292 2293
      if (!flush_stat.ok()) {
        if (is_manual) {
          manual_compaction_->status = flush_stat;
          manual_compaction_->done = true;
          manual_compaction_->in_progress = false;
          manual_compaction_ = nullptr;
        }
2294
        return flush_stat;
2295 2296 2297 2298
      }
    }
  }

2299 2300 2301
  // 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
2302
  unique_ptr<Compaction> c;
2303 2304
  InternalKey manual_end_storage;
  InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
2305
  if (is_manual) {
G
Gabor Cselle 已提交
2306
    ManualCompaction* m = manual_compaction_;
2307
    assert(m->in_progress);
2308 2309 2310
    c.reset(m->cfd->CompactRange(
          *m->cfd->GetLatestMutableCFOptions(), m->input_level, m->output_level,
          m->output_path_id, m->begin, m->end, &manual_end));
2311
    if (!c) {
2312
      m->done = true;
G
Gabor Cselle 已提交
2313
    }
I
Igor Canadi 已提交
2314 2315 2316 2317 2318 2319 2320 2321 2322
    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 已提交
2323
  } else {
2324
    // no need to refcount in iteration since it's always under a mutex
I
Igor Canadi 已提交
2325
    for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
2326 2327 2328 2329
      // 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) {
2330 2331 2332
        // 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 已提交
2333
        c.reset(cfd->PickCompaction(*mutable_cf_options, log_buffer));
I
Igor Canadi 已提交
2334 2335
        if (c != nullptr) {
          // update statistics
L
Lei Jin 已提交
2336
          MeasureTime(stats_, NUM_FILES_IN_SINGLE_COMPACTION,
I
Igor Canadi 已提交
2337 2338 2339
                      c->inputs(0)->size());
          break;
        }
I
Igor Canadi 已提交
2340 2341
      }
    }
J
jorlow@chromium.org 已提交
2342 2343 2344
  }

  Status status;
2345
  if (!c) {
H
hans@chromium.org 已提交
2346
    // Nothing to do
2347
    LogToBuffer(log_buffer, "Compaction nothing to do");
I
Igor Canadi 已提交
2348 2349 2350 2351 2352
  } 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);
2353
    assert(c->column_family_data()->ioptions()->compaction_style ==
I
Igor Canadi 已提交
2354 2355
           kCompactionStyleFIFO);
    for (const auto& f : *c->inputs(0)) {
2356
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
2357
    }
2358 2359 2360 2361 2362
    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 已提交
2363 2364 2365 2366 2367
    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 已提交
2368
  } else if (!is_manual && c->IsTrivialMove()) {
J
jorlow@chromium.org 已提交
2369
    // Move file to next level
2370
    assert(c->num_input_files(0) == 1);
J
jorlow@chromium.org 已提交
2371
    FileMetaData* f = c->input(0, 0);
2372
    c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
2373 2374 2375
    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);
2376 2377 2378
    status = versions_->LogAndApply(c->column_family_data(),
                                    *c->mutable_cf_options(),
                                    c->edit(), &mutex_, db_directory_.get());
2379
    // Use latest MutableCFOptions
2380 2381
    InstallSuperVersion(c->column_family_data(), deletion_state,
                        *c->mutable_cf_options());
2382

2383
    Version::LevelSummaryStorage tmp;
2384
    LogToBuffer(
2385 2386
        log_buffer,
        "[%s] Moved #%" PRIu64 " to level-%d %" PRIu64 " bytes %s: %s\n",
2387
        c->column_family_data()->GetName().c_str(),
2388 2389
        f->fd.GetNumber(), c->level() + 1,
        f->fd.GetFileSize(),
2390
        status.ToString().c_str(), c->input_version()->LevelSummary(&tmp));
I
Igor Canadi 已提交
2391
    c->ReleaseCompactionFiles(status);
2392
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2393
  } else {
2394
    MaybeScheduleFlushOrCompaction(); // do more compaction work in parallel.
2395
    CompactionState* compact = new CompactionState(c.get());
2396 2397
    status = DoCompactionWork(compact, *c->mutable_cf_options(),
                              deletion_state, log_buffer);
2398
    CleanupCompaction(compact, status);
I
Igor Canadi 已提交
2399
    c->ReleaseCompactionFiles(status);
2400
    c->ReleaseInputs();
2401
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2402
  }
2403
  c.reset();
J
jorlow@chromium.org 已提交
2404 2405 2406

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
2407
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
2408 2409
    // Ignore compaction errors found during shutting down
  } else {
2410
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log, "Compaction error: %s",
2411
        status.ToString().c_str());
2412
    if (db_options_.paranoid_checks && bg_error_.ok()) {
J
jorlow@chromium.org 已提交
2413 2414 2415
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
2416 2417

  if (is_manual) {
G
Gabor Cselle 已提交
2418
    ManualCompaction* m = manual_compaction_;
2419
    if (!status.ok()) {
L
Lei Jin 已提交
2420
      m->status = status;
2421 2422
      m->done = true;
    }
2423 2424 2425 2426 2427 2428 2429 2430 2431
    // 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.
2432 2433 2434 2435 2436
    //
    // 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) {
2437 2438
      m->done = true;
    }
G
Gabor Cselle 已提交
2439 2440 2441
    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 已提交
2442
      // Universal and FIFO compactions should always compact the whole range
2443 2444
      assert(m->cfd->ioptions()->compaction_style != kCompactionStyleUniversal);
      assert(m->cfd->ioptions()->compaction_style != kCompactionStyleFIFO);
2445
      m->tmp_storage = *manual_end;
G
Gabor Cselle 已提交
2446 2447
      m->begin = &m->tmp_storage;
    }
2448
    m->in_progress = false; // not being processed anymore
2449
    manual_compaction_ = nullptr;
H
hans@chromium.org 已提交
2450
  }
2451
  return status;
J
jorlow@chromium.org 已提交
2452 2453
}

2454
void DBImpl::CleanupCompaction(CompactionState* compact, Status status) {
J
jorlow@chromium.org 已提交
2455
  mutex_.AssertHeld();
2456
  if (compact->builder != nullptr) {
J
jorlow@chromium.org 已提交
2457 2458
    // May happen if we get a shutdown call in the middle of compaction
    compact->builder->Abandon();
2459
    compact->builder.reset();
J
jorlow@chromium.org 已提交
2460
  } else {
2461
    assert(compact->outfile == nullptr);
J
jorlow@chromium.org 已提交
2462
  }
D
dgrogan@chromium.org 已提交
2463
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2464 2465
    const CompactionState::Output& out = compact->outputs[i];
    pending_outputs_.erase(out.number);
2466 2467 2468 2469

    // 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 已提交
2470
      TableCache::Evict(table_cache_.get(), out.number);
2471
    }
J
jorlow@chromium.org 已提交
2472 2473 2474 2475
  }
  delete compact;
}

2476
// Allocate the file numbers for the output file. We allocate as
2477
// many output file numbers as there are files in level+1 (at least one)
2478 2479 2480
// Insert them into pending_outputs so that they do not get deleted.
void DBImpl::AllocateCompactionOutputFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2481 2482
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
2483
  int filesNeeded = compact->compaction->num_input_files(1);
2484
  for (int i = 0; i < std::max(filesNeeded, 1); i++) {
2485
    uint64_t file_number = versions_->NewFileNumber();
2486
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
2487 2488 2489 2490 2491 2492 2493
    compact->allocated_file_numbers.push_back(file_number);
  }
}

// Frees up unused file number.
void DBImpl::ReleaseCompactionUnusedFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2494
  for (const auto file_number : compact->allocated_file_numbers) {
2495 2496 2497 2498
    pending_outputs_.erase(file_number);
  }
}

2499 2500
Status DBImpl::OpenCompactionOutputFile(
    CompactionState* compact, const MutableCFOptions& mutable_cf_options) {
2501 2502
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
J
jorlow@chromium.org 已提交
2503
  uint64_t file_number;
2504 2505 2506 2507 2508 2509 2510
  // 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 已提交
2511 2512
    mutex_.Lock();
    file_number = versions_->NewFileNumber();
2513
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
J
jorlow@chromium.org 已提交
2514 2515
    mutex_.Unlock();
  }
2516 2517
  CompactionState::Output out;
  out.number = file_number;
2518
  out.path_id = compact->compaction->GetOutputPathId();
2519 2520
  out.smallest.Clear();
  out.largest.Clear();
2521
  out.smallest_seqno = out.largest_seqno = 0;
2522
  compact->outputs.push_back(out);
J
jorlow@chromium.org 已提交
2523 2524

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

J
jorlow@chromium.org 已提交
2529
  if (s.ok()) {
L
Lei Jin 已提交
2530
    compact->outfile->SetIOPriority(Env::IO_LOW);
2531
    compact->outfile->SetPreallocationBlockSize(
2532
        compact->compaction->OutputFilePreallocationSize(mutable_cf_options));
2533

2534
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2535
    compact->builder.reset(NewTableBuilder(
L
Lei Jin 已提交
2536 2537
        *cfd->ioptions(), cfd->internal_comparator(), compact->outfile.get(),
        compact->compaction->OutputCompressionType(),
2538
        cfd->ioptions()->compression_opts));
J
jorlow@chromium.org 已提交
2539
  }
2540
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
2541 2542 2543 2544 2545
  return s;
}

Status DBImpl::FinishCompactionOutputFile(CompactionState* compact,
                                          Iterator* input) {
2546
  assert(compact != nullptr);
2547
  assert(compact->outfile);
2548
  assert(compact->builder != nullptr);
J
jorlow@chromium.org 已提交
2549 2550

  const uint64_t output_number = compact->current_output()->number;
2551
  const uint32_t output_path_id = compact->current_output()->path_id;
J
jorlow@chromium.org 已提交
2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564
  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;
2565
  compact->builder.reset();
J
jorlow@chromium.org 已提交
2566 2567

  // Finish and check for file errors
2568 2569
  if (s.ok() && !db_options_.disableDataSync) {
    if (db_options_.use_fsync) {
L
Lei Jin 已提交
2570
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2571 2572
      s = compact->outfile->Fsync();
    } else {
L
Lei Jin 已提交
2573
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2574 2575
      s = compact->outfile->Sync();
    }
J
jorlow@chromium.org 已提交
2576 2577 2578 2579
  }
  if (s.ok()) {
    s = compact->outfile->Close();
  }
2580
  compact->outfile.reset();
J
jorlow@chromium.org 已提交
2581 2582 2583

  if (s.ok() && current_entries > 0) {
    // Verify that the table is usable
I
Igor Canadi 已提交
2584
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2585
    FileDescriptor fd(output_number, output_path_id, current_bytes);
I
Igor Canadi 已提交
2586
    Iterator* iter = cfd->table_cache()->NewIterator(
L
Lei Jin 已提交
2587
        ReadOptions(), env_options_, cfd->internal_comparator(), fd);
J
jorlow@chromium.org 已提交
2588 2589 2590
    s = iter->status();
    delete iter;
    if (s.ok()) {
2591
      Log(db_options_.info_log, "[%s] Generated table #%" PRIu64 ": %" PRIu64
2592 2593 2594
                             " keys, %" PRIu64 " bytes",
          cfd->GetName().c_str(), output_number, current_entries,
          current_bytes);
J
jorlow@chromium.org 已提交
2595 2596 2597 2598 2599 2600
    }
  }
  return s;
}


2601
Status DBImpl::InstallCompactionResults(CompactionState* compact,
2602
    const MutableCFOptions& mutable_cf_options, LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
2603
  mutex_.AssertHeld();
2604 2605 2606 2607 2608

  // 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.
2609
  if (!versions_->VerifyCompactionFileConsistency(compact->compaction)) {
2610
    Log(db_options_.info_log, "[%s] Compaction %d@%d + %d@%d files aborted",
I
Igor Canadi 已提交
2611 2612 2613 2614
        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 已提交
2615
    return Status::Corruption("Compaction input files inconsistent");
2616 2617
  }

I
Igor Canadi 已提交
2618 2619
  LogToBuffer(log_buffer, "[%s] Compacted %d@%d + %d@%d files => %lld bytes",
              compact->compaction->column_family_data()->GetName().c_str(),
2620 2621 2622 2623 2624
              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 已提交
2625 2626 2627

  // Add compaction outputs
  compact->compaction->AddInputDeletions(compact->compaction->edit());
D
dgrogan@chromium.org 已提交
2628
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2629
    const CompactionState::Output& out = compact->outputs[i];
2630 2631 2632 2633
    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 已提交
2634
  }
I
Igor Canadi 已提交
2635
  return versions_->LogAndApply(compact->compaction->column_family_data(),
2636
                                mutable_cf_options,
I
Igor Canadi 已提交
2637 2638
                                compact->compaction->edit(), &mutex_,
                                db_directory_.get());
J
jorlow@chromium.org 已提交
2639 2640
}

2641 2642 2643 2644 2645 2646 2647
// 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(
2648 2649
  SequenceNumber in, std::vector<SequenceNumber>& snapshots,
  SequenceNumber* prev_snapshot) {
2650
  SequenceNumber prev __attribute__((unused)) = 0;
2651 2652 2653
  for (const auto cur : snapshots) {
    assert(prev <= cur);
    if (cur >= in) {
2654
      *prev_snapshot = prev;
2655
      return cur;
2656
    }
2657 2658
    prev = cur; // assignment
    assert(prev);
2659
  }
2660
  Log(db_options_.info_log,
2661 2662
      "Looking for seqid %" PRIu64 " but maxseqid is %" PRIu64 "", in,
      snapshots[snapshots.size() - 1]);
2663 2664 2665 2666
  assert(0);
  return 0;
}

I
Igor Canadi 已提交
2667
uint64_t DBImpl::CallFlushDuringCompaction(ColumnFamilyData* cfd,
2668 2669
    const MutableCFOptions& mutable_cf_options, DeletionState& deletion_state,
    LogBuffer* log_buffer) {
2670
  if (db_options_.max_background_flushes > 0) {
2671 2672 2673
    // flush thread will take care of this
    return 0;
  }
I
Igor Canadi 已提交
2674 2675 2676 2677 2678
  if (cfd->imm()->imm_flush_needed.NoBarrier_Load() != nullptr) {
    const uint64_t imm_start = env_->NowMicros();
    mutex_.Lock();
    if (cfd->imm()->IsFlushPending()) {
      cfd->Ref();
2679 2680
      FlushMemTableToOutputFile(cfd, mutable_cf_options, nullptr,
                                deletion_state, log_buffer);
I
Igor Canadi 已提交
2681
      cfd->Unref();
I
Igor Canadi 已提交
2682
      bg_cv_.SignalAll();  // Wakeup DelayWrite() if necessary
I
Igor Canadi 已提交
2683 2684 2685 2686 2687 2688 2689 2690
    }
    mutex_.Unlock();
    log_buffer->FlushBufferToLog();
    return env_->NowMicros() - imm_start;
  }
  return 0;
}

D
Danny Guo 已提交
2691
Status DBImpl::ProcessKeyValueCompaction(
2692
    const MutableCFOptions& mutable_cf_options,
2693
    bool is_snapshot_supported,
D
Danny Guo 已提交
2694 2695 2696 2697 2698 2699 2700 2701 2702
    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,
2703
    int* num_output_records,
D
Danny Guo 已提交
2704
    LogBuffer* log_buffer) {
2705 2706
  assert(num_output_records != nullptr);

D
Danny Guo 已提交
2707
  size_t combined_idx = 0;
J
jorlow@chromium.org 已提交
2708
  Status status;
D
Danny Guo 已提交
2709
  std::string compaction_filter_value;
J
jorlow@chromium.org 已提交
2710
  ParsedInternalKey ikey;
2711
  IterKey current_user_key;
J
jorlow@chromium.org 已提交
2712
  bool has_current_user_key = false;
2713
  IterKey delete_key;
2714 2715
  SequenceNumber last_sequence_for_key __attribute__((unused)) =
    kMaxSequenceNumber;
2716
  SequenceNumber visible_in_snapshot = kMaxSequenceNumber;
2717
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
I
Igor Canadi 已提交
2718
  MergeHelper merge(
2719
      cfd->user_comparator(), cfd->ioptions()->merge_operator,
2720
      db_options_.info_log.get(), cfd->options()->min_partial_merge_operands,
2721
      false /* internal key corruption is expected */);
2722
  auto compaction_filter = cfd->ioptions()->compaction_filter;
2723 2724
  std::unique_ptr<CompactionFilter> compaction_filter_from_factory = nullptr;
  if (!compaction_filter) {
2725
    auto context = compact->GetFilterContextV1();
2726
    compaction_filter_from_factory =
2727
        cfd->ioptions()->compaction_filter_factory->CreateCompactionFilter(
I
Igor Canadi 已提交
2728
            context);
2729 2730
    compaction_filter = compaction_filter_from_factory.get();
  }
2731

2732 2733 2734 2735
  int64_t key_drop_user = 0;
  int64_t key_drop_newer_entry = 0;
  int64_t key_drop_obsolete = 0;
  int64_t loop_cnt = 0;
2736 2737
  while (input->Valid() && !shutting_down_.Acquire_Load() &&
         !cfd->IsDropped()) {
2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754
    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;
    }
2755 2756 2757 2758
    // 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
2759 2760
    imm_micros += CallFlushDuringCompaction(
        cfd, mutable_cf_options, deletion_state, log_buffer);
2761

D
Danny Guo 已提交
2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782
    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 已提交
2783

2784
    if (compact->compaction->ShouldStopBefore(key) &&
2785
        compact->builder != nullptr) {
D
Danny Guo 已提交
2786
      status = FinishCompactionOutputFile(compact, input);
2787 2788 2789 2790 2791 2792
      if (!status.ok()) {
        break;
      }
    }

    // Handle key/value, add to state, etc.
J
jorlow@chromium.org 已提交
2793
    bool drop = false;
2794
    bool current_entry_is_merging = false;
J
jorlow@chromium.org 已提交
2795 2796
    if (!ParseInternalKey(key, &ikey)) {
      // Do not hide error keys
2797 2798
      // 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.
2799
      current_user_key.Clear();
J
jorlow@chromium.org 已提交
2800 2801
      has_current_user_key = false;
      last_sequence_for_key = kMaxSequenceNumber;
2802
      visible_in_snapshot = kMaxSequenceNumber;
J
jorlow@chromium.org 已提交
2803 2804
    } else {
      if (!has_current_user_key ||
2805
          cfd->user_comparator()->Compare(ikey.user_key,
2806
                                          current_user_key.GetKey()) != 0) {
J
jorlow@chromium.org 已提交
2807
        // First occurrence of this user key
L
Lei Jin 已提交
2808
        current_user_key.SetKey(ikey.user_key);
J
jorlow@chromium.org 已提交
2809 2810
        has_current_user_key = true;
        last_sequence_for_key = kMaxSequenceNumber;
2811
        visible_in_snapshot = kMaxSequenceNumber;
H
Haobo Xu 已提交
2812
        // apply the compaction filter to the first occurrence of the user key
D
Danny Guo 已提交
2813
        if (compaction_filter && !is_compaction_v2 &&
H
Haobo Xu 已提交
2814 2815 2816 2817 2818 2819 2820 2821 2822
            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 已提交
2823 2824 2825
          bool to_delete = compaction_filter->Filter(
              compact->compaction->level(), ikey.user_key, value,
              &compaction_filter_value, &value_changed);
H
Haobo Xu 已提交
2826
          if (to_delete) {
2827 2828 2829
            // make a copy of the original key and convert it to a delete
            delete_key.SetInternalKey(ExtractUserKey(key), ikey.sequence,
                                      kTypeDeletion);
H
Haobo Xu 已提交
2830
            // anchor the key again
2831
            key = delete_key.GetKey();
H
Haobo Xu 已提交
2832 2833 2834 2835
            // needed because ikey is backed by key
            ParseInternalKey(key, &ikey);
            // no value associated with delete
            value.clear();
2836
            ++key_drop_user;
H
Haobo Xu 已提交
2837 2838 2839 2840
          } else if (value_changed) {
            value = compaction_filter_value;
          }
        }
J
jorlow@chromium.org 已提交
2841 2842
      }

2843 2844 2845
      // 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.
2846
      SequenceNumber prev_snapshot = 0; // 0 means no previous snapshot
2847 2848 2849 2850
      SequenceNumber visible = visible_at_tip ? visible_at_tip :
        is_snapshot_supported ?  findEarliestVisibleSnapshot(ikey.sequence,
                                  compact->existing_snapshots, &prev_snapshot)
                              : 0;
2851 2852 2853 2854 2855

      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 已提交
2856
        // Hidden by an newer entry for same user key
2857
        // TODO: why not > ?
2858
        assert(last_sequence_for_key >= ikey.sequence);
J
jorlow@chromium.org 已提交
2859
        drop = true;    // (A)
2860
        ++key_drop_newer_entry;
J
jorlow@chromium.org 已提交
2861
      } else if (ikey.type == kTypeDeletion &&
D
Danny Guo 已提交
2862
          ikey.sequence <= earliest_snapshot &&
2863
          compact->compaction->KeyNotExistsBeyondOutputLevel(ikey.user_key)) {
J
jorlow@chromium.org 已提交
2864 2865 2866 2867 2868 2869 2870 2871
        // 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;
2872
        ++key_drop_obsolete;
2873
      } else if (ikey.type == kTypeMerge) {
2874 2875 2876 2877 2878 2879
        if (!merge.HasOperator()) {
          LogToBuffer(log_buffer, "Options::merge_operator is null.");
          status = Status::InvalidArgument(
              "merge_operator is not properly initialized.");
          break;
        }
2880 2881 2882 2883 2884 2885
        // 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 已提交
2886 2887
        int steps = 0;
        merge.MergeUntil(input, prev_snapshot, bottommost_level,
2888
            db_options_.statistics.get(), &steps);
D
Danny Guo 已提交
2889 2890 2891
        // Skip the Merge ops
        combined_idx = combined_idx - 1 + steps;

2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909
        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 已提交
2910 2911 2912
      }

      last_sequence_for_key = ikey.sequence;
2913
      visible_in_snapshot = visible;
J
jorlow@chromium.org 已提交
2914 2915 2916
    }

    if (!drop) {
2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932
      // 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);
2933
      }
2934

2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945
      // 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.
2946
        if (bottommost_level && ikey.sequence < earliest_snapshot &&
2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957
            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
2958

2959 2960
        // Open output file if necessary
        if (compact->builder == nullptr) {
2961
          status = OpenCompactionOutputFile(compact, mutable_cf_options);
2962 2963 2964 2965
          if (!status.ok()) {
            break;
          }
        }
2966 2967

        SequenceNumber seqno = GetInternalKeySeqno(newkey);
2968 2969
        if (compact->builder->NumEntries() == 0) {
          compact->current_output()->smallest.DecodeFrom(newkey);
2970 2971 2972 2973
          compact->current_output()->smallest_seqno = seqno;
        } else {
          compact->current_output()->smallest_seqno =
            std::min(compact->current_output()->smallest_seqno, seqno);
2974 2975 2976
        }
        compact->current_output()->largest.DecodeFrom(newkey);
        compact->builder->Add(newkey, value);
2977
        (*num_output_records)++,
2978 2979
        compact->current_output()->largest_seqno =
          std::max(compact->current_output()->largest_seqno, seqno);
2980 2981 2982 2983

        // Close output file if it is big enough
        if (compact->builder->FileSize() >=
            compact->compaction->MaxOutputFileSize()) {
D
Danny Guo 已提交
2984
          status = FinishCompactionOutputFile(compact, input);
2985 2986 2987
          if (!status.ok()) {
            break;
          }
J
jorlow@chromium.org 已提交
2988 2989
        }

2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009
        // 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 已提交
3010 3011 3012 3013 3014
          break;
        }
      }
    }

3015
    // MergeUntil has moved input to the next entry
3016
    if (!current_entry_is_merging) {
3017 3018
      input->Next();
    }
J
jorlow@chromium.org 已提交
3019
  }
3020 3021 3022 3023 3024 3025 3026 3027 3028
  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);
  }
3029 3030
  RecordCompactionIOStats();

D
Danny Guo 已提交
3031 3032 3033 3034 3035 3036 3037 3038 3039
  return status;
}

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

3040
  // Assemble slice vectors for user keys and existing values.
3041
  // We also keep track of our parsed internal key structs because
3042 3043 3044
  // 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 已提交
3045
  std::vector<Slice> user_key_buf;
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055
  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 已提交
3056 3057 3058 3059 3060 3061 3062 3063 3064
  }

  // 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(),
3065
      user_key_buf, existing_value_buf,
D
Danny Guo 已提交
3066 3067 3068 3069 3070 3071
      &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() ==
3072
      compact->key_str_buf_.size());
D
Danny Guo 已提交
3073
  assert(compact->to_delete_buf_.size() ==
3074
      compact->existing_value_str_buf_.size());
D
Danny Guo 已提交
3075 3076 3077 3078 3079 3080 3081 3082 3083
  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],
3084 3085 3086
                        compact->key_str_buf_[i].size(),
                        ikey_buf[i].sequence,
                        kTypeDeletion);
D
Danny Guo 已提交
3087 3088

      // no value associated with delete
3089
      compact->existing_value_str_buf_[i].clear();
L
Lei Jin 已提交
3090
      RecordTick(stats_, COMPACTION_KEY_DROP_USER);
D
Danny Guo 已提交
3091
    } else if (compact->value_changed_buf_[i]) {
3092 3093
      compact->existing_value_str_buf_[i] =
          compact->new_value_buf_[new_value_idx++];
D
Danny Guo 已提交
3094 3095 3096 3097 3098
    }
  }  // for
}

Status DBImpl::DoCompactionWork(CompactionState* compact,
3099
                                const MutableCFOptions& mutable_cf_options,
D
Danny Guo 已提交
3100 3101 3102 3103 3104 3105
                                DeletionState& deletion_state,
                                LogBuffer* log_buffer) {
  assert(compact);
  compact->CleanupBatchBuffer();
  compact->CleanupMergedBuffer();

F
Feng Zhu 已提交
3106 3107
  // Generate file_levels_ for compaction berfore making Iterator
  compact->compaction->GenerateFileLevels();
D
Danny Guo 已提交
3108
  int64_t imm_micros = 0;  // Micros spent doing imm_ compactions
3109
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
3110 3111
  LogToBuffer(
      log_buffer,
I
Igor Canadi 已提交
3112 3113
      "[%s] Compacting %d@%d + %d@%d files, score %.2f slots available %d",
      cfd->GetName().c_str(), compact->compaction->num_input_files(0),
3114 3115
      compact->compaction->level(), compact->compaction->num_input_files(1),
      compact->compaction->output_level(), compact->compaction->score(),
3116
      db_options_.max_background_compactions - bg_compaction_scheduled_);
D
Danny Guo 已提交
3117 3118
  char scratch[2345];
  compact->compaction->Summary(scratch, sizeof(scratch));
I
Igor Canadi 已提交
3119 3120
  LogToBuffer(log_buffer, "[%s] Compaction start summary: %s\n",
              cfd->GetName().c_str(), scratch);
D
Danny Guo 已提交
3121

3122
  assert(cfd->current()->NumLevelFiles(compact->compaction->level()) > 0);
D
Danny Guo 已提交
3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147
  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);

3148
  bool is_snapshot_supported = IsSnapshotSupported();
D
Danny Guo 已提交
3149 3150
  // Release mutex while we're actually doing the compaction work
  mutex_.Unlock();
3151
  log_buffer->FlushBufferToLog();
D
Danny Guo 已提交
3152

3153
  int num_output_records = 0;
D
Danny Guo 已提交
3154 3155 3156 3157 3158 3159 3160 3161 3162 3163
  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 =
3164 3165
      cfd->ioptions()->compaction_filter_factory_v2->
          CreateCompactionFilterV2(context);
D
Danny Guo 已提交
3166 3167 3168
  auto compaction_filter_v2 =
    compaction_filter_from_factory_v2.get();

3169 3170
  if (!compaction_filter_v2) {
    status = ProcessKeyValueCompaction(
3171
      mutable_cf_options,
3172 3173 3174 3175 3176 3177 3178 3179 3180 3181
      is_snapshot_supported,
      visible_at_tip,
      earliest_snapshot,
      latest_snapshot,
      deletion_state,
      bottommost_level,
      imm_micros,
      input.get(),
      compact,
      false,
3182
      &num_output_records,
3183 3184 3185 3186 3187 3188 3189 3190 3191
      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.
3192
    bool prefix_initialized = false;
3193 3194 3195
    shared_ptr<Iterator> backup_input(
        versions_->MakeInputIterator(compact->compaction));
    backup_input->SeekToFirst();
3196 3197
    while (backup_input->Valid() && !shutting_down_.Acquire_Load() &&
           !cfd->IsDropped()) {
I
Igor Canadi 已提交
3198 3199 3200 3201
      // 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
3202 3203
      imm_micros += CallFlushDuringCompaction(cfd, mutable_cf_options,
          deletion_state, log_buffer);
I
Igor Canadi 已提交
3204

D
Danny Guo 已提交
3205 3206 3207 3208 3209
      Slice key = backup_input->key();
      Slice value = backup_input->value();

      if (!ParseInternalKey(key, &ikey)) {
        // log error
3210
        Log(db_options_.info_log, "[%s] Failed to parse key: %s",
I
Igor Canadi 已提交
3211
            cfd->GetName().c_str(), key.ToString().c_str());
D
Danny Guo 已提交
3212 3213
        continue;
      } else {
3214
        const SliceTransform* transformer =
3215
            cfd->ioptions()->compaction_filter_factory_v2->GetPrefixExtractor();
3216 3217 3218 3219 3220
        const auto key_prefix = transformer->Transform(ikey.user_key);
        if (!prefix_initialized) {
          compact->cur_prefix_ = key_prefix.ToString();
          prefix_initialized = true;
        }
D
Danny Guo 已提交
3221
        // If the prefix remains the same, keep buffering
3222
        if (key_prefix.compare(Slice(compact->cur_prefix_)) == 0) {
D
Danny Guo 已提交
3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239
          // 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
3240
          if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3241 3242
            CallCompactionFilterV2(compact, compaction_filter_v2);
          }
3243
          compact->cur_prefix_ = key_prefix.ToString();
D
Danny Guo 已提交
3244 3245 3246 3247
        }
      }

      // Merge this batch of data (values + ineligible keys)
3248
      compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3249 3250 3251 3252

      // Done buffering for the current prefix. Spit it out to disk
      // Now just iterate through all the kv-pairs
      status = ProcessKeyValueCompaction(
3253
          mutable_cf_options,
3254
          is_snapshot_supported,
D
Danny Guo 已提交
3255 3256 3257 3258 3259 3260 3261 3262 3263
          visible_at_tip,
          earliest_snapshot,
          latest_snapshot,
          deletion_state,
          bottommost_level,
          imm_micros,
          input.get(),
          compact,
          true,
3264
          &num_output_records,
D
Danny Guo 已提交
3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284
          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.
3285
        if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3286 3287
          CallCompactionFilterV2(compact, compaction_filter_v2);
        }
3288
        compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3289 3290

        status = ProcessKeyValueCompaction(
3291
            mutable_cf_options,
3292
            is_snapshot_supported,
D
Danny Guo 已提交
3293 3294 3295 3296 3297 3298 3299 3300 3301
            visible_at_tip,
            earliest_snapshot,
            latest_snapshot,
            deletion_state,
            bottommost_level,
            imm_micros,
            input.get(),
            compact,
            true,
3302
            &num_output_records,
D
Danny Guo 已提交
3303 3304 3305 3306 3307 3308 3309
            log_buffer);

        compact->CleanupBatchBuffer();
        compact->CleanupMergedBuffer();
      }
    }  // done processing all prefix batches
    // finish the last batch
3310
    if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3311 3312
      CallCompactionFilterV2(compact, compaction_filter_v2);
    }
3313
    compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3314
    status = ProcessKeyValueCompaction(
3315
        mutable_cf_options,
3316
        is_snapshot_supported,
D
Danny Guo 已提交
3317 3318 3319 3320 3321 3322 3323 3324 3325
        visible_at_tip,
        earliest_snapshot,
        latest_snapshot,
        deletion_state,
        bottommost_level,
        imm_micros,
        input.get(),
        compact,
        true,
3326
        &num_output_records,
D
Danny Guo 已提交
3327 3328 3329
        log_buffer);
  }  // checking for compaction filter v2

3330
  if (status.ok() && (shutting_down_.Acquire_Load() || cfd->IsDropped())) {
L
Lei Jin 已提交
3331
    status = Status::ShutdownInProgress(
3332
        "Database shutdown or Column family drop during compaction");
J
jorlow@chromium.org 已提交
3333
  }
3334
  if (status.ok() && compact->builder != nullptr) {
3335
    status = FinishCompactionOutputFile(compact, input.get());
J
jorlow@chromium.org 已提交
3336 3337 3338 3339
  }
  if (status.ok()) {
    status = input->status();
  }
3340
  input.reset();
J
jorlow@chromium.org 已提交
3341

3342
  if (!db_options_.disableDataSync) {
3343 3344
    db_directory_->Fsync();
  }
I
Igor Canadi 已提交
3345

L
Lei Jin 已提交
3346
  InternalStats::CompactionStats stats(1);
3347
  stats.micros = env_->NowMicros() - start_micros - imm_micros;
M
Mark Callaghan 已提交
3348 3349
  stats.files_in_leveln = compact->compaction->num_input_files(0);
  stats.files_in_levelnp1 = compact->compaction->num_input_files(1);
L
Lei Jin 已提交
3350
  MeasureTime(stats_, COMPACTION_TIME, stats.micros);
3351 3352

  int num_output_files = compact->outputs.size();
3353
  if (compact->builder != nullptr) {
P
Pascal Borreli 已提交
3354
    // An error occurred so ignore the last output.
3355 3356 3357 3358
    assert(num_output_files > 0);
    --num_output_files;
  }
  stats.files_out_levelnp1 = num_output_files;
M
Mark Callaghan 已提交
3359

3360 3361
  uint64_t num_input_records = 0;

3362
  for (int i = 0; i < compact->compaction->num_input_files(0); i++) {
3363
    stats.bytes_readn += compact->compaction->input(0, i)->fd.GetFileSize();
3364 3365
    stats.num_input_records += compact->compaction->input(0, i)->num_entries;
    num_input_records += compact->compaction->input(0, i)->num_entries;
3366
  }
M
Mark Callaghan 已提交
3367

3368
  for (int i = 0; i < compact->compaction->num_input_files(1); i++) {
3369
    stats.bytes_readnp1 += compact->compaction->input(1, i)->fd.GetFileSize();
3370
    num_input_records += compact->compaction->input(1, i)->num_entries;
3371
  }
M
Mark Callaghan 已提交
3372

3373
  for (int i = 0; i < num_output_files; i++) {
3374 3375
    stats.bytes_written += compact->outputs[i].file_size;
  }
3376 3377
  stats.num_dropped_records =
      static_cast<int>(num_input_records) - num_output_records;
3378

3379 3380
  RecordCompactionIOStats();

3381
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
3382
  mutex_.Lock();
3383 3384
  cfd->internal_stats()->AddCompactionStats(
      compact->compaction->output_level(), stats);
J
jorlow@chromium.org 已提交
3385

3386 3387 3388 3389
  // 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 已提交
3390
  if (status.ok()) {
3391 3392
    status = InstallCompactionResults(compact, mutable_cf_options, log_buffer);
    InstallSuperVersion(cfd, deletion_state, mutable_cf_options);
J
jorlow@chromium.org 已提交
3393
  }
3394
  Version::LevelSummaryStorage tmp;
3395 3396
  LogToBuffer(
      log_buffer,
3397 3398
      "[%s] compacted to: %s, MB/sec: %.1f rd, %.1f wr, level %d, "
      "files in(%d, %d) out(%d) "
3399
      "MB in(%.1f, %.1f) out(%.1f), read-write-amplify(%.1f) "
3400
      "write-amplify(%.1f) %s, records in: %d, records dropped: %d\n",
I
Igor Canadi 已提交
3401
      cfd->GetName().c_str(), cfd->current()->LevelSummary(&tmp),
3402 3403 3404
      (stats.bytes_readn + stats.bytes_readnp1) /
          static_cast<double>(stats.micros),
      stats.bytes_written / static_cast<double>(stats.micros),
3405 3406 3407
      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 已提交
3408
      stats.bytes_written / 1048576.0,
3409
      (stats.bytes_written + stats.bytes_readnp1 + stats.bytes_readn) /
3410 3411
          (double)stats.bytes_readn,
      stats.bytes_written / (double)stats.bytes_readn,
3412 3413
      status.ToString().c_str(), stats.num_input_records,
      stats.num_dropped_records);
M
Mark Callaghan 已提交
3414

J
jorlow@chromium.org 已提交
3415 3416 3417
  return status;
}

3418 3419
namespace {
struct IterState {
3420 3421
  IterState(DBImpl* db, port::Mutex* mu, SuperVersion* super_version)
      : db(db), mu(mu), super_version(super_version) {}
3422 3423

  DBImpl* db;
3424
  port::Mutex* mu;
3425
  SuperVersion* super_version;
3426 3427 3428 3429
};

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

3431
  if (state->super_version->Unref()) {
3432 3433
    DBImpl::DeletionState deletion_state;

3434 3435 3436 3437 3438 3439
    state->mu->Lock();
    state->super_version->Cleanup();
    state->db->FindObsoleteFiles(deletion_state, false, true);
    state->mu->Unlock();

    delete state->super_version;
3440 3441 3442
    if (deletion_state.HaveSomethingToDelete()) {
      state->db->PurgeObsoleteFiles(deletion_state);
    }
I
Igor Canadi 已提交
3443
  }
T
Tomislav Novak 已提交
3444

3445 3446
  delete state;
}
H
Hans Wennborg 已提交
3447
}  // namespace
3448

L
Lei Jin 已提交
3449
Iterator* DBImpl::NewInternalIterator(const ReadOptions& read_options,
3450
                                      ColumnFamilyData* cfd,
3451 3452 3453
                                      SuperVersion* super_version,
                                      Arena* arena) {
  Iterator* internal_iter;
3454 3455 3456 3457 3458
  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 已提交
3459
      super_version->mem->NewIterator(read_options, arena));
3460
  // Collect all needed child iterators for immutable memtables
L
Lei Jin 已提交
3461
  super_version->imm->AddIterators(read_options, &merge_iter_builder);
3462
  // Collect iterators for files in L0 - Ln
L
Lei Jin 已提交
3463
  super_version->current->AddIterators(read_options, env_options_,
3464 3465
                                       &merge_iter_builder);
  internal_iter = merge_iter_builder.Finish();
3466
  IterState* cleanup = new IterState(this, &mutex_, super_version);
3467
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
3468 3469 3470 3471

  return internal_iter;
}

3472 3473 3474 3475
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
3476
Status DBImpl::Get(const ReadOptions& read_options,
3477
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3478
                   std::string* value) {
L
Lei Jin 已提交
3479
  return GetImpl(read_options, column_family, key, value);
3480 3481
}

I
Igor Canadi 已提交
3482 3483 3484
// DeletionState gets created and destructed outside of the lock -- we
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3485
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3486 3487 3488 3489 3490 3491
//
// 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
3492 3493 3494
void DBImpl::InstallSuperVersion(
    ColumnFamilyData* cfd, DeletionState& deletion_state,
    const MutableCFOptions& mutable_cf_options) {
3495
  mutex_.AssertHeld();
3496
  SuperVersion* old_superversion =
L
Lei Jin 已提交
3497 3498
      InstallSuperVersion(cfd, deletion_state.new_superversion,
                          mutable_cf_options);
I
Igor Canadi 已提交
3499
  deletion_state.new_superversion = nullptr;
3500
  deletion_state.superversions_to_free.push_back(old_superversion);
I
Igor Canadi 已提交
3501 3502
}

L
Lei Jin 已提交
3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528
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,
3529 3530
                       ColumnFamilyHandle* column_family, const Slice& key,
                       std::string* value, bool* value_found) {
L
Lei Jin 已提交
3531
  StopWatch sw(env_, stats_, DB_GET);
3532
  PERF_TIMER_GUARD(get_snapshot_time);
3533

3534 3535 3536
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3537
  SequenceNumber snapshot;
L
Lei Jin 已提交
3538 3539 3540
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3541 3542
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3543
  }
3544

3545
  // Acquire SuperVersion
3546
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
I
Igor Canadi 已提交
3547

3548
  // Prepare to store a list of merge operations if merge occurs.
3549
  MergeContext merge_context;
3550

3551
  Status s;
3552
  // First look in the memtable, then in the immutable memtable (if any).
3553
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3554
  // merge_operands will contain the sequence of merges in the latter case.
3555
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3556
  PERF_TIMER_STOP(get_snapshot_time);
3557

3558
  if (sv->mem->Get(lkey, value, &s, &merge_context)) {
3559
    // Done
L
Lei Jin 已提交
3560
    RecordTick(stats_, MEMTABLE_HIT);
3561
  } else if (sv->imm->Get(lkey, value, &s, &merge_context)) {
3562
    // Done
L
Lei Jin 已提交
3563
    RecordTick(stats_, MEMTABLE_HIT);
3564
  } else {
3565
    PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3566 3567
    sv->current->Get(read_options, lkey, value, &s, &merge_context,
                     value_found);
L
Lei Jin 已提交
3568
    RecordTick(stats_, MEMTABLE_MISS);
3569
  }
3570

3571 3572
  {
    PERF_TIMER_GUARD(get_post_process_time);
3573

3574
    ReturnAndCleanupSuperVersion(cfd, sv);
3575

3576 3577 3578
    RecordTick(stats_, NUMBER_KEYS_READ);
    RecordTick(stats_, BYTES_READ, value->size());
  }
3579
  return s;
J
jorlow@chromium.org 已提交
3580 3581
}

3582
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
3583
    const ReadOptions& read_options,
3584
    const std::vector<ColumnFamilyHandle*>& column_family,
3585
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3586

L
Lei Jin 已提交
3587
  StopWatch sw(env_, stats_, DB_MULTIGET);
3588
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
3589

3590
  SequenceNumber snapshot;
3591

3592
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3593
    ColumnFamilyData* cfd;
3594 3595 3596 3597 3598
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3599 3600 3601 3602 3603 3604
    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});
3605 3606 3607
    }
  }

3608
  mutex_.Lock();
L
Lei Jin 已提交
3609 3610 3611
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3612 3613 3614
  } else {
    snapshot = versions_->LastSequence();
  }
3615
  for (auto mgd_iter : multiget_cf_data) {
3616 3617
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3618
  }
3619
  mutex_.Unlock();
3620

3621 3622
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3623

3624
  // Note: this always resizes the values array
3625 3626 3627
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3628 3629

  // Keep track of bytes that we read for statistics-recording later
3630
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3631
  PERF_TIMER_STOP(get_snapshot_time);
3632 3633 3634 3635

  // 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.
3636
  // merge_operands will contain the sequence of merges in the latter case.
3637
  for (size_t i = 0; i < num_keys; ++i) {
3638
    merge_context.Clear();
3639
    Status& s = stat_list[i];
3640 3641 3642
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3643 3644
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3645 3646 3647
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
3648
    if (super_version->mem->Get(lkey, value, &s, &merge_context)) {
3649
      // Done
3650
    } else if (super_version->imm->Get(lkey, value, &s, &merge_context)) {
3651 3652
      // Done
    } else {
3653
      PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3654 3655
      super_version->current->Get(read_options, lkey, value, &s,
                                  &merge_context);
3656 3657 3658
    }

    if (s.ok()) {
3659
      bytes_read += value->size();
3660 3661 3662 3663
    }
  }

  // Post processing (decrement reference counts and record statistics)
3664
  PERF_TIMER_GUARD(get_post_process_time);
3665 3666
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
3667
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3668 3669 3670 3671 3672 3673
  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);
3674 3675
    }
  }
3676 3677 3678 3679 3680 3681 3682
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3683
  }
3684

L
Lei Jin 已提交
3685 3686 3687
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
L
Lei Jin 已提交
3688
  PERF_TIMER_STOP(get_post_process_time);
3689

3690
  return stat_list;
3691 3692
}

L
Lei Jin 已提交
3693
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
3694
                                  const std::string& column_family_name,
3695
                                  ColumnFamilyHandle** handle) {
I
Igor Canadi 已提交
3696 3697 3698
  *handle = nullptr;
  MutexLock l(&mutex_);

I
Igor Canadi 已提交
3699 3700
  if (versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name) !=
      nullptr) {
I
Igor Canadi 已提交
3701 3702
    return Status::InvalidArgument("Column family already exists");
  }
3703
  VersionEdit edit;
3704
  edit.AddColumnFamily(column_family_name);
3705 3706
  uint32_t new_id = versions_->GetColumnFamilySet()->GetNextColumnFamilyID();
  edit.SetColumnFamily(new_id);
I
Igor Canadi 已提交
3707
  edit.SetLogNumber(logfile_number_);
L
Lei Jin 已提交
3708
  edit.SetComparatorName(cf_options.comparator->Name());
3709

I
Igor Canadi 已提交
3710 3711
  // LogAndApply will both write the creation in MANIFEST and create
  // ColumnFamilyData object
L
Lei Jin 已提交
3712
  Options opt(db_options_, cf_options);
3713 3714
  Status s = versions_->LogAndApply(nullptr,
      MutableCFOptions(opt, ImmutableCFOptions(opt)),
L
Lei Jin 已提交
3715
      &edit, &mutex_, db_directory_.get(), false, &cf_options);
3716
  if (s.ok()) {
3717
    single_column_family_mode_ = false;
3718 3719 3720
    auto cfd =
        versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
    assert(cfd != nullptr);
L
Lei Jin 已提交
3721
    delete InstallSuperVersion(cfd, nullptr, *cfd->GetLatestMutableCFOptions());
3722
    *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
3723
    Log(db_options_.info_log, "Created column family [%s] (ID %u)",
3724 3725
        column_family_name.c_str(), (unsigned)cfd->GetID());
  } else {
3726
    Log(db_options_.info_log, "Creating column family [%s] FAILED -- %s",
3727 3728
        column_family_name.c_str(), s.ToString().c_str());
  }
3729
  return s;
3730 3731
}

3732 3733 3734 3735
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3736 3737
    return Status::InvalidArgument("Can't drop default column family");
  }
3738

I
Igor Canadi 已提交
3739 3740
  VersionEdit edit;
  edit.DropColumnFamily();
3741 3742
  edit.SetColumnFamily(cfd->GetID());

3743
  Status s;
3744 3745 3746 3747 3748 3749
  {
    MutexLock l(&mutex_);
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
3750
      // we drop column family from a single write thread
I
Igor Canadi 已提交
3751 3752
      WriteThread::Writer w(&mutex_);
      s = write_thread_.EnterWriteThread(&w, 0);
3753
      assert(s.ok() && !w.done);  // No timeout and nobody should do our job
3754 3755
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
I
Igor Canadi 已提交
3756
      write_thread_.ExitWriteThread(&w, &w, s);
3757
    }
3758
  }
3759

3760
  if (s.ok()) {
I
Igor Canadi 已提交
3761
    assert(cfd->IsDropped());
L
Lei Jin 已提交
3762 3763 3764
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ -= mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
3765 3766
    Log(db_options_.info_log, "Dropped column family with id %u\n",
        cfd->GetID());
3767
  } else {
3768 3769
    Log(db_options_.info_log,
        "Dropping column family with id %u FAILED -- %s\n",
3770 3771 3772
        cfd->GetID(), s.ToString().c_str());
  }

3773
  return s;
3774 3775
}

L
Lei Jin 已提交
3776
bool DBImpl::KeyMayExist(const ReadOptions& read_options,
3777 3778
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
3779
  if (value_found != nullptr) {
K
Kai Liu 已提交
3780 3781
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
3782
  }
L
Lei Jin 已提交
3783
  ReadOptions roptions = read_options;
3784
  roptions.read_tier = kBlockCacheTier; // read from block cache only
3785
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
3786

3787
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
3788 3789 3790
  // 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();
3791 3792
}

3793
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
3794 3795 3796
                              ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
3797

3798
  if (read_options.tailing) {
I
Igor Canadi 已提交
3799 3800 3801 3802
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
3803 3804 3805 3806 3807
    auto iter = new ForwardIterator(this, read_options, cfd);
    return NewDBIterator(env_, *cfd->ioptions(), cfd->user_comparator(), iter,
                         kMaxSequenceNumber,
                         cfd->options()->max_sequential_skip_in_iterations,
                         read_options.iterate_upper_bound);
I
Igor Canadi 已提交
3808
#endif
T
Tomislav Novak 已提交
3809
  } else {
3810 3811 3812 3813
    SequenceNumber latest_snapshot = versions_->LastSequence();
    SuperVersion* sv = nullptr;
    sv = cfd->GetReferencedSuperVersion(&mutex_);

I
Igor Canadi 已提交
3814
    auto snapshot =
3815 3816 3817
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
3818
            : latest_snapshot;
T
Tomislav Novak 已提交
3819

3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862
    // 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(
3863 3864 3865
        env_, *cfd->ioptions(), cfd->user_comparator(),
        snapshot, cfd->options()->max_sequential_skip_in_iterations,
        read_options.iterate_upper_bound);
3866

3867
    Iterator* internal_iter =
3868
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
3869 3870 3871 3872
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
3873 3874
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
3875 3876
}

3877
Status DBImpl::NewIterators(
3878
    const ReadOptions& read_options,
I
Igor Canadi 已提交
3879
    const std::vector<ColumnFamilyHandle*>& column_families,
3880
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3881 3882 3883 3884 3885 3886
  iterators->clear();
  iterators->reserve(column_families.size());
  SequenceNumber latest_snapshot = 0;
  std::vector<SuperVersion*> super_versions;
  super_versions.reserve(column_families.size());

3887
  if (!read_options.tailing) {
I
Igor Canadi 已提交
3888 3889 3890 3891 3892 3893 3894 3895 3896
    mutex_.Lock();
    latest_snapshot = versions_->LastSequence();
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
      super_versions.push_back(cfd->GetSuperVersion()->Ref());
    }
    mutex_.Unlock();
  }

3897
  if (read_options.tailing) {
I
Igor Canadi 已提交
3898 3899 3900 3901
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
3902 3903
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
3904
      auto iter = new ForwardIterator(this, read_options, cfd);
L
Lei Jin 已提交
3905
      iterators->push_back(
3906 3907 3908
          NewDBIterator(env_, *cfd->ioptions(), cfd->user_comparator(), iter,
                        kMaxSequenceNumber,
                        cfd->options()->max_sequential_skip_in_iterations));
I
Igor Canadi 已提交
3909
    }
I
Igor Canadi 已提交
3910
#endif
I
Igor Canadi 已提交
3911 3912 3913 3914 3915 3916
  } else {
    for (size_t i = 0; i < column_families.size(); ++i) {
      auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_families[i]);
      auto cfd = cfh->cfd();

      auto snapshot =
3917 3918 3919
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
3920 3921
              : latest_snapshot;

3922
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
3923 3924
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
          cfd->options()->max_sequential_skip_in_iterations);
3925
      Iterator* internal_iter = NewInternalIterator(
3926
          read_options, cfd, super_versions[i], db_iter->GetArena());
3927 3928
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
3929 3930 3931 3932
    }
  }

  return Status::OK();
3933 3934
}

3935 3936 3937 3938 3939 3940 3941 3942 3943
bool DBImpl::IsSnapshotSupported() const {
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (!cfd->mem()->IsSnapshotSupported()) {
      return false;
    }
  }
  return true;
}

J
jorlow@chromium.org 已提交
3944
const Snapshot* DBImpl::GetSnapshot() {
3945
  MutexLock l(&mutex_);
3946 3947
  // returns null if the underlying memtable does not support snapshot.
  if (!IsSnapshotSupported()) return nullptr;
3948
  return snapshots_.New(versions_->LastSequence());
J
jorlow@chromium.org 已提交
3949 3950 3951 3952
}

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

// Convenience methods
3957 3958
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
3959
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
3960 3961
}

3962 3963 3964
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
3965
  if (!cfh->cfd()->ioptions()->merge_operator) {
3966 3967
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
3968
    return DB::Merge(o, column_family, key, val);
3969 3970 3971
  }
}

L
Lei Jin 已提交
3972
Status DBImpl::Delete(const WriteOptions& write_options,
3973
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
3974
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
3975 3976
}

L
Lei Jin 已提交
3977
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
S
Stanislau Hlebik 已提交
3978 3979 3980
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
3981
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
I
Igor Canadi 已提交
3982
  WriteThread::Writer w(&mutex_);
S
Stanislau Hlebik 已提交
3983
  w.batch = my_batch;
L
Lei Jin 已提交
3984 3985
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
S
Stanislau Hlebik 已提交
3986 3987
  w.in_batch_group = false;
  w.done = false;
L
Lei Jin 已提交
3988
  w.timeout_hint_us = write_options.timeout_hint_us;
S
Stanislau Hlebik 已提交
3989 3990

  uint64_t expiration_time = 0;
I
Igor Canadi 已提交
3991
  bool has_timeout = false;
S
Stanislau Hlebik 已提交
3992
  if (w.timeout_hint_us == 0) {
I
Igor Canadi 已提交
3993
    w.timeout_hint_us = WriteThread::kNoTimeOut;
S
Stanislau Hlebik 已提交
3994 3995
  } else {
    expiration_time = env_->NowMicros() + w.timeout_hint_us;
I
Igor Canadi 已提交
3996
    has_timeout = true;
S
Stanislau Hlebik 已提交
3997 3998
  }

L
Lei Jin 已提交
3999
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4000 4001 4002 4003 4004 4005
    RecordTick(stats_, WRITE_WITH_WAL);
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_WITH_WAL, 1);
  }

  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4006
  Status status = write_thread_.EnterWriteThread(&w, expiration_time);
S
Stanislau Hlebik 已提交
4007 4008
  assert(status.ok() || status.IsTimedOut());
  if (status.IsTimedOut()) {
4009
    mutex_.Unlock();
L
Lei Jin 已提交
4010
    RecordTick(stats_, WRITE_TIMEDOUT);
4011
    return Status::TimedOut();
4012
  }
S
Stanislau Hlebik 已提交
4013 4014 4015 4016 4017 4018 4019 4020 4021 4022
  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);
4023

4024 4025 4026 4027
  // 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.
4028 4029 4030
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

4031
  uint64_t max_total_wal_size = (db_options_.max_total_wal_size == 0)
4032
                                    ? 4 * max_total_in_memory_state_
4033
                                    : db_options_.max_total_wal_size;
4034
  if (UNLIKELY(!single_column_family_mode_) &&
4035
      alive_log_files_.begin()->getting_flushed == false &&
I
Igor Canadi 已提交
4036
      total_log_size_ > max_total_wal_size) {
I
Igor Canadi 已提交
4037
    uint64_t flush_column_family_if_log_file = alive_log_files_.begin()->number;
I
Igor Canadi 已提交
4038
    alive_log_files_.begin()->getting_flushed = true;
4039
    Log(db_options_.info_log,
4040 4041 4042
        "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 已提交
4043 4044
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4045
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
4046
      if (cfd->GetLogNumber() <= flush_column_family_if_log_file) {
S
Stanislau Hlebik 已提交
4047
        status = SetNewMemtableAndNewLogFile(cfd, &context);
I
Igor Canadi 已提交
4048 4049 4050
        if (!status.ok()) {
          break;
        }
S
Stanislau Hlebik 已提交
4051
        cfd->imm()->FlushRequested();
4052
      }
4053
    }
I
Igor Canadi 已提交
4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066
    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 已提交
4067
    status = DelayWrite(expiration_time);
I
Igor Canadi 已提交
4068 4069 4070 4071 4072
  }

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

D
dgrogan@chromium.org 已提交
4075
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4076
  WriteThread::Writer* last_writer = &w;
S
Stanislau Hlebik 已提交
4077
  if (status.ok()) {
4078
    autovector<WriteBatch*> write_batch_group;
I
Igor Canadi 已提交
4079
    write_thread_.BuildBatchGroup(&last_writer, &write_batch_group);
4080

4081 4082 4083
    // 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
4084
    // into memtables
4085
    {
4086
      mutex_.Unlock();
4087 4088 4089 4090 4091 4092 4093 4094 4095 4096
      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]);
        }
      }

4097 4098 4099 4100
      const SequenceNumber current_sequence = last_sequence + 1;
      WriteBatchInternal::SetSequence(updates, current_sequence);
      int my_batch_count = WriteBatchInternal::Count(updates);
      last_sequence += my_batch_count;
4101
      const uint64_t batch_size = WriteBatchInternal::ByteSize(updates);
4102
      // Record statistics
L
Lei Jin 已提交
4103 4104
      RecordTick(stats_, NUMBER_KEYS_WRITTEN, my_batch_count);
      RecordTick(stats_, BYTES_WRITTEN, WriteBatchInternal::ByteSize(updates));
L
Lei Jin 已提交
4105
      if (write_options.disableWAL) {
4106
        flush_on_destroy_ = true;
4107
      }
L
Lei Jin 已提交
4108
      PERF_TIMER_STOP(write_pre_and_post_process_time);
4109

4110
      uint64_t log_size = 0;
L
Lei Jin 已提交
4111
      if (!write_options.disableWAL) {
4112
        PERF_TIMER_GUARD(write_wal_time);
4113 4114
        Slice log_entry = WriteBatchInternal::Contents(updates);
        status = log_->AddRecord(log_entry);
I
Igor Canadi 已提交
4115 4116
        total_log_size_ += log_entry.size();
        alive_log_files_.back().AddSize(log_entry.size());
4117
        log_empty_ = false;
4118
        log_size = log_entry.size();
L
Lei Jin 已提交
4119
        RecordTick(stats_, WAL_FILE_BYTES, log_size);
L
Lei Jin 已提交
4120
        if (status.ok() && write_options.sync) {
I
Igor Canadi 已提交
4121
          RecordTick(stats_, WAL_FILE_SYNCED);
4122
          StopWatch sw(env_, stats_, WAL_FILE_SYNC_MICROS);
4123
          if (db_options_.use_fsync) {
4124
            status = log_->file()->Fsync();
4125
          } else {
4126
            status = log_->file()->Sync();
4127
          }
H
heyongqiang 已提交
4128
        }
4129 4130
      }
      if (status.ok()) {
4131
        PERF_TIMER_GUARD(write_memtable_time);
Y
Yueh-Hsuan Chiang 已提交
4132

4133
        status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
4134
            updates, column_family_memtables_.get(),
L
Lei Jin 已提交
4135
            write_options.ignore_missing_column_families, 0, this, false);
Y
Yueh-Hsuan Chiang 已提交
4136 4137 4138 4139 4140 4141 4142 4143
        // 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 已提交
4144
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
4145
      }
L
Lei Jin 已提交
4146
      PERF_TIMER_START(write_pre_and_post_process_time);
4147 4148 4149
      if (updates == &tmp_batch_) {
        tmp_batch_.Clear();
      }
4150
      mutex_.Lock();
4151 4152 4153
      // internal stats
      default_cf_internal_stats_->AddDBStats(
          InternalStats::BYTES_WRITTEN, batch_size);
L
Lei Jin 已提交
4154
      if (!write_options.disableWAL) {
4155 4156 4157 4158 4159
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_SYNCED, 1);
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_BYTES, log_size);
      }
4160
      if (status.ok()) {
4161
        versions_->SetLastSequence(last_sequence);
4162
      }
J
jorlow@chromium.org 已提交
4163 4164
    }
  }
4165
  if (db_options_.paranoid_checks && !status.ok() &&
4166
      !status.IsTimedOut() && bg_error_.ok()) {
I
Igor Canadi 已提交
4167 4168
    bg_error_ = status; // stop compaction & fail any further writes
  }
4169

I
Igor Canadi 已提交
4170
  write_thread_.ExitWriteThread(&w, last_writer, status);
I
Igor Canadi 已提交
4171
  mutex_.Unlock();
4172

4173
  if (status.IsTimedOut()) {
L
Lei Jin 已提交
4174
    RecordTick(stats_, WRITE_TIMEDOUT);
4175 4176
  }

J
jorlow@chromium.org 已提交
4177 4178 4179
  return status;
}

4180 4181
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
4182
Status DBImpl::DelayWrite(uint64_t expiration_time) {
4183 4184 4185 4186 4187 4188 4189 4190 4191
  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 已提交
4192
  while (bg_error_.ok() && write_controller_.IsStopped()) {
4193 4194 4195
    if (has_timeout) {
      bg_cv_.TimedWait(expiration_time);
      if (env_->NowMicros() > expiration_time) {
I
Igor Canadi 已提交
4196
        return Status::TimedOut();
4197 4198 4199 4200 4201
      }
    } else {
      bg_cv_.Wait();
    }
  }
I
Igor Canadi 已提交
4202 4203

  return bg_error_;
4204 4205
}

I
Igor Canadi 已提交
4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216
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 已提交
4217 4218
    }
  }
I
Igor Canadi 已提交
4219 4220 4221 4222
  if (schedule_bg_work) {
    MaybeScheduleFlushOrCompaction();
  }
  return Status::OK();
S
Stanislau Hlebik 已提交
4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240
}

// 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;
4241
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
S
Stanislau Hlebik 已提交
4242 4243 4244 4245
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
4246 4247 4248
      s = env_->NewWritableFile(
          LogFileName(db_options_.wal_dir, new_log_number),
          &lfile, env_->OptimizeForLogWrite(env_options_));
S
Stanislau Hlebik 已提交
4249 4250 4251
      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 已提交
4252 4253
        lfile->SetPreallocationBlockSize(
            1.1 * mutable_cf_options.write_buffer_size);
S
Stanislau Hlebik 已提交
4254
        new_log = new log::Writer(std::move(lfile));
I
Igor Canadi 已提交
4255
      }
S
Stanislau Hlebik 已提交
4256 4257 4258
    }

    if (s.ok()) {
L
Lei Jin 已提交
4259
      new_mem = new MemTable(cfd->internal_comparator(),
4260 4261
          *cfd->ioptions(), MemTableOptions(mutable_cf_options,
          *cfd->options()));
S
Stanislau Hlebik 已提交
4262 4263 4264
      new_superversion = new SuperVersion();
    }
  }
I
Igor Canadi 已提交
4265 4266 4267
  Log(db_options_.info_log,
      "[%s] New memtable created with log file: #%" PRIu64 "\n",
      cfd->GetName().c_str(), new_log_number);
S
Stanislau Hlebik 已提交
4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292
  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_);
4293
      }
4294 4295
    }
  }
S
Stanislau Hlebik 已提交
4296 4297 4298 4299 4300
  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 已提交
4301
      InstallSuperVersion(cfd, new_superversion, mutable_cf_options));
4302 4303 4304
  return s;
}

I
Igor Canadi 已提交
4305
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4306 4307 4308 4309 4310
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4311 4312
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4313
  auto version = cfd->current();
4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
I
Igor Canadi 已提交
4326
#endif  // ROCKSDB_LITE
4327

I
Igor Canadi 已提交
4328 4329 4330 4331
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4332 4333 4334 4335
Env* DBImpl::GetEnv() const {
  return env_;
}

4336 4337
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4338
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4339 4340
}

4341
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4342
                         const Slice& property, std::string* value) {
4343 4344
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4345 4346 4347
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);

4348
  value->clear();
4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363
  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 已提交
4364 4365
}

4366 4367
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
4368 4369
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381
  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) {
4382 4383
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4384 4385 4386

  if (!need_out_of_mutex) {
    MutexLock l(&mutex_);
4387
    return cfd->internal_stats()->GetIntProperty(property_type, value, this);
4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401
  } 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 已提交
4402
  return cfd->GetThreadLocalSuperVersion(&mutex_);
4403 4404 4405 4406
}

void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
4407
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420

  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);
  }
4421 4422
}

4423
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4424
                                 const Range* range, int n, uint64_t* sizes) {
J
jorlow@chromium.org 已提交
4425 4426
  // TODO(opt): better implementation
  Version* v;
4427 4428
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
J
jorlow@chromium.org 已提交
4429 4430
  {
    MutexLock l(&mutex_);
4431
    v = cfd->current();
4432
    v->Ref();
J
jorlow@chromium.org 已提交
4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449
  }

  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 已提交
4450 4451 4452 4453 4454
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
4455
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471
  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;
  }
4472
  iter->reset(new TransactionLogIteratorImpl(db_options_.wal_dir, &db_options_,
L
Lei Jin 已提交
4473
                                             read_options, env_options_,
I
Igor Canadi 已提交
4474 4475 4476 4477
                                             seq, std::move(wal_files), this));
  return (*iter)->status();
}

4478 4479 4480
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4481 4482 4483
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
4484
    Log(db_options_.info_log, "DeleteFile %s failed.\n", name.c_str());
4485 4486 4487
    return Status::InvalidArgument("Invalid file name");
  }

4488 4489 4490 4491
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4492
      Log(db_options_.info_log, "DeleteFile %s failed - not archived log.\n",
4493
          name.c_str());
4494 4495
      return Status::NotSupported("Delete only supported for archived logs");
    }
4496
    status = env_->DeleteFile(db_options_.wal_dir + "/" + name.c_str());
4497
    if (!status.ok()) {
4498
      Log(db_options_.info_log, "DeleteFile %s failed -- %s.\n",
4499
          name.c_str(), status.ToString().c_str());
4500 4501 4502 4503
    }
    return status;
  }

4504
  int level;
I
Igor Canadi 已提交
4505
  FileMetaData* metadata;
4506
  ColumnFamilyData* cfd;
4507
  VersionEdit edit;
K
Kai Liu 已提交
4508
  DeletionState deletion_state(true);
D
Dhruba Borthakur 已提交
4509 4510
  {
    MutexLock l(&mutex_);
4511
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
4512
    if (!status.ok()) {
4513
      Log(db_options_.info_log, "DeleteFile %s failed. File not found\n",
4514
                             name.c_str());
D
Dhruba Borthakur 已提交
4515 4516
      return Status::InvalidArgument("File not found");
    }
I
Igor Canadi 已提交
4517
    assert((level > 0) && (level < cfd->NumberLevels()));
4518

D
Dhruba Borthakur 已提交
4519
    // If the file is being compacted no need to delete.
4520
    if (metadata->being_compacted) {
4521
      Log(db_options_.info_log,
4522
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
D
Dhruba Borthakur 已提交
4523
      return Status::OK();
4524 4525
    }

D
Dhruba Borthakur 已提交
4526 4527 4528
    // 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 已提交
4529
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
4530
      if (cfd->current()->NumLevelFiles(i) != 0) {
4531
        Log(db_options_.info_log,
4532
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
D
Dhruba Borthakur 已提交
4533 4534 4535 4536
        return Status::InvalidArgument("File not in last level");
      }
    }
    edit.DeleteFile(level, number);
4537 4538
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                    &edit, &mutex_, db_directory_.get());
I
Igor Canadi 已提交
4539
    if (status.ok()) {
4540 4541
      InstallSuperVersion(cfd, deletion_state,
                          *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
4542
    }
I
Igor Canadi 已提交
4543
    FindObsoleteFiles(deletion_state, false);
D
Dhruba Borthakur 已提交
4544
  } // lock released here
4545
  LogFlush(db_options_.info_log);
I
Igor Canadi 已提交
4546
  // remove files outside the db-lock
4547 4548 4549
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
4550 4551 4552 4553 4554 4555
  {
    MutexLock l(&mutex_);
    // schedule flush if file deletion means we freed the space for flushes to
    // continue
    MaybeScheduleFlushOrCompaction();
  }
4556 4557 4558
  return status;
}

4559
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4560
  MutexLock l(&mutex_);
4561
  versions_->GetLiveFilesMetaData(metadata);
4562
}
I
Igor Canadi 已提交
4563
#endif  // ROCKSDB_LITE
4564

I
Igor Canadi 已提交
4565 4566 4567 4568 4569 4570 4571
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
4574 4575 4576 4577 4578 4579
    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) {
4580
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592
                             ". 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);
  }
}

4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619
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 已提交
4620 4621
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
4622
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
4623
               const Slice& key, const Slice& value) {
4624 4625 4626 4627
  // 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);
4628
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
4629 4630 4631
  return Write(opt, &batch);
}

4632 4633
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
4634
  WriteBatch batch;
4635
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
4636 4637 4638
  return Write(opt, &batch);
}

4639 4640
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
4641
  WriteBatch batch;
4642
  batch.Merge(column_family, key, value);
4643 4644 4645
  return Write(opt, &batch);
}

4646
// Default implementation -- returns not supported status
L
Lei Jin 已提交
4647
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
4648
                              const std::string& column_family_name,
4649
                              ColumnFamilyHandle** handle) {
4650
  return Status::NotSupported("");
4651
}
4652
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
4653
  return Status::NotSupported("");
4654 4655
}

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

J
Jim Paton 已提交
4658
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
4659 4660 4661 4662
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
4663
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
4664
  std::vector<ColumnFamilyHandle*> handles;
4665
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
4666 4667 4668 4669 4670 4671 4672
  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;
4673 4674
}

4675 4676
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
4677
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
4678 4679 4680 4681
  Status s = SanitizeDBOptionsByCFOptions(&db_options, column_families);
  if (!s.ok()) {
    return s;
  }
4682
  if (db_options.db_paths.size() > 1) {
4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694
    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. ");
    }
4695 4696
  }

4697
  *dbptr = nullptr;
4698
  handles->clear();
J
jorlow@chromium.org 已提交
4699

I
Igor Canadi 已提交
4700 4701 4702 4703
  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);
4704
  }
4705

I
Igor Canadi 已提交
4706
  DBImpl* impl = new DBImpl(db_options, dbname);
4707
  s = impl->env_->CreateDirIfMissing(impl->db_options_.wal_dir);
4708
  if (s.ok()) {
4709
    for (auto db_path : impl->db_options_.db_paths) {
4710
      s = impl->env_->CreateDirIfMissing(db_path.path);
4711 4712 4713 4714 4715 4716
      if (!s.ok()) {
        break;
      }
    }
  }

4717 4718 4719 4720 4721 4722
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
4723 4724 4725 4726
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
4727
  impl->mutex_.Lock();
4728 4729
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
4730
  if (s.ok()) {
4731
    uint64_t new_log_number = impl->versions_->NewFileNumber();
4732
    unique_ptr<WritableFile> lfile;
4733
    EnvOptions soptions(db_options);
4734 4735 4736
    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 已提交
4737
    if (s.ok()) {
4738
      lfile->SetPreallocationBlockSize(1.1 * max_write_buffer_size);
4739
      impl->logfile_number_ = new_log_number;
4740
      impl->log_.reset(new log::Writer(std::move(lfile)));
I
Igor Canadi 已提交
4741

4742 4743
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
4744 4745
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764
        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 已提交
4765
        }
4766
      }
I
Igor Canadi 已提交
4767 4768
    }
    if (s.ok()) {
4769
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
4770 4771
        delete impl->InstallSuperVersion(
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
4772
      }
I
Igor Canadi 已提交
4773 4774
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
4775
      impl->DeleteObsoleteFiles();
4776
      impl->MaybeScheduleFlushOrCompaction();
4777
      s = impl->db_directory_->Fsync();
J
jorlow@chromium.org 已提交
4778 4779
    }
  }
4780

I
Igor Canadi 已提交
4781 4782
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
4783 4784
      if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
          cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
I
Igor Canadi 已提交
4785 4786 4787 4788
        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 已提交
4789 4790 4791
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
                "open with universal or FIFO compaction style.");
I
Igor Canadi 已提交
4792 4793 4794 4795
            break;
          }
        }
      }
4796
      if (cfd->ioptions()->merge_operator != nullptr &&
4797 4798 4799 4800 4801
          !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 已提交
4802
      if (!s.ok()) {
4803 4804 4805 4806 4807
        break;
      }
    }
  }

4808 4809
  impl->mutex_.Unlock();

J
jorlow@chromium.org 已提交
4810
  if (s.ok()) {
4811
    impl->opened_successfully_ = true;
J
jorlow@chromium.org 已提交
4812 4813
    *dbptr = impl;
  } else {
4814 4815 4816
    for (auto h : *handles) {
      delete h;
    }
4817
    handles->clear();
J
jorlow@chromium.org 已提交
4818 4819 4820 4821 4822
    delete impl;
  }
  return s;
}

4823 4824 4825
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
4826
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
4827 4828
}

4829 4830 4831
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
4832
Status DestroyDB(const std::string& dbname, const Options& options) {
4833
  const InternalKeyComparator comparator(options.comparator);
4834
  const Options& soptions(SanitizeOptions(dbname, &comparator, options));
4835
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
4836
  std::vector<std::string> filenames;
4837 4838
  std::vector<std::string> archiveFiles;

4839
  std::string archivedir = ArchivalDirectory(dbname);
J
jorlow@chromium.org 已提交
4840 4841
  // Ignore error in case directory does not exist
  env->GetChildren(dbname, &filenames);
4842 4843 4844 4845 4846 4847 4848

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

J
jorlow@chromium.org 已提交
4850 4851 4852 4853 4854
  if (filenames.empty()) {
    return Status::OK();
  }

  FileLock* lock;
4855 4856
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
4857 4858 4859
  if (result.ok()) {
    uint64_t number;
    FileType type;
4860
    InfoLogPrefix info_log_prefix(!options.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
4861
    for (size_t i = 0; i < filenames.size(); i++) {
4862
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
4863
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
4864 4865 4866
        Status del;
        if (type == kMetaDatabase) {
          del = DestroyDB(dbname + "/" + filenames[i], options);
4867 4868
        } else if (type == kLogFile) {
          del = env->DeleteFile(soptions.wal_dir + "/" + filenames[i]);
K
Kosie van der Merwe 已提交
4869 4870 4871
        } else {
          del = env->DeleteFile(dbname + "/" + filenames[i]);
        }
J
jorlow@chromium.org 已提交
4872 4873 4874 4875 4876
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4877

4878 4879
    for (auto& db_path : options.db_paths) {
      env->GetChildren(db_path.path, &filenames);
4880 4881 4882 4883 4884
      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
4885
          Status del = env->DeleteFile(db_path.path + "/" + filenames[i]);
4886 4887 4888 4889 4890 4891 4892
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

4893
    env->GetChildren(archivedir, &archiveFiles);
4894 4895
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
4896 4897
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
4898
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
4899 4900 4901 4902 4903
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4904
    // ignore case where no archival directory is present.
4905
    env->DeleteDir(archivedir);
4906

J
jorlow@chromium.org 已提交
4907
    env->UnlockFile(lock);  // Ignore error since state is already gone
4908
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
4909
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
4910
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
4911 4912 4913 4914
  }
  return result;
}

4915 4916
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
4917
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
4918
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
4919 4920 4921 4922
  // 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);
4923
  Log(log, "Git sha %s", rocksdb_build_git_sha);
4924
  Log(log, "Compile time %s %s",
4925
      rocksdb_build_compile_time, rocksdb_build_compile_date);
I
Igor Canadi 已提交
4926
#endif
4927 4928
}

4929
}  // namespace rocksdb