db_impl.cc 171.1 KB
Newer Older
1 2 3 4 5
//  Copyright (c) 2013, Facebook, Inc.  All rights reserved.
//  This source code is licensed under the BSD-style license found in the
//  LICENSE file in the root directory of this source tree. An additional grant
//  of patent rights can be found in the PATENTS file in the same directory.
//
J
jorlow@chromium.org 已提交
6 7 8 9 10 11
// Copyright (c) 2011 The LevelDB Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. See the AUTHORS file for names of contributors.

#include "db/db_impl.h"

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 52 53
#include "rocksdb/compaction_filter.h"
#include "rocksdb/db.h"
#include "rocksdb/env.h"
#include "rocksdb/merge_operator.h"
#include "rocksdb/statistics.h"
#include "rocksdb/status.h"
S
Siying Dong 已提交
54
#include "rocksdb/table.h"
J
jorlow@chromium.org 已提交
55
#include "table/block.h"
56
#include "table/block_based_table_factory.h"
J
jorlow@chromium.org 已提交
57
#include "table/merger.h"
K
kailiu 已提交
58
#include "table/table_builder.h"
J
jorlow@chromium.org 已提交
59
#include "table/two_level_iterator.h"
60
#include "util/auto_roll_logger.h"
K
kailiu 已提交
61
#include "util/autovector.h"
62
#include "util/build_version.h"
J
jorlow@chromium.org 已提交
63
#include "util/coding.h"
I
Igor Canadi 已提交
64
#include "util/hash_skiplist_rep.h"
65
#include "util/hash_linklist_rep.h"
J
jorlow@chromium.org 已提交
66
#include "util/logging.h"
H
Haobo Xu 已提交
67
#include "util/log_buffer.h"
J
jorlow@chromium.org 已提交
68
#include "util/mutexlock.h"
69
#include "util/perf_context_imp.h"
70
#include "util/iostats_context_imp.h"
71
#include "util/stop_watch.h"
72
#include "util/sync_point.h"
J
jorlow@chromium.org 已提交
73

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

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

K
kailiu 已提交
78
void DumpLeveldbBuildVersion(Logger * log);
79

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

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

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

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

  uint64_t total_bytes;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

282 283
namespace {

284
Status SanitizeDBOptionsByCFOptions(
285
    const DBOptions* db_opts,
286 287 288 289 290 291 292 293 294 295 296
    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();
}

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

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

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

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

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

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

367 368 369
  DumpLeveldbBuildVersion(db_options_.info_log.get());
  DumpDBFileSummary(db_options_, dbname_);
  db_options_.Dump(db_options_.info_log.get());
370

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  const uint64_t now_micros = env_->NowMicros();

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

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

523
    PrintStatistics();
524 525 526
  }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    if (keep) {
      continue;
    }

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

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

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

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

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

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

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

  purge_wal_files_last_run_ = now_seconds;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#endif  // ROCKSDB_LITE

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

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

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

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

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

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

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

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

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

H
heyongqiang 已提交
1217 1218 1219 1220 1221 1222
    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 已提交
1223 1224 1225 1226 1227 1228 1229
    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()) {
1230 1231
          cfd->CreateNewMemtable(MemTableOptions(
              *cfd->GetLatestMutableCFOptions(), *cfd->options()));
S
Stanislau Hlebik 已提交
1232 1233
        }
      }
1234
    }
L
Lei Jin 已提交
1235
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1236 1237
  }

I
Igor Canadi 已提交
1238 1239 1240 1241 1242
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    max_total_in_memory_state_ += cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
  }

J
jorlow@chromium.org 已提交
1243 1244 1245
  return s;
}

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

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

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

S
Stanislau Hlebik 已提交
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
    // 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 已提交
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
        // 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;
1358
          }
1359 1360
          cfd->CreateNewMemtable(MemTableOptions(
              *cfd->GetLatestMutableCFOptions(), *cfd->options()));
1361
        }
J
jorlow@chromium.org 已提交
1362 1363 1364
      }
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1612

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

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

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

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

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

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

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

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

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

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

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

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

1724 1725 1726 1727 1728 1729 1730
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);
}

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

    minimum_level = i;
  }
  return minimum_level;
}

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

I
Igor Canadi 已提交
1754
  SuperVersion* superversion_to_free = nullptr;
1755
  SuperVersion* new_superversion = new SuperVersion();
I
Igor Canadi 已提交
1756 1757

  mutex_.Lock();
1758 1759 1760

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

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

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

  assert(to_level <= level);

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

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

1803 1804 1805 1806
    status = versions_->LogAndApply(cfd,
        mutable_cf_options, &edit, &mutex_, db_directory_.get());
    superversion_to_free = cfd->InstallSuperVersion(
        new_superversion, &mutex_, mutable_cf_options);
I
Igor Canadi 已提交
1807
    new_superversion = nullptr;
1808

1809
    Log(db_options_.info_log, "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
1810
        status.ToString().data());
1811 1812

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

  refitting_level_ = false;
  bg_work_gate_closed_ = false;
I
Igor Canadi 已提交
1820 1821 1822 1823

  mutex_.Unlock();
  delete superversion_to_free;
  delete new_superversion;
L
Lei Jin 已提交
1824
  return status;
G
Gabor Cselle 已提交
1825 1826
}

1827 1828 1829
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
1830 1831
}

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

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

1842
Status DBImpl::Flush(const FlushOptions& options,
1843 1844 1845
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return FlushMemTable(cfh->cfd(), options);
H
heyongqiang 已提交
1846 1847
}

1848
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
1849 1850 1851
  return versions_->LastSequence();
}

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

G
Gabor Cselle 已提交
1857 1858
  InternalKey begin_storage, end_storage;

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

  MutexLock l(&mutex_);
1886

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

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

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

1928 1929 1930
  assert(!manual.in_progress);
  assert(bg_manual_only_ > 0);
  --bg_manual_only_;
L
Lei Jin 已提交
1931
  return manual.status;
J
jorlow@chromium.org 已提交
1932 1933
}

