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

#include "db/db_impl.h"

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

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

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

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

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

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

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

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

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

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

  uint64_t total_bytes;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

284 285
namespace {

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

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

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

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

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

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

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

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

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

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

  // Wait for background work to finish
I
Igor Canadi 已提交
392
  shutting_down_.store(true, std::memory_order_release);
I
Igor Canadi 已提交
393
  while (bg_compaction_scheduled_ || bg_flush_scheduled_) {
H
hans@chromium.org 已提交
394
    bg_cv_.Wait();
J
jorlow@chromium.org 已提交
395
  }
396

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

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

I
Igor Canadi 已提交
406 407 408 409 410 411 412 413 414 415
  // 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_) {
I
Igor Canadi 已提交
416 417
    JobContext job_context;
    FindObsoleteFiles(&job_context, true);
I
Igor Canadi 已提交
418
    // manifest number starting from 2
I
Igor Canadi 已提交
419 420 421
    job_context.manifest_file_number = 1;
    if (job_context.HaveSomethingToDelete()) {
      PurgeObsoleteFiles(job_context);
422 423 424
    }
  }

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

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

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

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

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

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

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

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

  const uint64_t now_micros = env_->NowMicros();

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

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

525
    PrintStatistics();
526 527 528
  }
}

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

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

544 545 546 547 548
  bool doing_the_full_scan = false;

  // logic for figurint out if we're doing the full scan
  if (no_full_scan) {
    doing_the_full_scan = false;
549
  } else if (force || db_options_.delete_obsolete_files_period_micros == 0) {
550 551 552 553
    doing_the_full_scan = true;
  } else {
    const uint64_t now_micros = env_->NowMicros();
    if (delete_obsolete_files_last_run_ +
554
        db_options_.delete_obsolete_files_period_micros < now_micros) {
555 556 557 558 559
      doing_the_full_scan = true;
      delete_obsolete_files_last_run_ = now_micros;
    }
  }

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

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

I
Igor Canadi 已提交
570
  if (!doing_the_full_scan && !job_context->HaveSomethingToDelete()) {
571 572 573 574 575 576 577
    // avoid filling up sst_live if we're sure that we
    // are not going to do the full scan and that we don't have
    // anything to delete at the moment
    return;
  }

  // don't delete live files
578
  for (auto pair : pending_outputs_) {
I
Igor Canadi 已提交
579
    job_context->sst_live.emplace_back(pair.first, pair.second, 0);
580
  }
I
Igor Canadi 已提交
581
  versions_->AddLiveFiles(&job_context->sst_live);
I
Igor Canadi 已提交
582

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

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

617
namespace {
I
Igor Canadi 已提交
618 619
bool CompareCandidateFile(const JobContext::CandidateFileInfo& first,
                          const JobContext::CandidateFileInfo& second) {
620 621 622 623 624
  if (first.file_name > second.file_name) {
    return true;
  } else if (first.file_name < second.file_name) {
    return false;
  } else {
625
    return (first.path_id > second.path_id);
626 627 628 629
  }
}
};  // namespace

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

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

645
  // Now, convert live list to an unordered map, WITHOUT mutex held;
646
  // set is slow.
647
  std::unordered_map<uint64_t, const FileDescriptor*> sst_live_map;
I
Igor Canadi 已提交
648
  for (const FileDescriptor& fd : state.sst_live) {
649 650
    sst_live_map[fd.GetNumber()] = &fd;
  }
I
Igor Canadi 已提交
651

I
Igor Canadi 已提交
652 653 654 655
  auto candidate_files = state.candidate_files;
  candidate_files.reserve(candidate_files.size() +
                          state.sst_delete_files.size() +
                          state.log_delete_files.size());
K
kailiu 已提交
656 657
  // We may ignore the dbname when generating the file names.
  const char* kDumbDbName = "";
658
  for (auto file : state.sst_delete_files) {
659 660 661
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
662
    delete file;
I
Igor Canadi 已提交
663 664
  }

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

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

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

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

    if (keep) {
      continue;
    }

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

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

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

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
I
Igor Canadi 已提交
784 785 786 787
  JobContext job_context;
  FindObsoleteFiles(&job_context, true);
  if (job_context.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(job_context);
788
  }
789 790
}

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

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

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

  purge_wal_files_last_run_ = now_seconds;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#endif  // ROCKSDB_LITE

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

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

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

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

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

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

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

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

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

H
heyongqiang 已提交
1215 1216 1217 1218 1219 1220
    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 已提交
1221 1222 1223 1224 1225 1226 1227
    if (!logs.empty()) {
      // Recover in the order in which the logs were generated
      std::sort(logs.begin(), logs.end());
      s = RecoverLogFiles(logs, &max_sequence, read_only);
      if (!s.ok()) {
        // Clear memtables if recovery failed
        for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1228
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions());
S
Stanislau Hlebik 已提交
1229 1230
        }
      }
1231
    }
L
Lei Jin 已提交
1232
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1233 1234
  }

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

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
          }
L
Lei Jin 已提交
1359
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions());
1360
        }
J
jorlow@chromium.org 已提交
1361 1362 1363
      }
    }

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

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

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

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

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

J
jorlow@chromium.org 已提交
1420 1421 1422
  return status;
}

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

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

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

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

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

1480 1481
Status DBImpl::FlushMemTableToOutputFile(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
I
Igor Canadi 已提交
1482
    bool* madeProgress, JobContext* job_context, LogBuffer* log_buffer) {
1483
  mutex_.AssertHeld();
1484
  assert(cfd->imm()->size() != 0);
1485
  assert(cfd->imm()->IsFlushPending());
1486

I
Igor Canadi 已提交
1487 1488 1489 1490 1491
  FlushJob flush_job(dbname_, cfd, db_options_, mutable_cf_options,
                     env_options_, versions_.get(), &mutex_, &shutting_down_,
                     &pending_outputs_, snapshots_.GetNewest(), job_context,
                     log_buffer, db_directory_.get(),
                     GetCompressionFlush(*cfd->ioptions()), stats_);
1492

I
Igor Canadi 已提交
1493
  Status s = flush_job.Run();
J
jorlow@chromium.org 已提交
1494 1495

  if (s.ok()) {
I
Igor Canadi 已提交
1496
    InstallSuperVersionBackground(cfd, job_context, mutable_cf_options);
1497 1498 1499
    if (madeProgress) {
      *madeProgress = 1;
    }
S
sdong 已提交
1500
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Igor Canadi 已提交
1501
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
S
sdong 已提交
1502
                cfd->current()->GetStorageInfo()->LevelSummary(&tmp));
1503

1504
    if (disable_delete_obsolete_files_ == 0) {
I
Igor Canadi 已提交
1505
      // add to deletion state
1506
      while (alive_log_files_.size() &&
I
Igor Canadi 已提交
1507 1508
             alive_log_files_.begin()->number < versions_->MinLogNumber()) {
        const auto& earliest = *alive_log_files_.begin();
I
Igor Canadi 已提交
1509
        job_context->log_delete_files.push_back(earliest.number);
I
Igor Canadi 已提交
1510
        total_log_size_ -= earliest.size;
1511 1512
        alive_log_files_.pop_front();
      }
1513
    }
J
jorlow@chromium.org 已提交
1514
  }
1515

1516
  if (!s.ok() && !s.IsShutdownInProgress() && db_options_.paranoid_checks &&
1517 1518 1519 1520 1521
      bg_error_.ok()) {
    // if a bad error happened (not ShutdownInProgress) and paranoid_checks is
    // true, mark DB read-only
    bg_error_ = s;
  }
1522
  RecordFlushIOStats();
J
jorlow@chromium.org 已提交
1523 1524 1525
  return s;
}

1526
Status DBImpl::CompactRange(ColumnFamilyHandle* column_family,
1527
                            const Slice* begin, const Slice* end,
1528 1529
                            bool reduce_level, int target_level,
                            uint32_t target_path_id) {
1530
  if (target_path_id >= db_options_.db_paths.size()) {
1531 1532 1533
    return Status::InvalidArgument("Invalid target path ID");
  }

1534 1535
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
I
Igor Canadi 已提交
1536 1537

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
1538
  if (!s.ok()) {
1539
    LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1540 1541 1542
    return s;
  }

I
Igor Canadi 已提交
1543
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
1544 1545
  {
    MutexLock l(&mutex_);
I
Igor Canadi 已提交
1546 1547
    Version* base = cfd->current();
    for (int level = 1; level < cfd->NumberLevels(); level++) {
S
sdong 已提交
1548
      if (base->GetStorageInfo()->OverlapInLevel(level, begin, end)) {
G
Gabor Cselle 已提交
1549 1550 1551 1552
        max_level_with_files = level;
      }
    }
  }
1553 1554
  for (int level = 0; level <= max_level_with_files; level++) {
    // in case the compaction is unversal or if we're compacting the
1555 1556 1557
    // 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)
1558 1559
    if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
        cfd->ioptions()->compaction_style == kCompactionStyleFIFO ||
1560
        (level == max_level_with_files && level > 0)) {
1561
      s = RunManualCompaction(cfd, level, level, target_path_id, begin, end);
1562
    } else {
1563 1564
      s = RunManualCompaction(cfd, level, level + 1, target_path_id, begin,
                              end);
L
Lei Jin 已提交
1565 1566
    }
    if (!s.ok()) {
1567
      LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1568
      return s;
1569
    }
G
Gabor Cselle 已提交
1570
  }
1571 1572

  if (reduce_level) {
I
Igor Canadi 已提交
1573
    s = ReFitLevel(cfd, max_level_with_files, target_level);
1574
  }
1575
  LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1576

1577 1578 1579 1580 1581 1582 1583
  {
    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 已提交
1584
  return s;
1585 1586
}

1587 1588
bool DBImpl::SetOptions(ColumnFamilyHandle* column_family,
    const std::unordered_map<std::string, std::string>& options_map) {
L
Lei Jin 已提交
1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619
  auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  if (options_map.empty()) {
    Log(db_options_.info_log, "SetOptions() on column family [%s], empty input",
        cfd->GetName().c_str());
    return false;
  }

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

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

1622
// return the same level if it cannot be moved
1623 1624
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd,
    const MutableCFOptions& mutable_cf_options, int level) {
1625
  mutex_.AssertHeld();
S
sdong 已提交
1626
  auto* vstorage = cfd->current()->GetStorageInfo();
1627
  int minimum_level = level;
1628
  for (int i = level - 1; i > 0; --i) {
1629
    // stop if level i is not empty
S
sdong 已提交
1630
    if (vstorage->NumLevelFiles(i) > 0) break;
1631
    // stop if level i is too small (cannot fit the level files)
1632
    if (mutable_cf_options.MaxBytesForLevel(i) <
S
sdong 已提交
1633
        vstorage->NumLevelBytes(level)) {
1634 1635
      break;
    }
1636 1637 1638 1639 1640 1641

    minimum_level = i;
  }
  return minimum_level;
}

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

I
Igor Canadi 已提交
1645
  SuperVersion* superversion_to_free = nullptr;
1646
  SuperVersion* new_superversion = new SuperVersion();
I
Igor Canadi 已提交
1647 1648

  mutex_.Lock();
1649 1650 1651

  // only allow one thread refitting
  if (refitting_level_) {
I
Igor Canadi 已提交
1652
    mutex_.Unlock();
1653
    Log(db_options_.info_log, "ReFitLevel: another thread is refitting");
I
Igor Canadi 已提交
1654
    delete new_superversion;
L
Lei Jin 已提交
1655
    return Status::NotSupported("another thread is refitting");
1656 1657 1658 1659 1660
  }
  refitting_level_ = true;

  // wait for all background threads to stop
  bg_work_gate_closed_ = true;
1661
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_) {
1662
    Log(db_options_.info_log,
1663 1664
        "RefitLevel: waiting for background threads to stop: %d %d",
        bg_compaction_scheduled_, bg_flush_scheduled_);
1665 1666 1667
    bg_cv_.Wait();
  }

1668 1669
  const MutableCFOptions mutable_cf_options =
    *cfd->GetLatestMutableCFOptions();
1670
  // move to a smaller level
1671 1672
  int to_level = target_level;
  if (target_level < 0) {
1673
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
1674
  }
1675 1676 1677

  assert(to_level <= level);

L
Lei Jin 已提交
1678
  Status status;
