db_impl.cc 213.3 KB
Newer Older
1
//  Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.
2 3 4 5
//  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
// 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 已提交
11
#ifndef __STDC_FORMAT_MACROS
I
Igor Canadi 已提交
12
#define __STDC_FORMAT_MACROS
L
liuhuahang 已提交
13
#endif
I
Igor Canadi 已提交
14
#include <inttypes.h>
15
#include <stdint.h>
D
David Bernard 已提交
16
#ifdef OS_SOLARIS
D
David Bernard 已提交
17
#include <alloca.h>
D
David Bernard 已提交
18
#endif
19 20 21
#ifdef ROCKSDB_JEMALLOC
#include "jemalloc/jemalloc.h"
#endif
22

J
jorlow@chromium.org 已提交
23
#include <algorithm>
24 25
#include <climits>
#include <cstdio>
26
#include <map>
J
jorlow@chromium.org 已提交
27
#include <set>
28
#include <stdexcept>
29
#include <string>
30
#include <unordered_map>
31
#include <unordered_set>
T
Tomislav Novak 已提交
32
#include <utility>
33
#include <vector>
34

35
#include "db/auto_roll_logger.h"
J
jorlow@chromium.org 已提交
36
#include "db/builder.h"
I
Igor Canadi 已提交
37
#include "db/compaction_job.h"
38
#include "db/db_info_dumper.h"
39
#include "db/db_iter.h"
K
kailiu 已提交
40
#include "db/dbformat.h"
41
#include "db/event_helpers.h"
J
jorlow@chromium.org 已提交
42
#include "db/filename.h"
43 44
#include "db/flush_job.h"
#include "db/forward_iterator.h"
I
Igor Canadi 已提交
45
#include "db/job_context.h"
J
jorlow@chromium.org 已提交
46 47
#include "db/log_reader.h"
#include "db/log_writer.h"
V
Venkatesh Radhakrishnan 已提交
48
#include "db/managed_iterator.h"
J
jorlow@chromium.org 已提交
49
#include "db/memtable.h"
K
kailiu 已提交
50
#include "db/memtable_list.h"
51
#include "db/merge_context.h"
52
#include "db/merge_helper.h"
J
jorlow@chromium.org 已提交
53
#include "db/table_cache.h"
K
kailiu 已提交
54
#include "db/table_properties_collector.h"
55
#include "db/transaction_log_impl.h"
J
jorlow@chromium.org 已提交
56 57
#include "db/version_set.h"
#include "db/write_batch_internal.h"
A
agiardullo 已提交
58
#include "db/write_callback.h"
59
#include "db/xfunc_test_points.h"
60 61
#include "memtable/hash_linklist_rep.h"
#include "memtable/hash_skiplist_rep.h"
62
#include "port/likely.h"
63
#include "port/port.h"
I
Igor Canadi 已提交
64
#include "rocksdb/cache.h"
65 66 67 68 69 70
#include "rocksdb/compaction_filter.h"
#include "rocksdb/db.h"
#include "rocksdb/env.h"
#include "rocksdb/merge_operator.h"
#include "rocksdb/statistics.h"
#include "rocksdb/status.h"
S
Siying Dong 已提交
71
#include "rocksdb/table.h"
72
#include "rocksdb/version.h"
73
#include "rocksdb/wal_filter.h"
74
#include "rocksdb/write_buffer_manager.h"
J
jorlow@chromium.org 已提交
75
#include "table/block.h"
76
#include "table/block_based_table_factory.h"
J
jorlow@chromium.org 已提交
77
#include "table/merger.h"
K
kailiu 已提交
78
#include "table/table_builder.h"
J
jorlow@chromium.org 已提交
79
#include "table/two_level_iterator.h"
K
kailiu 已提交
80
#include "util/autovector.h"
81
#include "util/build_version.h"
J
jorlow@chromium.org 已提交
82
#include "util/coding.h"
I
Igor Canadi 已提交
83
#include "util/compression.h"
84
#include "util/crc32c.h"
85
#include "util/file_reader_writer.h"
86
#include "util/file_util.h"
87
#include "util/iostats_context_imp.h"
H
Haobo Xu 已提交
88
#include "util/log_buffer.h"
89
#include "util/logging.h"
J
jorlow@chromium.org 已提交
90
#include "util/mutexlock.h"
91 92
#include "util/options_helper.h"
#include "util/options_parser.h"
93
#include "util/perf_context_imp.h"
94
#include "util/sst_file_manager_impl.h"
95
#include "util/stop_watch.h"
96
#include "util/string_util.h"
97
#include "util/sync_point.h"
98 99
#include "util/thread_status_updater.h"
#include "util/thread_status_util.h"
V
Venkatesh Radhakrishnan 已提交
100
#include "util/xfunc.h"
J
jorlow@chromium.org 已提交
101

102
namespace rocksdb {
J
jorlow@chromium.org 已提交
103

104
const std::string kDefaultColumnFamilyName("default");
105

I
Igor Canadi 已提交
106
void DumpRocksDBBuildVersion(Logger * log);
107

S
Stanislau Hlebik 已提交
108 109
struct DBImpl::WriteContext {
  autovector<SuperVersion*> superversions_to_free_;
110
  autovector<MemTable*> memtables_to_free_;
S
Stanislau Hlebik 已提交
111 112 113 114 115

  ~WriteContext() {
    for (auto& sv : superversions_to_free_) {
      delete sv;
    }
116 117 118
    for (auto& m : memtables_to_free_) {
      delete m;
    }
S
Stanislau Hlebik 已提交
119 120 121
  }
};

J
jorlow@chromium.org 已提交
122 123 124
Options SanitizeOptions(const std::string& dbname,
                        const InternalKeyComparator* icmp,
                        const Options& src) {
125
  auto db_options = SanitizeOptions(dbname, DBOptions(src));
126
  auto cf_options = SanitizeOptions(db_options, icmp, ColumnFamilyOptions(src));
127 128 129 130 131
  return Options(db_options, cf_options);
}

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

133 134
  // result.max_open_files means an "infinite" open files.
  if (result.max_open_files != -1) {
I
Igor Canadi 已提交
135 136 137 138 139
    int max_max_open_files = port::GetMaxOpenFiles();
    if (max_max_open_files == -1) {
      max_max_open_files = 1000000;
    }
    ClipToRange(&result.max_open_files, 20, max_max_open_files);
140
  }
141

142
  if (result.info_log == nullptr) {
143
    Status s = CreateLoggerFromOptions(dbname, result, &result.info_log);
J
jorlow@chromium.org 已提交
144 145
    if (!s.ok()) {
      // No place suitable for logging
146
      result.info_log = nullptr;
J
jorlow@chromium.org 已提交
147 148
    }
  }
149 150 151 152
  if (!result.write_buffer_manager) {
    result.write_buffer_manager.reset(
        new WriteBufferManager(result.db_write_buffer_size));
  }
153 154 155 156 157 158
  if (result.base_background_compactions == -1) {
    result.base_background_compactions = result.max_background_compactions;
  }
  if (result.base_background_compactions > result.max_background_compactions) {
    result.base_background_compactions = result.max_background_compactions;
  }
159 160 161 162
  result.env->IncBackgroundThreadsIfNeeded(src.max_background_compactions,
                                           Env::Priority::LOW);
  result.env->IncBackgroundThreadsIfNeeded(src.max_background_flushes,
                                           Env::Priority::HIGH);
163

I
Igor Canadi 已提交
164
  if (result.rate_limiter.get() != nullptr) {
165 166 167 168 169
    if (result.bytes_per_sync == 0) {
      result.bytes_per_sync = 1024 * 1024;
    }
  }

170 171 172 173
  if (result.WAL_ttl_seconds > 0 || result.WAL_size_limit_MB > 0) {
    result.recycle_log_file_num = false;
  }

174 175 176 177 178 179 180 181 182 183 184
  if (result.recycle_log_file_num &&
      (result.wal_recovery_mode == WALRecoveryMode::kPointInTimeRecovery ||
       result.wal_recovery_mode == WALRecoveryMode::kAbsoluteConsistency)) {
    // kPointInTimeRecovery is indistinguishable from
    // kTolerateCorruptedTailRecords in recycle mode since we define
    // the "end" of the log as the first corrupt record we encounter.
    // kAbsoluteConsistency doesn't make sense because even a clean
    // shutdown leaves old junk at the end of the log file.
    result.wal_recovery_mode = WALRecoveryMode::kTolerateCorruptedTailRecords;
  }

185 186 187 188
  if (result.wal_dir.empty()) {
    // Use dbname as default
    result.wal_dir = dbname;
  }
189
  if (result.wal_dir.back() == '/') {
I
Igor Canadi 已提交
190
    result.wal_dir = result.wal_dir.substr(0, result.wal_dir.size() - 1);
191
  }
192

193
  if (result.db_paths.size() == 0) {
194
    result.db_paths.emplace_back(dbname, std::numeric_limits<uint64_t>::max());
195 196
  }

197 198 199 200
  if (result.compaction_readahead_size > 0) {
    result.new_table_reader_for_compaction_inputs = true;
  }

201 202 203 204 205 206 207
  // Force flush on DB open if 2PC is enabled, since with 2PC we have no
  // guarantee that consecutive log files have consecutive sequence id, which
  // make recovery complicated.
  if (result.allow_2pc) {
    result.avoid_flush_during_recovery = false;
  }

J
jorlow@chromium.org 已提交
208 209 210
  return result;
}

211 212
namespace {

213 214
Status SanitizeOptionsByTable(
    const DBOptions& db_opts,
215 216 217
    const std::vector<ColumnFamilyDescriptor>& column_families) {
  Status s;
  for (auto cf : column_families) {
218
    s = cf.options.table_factory->SanitizeOptions(db_opts, cf.options);
219 220 221 222 223 224 225
    if (!s.ok()) {
      return s;
    }
  }
  return Status::OK();
}

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
static Status ValidateOptions(
    const DBOptions& db_options,
    const std::vector<ColumnFamilyDescriptor>& column_families) {
  Status s;

  for (auto& cfd : column_families) {
    s = CheckCompressionSupported(cfd.options);
    if (s.ok() && db_options.allow_concurrent_memtable_write) {
      s = CheckConcurrentWritesSupported(cfd.options);
    }
    if (!s.ok()) {
      return s;
    }
    if (db_options.db_paths.size() > 1) {
      if ((cfd.options.compaction_style != kCompactionStyleUniversal) &&
          (cfd.options.compaction_style != kCompactionStyleLevel)) {
        return Status::NotSupported(
            "More than one DB paths are only supported in "
            "universal and level compaction styles. ");
      }
    }
  }

  if (db_options.db_paths.size() > 4) {
    return Status::NotSupported(
        "More than four DB paths are not supported yet. ");
  }

  if (db_options.allow_mmap_reads && !db_options.allow_os_buffer) {
    // Protect against assert in PosixMMapReadableFile constructor
    return Status::NotSupported(
        "If memory mapped reads (allow_mmap_reads) are enabled "
        "then os caching (allow_os_buffer) must also be enabled. ");
  }

  return Status::OK();
}

A
Aaron Gao 已提交
264 265 266
CompressionType GetCompressionFlush(
    const ImmutableCFOptions& ioptions,
    const MutableCFOptions& mutable_cf_options) {
267 268 269 270 271 272
  // 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;

273
  if (ioptions.compaction_style == kCompactionStyleUniversal) {
274
    can_compress =
275
        (ioptions.compaction_options_universal.compression_size_percent < 0);
276 277
  } else {
    // For leveled compress when min_level_to_compress == 0.
278 279
    can_compress = ioptions.compression_per_level.empty() ||
                   ioptions.compression_per_level[0] != kNoCompression;
280 281 282
  }

  if (can_compress) {
A
Aaron Gao 已提交
283
    return mutable_cf_options.compression;
284 285 286 287
  } else {
    return kNoCompression;
  }
}
I
Igor Canadi 已提交
288

289
void DumpSupportInfo(Logger* logger) {
I
Igor Canadi 已提交
290 291 292 293 294 295 296 297
  Log(InfoLogLevel::INFO_LEVEL, logger, "Compression algorithms supported:");
  Log(InfoLogLevel::INFO_LEVEL, logger, "\tSnappy supported: %d",
      Snappy_Supported());
  Log(InfoLogLevel::INFO_LEVEL, logger, "\tZlib supported: %d",
      Zlib_Supported());
  Log(InfoLogLevel::INFO_LEVEL, logger, "\tBzip supported: %d",
      BZip2_Supported());
  Log(InfoLogLevel::INFO_LEVEL, logger, "\tLZ4 supported: %d", LZ4_Supported());
298 299
  Log(InfoLogLevel::INFO_LEVEL, logger, "Fast CRC32 supported: %d",
      crc32c::IsFastCrc32Supported());
I
Igor Canadi 已提交
300 301
}

302
}  // namespace
303

I
Igor Canadi 已提交
304
DBImpl::DBImpl(const DBOptions& options, const std::string& dbname)
J
jorlow@chromium.org 已提交
305
    : env_(options.env),
H
heyongqiang 已提交
306
      dbname_(dbname),
307 308
      db_options_(SanitizeOptions(dbname, options)),
      stats_(db_options_.statistics.get()),
309
      db_lock_(nullptr),
I
Igor Canadi 已提交
310
      mutex_(stats_, env_, DB_MUTEX_WAIT_MICROS, options.use_adaptive_mutex),
I
Igor Canadi 已提交
311
      shutting_down_(false),
J
jorlow@chromium.org 已提交
312
      bg_cv_(&mutex_),
313
      logfile_number_(0),
314
      log_dir_synced_(false),
I
Igor Canadi 已提交
315
      log_empty_(true),
316
      default_cf_handle_(nullptr),
317
      log_sync_cv_(&mutex_),
I
Igor Canadi 已提交
318 319
      total_log_size_(0),
      max_total_in_memory_state_(0),
S
sdong 已提交
320
      is_snapshot_supported_(true),
321
      write_buffer_manager_(db_options_.write_buffer_manager.get()),
322 323 324 325
      write_thread_(options.enable_write_thread_adaptive_yield
                        ? options.write_thread_max_yield_usec
                        : 0,
                    options.write_thread_slow_yield_usec),
S
sdong 已提交
326 327
      write_controller_(options.delayed_write_rate),
      last_batch_group_size_(0),
328 329
      unscheduled_flushes_(0),
      unscheduled_compactions_(0),
330
      bg_compaction_scheduled_(0),
331
      num_running_compactions_(0),
332
      bg_flush_scheduled_(0),
333
      num_running_flushes_(0),
334
      bg_purge_scheduled_(0),
335
      disable_delete_obsolete_files_(0),
I
Igor Canadi 已提交
336 337 338
      delete_obsolete_files_next_run_(
          options.env->NowMicros() +
          db_options_.delete_obsolete_files_period_micros),
339
      last_stats_dump_time_microsec_(0),
340
      next_job_id_(1),
341
      has_unpersisted_data_(false),
342
      env_options_(db_options_),
I
Igor Canadi 已提交
343 344 345
#ifndef ROCKSDB_LITE
      wal_manager_(db_options_, env_options_),
#endif  // ROCKSDB_LITE
I
Igor Canadi 已提交
346
      event_logger_(db_options_.info_log.get()),
347
      bg_work_paused_(0),
348
      bg_compaction_paused_(0),
349
      refitting_level_(false),
350
      opened_successfully_(false) {
H
heyongqiang 已提交
351
  env_->GetAbsolutePath(dbname, &db_absolute_path_);
352

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

360
  versions_.reset(new VersionSet(dbname_, &db_options_, env_options_,
361
                                 table_cache_.get(), write_buffer_manager_,
362
                                 &write_controller_));
363 364
  column_family_memtables_.reset(
      new ColumnFamilyMemTablesImpl(versions_->GetColumnFamilySet()));
365

I
Igor Canadi 已提交
366
  DumpRocksDBBuildVersion(db_options_.info_log.get());
367 368
  DumpDBFileSummary(db_options_, dbname_);
  db_options_.Dump(db_options_.info_log.get());
369
  DumpSupportInfo(db_options_.info_log.get());
J
jorlow@chromium.org 已提交
370 371
}

372
// Will lock the mutex_,  will wait for completion if wait is true
373
void DBImpl::CancelAllBackgroundWork(bool wait) {
374
  InstrumentedMutexLock l(&mutex_);
375
  shutting_down_.store(true, std::memory_order_release);
376
  bg_cv_.SignalAll();
377 378 379 380
  if (!wait) {
    return;
  }
  // Wait for background work to finish
381
  while (bg_compaction_scheduled_ || bg_flush_scheduled_) {
382 383
    bg_cv_.Wait();
  }
384 385
}

J
jorlow@chromium.org 已提交
386
DBImpl::~DBImpl() {
387
  mutex_.Lock();
388

389 390
  if (!shutting_down_.load(std::memory_order_acquire) &&
      has_unpersisted_data_) {
391
    for (auto cfd : *versions_->GetColumnFamilySet()) {
392
      if (!cfd->IsDropped() && !cfd->mem()->IsEmpty()) {
393 394 395 396
        cfd->Ref();
        mutex_.Unlock();
        FlushMemTable(cfd, FlushOptions());
        mutex_.Lock();
397
        cfd->Unref();
398 399
      }
    }
400
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
401
  }
402 403 404
  mutex_.Unlock();
  // CancelAllBackgroundWork called with false means we just set the shutdown
  // marker. After this we do a variant of the waiting and unschedule work
405 406
  // (to consider: moving all the waiting into CancelAllBackgroundWork(true))
  CancelAllBackgroundWork(false);
407 408 409 410 411 412 413
  int compactions_unscheduled = env_->UnSchedule(this, Env::Priority::LOW);
  int flushes_unscheduled = env_->UnSchedule(this, Env::Priority::HIGH);
  mutex_.Lock();
  bg_compaction_scheduled_ -= compactions_unscheduled;
  bg_flush_scheduled_ -= flushes_unscheduled;

  // Wait for background work to finish
414 415 416
  while (bg_compaction_scheduled_ || bg_flush_scheduled_ ||
         bg_purge_scheduled_) {
    TEST_SYNC_POINT("DBImpl::~DBImpl:WaitJob");
417 418
    bg_cv_.Wait();
  }
419
  EraseThreadStatusDbInfo();
I
Igor Canadi 已提交
420 421
  flush_scheduler_.Clear();

422 423 424 425 426 427 428 429 430 431 432 433 434
  while (!flush_queue_.empty()) {
    auto cfd = PopFirstFromFlushQueue();
    if (cfd->Unref()) {
      delete cfd;
    }
  }
  while (!compaction_queue_.empty()) {
    auto cfd = PopFirstFromCompactionQueue();
    if (cfd->Unref()) {
      delete cfd;
    }
  }

I
Igor Canadi 已提交
435 436 437 438 439
  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();
440 441
  }

I
Igor Canadi 已提交
442 443 444 445 446 447 448 449 450 451
  // 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_) {
452
    JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
453
    FindObsoleteFiles(&job_context, true);
454 455

    mutex_.Unlock();
I
Igor Canadi 已提交
456
    // manifest number starting from 2
I
Igor Canadi 已提交
457 458 459
    job_context.manifest_file_number = 1;
    if (job_context.HaveSomethingToDelete()) {
      PurgeObsoleteFiles(job_context);
460
    }
I
Igor Canadi 已提交
461
    job_context.Clean();
462
    mutex_.Lock();
463 464
  }

465 466 467
  for (auto l : logs_to_free_) {
    delete l;
  }
468 469 470
  for (auto& log : logs_) {
    log.ClearWriter();
  }
471
  logs_.clear();
472

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
  // Table cache may have table handles holding blocks from the block cache.
  // We need to release them before the block cache is destroyed. The block
  // cache may be destroyed inside versions_.reset(), when column family data
  // list is destroyed, so leaving handles in table cache after
  // versions_.reset() may cause issues.
  // Here we clean all unreferenced handles in table cache.
  // Now we assume all user queries have finished, so only version set itself
  // can possibly hold the blocks from block cache. After releasing unreferenced
  // handles here, only handles held by version set left and inside
  // versions_.reset(), we will release them. There, we need to make sure every
  // time a handle is released, we erase it from the cache too. By doing that,
  // we can guarantee that after versions_.reset(), table cache is empty
  // so the cache can be safely destroyed.
  table_cache_->EraseUnRefEntries();

I
Islam AbdelRahman 已提交
488 489 490 491
  for (auto& txn_entry : recovered_transactions_) {
    delete txn_entry.second;
  }

492
  // versions need to be destroyed before table_cache since it can hold
493 494
  // references to table_cache.
  versions_.reset();
495
  mutex_.Unlock();
I
Igor Canadi 已提交
496 497 498
  if (db_lock_ != nullptr) {
    env_->UnlockFile(db_lock_);
  }
499

500
  LogFlush(db_options_.info_log);
J
jorlow@chromium.org 已提交
501 502 503
}

Status DBImpl::NewDB() {
504
  VersionEdit new_db;
505
  new_db.SetLogNumber(0);
J
jorlow@chromium.org 已提交
506 507 508
  new_db.SetNextFile(2);
  new_db.SetLastSequence(0);

509 510
  Status s;

511 512
  Log(InfoLogLevel::INFO_LEVEL,
      db_options_.info_log, "Creating manifest 1 \n");
J
jorlow@chromium.org 已提交
513 514
  const std::string manifest = DescriptorFileName(dbname_, 1);
  {
515 516
    unique_ptr<WritableFile> file;
    EnvOptions env_options = env_->OptimizeForManifestWrite(env_options_);
S
sdong 已提交
517
    s = NewWritableFile(env_, manifest, &file, env_options);
518 519 520 521 522 523
    if (!s.ok()) {
      return s;
    }
    file->SetPreallocationBlockSize(db_options_.manifest_preallocation_size);
    unique_ptr<WritableFileWriter> file_writer(
        new WritableFileWriter(std::move(file), env_options));
524
    log::Writer log(std::move(file_writer), 0, false);
J
jorlow@chromium.org 已提交
525 526 527
    std::string record;
    new_db.EncodeTo(&record);
    s = log.AddRecord(record);
S
sdong 已提交
528 529 530
    if (s.ok()) {
      s = SyncManifest(env_, &db_options_, log.file());
    }
J
jorlow@chromium.org 已提交
531 532 533
  }
  if (s.ok()) {
    // Make "CURRENT" file that points to the new manifest file.
534
    s = SetCurrentFile(env_, dbname_, 1, directories_.GetDbDir());
J
jorlow@chromium.org 已提交
535 536 537 538 539 540 541
  } else {
    env_->DeleteFile(manifest);
  }
  return s;
}

void DBImpl::MaybeIgnoreError(Status* s) const {
542
  if (s->ok() || db_options_.paranoid_checks) {
J
jorlow@chromium.org 已提交
543 544
    // No change needed
  } else {
545 546
    Log(InfoLogLevel::WARN_LEVEL,
        db_options_.info_log, "Ignoring error %s", s->ToString().c_str());
J
jorlow@chromium.org 已提交
547 548 549 550
    *s = Status::OK();
  }
}