1934 1935
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
                             const FlushOptions& options) {
S
Stanislau Hlebik 已提交
1936 1937 1938 1939
  Status s;
  {
    WriteContext context;
    MutexLock guard_lock(&mutex_);
1940 1941 1942 1943 1944 1945

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

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

H
heyongqiang 已提交
1959
  if (s.ok() && options.wait) {
1960
    // Wait until the compaction completes
1961
    s = WaitForFlushMemTable(cfd);
1962 1963
  }
  return s;
J
jorlow@chromium.org 已提交
1964 1965
}

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

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

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

2029
void DBImpl::RecordFlushIOStats() {
I
Igor Canadi 已提交
2030
  RecordTick(stats_, FLUSH_WRITE_BYTES, IOSTATS(bytes_written));
2031 2032 2033 2034
  IOSTATS_RESET(bytes_written);
}

void DBImpl::RecordCompactionIOStats() {
L
Lei Jin 已提交
2035
  RecordTick(stats_, COMPACT_READ_BYTES, IOSTATS(bytes_read));
2036
  IOSTATS_RESET(bytes_read);
L
Lei Jin 已提交
2037
  RecordTick(stats_, COMPACT_WRITE_BYTES, IOSTATS(bytes_written));
2038 2039 2040
  IOSTATS_RESET(bytes_written);
}

2041
void DBImpl::BGWorkFlush(void* db) {
2042
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
2043 2044 2045 2046
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
}

void DBImpl::BGWorkCompaction(void* db) {
2047
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
2048 2049 2050
  reinterpret_cast<DBImpl*>(db)->BackgroundCallCompaction();
}

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

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

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

2089
void DBImpl::BackgroundCallFlush() {
2090
  bool madeProgress = false;
K
Kai Liu 已提交
2091
  DeletionState deletion_state(true);
2092 2093
  assert(bg_flush_scheduled_);

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

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

2156
void DBImpl::BackgroundCallCompaction() {
2157
  bool madeProgress = false;
K
Kai Liu 已提交
2158
  DeletionState deletion_state(true);
H
Haobo Xu 已提交
2159 2160

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

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

2209
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2210

2211 2212
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

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

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

2246 2247
  bool is_manual = (manual_compaction_ != nullptr) &&
                   (manual_compaction_->in_progress == false);
2248

2249 2250 2251 2252 2253 2254 2255 2256 2257 2258
  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_;
  }

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

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

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

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

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

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

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

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

    // 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 已提交
2464
      TableCache::Evict(table_cache_.get(), out.number);
2465
    }
J
jorlow@chromium.org 已提交
2466 2467 2468 2469
  }
  delete compact;
}

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

// Frees up unused file number.
void DBImpl::ReleaseCompactionUnusedFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2488
  for (const auto file_number : compact->allocated_file_numbers) {
2489 2490 2491 2492
    pending_outputs_.erase(file_number);
  }
}

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

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

J
jorlow@chromium.org 已提交
2523
  if (s.ok()) {
L
Lei Jin 已提交
2524
    compact->outfile->SetIOPriority(Env::IO_LOW);
2525
    compact->outfile->SetPreallocationBlockSize(
2526
        compact->compaction->OutputFilePreallocationSize(mutable_cf_options));
2527

2528
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2529
    compact->builder.reset(NewTableBuilder(
L
Lei Jin 已提交
2530 2531
        *cfd->ioptions(), cfd->internal_comparator(), compact->outfile.get(),
        compact->compaction->OutputCompressionType(),
2532
        cfd->ioptions()->compression_opts));
J
jorlow@chromium.org 已提交
2533
  }
2534
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
2535 2536 2537 2538 2539
  return s;
}

Status DBImpl::FinishCompactionOutputFile(CompactionState* compact,
                                          Iterator* input) {
2540
  assert(compact != nullptr);
2541
  assert(compact->outfile);
2542
  assert(compact->builder != nullptr);
J
jorlow@chromium.org 已提交
2543 2544

  const uint64_t output_number = compact->current_output()->number;
2545
  const uint32_t output_path_id = compact->current_output()->path_id;
J
jorlow@chromium.org 已提交
2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558
  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;
2559
  compact->builder.reset();
J
jorlow@chromium.org 已提交
2560 2561

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

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


2595
Status DBImpl::InstallCompactionResults(CompactionState* compact,
2596
    const MutableCFOptions& mutable_cf_options, LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
2597
  mutex_.AssertHeld();
2598 2599 2600 2601 2602

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

I
Igor Canadi 已提交
2612 2613
  LogToBuffer(log_buffer, "[%s] Compacted %d@%d + %d@%d files => %lld bytes",
              compact->compaction->column_family_data()->GetName().c_str(),
2614 2615 2616 2617 2618
              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 已提交
2619 2620 2621

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

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

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

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

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

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

D
Danny Guo 已提交
2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776
    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 已提交
2777

2778
    if (compact->compaction->ShouldStopBefore(key) &&
2779
        compact->builder != nullptr) {
D
Danny Guo 已提交
2780
      status = FinishCompactionOutputFile(compact, input);
2781 2782 2783 2784 2785 2786
      if (!status.ok()) {
        break;
      }
    }

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

2837 2838 2839
      // 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.
2840
      SequenceNumber prev_snapshot = 0; // 0 means no previous snapshot
2841 2842 2843 2844
      SequenceNumber visible = visible_at_tip ? visible_at_tip :
        is_snapshot_supported ?  findEarliestVisibleSnapshot(ikey.sequence,
                                  compact->existing_snapshots, &prev_snapshot)
                              : 0;
2845 2846 2847 2848 2849

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

2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903
        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 已提交
2904 2905 2906
      }

      last_sequence_for_key = ikey.sequence;
2907
      visible_in_snapshot = visible;
J
jorlow@chromium.org 已提交
2908 2909 2910
    }

    if (!drop) {
2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926
      // 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);
2927
      }
2928

2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939
      // 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.
2940
        if (bottommost_level && ikey.sequence < earliest_snapshot &&
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951
            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
2952

2953 2954
        // Open output file if necessary
        if (compact->builder == nullptr) {
2955
          status = OpenCompactionOutputFile(compact, mutable_cf_options);
2956 2957 2958 2959
          if (!status.ok()) {
            break;
          }
        }
2960 2961

        SequenceNumber seqno = GetInternalKeySeqno(newkey);
2962 2963
        if (compact->builder->NumEntries() == 0) {
          compact->current_output()->smallest.DecodeFrom(newkey);
2964 2965 2966 2967
          compact->current_output()->smallest_seqno = seqno;
        } else {
          compact->current_output()->smallest_seqno =
            std::min(compact->current_output()->smallest_seqno, seqno);
2968 2969 2970
        }
        compact->current_output()->largest.DecodeFrom(newkey);
        compact->builder->Add(newkey, value);
2971
        (*num_output_records)++,
2972 2973
        compact->current_output()->largest_seqno =
          std::max(compact->current_output()->largest_seqno, seqno);
2974 2975 2976 2977

        // Close output file if it is big enough
        if (compact->builder->FileSize() >=
            compact->compaction->MaxOutputFileSize()) {
D
Danny Guo 已提交
2978
          status = FinishCompactionOutputFile(compact, input);
2979 2980 2981
          if (!status.ok()) {
            break;
          }
J
jorlow@chromium.org 已提交
2982 2983
        }

2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003
        // 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 已提交
3004 3005 3006 3007 3008
          break;
        }
      }
    }

3009
    // MergeUntil has moved input to the next entry
3010
    if (!current_entry_is_merging) {
3011 3012
      input->Next();
    }
J
jorlow@chromium.org 已提交
3013
  }
3014 3015 3016 3017 3018 3019 3020 3021 3022
  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);
  }
3023 3024
  RecordCompactionIOStats();

D
Danny Guo 已提交
3025 3026 3027 3028 3029 3030 3031 3032 3033
  return status;
}

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

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

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

      // no value associated with delete
3083
      compact->existing_value_str_buf_[i].clear();
L
Lei Jin 已提交
3084
      RecordTick(stats_, COMPACTION_KEY_DROP_USER);
D
Danny Guo 已提交
3085
    } else if (compact->value_changed_buf_[i]) {
3086 3087
      compact->existing_value_str_buf_[i] =
          compact->new_value_buf_[new_value_idx++];
D
Danny Guo 已提交
3088 3089 3090 3091 3092
    }
  }  // for
}