1679
  if (to_level < level) {
1680 1681
    Log(db_options_.info_log, "[%s] Before refitting:\n%s",
        cfd->GetName().c_str(), cfd->current()->DebugString().data());
1682

1683
    VersionEdit edit;
I
Igor Canadi 已提交
1684
    edit.SetColumnFamily(cfd->GetID());
S
sdong 已提交
1685
    for (const auto& f : cfd->current()->GetStorageInfo()->files_[level]) {
1686
      edit.DeleteFile(level, f->fd.GetNumber());
1687 1688 1689
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
                   f->smallest_seqno, f->largest_seqno);
1690
    }
1691
    Log(db_options_.info_log, "[%s] Apply version edit:\n%s",
I
Igor Canadi 已提交
1692
        cfd->GetName().c_str(), edit.DebugString().data());
1693

1694 1695
    status = versions_->LogAndApply(cfd,
        mutable_cf_options, &edit, &mutex_, db_directory_.get());
L
Lei Jin 已提交
1696 1697
    superversion_to_free = InstallSuperVersion(
        cfd, new_superversion, mutable_cf_options);
I
Igor Canadi 已提交
1698
    new_superversion = nullptr;
1699

1700
    Log(db_options_.info_log, "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
1701
        status.ToString().data());
1702 1703

    if (status.ok()) {
1704
      Log(db_options_.info_log, "[%s] After refitting:\n%s",
I
Igor Canadi 已提交
1705
          cfd->GetName().c_str(), cfd->current()->DebugString().data());
1706 1707 1708 1709 1710
    }
  }

  refitting_level_ = false;
  bg_work_gate_closed_ = false;
I
Igor Canadi 已提交
1711 1712 1713 1714

  mutex_.Unlock();
  delete superversion_to_free;
  delete new_superversion;
L
Lei Jin 已提交
1715
  return status;
G
Gabor Cselle 已提交
1716 1717
}

1718 1719 1720
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
1721 1722
}

1723 1724
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
1725 1726 1727
  MutexLock l(&mutex_);
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.max_mem_compaction_level;
1728 1729
}

1730 1731
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
1732 1733 1734
  MutexLock l(&mutex_);
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.level0_stop_writes_trigger;
1735 1736
}

L
Lei Jin 已提交
1737
Status DBImpl::Flush(const FlushOptions& flush_options,
1738 1739
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
1740
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
1741 1742
}

1743
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
1744 1745 1746
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
1747
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
1748 1749
                                   int output_level, uint32_t output_path_id,
                                   const Slice* begin, const Slice* end) {
1750
  assert(input_level >= 0);
1751

G
Gabor Cselle 已提交
1752 1753
  InternalKey begin_storage, end_storage;

H
hans@chromium.org 已提交
1754
  ManualCompaction manual;
I
Igor Canadi 已提交
1755
  manual.cfd = cfd;
1756 1757
  manual.input_level = input_level;
  manual.output_level = output_level;
1758
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
1759
  manual.done = false;
1760
  manual.in_progress = false;
1761 1762 1763
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
1764 1765
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
1766
    manual.begin = nullptr;
G
Gabor Cselle 已提交
1767 1768 1769 1770
  } else {
    begin_storage = InternalKey(*begin, kMaxSequenceNumber, kValueTypeForSeek);
    manual.begin = &begin_storage;
  }
1771
  if (end == nullptr ||
1772 1773
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
1774
    manual.end = nullptr;
G
Gabor Cselle 已提交
1775 1776 1777 1778 1779 1780
  } else {
    end_storage = InternalKey(*end, 0, static_cast<ValueType>(0));
    manual.end = &end_storage;
  }

  MutexLock l(&mutex_);
1781

1782 1783 1784 1785 1786 1787
  // 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
1788
  // RunManualCompaction(), i.e. during that time no other compaction will
1789 1790 1791
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
1792
  // RunManualCompaction() from getting to the second while loop below.
1793 1794 1795 1796 1797
  // 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) {
1798
    Log(db_options_.info_log,
I
Igor Canadi 已提交
1799 1800 1801
        "[%s] Manual compaction waiting for all other scheduled background "
        "compactions to finish",
        cfd->GetName().c_str());
1802 1803
    bg_cv_.Wait();
  }
1804

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

1808 1809 1810 1811
  // 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) {
1812 1813 1814
    assert(bg_manual_only_ > 0);
    if (manual_compaction_ != nullptr) {
      // Running either this or some other manual compaction
G
Gabor Cselle 已提交
1815
      bg_cv_.Wait();
1816 1817
    } else {
      manual_compaction_ = &manual;
1818 1819
      bg_compaction_scheduled_++;
      env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW);
G
Gabor Cselle 已提交
1820
    }
H
hans@chromium.org 已提交
1821
  }
1822

1823 1824 1825
  assert(!manual.in_progress);
  assert(bg_manual_only_ > 0);
  --bg_manual_only_;
L
Lei Jin 已提交
1826
  return manual.status;
J
jorlow@chromium.org 已提交
1827 1828
}

1829
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
L
Lei Jin 已提交
1830
                             const FlushOptions& flush_options) {
S
Stanislau Hlebik 已提交
1831 1832 1833 1834
  Status s;
  {
    WriteContext context;
    MutexLock guard_lock(&mutex_);
1835 1836 1837 1838 1839 1840

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

I
Igor Canadi 已提交
1841 1842
    WriteThread::Writer w(&mutex_);
    s = write_thread_.EnterWriteThread(&w, 0);
S
Stanislau Hlebik 已提交
1843 1844 1845 1846 1847 1848 1849 1850
    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 已提交
1851
    write_thread_.ExitWriteThread(&w, &w, s);
S
Stanislau Hlebik 已提交
1852
  }
S
Stanislau Hlebik 已提交
1853

L
Lei Jin 已提交
1854
  if (s.ok() && flush_options.wait) {
1855
    // Wait until the compaction completes
1856
    s = WaitForFlushMemTable(cfd);
1857 1858
  }
  return s;
J
jorlow@chromium.org 已提交
1859 1860
}

1861
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
1862 1863 1864
  Status s;
  // Wait until the compaction completes
  MutexLock l(&mutex_);
1865
  while (cfd->imm()->size() > 0 && bg_error_.ok()) {
1866 1867
    bg_cv_.Wait();
  }
1868
  if (!bg_error_.ok()) {
1869 1870 1871
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
1872 1873
}

1874
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
1875
  mutex_.AssertHeld();
1876
  bg_schedule_needed_ = false;
1877 1878
  if (bg_work_gate_closed_) {
    // gate closed for backgrond work
I
Igor Canadi 已提交
1879
  } else if (shutting_down_.load(std::memory_order_acquire)) {
J
jorlow@chromium.org 已提交
1880 1881
    // DB is being deleted; no more background compactions
  } else {
1882
    bool is_flush_pending = false;
1883
    // no need to refcount since we're under a mutex
1884
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
1885
      if (cfd->imm()->IsFlushPending()) {
1886 1887 1888
        is_flush_pending = true;
      }
    }
1889
    if (is_flush_pending) {
1890
      // memtable flush needed
1891
      if (bg_flush_scheduled_ < db_options_.max_background_flushes) {
1892 1893
        bg_flush_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH);
1894
      } else if (db_options_.max_background_flushes > 0) {
1895
        bg_schedule_needed_ = true;
1896
      }
1897
    }
1898
    bool is_compaction_needed = false;
1899
    // no need to refcount since we're under a mutex
1900
    for (auto cfd : *versions_->GetColumnFamilySet()) {
S
sdong 已提交
1901
      if (cfd->current()->GetStorageInfo()->NeedsCompaction()) {
1902 1903 1904 1905
        is_compaction_needed = true;
        break;
      }
    }
1906

1907 1908
    // Schedule BGWorkCompaction if there's a compaction pending (or a memtable
    // flush, but the HIGH pool is not enabled)
1909 1910 1911 1912
    // Do it only if max_background_compactions hasn't been reached and
    // bg_manual_only_ == 0
    if (!bg_manual_only_ &&
        (is_compaction_needed ||
1913 1914
         (is_flush_pending && db_options_.max_background_flushes == 0))) {
      if (bg_compaction_scheduled_ < db_options_.max_background_compactions) {
1915 1916 1917 1918 1919
        bg_compaction_scheduled_++;
        env_->Schedule(&DBImpl::BGWorkCompaction, this, Env::Priority::LOW);
      } else {
        bg_schedule_needed_ = true;
      }
1920 1921 1922 1923
    }
  }
}

1924
void DBImpl::RecordFlushIOStats() {
I
Igor Canadi 已提交
1925
  RecordTick(stats_, FLUSH_WRITE_BYTES, IOSTATS(bytes_written));
1926 1927 1928 1929
  IOSTATS_RESET(bytes_written);
}

void DBImpl::RecordCompactionIOStats() {
L
Lei Jin 已提交
1930
  RecordTick(stats_, COMPACT_READ_BYTES, IOSTATS(bytes_read));
1931
  IOSTATS_RESET(bytes_read);
L
Lei Jin 已提交
1932
  RecordTick(stats_, COMPACT_WRITE_BYTES, IOSTATS(bytes_written));
1933 1934 1935
  IOSTATS_RESET(bytes_written);
}

1936
void DBImpl::BGWorkFlush(void* db) {
1937
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
1938 1939 1940 1941
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
}

void DBImpl::BGWorkCompaction(void* db) {
1942
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
1943 1944 1945
  reinterpret_cast<DBImpl*>(db)->BackgroundCallCompaction();
}

I
Igor Canadi 已提交
1946
Status DBImpl::BackgroundFlush(bool* madeProgress, JobContext* job_context,
H
Haobo Xu 已提交
1947
                               LogBuffer* log_buffer) {
1948
  mutex_.AssertHeld();
1949 1950 1951 1952 1953

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

1954 1955 1956 1957 1958
  // 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
1959
  for (auto cfd : *versions_->GetColumnFamilySet()) {
1960 1961
    cfd->Ref();
    Status flush_status;
1962 1963
    const MutableCFOptions mutable_cf_options =
      *cfd->GetLatestMutableCFOptions();
1964
    while (flush_status.ok() && cfd->imm()->IsFlushPending()) {
1965 1966
      LogToBuffer(
          log_buffer,
1967
          "BackgroundCallFlush doing FlushMemTableToOutputFile with column "
I
Igor Canadi 已提交
1968 1969
          "family [%s], flush slots available %d",
          cfd->GetName().c_str(),
1970
          db_options_.max_background_flushes - bg_flush_scheduled_);
1971
      flush_status = FlushMemTableToOutputFile(
I
Igor Canadi 已提交
1972
          cfd, mutable_cf_options, madeProgress, job_context, log_buffer);
1973 1974 1975
    }
    if (call_status.ok() && !flush_status.ok()) {
      call_status = flush_status;
1976
    }
1977
    cfd->Unref();
J
jorlow@chromium.org 已提交
1978
  }
1979
  versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
1980
  return call_status;
J
jorlow@chromium.org 已提交
1981 1982
}

1983
void DBImpl::BackgroundCallFlush() {
1984
  bool madeProgress = false;
I
Igor Canadi 已提交
1985
  JobContext job_context(true);
1986 1987
  assert(bg_flush_scheduled_);

1988
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
H
Haobo Xu 已提交
1989 1990 1991 1992
  {
    MutexLock l(&mutex_);

    Status s;
I
Igor Canadi 已提交
1993
    if (!shutting_down_.load(std::memory_order_acquire)) {
I
Igor Canadi 已提交
1994
      s = BackgroundFlush(&madeProgress, &job_context, &log_buffer);
H
Haobo Xu 已提交
1995 1996 1997 1998 1999
      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.
2000 2001
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
H
Haobo Xu 已提交
2002 2003
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
2004
        Log(db_options_.info_log,
2005 2006 2007
            "Waiting after background flush error: %s"
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
H
Haobo Xu 已提交
2008
        log_buffer.FlushBufferToLog();
2009
        LogFlush(db_options_.info_log);
H
Haobo Xu 已提交
2010 2011 2012 2013 2014 2015 2016
        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()
I
Igor Canadi 已提交
2017
    FindObsoleteFiles(&job_context, !s.ok());
H
Haobo Xu 已提交
2018
    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
2019
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2020
      mutex_.Unlock();
2021 2022 2023 2024 2025
      // 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 已提交
2026
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
2027 2028
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
2029
      }
2030 2031
      mutex_.Lock();
    }
I
Igor Canadi 已提交
2032

H
Haobo Xu 已提交
2033
    bg_flush_scheduled_--;
2034 2035 2036 2037 2038
    // 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 已提交
2039 2040
      MaybeScheduleFlushOrCompaction();
    }
I
Igor Canadi 已提交
2041
    RecordFlushIOStats();
H
Haobo Xu 已提交
2042
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
2043 2044 2045 2046
    // 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.
2047
  }