551
const Status DBImpl::CreateArchivalDirectory() {
552 553
  if (db_options_.WAL_ttl_seconds > 0 || db_options_.WAL_size_limit_MB > 0) {
    std::string archivalPath = ArchivalDirectory(db_options_.wal_dir);
554 555 556 557 558
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

559
void DBImpl::PrintStatistics() {
560
  auto dbstats = db_options_.statistics.get();
561
  if (dbstats) {
Y
Yueh-Hsuan Chiang 已提交
562
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
M
Mark Callaghan 已提交
563
        "STATISTICS:\n %s",
564
        dbstats->ToString().c_str());
565 566 567
  }
}

568
#ifndef ROCKSDB_LITE
569 570 571 572 573 574 575 576 577 578 579 580 581 582
#ifdef ROCKSDB_JEMALLOC
typedef struct {
  char* cur;
  char* end;
} MallocStatus;

static void GetJemallocStatus(void* mstat_arg, const char* status) {
  MallocStatus* mstat = reinterpret_cast<MallocStatus*>(mstat_arg);
  size_t status_len = status ? strlen(status) : 0;
  size_t buf_size = (size_t)(mstat->end - mstat->cur);
  if (!status_len || status_len > buf_size) {
    return;
  }

583
  snprintf(mstat->cur, buf_size, "%s", status);
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
  mstat->cur += status_len;
}
#endif  // ROCKSDB_JEMALLOC

static void DumpMallocStats(std::string* stats) {
#ifdef ROCKSDB_JEMALLOC
  MallocStatus mstat;
  const uint kMallocStatusLen = 1000000;
  std::unique_ptr<char> buf{new char[kMallocStatusLen + 1]};
  mstat.cur = buf.get();
  mstat.end = buf.get() + kMallocStatusLen;
  malloc_stats_print(GetJemallocStatus, &mstat, "");
  stats->append(buf.get());
#endif  // ROCKSDB_JEMALLOC
}
599
#endif  // !ROCKSDB_LITE
600

601
void DBImpl::MaybeDumpStats() {
602
  if (db_options_.stats_dump_period_sec == 0) return;
H
Haobo Xu 已提交
603 604 605 606

  const uint64_t now_micros = env_->NowMicros();

  if (last_stats_dump_time_microsec_ +
607
      db_options_.stats_dump_period_sec * 1000000
H
Haobo Xu 已提交
608 609 610 611 612 613
      <= 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;
614

615
#ifndef ROCKSDB_LITE
616 617 618 619 620 621 622
    const DBPropertyInfo* cf_property_info =
        GetPropertyInfo(DB::Properties::kCFStats);
    assert(cf_property_info != nullptr);
    const DBPropertyInfo* db_property_info =
        GetPropertyInfo(DB::Properties::kDBStats);
    assert(db_property_info != nullptr);

H
Haobo Xu 已提交
623
    std::string stats;
624
    {
625
      InstrumentedMutexLock l(&mutex_);
626
      for (auto cfd : *versions_->GetColumnFamilySet()) {
627 628
        cfd->internal_stats()->GetStringProperty(
            *cf_property_info, DB::Properties::kCFStats, &stats);
629
      }
630 631
      default_cf_internal_stats_->GetStringProperty(
          *db_property_info, DB::Properties::kDBStats, &stats);
632
    }
633 634 635
    if (db_options_.dump_malloc_stats) {
      DumpMallocStats(&stats);
    }
Y
Yueh-Hsuan Chiang 已提交
636
    Log(InfoLogLevel::WARN_LEVEL,
637
        db_options_.info_log, "------- DUMPING STATS -------");
Y
Yueh-Hsuan Chiang 已提交
638
    Log(InfoLogLevel::WARN_LEVEL,
639
        db_options_.info_log, "%s", stats.c_str());
640
#endif  // !ROCKSDB_LITE
641

642
    PrintStatistics();
643 644 645
  }
}

646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
uint64_t DBImpl::FindMinPrepLogReferencedByMemTable() {
  uint64_t min_log = 0;

  // we must look through the memtables for two phase transactions
  // that have been committed but not yet flushed
  for (auto loop_cfd : *versions_->GetColumnFamilySet()) {
    if (loop_cfd->IsDropped()) {
      continue;
    }

    auto log = loop_cfd->imm()->GetMinLogContainingPrepSection();

    if (log > 0 && (min_log == 0 || log < min_log)) {
      min_log = log;
    }

    log = loop_cfd->mem()->GetMinLogContainingPrepSection();

    if (log > 0 && (min_log == 0 || log < min_log)) {
      min_log = log;
    }
  }

  return min_log;
}

void DBImpl::MarkLogAsHavingPrepSectionFlushed(uint64_t log) {
  assert(log != 0);
  std::lock_guard<std::mutex> lock(prep_heap_mutex_);
  auto it = prepared_section_completed_.find(log);
  assert(it != prepared_section_completed_.end());
  it->second += 1;
}

void DBImpl::MarkLogAsContainingPrepSection(uint64_t log) {
  assert(log != 0);
  std::lock_guard<std::mutex> lock(prep_heap_mutex_);
  min_log_with_prep_.push(log);
  auto it = prepared_section_completed_.find(log);
  if (it == prepared_section_completed_.end()) {
    prepared_section_completed_[log] = 0;
  }
}

uint64_t DBImpl::FindMinLogContainingOutstandingPrep() {
R
Reid Horuff 已提交
691
  std::lock_guard<std::mutex> lock(prep_heap_mutex_);
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
  uint64_t min_log = 0;

  // first we look in the prepared heap where we keep
  // track of transactions that have been prepared (written to WAL)
  // but not yet committed.
  while (!min_log_with_prep_.empty()) {
    min_log = min_log_with_prep_.top();

    auto it = prepared_section_completed_.find(min_log);

    // value was marked as 'deleted' from heap
    if (it != prepared_section_completed_.end() && it->second > 0) {
      it->second -= 1;
      min_log_with_prep_.pop();

      // back to squere one...
      min_log = 0;
      continue;
    } else {
      // found a valid value
      break;
    }
  }

  return min_log;
}

I
Igor Canadi 已提交
719
// * Returns the list of live files in 'sst_live'
I
Igor Canadi 已提交
720
// If it's doing full scan:
I
Igor Canadi 已提交
721 722
// * Returns the list of all files in the filesystem in
// 'full_scan_candidate_files'.
I
Igor Canadi 已提交
723
// Otherwise, gets obsolete files from VersionSet.
I
Igor Canadi 已提交
724 725
// no_full_scan = true -- never do the full scan using GetChildren()
// force = false -- don't force the full scan, except every
726
//  db_options_.delete_obsolete_files_period_micros
I
Igor Canadi 已提交
727
// force = true -- force the full scan
I
Igor Canadi 已提交
728
void DBImpl::FindObsoleteFiles(JobContext* job_context, bool force,
I
Igor Canadi 已提交
729
                               bool no_full_scan) {
D
Dhruba Borthakur 已提交
730 731
  mutex_.AssertHeld();

732
  // if deletion is disabled, do nothing
733
  if (disable_delete_obsolete_files_ > 0) {
734 735 736
    return;
  }

737 738 739 740 741
  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;
742
  } else if (force || db_options_.delete_obsolete_files_period_micros == 0) {
743 744 745
    doing_the_full_scan = true;
  } else {
    const uint64_t now_micros = env_->NowMicros();
I
Igor Canadi 已提交
746
    if (delete_obsolete_files_next_run_ < now_micros) {
747
      doing_the_full_scan = true;
I
Igor Canadi 已提交
748 749
      delete_obsolete_files_next_run_ =
          now_micros + db_options_.delete_obsolete_files_period_micros;
750 751 752
    }
  }

I
Igor Canadi 已提交
753 754
  // don't delete files that might be currently written to from compaction
  // threads
755 756 757
  // Since job_context->min_pending_output is set, until file scan finishes,
  // mutex_ cannot be released. Otherwise, we might see no min_pending_output
  // here but later find newer generated unfinalized files while scannint.
I
Igor Canadi 已提交
758 759 760 761 762 763 764
  if (!pending_outputs_.empty()) {
    job_context->min_pending_output = *pending_outputs_.begin();
  } else {
    // delete all of them
    job_context->min_pending_output = std::numeric_limits<uint64_t>::max();
  }

765 766
  // Get obsolete files.  This function will also update the list of
  // pending files in VersionSet().
I
Igor Canadi 已提交
767
  versions_->GetObsoleteFiles(&job_context->sst_delete_files,
768
                              &job_context->manifest_delete_files,
I
Igor Canadi 已提交
769
                              job_context->min_pending_output);
I
Igor Canadi 已提交
770

I
Igor Canadi 已提交
771
  // store the current filenum, lognum, etc
772
  job_context->manifest_file_number = versions_->manifest_file_number();
I
Igor Canadi 已提交
773
  job_context->pending_manifest_file_number =
774
      versions_->pending_manifest_file_number();
I
Igor Canadi 已提交
775
  job_context->log_number = versions_->MinLogNumber();
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801

  if (allow_2pc()) {
    // if are 2pc we must consider logs containing prepared
    // sections of outstanding transactions.
    //
    // We must check min logs with outstanding prep before we check
    // logs referneces by memtables because a log referenced by the
    // first data structure could transition to the second under us.
    //
    // TODO(horuff): iterating over all column families under db mutex.
    // should find more optimial solution
    auto min_log_in_prep_heap = FindMinLogContainingOutstandingPrep();

    if (min_log_in_prep_heap != 0 &&
        min_log_in_prep_heap < job_context->log_number) {
      job_context->log_number = min_log_in_prep_heap;
    }

    auto min_log_refed_by_mem = FindMinPrepLogReferencedByMemTable();

    if (min_log_refed_by_mem != 0 &&
        min_log_refed_by_mem < job_context->log_number) {
      job_context->log_number = min_log_refed_by_mem;
    }
  }

802
  job_context->prev_log_number = versions_->prev_log_number();
I
Igor Canadi 已提交
803

I
Igor Canadi 已提交
804
  versions_->AddLiveFiles(&job_context->sst_live);
805
  if (doing_the_full_scan) {
806
    for (size_t path_id = 0; path_id < db_options_.db_paths.size(); path_id++) {
807 808 809
      // set of all files in the directory. We'll exclude files that are still
      // alive in the subsequent processings.
      std::vector<std::string> files;
810
      env_->GetChildren(db_options_.db_paths[path_id].path,
811
                        &files);  // Ignore errors
812
      for (std::string file : files) {
I
Igor Canadi 已提交
813
        // TODO(icanadi) clean up this mess to avoid having one-off "/" prefixes
S
Siying Dong 已提交
814 815
        job_context->full_scan_candidate_files.emplace_back(
            "/" + file, static_cast<uint32_t>(path_id));
816 817
      }
    }
818 819

    //Add log files in wal_dir
820
    if (db_options_.wal_dir != dbname_) {
821
      std::vector<std::string> log_files;
822
      env_->GetChildren(db_options_.wal_dir, &log_files);  // Ignore errors
823
      for (std::string log_file : log_files) {
I
Igor Canadi 已提交
824
        job_context->full_scan_candidate_files.emplace_back(log_file, 0);
825 826
      }
    }
827
    // Add info log files in db_log_dir
828
    if (!db_options_.db_log_dir.empty() && db_options_.db_log_dir != dbname_) {
829
      std::vector<std::string> info_log_files;
830 831
      // Ignore errors
      env_->GetChildren(db_options_.db_log_dir, &info_log_files);
832
      for (std::string log_file : info_log_files) {
I
Igor Canadi 已提交
833
        job_context->full_scan_candidate_files.emplace_back(log_file, 0);
834 835
      }
    }
836
  }
837 838

  if (!alive_log_files_.empty()) {
839
    uint64_t min_log_number = job_context->log_number;
S
sdong 已提交
840
    size_t num_alive_log_files = alive_log_files_.size();
841 842 843
    // find newly obsoleted log files
    while (alive_log_files_.begin()->number < min_log_number) {
      auto& earliest = *alive_log_files_.begin();
S
Sage Weil 已提交
844 845 846 847 848 849 850
      if (db_options_.recycle_log_file_num > log_recycle_files.size()) {
        Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
            "adding log %" PRIu64 " to recycle list\n", earliest.number);
        log_recycle_files.push_back(earliest.number);
      } else {
        job_context->log_delete_files.push_back(earliest.number);
      }
S
sdong 已提交
851 852 853 854 855
      if (job_context->size_log_to_delete == 0) {
        job_context->prev_total_log_size = total_log_size_;
        job_context->num_alive_log_files = num_alive_log_files;
      }
      job_context->size_log_to_delete += earliest.size;
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
      total_log_size_ -= earliest.size;
      alive_log_files_.pop_front();
      // Current log should always stay alive since it can't have
      // number < MinLogNumber().
      assert(alive_log_files_.size());
    }
    while (!logs_.empty() && logs_.front().number < min_log_number) {
      auto& log = logs_.front();
      if (log.getting_synced) {
        log_sync_cv_.Wait();
        // logs_ could have changed while we were waiting.
        continue;
      }
      logs_to_free_.push_back(log.ReleaseWriter());
      logs_.pop_front();
    }
    // Current log cannot be obsolete.
    assert(!logs_.empty());
  }

  // We're just cleaning up for DB::Write().
  assert(job_context->logs_to_free.empty());
  job_context->logs_to_free = logs_to_free_;
  logs_to_free_.clear();
880 881
}

882
namespace {
I
Igor Canadi 已提交
883 884
bool CompareCandidateFile(const JobContext::CandidateFileInfo& first,
                          const JobContext::CandidateFileInfo& second) {
885 886 887 888 889
  if (first.file_name > second.file_name) {
    return true;
  } else if (first.file_name < second.file_name) {
    return false;
  } else {
890
    return (first.path_id > second.path_id);
891 892 893 894
  }
}
};  // namespace

895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
// Delete obsolete files and log status and information of file deletion
void DBImpl::DeleteObsoleteFileImpl(Status file_deletion_status, int job_id,
                                    const std::string& fname, FileType type,
                                    uint64_t number, uint32_t path_id) {
  if (type == kTableFile) {
    file_deletion_status = DeleteSSTFile(&db_options_, fname, path_id);
  } else {
    file_deletion_status = env_->DeleteFile(fname);
  }
  if (file_deletion_status.ok()) {
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
        "[JOB %d] Delete %s type=%d #%" PRIu64 " -- %s\n", job_id,
        fname.c_str(), type, number, file_deletion_status.ToString().c_str());
  } else if (env_->FileExists(fname).IsNotFound()) {
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "[JOB %d] Tried to delete a non-existing file %s type=%d #%" PRIu64
        " -- %s\n",
        job_id, fname.c_str(), type, number,
        file_deletion_status.ToString().c_str());
  } else {
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "[JOB %d] Failed to delete %s type=%d #%" PRIu64 " -- %s\n", job_id,
        fname.c_str(), type, number, file_deletion_status.ToString().c_str());
  }
  if (type == kTableFile) {
    EventHelpers::LogAndNotifyTableFileDeletion(
        &event_logger_, job_id, number, fname, file_deletion_status, GetName(),
        db_options_.listeners);
  }
}

D
Dhruba Borthakur 已提交
926
// Diffs the files listed in filenames and those that do not
I
Igor Canadi 已提交
927
// belong to live files are posibly removed. Also, removes all the
928
// files in sst_delete_files and log_delete_files.
929
// It is not necessary to hold the mutex when invoking this method.
930
void DBImpl::PurgeObsoleteFiles(const JobContext& state, bool schedule_only) {
931 932
  // we'd better have sth to delete
  assert(state.HaveSomethingToDelete());
933

I
Igor Canadi 已提交
934 935 936 937
  // 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 已提交
938 939
    return;
  }
940

941
  // Now, convert live list to an unordered map, WITHOUT mutex held;
942
  // set is slow.
943
  std::unordered_map<uint64_t, const FileDescriptor*> sst_live_map;
I
Igor Canadi 已提交
944
  for (const FileDescriptor& fd : state.sst_live) {
945 946
    sst_live_map[fd.GetNumber()] = &fd;
  }
I
Igor Canadi 已提交
947

I
Igor Canadi 已提交
948
  auto candidate_files = state.full_scan_candidate_files;
949 950 951
  candidate_files.reserve(
      candidate_files.size() + state.sst_delete_files.size() +
      state.log_delete_files.size() + state.manifest_delete_files.size());
K
kailiu 已提交
952 953
  // We may ignore the dbname when generating the file names.
  const char* kDumbDbName = "";
954
  for (auto file : state.sst_delete_files) {
955 956 957
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
958
    delete file;
I
Igor Canadi 已提交
959 960
  }

K
kailiu 已提交
961 962
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
963 964
      candidate_files.emplace_back(LogFileName(kDumbDbName, file_num).substr(1),
                                   0);
I
Igor Canadi 已提交
965 966
    }
  }
967 968 969
  for (const auto& filename : state.manifest_delete_files) {
    candidate_files.emplace_back(filename, 0);
  }
970

K
kailiu 已提交
971
  // dedup state.candidate_files so we don't try to delete the same
I
Igor Canadi 已提交
972
  // file twice
973 974 975 976 977
  std::sort(candidate_files.begin(), candidate_files.end(),
            CompareCandidateFile);
  candidate_files.erase(
      std::unique(candidate_files.begin(), candidate_files.end()),
      candidate_files.end());
J
jorlow@chromium.org 已提交
978

S
sdong 已提交
979 980 981 982 983 984 985 986 987
  if (state.prev_total_log_size > 0) {
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "[JOB %d] Try to delete WAL files size %" PRIu64
        ", prev total WAL file size %" PRIu64
        ", number of live WAL files %" ROCKSDB_PRIszt ".\n",
        state.job_id, state.size_log_to_delete, state.prev_total_log_size,
        state.num_alive_log_files);
  }

988
  std::vector<std::string> old_info_log_files;
989
  InfoLogPrefix info_log_prefix(!db_options_.db_log_dir.empty(), dbname_);
990 991 992
  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 已提交
993 994 995
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
996
    if (!ParseFileName(to_delete, &number, info_log_prefix.prefix, &type)) {
K
kailiu 已提交
997 998
      continue;
    }
J
jorlow@chromium.org 已提交
999

K
kailiu 已提交
1000 1001 1002 1003 1004 1005 1006 1007
    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'
1008
        // (can happen during manifest roll)
K
kailiu 已提交
1009 1010 1011
        keep = (number >= state.manifest_file_number);
        break;
      case kTableFile:
I
Igor Canadi 已提交
1012 1013 1014 1015
        // If the second condition is not there, this makes
        // DontDeletePendingOutputs fail
        keep = (sst_live_map.find(number) != sst_live_map.end()) ||
               number >= state.min_pending_output;
K
kailiu 已提交
1016 1017 1018
        break;
      case kTempFile:
        // Any temp files that are currently being written to must
1019 1020 1021 1022
        // 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
1023 1024 1025
        //
        // TODO(yhchiang): carefully modify the third condition to safely
        //                 remove the temp options files.
1026
        keep = (sst_live_map.find(number) != sst_live_map.end()) ||
1027 1028
               (number == state.pending_manifest_file_number) ||
               (to_delete.find(kOptionsFileNamePrefix) != std::string::npos);
K
kailiu 已提交
1029 1030 1031 1032
        break;
      case kInfoLogFile:
        keep = true;
        if (number != 0) {
1033
          old_info_log_files.push_back(to_delete);
J
jorlow@chromium.org 已提交
1034
        }
K
kailiu 已提交
1035 1036 1037 1038 1039
        break;
      case kCurrentFile:
      case kDBLockFile:
      case kIdentityFile:
      case kMetaDatabase:
1040
      case kOptionsFile:
K
kailiu 已提交
1041 1042 1043 1044 1045 1046 1047 1048
        keep = true;
        break;
    }

    if (keep) {
      continue;
    }

1049
    std::string fname;
K
kailiu 已提交
1050 1051
    if (type == kTableFile) {
      // evict from cache
1052
      TableCache::Evict(table_cache_.get(), number);
1053
      fname = TableFileName(db_options_.db_paths, number, path_id);
1054
    } else {
1055 1056
      fname = ((type == kLogFile) ?
          db_options_.wal_dir : dbname_) + "/" + to_delete;
K
kailiu 已提交
1057
    }
1058

1059
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
1060
    if (type == kLogFile && (db_options_.WAL_ttl_seconds > 0 ||
1061
                              db_options_.WAL_size_limit_MB > 0)) {
I
Igor Canadi 已提交
1062
      wal_manager_.ArchiveWALFile(fname, number);
1063 1064 1065
      continue;
    }
#endif  // !ROCKSDB_LITE
S
sdong 已提交
1066

I
Islam AbdelRahman 已提交
1067
    Status file_deletion_status;
1068 1069 1070
    if (schedule_only) {
      InstrumentedMutexLock guard_lock(&mutex_);
      SchedulePendingPurge(fname, type, number, path_id, state.job_id);
1071
    } else {
1072 1073
      DeleteObsoleteFileImpl(file_deletion_status, state.job_id, fname, type,
                             number, path_id);
J
jorlow@chromium.org 已提交
1074 1075
    }
  }
H
heyongqiang 已提交
1076

1077
  // Delete old info log files.
1078
  size_t old_info_log_file_count = old_info_log_files.size();
1079 1080
  if (old_info_log_file_count != 0 &&
      old_info_log_file_count >= db_options_.keep_log_file_num) {
1081
    std::sort(old_info_log_files.begin(), old_info_log_files.end());
1082
    size_t end = old_info_log_file_count - db_options_.keep_log_file_num;
1083
    for (unsigned int i = 0; i <= end; i++) {
1084
      std::string& to_delete = old_info_log_files.at(i);
1085 1086
      std::string full_path_to_delete = (db_options_.db_log_dir.empty() ?
           dbname_ : db_options_.db_log_dir) + "/" + to_delete;
1087
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
1088
          "[JOB %d] Delete info log file %s\n", state.job_id,
1089 1090
          full_path_to_delete.c_str());
      Status s = env_->DeleteFile(full_path_to_delete);
1091
      if (!s.ok()) {
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
        if (env_->FileExists(full_path_to_delete).IsNotFound()) {
          Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
              "[JOB %d] Tried to delete non-existing info log file %s FAILED "
              "-- %s\n",
              state.job_id, to_delete.c_str(), s.ToString().c_str());
        } else {
          Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
              "[JOB %d] Delete info log file %s FAILED -- %s\n", state.job_id,
              to_delete.c_str(), s.ToString().c_str());
        }
1102
      }
H
heyongqiang 已提交
1103 1104
    }
  }
I
Igor Canadi 已提交
1105 1106 1107
#ifndef ROCKSDB_LITE
  wal_manager_.PurgeObsoleteWALFiles();
#endif  // ROCKSDB_LITE
1108
  LogFlush(db_options_.info_log);
D
Dhruba Borthakur 已提交
1109 1110 1111 1112
}

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
1113
  JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
1114
  FindObsoleteFiles(&job_context, true);
1115 1116

  mutex_.Unlock();
I
Igor Canadi 已提交
1117 1118
  if (job_context.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(job_context);
1119
  }
I
Igor Canadi 已提交
1120
  job_context.Clean();
1121
  mutex_.Lock();
1122 1123
}

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
Status DBImpl::Directories::CreateAndNewDirectory(
    Env* env, const std::string& dirname,
    std::unique_ptr<Directory>* directory) const {
  // 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(dirname);
  if (!s.ok()) {
    return s;
  }
  return env->NewDirectory(dirname, directory);
}
J
jorlow@chromium.org 已提交
1140

1141 1142 1143 1144 1145 1146 1147 1148 1149
Status DBImpl::Directories::SetDirectories(
    Env* env, const std::string& dbname, const std::string& wal_dir,
    const std::vector<DbPath>& data_paths) {
  Status s = CreateAndNewDirectory(env, dbname, &db_dir_);
  if (!s.ok()) {
    return s;
  }
  if (!wal_dir.empty() && dbname != wal_dir) {
    s = CreateAndNewDirectory(env, wal_dir, &wal_dir_);
1150 1151 1152
    if (!s.ok()) {
      return s;
    }
1153
  }
1154

1155 1156 1157 1158 1159 1160 1161 1162
  data_dirs_.clear();
  for (auto& p : data_paths) {
    const std::string db_path = p.path;
    if (db_path == dbname) {
      data_dirs_.emplace_back(nullptr);
    } else {
      std::unique_ptr<Directory> path_directory;
      s = CreateAndNewDirectory(env, db_path, &path_directory);
1163 1164 1165
      if (!s.ok()) {
        return s;
      }
1166
      data_dirs_.emplace_back(path_directory.release());
1167
    }
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
  }
  assert(data_dirs_.size() == data_paths.size());
  return Status::OK();
}

Directory* DBImpl::Directories::GetDataDir(size_t path_id) {
  assert(path_id < data_dirs_.size());
  Directory* ret_dir = data_dirs_[path_id].get();
  if (ret_dir == nullptr) {
    // Should use db_dir_
    return db_dir_.get();
  }
  return ret_dir;
}

Status DBImpl::Recover(
    const std::vector<ColumnFamilyDescriptor>& column_families, bool read_only,
1185
    bool error_if_log_file_exist, bool error_if_data_exists_in_logs) {
1186
  mutex_.AssertHeld();
1187

1188 1189 1190 1191 1192
  bool is_new_db = false;
  assert(db_lock_ == nullptr);
  if (!read_only) {
    Status s = directories_.SetDirectories(env_, dbname_, db_options_.wal_dir,
                                           db_options_.db_paths);
1193 1194 1195 1196
    if (!s.ok()) {
      return s;
    }

1197
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
1198 1199 1200
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
1201

A
agiardullo 已提交
1202 1203
    s = env_->FileExists(CurrentFileName(dbname_));
    if (s.IsNotFound()) {
1204
      if (db_options_.create_if_missing) {
1205
        s = NewDB();
1206
        is_new_db = true;
1207 1208 1209 1210 1211 1212
        if (!s.ok()) {
          return s;
        }
      } else {
        return Status::InvalidArgument(
            dbname_, "does not exist (create_if_missing is false)");
J
jorlow@chromium.org 已提交
1213
      }
A
agiardullo 已提交
1214
    } else if (s.ok()) {
1215
      if (db_options_.error_if_exists) {
1216 1217 1218
        return Status::InvalidArgument(
            dbname_, "exists (error_if_exists is true)");
      }
A
agiardullo 已提交
1219 1220 1221 1222
    } else {
      // Unexpected error reading file
      assert(s.IsIOError());
      return s;
J
jorlow@chromium.org 已提交
1223
    }
M
Mayank Agarwal 已提交
1224
    // Check for the IDENTITY file and create it if not there
A
agiardullo 已提交
1225 1226
    s = env_->FileExists(IdentityFileName(dbname_));
    if (s.IsNotFound()) {
M
Mayank Agarwal 已提交
1227 1228 1229 1230
      s = SetIdentityFile(env_, dbname_);
      if (!s.ok()) {
        return s;
      }
A
agiardullo 已提交
1231 1232 1233
    } else if (!s.ok()) {
      assert(s.IsIOError());
      return s;
M
Mayank Agarwal 已提交
1234
    }
J
jorlow@chromium.org 已提交
1235 1236
  }

1237
  Status s = versions_->Recover(column_families, read_only);
1238
  if (db_options_.paranoid_checks && s.ok()) {
I
Igor Canadi 已提交
1239 1240
    s = CheckConsistency();
  }
J
jorlow@chromium.org 已提交
1241
  if (s.ok()) {
1242
    SequenceNumber next_sequence(kMaxSequenceNumber);
1243 1244
    default_cf_handle_ = new ColumnFamilyHandleImpl(
        versions_->GetColumnFamilySet()->GetDefault(), this, &mutex_);
1245
    default_cf_internal_stats_ = default_cf_handle_->cfd()->internal_stats();
1246 1247
    single_column_family_mode_ =
        versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1;
1248 1249 1250 1251 1252

    // 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).
    //
1253
    // Note that prev_log_number() is no longer used, but we pay
1254
    // attention to it in case we are recovering a database
1255
    // produced by an older version of rocksdb.
1256
    std::vector<std::string> filenames;
1257
    s = env_->GetChildren(db_options_.wal_dir, &filenames);
1258 1259
    if (!s.ok()) {
      return s;
1260
    }
K
kailiu 已提交
1261

1262 1263
    std::vector<uint64_t> logs;
    for (size_t i = 0; i < filenames.size(); i++) {
K
kailiu 已提交
1264 1265
      uint64_t number;
      FileType type;
1266 1267 1268 1269 1270 1271
      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]);
1272
        } else {
1273 1274
          logs.push_back(number);
        }
1275
      }
J
jorlow@chromium.org 已提交
1276
    }
1277

1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
    if (logs.size() > 0) {
      if (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");
      } else if (error_if_data_exists_in_logs) {
        for (auto& log : logs) {
          std::string fname = LogFileName(db_options_.wal_dir, log);
          uint64_t bytes;
          s = env_->GetFileSize(fname, &bytes);
          if (s.ok()) {
            if (bytes > 0) {
              return Status::Corruption(
                  "error_if_data_exists_in_logs is set but there are data "
                  " in log files.");
            }
          }
        }
      }
H
heyongqiang 已提交
1297 1298
    }

S
Stanislau Hlebik 已提交
1299 1300 1301
    if (!logs.empty()) {
      // Recover in the order in which the logs were generated
      std::sort(logs.begin(), logs.end());
1302
      s = RecoverLogFiles(logs, &next_sequence, read_only);
S
Stanislau Hlebik 已提交
1303 1304 1305
      if (!s.ok()) {
        // Clear memtables if recovery failed
        for (auto cfd : *versions_->GetColumnFamilySet()) {
A
agiardullo 已提交
1306 1307
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 kMaxSequenceNumber);
S
Stanislau Hlebik 已提交
1308 1309
        }
      }
1310
    }
L
Lei Jin 已提交
1311
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1312 1313
  }

L
Lei Jin 已提交
1314 1315
  // Initial value
  max_total_in_memory_state_ = 0;
I
Igor Canadi 已提交
1316
  for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1317 1318 1319
    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 已提交
1320 1321
  }

J
jorlow@chromium.org 已提交
1322 1323 1324
  return s;
}

S
Stanislau Hlebik 已提交
1325 1326
// REQUIRES: log_numbers are sorted in ascending order
Status DBImpl::RecoverLogFiles(const std::vector<uint64_t>& log_numbers,
1327
                               SequenceNumber* next_sequence, bool read_only) {
J
jorlow@chromium.org 已提交
1328 1329
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1330
    Logger* info_log;
J
jorlow@chromium.org 已提交
1331
    const char* fname;
1332
    Status* status;  // nullptr if db_options_.paranoid_checks==false
I
Igor Sugak 已提交
1333
    virtual void Corruption(size_t bytes, const Status& s) override {
1334 1335
      Log(InfoLogLevel::WARN_LEVEL,
          info_log, "%s%s: dropping %d bytes; %s",
1336
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1337
          fname, static_cast<int>(bytes), s.ToString().c_str());
K
krad 已提交
1338 1339 1340
      if (this->status != nullptr && this->status->ok()) {
        *this->status = s;
      }
J
jorlow@chromium.org 已提交
1341 1342 1343 1344
    }
  };

  mutex_.AssertHeld();
S
Stanislau Hlebik 已提交
1345
  Status status;
1346
  std::unordered_map<int, VersionEdit> version_edits;
1347
  // no need to refcount because iteration is under mutex
1348 1349
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    VersionEdit edit;
1350 1351
    edit.SetColumnFamily(cfd->GetID());
    version_edits.insert({cfd->GetID(), edit});
1352
  }
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
  int job_id = next_job_id_.fetch_add(1);
  {
    auto stream = event_logger_.Log();
    stream << "job" << job_id << "event"
           << "recovery_started";
    stream << "log_files";
    stream.StartArray();
    for (auto log_number : log_numbers) {
      stream << log_number;
    }
    stream.EndArray();
  }
I
Igor Canadi 已提交
1365

1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
#ifndef ROCKSDB_LITE
  if (db_options_.wal_filter != nullptr) {
    std::map<std::string, uint32_t> cf_name_id_map;
    std::map<uint32_t, uint64_t> cf_lognumber_map;
    for (auto cfd : *versions_->GetColumnFamilySet()) {
      cf_name_id_map.insert(
        std::make_pair(cfd->GetName(), cfd->GetID()));
      cf_lognumber_map.insert(
        std::make_pair(cfd->GetID(), cfd->GetLogNumber()));
    }

    db_options_.wal_filter->ColumnFamilyLogNumberMap(
      cf_lognumber_map,
      cf_name_id_map);
  }
#endif

1383 1384 1385 1386
  bool stop_replay_by_wal_filter = false;
  bool stop_replay_for_corruption = false;
  bool flushed = false;
  SequenceNumber recovered_sequence = 0;
S
Stanislau Hlebik 已提交
1387 1388 1389 1390
  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.
1391
    versions_->MarkFileNumberUsedDuringRecovery(log_number);
S
Stanislau Hlebik 已提交
1392 1393
    // Open the log file
    std::string fname = LogFileName(db_options_.wal_dir, log_number);
1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410

    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "Recovering log #%" PRIu64 " mode %d", log_number,
        db_options_.wal_recovery_mode);
    auto logFileDropped = [this, &fname]() {
      uint64_t bytes;
      if (env_->GetFileSize(fname, &bytes).ok()) {
        auto info_log = db_options_.info_log.get();
        Log(InfoLogLevel::WARN_LEVEL, info_log, "%s: dropping %d bytes",
            fname.c_str(), static_cast<int>(bytes));
      }
    };
    if (stop_replay_by_wal_filter) {
      logFileDropped();
      continue;
    }

1411 1412 1413 1414
    unique_ptr<SequentialFileReader> file_reader;
    {
      unique_ptr<SequentialFile> file;
      status = env_->NewSequentialFile(fname, &file, env_options_);
S
Stanislau Hlebik 已提交
1415
      if (!status.ok()) {
1416 1417 1418 1419 1420 1421 1422 1423
        MaybeIgnoreError(&status);
        if (!status.ok()) {
          return status;
        } else {
          // Fail with one log file, but that's ok.
          // Try next one.
          continue;
        }
S
Stanislau Hlebik 已提交
1424
      }
1425
      file_reader.reset(new SequentialFileReader(std::move(file)));
J
jorlow@chromium.org 已提交
1426 1427
    }

S
Stanislau Hlebik 已提交
1428 1429 1430 1431 1432
    // Create the log reader.
    LogReporter reporter;
    reporter.env = env_;
    reporter.info_log = db_options_.info_log.get();
    reporter.fname = fname.c_str();
K
krad 已提交
1433 1434 1435 1436 1437 1438 1439
    if (!db_options_.paranoid_checks ||
        db_options_.wal_recovery_mode ==
            WALRecoveryMode::kSkipAnyCorruptedRecords) {
      reporter.status = nullptr;
    } else {
      reporter.status = &status;
    }
S
Stanislau Hlebik 已提交
1440 1441 1442 1443
    // 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).