Status DBImpl::DoCompactionWork(CompactionState* compact,
3093
                                const MutableCFOptions& mutable_cf_options,
D
Danny Guo 已提交
3094 3095 3096 3097 3098 3099
                                DeletionState& deletion_state,
                                LogBuffer* log_buffer) {
  assert(compact);
  compact->CleanupBatchBuffer();
  compact->CleanupMergedBuffer();

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

3116
  assert(cfd->current()->NumLevelFiles(compact->compaction->level()) > 0);
D
Danny Guo 已提交
3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141
  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);

3142
  bool is_snapshot_supported = IsSnapshotSupported();
D
Danny Guo 已提交
3143 3144
  // Release mutex while we're actually doing the compaction work
  mutex_.Unlock();
3145
  log_buffer->FlushBufferToLog();
D
Danny Guo 已提交
3146

3147
  int num_output_records = 0;
D
Danny Guo 已提交
3148 3149 3150 3151 3152 3153 3154 3155 3156 3157
  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 =
3158 3159
      cfd->ioptions()->compaction_filter_factory_v2->
          CreateCompactionFilterV2(context);
D
Danny Guo 已提交
3160 3161 3162
  auto compaction_filter_v2 =
    compaction_filter_from_factory_v2.get();

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

D
Danny Guo 已提交
3199 3200 3201 3202 3203
      Slice key = backup_input->key();
      Slice value = backup_input->value();

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

      // Merge this batch of data (values + ineligible keys)
3242
      compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3243 3244 3245 3246

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

        status = ProcessKeyValueCompaction(
3285
            mutable_cf_options,
3286
            is_snapshot_supported,
D
Danny Guo 已提交
3287 3288 3289 3290 3291 3292 3293 3294 3295
            visible_at_tip,
            earliest_snapshot,
            latest_snapshot,
            deletion_state,
            bottommost_level,
            imm_micros,
            input.get(),
            compact,
            true,
3296
            &num_output_records,
D
Danny Guo 已提交
3297 3298 3299 3300 3301 3302 3303
            log_buffer);

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

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

3336
  if (!db_options_.disableDataSync) {
3337 3338
    db_directory_->Fsync();
  }
I
Igor Canadi 已提交
3339

L
Lei Jin 已提交
3340
  InternalStats::CompactionStats stats(1);
3341
  stats.micros = env_->NowMicros() - start_micros - imm_micros;
M
Mark Callaghan 已提交
3342 3343
  stats.files_in_leveln = compact->compaction->num_input_files(0);
  stats.files_in_levelnp1 = compact->compaction->num_input_files(1);
L
Lei Jin 已提交
3344
  MeasureTime(stats_, COMPACTION_TIME, stats.micros);
3345 3346

  int num_output_files = compact->outputs.size();
3347
  if (compact->builder != nullptr) {
P
Pascal Borreli 已提交
3348
    // An error occurred so ignore the last output.
3349 3350 3351 3352
    assert(num_output_files > 0);
    --num_output_files;
  }
  stats.files_out_levelnp1 = num_output_files;
M
Mark Callaghan 已提交
3353

3354 3355
  uint64_t num_input_records = 0;

3356
  for (int i = 0; i < compact->compaction->num_input_files(0); i++) {
3357
    stats.bytes_readn += compact->compaction->input(0, i)->fd.GetFileSize();
3358 3359
    stats.num_input_records += compact->compaction->input(0, i)->num_entries;
    num_input_records += compact->compaction->input(0, i)->num_entries;
3360
  }
M
Mark Callaghan 已提交
3361

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

3367
  for (int i = 0; i < num_output_files; i++) {
3368 3369
    stats.bytes_written += compact->outputs[i].file_size;
  }
3370 3371
  stats.num_dropped_records =
      static_cast<int>(num_input_records) - num_output_records;
3372

3373 3374
  RecordCompactionIOStats();

3375
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
3376
  mutex_.Lock();
3377 3378
  cfd->internal_stats()->AddCompactionStats(
      compact->compaction->output_level(), stats);
J
jorlow@chromium.org 已提交
3379

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

J
jorlow@chromium.org 已提交
3409 3410 3411
  return status;
}

3412 3413
namespace {
struct IterState {
3414 3415
  IterState(DBImpl* db, port::Mutex* mu, SuperVersion* super_version)
      : db(db), mu(mu), super_version(super_version) {}
3416 3417

  DBImpl* db;
3418
  port::Mutex* mu;
3419
  SuperVersion* super_version;
3420 3421 3422 3423
};

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

3425
  if (state->super_version->Unref()) {
3426 3427
    DBImpl::DeletionState deletion_state;

3428 3429 3430 3431 3432 3433
    state->mu->Lock();
    state->super_version->Cleanup();
    state->db->FindObsoleteFiles(deletion_state, false, true);
    state->mu->Unlock();

    delete state->super_version;
3434 3435 3436
    if (deletion_state.HaveSomethingToDelete()) {
      state->db->PurgeObsoleteFiles(deletion_state);
    }
I
Igor Canadi 已提交
3437
  }
T
Tomislav Novak 已提交
3438

3439 3440
  delete state;
}
H
Hans Wennborg 已提交
3441
}  // namespace
3442

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

  return internal_iter;
}

3466 3467 3468 3469
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

J
jorlow@chromium.org 已提交
3470
Status DBImpl::Get(const ReadOptions& options,
3471
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3472
                   std::string* value) {
3473
  return GetImpl(options, column_family, key, value);
3474 3475
}

I
Igor Canadi 已提交
3476 3477 3478
// DeletionState gets created and destructed outside of the lock -- we
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3479
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3480 3481 3482 3483 3484 3485
//
// 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
3486 3487 3488
void DBImpl::InstallSuperVersion(
    ColumnFamilyData* cfd, DeletionState& deletion_state,
    const MutableCFOptions& mutable_cf_options) {
3489
  mutex_.AssertHeld();
I
Igor Canadi 已提交
3490 3491 3492 3493
  // if new_superversion == nullptr, it means somebody already used it
  SuperVersion* new_superversion =
    (deletion_state.new_superversion != nullptr) ?
    deletion_state.new_superversion : new SuperVersion();
3494
  SuperVersion* old_superversion =
3495
      cfd->InstallSuperVersion(new_superversion, &mutex_, mutable_cf_options);
I
Igor Canadi 已提交
3496
  deletion_state.new_superversion = nullptr;
3497
  deletion_state.superversions_to_free.push_back(old_superversion);
I
Igor Canadi 已提交
3498 3499
}