J
jorlow@chromium.org 已提交
2048 2049
}

2050
void DBImpl::BackgroundCallCompaction() {
2051
  bool madeProgress = false;
I
Igor Canadi 已提交
2052
  JobContext job_context(true);
H
Haobo Xu 已提交
2053 2054

  MaybeDumpStats();
2055
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
2056 2057 2058 2059
  {
    MutexLock l(&mutex_);
    assert(bg_compaction_scheduled_);
    Status s;
I
Igor Canadi 已提交
2060
    if (!shutting_down_.load(std::memory_order_acquire)) {
I
Igor Canadi 已提交
2061
      s = BackgroundCompaction(&madeProgress, &job_context, &log_buffer);
2062 2063 2064 2065 2066
      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.
2067 2068
        uint64_t error_cnt =
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
2069 2070
        bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
        mutex_.Unlock();
H
Haobo Xu 已提交
2071
        log_buffer.FlushBufferToLog();
2072
        Log(db_options_.info_log,
2073 2074 2075
            "Waiting after background compaction error: %s, "
            "Accumulated background error counts: %" PRIu64,
            s.ToString().c_str(), error_cnt);
2076
        LogFlush(db_options_.info_log);
2077 2078 2079 2080
        env_->SleepForMicroseconds(1000000);
        mutex_.Lock();
      }
    }
H
Haobo Xu 已提交
2081

2082 2083
    // 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
I
Igor Canadi 已提交
2084 2085 2086
    // FindObsoleteFiles(). This is because job_context does not
    // catch all created files if compaction failed.
    FindObsoleteFiles(&job_context, !s.ok());
2087 2088

    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
2089
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
2090
      mutex_.Unlock();
2091 2092 2093 2094 2095
      // 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 已提交
2096
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
2097 2098
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
2099
      }
2100 2101
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
2102

2103
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
2104

2105 2106
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

2107 2108 2109
    // Previous compaction may have produced too many files in a level,
    // So reschedule another compaction if we made progress in the
    // last compaction.
2110 2111 2112 2113 2114 2115
    //
    // 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_) {
2116 2117
      MaybeScheduleFlushOrCompaction();
    }
2118 2119
    if (madeProgress || bg_compaction_scheduled_ == 0 || bg_manual_only_ > 0) {
      // signal if
I
Igor Canadi 已提交
2120
      // * madeProgress -- need to wakeup DelayWrite
2121 2122 2123 2124 2125 2126
      // * 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 已提交
2127 2128 2129 2130
    // 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.
2131
  }
J
jorlow@chromium.org 已提交
2132 2133
}

I
Igor Canadi 已提交
2134
Status DBImpl::BackgroundCompaction(bool* madeProgress, JobContext* job_context,
2135
                                    LogBuffer* log_buffer) {
2136
  *madeProgress = false;
J
jorlow@chromium.org 已提交
2137
  mutex_.AssertHeld();
2138

2139 2140
  bool is_manual = (manual_compaction_ != nullptr) &&
                   (manual_compaction_->in_progress == false);
2141

2142 2143 2144 2145 2146 2147 2148 2149 2150 2151
  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_;
  }

2152 2153 2154
  if (is_manual) {
    // another thread cannot pick up the same work
    manual_compaction_->in_progress = true;
2155 2156 2157 2158
  } else if (manual_compaction_ != nullptr) {
    // there should be no automatic compactions running when manual compaction
    // is running
    return Status::OK();
2159 2160 2161 2162 2163
  }

  // FLUSH preempts compaction
  Status flush_stat;
  for (auto cfd : *versions_->GetColumnFamilySet()) {
2164 2165
    const MutableCFOptions mutable_cf_options =
      *cfd->GetLatestMutableCFOptions();
2166 2167 2168 2169 2170
    while (cfd->imm()->IsFlushPending()) {
      LogToBuffer(
          log_buffer,
          "BackgroundCompaction doing FlushMemTableToOutputFile, "
          "compaction slots available %d",
2171
          db_options_.max_background_compactions - bg_compaction_scheduled_);
2172
      cfd->Ref();
2173
      flush_stat = FlushMemTableToOutputFile(
I
Igor Canadi 已提交
2174
          cfd, mutable_cf_options, madeProgress, job_context, log_buffer);
2175
      cfd->Unref();
2176 2177 2178 2179 2180 2181 2182
      if (!flush_stat.ok()) {
        if (is_manual) {
          manual_compaction_->status = flush_stat;
          manual_compaction_->done = true;
          manual_compaction_->in_progress = false;
          manual_compaction_ = nullptr;
        }
2183
        return flush_stat;
2184 2185 2186 2187
      }
    }
  }

2188 2189 2190
  // 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
2191
  unique_ptr<Compaction> c;
2192 2193
  InternalKey manual_end_storage;
  InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
2194
  if (is_manual) {
G
Gabor Cselle 已提交
2195
    ManualCompaction* m = manual_compaction_;
2196
    assert(m->in_progress);
2197 2198 2199
    c.reset(m->cfd->CompactRange(
          *m->cfd->GetLatestMutableCFOptions(), m->input_level, m->output_level,
          m->output_path_id, m->begin, m->end, &manual_end));
2200
    if (!c) {
2201
      m->done = true;
G
Gabor Cselle 已提交
2202
    }
I
Igor Canadi 已提交
2203 2204 2205 2206 2207 2208 2209 2210 2211
    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 已提交
2212
  } else {
2213
    // no need to refcount in iteration since it's always under a mutex
I
Igor Canadi 已提交
2214
    for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
2215 2216 2217 2218
      // Pick up latest mutable CF Options and use it throughout the
      // compaction job
      auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
      if (!mutable_cf_options->disable_auto_compactions) {
2219 2220 2221
        // NOTE: try to avoid unnecessary copy of MutableCFOptions if
        // compaction is not necessary. Need to make sure mutex is held
        // until we make a copy in the following code
L
Lei Jin 已提交
2222
        c.reset(cfd->PickCompaction(*mutable_cf_options, log_buffer));
I
Igor Canadi 已提交
2223 2224
        if (c != nullptr) {
          // update statistics
L
Lei Jin 已提交
2225
          MeasureTime(stats_, NUM_FILES_IN_SINGLE_COMPACTION,
I
Igor Canadi 已提交
2226 2227 2228
                      c->inputs(0)->size());
          break;
        }
I
Igor Canadi 已提交
2229 2230
      }
    }
J
jorlow@chromium.org 已提交
2231 2232 2233
  }

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

S
sdong 已提交
2272 2273 2274 2275 2276 2277
    VersionStorageInfo::LevelSummaryStorage tmp;
    LogToBuffer(log_buffer, "[%s] Moved #%" PRIu64 " to level-%d %" PRIu64
                            " bytes %s: %s\n",
                c->column_family_data()->GetName().c_str(), f->fd.GetNumber(),
                c->level() + 1, f->fd.GetFileSize(), status.ToString().c_str(),
                c->input_version()->GetStorageInfo()->LevelSummary(&tmp));
I
Igor Canadi 已提交
2278
    c->ReleaseCompactionFiles(status);
2279
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2280
  } else {
2281
    MaybeScheduleFlushOrCompaction(); // do more compaction work in parallel.
2282
    CompactionState* compact = new CompactionState(c.get());
I
Igor Canadi 已提交
2283 2284
    status = DoCompactionWork(compact, *c->mutable_cf_options(), job_context,
                              log_buffer);
2285
    CleanupCompaction(compact, status);
I
Igor Canadi 已提交
2286
    c->ReleaseCompactionFiles(status);
2287
    c->ReleaseInputs();
2288
    *madeProgress = true;
J
jorlow@chromium.org 已提交
2289
  }
2290
  c.reset();
J
jorlow@chromium.org 已提交
2291 2292 2293

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
2294
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
2295 2296
    // Ignore compaction errors found during shutting down
  } else {
2297
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log, "Compaction error: %s",
2298
        status.ToString().c_str());
2299
    if (db_options_.paranoid_checks && bg_error_.ok()) {
J
jorlow@chromium.org 已提交
2300 2301 2302
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
2303 2304

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

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

    // 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 已提交
2357
      TableCache::Evict(table_cache_.get(), out.number);
2358
    }
J
jorlow@chromium.org 已提交
2359 2360 2361 2362
  }
  delete compact;
}

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

// Frees up unused file number.
void DBImpl::ReleaseCompactionUnusedFileNumbers(CompactionState* compact) {
  mutex_.AssertHeld();
2381
  for (const auto file_number : compact->allocated_file_numbers) {
2382 2383 2384 2385
    pending_outputs_.erase(file_number);
  }
}

2386 2387
Status DBImpl::OpenCompactionOutputFile(
    CompactionState* compact, const MutableCFOptions& mutable_cf_options) {
2388 2389
  assert(compact != nullptr);
  assert(compact->builder == nullptr);
J
jorlow@chromium.org 已提交
2390
  uint64_t file_number;
2391 2392 2393 2394 2395 2396 2397
  // 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 已提交
2398 2399
    mutex_.Lock();
    file_number = versions_->NewFileNumber();
2400
    pending_outputs_[file_number] = compact->compaction->GetOutputPathId();
J
jorlow@chromium.org 已提交
2401 2402
    mutex_.Unlock();
  }
2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416
  // Make the output file
  std::string fname = TableFileName(db_options_.db_paths, file_number,
                                    compact->compaction->GetOutputPathId());
  Status s = env_->NewWritableFile(fname, &compact->outfile, env_options_);

  if (!s.ok()) {
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "[%s] OpenCompactionOutputFiles for table #%" PRIu64 " "
        "fails at NewWritableFile with status %s",
        compact->compaction->column_family_data()->GetName().c_str(),
        file_number, s.ToString().c_str());
    LogFlush(db_options_.info_log);
    return s;
  }
2417 2418
  CompactionState::Output out;
  out.number = file_number;
2419
  out.path_id = compact->compaction->GetOutputPathId();
2420 2421
  out.smallest.Clear();
  out.largest.Clear();
2422
  out.smallest_seqno = out.largest_seqno = 0;
J
jorlow@chromium.org 已提交
2423

2424 2425 2426 2427
  compact->outputs.push_back(out);
  compact->outfile->SetIOPriority(Env::IO_LOW);
  compact->outfile->SetPreallocationBlockSize(
      compact->compaction->OutputFilePreallocationSize(mutable_cf_options));
2428

2429 2430 2431 2432 2433
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
  compact->builder.reset(NewTableBuilder(
      *cfd->ioptions(), cfd->internal_comparator(), compact->outfile.get(),
      compact->compaction->OutputCompressionType(),
      cfd->ioptions()->compression_opts));
2434
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
2435 2436 2437 2438 2439
  return s;
}

Status DBImpl::FinishCompactionOutputFile(CompactionState* compact,
                                          Iterator* input) {
2440
  assert(compact != nullptr);
2441
  assert(compact->outfile);
2442
  assert(compact->builder != nullptr);
J
jorlow@chromium.org 已提交
2443 2444

  const uint64_t output_number = compact->current_output()->number;
2445
  const uint32_t output_path_id = compact->current_output()->path_id;
J
jorlow@chromium.org 已提交
2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
  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;
2459
  compact->builder.reset();
J
jorlow@chromium.org 已提交
2460 2461

  // Finish and check for file errors
2462 2463
  if (s.ok() && !db_options_.disableDataSync) {
    if (db_options_.use_fsync) {
L
Lei Jin 已提交
2464
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2465 2466
      s = compact->outfile->Fsync();
    } else {
L
Lei Jin 已提交
2467
      StopWatch sw(env_, stats_, COMPACTION_OUTFILE_SYNC_MICROS);
2468 2469
      s = compact->outfile->Sync();
    }
J
jorlow@chromium.org 已提交
2470 2471 2472 2473
  }
  if (s.ok()) {
    s = compact->outfile->Close();
  }
2474
  compact->outfile.reset();
J
jorlow@chromium.org 已提交
2475 2476 2477

  if (s.ok() && current_entries > 0) {
    // Verify that the table is usable
I
Igor Canadi 已提交
2478
    ColumnFamilyData* cfd = compact->compaction->column_family_data();
2479
    FileDescriptor fd(output_number, output_path_id, current_bytes);
I
Igor Canadi 已提交
2480
    Iterator* iter = cfd->table_cache()->NewIterator(
L
Lei Jin 已提交
2481
        ReadOptions(), env_options_, cfd->internal_comparator(), fd);
J
jorlow@chromium.org 已提交
2482 2483 2484
    s = iter->status();
    delete iter;
    if (s.ok()) {
2485
      Log(db_options_.info_log, "[%s] Generated table #%" PRIu64 ": %" PRIu64
2486 2487 2488
                             " keys, %" PRIu64 " bytes",
          cfd->GetName().c_str(), output_number, current_entries,
          current_bytes);
J
jorlow@chromium.org 已提交
2489 2490 2491 2492 2493 2494
    }
  }
  return s;
}