1444 1445
    log::Reader reader(db_options_.info_log, std::move(file_reader), &reporter,
                       true /*checksum*/, 0 /*initial_offset*/, log_number);
K
krad 已提交
1446 1447

    // Determine if we should tolerate incomplete records at the tail end of the
S
Stanislau Hlebik 已提交
1448 1449 1450 1451
    // Read all the records and add to a memtable
    std::string scratch;
    Slice record;
    WriteBatch batch;
K
krad 已提交
1452

1453
    while (
1454
        !stop_replay_by_wal_filter &&
1455 1456
        reader.ReadRecord(&record, &scratch, db_options_.wal_recovery_mode) &&
        status.ok()) {
1457
      if (record.size() < WriteBatchInternal::kHeader) {
S
Stanislau Hlebik 已提交
1458 1459 1460 1461 1462
        reporter.Corruption(record.size(),
                            Status::Corruption("log record too small"));
        continue;
      }
      WriteBatchInternal::SetContents(&batch, record);
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
      SequenceNumber sequence = WriteBatchInternal::Sequence(&batch);

      // In point-in-time recovery mode, if sequence id of log files are
      // consecutive, we continue recovery despite corruption. This could happen
      // when we open and write to a corrupted DB, where sequence id will start
      // from the last sequence id we recovered.
      if (db_options_.wal_recovery_mode ==
          WALRecoveryMode::kPointInTimeRecovery) {
        if (sequence == recovered_sequence + 1) {
          stop_replay_for_corruption = false;
        }
        if (stop_replay_for_corruption) {
          logFileDropped();
          break;
        }
      }

      recovered_sequence = sequence;
      if (*next_sequence == kMaxSequenceNumber) {
        *next_sequence = sequence;
      } else {
        WriteBatchInternal::SetSequence(&batch, *next_sequence);
      }
S
Stanislau Hlebik 已提交
1486

1487
#ifndef ROCKSDB_LITE
1488
      if (db_options_.wal_filter != nullptr) {
1489 1490 1491
        WriteBatch new_batch;
        bool batch_changed = false;

1492
        WalFilter::WalProcessingOption wal_processing_option =
P
Praveen Rao 已提交
1493
            db_options_.wal_filter->LogRecordFound(log_number, fname, batch,
1494
                                              &new_batch, &batch_changed);
1495

1496
        switch (wal_processing_option) {
S
sdong 已提交
1497 1498 1499 1500 1501
          case WalFilter::WalProcessingOption::kContinueProcessing:
            // do nothing, proceeed normally
            break;
          case WalFilter::WalProcessingOption::kIgnoreCurrentRecord:
            // skip current record
1502
            continue;
S
sdong 已提交
1503 1504
          case WalFilter::WalProcessingOption::kStopReplay:
            // skip current record and stop replay
1505
            stop_replay_by_wal_filter = true;
1506
            continue;
S
sdong 已提交
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
          case WalFilter::WalProcessingOption::kCorruptedRecord: {
            status = Status::Corruption("Corruption reported by Wal Filter ",
                                        db_options_.wal_filter->Name());
            MaybeIgnoreError(&status);
            if (!status.ok()) {
              reporter.Corruption(record.size(), status);
              continue;
            }
            break;
          }
          default: {
            assert(false);  // unhandled case
            status = Status::NotSupported(
                "Unknown WalProcessingOption returned"
                " by Wal Filter ",
                db_options_.wal_filter->Name());
            MaybeIgnoreError(&status);
            if (!status.ok()) {
              return status;
            } else {
              // Ignore the error with current record processing.
              continue;
            }
1530 1531 1532 1533 1534 1535 1536 1537 1538
          }
        }

        if (batch_changed) {
          // Make sure that the count in the new batch is
          // within the orignal count.
          int new_count = WriteBatchInternal::Count(&new_batch);
          int original_count = WriteBatchInternal::Count(&batch);
          if (new_count > original_count) {
1539
            Log(InfoLogLevel::FATAL_LEVEL, db_options_.info_log,
S
sdong 已提交
1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
                "Recovering log #%" PRIu64
                " mode %d log filter %s returned "
                "more records (%d) than original (%d) which is not allowed. "
                "Aborting recovery.",
                log_number, db_options_.wal_recovery_mode,
                db_options_.wal_filter->Name(), new_count, original_count);
            status = Status::NotSupported(
                "More than original # of records "
                "returned by Wal Filter ",
                db_options_.wal_filter->Name());
1550
            return status;
1551 1552 1553
          }
          // Set the same sequence number in the new_batch
          // as the original batch.
S
sdong 已提交
1554 1555
          WriteBatchInternal::SetSequence(&new_batch,
                                          WriteBatchInternal::Sequence(&batch));
1556
          batch = new_batch;
1557 1558
        }
      }
S
sdong 已提交
1559
#endif  // ROCKSDB_LITE
1560

S
Stanislau Hlebik 已提交
1561 1562 1563 1564 1565
      // 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
1566 1567
      status = WriteBatchInternal::InsertInto(
          &batch, column_family_memtables_.get(), &flush_scheduler_, true,
S
sdong 已提交
1568 1569
          log_number, this, false /* concurrent_memtable_writes */,
          next_sequence);
S
Stanislau Hlebik 已提交
1570 1571
      MaybeIgnoreError(&status);
      if (!status.ok()) {
1572 1573 1574 1575
        // We are treating this as a failure while reading since we read valid
        // blocks that do not form coherent data
        reporter.Corruption(record.size(), status);
        continue;
S
Stanislau Hlebik 已提交
1576
      }
1577

S
Stanislau Hlebik 已提交
1578
      if (!read_only) {
I
Igor Canadi 已提交
1579 1580 1581 1582
        // 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;

1583
        while ((cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
1584 1585 1586 1587 1588 1589 1590
          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;
1591
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
I
Igor Canadi 已提交
1592 1593 1594 1595
          if (!status.ok()) {
            // Reflect errors immediately so that conditions like full
            // file-systems cause the DB::Open() to fail.
            return status;
1596
          }
1597
          flushed = true;
A
agiardullo 已提交
1598 1599

          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
1600
                                 *next_sequence);
1601
        }
J
jorlow@chromium.org 已提交
1602 1603 1604
      }
    }

1605
    if (!status.ok()) {
K
krad 已提交
1606
      if (db_options_.wal_recovery_mode ==
1607 1608 1609 1610
             WALRecoveryMode::kSkipAnyCorruptedRecords) {
        // We should ignore all errors unconditionally
        status = Status::OK();
      } else if (db_options_.wal_recovery_mode ==
K
krad 已提交
1611 1612 1613
                 WALRecoveryMode::kPointInTimeRecovery) {
        // We should ignore the error but not continue replaying
        status = Status::OK();
1614
        stop_replay_for_corruption = true;
K
krad 已提交
1615 1616
        Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
            "Point in time recovered to log #%" PRIu64 " seq #%" PRIu64,
1617
            log_number, *next_sequence);
1618 1619 1620 1621 1622
      } else {
        assert(db_options_.wal_recovery_mode ==
                  WALRecoveryMode::kTolerateCorruptedTailRecords
               || db_options_.wal_recovery_mode ==
                  WALRecoveryMode::kAbsoluteConsistency);
K
krad 已提交
1623 1624
        return status;
      }
1625 1626
    }

I
Igor Canadi 已提交
1627
    flush_scheduler_.Clear();
1628 1629 1630 1631
    auto last_sequence = *next_sequence - 1;
    if ((*next_sequence != kMaxSequenceNumber) &&
        (versions_->LastSequence() <= last_sequence)) {
      versions_->SetLastSequence(last_sequence);
S
Stanislau Hlebik 已提交
1632
    }
1633 1634
  }

1635
  if (!read_only) {
1636 1637
    // 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 已提交
1638
    auto max_log_number = log_numbers.back();
1639
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1640
      auto iter = version_edits.find(cfd->GetID());
1641 1642 1643
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

S
Stanislau Hlebik 已提交
1644
      if (cfd->GetLogNumber() > max_log_number) {
1645
        // Column family cfd has already flushed the data
S
Stanislau Hlebik 已提交
1646
        // from all logs. Memtable has to be empty because
1647
        // we filter the updates based on log_number
1648
        // (in WriteBatch::InsertInto)
1649 1650 1651 1652 1653 1654 1655
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
        // If flush happened in the middle of recovery (e.g. due to memtable
        // being full), we flush at the end. Otherwise we'll need to record
        // where we were on last flush, which make the logic complicated.
        if (flushed || !db_options_.avoid_flush_during_recovery) {
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
          if (!status.ok()) {
            // Recovery failed
            break;
          }
          flushed = true;
A
agiardullo 已提交
1666

1667 1668 1669
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 *next_sequence);
        }
1670
      }
J
jorlow@chromium.org 已提交
1671

1672
      // write MANIFEST with update
S
Stanislau Hlebik 已提交
1673
      // writing log_number in the manifest means that any log file
1674 1675
      // with number strongly less than (log_number + 1) is already
      // recovered and should be ignored on next reincarnation.
S
Stanislau Hlebik 已提交
1676 1677
      // Since we already recovered max_log_number, we want all logs
      // with numbers `<= max_log_number` (includes this one) to be ignored
1678 1679 1680
      if (flushed) {
        edit->SetLogNumber(max_log_number + 1);
      }
1681 1682 1683
      // 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 已提交
1684
      // log number
1685
      versions_->MarkFileNumberUsedDuringRecovery(max_log_number + 1);
1686 1687
      status = versions_->LogAndApply(
          cfd, *cfd->GetLatestMutableCFOptions(), edit, &mutex_);
1688
      if (!status.ok()) {
S
Stanislau Hlebik 已提交
1689 1690
        // Recovery failed
        break;
1691 1692
      }
    }
1693
  }
I
Igor Canadi 已提交
1694

1695 1696 1697
  event_logger_.Log() << "job" << job_id << "event"
                      << "recovery_finished";

J
jorlow@chromium.org 已提交
1698 1699 1700
  return status;
}

1701 1702
Status DBImpl::WriteLevel0TableForRecovery(int job_id, ColumnFamilyData* cfd,
                                           MemTable* mem, VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1703
  mutex_.AssertHeld();
1704
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1705
  FileMetaData meta;
I
Igor Canadi 已提交
1706 1707
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();
1708
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
1709 1710
  ReadOptions ro;
  ro.total_order_seek = true;
1711
  Arena arena;
1712
  Status s;
1713
  TableProperties table_properties;
1714
  {
1715
    ScopedArenaIterator iter(mem->NewIterator(ro, &arena));
1716 1717 1718
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
        "[%s] [WriteLevel0TableForRecovery]"
        " Level-0 table #%" PRIu64 ": started",
1719
        cfd->GetName().c_str(), meta.fd.GetNumber());
1720

A
Aaron Gao 已提交
1721 1722 1723
    // Get the latest mutable cf options while the mutex is still locked
    const MutableCFOptions mutable_cf_options =
        *cfd->GetLatestMutableCFOptions();
1724 1725
    bool paranoid_file_checks =
        cfd->GetLatestMutableCFOptions()->paranoid_file_checks;
1726 1727
    {
      mutex_.Unlock();
1728 1729 1730 1731 1732

      SequenceNumber earliest_write_conflict_snapshot;
      std::vector<SequenceNumber> snapshot_seqs =
          snapshots_.GetAll(&earliest_write_conflict_snapshot);

1733
      s = BuildTable(
A
Aaron Gao 已提交
1734 1735
          dbname_, env_, *cfd->ioptions(), mutable_cf_options, env_options_,
          cfd->table_cache(), iter.get(), &meta, cfd->internal_comparator(),
1736 1737
          cfd->int_tbl_prop_collector_factories(), cfd->GetID(), cfd->GetName(),
          snapshot_seqs, earliest_write_conflict_snapshot,
A
Aaron Gao 已提交
1738
          GetCompressionFlush(*cfd->ioptions(), mutable_cf_options),
1739
          cfd->ioptions()->compression_opts, paranoid_file_checks,
1740 1741
          cfd->internal_stats(), TableFileCreationReason::kRecovery,
          &event_logger_, job_id);
1742
      LogFlush(db_options_.info_log);
1743 1744 1745 1746 1747
      Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
          "[%s] [WriteLevel0TableForRecovery]"
          " Level-0 table #%" PRIu64 ": %" PRIu64 " bytes %s",
          cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
          s.ToString().c_str());
1748 1749
      mutex_.Lock();
    }
1750
  }
I
Igor Canadi 已提交
1751
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
1752 1753 1754 1755

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1756
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1757 1758
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
1759 1760
                  meta.smallest_seqno, meta.largest_seqno,
                  meta.marked_for_compaction);
1761 1762
  }

L
Lei Jin 已提交
1763
  InternalStats::CompactionStats stats(1);
1764
  stats.micros = env_->NowMicros() - start_micros;
1765
  stats.bytes_written = meta.fd.GetFileSize();
1766
  stats.num_output_files = 1;
1767
  cfd->internal_stats()->AddCompactionStats(level, stats);
1768 1769
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1770
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1771 1772 1773
  return s;
}

1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816
Status DBImpl::SyncClosedLogs(JobContext* job_context) {
  mutex_.AssertHeld();
  autovector<log::Writer*, 1> logs_to_sync;
  uint64_t current_log_number = logfile_number_;
  while (logs_.front().number < current_log_number &&
         logs_.front().getting_synced) {
    log_sync_cv_.Wait();
  }
  for (auto it = logs_.begin();
       it != logs_.end() && it->number < current_log_number; ++it) {
    auto& log = *it;
    assert(!log.getting_synced);
    log.getting_synced = true;
    logs_to_sync.push_back(log.writer);
  }

  Status s;
  if (!logs_to_sync.empty()) {
    mutex_.Unlock();

    for (log::Writer* log : logs_to_sync) {
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
          "[JOB %d] Syncing log #%" PRIu64, job_context->job_id,
          log->get_log_number());
      s = log->file()->Sync(db_options_.use_fsync);
    }
    if (s.ok()) {
      s = directories_.GetWalDir()->Fsync();
    }

    mutex_.Lock();

    // "number <= current_log_number - 1" is equivalent to
    // "number < current_log_number".
    MarkLogsSynced(current_log_number - 1, true, s);
    if (!s.ok()) {
      bg_error_ = s;
      return s;
    }
  }
  return s;
}

1817 1818
Status DBImpl::FlushMemTableToOutputFile(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
1819
    bool* made_progress, JobContext* job_context, LogBuffer* log_buffer) {
1820
  mutex_.AssertHeld();
1821
  assert(cfd->imm()->NumNotFlushed() != 0);
1822
  assert(cfd->imm()->IsFlushPending());
1823

1824 1825 1826 1827
  SequenceNumber earliest_write_conflict_snapshot;
  std::vector<SequenceNumber> snapshot_seqs =
      snapshots_.GetAll(&earliest_write_conflict_snapshot);

A
Aaron Gao 已提交
1828 1829 1830 1831 1832 1833 1834
  FlushJob flush_job(
      dbname_, cfd, db_options_, mutable_cf_options, env_options_,
      versions_.get(), &mutex_, &shutting_down_, snapshot_seqs,
      earliest_write_conflict_snapshot, job_context, log_buffer,
      directories_.GetDbDir(), directories_.GetDataDir(0U),
      GetCompressionFlush(*cfd->ioptions(), mutable_cf_options), stats_,
      &event_logger_, mutable_cf_options.report_bg_io_stats);
1835

1836
  FileMetaData file_meta;
1837

1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852
  flush_job.PickMemTable();

  Status s;
  if (logfile_number_ > 0 &&
      versions_->GetColumnFamilySet()->NumberOfColumnFamilies() > 0 &&
      !db_options_.disableDataSync) {
    // If there are more than one column families, we need to make sure that
    // all the log files except the most recent one are synced. Otherwise if
    // the host crashes after flushing and before WAL is persistent, the
    // flushed SST may contain data from write batches whose updates to
    // other column families are missing.
    // SyncClosedLogs() may unlock and re-lock the db_mutex.
    s = SyncClosedLogs(job_context);
  }

1853 1854 1855 1856 1857 1858
  // Within flush_job.Run, rocksdb may call event listener to notify
  // file creation and deletion.
  //
  // Note that flush_job.Run will unlock and lock the db_mutex,
  // and EventListener callback will be called when the db_mutex
  // is unlocked by the current thread.
1859 1860 1861
  if (s.ok()) {
    s = flush_job.Run(&file_meta);
  }
J
jorlow@chromium.org 已提交
1862 1863

  if (s.ok()) {
I
Igor Canadi 已提交
1864 1865
    InstallSuperVersionAndScheduleWorkWrapper(cfd, job_context,
                                              mutable_cf_options);
1866 1867
    if (made_progress) {
      *made_progress = 1;
1868
    }
S
sdong 已提交
1869
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Igor Canadi 已提交
1870
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
S
sdong 已提交
1871
                cfd->current()->storage_info()->LevelSummary(&tmp));
J
jorlow@chromium.org 已提交
1872
  }
1873

1874
  if (!s.ok() && !s.IsShutdownInProgress() && db_options_.paranoid_checks &&
1875 1876 1877 1878 1879
      bg_error_.ok()) {
    // if a bad error happened (not ShutdownInProgress) and paranoid_checks is
    // true, mark DB read-only
    bg_error_ = s;
  }
1880
  if (s.ok()) {
1881
#ifndef ROCKSDB_LITE
1882
    // may temporarily unlock and lock the mutex.
1883
    NotifyOnFlushCompleted(cfd, &file_meta, mutable_cf_options,
1884
                           job_context->job_id, flush_job.GetTableProperties());
1885
#endif  // ROCKSDB_LITE
1886 1887 1888 1889 1890 1891 1892
    auto sfm =
        static_cast<SstFileManagerImpl*>(db_options_.sst_file_manager.get());
    if (sfm) {
      // Notify sst_file_manager that a new file was added
      std::string file_path = MakeTableFileName(db_options_.db_paths[0].path,
                                                file_meta.fd.GetNumber());
      sfm->OnAddFile(file_path);
1893 1894 1895 1896 1897
      if (sfm->IsMaxAllowedSpaceReached() && bg_error_.ok()) {
        bg_error_ = Status::IOError("Max allowed space was reached");
        TEST_SYNC_POINT(
            "DBImpl::FlushMemTableToOutputFile:MaxAllowedSpaceReached");
      }
1898
    }
1899
  }
J
jorlow@chromium.org 已提交
1900 1901 1902
  return s;
}

1903 1904 1905 1906
void DBImpl::NotifyOnFlushCompleted(ColumnFamilyData* cfd,
                                    FileMetaData* file_meta,
                                    const MutableCFOptions& mutable_cf_options,
                                    int job_id, TableProperties prop) {
1907
#ifndef ROCKSDB_LITE
1908
  if (db_options_.listeners.size() == 0U) {
1909 1910
    return;
  }
1911 1912 1913 1914
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
1915
  bool triggered_writes_slowdown =
1916
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
1917
       mutable_cf_options.level0_slowdown_writes_trigger);
1918
  bool triggered_writes_stop =
1919
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
1920
       mutable_cf_options.level0_stop_writes_trigger);
1921 1922
  // release lock while notifying events
  mutex_.Unlock();
1923
  {
1924 1925 1926 1927 1928
    FlushJobInfo info;
    info.cf_name = cfd->GetName();
    // TODO(yhchiang): make db_paths dynamic in case flush does not
    //                 go to L0 in the future.
    info.file_path = MakeTableFileName(db_options_.db_paths[0].path,
1929
                                       file_meta->fd.GetNumber());
1930
    info.thread_id = env_->GetThreadID();
1931 1932 1933
    info.job_id = job_id;
    info.triggered_writes_slowdown = triggered_writes_slowdown;
    info.triggered_writes_stop = triggered_writes_stop;
1934 1935
    info.smallest_seqno = file_meta->smallest_seqno;
    info.largest_seqno = file_meta->largest_seqno;
1936
    info.table_properties = prop;
1937
    for (auto listener : db_options_.listeners) {
1938
      listener->OnFlushCompleted(this, info);
1939 1940
    }
  }
1941 1942 1943
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
1944
#endif  // ROCKSDB_LITE
1945 1946
}

1947 1948 1949 1950
Status DBImpl::CompactRange(const CompactRangeOptions& options,
                            ColumnFamilyHandle* column_family,
                            const Slice* begin, const Slice* end) {
  if (options.target_path_id >= db_options_.db_paths.size()) {
1951 1952 1953
    return Status::InvalidArgument("Invalid target path ID");
  }

1954 1955
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
1956
  bool exclusive = options.exclusive_manual_compaction;
I
Igor Canadi 已提交
1957 1958

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
1959
  if (!s.ok()) {
1960
    LogFlush(db_options_.info_log);
L
Lei Jin 已提交
1961 1962 1963
    return s;
  }

I
Igor Canadi 已提交
1964
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
1965
  {
1966
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
1967
    Version* base = cfd->current();
1968 1969
    for (int level = 1; level < base->storage_info()->num_non_empty_levels();
         level++) {
S
sdong 已提交
1970
      if (base->storage_info()->OverlapInLevel(level, begin, end)) {
G
Gabor Cselle 已提交
1971 1972 1973 1974
        max_level_with_files = level;
      }
    }
  }
1975

1976
  int final_output_level = 0;
1977 1978 1979 1980
  if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal &&
      cfd->NumberLevels() > 1) {
    // Always compact all files together.
    s = RunManualCompaction(cfd, ColumnFamilyData::kCompactAllLevels,
1981
                            cfd->NumberLevels() - 1, options.target_path_id,
1982
                            begin, end, exclusive);
1983
    final_output_level = cfd->NumberLevels() - 1;
1984 1985
  } else {
    for (int level = 0; level <= max_level_with_files; level++) {
1986
      int output_level;
A
Andres Notzli 已提交
1987
      // in case the compaction is universal or if we're compacting the
1988 1989 1990 1991
      // 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)
      if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
1992 1993 1994
          cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
        output_level = level;
      } else if (level == max_level_with_files && level > 0) {
1995 1996 1997 1998 1999 2000 2001
        if (options.bottommost_level_compaction ==
            BottommostLevelCompaction::kSkip) {
          // Skip bottommost level compaction
          continue;
        } else if (options.bottommost_level_compaction ==
                       BottommostLevelCompaction::kIfHaveCompactionFilter &&
                   cfd->ioptions()->compaction_filter == nullptr &&
I
Igor Canadi 已提交
2002
                   cfd->ioptions()->compaction_filter_factory == nullptr) {
A
Andres Notzli 已提交
2003 2004
          // Skip bottommost level compaction since we don't have a compaction
          // filter
2005 2006
          continue;
        }
2007
        output_level = level;
2008
      } else {
2009
        output_level = level + 1;
2010 2011 2012 2013 2014
        if (cfd->ioptions()->compaction_style == kCompactionStyleLevel &&
            cfd->ioptions()->level_compaction_dynamic_level_bytes &&
            level == 0) {
          output_level = ColumnFamilyData::kCompactToBaseLevel;
        }
2015
      }
2016
      s = RunManualCompaction(cfd, level, output_level, options.target_path_id,
2017
                              begin, end, exclusive);
2018 2019 2020
      if (!s.ok()) {
        break;
      }
2021 2022 2023 2024 2025
      if (output_level == ColumnFamilyData::kCompactToBaseLevel) {
        final_output_level = cfd->NumberLevels() - 1;
      } else if (output_level > final_output_level) {
        final_output_level = output_level;
      }
2026 2027
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::1");
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::2");
2028
    }
G
Gabor Cselle 已提交
2029
  }
2030 2031 2032 2033
  if (!s.ok()) {
    LogFlush(db_options_.info_log);
    return s;
  }
2034

2035
  if (options.change_level) {
2036 2037 2038 2039 2040 2041 2042
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "[RefitLevel] waiting for background threads to stop");
    s = PauseBackgroundWork();
    if (s.ok()) {
      s = ReFitLevel(cfd, final_output_level, options.target_level);
    }
    ContinueBackgroundWork();
2043
  }
2044
  LogFlush(db_options_.info_log);
L
Lei Jin 已提交
2045

2046
  {
2047
    InstrumentedMutexLock l(&mutex_);
2048 2049 2050 2051 2052
    // an automatic compaction that has been scheduled might have been
    // preempted by the manual compactions. Need to schedule it back.
    MaybeScheduleFlushOrCompaction();
  }

L
Lei Jin 已提交
2053
  return s;
2054 2055
}

2056 2057 2058 2059 2060
Status DBImpl::CompactFiles(
    const CompactionOptions& compact_options,
    ColumnFamilyHandle* column_family,
    const std::vector<std::string>& input_file_names,
    const int output_level, const int output_path_id) {
I
Igor Canadi 已提交
2061 2062 2063 2064
#ifdef ROCKSDB_LITE
    // not supported in lite version
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
2065 2066 2067 2068 2069 2070
  if (column_family == nullptr) {
    return Status::InvalidArgument("ColumnFamilyHandle must be non-null.");
  }

  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  assert(cfd);
2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095

  Status s;
  JobContext job_context(0, true);
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
                       db_options_.info_log.get());

  // Perform CompactFiles
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
  {
    InstrumentedMutexLock l(&mutex_);

    s = CompactFilesImpl(compact_options, cfd, sv->current,
                         input_file_names, output_level,
                         output_path_id, &job_context, &log_buffer);
  }
  ReturnAndCleanupSuperVersion(cfd, sv);

  // Find and delete obsolete files
  {
    InstrumentedMutexLock l(&mutex_);
    // If !s.ok(), this means that Compaction failed. In that case, we want
    // to delete all obsolete files we might have created and we force
    // FindObsoleteFiles(). This is because job_context does not
    // catch all created files if compaction failed.
    FindObsoleteFiles(&job_context, !s.ok());
2096
  }  // release the mutex
2097 2098 2099 2100 2101 2102 2103 2104 2105 2106

  // delete unnecessary files if any, this is done outside the mutex
  if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
    // 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.
    log_buffer.FlushBufferToLog();
    if (job_context.HaveSomethingToDelete()) {
2107
      // no mutex is locked here.  No need to Unlock() and Lock() here.
2108 2109 2110 2111 2112
      PurgeObsoleteFiles(job_context);
    }
    job_context.Clean();
  }

2113
  return s;
I
Igor Canadi 已提交
2114
#endif  // ROCKSDB_LITE
2115 2116
}