3500
Status DBImpl::GetImpl(const ReadOptions& options,
3501 3502
                       ColumnFamilyHandle* column_family, const Slice& key,
                       std::string* value, bool* value_found) {
L
Lei Jin 已提交
3503
  StopWatch sw(env_, stats_, DB_GET);
3504
  PERF_TIMER_GUARD(get_snapshot_time);
3505

3506 3507 3508
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3509
  SequenceNumber snapshot;
3510
  if (options.snapshot != nullptr) {
3511 3512 3513
    snapshot = reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_;
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3514
  }
3515

3516
  // Acquire SuperVersion
3517
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
I
Igor Canadi 已提交
3518

3519
  // Prepare to store a list of merge operations if merge occurs.
3520
  MergeContext merge_context;
3521

3522
  Status s;
3523
  // First look in the memtable, then in the immutable memtable (if any).
3524
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3525
  // merge_operands will contain the sequence of merges in the latter case.
3526
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3527
  PERF_TIMER_STOP(get_snapshot_time);
3528

3529
  if (sv->mem->Get(lkey, value, &s, &merge_context)) {
3530
    // Done
L
Lei Jin 已提交
3531
    RecordTick(stats_, MEMTABLE_HIT);
3532
  } else if (sv->imm->Get(lkey, value, &s, &merge_context)) {
3533
    // Done
L
Lei Jin 已提交
3534
    RecordTick(stats_, MEMTABLE_HIT);
3535
  } else {
3536
    PERF_TIMER_GUARD(get_from_output_files_time);
I
Igor Canadi 已提交
3537
    sv->current->Get(options, lkey, value, &s, &merge_context, value_found);
L
Lei Jin 已提交
3538
    RecordTick(stats_, MEMTABLE_MISS);
3539
  }
3540

3541 3542
  {
    PERF_TIMER_GUARD(get_post_process_time);
3543

3544
    ReturnAndCleanupSuperVersion(cfd, sv);
3545

3546 3547 3548
    RecordTick(stats_, NUMBER_KEYS_READ);
    RecordTick(stats_, BYTES_READ, value->size());
  }
3549
  return s;
J
jorlow@chromium.org 已提交
3550 3551
}

3552 3553
std::vector<Status> DBImpl::MultiGet(
    const ReadOptions& options,
3554
    const std::vector<ColumnFamilyHandle*>& column_family,
3555
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3556

L
Lei Jin 已提交
3557
  StopWatch sw(env_, stats_, DB_MULTIGET);
3558
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
3559

3560
  SequenceNumber snapshot;
3561

3562
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3563
    ColumnFamilyData* cfd;
3564 3565 3566 3567 3568
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3569 3570 3571 3572 3573 3574
    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});
3575 3576 3577
    }
  }

3578
  mutex_.Lock();
3579 3580 3581 3582 3583
  if (options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(options.snapshot)->number_;
  } else {
    snapshot = versions_->LastSequence();
  }
3584
  for (auto mgd_iter : multiget_cf_data) {
3585 3586
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3587
  }
3588
  mutex_.Unlock();
3589

3590 3591
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3592

3593
  // Note: this always resizes the values array
3594 3595 3596
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3597 3598

  // Keep track of bytes that we read for statistics-recording later
3599
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3600
  PERF_TIMER_STOP(get_snapshot_time);
3601 3602 3603 3604

  // 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.
3605
  // merge_operands will contain the sequence of merges in the latter case.
3606
  for (size_t i = 0; i < num_keys; ++i) {
3607
    merge_context.Clear();
3608
    Status& s = stat_list[i];
3609 3610 3611
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3612 3613
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3614 3615 3616
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
3617
    if (super_version->mem->Get(lkey, value, &s, &merge_context)) {
3618
      // Done
3619
    } else if (super_version->imm->Get(lkey, value, &s, &merge_context)) {
3620 3621
      // Done
    } else {
3622
      PERF_TIMER_GUARD(get_from_output_files_time);
I
Igor Canadi 已提交
3623
      super_version->current->Get(options, lkey, value, &s, &merge_context);
3624 3625 3626
    }

    if (s.ok()) {
3627
      bytes_read += value->size();
3628 3629 3630 3631
    }
  }

  // Post processing (decrement reference counts and record statistics)
3632
  PERF_TIMER_GUARD(get_post_process_time);
3633 3634
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
3635
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3636 3637 3638 3639 3640 3641
  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);
3642 3643
    }
  }
3644 3645 3646 3647 3648 3649 3650
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3651
  }
3652

L
Lei Jin 已提交
3653 3654 3655
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
L
Lei Jin 已提交
3656
  PERF_TIMER_STOP(get_post_process_time);
3657

3658
  return stat_list;
3659 3660
}

3661
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& options,
3662
                                  const std::string& column_family_name,
3663
                                  ColumnFamilyHandle** handle) {
I
Igor Canadi 已提交
3664 3665 3666
  *handle = nullptr;
  MutexLock l(&mutex_);

I
Igor Canadi 已提交
3667 3668
  if (versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name) !=
      nullptr) {
I
Igor Canadi 已提交
3669 3670
    return Status::InvalidArgument("Column family already exists");
  }
3671
  VersionEdit edit;
3672
  edit.AddColumnFamily(column_family_name);
3673 3674
  uint32_t new_id = versions_->GetColumnFamilySet()->GetNextColumnFamilyID();
  edit.SetColumnFamily(new_id);
I
Igor Canadi 已提交
3675
  edit.SetLogNumber(logfile_number_);
I
Igor Canadi 已提交
3676
  edit.SetComparatorName(options.comparator->Name());
3677

I
Igor Canadi 已提交
3678 3679
  // LogAndApply will both write the creation in MANIFEST and create
  // ColumnFamilyData object
3680 3681 3682 3683
  Options opt(db_options_, options);
  Status s = versions_->LogAndApply(nullptr,
      MutableCFOptions(opt, ImmutableCFOptions(opt)),
      &edit, &mutex_, db_directory_.get(), false, &options);
3684
  if (s.ok()) {
3685
    single_column_family_mode_ = false;
3686 3687 3688
    auto cfd =
        versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
    assert(cfd != nullptr);
3689 3690
    delete cfd->InstallSuperVersion(new SuperVersion(), &mutex_,
                                    *cfd->GetLatestMutableCFOptions());
3691
    *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
3692
    Log(db_options_.info_log, "Created column family [%s] (ID %u)",
3693
        column_family_name.c_str(), (unsigned)cfd->GetID());
I
Igor Canadi 已提交
3694 3695
    max_total_in_memory_state_ += cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
3696
  } else {
3697
    Log(db_options_.info_log, "Creating column family [%s] FAILED -- %s",
3698 3699
        column_family_name.c_str(), s.ToString().c_str());
  }
3700
  return s;
3701 3702
}

3703 3704 3705 3706
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3707 3708
    return Status::InvalidArgument("Can't drop default column family");
  }
3709

I
Igor Canadi 已提交
3710 3711
  VersionEdit edit;
  edit.DropColumnFamily();
3712 3713
  edit.SetColumnFamily(cfd->GetID());

3714

3715
  Status s;
3716 3717 3718 3719 3720 3721
  {
    MutexLock l(&mutex_);
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
3722
      // we drop column family from a single write thread
I
Igor Canadi 已提交
3723 3724
      WriteThread::Writer w(&mutex_);
      s = write_thread_.EnterWriteThread(&w, 0);
3725
      assert(s.ok() && !w.done);  // No timeout and nobody should do our job
3726 3727
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
I
Igor Canadi 已提交
3728
      write_thread_.ExitWriteThread(&w, &w, s);
3729
    }
3730
  }
3731