2495
Status DBImpl::InstallCompactionResults(CompactionState* compact,
2496
    const MutableCFOptions& mutable_cf_options, LogBuffer* log_buffer) {
J
jorlow@chromium.org 已提交
2497
  mutex_.AssertHeld();
2498 2499 2500 2501 2502

  // 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.
2503
  if (!versions_->VerifyCompactionFileConsistency(compact->compaction)) {
2504
    Log(db_options_.info_log, "[%s] Compaction %d@%d + %d@%d files aborted",
I
Igor Canadi 已提交
2505 2506 2507 2508
        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 已提交
2509
    return Status::Corruption("Compaction input files inconsistent");
2510 2511
  }

I
Igor Canadi 已提交
2512 2513
  LogToBuffer(log_buffer, "[%s] Compacted %d@%d + %d@%d files => %lld bytes",
              compact->compaction->column_family_data()->GetName().c_str(),
2514 2515 2516 2517 2518
              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 已提交
2519 2520 2521

  // Add compaction outputs
  compact->compaction->AddInputDeletions(compact->compaction->edit());
D
dgrogan@chromium.org 已提交
2522
  for (size_t i = 0; i < compact->outputs.size(); i++) {
J
jorlow@chromium.org 已提交
2523
    const CompactionState::Output& out = compact->outputs[i];
2524 2525 2526 2527
    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 已提交
2528
  }
I
Igor Canadi 已提交
2529
  return versions_->LogAndApply(compact->compaction->column_family_data(),
2530
                                mutable_cf_options,
I
Igor Canadi 已提交
2531 2532
                                compact->compaction->edit(), &mutex_,
                                db_directory_.get());
J
jorlow@chromium.org 已提交
2533 2534
}

2535 2536 2537 2538 2539 2540 2541
// 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(
2542 2543
  SequenceNumber in, std::vector<SequenceNumber>& snapshots,
  SequenceNumber* prev_snapshot) {
2544
  SequenceNumber prev __attribute__((unused)) = 0;
2545 2546 2547
  for (const auto cur : snapshots) {
    assert(prev <= cur);
    if (cur >= in) {
2548
      *prev_snapshot = prev;
2549
      return cur;
2550
    }
2551 2552
    prev = cur; // assignment
    assert(prev);
2553
  }
2554
  Log(db_options_.info_log,
2555 2556
      "Looking for seqid %" PRIu64 " but maxseqid is %" PRIu64 "", in,
      snapshots[snapshots.size() - 1]);
2557 2558 2559 2560
  assert(0);
  return 0;
}

I
Igor Canadi 已提交
2561 2562 2563
uint64_t DBImpl::CallFlushDuringCompaction(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
    JobContext* job_context, LogBuffer* log_buffer) {
2564
  if (db_options_.max_background_flushes > 0) {
2565 2566 2567
    // flush thread will take care of this
    return 0;
  }
I
Igor Canadi 已提交
2568
  if (cfd->imm()->imm_flush_needed.load(std::memory_order_relaxed)) {
I
Igor Canadi 已提交
2569 2570 2571 2572
    const uint64_t imm_start = env_->NowMicros();
    mutex_.Lock();
    if (cfd->imm()->IsFlushPending()) {
      cfd->Ref();
I
Igor Canadi 已提交
2573 2574
      FlushMemTableToOutputFile(cfd, mutable_cf_options, nullptr, job_context,
                                log_buffer);
I
Igor Canadi 已提交
2575
      cfd->Unref();
I
Igor Canadi 已提交
2576
      bg_cv_.SignalAll();  // Wakeup DelayWrite() if necessary
I
Igor Canadi 已提交
2577 2578 2579 2580 2581 2582 2583 2584
    }
    mutex_.Unlock();
    log_buffer->FlushBufferToLog();
    return env_->NowMicros() - imm_start;
  }
  return 0;
}

D
Danny Guo 已提交
2585
Status DBImpl::ProcessKeyValueCompaction(
I
Igor Canadi 已提交
2586 2587 2588 2589 2590
    const MutableCFOptions& mutable_cf_options, bool is_snapshot_supported,
    SequenceNumber visible_at_tip, SequenceNumber earliest_snapshot,
    SequenceNumber latest_snapshot, JobContext* job_context,
    bool bottommost_level, int64_t* imm_micros, Iterator* input,
    CompactionState* compact, bool is_compaction_v2, int* num_output_records,
D
Danny Guo 已提交
2591
    LogBuffer* log_buffer) {
2592 2593
  assert(num_output_records != nullptr);

D
Danny Guo 已提交
2594
  size_t combined_idx = 0;
J
jorlow@chromium.org 已提交
2595
  Status status;
D
Danny Guo 已提交
2596
  std::string compaction_filter_value;
J
jorlow@chromium.org 已提交
2597
  ParsedInternalKey ikey;
2598
  IterKey current_user_key;
J
jorlow@chromium.org 已提交
2599
  bool has_current_user_key = false;
2600
  IterKey delete_key;
2601 2602
  SequenceNumber last_sequence_for_key __attribute__((unused)) =
    kMaxSequenceNumber;
2603
  SequenceNumber visible_in_snapshot = kMaxSequenceNumber;
2604
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
I
Igor Canadi 已提交
2605
  MergeHelper merge(
2606
      cfd->user_comparator(), cfd->ioptions()->merge_operator,
L
Lei Jin 已提交
2607
      db_options_.info_log.get(), cfd->ioptions()->min_partial_merge_operands,
2608
      false /* internal key corruption is expected */);
2609
  auto compaction_filter = cfd->ioptions()->compaction_filter;
2610 2611
  std::unique_ptr<CompactionFilter> compaction_filter_from_factory = nullptr;
  if (!compaction_filter) {
2612
    auto context = compact->GetFilterContextV1();
2613
    compaction_filter_from_factory =
2614
        cfd->ioptions()->compaction_filter_factory->CreateCompactionFilter(
I
Igor Canadi 已提交
2615
            context);
2616 2617
    compaction_filter = compaction_filter_from_factory.get();
  }
2618

2619 2620 2621 2622
  int64_t key_drop_user = 0;
  int64_t key_drop_newer_entry = 0;
  int64_t key_drop_obsolete = 0;
  int64_t loop_cnt = 0;
I
Igor Canadi 已提交
2623
  while (input->Valid() && !shutting_down_.load(std::memory_order_acquire) &&
2624
         !cfd->IsDropped() && status.ok()) {
2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641
    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;
    }
2642 2643 2644 2645
    // FLUSH preempts compaction
    // TODO(icanadi) this currently only checks if flush is necessary on
    // compacting column family. we should also check if flush is necessary on
    // other column families, too
I
Igor Canadi 已提交
2646 2647
    (*imm_micros) += CallFlushDuringCompaction(cfd, mutable_cf_options,
                                               job_context, log_buffer);
2648

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

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

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

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

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

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

      last_sequence_for_key = ikey.sequence;
2800
      visible_in_snapshot = visible;
J
jorlow@chromium.org 已提交
2801 2802 2803
    }

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

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

2846 2847
        // Open output file if necessary
        if (compact->builder == nullptr) {
2848
          status = OpenCompactionOutputFile(compact, mutable_cf_options);
2849 2850 2851 2852
          if (!status.ok()) {
            break;
          }
        }
2853 2854

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

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

2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896
        // 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 已提交
2897 2898
          break;
        }
2899 2900
      }  // while (true)
    }  // if (!drop)
J
jorlow@chromium.org 已提交
2901

2902
    // MergeUntil has moved input to the next entry
2903
    if (!current_entry_is_merging) {
2904 2905
      input->Next();
    }
J
jorlow@chromium.org 已提交
2906
  }
2907 2908 2909 2910 2911 2912 2913 2914 2915
  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);
  }
2916 2917
  RecordCompactionIOStats();

D
Danny Guo 已提交
2918 2919 2920 2921 2922 2923 2924 2925 2926
  return status;
}

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

2927
  // Assemble slice vectors for user keys and existing values.
2928
  // We also keep track of our parsed internal key structs because
2929 2930 2931
  // 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 已提交
2932
  std::vector<Slice> user_key_buf;
2933 2934 2935 2936 2937 2938 2939 2940 2941 2942
  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 已提交
2943 2944 2945 2946 2947 2948 2949 2950 2951
  }

  // 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(),
2952
      user_key_buf, existing_value_buf,
D
Danny Guo 已提交
2953 2954 2955 2956 2957 2958
      &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() ==
2959
      compact->key_str_buf_.size());
D
Danny Guo 已提交
2960
  assert(compact->to_delete_buf_.size() ==
2961
      compact->existing_value_str_buf_.size());
D
Danny Guo 已提交
2962 2963 2964 2965 2966 2967 2968 2969 2970
  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],
2971 2972 2973
                        compact->key_str_buf_[i].size(),
                        ikey_buf[i].sequence,
                        kTypeDeletion);
D
Danny Guo 已提交
2974 2975

      // no value associated with delete
2976
      compact->existing_value_str_buf_[i].clear();
L
Lei Jin 已提交
2977
      RecordTick(stats_, COMPACTION_KEY_DROP_USER);
D
Danny Guo 已提交
2978
    } else if (compact->value_changed_buf_[i]) {
2979 2980
      compact->existing_value_str_buf_[i] =
          compact->new_value_buf_[new_value_idx++];
D
Danny Guo 已提交
2981 2982 2983 2984 2985
    }
  }  // for
}

Status DBImpl::DoCompactionWork(CompactionState* compact,
2986
                                const MutableCFOptions& mutable_cf_options,
I
Igor Canadi 已提交
2987
                                JobContext* job_context,
D
Danny Guo 已提交
2988 2989 2990 2991 2992
                                LogBuffer* log_buffer) {
  assert(compact);
  compact->CleanupBatchBuffer();
  compact->CleanupMergedBuffer();

F
Feng Zhu 已提交
2993 2994
  // Generate file_levels_ for compaction berfore making Iterator
  compact->compaction->GenerateFileLevels();
D
Danny Guo 已提交
2995
  int64_t imm_micros = 0;  // Micros spent doing imm_ compactions
2996
  ColumnFamilyData* cfd = compact->compaction->column_family_data();
2997 2998
  LogToBuffer(
      log_buffer,
I
Igor Canadi 已提交
2999 3000
      "[%s] Compacting %d@%d + %d@%d files, score %.2f slots available %d",
      cfd->GetName().c_str(), compact->compaction->num_input_files(0),
3001 3002
      compact->compaction->level(), compact->compaction->num_input_files(1),
      compact->compaction->output_level(), compact->compaction->score(),
3003
      db_options_.max_background_compactions - bg_compaction_scheduled_);
D
Danny Guo 已提交
3004 3005
  char scratch[2345];
  compact->compaction->Summary(scratch, sizeof(scratch));
I
Igor Canadi 已提交
3006 3007
  LogToBuffer(log_buffer, "[%s] Compaction start summary: %s\n",
              cfd->GetName().c_str(), scratch);
D
Danny Guo 已提交
3008

S
sdong 已提交
3009 3010
  assert(cfd->current()->GetStorageInfo()->NumLevelFiles(
             compact->compaction->level()) > 0);
D
Danny Guo 已提交
3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035
  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);

3036
  bool is_snapshot_supported = IsSnapshotSupported();
D
Danny Guo 已提交
3037 3038
  // Release mutex while we're actually doing the compaction work
  mutex_.Unlock();
3039
  log_buffer->FlushBufferToLog();
D
Danny Guo 已提交
3040

3041
  int num_output_records = 0;
D
Danny Guo 已提交
3042 3043 3044 3045 3046 3047 3048 3049 3050 3051
  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 =
3052 3053
      cfd->ioptions()->compaction_filter_factory_v2->
          CreateCompactionFilterV2(context);
D
Danny Guo 已提交
3054 3055 3056
  auto compaction_filter_v2 =
    compaction_filter_from_factory_v2.get();

3057 3058
  if (!compaction_filter_v2) {
    status = ProcessKeyValueCompaction(
I
Igor Canadi 已提交
3059 3060 3061 3062
        mutable_cf_options, is_snapshot_supported, visible_at_tip,
        earliest_snapshot, latest_snapshot, job_context, bottommost_level,
        &imm_micros, input.get(), compact, false, &num_output_records,
        log_buffer);
3063 3064 3065 3066 3067 3068 3069 3070
  } 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.