I
Igor Canadi 已提交
2117
#ifndef ROCKSDB_LITE
2118 2119 2120
Status DBImpl::CompactFilesImpl(
    const CompactionOptions& compact_options, ColumnFamilyData* cfd,
    Version* version, const std::vector<std::string>& input_file_names,
2121 2122
    const int output_level, int output_path_id, JobContext* job_context,
    LogBuffer* log_buffer) {
2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154
  mutex_.AssertHeld();

  if (shutting_down_.load(std::memory_order_acquire)) {
    return Status::ShutdownInProgress();
  }

  std::unordered_set<uint64_t> input_set;
  for (auto file_name : input_file_names) {
    input_set.insert(TableFileNameToNumber(file_name));
  }

  ColumnFamilyMetaData cf_meta;
  // TODO(yhchiang): can directly use version here if none of the
  // following functions call is pluggable to external developers.
  version->GetColumnFamilyMetaData(&cf_meta);

  if (output_path_id < 0) {
    if (db_options_.db_paths.size() == 1U) {
      output_path_id = 0;
    } else {
      return Status::NotSupported(
          "Automatic output path selection is not "
          "yet supported in CompactFiles()");
    }
  }

  Status s = cfd->compaction_picker()->SanitizeCompactionInputFiles(
      &input_set, cf_meta, output_level);
  if (!s.ok()) {
    return s;
  }

2155
  std::vector<CompactionInputFiles> input_files;
2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175
  s = cfd->compaction_picker()->GetCompactionInputsFromFileNumbers(
      &input_files, &input_set, version->storage_info(), compact_options);
  if (!s.ok()) {
    return s;
  }

  for (auto inputs : input_files) {
    if (cfd->compaction_picker()->FilesInCompaction(inputs.files)) {
      return Status::Aborted(
          "Some of the necessary compaction input "
          "files are already being compacted");
    }
  }

  // At this point, CompactFiles will be run.
  bg_compaction_scheduled_++;

  unique_ptr<Compaction> c;
  assert(cfd->compaction_picker());
  c.reset(cfd->compaction_picker()->FormCompaction(
2176 2177
      compact_options, input_files, output_level, version->storage_info(),
      *cfd->GetLatestMutableCFOptions(), output_path_id));
2178 2179 2180
  if (!c) {
    return Status::Aborted("Another Level 0 compaction is running");
  }
2181 2182
  c->SetInputVersion(version);
  // deletion compaction currently not allowed in CompactFiles.
2183
  assert(!c->deletion_compaction());
2184
  running_compactions_.insert(c.get());
2185

2186 2187 2188 2189
  SequenceNumber earliest_write_conflict_snapshot;
  std::vector<SequenceNumber> snapshot_seqs =
      snapshots_.GetAll(&earliest_write_conflict_snapshot);

2190 2191 2192
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();

I
Igor Canadi 已提交
2193
  assert(is_snapshot_supported_ || snapshots_.empty());
2194
  CompactionJob compaction_job(
I
Igor Canadi 已提交
2195 2196
      job_context->job_id, c.get(), db_options_, env_options_, versions_.get(),
      &shutting_down_, log_buffer, directories_.GetDbDir(),
2197 2198 2199
      directories_.GetDataDir(c->output_path_id()), stats_, &mutex_, &bg_error_,
      snapshot_seqs, earliest_write_conflict_snapshot, table_cache_,
      &event_logger_, c->mutable_cf_options()->paranoid_file_checks,
2200
      c->mutable_cf_options()->report_bg_io_stats, dbname_,
2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213
      nullptr);  // Here we pass a nullptr for CompactionJobStats because
                 // CompactFiles does not trigger OnCompactionCompleted(),
                 // which is the only place where CompactionJobStats is
                 // returned.  The idea of not triggering OnCompationCompleted()
                 // is that CompactFiles runs in the caller thread, so the user
                 // should always know when it completes.  As a result, it makes
                 // less sense to notify the users something they should already
                 // know.
                 //
                 // In the future, if we would like to add CompactionJobStats
                 // support for CompactFiles, we should have CompactFiles API
                 // pass a pointer of CompactionJobStats as the out-value
                 // instead of using EventListener.
2214 2215 2216 2217 2218

  // Creating a compaction influences the compaction score because the score
  // takes running compactions into account (by skipping files that are already
  // being compacted). Since we just changed compaction score, we recalculate it
  // here.
2219
  version->storage_info()->ComputeCompactionScore(*c->mutable_cf_options());
2220

2221 2222 2223
  compaction_job.Prepare();

  mutex_.Unlock();
2224 2225
  TEST_SYNC_POINT("CompactFilesImpl:0");
  TEST_SYNC_POINT("CompactFilesImpl:1");
2226
  compaction_job.Run();
2227 2228
  TEST_SYNC_POINT("CompactFilesImpl:2");
  TEST_SYNC_POINT("CompactFilesImpl:3");
2229
  mutex_.Lock();
2230

2231
  Status status = compaction_job.Install(*c->mutable_cf_options());
2232
  if (status.ok()) {
I
Igor Canadi 已提交
2233 2234
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
2235 2236 2237
  }
  c->ReleaseCompactionFiles(s);

2238
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
2239

2240 2241
  running_compactions_.erase(c.get());

2242 2243 2244 2245 2246
  if (status.ok()) {
    // Done
  } else if (status.IsShutdownInProgress()) {
    // Ignore compaction errors found during shutting down
  } else {
2247 2248
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
        "[%s] [JOB %d] Compaction error: %s",
2249
        c->column_family_data()->GetName().c_str(), job_context->job_id,
2250 2251 2252 2253 2254 2255
        status.ToString().c_str());
    if (db_options_.paranoid_checks && bg_error_.ok()) {
      bg_error_ = status;
    }
  }

2256 2257
  c.reset();

2258
  bg_compaction_scheduled_--;
2259 2260 2261
  if (bg_compaction_scheduled_ == 0) {
    bg_cv_.SignalAll();
  }
2262 2263 2264

  return status;
}
I
Igor Canadi 已提交
2265
#endif  // ROCKSDB_LITE
2266

2267 2268
Status DBImpl::PauseBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
2269
  bg_compaction_paused_++;
2270 2271 2272
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_ > 0) {
    bg_cv_.Wait();
  }
2273
  bg_work_paused_++;
2274 2275 2276 2277 2278
  return Status::OK();
}

Status DBImpl::ContinueBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
2279 2280 2281
  if (bg_work_paused_ == 0) {
    return Status::InvalidArgument();
  }
2282
  assert(bg_work_paused_ > 0);
2283 2284
  assert(bg_compaction_paused_ > 0);
  bg_compaction_paused_--;
2285
  bg_work_paused_--;
2286 2287
  // It's sufficient to check just bg_work_paused_ here since
  // bg_work_paused_ is always no greater than bg_compaction_paused_
2288 2289 2290 2291 2292 2293
  if (bg_work_paused_ == 0) {
    MaybeScheduleFlushOrCompaction();
  }
  return Status::OK();
}

O
Ori Bernstein 已提交
2294
void DBImpl::NotifyOnCompactionCompleted(
2295 2296
    ColumnFamilyData* cfd, Compaction *c, const Status &st,
    const CompactionJobStats& compaction_job_stats,
2297
    const int job_id) {
O
Ori Bernstein 已提交
2298
#ifndef ROCKSDB_LITE
2299
  if (db_options_.listeners.size() == 0U) {
O
Ori Bernstein 已提交
2300 2301 2302 2303 2304 2305 2306 2307
    return;
  }
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
  // release lock while notifying events
  mutex_.Unlock();
2308
  TEST_SYNC_POINT("DBImpl::NotifyOnCompactionCompleted::UnlockMutex");
2309 2310 2311 2312
  {
    CompactionJobInfo info;
    info.cf_name = cfd->GetName();
    info.status = st;
2313
    info.thread_id = env_->GetThreadID();
2314 2315
    info.job_id = job_id;
    info.base_input_level = c->start_level();
2316
    info.output_level = c->output_level();
2317
    info.stats = compaction_job_stats;
2318
    info.table_properties = c->GetOutputTableProperties();
2319
    info.compaction_reason = c->compaction_reason();
2320
    info.compression = c->output_compression();
2321 2322
    for (size_t i = 0; i < c->num_input_levels(); ++i) {
      for (const auto fmd : *c->inputs(i)) {
2323 2324 2325 2326 2327
        auto fn = TableFileName(db_options_.db_paths, fmd->fd.GetNumber(),
                                fmd->fd.GetPathId());
        info.input_files.push_back(fn);
        if (info.table_properties.count(fn) == 0) {
          std::shared_ptr<const TableProperties> tp;
2328
          auto s = cfd->current()->GetTableProperties(&tp, fmd, &fn);
2329 2330 2331 2332
          if (s.ok()) {
            info.table_properties[fn] = tp;
          }
        }
2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344
      }
    }
    for (const auto newf : c->edit()->GetNewFiles()) {
      info.output_files.push_back(
          TableFileName(db_options_.db_paths,
                        newf.second.fd.GetNumber(),
                        newf.second.fd.GetPathId()));
    }
    for (auto listener : db_options_.listeners) {
      listener->OnCompactionCompleted(this, info);
    }
  }
O
Ori Bernstein 已提交
2345 2346 2347 2348 2349 2350
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
#endif  // ROCKSDB_LITE
}

2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364
bool DBImpl::NeedFlushOrCompaction(const MutableCFOptions& base_options,
                                   const MutableCFOptions& new_options) {
  return (base_options.disable_auto_compactions &&
          !new_options.disable_auto_compactions) ||
         base_options.level0_slowdown_writes_trigger <
             new_options.level0_slowdown_writes_trigger ||
         base_options.level0_stop_writes_trigger <
             new_options.level0_stop_writes_trigger ||
         base_options.soft_pending_compaction_bytes_limit <
             new_options.soft_pending_compaction_bytes_limit ||
         base_options.hard_pending_compaction_bytes_limit <
             new_options.hard_pending_compaction_bytes_limit;
}

2365
Status DBImpl::SetOptions(ColumnFamilyHandle* column_family,
2366
    const std::unordered_map<std::string, std::string>& options_map) {
I
Igor Canadi 已提交
2367 2368 2369
#ifdef ROCKSDB_LITE
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
L
Lei Jin 已提交
2370 2371
  auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  if (options_map.empty()) {
2372 2373
    Log(InfoLogLevel::WARN_LEVEL,
        db_options_.info_log, "SetOptions() on column family [%s], empty input",
L
Lei Jin 已提交
2374
        cfd->GetName().c_str());
2375
    return Status::InvalidArgument("empty input");
L
Lei Jin 已提交
2376 2377
  }

2378
  MutableCFOptions prev_options = *cfd->GetLatestMutableCFOptions();
L
Lei Jin 已提交
2379
  MutableCFOptions new_options;
2380
  Status s;
2381
  Status persist_options_status;
L
Lei Jin 已提交
2382
  {
2383
    InstrumentedMutexLock l(&mutex_);
2384 2385
    s = cfd->SetOptions(options_map);
    if (s.ok()) {
L
Lei Jin 已提交
2386
      new_options = *cfd->GetLatestMutableCFOptions();
2387 2388 2389 2390 2391 2392 2393 2394 2395
      if (NeedFlushOrCompaction(prev_options, new_options)) {
        // Trigger possible flush/compactions. This has to be before we persist
        // options to file, otherwise there will be a deadlock with writer
        // thread.
        auto* old_sv =
            InstallSuperVersionAndScheduleWork(cfd, nullptr, new_options);
        delete old_sv;
      }

2396 2397 2398 2399 2400 2401 2402
      // Persist RocksDB options under the single write thread
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);

      persist_options_status = WriteOptionsFile();

      write_thread_.ExitUnbatched(&w);
2403 2404
    }
  }
L
Lei Jin 已提交
2405

2406 2407
  Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
      "SetOptions() on column family [%s], inputs:",
L
Lei Jin 已提交
2408 2409
      cfd->GetName().c_str());
  for (const auto& o : options_map) {
2410 2411
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "%s: %s\n", o.first.c_str(), o.second.c_str());
L
Lei Jin 已提交
2412
  }
2413
  if (s.ok()) {
2414 2415
    Log(InfoLogLevel::INFO_LEVEL,
        db_options_.info_log, "[%s] SetOptions succeeded",
L
Lei Jin 已提交
2416 2417
        cfd->GetName().c_str());
    new_options.Dump(db_options_.info_log.get());
2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
    if (!persist_options_status.ok()) {
      if (db_options_.fail_if_options_file_error) {
        s = Status::IOError(
            "SetOptions succeeded, but unable to persist options",
            persist_options_status.ToString());
      }
      Warn(db_options_.info_log,
           "Unable to persist options in SetOptions() -- %s",
           persist_options_status.ToString().c_str());
    }
L
Lei Jin 已提交
2428
  } else {
2429 2430
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
        "[%s] SetOptions failed", cfd->GetName().c_str());
L
Lei Jin 已提交
2431
  }
S
sdong 已提交
2432
  LogFlush(db_options_.info_log);
2433
  return s;
I
Igor Canadi 已提交
2434
#endif  // ROCKSDB_LITE
2435 2436
}

2437
// return the same level if it cannot be moved
2438 2439
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd,
    const MutableCFOptions& mutable_cf_options, int level) {
2440
  mutex_.AssertHeld();
S
sdong 已提交
2441
  const auto* vstorage = cfd->current()->storage_info();
2442
  int minimum_level = level;
2443
  for (int i = level - 1; i > 0; --i) {
2444
    // stop if level i is not empty
S
sdong 已提交
2445
    if (vstorage->NumLevelFiles(i) > 0) break;
2446
    // stop if level i is too small (cannot fit the level files)
2447
    if (vstorage->MaxBytesForLevel(i) < vstorage->NumLevelBytes(level)) {
2448 2449
      break;
    }
2450 2451 2452 2453 2454 2455

    minimum_level = i;
  }
  return minimum_level;
}

2456 2457
// REQUIREMENT: block all background work by calling PauseBackgroundWork()
// before calling this function
I
Igor Canadi 已提交
2458 2459
Status DBImpl::ReFitLevel(ColumnFamilyData* cfd, int level, int target_level) {
  assert(level < cfd->NumberLevels());
2460 2461 2462
  if (target_level >= cfd->NumberLevels()) {
    return Status::InvalidArgument("Target level exceeds number of levels");
  }
2463

2464 2465 2466 2467
  std::unique_ptr<SuperVersion> superversion_to_free;
  std::unique_ptr<SuperVersion> new_superversion(new SuperVersion());

  Status status;
I
Igor Canadi 已提交
2468

I
Islam AbdelRahman 已提交
2469
  InstrumentedMutexLock guard_lock(&mutex_);
2470 2471 2472

  // only allow one thread refitting
  if (refitting_level_) {
2473 2474
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "[ReFitLevel] another thread is refitting");
L
Lei Jin 已提交
2475
    return Status::NotSupported("another thread is refitting");
2476 2477 2478
  }
  refitting_level_ = true;

2479
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
2480
  // move to a smaller level
2481 2482
  int to_level = target_level;
  if (target_level < 0) {
2483
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
2484
  }
2485

2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500
  auto* vstorage = cfd->current()->storage_info();
  if (to_level > level) {
    if (level == 0) {
      return Status::NotSupported(
          "Cannot change from level 0 to other levels.");
    }
    // Check levels are empty for a trivial move
    for (int l = level + 1; l <= to_level; l++) {
      if (vstorage->NumLevelFiles(l) > 0) {
        return Status::NotSupported(
            "Levels between source and target are not empty for a move.");
      }
    }
  }
  if (to_level != level) {
2501
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
2502 2503
        "[%s] Before refitting:\n%s", cfd->GetName().c_str(),
        cfd->current()->DebugString().data());
2504

2505
    VersionEdit edit;
I
Igor Canadi 已提交
2506
    edit.SetColumnFamily(cfd->GetID());
2507
    for (const auto& f : vstorage->LevelFiles(level)) {
2508
      edit.DeleteFile(level, f->fd.GetNumber());
2509 2510
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
2511 2512
                   f->smallest_seqno, f->largest_seqno,
                   f->marked_for_compaction);
2513
    }
2514
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
2515 2516
        "[%s] Apply version edit:\n%s", cfd->GetName().c_str(),
        edit.DebugString().data());
2517

2518 2519
    status = versions_->LogAndApply(cfd, mutable_cf_options, &edit, &mutex_,
                                    directories_.GetDbDir());
2520 2521
    superversion_to_free.reset(InstallSuperVersionAndScheduleWork(
        cfd, new_superversion.release(), mutable_cf_options));
2522

2523 2524
    Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
        "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
2525
        status.ToString().data());
2526 2527

    if (status.ok()) {
2528
      Log(InfoLogLevel::DEBUG_LEVEL, db_options_.info_log,
2529 2530
          "[%s] After refitting:\n%s", cfd->GetName().c_str(),
          cfd->current()->DebugString().data());
2531 2532 2533 2534
    }
  }

  refitting_level_ = false;
I
Igor Canadi 已提交
2535

L
Lei Jin 已提交
2536
  return status;
G
Gabor Cselle 已提交
2537 2538
}

2539 2540 2541
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
2542 2543
}

2544
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
2545
  return 0;
2546 2547
}

2548 2549
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
2550
  InstrumentedMutexLock l(&mutex_);
L
Lei Jin 已提交
2551 2552
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.level0_stop_writes_trigger;
2553 2554
}

L
Lei Jin 已提交
2555
Status DBImpl::Flush(const FlushOptions& flush_options,
2556 2557
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
2558
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
2559 2560
}

2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592
Status DBImpl::SyncWAL() {
  autovector<log::Writer*, 1> logs_to_sync;
  bool need_log_dir_sync;
  uint64_t current_log_number;

  {
    InstrumentedMutexLock l(&mutex_);
    assert(!logs_.empty());

    // This SyncWAL() call only cares about logs up to this number.
    current_log_number = logfile_number_;

    while (logs_.front().number <= current_log_number &&
           logs_.front().getting_synced) {
      log_sync_cv_.Wait();
    }
    // First check that logs are safe to sync in background.
    for (auto it = logs_.begin();
         it != logs_.end() && it->number <= current_log_number; ++it) {
      if (!it->writer->file()->writable_file()->IsSyncThreadSafe()) {
        return Status::NotSupported(
          "SyncWAL() is not supported for this implementation of WAL file",
          db_options_.allow_mmap_writes
            ? "try setting Options::allow_mmap_writes to false"
            : Slice());
      }
    }
    for (auto it = logs_.begin();
         it != logs_.end() && it->number <= current_log_number; ++it) {
      auto& log = *it;
      assert(!log.getting_synced);
      log.getting_synced = true;
2593
      logs_to_sync.push_back(log.writer);
2594 2595 2596 2597 2598
    }

    need_log_dir_sync = !log_dir_synced_;
  }

2599
  RecordTick(stats_, WAL_FILE_SYNCED);
2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610
  Status status;
  for (log::Writer* log : logs_to_sync) {
    status = log->file()->SyncWithoutFlush(db_options_.use_fsync);
    if (!status.ok()) {
      break;
    }
  }
  if (status.ok() && need_log_dir_sync) {
    status = directories_.GetWalDir()->Fsync();
  }

2611
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:1");
2612 2613 2614 2615
  {
    InstrumentedMutexLock l(&mutex_);
    MarkLogsSynced(current_log_number, need_log_dir_sync, status);
  }
2616
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:2");
2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632

  return status;
}

void DBImpl::MarkLogsSynced(
    uint64_t up_to, bool synced_dir, const Status& status) {
  mutex_.AssertHeld();
  if (synced_dir &&
      logfile_number_ == up_to &&
      status.ok()) {
    log_dir_synced_ = true;
  }
  for (auto it = logs_.begin(); it != logs_.end() && it->number <= up_to;) {
    auto& log = *it;
    assert(log.getting_synced);
    if (status.ok() && logs_.size() > 1) {
2633
      logs_to_free_.push_back(log.ReleaseWriter());
A
Andres Noetzli 已提交
2634
      it = logs_.erase(it);
2635 2636 2637 2638 2639
    } else {
      log.getting_synced = false;
      ++it;
    }
  }
2640 2641
  assert(logs_.empty() || logs_[0].number > up_to ||
         (logs_.size() == 1 && !logs_[0].getting_synced));
2642 2643 2644
  log_sync_cv_.SignalAll();
}

2645
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
2646 2647 2648
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
2649
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
2650
                                   int output_level, uint32_t output_path_id,
2651
                                   const Slice* begin, const Slice* end,
2652
                                   bool exclusive, bool disallow_trivial_move) {
2653 2654
  assert(input_level == ColumnFamilyData::kCompactAllLevels ||
         input_level >= 0);
2655

G
Gabor Cselle 已提交
2656
  InternalKey begin_storage, end_storage;
2657
  CompactionArg* ca;
G
Gabor Cselle 已提交
2658

2659 2660
  bool scheduled = false;
  bool manual_conflict = false;
H
hans@chromium.org 已提交
2661
  ManualCompaction manual;
I
Igor Canadi 已提交
2662
  manual.cfd = cfd;
2663 2664
  manual.input_level = input_level;
  manual.output_level = output_level;
2665
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
2666
  manual.done = false;
2667
  manual.in_progress = false;
2668 2669
  manual.incomplete = false;
  manual.exclusive = exclusive;
2670
  manual.disallow_trivial_move = disallow_trivial_move;
2671 2672 2673
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
2674 2675
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2676
    manual.begin = nullptr;
G
Gabor Cselle 已提交
2677
  } else {
2678
    begin_storage.SetMaxPossibleForUserKey(*begin);
G
Gabor Cselle 已提交
2679 2680
    manual.begin = &begin_storage;
  }
2681
  if (end == nullptr ||
2682 2683
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2684
    manual.end = nullptr;
G
Gabor Cselle 已提交
2685
  } else {
2686
    end_storage.SetMinPossibleForUserKey(*end);
G
Gabor Cselle 已提交
2687 2688 2689
    manual.end = &end_storage;
  }

2690
  InstrumentedMutexLock l(&mutex_);
2691

2692 2693 2694 2695 2696
  // 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.
  //
2697
  // HasPendingManualCompaction() is true when at least one thread is inside
2698
  // RunManualCompaction(), i.e. during that time no other compaction will
2699 2700 2701
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
2702
  // RunManualCompaction() from getting to the second while loop below.
2703 2704 2705
  // However, only one of them will actually schedule compaction, while
  // others will wait on a condition variable until it completes.

2706 2707 2708 2709 2710 2711 2712 2713 2714 2715
  AddManualCompaction(&manual);
  TEST_SYNC_POINT_CALLBACK("DBImpl::RunManualCompaction:NotScheduled", &mutex_);
  if (exclusive) {
    while (bg_compaction_scheduled_ > 0) {
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
          "[%s] Manual compaction waiting for all other scheduled background "
          "compactions to finish",
          cfd->GetName().c_str());
      bg_cv_.Wait();
    }
2716
  }
2717

2718 2719
  Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
      "[%s] Manual compaction starting",
I
Igor Canadi 已提交
2720
      cfd->GetName().c_str());
2721

2722 2723 2724 2725
  // 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) {
2726 2727
    assert(HasPendingManualCompaction());
    manual_conflict = false;
2728
    if (ShouldntRunManualCompaction(&manual) || (manual.in_progress == true) ||
2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739
        scheduled ||
        ((manual.manual_end = &manual.tmp_storage1)&&(
             (manual.compaction = manual.cfd->CompactRange(
                  *manual.cfd->GetLatestMutableCFOptions(), manual.input_level,
                  manual.output_level, manual.output_path_id, manual.begin,
                  manual.end, &manual.manual_end, &manual_conflict)) ==
             nullptr) &&
         manual_conflict)) {
      // exclusive manual compactions should not see a conflict during
      // CompactRange
      assert(!exclusive || !manual_conflict);
2740
      // Running either this or some other manual compaction
G
Gabor Cselle 已提交
2741
      bg_cv_.Wait();
2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756
      if (scheduled && manual.incomplete == true) {
        assert(!manual.in_progress);
        scheduled = false;
        manual.incomplete = false;
      }
    } else if (!scheduled) {
      if (manual.compaction == nullptr) {
        manual.done = true;
        bg_cv_.SignalAll();
        continue;
      }
      ca = new CompactionArg;
      ca->db = this;
      ca->m = &manual;
      manual.incomplete = false;
2757
      bg_compaction_scheduled_++;
2758 2759 2760
      env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                     &DBImpl::UnscheduleCallback);
      scheduled = true;
G
Gabor Cselle 已提交
2761
    }
H
hans@chromium.org 已提交
2762
  }
2763

2764
  assert(!manual.in_progress);
2765 2766
  assert(HasPendingManualCompaction());
  RemoveManualCompaction(&manual);
2767
  bg_cv_.SignalAll();
L
Lei Jin 已提交
2768
  return manual.status;
J
jorlow@chromium.org 已提交
2769 2770
}

2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787
InternalIterator* DBImpl::NewInternalIterator(
    Arena* arena, ColumnFamilyHandle* column_family) {
  ColumnFamilyData* cfd;
  if (column_family == nullptr) {
    cfd = default_cf_handle_->cfd();
  } else {
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
    cfd = cfh->cfd();
  }

  mutex_.Lock();
  SuperVersion* super_version = cfd->GetSuperVersion()->Ref();
  mutex_.Unlock();
  ReadOptions roptions;
  return NewInternalIterator(roptions, cfd, super_version, arena);
}

2788
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
L
Lei Jin 已提交
2789
                             const FlushOptions& flush_options) {
S
Stanislau Hlebik 已提交
2790 2791 2792
  Status s;
  {
    WriteContext context;
2793
    InstrumentedMutexLock guard_lock(&mutex_);
2794

2795
    if (cfd->imm()->NumNotFlushed() == 0 && cfd->mem()->IsEmpty()) {
2796 2797 2798 2799
      // Nothing to flush
      return Status::OK();
    }

2800 2801
    WriteThread::Writer w;
    write_thread_.EnterUnbatched(&w, &mutex_);
S
Stanislau Hlebik 已提交
2802

I
Igor Canadi 已提交
2803
    // SwitchMemtable() will release and reacquire mutex
S
Stanislau Hlebik 已提交
2804
    // during execution
I
Igor Canadi 已提交
2805
    s = SwitchMemtable(cfd, &context);
2806
    write_thread_.ExitUnbatched(&w);
2807

S
Stanislau Hlebik 已提交
2808 2809
    cfd->imm()->FlushRequested();

2810 2811 2812
    // schedule flush
    SchedulePendingFlush(cfd);
    MaybeScheduleFlushOrCompaction();
S
Stanislau Hlebik 已提交
2813
  }
S
Stanislau Hlebik 已提交
2814

L
Lei Jin 已提交
2815
  if (s.ok() && flush_options.wait) {
2816
    // Wait until the compaction completes
2817
    s = WaitForFlushMemTable(cfd);
2818 2819
  }
  return s;
J
jorlow@chromium.org 已提交
2820 2821
}

2822
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
2823 2824
  Status s;
  // Wait until the compaction completes
2825
  InstrumentedMutexLock l(&mutex_);
2826
  while (cfd->imm()->NumNotFlushed() > 0 && bg_error_.ok()) {
2827 2828 2829
    if (shutting_down_.load(std::memory_order_acquire)) {
      return Status::ShutdownInProgress();
    }
2830 2831
    bg_cv_.Wait();
  }
2832
  if (!bg_error_.ok()) {
2833 2834 2835
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
2836 2837
}

2838 2839 2840 2841
Status DBImpl::EnableAutoCompaction(
    const std::vector<ColumnFamilyHandle*>& column_family_handles) {
  Status s;
  for (auto cf_ptr : column_family_handles) {
2842 2843
    Status status =
        this->SetOptions(cf_ptr, {{"disable_auto_compactions", "false"}});
2844
    if (!status.ok()) {
2845
      s = status;
2846 2847 2848 2849 2850 2851
    }
  }

  return s;
}

2852
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
2853
  mutex_.AssertHeld();
2854 2855 2856 2857
  if (!opened_successfully_) {
    // Compaction may introduce data race to DB open
    return;
  }
2858 2859
  if (bg_work_paused_ > 0) {
    // we paused the background work
2860
    return;
I
Igor Canadi 已提交
2861
  } else if (shutting_down_.load(std::memory_order_acquire)) {
J
jorlow@chromium.org 已提交
2862
    // DB is being deleted; no more background compactions
2863 2864
    return;
  }
2865

2866 2867 2868 2869
  while (unscheduled_flushes_ > 0 &&
         bg_flush_scheduled_ < db_options_.max_background_flushes) {
    unscheduled_flushes_--;
    bg_flush_scheduled_++;
2870
    env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH, this);
2871 2872
  }

2873 2874
  auto bg_compactions_allowed = BGCompactionsAllowed();

2875 2876 2877 2878 2879
  // special case -- if max_background_flushes == 0, then schedule flush on a
  // compaction thread
  if (db_options_.max_background_flushes == 0) {
    while (unscheduled_flushes_ > 0 &&
           bg_flush_scheduled_ + bg_compaction_scheduled_ <
2880
               bg_compactions_allowed) {
2881 2882 2883 2884 2885 2886
      unscheduled_flushes_--;
      bg_flush_scheduled_++;
      env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::LOW, this);
    }
  }

2887 2888 2889 2890 2891
  if (bg_compaction_paused_ > 0) {
    // we paused the background compaction
    return;
  }

2892
  if (HasExclusiveManualCompaction()) {
2893 2894 2895 2896 2897
    // only manual compactions are allowed to run. don't schedule automatic
    // compactions
    return;
  }

2898
  while (bg_compaction_scheduled_ < bg_compactions_allowed &&
2899
         unscheduled_compactions_ > 0) {
2900 2901 2902
    CompactionArg* ca = new CompactionArg;
    ca->db = this;
    ca->m = nullptr;
2903 2904
    bg_compaction_scheduled_++;
    unscheduled_compactions_--;
2905 2906
    env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                   &DBImpl::UnscheduleCallback);
2907 2908 2909
  }
}

2910 2911 2912 2913 2914 2915 2916 2917 2918
void DBImpl::SchedulePurge() {
  mutex_.AssertHeld();
  assert(opened_successfully_);

  // Purge operations are put into High priority queue
  bg_purge_scheduled_++;
  env_->Schedule(&DBImpl::BGWorkPurge, this, Env::Priority::HIGH, nullptr);
}

2919 2920 2921 2922 2923 2924 2925 2926
int DBImpl::BGCompactionsAllowed() const {
  if (write_controller_.NeedSpeedupCompaction()) {
    return db_options_.max_background_compactions;
  } else {
    return db_options_.base_background_compactions;
  }
}

2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969
void DBImpl::AddToCompactionQueue(ColumnFamilyData* cfd) {
  assert(!cfd->pending_compaction());
  cfd->Ref();
  compaction_queue_.push_back(cfd);
  cfd->set_pending_compaction(true);
}

ColumnFamilyData* DBImpl::PopFirstFromCompactionQueue() {
  assert(!compaction_queue_.empty());
  auto cfd = *compaction_queue_.begin();
  compaction_queue_.pop_front();
  assert(cfd->pending_compaction());
  cfd->set_pending_compaction(false);
  return cfd;
}

void DBImpl::AddToFlushQueue(ColumnFamilyData* cfd) {
  assert(!cfd->pending_flush());
  cfd->Ref();
  flush_queue_.push_back(cfd);
  cfd->set_pending_flush(true);
}

ColumnFamilyData* DBImpl::PopFirstFromFlushQueue() {
  assert(!flush_queue_.empty());
  auto cfd = *flush_queue_.begin();
  flush_queue_.pop_front();
  assert(cfd->pending_flush());
  cfd->set_pending_flush(false);
  return cfd;
}