3732
  if (s.ok()) {
I
Igor Canadi 已提交
3733
    assert(cfd->IsDropped());
I
Igor Canadi 已提交
3734 3735
    max_total_in_memory_state_ -= cfd->options()->write_buffer_size *
                                  cfd->options()->max_write_buffer_number;
3736 3737
    Log(db_options_.info_log, "Dropped column family with id %u\n",
        cfd->GetID());
3738
  } else {
3739 3740
    Log(db_options_.info_log,
        "Dropping column family with id %u FAILED -- %s\n",
3741 3742 3743
        cfd->GetID(), s.ToString().c_str());
  }

3744
  return s;
3745 3746
}

3747
bool DBImpl::KeyMayExist(const ReadOptions& options,
3748 3749
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
3750
  if (value_found != nullptr) {
K
Kai Liu 已提交
3751 3752
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
3753
  }
3754 3755
  ReadOptions roptions = options;
  roptions.read_tier = kBlockCacheTier; // read from block cache only
3756
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
3757

3758
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
3759 3760 3761
  // 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();
3762 3763
}

3764
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
3765 3766 3767
                              ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
3768

3769
  if (read_options.tailing) {
I
Igor Canadi 已提交
3770 3771 3772 3773
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
3774 3775 3776 3777 3778
    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 已提交
3779
#endif
T
Tomislav Novak 已提交
3780
  } else {
3781 3782 3783 3784
    SequenceNumber latest_snapshot = versions_->LastSequence();
    SuperVersion* sv = nullptr;
    sv = cfd->GetReferencedSuperVersion(&mutex_);

I
Igor Canadi 已提交
3785
    auto snapshot =
3786 3787 3788
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
3789
            : latest_snapshot;
T
Tomislav Novak 已提交
3790

3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833
    // 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(
3834 3835 3836
        env_, *cfd->ioptions(), cfd->user_comparator(),
        snapshot, cfd->options()->max_sequential_skip_in_iterations,
        read_options.iterate_upper_bound);
3837

3838
    Iterator* internal_iter =
3839
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
3840 3841 3842 3843
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
3844 3845
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
3846 3847
}

3848
Status DBImpl::NewIterators(
3849
    const ReadOptions& read_options,
I
Igor Canadi 已提交
3850
    const std::vector<ColumnFamilyHandle*>& column_families,
3851
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3852 3853 3854 3855 3856 3857
  iterators->clear();
  iterators->reserve(column_families.size());
  SequenceNumber latest_snapshot = 0;
  std::vector<SuperVersion*> super_versions;
  super_versions.reserve(column_families.size());

3858
  if (!read_options.tailing) {
I
Igor Canadi 已提交
3859 3860 3861 3862 3863 3864 3865 3866 3867
    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();
  }

3868
  if (read_options.tailing) {
I
Igor Canadi 已提交
3869 3870 3871 3872
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
3873 3874
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
3875
      auto iter = new ForwardIterator(this, read_options, cfd);
L
Lei Jin 已提交
3876
      iterators->push_back(
3877 3878 3879
          NewDBIterator(env_, *cfd->ioptions(), cfd->user_comparator(), iter,
                        kMaxSequenceNumber,
                        cfd->options()->max_sequential_skip_in_iterations));
I
Igor Canadi 已提交
3880
    }
I
Igor Canadi 已提交
3881
#endif
I
Igor Canadi 已提交
3882 3883 3884 3885 3886 3887
  } 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 =
3888 3889 3890
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
3891 3892
              : latest_snapshot;

3893
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
3894 3895
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
          cfd->options()->max_sequential_skip_in_iterations);
3896
      Iterator* internal_iter = NewInternalIterator(
3897
          read_options, cfd, super_versions[i], db_iter->GetArena());
3898 3899
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
3900 3901 3902 3903
    }
  }

  return Status::OK();
3904 3905
}

3906 3907 3908 3909 3910 3911 3912 3913 3914
bool DBImpl::IsSnapshotSupported() const {
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (!cfd->mem()->IsSnapshotSupported()) {
      return false;
    }
  }
  return true;
}

J
jorlow@chromium.org 已提交
3915
const Snapshot* DBImpl::GetSnapshot() {
3916
  MutexLock l(&mutex_);
3917 3918
  // returns null if the underlying memtable does not support snapshot.
  if (!IsSnapshotSupported()) return nullptr;
3919
  return snapshots_.New(versions_->LastSequence());
J
jorlow@chromium.org 已提交
3920 3921 3922 3923
}

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

// Convenience methods
3928 3929
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
3930
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
3931 3932
}

3933 3934 3935
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
3936
  if (!cfh->cfd()->ioptions()->merge_operator) {
3937 3938
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
3939
    return DB::Merge(o, column_family, key, val);
3940 3941 3942
  }
}

3943
Status DBImpl::Delete(const WriteOptions& options,
3944
                      ColumnFamilyHandle* column_family, const Slice& key) {
3945
  return DB::Delete(options, column_family, key);
J
jorlow@chromium.org 已提交
3946 3947
}

S
Stanislau Hlebik 已提交
3948 3949 3950 3951
Status DBImpl::Write(const WriteOptions& options, WriteBatch* my_batch) {
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
3952
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
I
Igor Canadi 已提交
3953
  WriteThread::Writer w(&mutex_);
S
Stanislau Hlebik 已提交
3954 3955 3956 3957 3958 3959 3960 3961
  w.batch = my_batch;
  w.sync = options.sync;
  w.disableWAL = options.disableWAL;
  w.in_batch_group = false;
  w.done = false;
  w.timeout_hint_us = options.timeout_hint_us;

  uint64_t expiration_time = 0;
I
Igor Canadi 已提交
3962
  bool has_timeout = false;
S
Stanislau Hlebik 已提交
3963
  if (w.timeout_hint_us == 0) {
I
Igor Canadi 已提交
3964
    w.timeout_hint_us = WriteThread::kNoTimeOut;
S
Stanislau Hlebik 已提交
3965 3966
  } else {
    expiration_time = env_->NowMicros() + w.timeout_hint_us;
I
Igor Canadi 已提交
3967
    has_timeout = true;
S
Stanislau Hlebik 已提交
3968 3969 3970 3971 3972 3973 3974 3975 3976
  }

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

  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
3977
  Status status = write_thread_.EnterWriteThread(&w, expiration_time);
S
Stanislau Hlebik 已提交
3978 3979
  assert(status.ok() || status.IsTimedOut());
  if (status.IsTimedOut()) {
3980
    mutex_.Unlock();
L
Lei Jin 已提交
3981
    RecordTick(stats_, WRITE_TIMEDOUT);
3982
    return Status::TimedOut();
3983
  }
S
Stanislau Hlebik 已提交
3984 3985 3986 3987 3988 3989 3990 3991 3992 3993
  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);
3994

3995 3996 3997 3998
  // 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.
3999 4000 4001
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

4002
  uint64_t max_total_wal_size = (db_options_.max_total_wal_size == 0)
4003
                                    ? 4 * max_total_in_memory_state_
4004
                                    : db_options_.max_total_wal_size;