3071
    bool prefix_initialized = false;
3072 3073 3074
    shared_ptr<Iterator> backup_input(
        versions_->MakeInputIterator(compact->compaction));
    backup_input->SeekToFirst();
I
Igor Canadi 已提交
3075 3076
    while (backup_input->Valid() &&
           !shutting_down_.load(std::memory_order_acquire) &&
3077
           !cfd->IsDropped()) {
I
Igor Canadi 已提交
3078 3079 3080 3081
      // 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
3082
      imm_micros += CallFlushDuringCompaction(cfd, mutable_cf_options,
I
Igor Canadi 已提交
3083
                                              job_context, log_buffer);
I
Igor Canadi 已提交
3084

D
Danny Guo 已提交
3085 3086 3087 3088 3089
      Slice key = backup_input->key();
      Slice value = backup_input->value();

      if (!ParseInternalKey(key, &ikey)) {
        // log error
3090
        Log(db_options_.info_log, "[%s] Failed to parse key: %s",
I
Igor Canadi 已提交
3091
            cfd->GetName().c_str(), key.ToString().c_str());
D
Danny Guo 已提交
3092 3093
        continue;
      } else {
3094
        const SliceTransform* transformer =
3095
            cfd->ioptions()->compaction_filter_factory_v2->GetPrefixExtractor();
3096 3097 3098 3099 3100
        const auto key_prefix = transformer->Transform(ikey.user_key);
        if (!prefix_initialized) {
          compact->cur_prefix_ = key_prefix.ToString();
          prefix_initialized = true;
        }
D
Danny Guo 已提交
3101
        // If the prefix remains the same, keep buffering
3102
        if (key_prefix.compare(Slice(compact->cur_prefix_)) == 0) {
D
Danny Guo 已提交
3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119
          // 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
3120
          if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3121 3122
            CallCompactionFilterV2(compact, compaction_filter_v2);
          }
3123
          compact->cur_prefix_ = key_prefix.ToString();
D
Danny Guo 已提交
3124 3125 3126 3127
        }
      }

      // Merge this batch of data (values + ineligible keys)
3128
      compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3129 3130 3131 3132

      // Done buffering for the current prefix. Spit it out to disk
      // Now just iterate through all the kv-pairs
      status = ProcessKeyValueCompaction(
I
Igor Canadi 已提交
3133 3134 3135
          mutable_cf_options, is_snapshot_supported, visible_at_tip,
          earliest_snapshot, latest_snapshot, job_context, bottommost_level,
          &imm_micros, input.get(), compact, true, &num_output_records,
D
Danny Guo 已提交
3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155
          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.
3156
        if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3157 3158
          CallCompactionFilterV2(compact, compaction_filter_v2);
        }
3159
        compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3160 3161

        status = ProcessKeyValueCompaction(
I
Igor Canadi 已提交
3162 3163 3164
            mutable_cf_options, is_snapshot_supported, visible_at_tip,
            earliest_snapshot, latest_snapshot, job_context, bottommost_level,
            &imm_micros, input.get(), compact, true, &num_output_records,
D
Danny Guo 已提交
3165 3166 3167 3168 3169 3170 3171
            log_buffer);

        compact->CleanupBatchBuffer();
        compact->CleanupMergedBuffer();
      }
    }  // done processing all prefix batches
    // finish the last batch
3172
    if (compact->key_str_buf_.size() > 0) {
D
Danny Guo 已提交
3173 3174
      CallCompactionFilterV2(compact, compaction_filter_v2);
    }
3175
    compact->MergeKeyValueSliceBuffer(&cfd->internal_comparator());
D
Danny Guo 已提交
3176
    status = ProcessKeyValueCompaction(
I
Igor Canadi 已提交
3177 3178 3179
        mutable_cf_options, is_snapshot_supported, visible_at_tip,
        earliest_snapshot, latest_snapshot, job_context, bottommost_level,
        &imm_micros, input.get(), compact, true, &num_output_records,
D
Danny Guo 已提交
3180 3181 3182
        log_buffer);
  }  // checking for compaction filter v2

I
Igor Canadi 已提交
3183 3184
  if (status.ok() &&
      (shutting_down_.load(std::memory_order_acquire) || cfd->IsDropped())) {
L
Lei Jin 已提交
3185
    status = Status::ShutdownInProgress(
3186
        "Database shutdown or Column family drop during compaction");
J
jorlow@chromium.org 已提交
3187
  }
3188
  if (status.ok() && compact->builder != nullptr) {
3189
    status = FinishCompactionOutputFile(compact, input.get());
J
jorlow@chromium.org 已提交
3190 3191 3192 3193
  }
  if (status.ok()) {
    status = input->status();
  }
3194
  input.reset();
J
jorlow@chromium.org 已提交
3195

3196
  if (!db_options_.disableDataSync) {
3197 3198
    db_directory_->Fsync();
  }
I
Igor Canadi 已提交
3199

L
Lei Jin 已提交
3200
  InternalStats::CompactionStats stats(1);
3201
  stats.micros = env_->NowMicros() - start_micros - imm_micros;
M
Mark Callaghan 已提交
3202 3203
  stats.files_in_leveln = compact->compaction->num_input_files(0);
  stats.files_in_levelnp1 = compact->compaction->num_input_files(1);
L
Lei Jin 已提交
3204
  MeasureTime(stats_, COMPACTION_TIME, stats.micros);
3205 3206

  int num_output_files = compact->outputs.size();
3207
  if (compact->builder != nullptr) {
P
Pascal Borreli 已提交
3208
    // An error occurred so ignore the last output.
3209 3210 3211 3212
    assert(num_output_files > 0);
    --num_output_files;
  }
  stats.files_out_levelnp1 = num_output_files;
M
Mark Callaghan 已提交
3213

3214 3215
  uint64_t num_input_records = 0;

3216
  for (int i = 0; i < compact->compaction->num_input_files(0); i++) {
3217
    stats.bytes_readn += compact->compaction->input(0, i)->fd.GetFileSize();
3218 3219
    stats.num_input_records += compact->compaction->input(0, i)->num_entries;
    num_input_records += compact->compaction->input(0, i)->num_entries;
3220
  }
M
Mark Callaghan 已提交
3221

3222
  for (int i = 0; i < compact->compaction->num_input_files(1); i++) {
3223
    stats.bytes_readnp1 += compact->compaction->input(1, i)->fd.GetFileSize();
3224
    num_input_records += compact->compaction->input(1, i)->num_entries;
3225
  }
M
Mark Callaghan 已提交
3226

3227
  for (int i = 0; i < num_output_files; i++) {
3228 3229
    stats.bytes_written += compact->outputs[i].file_size;
  }
3230 3231
  stats.num_dropped_records =
      static_cast<int>(num_input_records) - num_output_records;
3232

3233 3234
  RecordCompactionIOStats();

3235
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
3236
  mutex_.Lock();
3237 3238
  cfd->internal_stats()->AddCompactionStats(
      compact->compaction->output_level(), stats);
J
jorlow@chromium.org 已提交
3239

3240 3241 3242 3243
  // 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 已提交
3244
  if (status.ok()) {
3245
    status = InstallCompactionResults(compact, mutable_cf_options, log_buffer);
I
Igor Canadi 已提交
3246
    InstallSuperVersionBackground(cfd, job_context, mutable_cf_options);
J
jorlow@chromium.org 已提交
3247
  }
S
sdong 已提交
3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267
  VersionStorageInfo::LevelSummaryStorage tmp;
  LogToBuffer(log_buffer,
              "[%s] compacted to: %s, MB/sec: %.1f rd, %.1f wr, level %d, "
              "files in(%d, %d) out(%d) "
              "MB in(%.1f, %.1f) out(%.1f), read-write-amplify(%.1f) "
              "write-amplify(%.1f) %s, records in: %d, records dropped: %d\n",
              cfd->GetName().c_str(),
              cfd->current()->GetStorageInfo()->LevelSummary(&tmp),
              (stats.bytes_readn + stats.bytes_readnp1) /
                  static_cast<double>(stats.micros),
              stats.bytes_written / static_cast<double>(stats.micros),
              compact->compaction->output_level(), stats.files_in_leveln,
              stats.files_in_levelnp1, stats.files_out_levelnp1,
              stats.bytes_readn / 1048576.0, stats.bytes_readnp1 / 1048576.0,
              stats.bytes_written / 1048576.0,
              (stats.bytes_written + stats.bytes_readnp1 + stats.bytes_readn) /
                  (double)stats.bytes_readn,
              stats.bytes_written / (double)stats.bytes_readn,
              status.ToString().c_str(), stats.num_input_records,
              stats.num_dropped_records);
M
Mark Callaghan 已提交
3268

J
jorlow@chromium.org 已提交
3269 3270 3271
  return status;
}

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

  DBImpl* db;
3278
  port::Mutex* mu;
3279
  SuperVersion* super_version;
3280 3281 3282 3283
};

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

3285
  if (state->super_version->Unref()) {
I
Igor Canadi 已提交
3286
    JobContext job_context;
3287

3288 3289
    state->mu->Lock();
    state->super_version->Cleanup();
I
Igor Canadi 已提交
3290
    state->db->FindObsoleteFiles(&job_context, false, true);
3291 3292 3293
    state->mu->Unlock();

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

3299 3300
  delete state;
}
H
Hans Wennborg 已提交
3301
}  // namespace
3302

L
Lei Jin 已提交
3303
Iterator* DBImpl::NewInternalIterator(const ReadOptions& read_options,
3304
                                      ColumnFamilyData* cfd,
3305 3306 3307
                                      SuperVersion* super_version,
                                      Arena* arena) {
  Iterator* internal_iter;
3308 3309 3310 3311 3312
  assert(arena != nullptr);
  // Need to create internal iterator from the arena.
  MergeIteratorBuilder merge_iter_builder(&cfd->internal_comparator(), arena);
  // Collect iterator for mutable mem
  merge_iter_builder.AddIterator(
L
Lei Jin 已提交
3313
      super_version->mem->NewIterator(read_options, arena));
3314
  // Collect all needed child iterators for immutable memtables
L
Lei Jin 已提交
3315
  super_version->imm->AddIterators(read_options, &merge_iter_builder);
3316
  // Collect iterators for files in L0 - Ln
L
Lei Jin 已提交
3317
  super_version->current->AddIterators(read_options, env_options_,
3318 3319
                                       &merge_iter_builder);
  internal_iter = merge_iter_builder.Finish();
3320
  IterState* cleanup = new IterState(this, &mutex_, super_version);
3321
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
3322 3323 3324 3325

  return internal_iter;
}

3326 3327 3328 3329
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
3330
Status DBImpl::Get(const ReadOptions& read_options,
3331
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3332
                   std::string* value) {
L
Lei Jin 已提交
3333
  return GetImpl(read_options, column_family, key, value);
3334 3335
}

I
Igor Canadi 已提交
3336 3337
// JobContext gets created and destructed outside of the lock --
// we
I
Igor Canadi 已提交
3338 3339
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3340
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3341
//
I
Igor Canadi 已提交
3342 3343 3344 3345
// However, if InstallSuperVersion() gets called twice with the same
// job_context, we can't reuse the SuperVersion() that got
// malloced
// because
I
Igor Canadi 已提交
3346 3347 3348
// 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
I
Igor Canadi 已提交
3349 3350
void DBImpl::InstallSuperVersionBackground(
    ColumnFamilyData* cfd, JobContext* job_context,
3351
    const MutableCFOptions& mutable_cf_options) {
3352
  mutex_.AssertHeld();
I
Igor Canadi 已提交
3353 3354 3355 3356
  SuperVersion* old_superversion = InstallSuperVersion(
      cfd, job_context->new_superversion, mutable_cf_options);
  job_context->new_superversion = nullptr;
  job_context->superversions_to_free.push_back(old_superversion);
I
Igor Canadi 已提交
3357 3358
}