void DBImpl::SchedulePendingFlush(ColumnFamilyData* cfd) {
  if (!cfd->pending_flush() && cfd->imm()->IsFlushPending()) {
    AddToFlushQueue(cfd);
    ++unscheduled_flushes_;
  }
}

void DBImpl::SchedulePendingCompaction(ColumnFamilyData* cfd) {
  if (!cfd->pending_compaction() && cfd->NeedsCompaction()) {
    AddToCompactionQueue(cfd);
    ++unscheduled_compactions_;
2970 2971 2972
  }
}

2973 2974 2975 2976 2977 2978 2979 2980
void DBImpl::SchedulePendingPurge(std::string fname, FileType type,
                                  uint64_t number, uint32_t path_id,
                                  int job_id) {
  mutex_.AssertHeld();
  PurgeFileInfo file_info(fname, type, number, path_id, job_id);
  purge_queue_.push_back(std::move(file_info));
}

2981
void DBImpl::BGWorkFlush(void* db) {
2982
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
2983
  TEST_SYNC_POINT("DBImpl::BGWorkFlush");
2984
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
2985
  TEST_SYNC_POINT("DBImpl::BGWorkFlush:done");
2986 2987
}

2988 2989 2990
void DBImpl::BGWorkCompaction(void* arg) {
  CompactionArg ca = *(reinterpret_cast<CompactionArg*>(arg));
  delete reinterpret_cast<CompactionArg*>(arg);
2991
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
2992
  TEST_SYNC_POINT("DBImpl::BGWorkCompaction");
2993 2994 2995
  reinterpret_cast<DBImpl*>(ca.db)->BackgroundCallCompaction(ca.m);
}

2996 2997 2998 2999 3000 3001
void DBImpl::BGWorkPurge(void* db) {
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
  TEST_SYNC_POINT("DBImpl::BGWorkPurge");
  reinterpret_cast<DBImpl*>(db)->BackgroundCallPurge();
}

3002 3003 3004 3005 3006 3007 3008
void DBImpl::UnscheduleCallback(void* arg) {
  CompactionArg ca = *(reinterpret_cast<CompactionArg*>(arg));
  delete reinterpret_cast<CompactionArg*>(arg);
  if ((ca.m != nullptr) && (ca.m->compaction != nullptr)) {
    delete ca.m->compaction;
  }
  TEST_SYNC_POINT("DBImpl::UnscheduleCallback");
3009 3010
}

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 3036 3037 3038
void DBImpl::BackgroundCallPurge() {
  mutex_.Lock();

  while (!purge_queue_.empty()) {
    auto purge_file = purge_queue_.begin();
    auto fname = purge_file->fname;
    auto type = purge_file->type;
    auto number = purge_file->number;
    auto path_id = purge_file->path_id;
    auto job_id = purge_file->job_id;
    purge_queue_.pop_front();

    mutex_.Unlock();
    Status file_deletion_status;
    DeleteObsoleteFileImpl(file_deletion_status, job_id, fname, type, number,
                           path_id);
    mutex_.Lock();
  }
  bg_purge_scheduled_--;

  bg_cv_.SignalAll();
  // 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.
  mutex_.Unlock();
}

3039
Status DBImpl::BackgroundFlush(bool* made_progress, JobContext* job_context,
H
Haobo Xu 已提交
3040
                               LogBuffer* log_buffer) {
3041
  mutex_.AssertHeld();
3042

3043 3044 3045 3046 3047 3048 3049
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

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

3052 3053 3054
  ColumnFamilyData* cfd = nullptr;
  while (!flush_queue_.empty()) {
    // This cfd is already referenced
I
Igor Canadi 已提交
3055
    auto first_cfd = PopFirstFromFlushQueue();
3056

I
Igor Canadi 已提交
3057
    if (first_cfd->IsDropped() || !first_cfd->imm()->IsFlushPending()) {
3058
      // can't flush this CF, try next one
I
Igor Canadi 已提交
3059 3060
      if (first_cfd->Unref()) {
        delete first_cfd;
3061 3062
      }
      continue;
3063
    }
3064 3065

    // found a flush!
I
Igor Canadi 已提交
3066
    cfd = first_cfd;
3067 3068 3069 3070 3071 3072 3073 3074 3075
    break;
  }

  if (cfd != nullptr) {
    const MutableCFOptions mutable_cf_options =
        *cfd->GetLatestMutableCFOptions();
    LogToBuffer(
        log_buffer,
        "Calling FlushMemTableToOutputFile with column "
3076 3077 3078 3079
        "family [%s], flush slots available %d, compaction slots allowed %d, "
        "compaction slots scheduled %d",
        cfd->GetName().c_str(), db_options_.max_background_flushes,
        bg_flush_scheduled_, BGCompactionsAllowed() - bg_compaction_scheduled_);
3080
    status = FlushMemTableToOutputFile(cfd, mutable_cf_options, made_progress,
3081 3082 3083
                                       job_context, log_buffer);
    if (cfd->Unref()) {
      delete cfd;
3084
    }
J
jorlow@chromium.org 已提交
3085
  }
3086
  return status;
J
jorlow@chromium.org 已提交
3087 3088
}

3089
void DBImpl::BackgroundCallFlush() {
3090
  bool made_progress = false;
3091
  JobContext job_context(next_job_id_.fetch_add(1), true);
3092 3093
  assert(bg_flush_scheduled_);

3094
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
H
Haobo Xu 已提交
3095
  {
3096
    InstrumentedMutexLock l(&mutex_);
3097
    num_running_flushes_++;
H
Haobo Xu 已提交
3098

I
Igor Canadi 已提交
3099 3100 3101
    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

3102
    Status s = BackgroundFlush(&made_progress, &job_context, &log_buffer);
3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119
    if (!s.ok() && !s.IsShutdownInProgress()) {
      // Wait a little bit before retrying background flush in
      // case this is an environmental problem and we do not want to
      // chew up resources for failed flushes for the duration of
      // the problem.
      uint64_t error_cnt =
        default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
      bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
      mutex_.Unlock();
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "Waiting after background flush error: %s"
          "Accumulated background error counts: %" PRIu64,
          s.ToString().c_str(), error_cnt);
      log_buffer.FlushBufferToLog();
      LogFlush(db_options_.info_log);
      env_->SleepForMicroseconds(1000000);
      mutex_.Lock();
H
Haobo Xu 已提交
3120 3121
    }

I
Igor Canadi 已提交
3122 3123
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

3124 3125 3126
    // If flush failed, we want to delete all temporary files that we might have
    // created. Thus, we force full scan in FindObsoleteFiles()
    FindObsoleteFiles(&job_context, !s.ok() && !s.IsShutdownInProgress());
H
Haobo Xu 已提交
3127
    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
3128
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
3129
      mutex_.Unlock();
3130 3131 3132 3133 3134
      // 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 已提交
3135
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
3136 3137
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
3138
      }
I
Igor Canadi 已提交
3139
      job_context.Clean();
3140 3141
      mutex_.Lock();
    }
I
Igor Canadi 已提交
3142

3143 3144
    assert(num_running_flushes_ > 0);
    num_running_flushes_--;
H
Haobo Xu 已提交
3145
    bg_flush_scheduled_--;
3146 3147
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
H
Haobo Xu 已提交
3148
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
3149 3150 3151 3152
    // 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.
3153
  }
J
jorlow@chromium.org 已提交
3154 3155
}

3156
void DBImpl::BackgroundCallCompaction(void* arg) {
3157
  bool made_progress = false;
3158
  ManualCompaction* m = reinterpret_cast<ManualCompaction*>(arg);
3159
  JobContext job_context(next_job_id_.fetch_add(1), true);
3160
  TEST_SYNC_POINT("BackgroundCallCompaction:0");
H
Haobo Xu 已提交
3161
  MaybeDumpStats();
3162
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL, db_options_.info_log.get());
3163
  {
3164
    InstrumentedMutexLock l(&mutex_);
3165
    num_running_compactions_++;
I
Igor Canadi 已提交
3166 3167 3168 3169

    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

3170
    assert(bg_compaction_scheduled_);
3171 3172
    Status s =
        BackgroundCompaction(&made_progress, &job_context, &log_buffer, m);
3173
    TEST_SYNC_POINT("BackgroundCallCompaction:1");
3174 3175 3176 3177 3178 3179
    if (!s.ok() && !s.IsShutdownInProgress()) {
      // 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.
      uint64_t error_cnt =
3180
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
3181 3182 3183 3184 3185 3186 3187 3188 3189 3190
      bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
      mutex_.Unlock();
      log_buffer.FlushBufferToLog();
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "Waiting after background compaction error: %s, "
          "Accumulated background error counts: %" PRIu64,
          s.ToString().c_str(), error_cnt);
      LogFlush(db_options_.info_log);
      env_->SleepForMicroseconds(1000000);
      mutex_.Lock();
3191
    }
H
Haobo Xu 已提交
3192

I
Igor Canadi 已提交
3193 3194
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

3195 3196 3197 3198
    // If compaction failed, we want to delete all temporary files that we might
    // have created (they might not be all recorded in job_context in case of a
    // failure). Thus, we force full scan in FindObsoleteFiles()
    FindObsoleteFiles(&job_context, !s.ok() && !s.IsShutdownInProgress());
3199 3200

    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
3201
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
3202
      mutex_.Unlock();
3203 3204 3205 3206 3207
      // 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 已提交
3208
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
3209 3210
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
3211
      }
I
Igor Canadi 已提交
3212
      job_context.Clean();
3213 3214
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
3215

3216 3217
    assert(num_running_compactions_ > 0);
    num_running_compactions_--;
3218
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
3219

3220 3221
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

3222 3223
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
3224 3225
    if (made_progress || bg_compaction_scheduled_ == 0 ||
        HasPendingManualCompaction()) {
3226
      // signal if
3227
      // * made_progress -- need to wakeup DelayWrite
3228
      // * bg_compaction_scheduled_ == 0 -- need to wakeup ~DBImpl
3229
      // * HasPendingManualCompaction -- need to wakeup RunManualCompaction
3230 3231 3232 3233
      // If none of this is true, there is no need to signal since nobody is
      // waiting for it
      bg_cv_.SignalAll();
    }
I
Igor Canadi 已提交
3234 3235 3236 3237
    // 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.
3238
  }
J
jorlow@chromium.org 已提交
3239 3240
}

3241 3242
Status DBImpl::BackgroundCompaction(bool* made_progress,
                                    JobContext* job_context,
3243 3244 3245
                                    LogBuffer* log_buffer, void* arg) {
  ManualCompaction* manual_compaction =
      reinterpret_cast<ManualCompaction*>(arg);
3246
  *made_progress = false;
J
jorlow@chromium.org 已提交
3247
  mutex_.AssertHeld();
3248
  TEST_SYNC_POINT("DBImpl::BackgroundCompaction:Start");
3249

3250 3251 3252 3253 3254
  bool is_manual = (manual_compaction != nullptr);

  // (manual_compaction->in_progress == false);
  bool trivial_move_disallowed =
      is_manual && manual_compaction->disallow_trivial_move;
3255

3256
  CompactionJobStats compaction_job_stats;
3257 3258 3259 3260 3261 3262
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
3263
    if (is_manual) {
3264 3265 3266 3267 3268
      manual_compaction->status = status;
      manual_compaction->done = true;
      manual_compaction->in_progress = false;
      delete manual_compaction->compaction;
      manual_compaction = nullptr;
3269
    }
3270
    return status;
3271 3272
  }

3273 3274
  if (is_manual) {
    // another thread cannot pick up the same work
3275
    manual_compaction->in_progress = true;
3276 3277 3278
  }

  unique_ptr<Compaction> c;
3279 3280
  // InternalKey manual_end_storage;
  // InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
3281
  if (is_manual) {
3282
    ManualCompaction* m = manual_compaction;
3283
    assert(m->in_progress);
3284
    c.reset(std::move(m->compaction));
3285
    if (!c) {
3286
      m->done = true;
3287
      m->manual_end = nullptr;
3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300
      LogToBuffer(log_buffer,
                  "[%s] Manual compaction from level-%d from %s .. "
                  "%s; nothing to do\n",
                  m->cfd->GetName().c_str(), m->input_level,
                  (m->begin ? m->begin->DebugString().c_str() : "(begin)"),
                  (m->end ? m->end->DebugString().c_str() : "(end)"));
    } else {
      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, c->output_level(),
                  (m->begin ? m->begin->DebugString().c_str() : "(begin)"),
                  (m->end ? m->end->DebugString().c_str() : "(end)"),
3301
                  ((m->done || m->manual_end == nullptr)
3302
                       ? "(end)"
3303
                       : m->manual_end->DebugString().c_str()));
G
Gabor Cselle 已提交
3304
    }
3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319
  } else if (!compaction_queue_.empty()) {
    // cfd is referenced here
    auto cfd = PopFirstFromCompactionQueue();
    // We unreference here because the following code will take a Ref() on
    // this cfd if it is going to use it (Compaction class holds a
    // reference).
    // This will all happen under a mutex so we don't have to be afraid of
    // somebody else deleting it.
    if (cfd->Unref()) {
      delete cfd;
      // This was the last reference of the column family, so no need to
      // compact.
      return Status::OK();
    }

3320 3321 3322 3323 3324 3325
    if (HaveManualCompaction(cfd)) {
      // Can't compact right now, but try again later
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction()::Conflict");
      return Status::OK();
    }

3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342
    // Pick up latest mutable CF Options and use it throughout the
    // compaction job
    // 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
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    if (!mutable_cf_options->disable_auto_compactions && !cfd->IsDropped()) {
      // NOTE: try to avoid unnecessary copy of MutableCFOptions if
      // compaction is not necessary. Need to make sure mutex is held
      // until we make a copy in the following code
      c.reset(cfd->PickCompaction(*mutable_cf_options, log_buffer));
      if (c != nullptr) {
        // update statistics
        MeasureTime(stats_, NUM_FILES_IN_SINGLE_COMPACTION,
                    c->inputs(0)->size());
        // There are three things that can change compaction score:
        // 1) When flush or compaction finish. This case is covered by
I
Igor Canadi 已提交
3343
        // InstallSuperVersionAndScheduleWork
3344
        // 2) When MutableCFOptions changes. This case is also covered by
I
Igor Canadi 已提交
3345 3346
        // InstallSuperVersionAndScheduleWork, because this is when the new
        // options take effect.
3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357
        // 3) When we Pick a new compaction, we "remove" those files being
        // compacted from the calculation, which then influences compaction
        // score. Here we check if we need the new compaction even without the
        // files that are currently being compacted. If we need another
        // compaction, we might be able to execute it in parallel, so we add it
        // to the queue and schedule a new thread.
        if (cfd->NeedsCompaction()) {
          // Yes, we need more compactions!
          AddToCompactionQueue(cfd);
          ++unscheduled_compactions_;
          MaybeScheduleFlushOrCompaction();
I
Igor Canadi 已提交
3358
        }
I
Igor Canadi 已提交
3359 3360
      }
    }
J
jorlow@chromium.org 已提交
3361 3362
  }

3363 3364 3365 3366
  if (c != nullptr) {
    running_compactions_.insert(c.get());
  }

3367
  if (!c) {
H
hans@chromium.org 已提交
3368
    // Nothing to do
3369
    LogToBuffer(log_buffer, "Compaction nothing to do");
3370
  } else if (c->deletion_compaction()) {
I
Igor Canadi 已提交
3371 3372 3373 3374
    // 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);
3375
    assert(c->column_family_data()->ioptions()->compaction_style ==
I
Igor Canadi 已提交
3376
           kCompactionStyleFIFO);
3377 3378 3379

    compaction_job_stats.num_input_files = c->num_input_files(0);

I
Igor Canadi 已提交
3380
    for (const auto& f : *c->inputs(0)) {
3381
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
3382
    }
3383 3384 3385
    status = versions_->LogAndApply(c->column_family_data(),
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
3386 3387
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
3388 3389 3390
    LogToBuffer(log_buffer, "[%s] Deleted %d files\n",
                c->column_family_data()->GetName().c_str(),
                c->num_input_files(0));
3391
    *made_progress = true;
3392
  } else if (!trivial_move_disallowed && c->IsTrivialMove()) {
3393
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:TrivialMove");
3394 3395
    // Instrument for event update
    // TODO(yhchiang): add op details for showing trivial-move.
3396 3397 3398
    ThreadStatusUtil::SetColumnFamily(
        c->column_family_data(), c->column_family_data()->ioptions()->env,
        c->column_family_data()->options()->enable_thread_tracking);
3399 3400
    ThreadStatusUtil::SetThreadOperation(ThreadStatus::OP_COMPACTION);

3401 3402
    compaction_job_stats.num_input_files = c->num_input_files(0);

3403 3404 3405
    // Move files to next level
    int32_t moved_files = 0;
    int64_t moved_bytes = 0;
3406
    for (unsigned int l = 0; l < c->num_input_levels(); l++) {
3407
      if (c->level(l) == c->output_level()) {
3408 3409 3410 3411
        continue;
      }
      for (size_t i = 0; i < c->num_input_files(l); i++) {
        FileMetaData* f = c->input(l, i);
3412
        c->edit()->DeleteFile(c->level(l), f->fd.GetNumber());
3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424
        c->edit()->AddFile(c->output_level(), f->fd.GetNumber(),
                           f->fd.GetPathId(), f->fd.GetFileSize(), f->smallest,
                           f->largest, f->smallest_seqno, f->largest_seqno,
                           f->marked_for_compaction);

        LogToBuffer(log_buffer,
                    "[%s] Moving #%" PRIu64 " to level-%d %" PRIu64 " bytes\n",
                    c->column_family_data()->GetName().c_str(),
                    f->fd.GetNumber(), c->output_level(), f->fd.GetFileSize());
        ++moved_files;
        moved_bytes += f->fd.GetFileSize();
      }
3425
    }
3426

3427
    status = versions_->LogAndApply(c->column_family_data(),
3428 3429
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
3430
    // Use latest MutableCFOptions
I
Igor Canadi 已提交
3431 3432
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
3433

S
sdong 已提交
3434
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Islam AbdelRahman 已提交
3435
    c->column_family_data()->internal_stats()->IncBytesMoved(c->output_level(),
3436
                                                             moved_bytes);
3437 3438 3439 3440
    {
      event_logger_.LogToBuffer(log_buffer)
          << "job" << job_context->job_id << "event"
          << "trivial_move"
I
Islam AbdelRahman 已提交
3441
          << "destination_level" << c->output_level() << "files" << moved_files
3442
          << "total_files_size" << moved_bytes;
3443
    }
3444 3445
    LogToBuffer(
        log_buffer,
3446
        "[%s] Moved #%d files to level-%d %" PRIu64 " bytes %s: %s\n",
I
Islam AbdelRahman 已提交
3447 3448
        c->column_family_data()->GetName().c_str(), moved_files,
        c->output_level(), moved_bytes, status.ToString().c_str(),
3449
        c->column_family_data()->current()->storage_info()->LevelSummary(&tmp));
3450
    *made_progress = true;
3451 3452 3453

    // Clear Instrument
    ThreadStatusUtil::ResetThreadStatus();
J
jorlow@chromium.org 已提交
3454
  } else {
3455 3456 3457
    int output_level  __attribute__((unused)) = c->output_level();
    TEST_SYNC_POINT_CALLBACK("DBImpl::BackgroundCompaction:NonTrivial",
                             &output_level);
3458 3459 3460 3461 3462

    SequenceNumber earliest_write_conflict_snapshot;
    std::vector<SequenceNumber> snapshot_seqs =
        snapshots_.GetAll(&earliest_write_conflict_snapshot);

I
Igor Canadi 已提交
3463
    assert(is_snapshot_supported_ || snapshots_.empty());
3464
    CompactionJob compaction_job(
I
Igor Canadi 已提交
3465 3466
        job_context->job_id, c.get(), db_options_, env_options_,
        versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
3467 3468 3469
        directories_.GetDataDir(c->output_path_id()), stats_, &mutex_,
        &bg_error_, snapshot_seqs, earliest_write_conflict_snapshot,
        table_cache_, &event_logger_,
3470
        c->mutable_cf_options()->paranoid_file_checks,
3471
        c->mutable_cf_options()->report_bg_io_stats, dbname_,
S
sdong 已提交
3472
        &compaction_job_stats);
I
Igor Canadi 已提交
3473
    compaction_job.Prepare();
3474

I
Igor Canadi 已提交
3475
    mutex_.Unlock();
3476
    compaction_job.Run();
3477
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:NonTrivial:AfterRun");
I
Igor Canadi 已提交
3478
    mutex_.Lock();
3479

3480
    status = compaction_job.Install(*c->mutable_cf_options());
I
Igor Canadi 已提交
3481
    if (status.ok()) {
I
Igor Canadi 已提交
3482 3483
      InstallSuperVersionAndScheduleWorkWrapper(
          c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
3484
    }
3485
    *made_progress = true;
O
Ori Bernstein 已提交
3486 3487
  }
  if (c != nullptr) {
3488 3489
    c->ReleaseCompactionFiles(status);
    *made_progress = true;
3490 3491 3492
    NotifyOnCompactionCompleted(
        c->column_family_data(), c.get(), status,
        compaction_job_stats, job_context->job_id);
3493
    running_compactions_.erase(c.get());
J
jorlow@chromium.org 已提交
3494
  }
3495
  // this will unref its input_version and column_family_data
3496
  c.reset();
J
jorlow@chromium.org 已提交
3497 3498 3499

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
3500
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
3501 3502
    // Ignore compaction errors found during shutting down
  } else {
3503
    Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log, "Compaction error: %s",
3504
        status.ToString().c_str());
3505
    if (db_options_.paranoid_checks && bg_error_.ok()) {
J
jorlow@chromium.org 已提交
3506 3507 3508
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
3509 3510

  if (is_manual) {
3511
    ManualCompaction* m = manual_compaction;
3512
    if (!status.ok()) {
L
Lei Jin 已提交
3513
      m->status = status;
3514 3515
      m->done = true;
    }
3516 3517 3518 3519 3520 3521 3522 3523 3524
    // 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.
3525 3526 3527 3528
    //
    // 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
3529
    if (m->manual_end == nullptr) {
3530 3531
      m->done = true;
    }
G
Gabor Cselle 已提交
3532 3533 3534
    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 已提交
3535
      // Universal and FIFO compactions should always compact the whole range
S
sdong 已提交
3536 3537 3538
      assert(m->cfd->ioptions()->compaction_style !=
                 kCompactionStyleUniversal ||
             m->cfd->ioptions()->num_levels > 1);
3539
      assert(m->cfd->ioptions()->compaction_style != kCompactionStyleFIFO);
3540
      m->tmp_storage = *m->manual_end;
G
Gabor Cselle 已提交
3541
      m->begin = &m->tmp_storage;
3542
      m->incomplete = true;
G
Gabor Cselle 已提交
3543
    }
3544
    m->in_progress = false; // not being processed anymore
H
hans@chromium.org 已提交
3545
  }
3546
  TEST_SYNC_POINT("DBImpl::BackgroundCompaction:Finish");
3547
  return status;
J
jorlow@chromium.org 已提交
3548 3549
}

3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572
bool DBImpl::HasPendingManualCompaction() {
  return (!manual_compaction_dequeue_.empty());
}

void DBImpl::AddManualCompaction(DBImpl::ManualCompaction* m) {
  manual_compaction_dequeue_.push_back(m);
}

void DBImpl::RemoveManualCompaction(DBImpl::ManualCompaction* m) {
  // Remove from queue
  std::deque<ManualCompaction*>::iterator it =
      manual_compaction_dequeue_.begin();
  while (it != manual_compaction_dequeue_.end()) {
    if (m == (*it)) {
      it = manual_compaction_dequeue_.erase(it);
      return;
    }
    it++;
  }
  assert(false);
  return;
}

3573 3574 3575
bool DBImpl::ShouldntRunManualCompaction(ManualCompaction* m) {
  if (m->exclusive) {
    return (bg_compaction_scheduled_ > 0);
3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636
  }
  std::deque<ManualCompaction*>::iterator it =
      manual_compaction_dequeue_.begin();
  bool seen = false;
  while (it != manual_compaction_dequeue_.end()) {
    if (m == (*it)) {
      it++;
      seen = true;
      continue;
    } else if (MCOverlap(m, (*it)) && (!seen && !(*it)->in_progress)) {
      // Consider the other manual compaction *it, conflicts if:
      // overlaps with m
      // and (*it) is ahead in the queue and is not yet in progress
      return true;
    }
    it++;
  }
  return false;
}

bool DBImpl::HaveManualCompaction(ColumnFamilyData* cfd) {
  // Remove from priority queue
  std::deque<ManualCompaction*>::iterator it =
      manual_compaction_dequeue_.begin();
  while (it != manual_compaction_dequeue_.end()) {
    if ((*it)->exclusive) {
      return true;
    }
    if ((cfd == (*it)->cfd) && (!((*it)->in_progress || (*it)->done))) {
      // Allow automatic compaction if manual compaction is
      // is in progress
      return true;
    }
    it++;
  }
  return false;
}

bool DBImpl::HasExclusiveManualCompaction() {
  // Remove from priority queue
  std::deque<ManualCompaction*>::iterator it =
      manual_compaction_dequeue_.begin();
  while (it != manual_compaction_dequeue_.end()) {
    if ((*it)->exclusive) {
      return true;
    }
    it++;
  }
  return false;
}

bool DBImpl::MCOverlap(ManualCompaction* m, ManualCompaction* m1) {
  if ((m->exclusive) || (m1->exclusive)) {
    return true;
  }
  if (m->cfd != m1->cfd) {
    return false;
  }
  return true;
}

3637 3638
namespace {
struct IterState {
3639
  IterState(DBImpl* _db, InstrumentedMutex* _mu, SuperVersion* _super_version,
3640
            bool _background_purge)
3641 3642 3643
      : db(_db),
        mu(_mu),
        super_version(_super_version),
3644
        background_purge(_background_purge) {}
3645 3646

  DBImpl* db;
3647
  InstrumentedMutex* mu;
3648
  SuperVersion* super_version;
3649
  bool background_purge;
3650 3651 3652 3653
};

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

3655
  if (state->super_version->Unref()) {
3656 3657 3658
    // Job id == 0 means that this is not our background process, but rather
    // user thread
    JobContext job_context(0);
3659

3660 3661
    state->mu->Lock();
    state->super_version->Cleanup();
I
Igor Canadi 已提交
3662
    state->db->FindObsoleteFiles(&job_context, false, true);
3663 3664 3665
    state->mu->Unlock();

    delete state->super_version;
I
Igor Canadi 已提交
3666
    if (job_context.HaveSomethingToDelete()) {
3667
      if (state->background_purge) {
3668 3669 3670 3671 3672 3673 3674 3675 3676 3677
        // PurgeObsoleteFiles here does not delete files. Instead, it adds the
        // files to be deleted to a job queue, and deletes it in a separate
        // background thread.
        state->db->PurgeObsoleteFiles(job_context, true /* schedule only */);
        state->mu->Lock();
        state->db->SchedulePurge();
        state->mu->Unlock();
      } else {
        state->db->PurgeObsoleteFiles(job_context);
      }
3678
    }
I
Igor Canadi 已提交
3679
    job_context.Clean();
I
Igor Canadi 已提交
3680
  }
T
Tomislav Novak 已提交
3681

3682 3683
  delete state;
}
H
Hans Wennborg 已提交
3684
}  // namespace
3685

S
sdong 已提交
3686 3687 3688 3689 3690
InternalIterator* DBImpl::NewInternalIterator(const ReadOptions& read_options,
                                              ColumnFamilyData* cfd,
                                              SuperVersion* super_version,
                                              Arena* arena) {
  InternalIterator* internal_iter;
3691 3692 3693 3694 3695
  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 已提交
3696
      super_version->mem->NewIterator(read_options, arena));
3697
  // Collect all needed child iterators for immutable memtables
L
Lei Jin 已提交
3698
  super_version->imm->AddIterators(read_options, &merge_iter_builder);
3699
  // Collect iterators for files in L0 - Ln
L
Lei Jin 已提交
3700
  super_version->current->AddIterators(read_options, env_options_,
3701 3702
                                       &merge_iter_builder);
  internal_iter = merge_iter_builder.Finish();
3703
  IterState* cleanup =
3704 3705
      new IterState(this, &mutex_, super_version,
                    read_options.background_purge_on_iterator_cleanup);
3706
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
3707 3708 3709 3710

  return internal_iter;
}

3711 3712 3713 3714
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
3715
Status DBImpl::Get(const ReadOptions& read_options,
3716
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3717
                   std::string* value) {
L
Lei Jin 已提交
3718
  return GetImpl(read_options, column_family, key, value);
3719 3720
}