4005
  if (UNLIKELY(!single_column_family_mode_) &&
4006
      alive_log_files_.begin()->getting_flushed == false &&
I
Igor Canadi 已提交
4007
      total_log_size_ > max_total_wal_size) {
I
Igor Canadi 已提交
4008
    uint64_t flush_column_family_if_log_file = alive_log_files_.begin()->number;
I
Igor Canadi 已提交
4009
    alive_log_files_.begin()->getting_flushed = true;
4010
    Log(db_options_.info_log,
4011 4012 4013
        "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 已提交
4014 4015
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4016
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
4017
      if (cfd->GetLogNumber() <= flush_column_family_if_log_file) {
S
Stanislau Hlebik 已提交
4018
        status = SetNewMemtableAndNewLogFile(cfd, &context);
I
Igor Canadi 已提交
4019 4020 4021
        if (!status.ok()) {
          break;
        }
S
Stanislau Hlebik 已提交
4022
        cfd->imm()->FlushRequested();
4023
      }
4024
    }
I
Igor Canadi 已提交
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043
    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)) {
    DelayWrite(expiration_time);
  }

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

D
dgrogan@chromium.org 已提交
4046
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4047
  WriteThread::Writer* last_writer = &w;
S
Stanislau Hlebik 已提交
4048
  if (status.ok()) {
4049
    autovector<WriteBatch*> write_batch_group;
I
Igor Canadi 已提交
4050
    write_thread_.BuildBatchGroup(&last_writer, &write_batch_group);
4051

4052 4053 4054
    // 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
4055
    // into memtables
4056
    {
4057
      mutex_.Unlock();
4058 4059 4060 4061 4062 4063 4064 4065 4066 4067
      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]);
        }
      }

4068 4069 4070 4071
      const SequenceNumber current_sequence = last_sequence + 1;
      WriteBatchInternal::SetSequence(updates, current_sequence);
      int my_batch_count = WriteBatchInternal::Count(updates);
      last_sequence += my_batch_count;
4072
      const uint64_t batch_size = WriteBatchInternal::ByteSize(updates);
4073
      // Record statistics
L
Lei Jin 已提交
4074 4075
      RecordTick(stats_, NUMBER_KEYS_WRITTEN, my_batch_count);
      RecordTick(stats_, BYTES_WRITTEN, WriteBatchInternal::ByteSize(updates));
4076 4077
      if (options.disableWAL) {
        flush_on_destroy_ = true;
4078
      }
L
Lei Jin 已提交
4079
      PERF_TIMER_STOP(write_pre_and_post_process_time);
4080

4081
      uint64_t log_size = 0;
4082
      if (!options.disableWAL) {
4083
        PERF_TIMER_GUARD(write_wal_time);
4084 4085
        Slice log_entry = WriteBatchInternal::Contents(updates);
        status = log_->AddRecord(log_entry);
I
Igor Canadi 已提交
4086 4087
        total_log_size_ += log_entry.size();
        alive_log_files_.back().AddSize(log_entry.size());
4088
        log_empty_ = false;
4089
        log_size = log_entry.size();
L
Lei Jin 已提交
4090
        RecordTick(stats_, WAL_FILE_BYTES, log_size);
H
heyongqiang 已提交
4091
        if (status.ok() && options.sync) {
I
Igor Canadi 已提交
4092
          RecordTick(stats_, WAL_FILE_SYNCED);
4093
          StopWatch sw(env_, stats_, WAL_FILE_SYNC_MICROS);
4094
          if (db_options_.use_fsync) {
4095
            status = log_->file()->Fsync();
4096
          } else {
4097
            status = log_->file()->Sync();
4098
          }
H
heyongqiang 已提交
4099
        }
4100 4101
      }
      if (status.ok()) {
4102
        PERF_TIMER_GUARD(write_memtable_time);
Y
Yueh-Hsuan Chiang 已提交
4103

4104
        status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
4105 4106
            updates, column_family_memtables_.get(),
            options.ignore_missing_column_families, 0, this, false);
Y
Yueh-Hsuan Chiang 已提交
4107 4108 4109 4110 4111 4112 4113 4114
        // 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 已提交
4115
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
4116
      }
L
Lei Jin 已提交
4117
      PERF_TIMER_START(write_pre_and_post_process_time);
4118 4119 4120
      if (updates == &tmp_batch_) {
        tmp_batch_.Clear();
      }
4121
      mutex_.Lock();
4122 4123 4124 4125 4126 4127 4128 4129 4130
      // internal stats
      default_cf_internal_stats_->AddDBStats(
          InternalStats::BYTES_WRITTEN, batch_size);
      if (!options.disableWAL) {
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_SYNCED, 1);
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_BYTES, log_size);
      }
4131
      if (status.ok()) {
4132
        versions_->SetLastSequence(last_sequence);
4133
      }
J
jorlow@chromium.org 已提交
4134 4135
    }
  }
4136
  if (db_options_.paranoid_checks && !status.ok() &&
4137
      !status.IsTimedOut() && bg_error_.ok()) {
I
Igor Canadi 已提交
4138 4139
    bg_error_ = status; // stop compaction & fail any further writes
  }
4140

I
Igor Canadi 已提交
4141
  write_thread_.ExitWriteThread(&w, last_writer, status);
I
Igor Canadi 已提交
4142
  mutex_.Unlock();
4143

4144
  if (status.IsTimedOut()) {
L
Lei Jin 已提交
4145
    RecordTick(stats_, WRITE_TIMEDOUT);
4146 4147
  }

J
jorlow@chromium.org 已提交
4148 4149 4150
  return status;
}

4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
void DBImpl::DelayWrite(uint64_t expiration_time) {
  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();
  }

  while (write_controller_.IsStopped()) {
    if (has_timeout) {
      bg_cv_.TimedWait(expiration_time);
      if (env_->NowMicros() > expiration_time) {
        break;
      }
    } else {
      bg_cv_.Wait();
    }
  }
4173 4174
}

I
Igor Canadi 已提交
4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185
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 已提交
4186 4187
    }
  }
I
Igor Canadi 已提交
4188 4189 4190 4191
  if (schedule_bg_work) {
    MaybeScheduleFlushOrCompaction();
  }
  return Status::OK();
S
Stanislau Hlebik 已提交
4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209
}

// 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;
4210
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
S
Stanislau Hlebik 已提交
4211 4212 4213 4214
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
4215 4216 4217
      s = env_->NewWritableFile(
          LogFileName(db_options_.wal_dir, new_log_number),
          &lfile, env_->OptimizeForLogWrite(env_options_));
S
Stanislau Hlebik 已提交
4218 4219 4220 4221 4222 4223
      if (s.ok()) {
        // Our final size should be less than write_buffer_size
        // (compression, etc) but err on the side of caution.
        lfile->SetPreallocationBlockSize(1.1 *
                                         cfd->options()->write_buffer_size);
        new_log = new log::Writer(std::move(lfile));
I
Igor Canadi 已提交
4224
      }