L
Lei Jin 已提交
3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384
SuperVersion* DBImpl::InstallSuperVersion(
    ColumnFamilyData* cfd, SuperVersion* new_sv,
    const MutableCFOptions& mutable_cf_options) {
  mutex_.AssertHeld();
  auto* old = cfd->InstallSuperVersion(
      new_sv ? new_sv : new SuperVersion(), &mutex_, mutable_cf_options);

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

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

Status DBImpl::GetImpl(const ReadOptions& read_options,
3385 3386
                       ColumnFamilyHandle* column_family, const Slice& key,
                       std::string* value, bool* value_found) {
L
Lei Jin 已提交
3387
  StopWatch sw(env_, stats_, DB_GET);
3388
  PERF_TIMER_GUARD(get_snapshot_time);
3389

3390 3391 3392
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3393
  SequenceNumber snapshot;
L
Lei Jin 已提交
3394 3395 3396
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3397 3398
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3399
  }
3400

3401
  // Acquire SuperVersion
3402
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
I
Igor Canadi 已提交
3403

3404
  // Prepare to store a list of merge operations if merge occurs.
3405
  MergeContext merge_context;
3406

3407
  Status s;
3408
  // First look in the memtable, then in the immutable memtable (if any).
3409
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3410
  // merge_operands will contain the sequence of merges in the latter case.
3411
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3412
  PERF_TIMER_STOP(get_snapshot_time);
3413

3414
  if (sv->mem->Get(lkey, value, &s, &merge_context)) {
3415
    // Done
L
Lei Jin 已提交
3416
    RecordTick(stats_, MEMTABLE_HIT);
3417
  } else if (sv->imm->Get(lkey, value, &s, &merge_context)) {
3418
    // Done
L
Lei Jin 已提交
3419
    RecordTick(stats_, MEMTABLE_HIT);
3420
  } else {
3421
    PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3422 3423
    sv->current->Get(read_options, lkey, value, &s, &merge_context,
                     value_found);
L
Lei Jin 已提交
3424
    RecordTick(stats_, MEMTABLE_MISS);
3425
  }
3426

3427 3428
  {
    PERF_TIMER_GUARD(get_post_process_time);
3429

3430
    ReturnAndCleanupSuperVersion(cfd, sv);
3431

3432 3433 3434
    RecordTick(stats_, NUMBER_KEYS_READ);
    RecordTick(stats_, BYTES_READ, value->size());
  }
3435
  return s;
J
jorlow@chromium.org 已提交
3436 3437
}

3438
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
3439
    const ReadOptions& read_options,
3440
    const std::vector<ColumnFamilyHandle*>& column_family,
3441
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3442

L
Lei Jin 已提交
3443
  StopWatch sw(env_, stats_, DB_MULTIGET);
3444
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
3445

3446
  SequenceNumber snapshot;
3447

3448
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3449
    ColumnFamilyData* cfd;
3450 3451 3452 3453 3454
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3455 3456 3457 3458 3459 3460
    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});
3461 3462 3463
    }
  }

3464
  mutex_.Lock();
L
Lei Jin 已提交
3465 3466 3467
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3468 3469 3470
  } else {
    snapshot = versions_->LastSequence();
  }
3471
  for (auto mgd_iter : multiget_cf_data) {
3472 3473
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3474
  }
3475
  mutex_.Unlock();
3476

3477 3478
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3479

3480
  // Note: this always resizes the values array
3481 3482 3483
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3484 3485

  // Keep track of bytes that we read for statistics-recording later
3486
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3487
  PERF_TIMER_STOP(get_snapshot_time);
3488 3489 3490 3491

  // 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.
3492
  // merge_operands will contain the sequence of merges in the latter case.
3493
  for (size_t i = 0; i < num_keys; ++i) {
3494
    merge_context.Clear();
3495
    Status& s = stat_list[i];
3496 3497 3498
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3499 3500
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3501 3502 3503
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
3504
    if (super_version->mem->Get(lkey, value, &s, &merge_context)) {
3505
      // Done
3506
    } else if (super_version->imm->Get(lkey, value, &s, &merge_context)) {
3507 3508
      // Done
    } else {
3509
      PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3510 3511
      super_version->current->Get(read_options, lkey, value, &s,
                                  &merge_context);
3512 3513 3514
    }

    if (s.ok()) {
3515
      bytes_read += value->size();
3516 3517 3518 3519
    }
  }

  // Post processing (decrement reference counts and record statistics)
3520
  PERF_TIMER_GUARD(get_post_process_time);
3521 3522
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
3523
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3524 3525 3526 3527 3528 3529
  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);
3530 3531
    }
  }
3532 3533 3534 3535 3536 3537 3538
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3539
  }
3540

L
Lei Jin 已提交
3541 3542 3543
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
L
Lei Jin 已提交
3544
  PERF_TIMER_STOP(get_post_process_time);
3545

3546
  return stat_list;
3547 3548
}

L
Lei Jin 已提交
3549
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
3550
                                  const std::string& column_family_name,
3551
                                  ColumnFamilyHandle** handle) {
I
Igor Canadi 已提交
3552 3553 3554
  *handle = nullptr;
  MutexLock l(&mutex_);

I
Igor Canadi 已提交
3555 3556
  if (versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name) !=
      nullptr) {
I
Igor Canadi 已提交
3557 3558
    return Status::InvalidArgument("Column family already exists");
  }
3559
  VersionEdit edit;
3560
  edit.AddColumnFamily(column_family_name);
3561 3562
  uint32_t new_id = versions_->GetColumnFamilySet()->GetNextColumnFamilyID();
  edit.SetColumnFamily(new_id);
I
Igor Canadi 已提交
3563
  edit.SetLogNumber(logfile_number_);
L
Lei Jin 已提交
3564
  edit.SetComparatorName(cf_options.comparator->Name());
3565

I
Igor Canadi 已提交
3566 3567
  // LogAndApply will both write the creation in MANIFEST and create
  // ColumnFamilyData object
L
Lei Jin 已提交
3568
  Options opt(db_options_, cf_options);
3569 3570
  Status s = versions_->LogAndApply(nullptr,
      MutableCFOptions(opt, ImmutableCFOptions(opt)),
L
Lei Jin 已提交
3571
      &edit, &mutex_, db_directory_.get(), false, &cf_options);
3572
  if (s.ok()) {
3573
    single_column_family_mode_ = false;
3574 3575 3576
    auto cfd =
        versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
    assert(cfd != nullptr);
L
Lei Jin 已提交
3577
    delete InstallSuperVersion(cfd, nullptr, *cfd->GetLatestMutableCFOptions());
3578
    *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
3579
    Log(db_options_.info_log, "Created column family [%s] (ID %u)",
3580 3581
        column_family_name.c_str(), (unsigned)cfd->GetID());
  } else {
3582
    Log(db_options_.info_log, "Creating column family [%s] FAILED -- %s",
3583 3584
        column_family_name.c_str(), s.ToString().c_str());
  }
3585
  return s;
3586 3587
}

3588 3589 3590 3591
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
3592 3593
    return Status::InvalidArgument("Can't drop default column family");
  }
3594

I
Igor Canadi 已提交
3595 3596
  VersionEdit edit;
  edit.DropColumnFamily();
3597 3598
  edit.SetColumnFamily(cfd->GetID());

3599
  Status s;
3600 3601 3602 3603 3604 3605
  {
    MutexLock l(&mutex_);
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
3606
      // we drop column family from a single write thread
I
Igor Canadi 已提交
3607 3608
      WriteThread::Writer w(&mutex_);
      s = write_thread_.EnterWriteThread(&w, 0);
3609
      assert(s.ok() && !w.done);  // No timeout and nobody should do our job
3610 3611
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
I
Igor Canadi 已提交
3612
      write_thread_.ExitWriteThread(&w, &w, s);
3613
    }
3614
  }
3615

3616
  if (s.ok()) {
I
Igor Canadi 已提交
3617
    assert(cfd->IsDropped());
L
Lei Jin 已提交
3618 3619 3620
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ -= mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
3621 3622
    Log(db_options_.info_log, "Dropped column family with id %u\n",
        cfd->GetID());
3623
  } else {
3624 3625
    Log(db_options_.info_log,
        "Dropping column family with id %u FAILED -- %s\n",
3626 3627 3628
        cfd->GetID(), s.ToString().c_str());
  }

3629
  return s;
3630 3631
}

L
Lei Jin 已提交
3632
bool DBImpl::KeyMayExist(const ReadOptions& read_options,
3633 3634
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
3635
  if (value_found != nullptr) {
K
Kai Liu 已提交
3636 3637
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
3638
  }
L
Lei Jin 已提交
3639
  ReadOptions roptions = read_options;
3640
  roptions.read_tier = kBlockCacheTier; // read from block cache only
3641
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
3642

3643
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
3644 3645 3646
  // 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();
3647 3648
}

3649
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
3650 3651 3652
                              ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
3653

3654
  if (read_options.tailing) {
I
Igor Canadi 已提交
3655 3656 3657 3658
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
3659 3660
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
    auto iter = new ForwardIterator(this, read_options, cfd, sv);
3661
    return NewDBIterator(env_, *cfd->ioptions(), cfd->user_comparator(), iter,
3662 3663 3664
        kMaxSequenceNumber,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
        read_options.iterate_upper_bound);
I
Igor Canadi 已提交
3665
#endif
T
Tomislav Novak 已提交
3666
  } else {
3667
    SequenceNumber latest_snapshot = versions_->LastSequence();
3668
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
3669

I
Igor Canadi 已提交
3670
    auto snapshot =
3671 3672 3673
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
3674
            : latest_snapshot;
T
Tomislav Novak 已提交
3675

3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718
    // 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(
3719
        env_, *cfd->ioptions(), cfd->user_comparator(),
3720
        snapshot, sv->mutable_cf_options.max_sequential_skip_in_iterations,
3721
        read_options.iterate_upper_bound);
3722

3723
    Iterator* internal_iter =
3724
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
3725 3726 3727 3728
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
3729 3730
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
3731 3732
}

3733
Status DBImpl::NewIterators(
3734
    const ReadOptions& read_options,
I
Igor Canadi 已提交
3735
    const std::vector<ColumnFamilyHandle*>& column_families,
3736
    std::vector<Iterator*>* iterators) {
I
Igor Canadi 已提交
3737 3738 3739
  iterators->clear();
  iterators->reserve(column_families.size());

3740
  if (read_options.tailing) {
I
Igor Canadi 已提交
3741 3742 3743 3744
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
3745 3746
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
3747 3748
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
      auto iter = new ForwardIterator(this, read_options, cfd, sv);
L
Lei Jin 已提交
3749
      iterators->push_back(
3750
          NewDBIterator(env_, *cfd->ioptions(), cfd->user_comparator(), iter,
3751 3752
              kMaxSequenceNumber,
              sv->mutable_cf_options.max_sequential_skip_in_iterations));
I
Igor Canadi 已提交
3753
    }
I
Igor Canadi 已提交
3754
#endif
I
Igor Canadi 已提交
3755
  } else {
3756 3757
    SequenceNumber latest_snapshot = versions_->LastSequence();

I
Igor Canadi 已提交
3758
    for (size_t i = 0; i < column_families.size(); ++i) {
3759 3760 3761
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
3762 3763

      auto snapshot =
3764 3765 3766
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
3767 3768
              : latest_snapshot;

3769
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
3770
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
3771
          sv->mutable_cf_options.max_sequential_skip_in_iterations);
3772
      Iterator* internal_iter = NewInternalIterator(
3773
          read_options, cfd, sv, db_iter->GetArena());
3774 3775
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
3776 3777 3778 3779
    }
  }

  return Status::OK();
3780 3781
}

3782 3783 3784 3785 3786 3787 3788 3789 3790
bool DBImpl::IsSnapshotSupported() const {
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (!cfd->mem()->IsSnapshotSupported()) {
      return false;
    }
  }
  return true;
}

J
jorlow@chromium.org 已提交
3791
const Snapshot* DBImpl::GetSnapshot() {
3792
  MutexLock l(&mutex_);
3793 3794
  // returns null if the underlying memtable does not support snapshot.
  if (!IsSnapshotSupported()) return nullptr;
3795
  return snapshots_.New(versions_->LastSequence());
J
jorlow@chromium.org 已提交
3796 3797 3798 3799
}

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

// Convenience methods
3804 3805
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
3806
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
3807 3808
}

3809 3810 3811
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
3812
  if (!cfh->cfd()->ioptions()->merge_operator) {
3813 3814
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
3815
    return DB::Merge(o, column_family, key, val);
3816 3817 3818
  }
}

L
Lei Jin 已提交
3819
Status DBImpl::Delete(const WriteOptions& write_options,
3820
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
3821
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
3822 3823
}

L
Lei Jin 已提交
3824
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
S
Stanislau Hlebik 已提交
3825 3826 3827
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
3828
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
I
Igor Canadi 已提交
3829
  WriteThread::Writer w(&mutex_);
S
Stanislau Hlebik 已提交
3830
  w.batch = my_batch;