I
Igor Canadi 已提交
3721 3722
// JobContext gets created and destructed outside of the lock --
// we
I
Igor Canadi 已提交
3723 3724
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3725
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3726
//
I
Igor Canadi 已提交
3727 3728 3729
// However, if InstallSuperVersionAndScheduleWork() gets called twice with the
// same job_context, we can't reuse the SuperVersion() that got
// malloced because
I
Igor Canadi 已提交
3730 3731 3732
// 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 已提交
3733
void DBImpl::InstallSuperVersionAndScheduleWorkWrapper(
I
Igor Canadi 已提交
3734
    ColumnFamilyData* cfd, JobContext* job_context,
3735
    const MutableCFOptions& mutable_cf_options) {
3736
  mutex_.AssertHeld();
I
Igor Canadi 已提交
3737
  SuperVersion* old_superversion = InstallSuperVersionAndScheduleWork(
I
Igor Canadi 已提交
3738 3739 3740
      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 已提交
3741 3742
}

I
Igor Canadi 已提交
3743
SuperVersion* DBImpl::InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
3744
    ColumnFamilyData* cfd, SuperVersion* new_sv,
I
Igor Canadi 已提交
3745
    const MutableCFOptions& mutable_cf_options) {
L
Lei Jin 已提交
3746
  mutex_.AssertHeld();
3747 3748 3749 3750 3751 3752 3753 3754 3755

  // Update max_total_in_memory_state_
  size_t old_memtable_size = 0;
  auto* old_sv = cfd->GetSuperVersion();
  if (old_sv) {
    old_memtable_size = old_sv->mutable_cf_options.write_buffer_size *
                        old_sv->mutable_cf_options.max_write_buffer_number;
  }

L
Lei Jin 已提交
3756 3757 3758
  auto* old = cfd->InstallSuperVersion(
      new_sv ? new_sv : new SuperVersion(), &mutex_, mutable_cf_options);

3759
  // Whenever we install new SuperVersion, we might need to issue new flushes or
I
Igor Canadi 已提交
3760 3761 3762 3763
  // compactions.
  SchedulePendingFlush(cfd);
  SchedulePendingCompaction(cfd);
  MaybeScheduleFlushOrCompaction();
L
Lei Jin 已提交
3764 3765 3766 3767 3768 3769 3770 3771 3772 3773

  // Update max_total_in_memory_state_
  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,
3774 3775
                       ColumnFamilyHandle* column_family, const Slice& key,
                       std::string* value, bool* value_found) {
L
Lei Jin 已提交
3776
  StopWatch sw(env_, stats_, DB_GET);
3777
  PERF_TIMER_GUARD(get_snapshot_time);
3778

3779 3780 3781
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3782
  SequenceNumber snapshot;
L
Lei Jin 已提交
3783 3784 3785
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3786 3787
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3788
  }
3789
  // Acquire SuperVersion
3790
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
3791
  // Prepare to store a list of merge operations if merge occurs.
3792
  MergeContext merge_context;
3793

3794
  Status s;
3795
  // First look in the memtable, then in the immutable memtable (if any).
3796
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3797
  // merge_operands will contain the sequence of merges in the latter case.
3798
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3799
  PERF_TIMER_STOP(get_snapshot_time);
3800

3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813
  bool skip_memtable =
      (read_options.read_tier == kPersistedTier && has_unpersisted_data_);
  bool done = false;
  if (!skip_memtable) {
    if (sv->mem->Get(lkey, value, &s, &merge_context)) {
      done = true;
      RecordTick(stats_, MEMTABLE_HIT);
    } else if (sv->imm->Get(lkey, value, &s, &merge_context)) {
      done = true;
      RecordTick(stats_, MEMTABLE_HIT);
    }
  }
  if (!done) {
3814
    PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3815 3816
    sv->current->Get(read_options, lkey, value, &s, &merge_context,
                     value_found);
L
Lei Jin 已提交
3817
    RecordTick(stats_, MEMTABLE_MISS);
3818
  }
3819

3820 3821
  {
    PERF_TIMER_GUARD(get_post_process_time);
3822

3823
    ReturnAndCleanupSuperVersion(cfd, sv);
3824

3825 3826
    RecordTick(stats_, NUMBER_KEYS_READ);
    RecordTick(stats_, BYTES_READ, value->size());
3827
    MeasureTime(stats_, BYTES_PER_READ, value->size());
3828
  }
3829
  return s;
J
jorlow@chromium.org 已提交
3830 3831
}

3832
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
3833
    const ReadOptions& read_options,
3834
    const std::vector<ColumnFamilyHandle*>& column_family,
3835
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
3836

L
Lei Jin 已提交
3837
  StopWatch sw(env_, stats_, DB_MULTIGET);
3838
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
3839

3840
  SequenceNumber snapshot;
3841

3842
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
3843
    ColumnFamilyData* cfd;
3844 3845 3846 3847 3848
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
3849 3850 3851 3852 3853 3854
    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});
3855 3856 3857
    }
  }

3858
  mutex_.Lock();
L
Lei Jin 已提交
3859 3860 3861
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3862 3863 3864
  } else {
    snapshot = versions_->LastSequence();
  }
3865
  for (auto mgd_iter : multiget_cf_data) {
3866 3867
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
3868
  }
3869
  mutex_.Unlock();
3870

3871 3872
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
3873

3874
  // Note: this always resizes the values array
3875 3876 3877
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
3878 3879

  // Keep track of bytes that we read for statistics-recording later
3880
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
3881
  PERF_TIMER_STOP(get_snapshot_time);
3882 3883 3884 3885

  // 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.
3886
  // merge_operands will contain the sequence of merges in the latter case.
3887
  for (size_t i = 0; i < num_keys; ++i) {
3888
    merge_context.Clear();
3889
    Status& s = stat_list[i];
3890 3891 3892
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
3893 3894
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
3895 3896 3897
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910
    bool skip_memtable =
        (read_options.read_tier == kPersistedTier && has_unpersisted_data_);
    bool done = false;
    if (!skip_memtable) {
      if (super_version->mem->Get(lkey, value, &s, &merge_context)) {
        done = true;
        // TODO(?): RecordTick(stats_, MEMTABLE_HIT)?
      } else if (super_version->imm->Get(lkey, value, &s, &merge_context)) {
        done = true;
        // TODO(?): RecordTick(stats_, MEMTABLE_HIT)?
      }
    }
    if (!done) {
3911
      PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3912 3913
      super_version->current->Get(read_options, lkey, value, &s,
                                  &merge_context);
3914
      // TODO(?): RecordTick(stats_, MEMTABLE_MISS)?
3915 3916 3917
    }

    if (s.ok()) {
3918
      bytes_read += value->size();
3919 3920 3921 3922
    }
  }

  // Post processing (decrement reference counts and record statistics)
3923
  PERF_TIMER_GUARD(get_post_process_time);
3924 3925
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
3926
  // TODO(icanadi) do we need lock here or just around Cleanup()?
3927 3928 3929 3930 3931 3932
  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);
3933 3934
    }
  }
3935 3936 3937 3938 3939 3940 3941
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
3942
  }
3943

L
Lei Jin 已提交
3944 3945 3946
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
3947
  MeasureTime(stats_, BYTES_PER_MULTIGET, bytes_read);
L
Lei Jin 已提交
3948
  PERF_TIMER_STOP(get_post_process_time);
3949

3950
  return stat_list;
3951 3952
}

L
Lei Jin 已提交
3953
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
3954
                                  const std::string& column_family_name,
3955
                                  ColumnFamilyHandle** handle) {
Y
Yueh-Hsuan Chiang 已提交
3956
  Status s;
3957
  Status persist_options_status;
I
Igor Canadi 已提交
3958
  *handle = nullptr;
3959 3960

  s = CheckCompressionSupported(cf_options);
3961 3962 3963
  if (s.ok() && db_options_.allow_concurrent_memtable_write) {
    s = CheckConcurrentWritesSupported(cf_options);
  }
3964 3965 3966 3967
  if (!s.ok()) {
    return s;
  }

Y
Yueh-Hsuan Chiang 已提交
3968
  {
3969
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
3970

Y
Yueh-Hsuan Chiang 已提交
3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984
    if (versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name) !=
        nullptr) {
      return Status::InvalidArgument("Column family already exists");
    }
    VersionEdit edit;
    edit.AddColumnFamily(column_family_name);
    uint32_t new_id = versions_->GetColumnFamilySet()->GetNextColumnFamilyID();
    edit.SetColumnFamily(new_id);
    edit.SetLogNumber(logfile_number_);
    edit.SetComparatorName(cf_options.comparator->Name());

    // LogAndApply will both write the creation in MANIFEST and create
    // ColumnFamilyData object
    Options opt(db_options_, cf_options);
I
Igor Canadi 已提交
3985
    {  // write thread
3986 3987
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
I
Igor Canadi 已提交
3988 3989 3990 3991
      // LogAndApply will both write the creation in MANIFEST and create
      // ColumnFamilyData object
      s = versions_->LogAndApply(
          nullptr, MutableCFOptions(opt, ImmutableCFOptions(opt)), &edit,
3992
          &mutex_, directories_.GetDbDir(), false, &cf_options);
3993 3994 3995 3996 3997 3998

      if (s.ok()) {
        // If the column family was created successfully, we then persist
        // the updated RocksDB options under the same single write thread
        persist_options_status = WriteOptionsFile();
      }
3999
      write_thread_.ExitUnbatched(&w);
I
Igor Canadi 已提交
4000
    }
Y
Yueh-Hsuan Chiang 已提交
4001 4002 4003 4004 4005
    if (s.ok()) {
      single_column_family_mode_ = false;
      auto* cfd =
          versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
      assert(cfd != nullptr);
I
Igor Canadi 已提交
4006
      delete InstallSuperVersionAndScheduleWork(
Y
Yueh-Hsuan Chiang 已提交
4007
          cfd, nullptr, *cfd->GetLatestMutableCFOptions());
S
sdong 已提交
4008 4009 4010 4011 4012

      if (!cfd->mem()->IsSnapshotSupported()) {
        is_snapshot_supported_ = false;
      }

Y
Yueh-Hsuan Chiang 已提交
4013 4014 4015 4016 4017 4018 4019 4020 4021
      *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
          "Created column family [%s] (ID %u)",
          column_family_name.c_str(), (unsigned)cfd->GetID());
    } else {
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "Creating column family [%s] FAILED -- %s",
          column_family_name.c_str(), s.ToString().c_str());
    }
4022
  }  // InstrumentedMutexLock l(&mutex_)
Y
Yueh-Hsuan Chiang 已提交
4023 4024

  // this is outside the mutex
4025
  if (s.ok()) {
4026 4027
    NewThreadStatusCfInfo(
        reinterpret_cast<ColumnFamilyHandleImpl*>(*handle)->cfd());
4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038
    if (!persist_options_status.ok()) {
      if (db_options_.fail_if_options_file_error) {
        s = Status::IOError(
            "ColumnFamily has been created, but unable to persist"
            "options in CreateColumnFamily()",
            persist_options_status.ToString().c_str());
      }
      Warn(db_options_.info_log,
           "Unable to persist options in CreateColumnFamily() -- %s",
           persist_options_status.ToString().c_str());
    }
4039
  }
4040
  return s;
4041 4042
}

4043 4044 4045 4046
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
4047 4048
    return Status::InvalidArgument("Can't drop default column family");
  }
4049

S
sdong 已提交
4050 4051
  bool cf_support_snapshot = cfd->mem()->IsSnapshotSupported();

I
Igor Canadi 已提交
4052 4053
  VersionEdit edit;
  edit.DropColumnFamily();
4054 4055
  edit.SetColumnFamily(cfd->GetID());

4056
  Status s;
4057
  Status options_persist_status;
4058
  {
4059
    InstrumentedMutexLock l(&mutex_);
4060 4061 4062 4063
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
4064
      // we drop column family from a single write thread
4065 4066
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
4067 4068
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
4069 4070 4071 4072 4073
      if (s.ok()) {
        // If the column family was dropped successfully, we then persist
        // the updated RocksDB options under the same single write thread
        options_persist_status = WriteOptionsFile();
      }
4074
      write_thread_.ExitUnbatched(&w);
4075
    }
S
sdong 已提交
4076 4077 4078 4079 4080 4081

    if (!cf_support_snapshot) {
      // Dropped Column Family doesn't support snapshot. Need to recalculate
      // is_snapshot_supported_.
      bool new_is_snapshot_supported = true;
      for (auto c : *versions_->GetColumnFamilySet()) {
4082
        if (!c->IsDropped() && !c->mem()->IsSnapshotSupported()) {
S
sdong 已提交
4083 4084 4085 4086 4087 4088
          new_is_snapshot_supported = false;
          break;
        }
      }
      is_snapshot_supported_ = new_is_snapshot_supported;
    }
4089
  }
4090

4091
  if (s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
4092 4093 4094 4095
    // Note that here we erase the associated cf_info of the to-be-dropped
    // cfd before its ref-count goes to zero to avoid having to erase cf_info
    // later inside db_mutex.
    EraseThreadStatusCfInfo(cfd);
I
Igor Canadi 已提交
4096
    assert(cfd->IsDropped());
L
Lei Jin 已提交
4097 4098 4099
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ -= mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
4100 4101 4102
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
        "Dropped column family with id %u\n", cfd->GetID());

4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113
    if (!options_persist_status.ok()) {
      if (db_options_.fail_if_options_file_error) {
        s = Status::IOError(
            "ColumnFamily has been dropped, but unable to persist "
            "options in DropColumnFamily()",
            options_persist_status.ToString().c_str());
      }
      Warn(db_options_.info_log,
           "Unable to persist options in DropColumnFamily() -- %s",
           options_persist_status.ToString().c_str());
    }
4114
  } else {
4115
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
4116
        "Dropping column family with id %u FAILED -- %s\n",
4117 4118 4119
        cfd->GetID(), s.ToString().c_str());
  }

4120
  return s;
4121 4122
}

L
Lei Jin 已提交
4123
bool DBImpl::KeyMayExist(const ReadOptions& read_options,
4124 4125
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
4126
  if (value_found != nullptr) {
K
Kai Liu 已提交
4127 4128
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
4129
  }
L
Lei Jin 已提交
4130
  ReadOptions roptions = read_options;
4131
  roptions.read_tier = kBlockCacheTier; // read from block cache only
4132
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
4133

4134
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
4135 4136 4137
  // 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();
4138 4139
}

4140
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
4141
                              ColumnFamilyHandle* column_family) {
4142 4143 4144 4145
  if (read_options.read_tier == kPersistedTier) {
    return NewErrorIterator(Status::NotSupported(
        "ReadTier::kPersistedData is not yet supported in iterators."));
  }
4146 4147
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
4148

V
Venkatesh Radhakrishnan 已提交
4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166
  XFUNC_TEST("", "managed_new", managed_new1, xf_manage_new,
             reinterpret_cast<DBImpl*>(this),
             const_cast<ReadOptions*>(&read_options), is_snapshot_supported_);
  if (read_options.managed) {
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return NewErrorIterator(Status::InvalidArgument(
        "Managed Iterators not supported in RocksDBLite."));
#else
    if ((read_options.tailing) || (read_options.snapshot != nullptr) ||
        (is_snapshot_supported_)) {
      return new ManagedIterator(this, read_options, cfd);
    }
    // Managed iter not supported
    return NewErrorIterator(Status::InvalidArgument(
        "Managed Iterators not supported without snapshots."));
#endif
  } else if (read_options.tailing) {
I
Igor Canadi 已提交
4167 4168 4169 4170
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
4171 4172
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
    auto iter = new ForwardIterator(this, read_options, cfd, sv);
4173 4174
    return NewDBIterator(
        env_, *cfd->ioptions(), cfd->user_comparator(), iter,
4175 4176
        kMaxSequenceNumber,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4177 4178
        sv->version_number, read_options.iterate_upper_bound,
        read_options.prefix_same_as_start, read_options.pin_data);
I
Igor Canadi 已提交
4179
#endif
T
Tomislav Novak 已提交
4180
  } else {
4181
    SequenceNumber latest_snapshot = versions_->LastSequence();
4182
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
4183

I
Igor Canadi 已提交
4184
    auto snapshot =
4185 4186 4187
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
4188
            : latest_snapshot;
T
Tomislav Novak 已提交
4189

4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225
    // 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         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
4226 4227
    // ArenaWrappedDBIter inlines an arena area where all the iterators in
    // the iterator tree are allocated in the order of being accessed when
4228 4229 4230 4231 4232
    // 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(
4233 4234
        env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4235 4236
        sv->version_number, read_options.iterate_upper_bound,
        read_options.prefix_same_as_start, read_options.pin_data);
4237

S
sdong 已提交
4238
    InternalIterator* internal_iter =
4239
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
4240 4241 4242 4243
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
4244 4245
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
4246 4247
}

4248
Status DBImpl::NewIterators(
4249
    const ReadOptions& read_options,
I
Igor Canadi 已提交
4250
    const std::vector<ColumnFamilyHandle*>& column_families,
4251
    std::vector<Iterator*>* iterators) {
4252 4253 4254 4255
  if (read_options.read_tier == kPersistedTier) {
    return Status::NotSupported(
        "ReadTier::kPersistedData is not yet supported in iterators.");
  }
I
Igor Canadi 已提交
4256 4257
  iterators->clear();
  iterators->reserve(column_families.size());
V
Venkatesh Radhakrishnan 已提交
4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277
  XFUNC_TEST("", "managed_new", managed_new1, xf_manage_new,
             reinterpret_cast<DBImpl*>(this),
             const_cast<ReadOptions*>(&read_options), is_snapshot_supported_);
  if (read_options.managed) {
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Managed interator not supported in RocksDB lite");
#else
    if ((!read_options.tailing) && (read_options.snapshot == nullptr) &&
        (!is_snapshot_supported_)) {
      return Status::InvalidArgument(
          "Managed interator not supported without snapshots");
    }
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
      auto iter = new ManagedIterator(this, read_options, cfd);
      iterators->push_back(iter);
    }
#endif
  } else if (read_options.tailing) {
I
Igor Canadi 已提交
4278 4279 4280 4281
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
4282 4283
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
4284 4285
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
      auto iter = new ForwardIterator(this, read_options, cfd, sv);
4286 4287 4288
      iterators->push_back(NewDBIterator(
          env_, *cfd->ioptions(), cfd->user_comparator(), iter,
          kMaxSequenceNumber,
4289 4290
          sv->mutable_cf_options.max_sequential_skip_in_iterations,
          sv->version_number, nullptr, false, read_options.pin_data));
I
Igor Canadi 已提交
4291
    }
I
Igor Canadi 已提交
4292
#endif
I
Igor Canadi 已提交
4293
  } else {
4294 4295
    SequenceNumber latest_snapshot = versions_->LastSequence();

I
Igor Canadi 已提交
4296
    for (size_t i = 0; i < column_families.size(); ++i) {
4297 4298 4299
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
4300 4301

      auto snapshot =
4302 4303 4304
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
4305 4306
              : latest_snapshot;

4307
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
4308
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
4309 4310
          sv->mutable_cf_options.max_sequential_skip_in_iterations,
          sv->version_number, nullptr, false, read_options.pin_data);
S
sdong 已提交
4311 4312
      InternalIterator* internal_iter =
          NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
4313 4314
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
4315 4316 4317 4318
    }
  }

  return Status::OK();
4319 4320
}

4321 4322
const Snapshot* DBImpl::GetSnapshot() { return GetSnapshotImpl(false); }

4323
#ifndef ROCKSDB_LITE
4324 4325 4326
const Snapshot* DBImpl::GetSnapshotForWriteConflictBoundary() {
  return GetSnapshotImpl(true);
}
4327
#endif  // ROCKSDB_LITE
4328 4329

const Snapshot* DBImpl::GetSnapshotImpl(bool is_write_conflict_boundary) {
4330 4331
  int64_t unix_time = 0;
  env_->GetCurrentTime(&unix_time);  // Ignore error
4332
  SnapshotImpl* s = new SnapshotImpl;
4333

4334
  InstrumentedMutexLock l(&mutex_);
4335
  // returns null if the underlying memtable does not support snapshot.
4336 4337 4338 4339
  if (!is_snapshot_supported_) {
    delete s;
    return nullptr;
  }
4340 4341
  return snapshots_.New(s, versions_->LastSequence(), unix_time,
                        is_write_conflict_boundary);
J
jorlow@chromium.org 已提交
4342 4343 4344
}

void DBImpl::ReleaseSnapshot(const Snapshot* s) {
4345 4346 4347 4348 4349 4350
  const SnapshotImpl* casted_s = reinterpret_cast<const SnapshotImpl*>(s);
  {
    InstrumentedMutexLock l(&mutex_);
    snapshots_.Delete(casted_s);
  }
  delete casted_s;
J
jorlow@chromium.org 已提交
4351 4352 4353
}

// Convenience methods
4354 4355
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
4356
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
4357 4358
}

4359 4360 4361
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
4362
  if (!cfh->cfd()->ioptions()->merge_operator) {
4363 4364
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
4365
    return DB::Merge(o, column_family, key, val);
4366 4367 4368
  }
}

L
Lei Jin 已提交
4369
Status DBImpl::Delete(const WriteOptions& write_options,
4370
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
4371
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
4372 4373
}

A
Andres Noetzli 已提交
4374 4375 4376 4377 4378 4379
Status DBImpl::SingleDelete(const WriteOptions& write_options,
                            ColumnFamilyHandle* column_family,
                            const Slice& key) {
  return DB::SingleDelete(write_options, column_family, key);
}

L
Lei Jin 已提交
4380
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
4381
  return WriteImpl(write_options, my_batch, nullptr, nullptr);
A
agiardullo 已提交
4382 4383
}

A
agiardullo 已提交
4384
#ifndef ROCKSDB_LITE
A
agiardullo 已提交
4385 4386 4387
Status DBImpl::WriteWithCallback(const WriteOptions& write_options,
                                 WriteBatch* my_batch,
                                 WriteCallback* callback) {
4388
  return WriteImpl(write_options, my_batch, callback, nullptr);
A
agiardullo 已提交
4389
}
A
agiardullo 已提交
4390
#endif  // ROCKSDB_LITE
A
agiardullo 已提交
4391 4392

Status DBImpl::WriteImpl(const WriteOptions& write_options,
4393 4394 4395
                         WriteBatch* my_batch, WriteCallback* callback,
                         uint64_t* log_used, uint64_t log_ref,
                         bool disable_memtable) {
S
Stanislau Hlebik 已提交
4396 4397 4398
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
4399 4400 4401
  if (write_options.timeout_hint_us != 0) {
    return Status::InvalidArgument("timeout_hint_us is deprecated");
  }
A
agiardullo 已提交
4402 4403

  Status status;
A
agiardullo 已提交
4404

A
agiardullo 已提交
4405 4406 4407 4408 4409 4410 4411 4412 4413 4414
  bool xfunc_attempted_write = false;
  XFUNC_TEST("transaction", "transaction_xftest_write_impl",
             xf_transaction_write1, xf_transaction_write, write_options,
             db_options_, my_batch, callback, this, &status,
             &xfunc_attempted_write);
  if (xfunc_attempted_write) {
    // Test already did the write
    return status;
  }

4415
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
4416
  WriteThread::Writer w;
S
Stanislau Hlebik 已提交
4417
  w.batch = my_batch;
L
Lei Jin 已提交
4418 4419
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
4420
  w.disable_memtable = disable_memtable;
S
Stanislau Hlebik 已提交
4421
  w.in_batch_group = false;
4422
  w.callback = callback;
4423
  w.log_ref = log_ref;
S
Stanislau Hlebik 已提交
4424

L
Lei Jin 已提交
4425
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4426 4427 4428
    RecordTick(stats_, WRITE_WITH_WAL);
  }

4429 4430
  StopWatch write_sw(env_, db_options_.statistics.get(), DB_WRITE);

4431
  write_thread_.JoinBatchGroup(&w);
4432 4433 4434 4435
  if (w.state == WriteThread::STATE_PARALLEL_FOLLOWER) {
    // we are a non-leader in a parallel group
    PERF_TIMER_GUARD(write_memtable_time);

4436 4437 4438 4439 4440
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }

    if (w.ShouldWriteToMemtable()) {
4441 4442 4443 4444
      ColumnFamilyMemTablesImpl column_family_memtables(
          versions_->GetColumnFamilySet());
      WriteBatchInternal::SetSequence(w.batch, w.sequence);
      w.status = WriteBatchInternal::InsertInto(
4445
          &w, &column_family_memtables, &flush_scheduler_,
4446
          write_options.ignore_missing_column_families, 0 /*log_number*/, this,
S
sdong 已提交
4447
          true /*concurrent_memtable_writes*/);
4448
    }
4449 4450 4451

    if (write_thread_.CompleteParallelWorker(&w)) {
      // we're responsible for early exit
4452
      auto last_sequence = w.parallel_group->last_sequence;
4453 4454 4455 4456 4457 4458
      SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
      versions_->SetLastSequence(last_sequence);
      write_thread_.EarlyExitParallelGroup(&w);
    }
    assert(w.state == WriteThread::STATE_COMPLETED);
    // STATE_COMPLETED conditional below handles exit
4459 4460

    status = w.FinalStatus();
4461 4462
  }
  if (w.state == WriteThread::STATE_COMPLETED) {
4463 4464 4465
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }
4466
    // write is complete and leader has updated sequence
4467
    RecordTick(stats_, WRITE_DONE_BY_OTHER);
4468
    return w.FinalStatus();
4469 4470
  }
  // else we are the leader of the write batch group
4471
  assert(w.state == WriteThread::STATE_GROUP_LEADER);
4472

S
Stanislau Hlebik 已提交
4473 4474
  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4475 4476 4477 4478 4479

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

S
Stanislau Hlebik 已提交
4480 4481
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
4482

4483 4484 4485 4486
  // 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.
4487 4488 4489
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

4490
  uint64_t max_total_wal_size = (db_options_.max_total_wal_size == 0)
4491
                                    ? 4 * max_total_in_memory_state_
4492
                                    : db_options_.max_total_wal_size;
4493 4494 4495
  if (UNLIKELY(!single_column_family_mode_ &&
               alive_log_files_.begin()->getting_flushed == false &&
               total_log_size_ > max_total_wal_size)) {
I
Igor Canadi 已提交
4496
    uint64_t flush_column_family_if_log_file = alive_log_files_.begin()->number;
I
Igor Canadi 已提交
4497
    alive_log_files_.begin()->getting_flushed = true;
4498
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
4499 4500 4501
        "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 已提交
4502 4503
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4504
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4505 4506 4507
      if (cfd->IsDropped()) {
        continue;
      }
I
Igor Canadi 已提交
4508
      if (cfd->GetLogNumber() <= flush_column_family_if_log_file) {
I
Igor Canadi 已提交
4509
        status = SwitchMemtable(cfd, &context);
I
Igor Canadi 已提交
4510 4511 4512
        if (!status.ok()) {
          break;
        }
S
Stanislau Hlebik 已提交
4513
        cfd->imm()->FlushRequested();
4514
        SchedulePendingFlush(cfd);
4515
      }
4516
    }
I
Igor Canadi 已提交
4517
    MaybeScheduleFlushOrCompaction();
4518 4519 4520 4521 4522 4523
  } else if (UNLIKELY(write_buffer_manager_->ShouldFlush())) {
    // Before a new memtable is added in SwitchMemtable(),
    // write_buffer_manager_->ShouldFlush() will keep returning true. If another
    // thread is writing to another DB with the same write buffer, they may also
    // be flushed. We may end up with flushing much more DBs than needed. It's
    // suboptimal but still correct.
4524
    Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
4525 4526
        "Flushing column family with largest mem table size. Write buffer is "
        "using %" PRIu64 " bytes out of a total of %" PRIu64 ".",
4527 4528
        write_buffer_manager_->memory_usage(),
        write_buffer_manager_->buffer_size());
4529 4530
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4531 4532 4533
    ColumnFamilyData* largest_cfd = nullptr;
    size_t largest_cfd_size = 0;

4534
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4535 4536 4537
      if (cfd->IsDropped()) {
        continue;
      }
4538
      if (!cfd->mem()->IsEmpty()) {
4539 4540 4541 4542 4543 4544
        // We only consider active mem table, hoping immutable memtable is
        // already in the process of flushing.
        size_t cfd_size = cfd->mem()->ApproximateMemoryUsage();
        if (largest_cfd == nullptr || cfd_size > largest_cfd_size) {
          largest_cfd = cfd;
          largest_cfd_size = cfd_size;
4545 4546 4547
        }
      }
    }
4548 4549 4550 4551 4552 4553 4554 4555
    if (largest_cfd != nullptr) {
      status = SwitchMemtable(largest_cfd, &context);
      if (status.ok()) {
        largest_cfd->imm()->FlushRequested();
        SchedulePendingFlush(largest_cfd);
        MaybeScheduleFlushOrCompaction();
      }
    }
I
Igor Canadi 已提交
4556 4557 4558 4559 4560 4561 4562 4563 4564 4565
  }

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

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

4566 4567
  if (UNLIKELY(status.ok() && (write_controller_.IsStopped() ||
                               write_controller_.NeedsDelay()))) {
4568 4569
    PERF_TIMER_STOP(write_pre_and_post_process_time);
    PERF_TIMER_GUARD(write_delay_time);
S
sdong 已提交
4570 4571 4572 4573
    // We don't know size of curent batch so that we always use the size
    // for previous one. It might create a fairness issue that expiration
    // might happen for smaller writes but larger writes can go through.
    // Can optimize it if it is an issue.
4574
    status = DelayWrite(last_batch_group_size_);
4575
    PERF_TIMER_START(write_pre_and_post_process_time);
I
Igor Canadi 已提交
4576 4577
  }