S
Stanislau Hlebik 已提交
4225 4226 4227
    }

    if (s.ok()) {
L
Lei Jin 已提交
4228
      new_mem = new MemTable(cfd->internal_comparator(),
4229 4230
          *cfd->ioptions(), MemTableOptions(mutable_cf_options,
          *cfd->options()));
S
Stanislau Hlebik 已提交
4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258
      new_superversion = new SuperVersion();
    }
  }
  mutex_.Lock();
  if (!s.ok()) {
    // how do we fail if we're not creating new log?
    assert(creating_new_log);
    // Avoid chewing through file number space in a tight loop.
    versions_->ReuseLogFileNumber(new_log_number);
    assert(!new_mem);
    assert(!new_log);
    return s;
  }
  if (creating_new_log) {
    logfile_number_ = new_log_number;
    assert(new_log != nullptr);
    context->logs_to_free_.push_back(log_.release());
    log_.reset(new_log);
    log_empty_ = true;
    alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
    for (auto cfd : *versions_->GetColumnFamilySet()) {
      // all this is just optimization to delete logs that
      // are no longer needed -- if CF is empty, that means it
      // doesn't need that particular log to stay alive, so we just
      // advance the log number. no need to persist this in the manifest
      if (cfd->mem()->GetFirstSequenceNumber() == 0 &&
          cfd->imm()->size() == 0) {
        cfd->SetLogNumber(logfile_number_);
4259
      }
4260 4261
    }
  }
S
Stanislau Hlebik 已提交
4262 4263 4264 4265
  cfd->mem()->SetNextLogNumber(logfile_number_);
  cfd->imm()->Add(cfd->mem());
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
4266
  Log(db_options_.info_log,
S
Stanislau Hlebik 已提交
4267 4268 4269
      "[%s] New memtable created with log file: #%" PRIu64 "\n",
      cfd->GetName().c_str(), logfile_number_);
  context->superversions_to_free_.push_back(
4270
      cfd->InstallSuperVersion(new_superversion, &mutex_, mutable_cf_options));
4271 4272 4273
  return s;
}

I
Igor Canadi 已提交
4274
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4275 4276 4277 4278 4279
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4280 4281
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4282
  auto version = cfd->current();
4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
I
Igor Canadi 已提交
4295
#endif  // ROCKSDB_LITE
4296

I
Igor Canadi 已提交
4297 4298 4299 4300
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4301 4302 4303 4304
Env* DBImpl::GetEnv() const {
  return env_;
}

4305 4306
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4307
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4308 4309
}

4310
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4311
                         const Slice& property, std::string* value) {
4312 4313
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4314 4315 4316
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);

4317
  value->clear();
4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332
  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 已提交
4333 4334
}

4335 4336
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
4337 4338
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350
  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) {
4351 4352
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4353 4354 4355

  if (!need_out_of_mutex) {
    MutexLock l(&mutex_);
4356
    return cfd->internal_stats()->GetIntProperty(property_type, value, this);
4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370
  } 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 已提交
4371
  return cfd->GetThreadLocalSuperVersion(&mutex_);
4372 4373 4374 4375
}

void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
4376
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389

  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);
  }
4390 4391
}

4392
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4393
                                 const Range* range, int n, uint64_t* sizes) {
J
jorlow@chromium.org 已提交
4394 4395
  // TODO(opt): better implementation
  Version* v;
4396 4397
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
J
jorlow@chromium.org 已提交
4398 4399
  {
    MutexLock l(&mutex_);
4400
    v = cfd->current();
4401
    v->Ref();
J
jorlow@chromium.org 已提交
4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418
  }

  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 已提交
4419 4420 4421 4422 4423
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
4424
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440
  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;
  }
4441
  iter->reset(new TransactionLogIteratorImpl(db_options_.wal_dir, &db_options_,
L
Lei Jin 已提交
4442
                                             read_options, env_options_,
I
Igor Canadi 已提交
4443 4444 4445 4446
                                             seq, std::move(wal_files), this));
  return (*iter)->status();
}

4447 4448 4449
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4450 4451 4452
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
4453
    Log(db_options_.info_log, "DeleteFile %s failed.\n", name.c_str());
4454 4455 4456
    return Status::InvalidArgument("Invalid file name");
  }

4457 4458 4459 4460
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4461
      Log(db_options_.info_log, "DeleteFile %s failed - not archived log.\n",
4462
          name.c_str());
4463 4464
      return Status::NotSupported("Delete only supported for archived logs");
    }
4465
    status = env_->DeleteFile(db_options_.wal_dir + "/" + name.c_str());
4466
    if (!status.ok()) {
4467
      Log(db_options_.info_log, "DeleteFile %s failed -- %s.\n",
4468
          name.c_str(), status.ToString().c_str());
4469 4470 4471 4472
    }
    return status;
  }

4473
  int level;
I
Igor Canadi 已提交
4474
  FileMetaData* metadata;
4475
  ColumnFamilyData* cfd;
4476
  VersionEdit edit;
K
Kai Liu 已提交
4477
  DeletionState deletion_state(true);
D
Dhruba Borthakur 已提交
4478 4479
  {
    MutexLock l(&mutex_);
4480
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
4481
    if (!status.ok()) {
4482
      Log(db_options_.info_log, "DeleteFile %s failed. File not found\n",
4483
                             name.c_str());
D
Dhruba Borthakur 已提交
4484 4485
      return Status::InvalidArgument("File not found");
    }
I
Igor Canadi 已提交
4486
    assert((level > 0) && (level < cfd->NumberLevels()));
4487

D
Dhruba Borthakur 已提交
4488
    // If the file is being compacted no need to delete.
4489
    if (metadata->being_compacted) {
4490
      Log(db_options_.info_log,
4491
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
D
Dhruba Borthakur 已提交
4492
      return Status::OK();
4493 4494
    }

D
Dhruba Borthakur 已提交
4495 4496 4497
    // 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 已提交
4498
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
4499
      if (cfd->current()->NumLevelFiles(i) != 0) {
4500
        Log(db_options_.info_log,
4501
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
D
Dhruba Borthakur 已提交
4502 4503 4504 4505
        return Status::InvalidArgument("File not in last level");
      }
    }
    edit.DeleteFile(level, number);
4506 4507
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                    &edit, &mutex_, db_directory_.get());
I
Igor Canadi 已提交
4508
    if (status.ok()) {
4509 4510
      InstallSuperVersion(cfd, deletion_state,
                          *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
4511
    }
I
Igor Canadi 已提交
4512
    FindObsoleteFiles(deletion_state, false);
D
Dhruba Borthakur 已提交
4513
  } // lock released here
4514
  LogFlush(db_options_.info_log);
I
Igor Canadi 已提交
4515
  // remove files outside the db-lock
4516 4517 4518
  if (deletion_state.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(deletion_state);
  }
4519 4520 4521 4522 4523 4524
  {
    MutexLock l(&mutex_);
    // schedule flush if file deletion means we freed the space for flushes to
    // continue
    MaybeScheduleFlushOrCompaction();
  }
4525 4526 4527
  return status;
}

4528
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4529
  MutexLock l(&mutex_);
4530
  versions_->GetLiveFilesMetaData(metadata);
4531
}
I
Igor Canadi 已提交
4532
#endif  // ROCKSDB_LITE
4533

I
Igor Canadi 已提交
4534 4535 4536 4537 4538 4539 4540
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
4543 4544 4545 4546 4547 4548
    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) {
4549
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561
                             ". 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);
  }
}

4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588
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 已提交
4589 4590
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
4591
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
4592
               const Slice& key, const Slice& value) {
4593 4594 4595 4596
  // 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);
4597
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
4598 4599 4600
  return Write(opt, &batch);
}

4601 4602
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
4603
  WriteBatch batch;
4604
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
4605 4606 4607
  return Write(opt, &batch);
}