L
Lei Jin 已提交
3831 3832
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
S
Stanislau Hlebik 已提交
3833 3834
  w.in_batch_group = false;
  w.done = false;
L
Lei Jin 已提交
3835
  w.timeout_hint_us = write_options.timeout_hint_us;
S
Stanislau Hlebik 已提交
3836 3837

  uint64_t expiration_time = 0;
I
Igor Canadi 已提交
3838
  bool has_timeout = false;
S
Stanislau Hlebik 已提交
3839
  if (w.timeout_hint_us == 0) {
I
Igor Canadi 已提交
3840
    w.timeout_hint_us = WriteThread::kNoTimeOut;
S
Stanislau Hlebik 已提交
3841 3842
  } else {
    expiration_time = env_->NowMicros() + w.timeout_hint_us;
I
Igor Canadi 已提交
3843
    has_timeout = true;
S
Stanislau Hlebik 已提交
3844 3845
  }

L
Lei Jin 已提交
3846
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
3847 3848 3849 3850 3851 3852
    RecordTick(stats_, WRITE_WITH_WAL);
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_WITH_WAL, 1);
  }

  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
3853
  Status status = write_thread_.EnterWriteThread(&w, expiration_time);
S
Stanislau Hlebik 已提交
3854 3855
  assert(status.ok() || status.IsTimedOut());
  if (status.IsTimedOut()) {
3856
    mutex_.Unlock();
L
Lei Jin 已提交
3857
    RecordTick(stats_, WRITE_TIMEDOUT);
3858
    return Status::TimedOut();
3859
  }
S
Stanislau Hlebik 已提交
3860 3861 3862 3863 3864 3865 3866 3867 3868 3869
  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);
3870

3871 3872 3873 3874
  // 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.
3875 3876 3877
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

3878
  uint64_t max_total_wal_size = (db_options_.max_total_wal_size == 0)
3879
                                    ? 4 * max_total_in_memory_state_
3880
                                    : db_options_.max_total_wal_size;
3881
  if (UNLIKELY(!single_column_family_mode_) &&
3882
      alive_log_files_.begin()->getting_flushed == false &&
I
Igor Canadi 已提交
3883
      total_log_size_ > max_total_wal_size) {
I
Igor Canadi 已提交
3884
    uint64_t flush_column_family_if_log_file = alive_log_files_.begin()->number;
I
Igor Canadi 已提交
3885
    alive_log_files_.begin()->getting_flushed = true;
3886
    Log(db_options_.info_log,
3887 3888 3889
        "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 已提交
3890 3891
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
3892
    for (auto cfd : *versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
3893
      if (cfd->GetLogNumber() <= flush_column_family_if_log_file) {
S
Stanislau Hlebik 已提交
3894
        status = SetNewMemtableAndNewLogFile(cfd, &context);
I
Igor Canadi 已提交
3895 3896 3897
        if (!status.ok()) {
          break;
        }
S
Stanislau Hlebik 已提交
3898
        cfd->imm()->FlushRequested();
3899
      }
3900
    }
I
Igor Canadi 已提交
3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913
    MaybeScheduleFlushOrCompaction();
  }

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

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

  if (UNLIKELY(status.ok()) &&
      (write_controller_.IsStopped() || write_controller_.GetDelay() > 0)) {
I
Igor Canadi 已提交
3914
    status = DelayWrite(expiration_time);
I
Igor Canadi 已提交
3915 3916 3917 3918 3919
  }

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

D
dgrogan@chromium.org 已提交
3922
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
3923
  WriteThread::Writer* last_writer = &w;
S
Stanislau Hlebik 已提交
3924
  if (status.ok()) {
3925
    autovector<WriteBatch*> write_batch_group;
I
Igor Canadi 已提交
3926
    write_thread_.BuildBatchGroup(&last_writer, &write_batch_group);
3927

3928 3929 3930
    // 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
3931
    // into memtables
3932
    {
3933
      mutex_.Unlock();
3934 3935 3936 3937 3938 3939 3940 3941 3942 3943
      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]);
        }
      }

3944 3945 3946 3947
      const SequenceNumber current_sequence = last_sequence + 1;
      WriteBatchInternal::SetSequence(updates, current_sequence);
      int my_batch_count = WriteBatchInternal::Count(updates);
      last_sequence += my_batch_count;
3948
      const uint64_t batch_size = WriteBatchInternal::ByteSize(updates);
3949
      // Record statistics
L
Lei Jin 已提交
3950
      RecordTick(stats_, NUMBER_KEYS_WRITTEN, my_batch_count);
S
sdong 已提交
3951
      RecordTick(stats_, BYTES_WRITTEN, batch_size);
L
Lei Jin 已提交
3952
      if (write_options.disableWAL) {
3953
        flush_on_destroy_ = true;
3954
      }
L
Lei Jin 已提交
3955
      PERF_TIMER_STOP(write_pre_and_post_process_time);
3956

3957
      uint64_t log_size = 0;
L
Lei Jin 已提交
3958
      if (!write_options.disableWAL) {
3959
        PERF_TIMER_GUARD(write_wal_time);
3960 3961
        Slice log_entry = WriteBatchInternal::Contents(updates);
        status = log_->AddRecord(log_entry);
I
Igor Canadi 已提交
3962 3963
        total_log_size_ += log_entry.size();
        alive_log_files_.back().AddSize(log_entry.size());
3964
        log_empty_ = false;
3965
        log_size = log_entry.size();
L
Lei Jin 已提交
3966
        RecordTick(stats_, WAL_FILE_BYTES, log_size);
L
Lei Jin 已提交
3967
        if (status.ok() && write_options.sync) {
I
Igor Canadi 已提交
3968
          RecordTick(stats_, WAL_FILE_SYNCED);
3969
          StopWatch sw(env_, stats_, WAL_FILE_SYNC_MICROS);
3970
          if (db_options_.use_fsync) {
3971
            status = log_->file()->Fsync();
3972
          } else {
3973
            status = log_->file()->Sync();
3974
          }
H
heyongqiang 已提交
3975
        }
3976 3977
      }
      if (status.ok()) {
3978
        PERF_TIMER_GUARD(write_memtable_time);
Y
Yueh-Hsuan Chiang 已提交
3979

3980
        status = WriteBatchInternal::InsertInto(
I
Igor Canadi 已提交
3981
            updates, column_family_memtables_.get(),
L
Lei Jin 已提交
3982
            write_options.ignore_missing_column_families, 0, this, false);
Y
Yueh-Hsuan Chiang 已提交
3983 3984 3985 3986 3987 3988 3989 3990
        // 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 已提交
3991
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
3992
      }
L
Lei Jin 已提交
3993
      PERF_TIMER_START(write_pre_and_post_process_time);
3994 3995 3996
      if (updates == &tmp_batch_) {
        tmp_batch_.Clear();
      }
3997
      mutex_.Lock();
3998 3999 4000
      // internal stats
      default_cf_internal_stats_->AddDBStats(
          InternalStats::BYTES_WRITTEN, batch_size);
S
sdong 已提交
4001 4002
      default_cf_internal_stats_->AddDBStats(InternalStats::NUMBER_KEYS_WRITTEN,
                                             my_batch_count);
L
Lei Jin 已提交
4003
      if (!write_options.disableWAL) {
4004 4005 4006 4007 4008
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_SYNCED, 1);
        default_cf_internal_stats_->AddDBStats(
            InternalStats::WAL_FILE_BYTES, log_size);
      }
4009
      if (status.ok()) {
4010
        versions_->SetLastSequence(last_sequence);
4011
      }
J
jorlow@chromium.org 已提交
4012 4013
    }
  }
4014
  if (db_options_.paranoid_checks && !status.ok() &&
4015
      !status.IsTimedOut() && bg_error_.ok()) {
I
Igor Canadi 已提交
4016 4017
    bg_error_ = status; // stop compaction & fail any further writes
  }
4018

I
Igor Canadi 已提交
4019
  write_thread_.ExitWriteThread(&w, last_writer, status);
I
Igor Canadi 已提交
4020
  mutex_.Unlock();
4021

4022
  if (status.IsTimedOut()) {
L
Lei Jin 已提交
4023
    RecordTick(stats_, WRITE_TIMEDOUT);
4024 4025
  }

J
jorlow@chromium.org 已提交
4026 4027 4028
  return status;
}

4029 4030
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
4031
Status DBImpl::DelayWrite(uint64_t expiration_time) {
4032 4033 4034 4035 4036 4037 4038 4039 4040
  StopWatch sw(env_, stats_, WRITE_STALL);
  bool has_timeout = (expiration_time > 0);
  auto delay = write_controller_.GetDelay();
  if (write_controller_.IsStopped() == false && delay > 0) {
    mutex_.Unlock();
    env_->SleepForMicroseconds(delay);
    mutex_.Lock();
  }

I
Igor Canadi 已提交
4041
  while (bg_error_.ok() && write_controller_.IsStopped()) {
4042 4043 4044
    if (has_timeout) {
      bg_cv_.TimedWait(expiration_time);
      if (env_->NowMicros() > expiration_time) {
I
Igor Canadi 已提交
4045
        return Status::TimedOut();
4046 4047 4048 4049 4050
      }
    } else {
      bg_cv_.Wait();
    }
  }
I
Igor Canadi 已提交
4051 4052

  return bg_error_;
4053 4054
}

I
Igor Canadi 已提交
4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065
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 已提交
4066 4067
    }
  }
I
Igor Canadi 已提交
4068 4069 4070 4071
  if (schedule_bg_work) {
    MaybeScheduleFlushOrCompaction();
  }
  return Status::OK();
S
Stanislau Hlebik 已提交
4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089
}

// 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;
4090
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
S
Stanislau Hlebik 已提交
4091 4092 4093 4094
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
4095 4096 4097
      s = env_->NewWritableFile(
          LogFileName(db_options_.wal_dir, new_log_number),
          &lfile, env_->OptimizeForLogWrite(env_options_));
S
Stanislau Hlebik 已提交
4098 4099 4100
      if (s.ok()) {
        // Our final size should be less than write_buffer_size
        // (compression, etc) but err on the side of caution.
L
Lei Jin 已提交
4101 4102
        lfile->SetPreallocationBlockSize(
            1.1 * mutable_cf_options.write_buffer_size);
S
Stanislau Hlebik 已提交
4103
        new_log = new log::Writer(std::move(lfile));
I
Igor Canadi 已提交
4104
      }
S
Stanislau Hlebik 已提交
4105 4106 4107
    }

    if (s.ok()) {
L
Lei Jin 已提交
4108 4109
      new_mem = new MemTable(cfd->internal_comparator(), *cfd->ioptions(),
                             mutable_cf_options);
S
Stanislau Hlebik 已提交
4110 4111 4112
      new_superversion = new SuperVersion();
    }
  }
I
Igor Canadi 已提交
4113 4114 4115
  Log(db_options_.info_log,
      "[%s] New memtable created with log file: #%" PRIu64 "\n",
      cfd->GetName().c_str(), new_log_number);
S
Stanislau Hlebik 已提交
4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140
  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_);
4141
      }
4142 4143
    }
  }
S
Stanislau Hlebik 已提交
4144 4145 4146 4147 4148
  cfd->mem()->SetNextLogNumber(logfile_number_);
  cfd->imm()->Add(cfd->mem());
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
  context->superversions_to_free_.push_back(
L
Lei Jin 已提交
4149
      InstallSuperVersion(cfd, new_superversion, mutable_cf_options));
4150 4151 4152
  return s;
}

I
Igor Canadi 已提交
4153
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
4154 4155 4156 4157 4158
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4159 4160
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
4161
  auto version = cfd->current();
4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
I
Igor Canadi 已提交
4174
#endif  // ROCKSDB_LITE
4175

I
Igor Canadi 已提交
4176 4177 4178 4179
const std::string& DBImpl::GetName() const {
  return dbname_;
}

4180 4181 4182 4183
Env* DBImpl::GetEnv() const {
  return env_;
}

4184 4185
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
4186
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
4187 4188
}

4189
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
4190
                         const Slice& property, std::string* value) {
4191 4192
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4193 4194 4195
  DBPropertyType property_type =
      GetPropertyType(property, &is_int_property, &need_out_of_mutex);

4196
  value->clear();
4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211
  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 已提交
4212 4213
}

4214 4215
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
4216 4217
  bool is_int_property = false;
  bool need_out_of_mutex = false;
4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229
  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) {
4230 4231
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
4232 4233 4234

  if (!need_out_of_mutex) {
    MutexLock l(&mutex_);
4235
    return cfd->internal_stats()->GetIntProperty(property_type, value, this);
4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249
  } 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 已提交
4250
  return cfd->GetThreadLocalSuperVersion(&mutex_);
4251 4252 4253 4254
}