D
dgrogan@chromium.org 已提交
4578
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4579
  WriteThread::Writer* last_writer = &w;
4580
  autovector<WriteThread::Writer*> write_group;
4581 4582
  bool need_log_sync = !write_options.disableWAL && write_options.sync;
  bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
A
agiardullo 已提交
4583

S
Stanislau Hlebik 已提交
4584
  if (status.ok()) {
4585
    if (need_log_sync) {
4586 4587 4588 4589 4590 4591 4592 4593 4594
      while (logs_.front().getting_synced) {
        log_sync_cv_.Wait();
      }
      for (auto& log : logs_) {
        assert(!log.getting_synced);
        log.getting_synced = true;
      }
    }

4595 4596 4597
    // 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
4598
    // into memtables
A
agiardullo 已提交
4599 4600
  }

4601 4602
  mutex_.Unlock();

A
agiardullo 已提交
4603 4604
  // At this point the mutex is unlocked

4605
  bool exit_completed_early = false;
4606 4607
  last_batch_group_size_ =
      write_thread_.EnterAsBatchGroupLeader(&w, &last_writer, &write_group);
4608

A
agiardullo 已提交
4609
  if (status.ok()) {
4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622
    // Rules for when we can update the memtable concurrently
    // 1. supported by memtable
    // 2. Puts are not okay if inplace_update_support
    // 3. Deletes or SingleDeletes are not okay if filtering deletes
    //    (controlled by both batch and memtable setting)
    // 4. Merges are not okay
    //
    // Rules 1..3 are enforced by checking the options
    // during startup (CheckConcurrentWritesSupported), so if
    // options.allow_concurrent_memtable_write is true then they can be
    // assumed to be true.  Rule 4 is checked for each batch.  We could
    // relax rules 2 and 3 if we could prevent write batches from referring
    // more than once to a particular key.
4623 4624
    bool parallel =
        db_options_.allow_concurrent_memtable_write && write_group.size() > 1;
4625 4626
    int total_count = 0;
    uint64_t total_byte_size = 0;
4627 4628
    for (auto writer : write_group) {
      if (writer->CheckCallback(this)) {
4629 4630 4631 4632 4633 4634 4635 4636 4637
        if (writer->ShouldWriteToMemtable()) {
          total_count += WriteBatchInternal::Count(writer->batch);
          parallel = parallel && !writer->batch->HasMerge();
        }

        if (writer->ShouldWriteToWAL()) {
          total_byte_size = WriteBatchInternal::AppendedByteSize(
              total_byte_size, WriteBatchInternal::ByteSize(writer->batch));
        }
4638
      }
4639 4640 4641 4642 4643 4644 4645 4646
    }

    const SequenceNumber current_sequence = last_sequence + 1;
    last_sequence += total_count;

    // Record statistics
    RecordTick(stats_, NUMBER_KEYS_WRITTEN, total_count);
    RecordTick(stats_, BYTES_WRITTEN, total_byte_size);
4647
    MeasureTime(stats_, BYTES_PER_WRITE, total_byte_size);
4648
    PERF_TIMER_STOP(write_pre_and_post_process_time);
4649

4650
    if (write_options.disableWAL) {
4651
      has_unpersisted_data_ = true;
4652
    }
4653

4654 4655 4656
    uint64_t log_size = 0;
    if (!write_options.disableWAL) {
      PERF_TIMER_GUARD(write_wal_time);
4657

4658
      WriteBatch* merged_batch = nullptr;
4659
      if (write_group.size() == 1 && write_group[0]->ShouldWriteToWAL()) {
4660
        merged_batch = write_group[0]->batch;
4661
        write_group[0]->log_used = logfile_number_;
4662 4663 4664 4665 4666
      } else {
        // WAL needs all of the batches flattened into a single batch.
        // We could avoid copying here with an iov-like AddRecord
        // interface
        merged_batch = &tmp_batch_;
4667
        for (auto writer : write_group) {
4668
          if (writer->ShouldWriteToWAL()) {
4669 4670
            WriteBatchInternal::Append(merged_batch, writer->batch);
          }
4671
          writer->log_used = logfile_number_;
4672 4673 4674
        }
      }

4675 4676 4677 4678 4679
      if (log_used != nullptr) {
        *log_used = logfile_number_;
      }

      WriteBatchInternal::SetSequence(merged_batch, current_sequence);
4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709

      Slice log_entry = WriteBatchInternal::Contents(merged_batch);
      status = logs_.back().writer->AddRecord(log_entry);
      total_log_size_ += log_entry.size();
      alive_log_files_.back().AddSize(log_entry.size());
      log_empty_ = false;
      log_size = log_entry.size();
      RecordTick(stats_, WAL_FILE_BYTES, log_size);
      if (status.ok() && need_log_sync) {
        RecordTick(stats_, WAL_FILE_SYNCED);
        StopWatch sw(env_, stats_, WAL_FILE_SYNC_MICROS);
        // It's safe to access logs_ with unlocked mutex_ here because:
        //  - we've set getting_synced=true for all logs,
        //    so other threads won't pop from logs_ while we're here,
        //  - only writer thread can push to logs_, and we're in
        //    writer thread, so no one will push to logs_,
        //  - as long as other threads don't modify it, it's safe to read
        //    from std::deque from multiple threads concurrently.
        for (auto& log : logs_) {
          status = log.writer->file()->Sync(db_options_.use_fsync);
          if (!status.ok()) {
            break;
          }
        }
        if (status.ok() && need_log_dir_sync) {
          // We only sync WAL directory the first time WAL syncing is
          // requested, so that in case users never turn on WAL sync,
          // we can avoid the disk I/O in the write code path.
          status = directories_.GetWalDir()->Fsync();
        }
4710 4711
      }

4712 4713 4714 4715 4716 4717
      if (merged_batch == &tmp_batch_) {
        tmp_batch_.Clear();
      }
    }
    if (status.ok()) {
      PERF_TIMER_GUARD(write_memtable_time);
4718

4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730
      {
        // Update stats while we are an exclusive group leader, so we know
        // that nobody else can be writing to these particular stats.
        // We're optimistic, updating the stats before we successfully
        // commit.  That lets us release our leader status early in
        // some cases.
        auto stats = default_cf_internal_stats_;
        stats->AddDBStats(InternalStats::BYTES_WRITTEN, total_byte_size);
        stats->AddDBStats(InternalStats::NUMBER_KEYS_WRITTEN, total_count);
        if (!write_options.disableWAL) {
          if (write_options.sync) {
            stats->AddDBStats(InternalStats::WAL_FILE_SYNCED, 1);
4731
          }
4732
          stats->AddDBStats(InternalStats::WAL_FILE_BYTES, log_size);
4733
        }
4734
        uint64_t for_other = write_group.size() - 1;
4735 4736 4737 4738
        if (for_other > 0) {
          stats->AddDBStats(InternalStats::WRITE_DONE_BY_OTHER, for_other);
          if (!write_options.disableWAL) {
            stats->AddDBStats(InternalStats::WRITE_WITH_WAL, for_other);
4739
          }
H
heyongqiang 已提交
4740
        }
4741
      }
Y
Yueh-Hsuan Chiang 已提交
4742

4743
      if (!parallel) {
4744
        status = WriteBatchInternal::InsertInto(
4745
            write_group, current_sequence, column_family_memtables_.get(),
4746
            &flush_scheduler_, write_options.ignore_missing_column_families,
S
sdong 已提交
4747
            0 /*log_number*/, this);
4748 4749 4750 4751 4752 4753 4754

        if (status.ok()) {
          // There were no write failures. Set leader's status
          // in case the write callback returned a non-ok status.
          status = w.FinalStatus();
        }

4755
      } else {
4756
        WriteThread::ParallelGroup pg;
4757 4758
        pg.leader = &w;
        pg.last_writer = last_writer;
4759
        pg.last_sequence = last_sequence;
4760
        pg.early_exit_allowed = !need_log_sync;
4761
        pg.running.store(static_cast<uint32_t>(write_group.size()),
4762
                         std::memory_order_relaxed);
4763 4764
        write_thread_.LaunchParallelFollowers(&pg, current_sequence);

4765
        if (w.ShouldWriteToMemtable()) {
4766 4767 4768 4769 4770 4771
          // do leader write
          ColumnFamilyMemTablesImpl column_family_memtables(
              versions_->GetColumnFamilySet());
          assert(w.sequence == current_sequence);
          WriteBatchInternal::SetSequence(w.batch, w.sequence);
          w.status = WriteBatchInternal::InsertInto(
4772
              &w, &column_family_memtables, &flush_scheduler_,
4773
              write_options.ignore_missing_column_families, 0 /*log_number*/,
S
sdong 已提交
4774
              this, true /*concurrent_memtable_writes*/);
4775 4776
        }

4777 4778 4779
        // CompleteParallelWorker returns true if this thread should
        // handle exit, false means somebody else did
        exit_completed_early = !write_thread_.CompleteParallelWorker(&w);
4780
        status = w.FinalStatus();
4781
      }
A
agiardullo 已提交
4782

4783
      if (!exit_completed_early && w.status.ok()) {
4784 4785 4786
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
        versions_->SetLastSequence(last_sequence);
        if (!need_log_sync) {
4787
          write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
4788
          exit_completed_early = true;
4789
        }
4790
      }
4791 4792 4793 4794 4795 4796 4797 4798 4799

      // A non-OK status here indicates that the state implied by the
      // WAL has diverged from the in-memory state.  This could be
      // because of a corrupt write_batch (very bad), or because the
      // client specified an invalid column family and didn't specify
      // ignore_missing_column_families.
      //
      // Is setting bg_error_ enough here?  This will at least stop
      // compaction and fail any further writes.
4800
      if (!status.ok() && bg_error_.ok() && !w.CallbackFailed()) {
4801
        bg_error_ = status;
4802
      }
4803
    }
4804
  }
4805
  PERF_TIMER_START(write_pre_and_post_process_time);
A
agiardullo 已提交
4806

4807
  if (db_options_.paranoid_checks && !status.ok() && !w.CallbackFailed() &&
4808 4809 4810 4811 4812 4813
      !status.IsBusy()) {
    mutex_.Lock();
    if (bg_error_.ok()) {
      bg_error_ = status;  // stop compaction & fail any further writes
    }
    mutex_.Unlock();
I
Igor Canadi 已提交
4814
  }
4815

4816
  if (need_log_sync) {
4817
    mutex_.Lock();
4818
    MarkLogsSynced(logfile_number_, need_log_dir_sync, status);
4819
    mutex_.Unlock();
4820 4821
  }

4822
  if (!exit_completed_early) {
4823
    write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
4824
  }
4825

J
jorlow@chromium.org 已提交
4826 4827 4828
  return status;
}

4829 4830
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
4831
Status DBImpl::DelayWrite(uint64_t num_bytes) {
S
sdong 已提交
4832 4833 4834 4835
  uint64_t time_delayed = 0;
  bool delayed = false;
  {
    StopWatch sw(env_, stats_, WRITE_STALL, &time_delayed);
S
sdong 已提交
4836 4837
    auto delay = write_controller_.GetDelay(env_, num_bytes);
    if (delay > 0) {
S
sdong 已提交
4838 4839
      mutex_.Unlock();
      delayed = true;
S
sdong 已提交
4840
      TEST_SYNC_POINT("DBImpl::DelayWrite:Sleep");
4841 4842
      // hopefully we don't have to sleep more than 2 billion microseconds
      env_->SleepForMicroseconds(static_cast<int>(delay));
S
sdong 已提交
4843 4844
      mutex_.Lock();
    }
4845

4846
    while (bg_error_.ok() && write_controller_.IsStopped()) {
S
sdong 已提交
4847
      delayed = true;
4848 4849
      TEST_SYNC_POINT("DBImpl::DelayWrite:Wait");
      bg_cv_.Wait();
4850 4851
    }
  }
S
sdong 已提交
4852 4853 4854 4855 4856
  if (delayed) {
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_STALL_MICROS,
                                           time_delayed);
    RecordTick(stats_, STALL_MICROS, time_delayed);
  }
I
Igor Canadi 已提交
4857 4858

  return bg_error_;
4859 4860
}

I
Igor Canadi 已提交
4861 4862
Status DBImpl::ScheduleFlushes(WriteContext* context) {
  ColumnFamilyData* cfd;
4863
  while ((cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
4864
    auto status = SwitchMemtable(cfd, context);
I
Igor Canadi 已提交
4865 4866 4867 4868 4869
    if (cfd->Unref()) {
      delete cfd;
    }
    if (!status.ok()) {
      return status;
S
Stanislau Hlebik 已提交
4870 4871
    }
  }
I
Igor Canadi 已提交
4872
  return Status::OK();
S
Stanislau Hlebik 已提交
4873 4874
}

4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886
#ifndef ROCKSDB_LITE
void DBImpl::NotifyOnMemTableSealed(ColumnFamilyData* cfd,
                                    const MemTableInfo& mem_table_info) {
  if (db_options_.listeners.size() == 0U) {
    return;
  }
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }

  for (auto listener : db_options_.listeners) {
    listener->OnMemTableSealed(mem_table_info);
4887
  }
4888 4889 4890
}
#endif  // ROCKSDB_LITE

S
Stanislau Hlebik 已提交
4891 4892
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
4893
Status DBImpl::SwitchMemtable(ColumnFamilyData* cfd, WriteContext* context) {
S
Stanislau Hlebik 已提交
4894 4895 4896 4897 4898 4899 4900
  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.
4901
  assert(versions_->prev_log_number() == 0);
S
Stanislau Hlebik 已提交
4902
  bool creating_new_log = !log_empty_;
S
Sage Weil 已提交
4903 4904 4905 4906 4907 4908
  uint64_t recycle_log_number = 0;
  if (creating_new_log && db_options_.recycle_log_file_num &&
      !log_recycle_files.empty()) {
    recycle_log_number = log_recycle_files.front();
    log_recycle_files.pop_front();
  }
S
Stanislau Hlebik 已提交
4909 4910 4911
  uint64_t new_log_number =
      creating_new_log ? versions_->NewFileNumber() : logfile_number_;
  SuperVersion* new_superversion = nullptr;
4912
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
4913 4914 4915 4916 4917 4918 4919 4920 4921 4922

  // Set current_memtble_info for memtable sealed callback
#ifndef ROCKSDB_LITE
  MemTableInfo memtable_info;
  memtable_info.cf_name = cfd->GetName();
  memtable_info.first_seqno = cfd->mem()->GetFirstSequenceNumber();
  memtable_info.earliest_seqno = cfd->mem()->GetEarliestSequenceNumber();
  memtable_info.num_entries = cfd->mem()->num_entries();
  memtable_info.num_deletes = cfd->mem()->num_deletes();
#endif  // ROCKSDB_LITE
4923 4924 4925
  // Log this later after lock release. It may be outdated, e.g., if background
  // flush happens before logging, but that should be ok.
  int num_imm_unflushed = cfd->imm()->NumNotFlushed();
S
Stanislau Hlebik 已提交
4926 4927 4928 4929
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
4930 4931
      EnvOptions opt_env_opt =
          env_->OptimizeForLogWrite(env_options_, db_options_);
S
Sage Weil 已提交
4932 4933 4934 4935 4936 4937 4938 4939
      if (recycle_log_number) {
        Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
            "reusing log %" PRIu64 " from recycle list\n", recycle_log_number);
        s = env_->ReuseWritableFile(
            LogFileName(db_options_.wal_dir, new_log_number),
            LogFileName(db_options_.wal_dir, recycle_log_number), &lfile,
            opt_env_opt);
      } else {
S
sdong 已提交
4940 4941 4942
        s = NewWritableFile(env_,
                            LogFileName(db_options_.wal_dir, new_log_number),
                            &lfile, opt_env_opt);
S
Sage Weil 已提交
4943
      }
S
Stanislau Hlebik 已提交
4944 4945 4946
      if (s.ok()) {
        // Our final size should be less than write_buffer_size
        // (compression, etc) but err on the side of caution.
D
Dmitri Smirnov 已提交
4947 4948 4949
        lfile->SetPreallocationBlockSize(
            mutable_cf_options.write_buffer_size / 10 +
            mutable_cf_options.write_buffer_size);
4950 4951
        unique_ptr<WritableFileWriter> file_writer(
            new WritableFileWriter(std::move(lfile), opt_env_opt));
S
sdong 已提交
4952 4953
        new_log = new log::Writer(std::move(file_writer), new_log_number,
                                  db_options_.recycle_log_file_num > 0);
I
Igor Canadi 已提交
4954
      }
S
Stanislau Hlebik 已提交
4955 4956 4957
    }

    if (s.ok()) {
A
agiardullo 已提交
4958 4959
      SequenceNumber seq = versions_->LastSequence();
      new_mem = cfd->ConstructNewMemtable(mutable_cf_options, seq);
S
Stanislau Hlebik 已提交
4960 4961
      new_superversion = new SuperVersion();
    }
4962 4963 4964 4965 4966 4967 4968

#ifndef ROCKSDB_LITE
    // PLEASE NOTE: We assume that there are no failable operations
    // after lock is acquired below since we are already notifying
    // client about mem table becoming immutable.
    NotifyOnMemTableSealed(cfd, memtable_info);
#endif //ROCKSDB_LITE
S
Stanislau Hlebik 已提交
4969
  }
4970 4971 4972
  Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
      "[%s] New memtable created with log file: #%" PRIu64
      ". Immutable memtables: %d.\n",
4973
      cfd->GetName().c_str(), new_log_number, num_imm_unflushed);
S
Stanislau Hlebik 已提交
4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985
  mutex_.Lock();
  if (!s.ok()) {
    // how do we fail if we're not creating new log?
    assert(creating_new_log);
    assert(!new_mem);
    assert(!new_log);
    return s;
  }
  if (creating_new_log) {
    logfile_number_ = new_log_number;
    assert(new_log != nullptr);
    log_empty_ = true;
4986
    log_dir_synced_ = false;
4987
    logs_.emplace_back(logfile_number_, new_log);
S
Stanislau Hlebik 已提交
4988
    alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
I
Igor Canadi 已提交
4989
    for (auto loop_cfd : *versions_->GetColumnFamilySet()) {
S
Stanislau Hlebik 已提交
4990 4991 4992 4993
      // 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
I
Igor Canadi 已提交
4994
      if (loop_cfd->mem()->GetFirstSequenceNumber() == 0 &&
4995
          loop_cfd->imm()->NumNotFlushed() == 0) {
I
Igor Canadi 已提交
4996
        loop_cfd->SetLogNumber(logfile_number_);
4997
      }
4998 4999
    }
  }
S
Stanislau Hlebik 已提交
5000
  cfd->mem()->SetNextLogNumber(logfile_number_);
5001
  cfd->imm()->Add(cfd->mem(), &context->memtables_to_free_);
S
Stanislau Hlebik 已提交
5002 5003
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
I
Igor Canadi 已提交
5004 5005
  context->superversions_to_free_.push_back(InstallSuperVersionAndScheduleWork(
      cfd, new_superversion, mutable_cf_options));
5006 5007 5008
  return s;
}

I
Igor Canadi 已提交
5009
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
5010 5011 5012 5013 5014
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

5015 5016
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
5017
  auto version = cfd->current();
5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
5030 5031

Status DBImpl::GetPropertiesOfTablesInRange(ColumnFamilyHandle* column_family,
5032
                                            const Range* range, std::size_t n,
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052
                                            TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

  // Increment the ref count
  mutex_.Lock();
  auto version = cfd->current();
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfTablesInRange(range, n, props);

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

  return s;
}

I
Igor Canadi 已提交
5053
#endif  // ROCKSDB_LITE
5054

I
Igor Canadi 已提交
5055 5056 5057 5058
const std::string& DBImpl::GetName() const {
  return dbname_;
}

5059 5060 5061 5062
Env* DBImpl::GetEnv() const {
  return env_;
}

5063 5064
const Options& DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
I
Igor Canadi 已提交
5065
  return *cfh->cfd()->options();
I
Igor Canadi 已提交
5066 5067
}

5068 5069
const DBOptions& DBImpl::GetDBOptions() const { return db_options_; }

5070
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
5071
                         const Slice& property, std::string* value) {
5072
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
5073
  value->clear();
5074
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5075 5076 5077
  if (property_info == nullptr) {
    return false;
  } else if (property_info->handle_int) {
5078
    uint64_t int_value;
5079 5080
    bool ret_value =
        GetIntPropertyInternal(cfd, *property_info, false, &int_value);
5081
    if (ret_value) {
5082
      *value = ToString(int_value);
5083 5084
    }
    return ret_value;
5085
  } else if (property_info->handle_string) {
5086
    InstrumentedMutexLock l(&mutex_);
5087
    return cfd->internal_stats()->GetStringProperty(*property_info, property,
5088 5089
                                                    value);
  }
5090 5091 5092 5093
  // Shouldn't reach here since exactly one of handle_string and handle_int
  // should be non-nullptr.
  assert(false);
  return false;
J
jorlow@chromium.org 已提交
5094 5095
}

5096 5097
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
5098 5099
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5100 5101
    return false;
  }
5102
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5103
  return GetIntPropertyInternal(cfd, *property_info, false, value);
5104 5105
}

5106
bool DBImpl::GetIntPropertyInternal(ColumnFamilyData* cfd,
5107 5108 5109 5110
                                    const DBPropertyInfo& property_info,
                                    bool is_locked, uint64_t* value) {
  assert(property_info.handle_int != nullptr);
  if (!property_info.need_out_of_mutex) {
5111 5112
    if (is_locked) {
      mutex_.AssertHeld();
5113
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5114 5115
    } else {
      InstrumentedMutexLock l(&mutex_);
5116
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5117
    }
5118
  } else {
5119 5120 5121 5122 5123 5124
    SuperVersion* sv = nullptr;
    if (!is_locked) {
      sv = GetAndRefSuperVersion(cfd);
    } else {
      sv = cfd->GetSuperVersion();
    }
5125 5126

    bool ret = cfd->internal_stats()->GetIntPropertyOutOfMutex(
5127
        property_info, sv->current, value);
5128

5129 5130 5131
    if (!is_locked) {
      ReturnAndCleanupSuperVersion(cfd, sv);
    }
5132 5133 5134 5135 5136

    return ret;
  }
}

5137 5138
bool DBImpl::GetAggregatedIntProperty(const Slice& property,
                                      uint64_t* aggregated_value) {
5139 5140
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5141 5142 5143 5144 5145 5146 5147 5148 5149
    return false;
  }

  uint64_t sum = 0;
  {
    // Needs mutex to protect the list of column families.
    InstrumentedMutexLock l(&mutex_);
    uint64_t value;
    for (auto* cfd : *versions_->GetColumnFamilySet()) {
5150
      if (GetIntPropertyInternal(cfd, *property_info, true, &value)) {
5151 5152 5153 5154 5155 5156 5157 5158 5159 5160
        sum += value;
      } else {
        return false;
      }
    }
  }
  *aggregated_value = sum;
  return true;
}

5161 5162
SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
I
Igor Canadi 已提交
5163
  return cfd->GetThreadLocalSuperVersion(&mutex_);
5164 5165
}

A
agiardullo 已提交
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177
// REQUIRED: this function should only be called on the write thread or if the
// mutex is held.
SuperVersion* DBImpl::GetAndRefSuperVersion(uint32_t column_family_id) {
  auto column_family_set = versions_->GetColumnFamilySet();
  auto cfd = column_family_set->GetColumnFamily(column_family_id);
  if (!cfd) {
    return nullptr;
  }

  return GetAndRefSuperVersion(cfd);
}

A
agiardullo 已提交
5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193
// REQUIRED:  mutex is NOT held
SuperVersion* DBImpl::GetAndRefSuperVersionUnlocked(uint32_t column_family_id) {
  ColumnFamilyData* cfd;
  {
    InstrumentedMutexLock l(&mutex_);
    auto column_family_set = versions_->GetColumnFamilySet();
    cfd = column_family_set->GetColumnFamily(column_family_id);
  }

  if (!cfd) {
    return nullptr;
  }

  return GetAndRefSuperVersion(cfd);
}

5194 5195
void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
5196
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
5197 5198 5199 5200 5201

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
5202
        InstrumentedMutexLock l(&mutex_);
5203 5204 5205 5206 5207 5208 5209
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
5210 5211
}

A
agiardullo 已提交
5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223
// REQUIRED: this function should only be called on the write thread.
void DBImpl::ReturnAndCleanupSuperVersion(uint32_t column_family_id,
                                          SuperVersion* sv) {
  auto column_family_set = versions_->GetColumnFamilySet();
  auto cfd = column_family_set->GetColumnFamily(column_family_id);

  // If SuperVersion is held, and we successfully fetched a cfd using
  // GetAndRefSuperVersion(), it must still exist.
  assert(cfd != nullptr);
  ReturnAndCleanupSuperVersion(cfd, sv);
}

A
agiardullo 已提交
5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239
// REQUIRED: Mutex should NOT be held.
void DBImpl::ReturnAndCleanupSuperVersionUnlocked(uint32_t column_family_id,
                                                  SuperVersion* sv) {
  ColumnFamilyData* cfd;
  {
    InstrumentedMutexLock l(&mutex_);
    auto column_family_set = versions_->GetColumnFamilySet();
    cfd = column_family_set->GetColumnFamily(column_family_id);
  }

  // If SuperVersion is held, and we successfully fetched a cfd using
  // GetAndRefSuperVersion(), it must still exist.
  assert(cfd != nullptr);
  ReturnAndCleanupSuperVersion(cfd, sv);
}

A
agiardullo 已提交
5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251
// REQUIRED: this function should only be called on the write thread or if the
// mutex is held.
ColumnFamilyHandle* DBImpl::GetColumnFamilyHandle(uint32_t column_family_id) {
  ColumnFamilyMemTables* cf_memtables = column_family_memtables_.get();

  if (!cf_memtables->Seek(column_family_id)) {
    return nullptr;
  }

  return cf_memtables->GetColumnFamilyHandle();
}

A
agiardullo 已提交
5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265
// REQUIRED: mutex is NOT held.
ColumnFamilyHandle* DBImpl::GetColumnFamilyHandleUnlocked(
    uint32_t column_family_id) {
  ColumnFamilyMemTables* cf_memtables = column_family_memtables_.get();

  InstrumentedMutexLock l(&mutex_);

  if (!cf_memtables->Seek(column_family_id)) {
    return nullptr;
  }

  return cf_memtables->GetColumnFamilyHandle();
}

5266
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
5267 5268
                                 const Range* range, int n, uint64_t* sizes,
                                 bool include_memtable) {
J
jorlow@chromium.org 已提交
5269
  Version* v;
5270 5271
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
5272 5273
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
  v = sv->current;
J
jorlow@chromium.org 已提交
5274 5275 5276

  for (int i = 0; i < n; i++) {
    // Convert user_key into a corresponding internal key.
5277 5278 5279
    InternalKey k1(range[i].start, kMaxSequenceNumber, kValueTypeForSeek);
    InternalKey k2(range[i].limit, kMaxSequenceNumber, kValueTypeForSeek);
    sizes[i] = versions_->ApproximateSize(v, k1.Encode(), k2.Encode());
5280 5281 5282 5283
    if (include_memtable) {
      sizes[i] += sv->mem->ApproximateSize(k1.Encode(), k2.Encode());
      sizes[i] += sv->imm->ApproximateSize(k1.Encode(), k2.Encode());
    }
J
jorlow@chromium.org 已提交
5284 5285
  }

5286
  ReturnAndCleanupSuperVersion(cfd, sv);
J
jorlow@chromium.org 已提交
5287 5288
}

I
Igor Canadi 已提交
5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304
std::list<uint64_t>::iterator
DBImpl::CaptureCurrentFileNumberInPendingOutputs() {
  // We need to remember the iterator of our insert, because after the
  // background job is done, we need to remove that element from
  // pending_outputs_.
  pending_outputs_.push_back(versions_->current_next_file_number());
  auto pending_outputs_inserted_elem = pending_outputs_.end();
  --pending_outputs_inserted_elem;
  return pending_outputs_inserted_elem;
}

void DBImpl::ReleaseFileNumberFromPendingOutputs(
    std::list<uint64_t>::iterator v) {
  pending_outputs_.erase(v);
}

I
Igor Canadi 已提交
5305 5306 5307 5308 5309
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
5310
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
5311 5312 5313
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
I
Igor Canadi 已提交
5314
  return wal_manager_.GetUpdatesSince(seq, iter, read_options, versions_.get());
I
Igor Canadi 已提交
5315 5316
}

5317 5318 5319
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
5320 5321 5322
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
5323 5324
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "DeleteFile %s failed.\n", name.c_str());
5325 5326 5327
    return Status::InvalidArgument("Invalid file name");
  }

5328 5329 5330 5331
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
5332 5333
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "DeleteFile %s failed - not archived log.\n",
5334
          name.c_str());