4608 4609
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
4610
  WriteBatch batch;
4611
  batch.Merge(column_family, key, value);
4612 4613 4614
  return Write(opt, &batch);
}

4615 4616
// Default implementation -- returns not supported status
Status DB::CreateColumnFamily(const ColumnFamilyOptions& options,
4617
                              const std::string& column_family_name,
4618
                              ColumnFamilyHandle** handle) {
4619
  return Status::NotSupported("");
4620
}
4621
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
4622
  return Status::NotSupported("");
4623 4624
}

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

J
Jim Paton 已提交
4627
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
4628 4629 4630 4631
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
4632
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
4633
  std::vector<ColumnFamilyHandle*> handles;
4634
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
4635 4636 4637 4638 4639 4640 4641
  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;
4642 4643
}

4644 4645
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
4646
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
4647 4648 4649 4650
  Status s = SanitizeDBOptionsByCFOptions(&db_options, column_families);
  if (!s.ok()) {
    return s;
  }
4651
  if (db_options.db_paths.size() > 1) {
4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663
    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. ");
    }
4664 4665
  }

4666
  *dbptr = nullptr;
4667
  handles->clear();
J
jorlow@chromium.org 已提交
4668

I
Igor Canadi 已提交
4669 4670 4671 4672
  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);
4673
  }
4674

I
Igor Canadi 已提交
4675
  DBImpl* impl = new DBImpl(db_options, dbname);
4676
  s = impl->env_->CreateDirIfMissing(impl->db_options_.wal_dir);
4677
  if (s.ok()) {
4678
    for (auto db_path : impl->db_options_.db_paths) {
4679
      s = impl->env_->CreateDirIfMissing(db_path.path);
4680 4681 4682 4683 4684 4685
      if (!s.ok()) {
        break;
      }
    }
  }

4686 4687 4688 4689 4690 4691
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
4692 4693 4694 4695
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
4696
  impl->mutex_.Lock();
4697 4698
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
4699
  if (s.ok()) {
4700
    uint64_t new_log_number = impl->versions_->NewFileNumber();
4701
    unique_ptr<WritableFile> lfile;
4702
    EnvOptions soptions(db_options);
4703 4704 4705
    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 已提交
4706
    if (s.ok()) {
4707
      lfile->SetPreallocationBlockSize(1.1 * max_write_buffer_size);
4708
      impl->logfile_number_ = new_log_number;
4709
      impl->log_.reset(new log::Writer(std::move(lfile)));
I
Igor Canadi 已提交
4710

4711 4712
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
4713 4714
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733
        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 已提交
4734
        }
4735
      }
I
Igor Canadi 已提交
4736 4737
    }
    if (s.ok()) {
4738
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
4739 4740
        delete cfd->InstallSuperVersion(new SuperVersion(), &impl->mutex_,
            *cfd->GetLatestMutableCFOptions());
4741
      }
I
Igor Canadi 已提交
4742 4743
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
4744
      impl->DeleteObsoleteFiles();
4745
      impl->MaybeScheduleFlushOrCompaction();
4746
      s = impl->db_directory_->Fsync();
J
jorlow@chromium.org 已提交
4747 4748
    }
  }
4749

I
Igor Canadi 已提交
4750 4751
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
4752 4753
      if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
          cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
I
Igor Canadi 已提交
4754 4755 4756 4757
        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 已提交
4758 4759 4760
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
                "open with universal or FIFO compaction style.");
I
Igor Canadi 已提交
4761 4762 4763 4764
            break;
          }
        }
      }
4765
      if (cfd->ioptions()->merge_operator != nullptr &&
4766 4767 4768 4769 4770
          !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 已提交
4771
      if (!s.ok()) {
4772 4773 4774 4775 4776
        break;
      }
    }
  }

4777 4778
  impl->mutex_.Unlock();

J
jorlow@chromium.org 已提交
4779
  if (s.ok()) {
4780
    impl->opened_successfully_ = true;
J
jorlow@chromium.org 已提交
4781 4782
    *dbptr = impl;
  } else {
4783 4784 4785
    for (auto h : *handles) {
      delete h;
    }
4786
    handles->clear();
J
jorlow@chromium.org 已提交
4787 4788 4789 4790 4791
    delete impl;
  }
  return s;
}

4792 4793 4794
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
4795
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
4796 4797
}

4798 4799 4800
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
4801
Status DestroyDB(const std::string& dbname, const Options& options) {
4802
  const InternalKeyComparator comparator(options.comparator);
4803
  const Options& soptions(SanitizeOptions(dbname, &comparator, options));
4804
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
4805
  std::vector<std::string> filenames;
4806 4807
  std::vector<std::string> archiveFiles;

4808
  std::string archivedir = ArchivalDirectory(dbname);
J
jorlow@chromium.org 已提交
4809 4810
  // Ignore error in case directory does not exist
  env->GetChildren(dbname, &filenames);
4811 4812 4813 4814 4815 4816 4817

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

J
jorlow@chromium.org 已提交
4819 4820 4821 4822 4823
  if (filenames.empty()) {
    return Status::OK();
  }

  FileLock* lock;
4824 4825
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
4826 4827 4828
  if (result.ok()) {
    uint64_t number;
    FileType type;
4829
    InfoLogPrefix info_log_prefix(!options.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
4830
    for (size_t i = 0; i < filenames.size(); i++) {
4831
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
4832
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
4833 4834 4835
        Status del;
        if (type == kMetaDatabase) {
          del = DestroyDB(dbname + "/" + filenames[i], options);
4836 4837
        } else if (type == kLogFile) {
          del = env->DeleteFile(soptions.wal_dir + "/" + filenames[i]);
K
Kosie van der Merwe 已提交
4838 4839 4840
        } else {
          del = env->DeleteFile(dbname + "/" + filenames[i]);
        }
J
jorlow@chromium.org 已提交
4841 4842 4843 4844 4845
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4846

4847 4848
    for (auto& db_path : options.db_paths) {
      env->GetChildren(db_path.path, &filenames);
4849 4850 4851 4852 4853
      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
4854
          Status del = env->DeleteFile(db_path.path + "/" + filenames[i]);
4855 4856 4857 4858 4859 4860 4861
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

4862
    env->GetChildren(archivedir, &archiveFiles);
4863 4864
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
4865 4866
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
4867
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
4868 4869 4870 4871 4872
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4873
    // ignore case where no archival directory is present.
4874
    env->DeleteDir(archivedir);
4875

J
jorlow@chromium.org 已提交
4876
    env->UnlockFile(lock);  // Ignore error since state is already gone
4877
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
4878
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
4879
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
4880 4881 4882 4883
  }
  return result;
}

4884 4885
//
// A global method that can dump out the build version
K
kailiu 已提交
4886
void DumpLeveldbBuildVersion(Logger * log) {
I
Igor Canadi 已提交
4887 4888
#if !defined(IOS_CROSS_COMPILE)
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't generate util/build_version.cc
4889
  Log(log, "Git sha %s", rocksdb_build_git_sha);
4890
  Log(log, "Compile time %s %s",
4891
      rocksdb_build_compile_time, rocksdb_build_compile_date);
I
Igor Canadi 已提交
4892
#endif
4893 4894
}

4895
}  // namespace rocksdb