void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
4255
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268

  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);
  }
4269 4270
}

4271
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
4272
                                 const Range* range, int n, uint64_t* sizes) {
J
jorlow@chromium.org 已提交
4273 4274
  // TODO(opt): better implementation
  Version* v;
4275 4276
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
J
jorlow@chromium.org 已提交
4277 4278
  {
    MutexLock l(&mutex_);
4279
    v = cfd->current();
4280
    v->Ref();
J
jorlow@chromium.org 已提交
4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297
  }

  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 已提交
4298 4299 4300 4301 4302
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
4303
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319
  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;
  }
4320
  iter->reset(new TransactionLogIteratorImpl(db_options_.wal_dir, &db_options_,
L
Lei Jin 已提交
4321
                                             read_options, env_options_,
I
Igor Canadi 已提交
4322 4323 4324 4325
                                             seq, std::move(wal_files), this));
  return (*iter)->status();
}

4326 4327 4328
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
4329 4330 4331
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
4332
    Log(db_options_.info_log, "DeleteFile %s failed.\n", name.c_str());
4333 4334 4335
    return Status::InvalidArgument("Invalid file name");
  }

4336 4337 4338 4339
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
4340
      Log(db_options_.info_log, "DeleteFile %s failed - not archived log.\n",
4341
          name.c_str());
4342 4343
      return Status::NotSupported("Delete only supported for archived logs");
    }
4344
    status = env_->DeleteFile(db_options_.wal_dir + "/" + name.c_str());
4345
    if (!status.ok()) {
4346
      Log(db_options_.info_log, "DeleteFile %s failed -- %s.\n",
4347
          name.c_str(), status.ToString().c_str());
4348 4349 4350 4351
    }
    return status;
  }

4352
  int level;
I
Igor Canadi 已提交
4353
  FileMetaData* metadata;
4354
  ColumnFamilyData* cfd;
4355
  VersionEdit edit;
I
Igor Canadi 已提交
4356
  JobContext job_context(true);
D
Dhruba Borthakur 已提交
4357 4358
  {
    MutexLock l(&mutex_);
4359
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
4360
    if (!status.ok()) {
4361
      Log(db_options_.info_log, "DeleteFile %s failed. File not found\n",
4362
                             name.c_str());
D
Dhruba Borthakur 已提交
4363 4364
      return Status::InvalidArgument("File not found");
    }
4365
    assert(level < cfd->NumberLevels());
4366

D
Dhruba Borthakur 已提交
4367
    // If the file is being compacted no need to delete.
4368
    if (metadata->being_compacted) {
4369
      Log(db_options_.info_log,
4370
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
D
Dhruba Borthakur 已提交
4371
      return Status::OK();
4372 4373
    }

D
Dhruba Borthakur 已提交
4374 4375 4376
    // 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.
S
sdong 已提交
4377
    auto* vstoreage = cfd->current()->GetStorageInfo();
I
Igor Canadi 已提交
4378
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
S
sdong 已提交
4379
      if (vstoreage->NumLevelFiles(i) != 0) {
4380
        Log(db_options_.info_log,
4381
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
D
Dhruba Borthakur 已提交
4382 4383 4384
        return Status::InvalidArgument("File not in last level");
      }
    }
4385
    // if level == 0, it has to be the oldest file
S
sdong 已提交
4386
    if (level == 0 && vstoreage->files_[0].back()->fd.GetNumber() != number) {
4387 4388 4389
      return Status::InvalidArgument("File in level 0, but not oldest");
    }
    edit.SetColumnFamily(cfd->GetID());
D
Dhruba Borthakur 已提交
4390
    edit.DeleteFile(level, number);
4391 4392
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                    &edit, &mutex_, db_directory_.get());
I
Igor Canadi 已提交
4393
    if (status.ok()) {
I
Igor Canadi 已提交
4394 4395
      InstallSuperVersionBackground(cfd, &job_context,
                                    *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
4396
    }
I
Igor Canadi 已提交
4397 4398
    FindObsoleteFiles(&job_context, false);
  }  // lock released here
4399
  LogFlush(db_options_.info_log);
I
Igor Canadi 已提交
4400
  // remove files outside the db-lock
I
Igor Canadi 已提交
4401 4402
  if (job_context.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(job_context);
4403
  }
4404 4405 4406 4407 4408 4409
  {
    MutexLock l(&mutex_);
    // schedule flush if file deletion means we freed the space for flushes to
    // continue
    MaybeScheduleFlushOrCompaction();
  }
4410 4411 4412
  return status;
}

4413
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
4414
  MutexLock l(&mutex_);
4415
  versions_->GetLiveFilesMetaData(metadata);
4416
}
I
Igor Canadi 已提交
4417
#endif  // ROCKSDB_LITE
4418

I
Igor Canadi 已提交
4419 4420 4421 4422 4423 4424 4425
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
4428 4429 4430 4431 4432 4433
    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) {
4434
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446
                             ". 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);
  }
}

4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473
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 已提交
4474 4475
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
4476
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
4477
               const Slice& key, const Slice& value) {
4478 4479 4480 4481
  // 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);
4482
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
4483 4484 4485
  return Write(opt, &batch);
}

4486 4487
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
4488
  WriteBatch batch;
4489
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
4490 4491 4492
  return Write(opt, &batch);
}

4493 4494
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
4495
  WriteBatch batch;
4496
  batch.Merge(column_family, key, value);
4497 4498 4499
  return Write(opt, &batch);
}

4500
// Default implementation -- returns not supported status
L
Lei Jin 已提交
4501
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
4502
                              const std::string& column_family_name,
4503
                              ColumnFamilyHandle** handle) {
4504
  return Status::NotSupported("");
4505
}
4506
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
4507
  return Status::NotSupported("");
4508 4509
}

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

J
Jim Paton 已提交
4512
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
4513 4514 4515 4516
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
4517
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
4518
  std::vector<ColumnFamilyHandle*> handles;
4519
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
4520 4521 4522 4523 4524 4525 4526
  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;
4527 4528
}

4529 4530
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
4531
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
4532
  Status s = SanitizeOptionsByTable(db_options, column_families);
4533 4534 4535
  if (!s.ok()) {
    return s;
  }
4536
  if (db_options.db_paths.size() > 1) {
4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548
    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. ");
    }
4549 4550
  }

4551
  *dbptr = nullptr;
4552
  handles->clear();
J
jorlow@chromium.org 已提交
4553

I
Igor Canadi 已提交
4554 4555 4556 4557
  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);
4558
  }
4559

I
Igor Canadi 已提交
4560
  DBImpl* impl = new DBImpl(db_options, dbname);
4561
  s = impl->env_->CreateDirIfMissing(impl->db_options_.wal_dir);
4562
  if (s.ok()) {
4563
    for (auto db_path : impl->db_options_.db_paths) {
4564
      s = impl->env_->CreateDirIfMissing(db_path.path);
4565 4566 4567 4568 4569 4570
      if (!s.ok()) {
        break;
      }
    }
  }

4571 4572 4573 4574 4575 4576
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
4577 4578 4579 4580
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
4581
  impl->mutex_.Lock();
4582 4583
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
4584
  if (s.ok()) {
4585
    uint64_t new_log_number = impl->versions_->NewFileNumber();
4586
    unique_ptr<WritableFile> lfile;
4587
    EnvOptions soptions(db_options);
4588 4589 4590
    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 已提交
4591
    if (s.ok()) {
4592
      lfile->SetPreallocationBlockSize(1.1 * max_write_buffer_size);
4593
      impl->logfile_number_ = new_log_number;
4594
      impl->log_.reset(new log::Writer(std::move(lfile)));
I
Igor Canadi 已提交
4595

4596 4597
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
4598 4599
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618
        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 已提交
4619
        }
4620
      }
I
Igor Canadi 已提交
4621 4622
    }
    if (s.ok()) {
4623
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
4624 4625
        delete impl->InstallSuperVersion(
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
4626
      }
I
Igor Canadi 已提交
4627 4628
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
4629
      impl->DeleteObsoleteFiles();
4630
      impl->MaybeScheduleFlushOrCompaction();
4631
      s = impl->db_directory_->Fsync();
J
jorlow@chromium.org 已提交
4632 4633
    }
  }
4634

I
Igor Canadi 已提交
4635 4636
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
4637 4638
      if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
          cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
S
sdong 已提交
4639 4640 4641
        auto* vstorage = cfd->current()->GetStorageInfo();
        for (int i = 1; i < vstorage->NumberLevels(); ++i) {
          int num_files = vstorage->NumLevelFiles(i);
I
Igor Canadi 已提交
4642
          if (num_files > 0) {
I
Igor Canadi 已提交
4643 4644 4645
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
                "open with universal or FIFO compaction style.");
I
Igor Canadi 已提交
4646 4647 4648 4649
            break;
          }
        }
      }
4650
      if (cfd->ioptions()->merge_operator != nullptr &&
4651 4652 4653 4654 4655
          !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 已提交
4656
      if (!s.ok()) {
4657 4658 4659 4660 4661
        break;
      }
    }
  }

4662 4663
  impl->mutex_.Unlock();

J
jorlow@chromium.org 已提交
4664
  if (s.ok()) {
4665
    impl->opened_successfully_ = true;
J
jorlow@chromium.org 已提交
4666 4667
    *dbptr = impl;
  } else {
4668 4669 4670
    for (auto h : *handles) {
      delete h;
    }
4671
    handles->clear();
J
jorlow@chromium.org 已提交
4672 4673 4674 4675 4676
    delete impl;
  }
  return s;
}

4677 4678 4679
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
4680
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
4681 4682
}

4683 4684 4685
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
4686
Status DestroyDB(const std::string& dbname, const Options& options) {
4687
  const InternalKeyComparator comparator(options.comparator);
4688
  const Options& soptions(SanitizeOptions(dbname, &comparator, options));
4689
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
4690
  std::vector<std::string> filenames;
4691 4692
  std::vector<std::string> archiveFiles;

4693
  std::string archivedir = ArchivalDirectory(dbname);
J
jorlow@chromium.org 已提交
4694 4695
  // Ignore error in case directory does not exist
  env->GetChildren(dbname, &filenames);
4696 4697 4698 4699 4700 4701 4702

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

J
jorlow@chromium.org 已提交
4704 4705 4706 4707 4708
  if (filenames.empty()) {
    return Status::OK();
  }

  FileLock* lock;
4709 4710
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
4711 4712 4713
  if (result.ok()) {
    uint64_t number;
    FileType type;
4714
    InfoLogPrefix info_log_prefix(!options.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
4715
    for (size_t i = 0; i < filenames.size(); i++) {
4716
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
4717
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
4718 4719 4720
        Status del;
        if (type == kMetaDatabase) {
          del = DestroyDB(dbname + "/" + filenames[i], options);
4721 4722
        } else if (type == kLogFile) {
          del = env->DeleteFile(soptions.wal_dir + "/" + filenames[i]);
K
Kosie van der Merwe 已提交
4723 4724 4725
        } else {
          del = env->DeleteFile(dbname + "/" + filenames[i]);
        }
J
jorlow@chromium.org 已提交
4726 4727 4728 4729 4730
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4731

4732 4733
    for (auto& db_path : options.db_paths) {
      env->GetChildren(db_path.path, &filenames);
4734 4735 4736 4737 4738
      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
4739
          Status del = env->DeleteFile(db_path.path + "/" + filenames[i]);
4740 4741 4742 4743 4744 4745 4746
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

4747
    env->GetChildren(archivedir, &archiveFiles);
4748 4749
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
4750 4751
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
4752
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
4753 4754 4755 4756 4757
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
4758
    // ignore case where no archival directory is present.
4759
    env->DeleteDir(archivedir);
4760

J
jorlow@chromium.org 已提交
4761
    env->UnlockFile(lock);  // Ignore error since state is already gone
4762
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
4763
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
4764
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
4765 4766 4767 4768
  }
  return result;
}

4769 4770
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
4771
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
4772
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
4773 4774 4775 4776
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
  Log(log, "RocksDB version: %d.%d.%d\n", ROCKSDB_MAJOR, ROCKSDB_MINOR,
      ROCKSDB_PATCH);
4777
  Log(log, "Git sha %s", rocksdb_build_git_sha);
4778
  Log(log, "Compile time %s %s",
4779
      rocksdb_build_compile_time, rocksdb_build_compile_date);
I
Igor Canadi 已提交
4780
#endif
4781 4782
}

4783
}  // namespace rocksdb