5335 5336
      return Status::NotSupported("Delete only supported for archived logs");
    }
5337
    status = env_->DeleteFile(db_options_.wal_dir + "/" + name.c_str());
5338
    if (!status.ok()) {
5339 5340
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "DeleteFile %s failed -- %s.\n",
5341
          name.c_str(), status.ToString().c_str());
5342 5343 5344 5345
    }
    return status;
  }

5346
  int level;
I
Igor Canadi 已提交
5347
  FileMetaData* metadata;
5348
  ColumnFamilyData* cfd;
5349
  VersionEdit edit;
5350
  JobContext job_context(next_job_id_.fetch_add(1), true);
D
Dhruba Borthakur 已提交
5351
  {
5352
    InstrumentedMutexLock l(&mutex_);
5353
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
5354
    if (!status.ok()) {
5355 5356
      Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
          "DeleteFile %s failed. File not found\n", name.c_str());
I
Igor Canadi 已提交
5357
      job_context.Clean();
D
Dhruba Borthakur 已提交
5358 5359
      return Status::InvalidArgument("File not found");
    }
5360
    assert(level < cfd->NumberLevels());
5361

D
Dhruba Borthakur 已提交
5362
    // If the file is being compacted no need to delete.
5363
    if (metadata->being_compacted) {
5364
      Log(InfoLogLevel::INFO_LEVEL, db_options_.info_log,
5365
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
I
Igor Canadi 已提交
5366
      job_context.Clean();
D
Dhruba Borthakur 已提交
5367
      return Status::OK();
5368 5369
    }

D
Dhruba Borthakur 已提交
5370 5371 5372
    // 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 已提交
5373
    auto* vstoreage = cfd->current()->storage_info();
I
Igor Canadi 已提交
5374
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
S
sdong 已提交
5375
      if (vstoreage->NumLevelFiles(i) != 0) {
5376
        Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
5377
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
I
Igor Canadi 已提交
5378
        job_context.Clean();
D
Dhruba Borthakur 已提交
5379 5380 5381
        return Status::InvalidArgument("File not in last level");
      }
    }
5382
    // if level == 0, it has to be the oldest file
S
sdong 已提交
5383 5384
    if (level == 0 &&
        vstoreage->LevelFiles(0).back()->fd.GetNumber() != number) {
5385 5386
      Log(InfoLogLevel::WARN_LEVEL, db_options_.info_log,
          "DeleteFile %s failed ---"
L
Lei Jin 已提交
5387
          " target file in level 0 must be the oldest.", name.c_str());
I
Igor Canadi 已提交
5388
      job_context.Clean();
5389 5390 5391
      return Status::InvalidArgument("File in level 0, but not oldest");
    }
    edit.SetColumnFamily(cfd->GetID());
D
Dhruba Borthakur 已提交
5392
    edit.DeleteFile(level, number);
5393
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
5394
                                    &edit, &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
5395
    if (status.ok()) {
I
Igor Canadi 已提交
5396 5397
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
5398
    }
I
Igor Canadi 已提交
5399 5400
    FindObsoleteFiles(&job_context, false);
  }  // lock released here
5401

5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417
  LogFlush(db_options_.info_log);
  // remove files outside the db-lock
  if (job_context.HaveSomethingToDelete()) {
    // Call PurgeObsoleteFiles() without holding mutex.
    PurgeObsoleteFiles(job_context);
  }
  job_context.Clean();
  return status;
}

Status DBImpl::DeleteFilesInRange(ColumnFamilyHandle* column_family,
                                  const Slice* begin, const Slice* end) {
  Status status;
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  ColumnFamilyData* cfd = cfh->cfd();
  VersionEdit edit;
5418
  std::vector<FileMetaData*> deleted_files;
5419 5420 5421
  JobContext job_context(next_job_id_.fetch_add(1), true);
  {
    InstrumentedMutexLock l(&mutex_);
5422
    Version* input_version = cfd->current();
5423

5424 5425
    auto* vstorage = input_version->storage_info();
    for (int i = 1; i < cfd->NumberLevels(); i++) {
5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446
      if (vstorage->LevelFiles(i).empty() ||
          !vstorage->OverlapInLevel(i, begin, end)) {
        continue;
      }
      std::vector<FileMetaData*> level_files;
      InternalKey begin_storage, end_storage, *begin_key, *end_key;
      if (begin == nullptr) {
        begin_key = nullptr;
      } else {
        begin_storage.SetMaxPossibleForUserKey(*begin);
        begin_key = &begin_storage;
      }
      if (end == nullptr) {
        end_key = nullptr;
      } else {
        end_storage.SetMinPossibleForUserKey(*end);
        end_key = &end_storage;
      }

      vstorage->GetOverlappingInputs(i, begin_key, end_key, &level_files, -1,
                                     nullptr, false);
5447 5448 5449
      FileMetaData* level_file;
      for (uint32_t j = 0; j < level_files.size(); j++) {
        level_file = level_files[j];
5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460
        if (((begin == nullptr) ||
             (cfd->internal_comparator().user_comparator()->Compare(
                  level_file->smallest.user_key(), *begin) >= 0)) &&
            ((end == nullptr) ||
             (cfd->internal_comparator().user_comparator()->Compare(
                  level_file->largest.user_key(), *end) <= 0))) {
          if (level_file->being_compacted) {
            continue;
          }
          edit.SetColumnFamily(cfd->GetID());
          edit.DeleteFile(i, level_file->fd.GetNumber());
5461 5462
          deleted_files.push_back(level_file);
          level_file->being_compacted = true;
5463 5464 5465 5466
        }
      }
    }
    if (edit.GetDeletedFiles().empty()) {
5467
      job_context.Clean();
5468 5469
      return Status::OK();
    }
5470
    input_version->Ref();
5471 5472 5473 5474 5475 5476
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                    &edit, &mutex_, directories_.GetDbDir());
    if (status.ok()) {
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
    }
5477 5478 5479 5480
    for (auto* deleted_file : deleted_files) {
      deleted_file->being_compacted = false;
    }
    input_version->Unref();
5481 5482 5483
    FindObsoleteFiles(&job_context, false);
  }  // lock released here

5484
  LogFlush(db_options_.info_log);
I
Igor Canadi 已提交
5485
  // remove files outside the db-lock
I
Igor Canadi 已提交
5486
  if (job_context.HaveSomethingToDelete()) {
5487
    // Call PurgeObsoleteFiles() without holding mutex.
I
Igor Canadi 已提交
5488
    PurgeObsoleteFiles(job_context);
5489
  }
I
Igor Canadi 已提交
5490
  job_context.Clean();
5491 5492 5493
  return status;
}

5494
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
5495
  InstrumentedMutexLock l(&mutex_);
5496
  versions_->GetLiveFilesMetaData(metadata);
5497
}
5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508

void DBImpl::GetColumnFamilyMetaData(
    ColumnFamilyHandle* column_family,
    ColumnFamilyMetaData* cf_meta) {
  assert(column_family);
  auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  auto* sv = GetAndRefSuperVersion(cfd);
  sv->current->GetColumnFamilyMetaData(cf_meta);
  ReturnAndCleanupSuperVersion(cfd, sv);
}

I
Igor Canadi 已提交
5509
#endif  // ROCKSDB_LITE
5510

I
Igor Canadi 已提交
5511 5512 5513 5514 5515 5516 5517
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

  std::string corruption_messages;
  for (const auto& md : metadata) {
5518 5519
    // md.name has a leading "/".
    std::string file_path = md.db_path + md.name;
5520

I
Igor Canadi 已提交
5521 5522
    uint64_t fsize = 0;
    Status s = env_->GetFileSize(file_path, &fsize);
D
dyniusz 已提交
5523 5524 5525 5526
    if (!s.ok() &&
        env_->GetFileSize(Rocks2LevelTableFileName(file_path), &fsize).ok()) {
      s = Status::OK();
    }
I
Igor Canadi 已提交
5527 5528 5529 5530
    if (!s.ok()) {
      corruption_messages +=
          "Can't access " + md.name + ": " + s.ToString() + "\n";
    } else if (fsize != md.size) {
5531
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
5532
                             ". Size recorded in manifest " +
5533 5534
                             ToString(md.size) + ", actual size " +
                             ToString(fsize) + "\n";
I
Igor Canadi 已提交
5535 5536 5537 5538 5539 5540 5541 5542 5543
    }
  }
  if (corruption_messages.size() == 0) {
    return Status::OK();
  } else {
    return Status::Corruption(corruption_messages);
  }
}

5544
Status DBImpl::GetDbIdentity(std::string& identity) const {
5545 5546
  std::string idfilename = IdentityFileName(dbname_);
  const EnvOptions soptions;
5547 5548 5549 5550 5551 5552 5553 5554 5555
  unique_ptr<SequentialFileReader> id_file_reader;
  Status s;
  {
    unique_ptr<SequentialFile> idfile;
    s = env_->NewSequentialFile(idfilename, &idfile, soptions);
    if (!s.ok()) {
      return s;
    }
    id_file_reader.reset(new SequentialFileReader(std::move(idfile)));
5556
  }
5557

5558 5559 5560 5561 5562
  uint64_t file_size;
  s = env_->GetFileSize(idfilename, &file_size);
  if (!s.ok()) {
    return s;
  }
D
Dmitri Smirnov 已提交
5563
  char* buffer = reinterpret_cast<char*>(alloca(file_size));
5564
  Slice id;
5565
  s = id_file_reader->Read(static_cast<size_t>(file_size), &id, buffer);
5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576
  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 已提交
5577 5578
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
5579
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
5580
               const Slice& key, const Slice& value) {
5581 5582 5583 5584
  // 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);
5585
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
5586 5587 5588
  return Write(opt, &batch);
}

5589 5590
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
5591
  WriteBatch batch;
5592
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
5593 5594 5595
  return Write(opt, &batch);
}

A
Andres Noetzli 已提交
5596 5597 5598 5599 5600 5601 5602
Status DB::SingleDelete(const WriteOptions& opt,
                        ColumnFamilyHandle* column_family, const Slice& key) {
  WriteBatch batch;
  batch.SingleDelete(column_family, key);
  return Write(opt, &batch);
}

5603 5604
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
5605
  WriteBatch batch;
5606
  batch.Merge(column_family, key, value);
5607 5608 5609
  return Write(opt, &batch);
}

5610
// Default implementation -- returns not supported status
L
Lei Jin 已提交
5611
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
5612
                              const std::string& column_family_name,
5613
                              ColumnFamilyHandle** handle) {
5614
  return Status::NotSupported("");
5615
}
5616
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
5617
  return Status::NotSupported("");
5618
}
5619 5620 5621 5622
Status DB::DestroyColumnFamilyHandle(ColumnFamilyHandle* column_family) {
  delete column_family;
  return Status::OK();
}
5623

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

J
Jim Paton 已提交
5626
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
5627 5628 5629 5630
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
5631
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
5632
  std::vector<ColumnFamilyHandle*> handles;
5633
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
5634 5635 5636 5637 5638 5639 5640
  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;
5641 5642
}

5643 5644
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
5645
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
5646
  Status s = SanitizeOptionsByTable(db_options, column_families);
5647 5648 5649
  if (!s.ok()) {
    return s;
  }
5650

5651 5652 5653
  s = ValidateOptions(db_options, column_families);
  if (!s.ok()) {
    return s;
5654 5655
  }

5656
  *dbptr = nullptr;
5657
  handles->clear();
J
jorlow@chromium.org 已提交
5658

I
Igor Canadi 已提交
5659 5660 5661 5662
  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);
5663
  }
5664

I
Igor Canadi 已提交
5665
  DBImpl* impl = new DBImpl(db_options, dbname);
5666
  s = impl->env_->CreateDirIfMissing(impl->db_options_.wal_dir);
5667
  if (s.ok()) {
5668
    for (auto db_path : impl->db_options_.db_paths) {
5669
      s = impl->env_->CreateDirIfMissing(db_path.path);
5670 5671 5672 5673 5674 5675
      if (!s.ok()) {
        break;
      }
    }
  }

5676 5677 5678 5679 5680 5681
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
5682 5683 5684 5685
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
5686
  impl->mutex_.Lock();
5687 5688
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
5689
  if (s.ok()) {
5690
    uint64_t new_log_number = impl->versions_->NewFileNumber();
5691
    unique_ptr<WritableFile> lfile;
5692
    EnvOptions soptions(db_options);
5693 5694
    EnvOptions opt_env_options =
        impl->db_options_.env->OptimizeForLogWrite(soptions, impl->db_options_);
S
sdong 已提交
5695 5696 5697
    s = NewWritableFile(impl->db_options_.env,
                        LogFileName(impl->db_options_.wal_dir, new_log_number),
                        &lfile, opt_env_options);
J
jorlow@chromium.org 已提交
5698
    if (s.ok()) {
D
Dmitri Smirnov 已提交
5699
      lfile->SetPreallocationBlockSize((max_write_buffer_size / 10) + max_write_buffer_size);
5700
      impl->logfile_number_ = new_log_number;
5701 5702
      unique_ptr<WritableFileWriter> file_writer(
          new WritableFileWriter(std::move(lfile), opt_env_options));
5703 5704
      impl->logs_.emplace_back(
          new_log_number,
S
sdong 已提交
5705 5706
          new log::Writer(std::move(file_writer), new_log_number,
                          impl->db_options_.recycle_log_file_num > 0));
I
Igor Canadi 已提交
5707

5708 5709
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
5710 5711
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
5712 5713 5714
        if (cfd != nullptr) {
          handles->push_back(
              new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
5715
          impl->NewThreadStatusCfInfo(cfd);
I
Igor Canadi 已提交
5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731
        } 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 已提交
5732
        }
5733
      }
I
Igor Canadi 已提交
5734 5735
    }
    if (s.ok()) {
5736
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
5737
        delete impl->InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
5738
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
5739
      }
I
Igor Canadi 已提交
5740 5741
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
5742
      impl->DeleteObsoleteFiles();
5743
      s = impl->directories_.GetDbDir()->Fsync();
J
jorlow@chromium.org 已提交
5744 5745
    }
  }
5746

I
Igor Canadi 已提交
5747 5748
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
S
sdong 已提交
5749
      if (cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
S
sdong 已提交
5750
        auto* vstorage = cfd->current()->storage_info();
5751
        for (int i = 1; i < vstorage->num_levels(); ++i) {
S
sdong 已提交
5752
          int num_files = vstorage->NumLevelFiles(i);
I
Igor Canadi 已提交
5753
          if (num_files > 0) {
I
Igor Canadi 已提交
5754 5755
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
S
sdong 已提交
5756
                "open with FIFO compaction style.");
I
Igor Canadi 已提交
5757 5758 5759 5760
            break;
          }
        }
      }
S
sdong 已提交
5761 5762 5763
      if (!cfd->mem()->IsSnapshotSupported()) {
        impl->is_snapshot_supported_ = false;
      }
5764
      if (cfd->ioptions()->merge_operator != nullptr &&
5765 5766 5767 5768 5769
          !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 已提交
5770
      if (!s.ok()) {
5771 5772 5773 5774
        break;
      }
    }
  }
5775
  TEST_SYNC_POINT("DBImpl::Open:Opened");
5776
  Status persist_options_status;
5777
  if (s.ok()) {
5778 5779 5780 5781
    // Persist RocksDB Options before scheduling the compaction.
    // The WriteOptionsFile() will release and lock the mutex internally.
    persist_options_status = impl->WriteOptionsFile();

5782
    *dbptr = impl;
5783 5784 5785
    impl->opened_successfully_ = true;
    impl->MaybeScheduleFlushOrCompaction();
  }
5786 5787
  impl->mutex_.Unlock();

5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806
  auto sfm = static_cast<SstFileManagerImpl*>(
      impl->db_options_.sst_file_manager.get());
  if (s.ok() && sfm) {
    // Notify SstFileManager about all sst files that already exist in
    // db_paths[0] when the DB is opened.
    auto& db_path = impl->db_options_.db_paths[0];
    std::vector<std::string> existing_files;
    impl->db_options_.env->GetChildren(db_path.path, &existing_files);
    for (auto& file_name : existing_files) {
      uint64_t file_number;
      FileType file_type;
      std::string file_path = db_path.path + "/" + file_name;
      if (ParseFileName(file_name, &file_number, &file_type) &&
          file_type == kTableFile) {
        sfm->OnAddFile(file_path);
      }
    }
  }

J
jorlow@chromium.org 已提交
5807
  if (s.ok()) {
S
sdong 已提交
5808 5809
    Log(InfoLogLevel::INFO_LEVEL, impl->db_options_.info_log, "DB pointer %p",
        impl);
5810
    LogFlush(impl->db_options_.info_log);
5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821
    if (!persist_options_status.ok()) {
      if (db_options.fail_if_options_file_error) {
        s = Status::IOError(
            "DB::Open() failed --- Unable to persist Options file",
            persist_options_status.ToString());
      }
      Warn(impl->db_options_.info_log,
           "Unable to persist options in DB::Open() -- %s",
           persist_options_status.ToString().c_str());
    }
  }
5822
  if (!s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
5823
    for (auto* h : *handles) {
5824 5825
      delete h;
    }
5826
    handles->clear();
J
jorlow@chromium.org 已提交
5827
    delete impl;
5828
    *dbptr = nullptr;
J
jorlow@chromium.org 已提交
5829 5830 5831 5832
  }
  return s;
}

5833 5834 5835
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
5836
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
5837 5838
}

5839 5840 5841
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
5842
Status DestroyDB(const std::string& dbname, const Options& options) {
5843
  const InternalKeyComparator comparator(options.comparator);
5844
  const Options& soptions(SanitizeOptions(dbname, &comparator, options));
5845
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
5846
  std::vector<std::string> filenames;
5847

J
jorlow@chromium.org 已提交
5848 5849
  // Ignore error in case directory does not exist
  env->GetChildren(dbname, &filenames);
5850

J
jorlow@chromium.org 已提交
5851
  FileLock* lock;
5852 5853
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
5854 5855 5856
  if (result.ok()) {
    uint64_t number;
    FileType type;
5857
    InfoLogPrefix info_log_prefix(!options.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
5858
    for (size_t i = 0; i < filenames.size(); i++) {
5859
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
5860
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
5861
        Status del;
5862
        std::string path_to_delete = dbname + "/" + filenames[i];
K
Kosie van der Merwe 已提交
5863
        if (type == kMetaDatabase) {
5864 5865
          del = DestroyDB(path_to_delete, options);
        } else if (type == kTableFile) {
5866
          del = DeleteSSTFile(&options, path_to_delete, 0);
K
Kosie van der Merwe 已提交
5867
        } else {
5868
          del = env->DeleteFile(path_to_delete);
K
Kosie van der Merwe 已提交
5869
        }
J
jorlow@chromium.org 已提交
5870 5871 5872 5873 5874
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
5875

5876 5877
    for (size_t path_id = 0; path_id < options.db_paths.size(); path_id++) {
      const auto& db_path = options.db_paths[path_id];
5878
      env->GetChildren(db_path.path, &filenames);
5879 5880 5881
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
5882
          std::string table_path = db_path.path + "/" + filenames[i];
5883 5884
          Status del = DeleteSSTFile(&options, table_path,
                                     static_cast<uint32_t>(path_id));
5885 5886 5887 5888 5889 5890 5891
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

I
Igor Canadi 已提交
5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909
    std::vector<std::string> walDirFiles;
    std::string archivedir = ArchivalDirectory(dbname);
    if (dbname != soptions.wal_dir) {
      env->GetChildren(soptions.wal_dir, &walDirFiles);
      archivedir = ArchivalDirectory(soptions.wal_dir);
    }

    // Delete log files in the WAL dir
    for (const auto& file : walDirFiles) {
      if (ParseFileName(file, &number, &type) && type == kLogFile) {
        Status del = env->DeleteFile(soptions.wal_dir + "/" + file);
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }

    std::vector<std::string> archiveFiles;
5910
    env->GetChildren(archivedir, &archiveFiles);
5911 5912
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
5913 5914
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
5915
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
5916 5917 5918 5919 5920
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
5921

5922
    // ignore case where no archival directory is present.
5923
    env->DeleteDir(archivedir);
5924

J
jorlow@chromium.org 已提交
5925
    env->UnlockFile(lock);  // Ignore error since state is already gone
5926
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
5927
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
5928
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
5929 5930 5931 5932
  }
  return result;
}

5933 5934
Status DBImpl::WriteOptionsFile() {
#ifndef ROCKSDB_LITE
5935
  mutex_.AssertHeld();
5936 5937 5938

  std::vector<std::string> cf_names;
  std::vector<ColumnFamilyOptions> cf_opts;
5939 5940 5941 5942 5943

  // This part requires mutex to protect the column family options
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
5944
    }
5945 5946 5947
    cf_names.push_back(cfd->GetName());
    cf_opts.push_back(BuildColumnFamilyOptions(
        *cfd->options(), *cfd->GetLatestMutableCFOptions()));
5948 5949
  }

5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962
  // Unlock during expensive operations.  New writes cannot get here
  // because the single write thread ensures all new writes get queued.
  mutex_.Unlock();

  std::string file_name =
      TempOptionsFileName(GetName(), versions_->NewFileNumber());
  Status s = PersistRocksDBOptions(GetDBOptions(), cf_names, cf_opts, file_name,
                                   GetEnv());

  if (s.ok()) {
    s = RenameTempFileToOptionsFile(file_name);
  }
  mutex_.Lock();
5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021
  return s;
#else
  return Status::OK();
#endif  // !ROCKSDB_LITE
}

#ifndef ROCKSDB_LITE
namespace {
void DeleteOptionsFilesHelper(const std::map<uint64_t, std::string>& filenames,
                              const size_t num_files_to_keep,
                              const std::shared_ptr<Logger>& info_log,
                              Env* env) {
  if (filenames.size() <= num_files_to_keep) {
    return;
  }
  for (auto iter = std::next(filenames.begin(), num_files_to_keep);
       iter != filenames.end(); ++iter) {
    if (!env->DeleteFile(iter->second).ok()) {
      Warn(info_log, "Unable to delete options file %s", iter->second.c_str());
    }
  }
}
}  // namespace
#endif  // !ROCKSDB_LITE

Status DBImpl::DeleteObsoleteOptionsFiles() {
#ifndef ROCKSDB_LITE
  std::vector<std::string> filenames;
  // use ordered map to store keep the filenames sorted from the newest
  // to the oldest.
  std::map<uint64_t, std::string> options_filenames;
  Status s;
  s = GetEnv()->GetChildren(GetName(), &filenames);
  if (!s.ok()) {
    return s;
  }
  for (auto& filename : filenames) {
    uint64_t file_number;
    FileType type;
    if (ParseFileName(filename, &file_number, &type) && type == kOptionsFile) {
      options_filenames.insert(
          {std::numeric_limits<uint64_t>::max() - file_number,
           GetName() + "/" + filename});
    }
  }

  // Keeps the latest 2 Options file
  const size_t kNumOptionsFilesKept = 2;
  DeleteOptionsFilesHelper(options_filenames, kNumOptionsFilesKept,
                           db_options_.info_log, GetEnv());
  return Status::OK();
#else
  return Status::OK();
#endif  // !ROCKSDB_LITE
}

Status DBImpl::RenameTempFileToOptionsFile(const std::string& file_name) {
#ifndef ROCKSDB_LITE
  Status s;
W
Wanning Jiang 已提交
6022 6023

  versions_->options_file_number_ = versions_->NewFileNumber();
6024
  std::string options_file_name =
W
Wanning Jiang 已提交
6025
      OptionsFileName(GetName(), versions_->options_file_number_);
6026 6027 6028 6029 6030 6031 6032 6033 6034 6035
  // Retry if the file name happen to conflict with an existing one.
  s = GetEnv()->RenameFile(file_name, options_file_name);

  DeleteObsoleteOptionsFiles();
  return s;
#else
  return Status::OK();
#endif  // !ROCKSDB_LITE
}

Y
Yueh-Hsuan Chiang 已提交
6036
#if ROCKSDB_USING_THREAD_STATUS
6037

Y
Yueh-Hsuan Chiang 已提交
6038 6039
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6040
  if (db_options_.enable_thread_tracking) {
6041 6042
    ThreadStatusUtil::NewColumnFamilyInfo(this, cfd, cfd->GetName(),
                                          cfd->ioptions()->env);
6043
  }
Y
Yueh-Hsuan Chiang 已提交
6044 6045 6046 6047
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6048
  if (db_options_.enable_thread_tracking) {
6049
    ThreadStatusUtil::EraseColumnFamilyInfo(cfd);
6050
  }
Y
Yueh-Hsuan Chiang 已提交
6051 6052 6053
}

void DBImpl::EraseThreadStatusDbInfo() const {
6054
  if (db_options_.enable_thread_tracking) {
6055
    ThreadStatusUtil::EraseDatabaseInfo(this);
6056
  }
Y
Yueh-Hsuan Chiang 已提交
6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071
}

#else
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
}

void DBImpl::EraseThreadStatusDbInfo() const {
}
#endif  // ROCKSDB_USING_THREAD_STATUS

6072 6073
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
6074
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
6075
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
6076 6077
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
6078 6079 6080 6081
  Header(log, "RocksDB version: %d.%d.%d\n", ROCKSDB_MAJOR, ROCKSDB_MINOR,
         ROCKSDB_PATCH);
  Header(log, "Git sha %s", rocksdb_build_git_sha);
  Header(log, "Compile date %s", rocksdb_build_compile_date);
I
Igor Canadi 已提交
6082
#endif
6083 6084
}

A
agiardullo 已提交
6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101
#ifndef ROCKSDB_LITE
SequenceNumber DBImpl::GetEarliestMemTableSequenceNumber(SuperVersion* sv,
                                                         bool include_history) {
  // Find the earliest sequence number that we know we can rely on reading
  // from the memtable without needing to check sst files.
  SequenceNumber earliest_seq =
      sv->imm->GetEarliestSequenceNumber(include_history);
  if (earliest_seq == kMaxSequenceNumber) {
    earliest_seq = sv->mem->GetEarliestSequenceNumber();
  }
  assert(sv->mem->GetEarliestSequenceNumber() >= earliest_seq);

  return earliest_seq;
}
#endif  // ROCKSDB_LITE

#ifndef ROCKSDB_LITE
6102 6103 6104
Status DBImpl::GetLatestSequenceForKey(SuperVersion* sv, const Slice& key,
                                       bool cache_only, SequenceNumber* seq,
                                       bool* found_record_for_key) {
A
agiardullo 已提交
6105 6106 6107 6108 6109 6110 6111
  Status s;
  MergeContext merge_context;

  SequenceNumber current_seq = versions_->LastSequence();
  LookupKey lkey(key, current_seq);

  *seq = kMaxSequenceNumber;
6112 6113
  *found_record_for_key = false;

A
agiardullo 已提交
6114
  // Check if there is a record for this key in the latest memtable
R
Reid Horuff 已提交
6115
  sv->mem->Get(lkey, nullptr, &s, &merge_context, seq);
A
agiardullo 已提交
6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "Unexpected status returned from MemTable::Get: %s\n",
        s.ToString().c_str());

    return s;
  }

  if (*seq != kMaxSequenceNumber) {
    // Found a sequence number, no need to check immutable memtables
6128
    *found_record_for_key = true;
A
agiardullo 已提交
6129 6130 6131 6132
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
R
Reid Horuff 已提交
6133
  sv->imm->Get(lkey, nullptr, &s, &merge_context, seq);
A
agiardullo 已提交
6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "Unexpected status returned from MemTableList::Get: %s\n",
        s.ToString().c_str());

    return s;
  }

  if (*seq != kMaxSequenceNumber) {
    // Found a sequence number, no need to check memtable history
6146
    *found_record_for_key = true;
A
agiardullo 已提交
6147 6148 6149 6150
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
R
Reid Horuff 已提交
6151
  sv->imm->GetFromHistory(lkey, nullptr, &s, &merge_context, seq);
A
agiardullo 已提交
6152 6153 6154 6155 6156 6157 6158 6159 6160 6161

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
    Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
        "Unexpected status returned from MemTableList::GetFromHistory: %s\n",
        s.ToString().c_str());

    return s;
  }

6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173
  if (*seq != kMaxSequenceNumber) {
    // Found a sequence number, no need to check SST files
    *found_record_for_key = true;
    return Status::OK();
  }

  // TODO(agiardullo): possible optimization: consider checking cached
  // SST files if cache_only=true?
  if (!cache_only) {
    // Check tables
    ReadOptions read_options;

R
Reid Horuff 已提交
6174
    sv->current->Get(read_options, lkey, nullptr, &s, &merge_context,
6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186
                     nullptr /* value_found */, found_record_for_key, seq);

    if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
      // unexpected error reading SST files
      Log(InfoLogLevel::ERROR_LEVEL, db_options_.info_log,
          "Unexpected status returned from Version::Get: %s\n",
          s.ToString().c_str());

      return s;
    }
  }

A
agiardullo 已提交
6187 6188 6189 6190
  return Status::OK();
}
#endif  // ROCKSDB_LITE

6191
}  // namespace rocksdb