db_impl.cc 224.6 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"
42
#include "db/external_sst_file_ingestion_job.h"
J
jorlow@chromium.org 已提交
43
#include "db/filename.h"
44 45
#include "db/flush_job.h"
#include "db/forward_iterator.h"
I
Igor Canadi 已提交
46
#include "db/job_context.h"
J
jorlow@chromium.org 已提交
47 48
#include "db/log_reader.h"
#include "db/log_writer.h"
V
Venkatesh Radhakrishnan 已提交
49
#include "db/managed_iterator.h"
J
jorlow@chromium.org 已提交
50
#include "db/memtable.h"
K
kailiu 已提交
51
#include "db/memtable_list.h"
52
#include "db/merge_context.h"
53
#include "db/merge_helper.h"
J
jorlow@chromium.org 已提交
54
#include "db/table_cache.h"
K
kailiu 已提交
55
#include "db/table_properties_collector.h"
56
#include "db/transaction_log_impl.h"
J
jorlow@chromium.org 已提交
57 58
#include "db/version_set.h"
#include "db/write_batch_internal.h"
A
agiardullo 已提交
59
#include "db/write_callback.h"
60
#include "db/xfunc_test_points.h"
61 62
#include "memtable/hash_linklist_rep.h"
#include "memtable/hash_skiplist_rep.h"
63
#include "port/likely.h"
64
#include "port/port.h"
I
Igor Canadi 已提交
65
#include "rocksdb/cache.h"
66 67 68 69 70 71
#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 已提交
72
#include "rocksdb/table.h"
73
#include "rocksdb/version.h"
74
#include "rocksdb/wal_filter.h"
75
#include "rocksdb/write_buffer_manager.h"
J
jorlow@chromium.org 已提交
76
#include "table/block.h"
77
#include "table/block_based_table_factory.h"
J
jorlow@chromium.org 已提交
78
#include "table/merger.h"
K
kailiu 已提交
79
#include "table/table_builder.h"
J
jorlow@chromium.org 已提交
80
#include "table/two_level_iterator.h"
K
kailiu 已提交
81
#include "util/autovector.h"
82
#include "util/build_version.h"
83
#include "util/cf_options.h"
J
jorlow@chromium.org 已提交
84
#include "util/coding.h"
I
Igor Canadi 已提交
85
#include "util/compression.h"
86
#include "util/crc32c.h"
87
#include "util/file_reader_writer.h"
88
#include "util/file_util.h"
89
#include "util/iostats_context_imp.h"
H
Haobo Xu 已提交
90
#include "util/log_buffer.h"
91
#include "util/logging.h"
J
jorlow@chromium.org 已提交
92
#include "util/mutexlock.h"
93 94
#include "util/options_helper.h"
#include "util/options_parser.h"
95
#include "util/perf_context_imp.h"
96
#include "util/sst_file_manager_impl.h"
97
#include "util/stop_watch.h"
98
#include "util/string_util.h"
99
#include "util/sync_point.h"
100 101
#include "util/thread_status_updater.h"
#include "util/thread_status_util.h"
V
Venkatesh Radhakrishnan 已提交
102
#include "util/xfunc.h"
J
jorlow@chromium.org 已提交
103

104
namespace rocksdb {
J
jorlow@chromium.org 已提交
105

106
const std::string kDefaultColumnFamilyName("default");
107

I
Igor Canadi 已提交
108
void DumpRocksDBBuildVersion(Logger * log);
109

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

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

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

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

136 137
  // result.max_open_files means an "infinite" open files.
  if (result.max_open_files != -1) {
I
Igor Canadi 已提交
138 139 140 141 142
    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);
143
  }
144

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

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

173 174 175 176
  if (result.WAL_ttl_seconds > 0 || result.WAL_size_limit_MB > 0) {
    result.recycle_log_file_num = false;
  }

177 178 179 180 181 182 183 184 185 186 187
  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;
  }

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

196
  if (result.db_paths.size() == 0) {
197
    result.db_paths.emplace_back(dbname, std::numeric_limits<uint64_t>::max());
198 199
  }

200 201 202 203
  if (result.compaction_readahead_size > 0) {
    result.new_table_reader_for_compaction_inputs = true;
  }

204 205 206 207 208 209 210
  // 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 已提交
211 212 213
  return result;
}

214 215
namespace {

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

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 264 265 266
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 已提交
267 268 269
CompressionType GetCompressionFlush(
    const ImmutableCFOptions& ioptions,
    const MutableCFOptions& mutable_cf_options) {
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.
273
  if (ioptions.compaction_style == kCompactionStyleUniversal) {
274 275 276 277 278 279 280 281
    if (ioptions.compaction_options_universal.compression_size_percent < 0) {
      return mutable_cf_options.compression;
    } else {
      return kNoCompression;
    }
  } else if (!ioptions.compression_per_level.empty()) {
    // For leveled compress when min_level_to_compress != 0.
    return ioptions.compression_per_level[0];
282
  } else {
A
Aaron Gao 已提交
283
    return mutable_cf_options.compression;
284 285
  }
}
I
Igor Canadi 已提交
286

287
void DumpSupportInfo(Logger* logger) {
I
Igor Canadi 已提交
288 289 290 291 292 293 294 295
  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());
296 297
  Log(InfoLogLevel::INFO_LEVEL, logger, "Fast CRC32 supported: %d",
      crc32c::IsFastCrc32Supported());
I
Igor Canadi 已提交
298 299
}

300
}  // namespace
301

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

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

363
  versions_.reset(new VersionSet(dbname_, &immutable_db_options_, env_options_,
364
                                 table_cache_.get(), write_buffer_manager_,
365
                                 &write_controller_));
366 367
  column_family_memtables_.reset(
      new ColumnFamilyMemTablesImpl(versions_->GetColumnFamilySet()));
368

369 370 371 372 373
  DumpRocksDBBuildVersion(immutable_db_options_.info_log.get());
  DumpDBFileSummary(immutable_db_options_, dbname_);
  immutable_db_options_.Dump(immutable_db_options_.info_log.get());
  mutable_db_options_.Dump(immutable_db_options_.info_log.get());
  DumpSupportInfo(immutable_db_options_.info_log.get());
J
jorlow@chromium.org 已提交
374 375
}

376
// Will lock the mutex_,  will wait for completion if wait is true
377
void DBImpl::CancelAllBackgroundWork(bool wait) {
378
  InstrumentedMutexLock l(&mutex_);
379

380 381
  if (!shutting_down_.load(std::memory_order_acquire) &&
      has_unpersisted_data_) {
382
    for (auto cfd : *versions_->GetColumnFamilySet()) {
383
      if (!cfd->IsDropped() && !cfd->mem()->IsEmpty()) {
384 385 386 387
        cfd->Ref();
        mutex_.Unlock();
        FlushMemTable(cfd, FlushOptions());
        mutex_.Lock();
388
        cfd->Unref();
389 390
      }
    }
391
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
392
  }
393 394 395 396 397 398 399 400 401 402 403 404 405

  shutting_down_.store(true, std::memory_order_release);
  bg_cv_.SignalAll();
  if (!wait) {
    return;
  }
  // Wait for background work to finish
  while (bg_compaction_scheduled_ || bg_flush_scheduled_) {
    bg_cv_.Wait();
  }
}

DBImpl::~DBImpl() {
406 407
  // CancelAllBackgroundWork called with false means we just set the shutdown
  // marker. After this we do a variant of the waiting and unschedule work
408 409
  // (to consider: moving all the waiting into CancelAllBackgroundWork(true))
  CancelAllBackgroundWork(false);
410 411 412 413 414 415 416
  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
417 418 419
  while (bg_compaction_scheduled_ || bg_flush_scheduled_ ||
         bg_purge_scheduled_) {
    TEST_SYNC_POINT("DBImpl::~DBImpl:WaitJob");
420 421
    bg_cv_.Wait();
  }
422
  EraseThreadStatusDbInfo();
I
Igor Canadi 已提交
423 424
  flush_scheduler_.Clear();

425 426 427 428 429 430 431 432 433 434 435 436 437
  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 已提交
438 439 440 441 442
  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();
443 444
  }

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

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

468 469 470
  for (auto l : logs_to_free_) {
    delete l;
  }
471 472 473
  for (auto& log : logs_) {
    log.ClearWriter();
  }
474
  logs_.clear();
475

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
  // 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 已提交
491 492 493 494
  for (auto& txn_entry : recovered_transactions_) {
    delete txn_entry.second;
  }

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

503
  LogFlush(immutable_db_options_.info_log);
J
jorlow@chromium.org 已提交
504 505 506
}

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

512 513
  Status s;

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

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

555
const Status DBImpl::CreateArchivalDirectory() {
556 557 558
  if (immutable_db_options_.wal_ttl_seconds > 0 ||
      immutable_db_options_.wal_size_limit_mb > 0) {
    std::string archivalPath = ArchivalDirectory(immutable_db_options_.wal_dir);
559 560 561 562 563
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

564
void DBImpl::PrintStatistics() {
565
  auto dbstats = immutable_db_options_.statistics.get();
566
  if (dbstats) {
567 568
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
        "STATISTICS:\n %s", dbstats->ToString().c_str());
569 570 571
  }
}

572
#ifndef ROCKSDB_LITE
573 574 575 576 577 578 579 580 581 582 583 584 585 586
#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;
  }

587
  snprintf(mstat->cur, buf_size, "%s", status);
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
  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
}
603
#endif  // !ROCKSDB_LITE
604

605
void DBImpl::MaybeDumpStats() {
606
  if (immutable_db_options_.stats_dump_period_sec == 0) return;
H
Haobo Xu 已提交
607 608 609 610

  const uint64_t now_micros = env_->NowMicros();

  if (last_stats_dump_time_microsec_ +
611 612
          immutable_db_options_.stats_dump_period_sec * 1000000 <=
      now_micros) {
H
Haobo Xu 已提交
613 614 615 616 617
    // 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;
618

619
#ifndef ROCKSDB_LITE
620 621 622 623 624 625 626
    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 已提交
627
    std::string stats;
628
    {
629
      InstrumentedMutexLock l(&mutex_);
630
      for (auto cfd : *versions_->GetColumnFamilySet()) {
631 632
        cfd->internal_stats()->GetStringProperty(
            *cf_property_info, DB::Properties::kCFStats, &stats);
633
      }
634 635
      default_cf_internal_stats_->GetStringProperty(
          *db_property_info, DB::Properties::kDBStats, &stats);
636
    }
637
    if (immutable_db_options_.dump_malloc_stats) {
638 639
      DumpMallocStats(&stats);
    }
640 641 642 643
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
        "------- DUMPING STATS -------");
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log, "%s",
        stats.c_str());
644
#endif  // !ROCKSDB_LITE
645

646
    PrintStatistics();
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 691 692 693 694
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 已提交
695
  std::lock_guard<std::mutex> lock(prep_heap_mutex_);
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
  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;
}

723 724 725 726 727 728 729 730 731 732
void DBImpl::ScheduleBgLogWriterClose(JobContext* job_context) {
  if (!job_context->logs_to_free.empty()) {
    for (auto l : job_context->logs_to_free) {
      AddToLogsToFreeQueue(l);
    }
    job_context->logs_to_free.clear();
    SchedulePurge();
  }
}

I
Igor Canadi 已提交
733
// * Returns the list of live files in 'sst_live'
I
Igor Canadi 已提交
734
// If it's doing full scan:
I
Igor Canadi 已提交
735 736
// * Returns the list of all files in the filesystem in
// 'full_scan_candidate_files'.
I
Igor Canadi 已提交
737
// Otherwise, gets obsolete files from VersionSet.
I
Igor Canadi 已提交
738 739
// no_full_scan = true -- never do the full scan using GetChildren()
// force = false -- don't force the full scan, except every
740
//  immutable_db_options_.delete_obsolete_files_period_micros
I
Igor Canadi 已提交
741
// force = true -- force the full scan
I
Igor Canadi 已提交
742
void DBImpl::FindObsoleteFiles(JobContext* job_context, bool force,
I
Igor Canadi 已提交
743
                               bool no_full_scan) {
D
Dhruba Borthakur 已提交
744 745
  mutex_.AssertHeld();

746
  // if deletion is disabled, do nothing
747
  if (disable_delete_obsolete_files_ > 0) {
748 749 750
    return;
  }

751 752 753 754 755
  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;
756 757
  } else if (force ||
             immutable_db_options_.delete_obsolete_files_period_micros == 0) {
758 759 760
    doing_the_full_scan = true;
  } else {
    const uint64_t now_micros = env_->NowMicros();
I
Igor Canadi 已提交
761
    if (delete_obsolete_files_next_run_ < now_micros) {
762
      doing_the_full_scan = true;
I
Igor Canadi 已提交
763
      delete_obsolete_files_next_run_ =
764 765
          now_micros +
          immutable_db_options_.delete_obsolete_files_period_micros;
766 767 768
    }
  }

I
Igor Canadi 已提交
769 770
  // don't delete files that might be currently written to from compaction
  // threads
771 772 773
  // 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 已提交
774 775 776 777 778 779 780
  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();
  }

781 782
  // Get obsolete files.  This function will also update the list of
  // pending files in VersionSet().
I
Igor Canadi 已提交
783
  versions_->GetObsoleteFiles(&job_context->sst_delete_files,
784
                              &job_context->manifest_delete_files,
I
Igor Canadi 已提交
785
                              job_context->min_pending_output);
I
Igor Canadi 已提交
786

I
Igor Canadi 已提交
787
  // store the current filenum, lognum, etc
788
  job_context->manifest_file_number = versions_->manifest_file_number();
I
Igor Canadi 已提交
789
  job_context->pending_manifest_file_number =
790
      versions_->pending_manifest_file_number();
I
Igor Canadi 已提交
791
  job_context->log_number = versions_->MinLogNumber();
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817

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

818
  job_context->prev_log_number = versions_->prev_log_number();
I
Igor Canadi 已提交
819

I
Igor Canadi 已提交
820
  versions_->AddLiveFiles(&job_context->sst_live);
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
  if (doing_the_full_scan) {
    for (size_t path_id = 0; path_id < immutable_db_options_.db_paths.size();
         path_id++) {
      // set of all files in the directory. We'll exclude files that are still
      // alive in the subsequent processings.
      std::vector<std::string> files;
      env_->GetChildren(immutable_db_options_.db_paths[path_id].path,
                        &files);  // Ignore errors
      for (std::string file : files) {
        // TODO(icanadi) clean up this mess to avoid having one-off "/" prefixes
        job_context->full_scan_candidate_files.emplace_back(
            "/" + file, static_cast<uint32_t>(path_id));
      }
    }

    // Add log files in wal_dir
    if (immutable_db_options_.wal_dir != dbname_) {
      std::vector<std::string> log_files;
      env_->GetChildren(immutable_db_options_.wal_dir,
                        &log_files);  // Ignore errors
      for (std::string log_file : log_files) {
        job_context->full_scan_candidate_files.emplace_back(log_file, 0);
      }
    }
    // Add info log files in db_log_dir
    if (!immutable_db_options_.db_log_dir.empty() &&
        immutable_db_options_.db_log_dir != dbname_) {
      std::vector<std::string> info_log_files;
      // Ignore errors
      env_->GetChildren(immutable_db_options_.db_log_dir, &info_log_files);
      for (std::string log_file : info_log_files) {
        job_context->full_scan_candidate_files.emplace_back(log_file, 0);
      }
    }
  }
856

857 858 859
  // logs_ is empty when called during recovery, in which case there can't yet
  // be any tracked obsolete logs
  if (!alive_log_files_.empty() && !logs_.empty()) {
860
    uint64_t min_log_number = job_context->log_number;
S
sdong 已提交
861
    size_t num_alive_log_files = alive_log_files_.size();
862 863 864
    // find newly obsoleted log files
    while (alive_log_files_.begin()->number < min_log_number) {
      auto& earliest = *alive_log_files_.begin();
865 866 867
      if (immutable_db_options_.recycle_log_file_num >
          log_recycle_files.size()) {
        Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
S
Sage Weil 已提交
868 869 870 871 872
            "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 已提交
873 874 875 876 877
      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;
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
      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_;
A
Andrew Kryczka 已提交
901 902
  job_context->log_recycle_files.assign(log_recycle_files.begin(),
                                        log_recycle_files.end());
903
  logs_to_free_.clear();
904 905
}

906
namespace {
I
Igor Canadi 已提交
907 908
bool CompareCandidateFile(const JobContext::CandidateFileInfo& first,
                          const JobContext::CandidateFileInfo& second) {
909 910 911 912 913
  if (first.file_name > second.file_name) {
    return true;
  } else if (first.file_name < second.file_name) {
    return false;
  } else {
914
    return (first.path_id > second.path_id);
915 916 917 918
  }
}
};  // namespace

919 920 921 922 923
// 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) {
924 925
    file_deletion_status =
        DeleteSSTFile(&immutable_db_options_, fname, path_id);
926 927 928 929
  } else {
    file_deletion_status = env_->DeleteFile(fname);
  }
  if (file_deletion_status.ok()) {
930
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
931 932 933
        "[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()) {
934
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
935 936 937 938 939
        "[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 {
940
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
941 942 943 944 945 946
        "[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(),
947
        immutable_db_options_.listeners);
948 949 950
  }
}

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

I
Igor Canadi 已提交
959 960 961 962
  // 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 已提交
963 964
    return;
  }
965

966
  // Now, convert live list to an unordered map, WITHOUT mutex held;
967
  // set is slow.
968
  std::unordered_map<uint64_t, const FileDescriptor*> sst_live_map;
I
Igor Canadi 已提交
969
  for (const FileDescriptor& fd : state.sst_live) {
970 971
    sst_live_map[fd.GetNumber()] = &fd;
  }
A
Andrew Kryczka 已提交
972 973
  std::unordered_set<uint64_t> log_recycle_files_set(
      state.log_recycle_files.begin(), state.log_recycle_files.end());
I
Igor Canadi 已提交
974

I
Igor Canadi 已提交
975
  auto candidate_files = state.full_scan_candidate_files;
976 977 978
  candidate_files.reserve(
      candidate_files.size() + state.sst_delete_files.size() +
      state.log_delete_files.size() + state.manifest_delete_files.size());
K
kailiu 已提交
979 980
  // We may ignore the dbname when generating the file names.
  const char* kDumbDbName = "";
981
  for (auto file : state.sst_delete_files) {
982 983 984
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
985
    delete file;
I
Igor Canadi 已提交
986 987
  }

K
kailiu 已提交
988 989
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
990
      candidate_files.emplace_back(LogFileName(kDumbDbName, file_num), 0);
I
Igor Canadi 已提交
991 992
    }
  }
993 994 995
  for (const auto& filename : state.manifest_delete_files) {
    candidate_files.emplace_back(filename, 0);
  }
996

K
kailiu 已提交
997
  // dedup state.candidate_files so we don't try to delete the same
I
Igor Canadi 已提交
998
  // file twice
999 1000 1001 1002 1003
  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 已提交
1004

S
sdong 已提交
1005
  if (state.prev_total_log_size > 0) {
1006
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
S
sdong 已提交
1007 1008 1009 1010 1011 1012 1013
        "[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);
  }

1014
  std::vector<std::string> old_info_log_files;
1015 1016
  InfoLogPrefix info_log_prefix(!immutable_db_options_.db_log_dir.empty(),
                                dbname_);
1017 1018 1019
  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 已提交
1020 1021 1022
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
1023
    if (!ParseFileName(to_delete, &number, info_log_prefix.prefix, &type)) {
K
kailiu 已提交
1024 1025
      continue;
    }
J
jorlow@chromium.org 已提交
1026

K
kailiu 已提交
1027 1028 1029 1030
    bool keep = true;
    switch (type) {
      case kLogFile:
        keep = ((number >= state.log_number) ||
A
Andrew Kryczka 已提交
1031 1032 1033
                (number == state.prev_log_number) ||
                (log_recycle_files_set.find(number) !=
                 log_recycle_files_set.end()));
K
kailiu 已提交
1034 1035 1036
        break;
      case kDescriptorFile:
        // Keep my manifest file, and any newer incarnations'
1037
        // (can happen during manifest roll)
K
kailiu 已提交
1038 1039 1040
        keep = (number >= state.manifest_file_number);
        break;
      case kTableFile:
I
Igor Canadi 已提交
1041 1042 1043 1044
        // 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 已提交
1045 1046 1047
        break;
      case kTempFile:
        // Any temp files that are currently being written to must
1048 1049 1050 1051
        // 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
1052 1053 1054
        //
        // TODO(yhchiang): carefully modify the third condition to safely
        //                 remove the temp options files.
1055
        keep = (sst_live_map.find(number) != sst_live_map.end()) ||
1056 1057
               (number == state.pending_manifest_file_number) ||
               (to_delete.find(kOptionsFileNamePrefix) != std::string::npos);
K
kailiu 已提交
1058 1059 1060 1061
        break;
      case kInfoLogFile:
        keep = true;
        if (number != 0) {
1062
          old_info_log_files.push_back(to_delete);
J
jorlow@chromium.org 已提交
1063
        }
K
kailiu 已提交
1064 1065 1066 1067 1068
        break;
      case kCurrentFile:
      case kDBLockFile:
      case kIdentityFile:
      case kMetaDatabase:
1069
      case kOptionsFile:
K
kailiu 已提交
1070 1071 1072 1073 1074 1075 1076 1077
        keep = true;
        break;
    }

    if (keep) {
      continue;
    }

1078
    std::string fname;
K
kailiu 已提交
1079 1080
    if (type == kTableFile) {
      // evict from cache
1081
      TableCache::Evict(table_cache_.get(), number);
1082
      fname = TableFileName(immutable_db_options_.db_paths, number, path_id);
1083
    } else {
1084 1085
      fname = ((type == kLogFile) ? immutable_db_options_.wal_dir : dbname_) +
              "/" + to_delete;
K
kailiu 已提交
1086
    }
1087

1088
#ifndef ROCKSDB_LITE
1089 1090
    if (type == kLogFile && (immutable_db_options_.wal_ttl_seconds > 0 ||
                             immutable_db_options_.wal_size_limit_mb > 0)) {
I
Igor Canadi 已提交
1091
      wal_manager_.ArchiveWALFile(fname, number);
1092 1093 1094
      continue;
    }
#endif  // !ROCKSDB_LITE
S
sdong 已提交
1095

I
Islam AbdelRahman 已提交
1096
    Status file_deletion_status;
1097 1098 1099
    if (schedule_only) {
      InstrumentedMutexLock guard_lock(&mutex_);
      SchedulePendingPurge(fname, type, number, path_id, state.job_id);
1100
    } else {
1101 1102
      DeleteObsoleteFileImpl(file_deletion_status, state.job_id, fname, type,
                             number, path_id);
J
jorlow@chromium.org 已提交
1103 1104
    }
  }
H
heyongqiang 已提交
1105

1106
  // Delete old info log files.
1107
  size_t old_info_log_file_count = old_info_log_files.size();
1108
  if (old_info_log_file_count != 0 &&
1109
      old_info_log_file_count >= immutable_db_options_.keep_log_file_num) {
1110
    std::sort(old_info_log_files.begin(), old_info_log_files.end());
1111 1112
    size_t end =
        old_info_log_file_count - immutable_db_options_.keep_log_file_num;
1113
    for (unsigned int i = 0; i <= end; i++) {
1114
      std::string& to_delete = old_info_log_files.at(i);
1115 1116 1117 1118 1119 1120
      std::string full_path_to_delete =
          (immutable_db_options_.db_log_dir.empty()
               ? dbname_
               : immutable_db_options_.db_log_dir) +
          "/" + to_delete;
      Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
1121
          "[JOB %d] Delete info log file %s\n", state.job_id,
1122 1123
          full_path_to_delete.c_str());
      Status s = env_->DeleteFile(full_path_to_delete);
1124
      if (!s.ok()) {
1125
        if (env_->FileExists(full_path_to_delete).IsNotFound()) {
1126
          Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
1127 1128 1129 1130
              "[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 {
1131
          Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
1132 1133 1134
              "[JOB %d] Delete info log file %s FAILED -- %s\n", state.job_id,
              to_delete.c_str(), s.ToString().c_str());
        }
1135
      }
H
heyongqiang 已提交
1136 1137
    }
  }
I
Igor Canadi 已提交
1138 1139 1140
#ifndef ROCKSDB_LITE
  wal_manager_.PurgeObsoleteWALFiles();
#endif  // ROCKSDB_LITE
1141
  LogFlush(immutable_db_options_.info_log);
D
Dhruba Borthakur 已提交
1142 1143 1144 1145
}

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
1146
  JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
1147
  FindObsoleteFiles(&job_context, true);
1148 1149

  mutex_.Unlock();
I
Igor Canadi 已提交
1150 1151
  if (job_context.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(job_context);
1152
  }
I
Igor Canadi 已提交
1153
  job_context.Clean();
1154
  mutex_.Lock();
1155 1156
}

1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
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 已提交
1173

1174 1175 1176 1177 1178 1179 1180 1181 1182
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_);
1183 1184 1185
    if (!s.ok()) {
      return s;
    }
1186
  }
1187

1188 1189 1190 1191 1192 1193 1194 1195
  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);
1196 1197 1198
      if (!s.ok()) {
        return s;
      }
1199
      data_dirs_.emplace_back(path_directory.release());
1200
    }
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
  }
  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,
1218
    bool error_if_log_file_exist, bool error_if_data_exists_in_logs) {
1219
  mutex_.AssertHeld();
1220

1221 1222 1223
  bool is_new_db = false;
  assert(db_lock_ == nullptr);
  if (!read_only) {
1224 1225 1226
    Status s = directories_.SetDirectories(env_, dbname_,
                                           immutable_db_options_.wal_dir,
                                           immutable_db_options_.db_paths);
1227 1228 1229 1230
    if (!s.ok()) {
      return s;
    }

1231
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
1232 1233 1234
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
1235

A
agiardullo 已提交
1236 1237
    s = env_->FileExists(CurrentFileName(dbname_));
    if (s.IsNotFound()) {
1238
      if (immutable_db_options_.create_if_missing) {
1239
        s = NewDB();
1240
        is_new_db = true;
1241 1242 1243 1244 1245 1246
        if (!s.ok()) {
          return s;
        }
      } else {
        return Status::InvalidArgument(
            dbname_, "does not exist (create_if_missing is false)");
J
jorlow@chromium.org 已提交
1247
      }
A
agiardullo 已提交
1248
    } else if (s.ok()) {
1249
      if (immutable_db_options_.error_if_exists) {
1250 1251 1252
        return Status::InvalidArgument(
            dbname_, "exists (error_if_exists is true)");
      }
A
agiardullo 已提交
1253 1254 1255 1256
    } else {
      // Unexpected error reading file
      assert(s.IsIOError());
      return s;
J
jorlow@chromium.org 已提交
1257
    }
M
Mayank Agarwal 已提交
1258
    // Check for the IDENTITY file and create it if not there
A
agiardullo 已提交
1259 1260
    s = env_->FileExists(IdentityFileName(dbname_));
    if (s.IsNotFound()) {
M
Mayank Agarwal 已提交
1261 1262 1263 1264
      s = SetIdentityFile(env_, dbname_);
      if (!s.ok()) {
        return s;
      }
A
agiardullo 已提交
1265 1266 1267
    } else if (!s.ok()) {
      assert(s.IsIOError());
      return s;
M
Mayank Agarwal 已提交
1268
    }
J
jorlow@chromium.org 已提交
1269 1270
  }

1271
  Status s = versions_->Recover(column_families, read_only);
1272
  if (immutable_db_options_.paranoid_checks && s.ok()) {
I
Igor Canadi 已提交
1273 1274
    s = CheckConsistency();
  }
J
jorlow@chromium.org 已提交
1275
  if (s.ok()) {
1276
    SequenceNumber next_sequence(kMaxSequenceNumber);
1277 1278
    default_cf_handle_ = new ColumnFamilyHandleImpl(
        versions_->GetColumnFamilySet()->GetDefault(), this, &mutex_);
1279
    default_cf_internal_stats_ = default_cf_handle_->cfd()->internal_stats();
1280 1281
    single_column_family_mode_ =
        versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1;
1282 1283 1284 1285 1286

    // 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).
    //
1287
    // Note that prev_log_number() is no longer used, but we pay
1288
    // attention to it in case we are recovering a database
1289
    // produced by an older version of rocksdb.
1290
    std::vector<std::string> filenames;
1291
    s = env_->GetChildren(immutable_db_options_.wal_dir, &filenames);
1292 1293
    if (!s.ok()) {
      return s;
1294
    }
K
kailiu 已提交
1295

1296 1297
    std::vector<uint64_t> logs;
    for (size_t i = 0; i < filenames.size(); i++) {
K
kailiu 已提交
1298 1299
      uint64_t number;
      FileType type;
1300 1301 1302 1303 1304 1305
      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]);
1306
        } else {
1307 1308
          logs.push_back(number);
        }
1309
      }
J
jorlow@chromium.org 已提交
1310
    }
1311

1312 1313 1314 1315 1316 1317 1318
    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) {
1319
          std::string fname = LogFileName(immutable_db_options_.wal_dir, log);
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
          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 已提交
1331 1332
    }

S
Stanislau Hlebik 已提交
1333 1334 1335
    if (!logs.empty()) {
      // Recover in the order in which the logs were generated
      std::sort(logs.begin(), logs.end());
1336
      s = RecoverLogFiles(logs, &next_sequence, read_only);
S
Stanislau Hlebik 已提交
1337 1338 1339
      if (!s.ok()) {
        // Clear memtables if recovery failed
        for (auto cfd : *versions_->GetColumnFamilySet()) {
A
agiardullo 已提交
1340 1341
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 kMaxSequenceNumber);
S
Stanislau Hlebik 已提交
1342 1343
        }
      }
1344
    }
L
Lei Jin 已提交
1345
    SetTickerCount(stats_, SEQUENCE_NUMBER, versions_->LastSequence());
J
jorlow@chromium.org 已提交
1346 1347
  }

L
Lei Jin 已提交
1348 1349
  // Initial value
  max_total_in_memory_state_ = 0;
I
Igor Canadi 已提交
1350
  for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1351 1352 1353
    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 已提交
1354 1355
  }

J
jorlow@chromium.org 已提交
1356 1357 1358
  return s;
}

S
Stanislau Hlebik 已提交
1359 1360
// REQUIRES: log_numbers are sorted in ascending order
Status DBImpl::RecoverLogFiles(const std::vector<uint64_t>& log_numbers,
1361
                               SequenceNumber* next_sequence, bool read_only) {
J
jorlow@chromium.org 已提交
1362 1363
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1364
    Logger* info_log;
J
jorlow@chromium.org 已提交
1365
    const char* fname;
1366
    Status* status;  // nullptr if immutable_db_options_.paranoid_checks==false
I
Igor Sugak 已提交
1367
    virtual void Corruption(size_t bytes, const Status& s) override {
1368 1369
      Log(InfoLogLevel::WARN_LEVEL,
          info_log, "%s%s: dropping %d bytes; %s",
1370
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1371
          fname, static_cast<int>(bytes), s.ToString().c_str());
K
krad 已提交
1372 1373 1374
      if (this->status != nullptr && this->status->ok()) {
        *this->status = s;
      }
J
jorlow@chromium.org 已提交
1375 1376 1377 1378
    }
  };

  mutex_.AssertHeld();
S
Stanislau Hlebik 已提交
1379
  Status status;
1380
  std::unordered_map<int, VersionEdit> version_edits;
1381
  // no need to refcount because iteration is under mutex
1382 1383
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    VersionEdit edit;
1384 1385
    edit.SetColumnFamily(cfd->GetID());
    version_edits.insert({cfd->GetID(), edit});
1386
  }
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
  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 已提交
1399

1400
#ifndef ROCKSDB_LITE
1401
  if (immutable_db_options_.wal_filter != nullptr) {
1402 1403 1404 1405 1406 1407 1408 1409 1410
    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()));
    }

1411 1412
    immutable_db_options_.wal_filter->ColumnFamilyLogNumberMap(cf_lognumber_map,
                                                               cf_name_id_map);
1413 1414 1415
  }
#endif

1416 1417 1418
  bool stop_replay_by_wal_filter = false;
  bool stop_replay_for_corruption = false;
  bool flushed = false;
S
Stanislau Hlebik 已提交
1419 1420 1421 1422
  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.
1423
    versions_->MarkFileNumberUsedDuringRecovery(log_number);
S
Stanislau Hlebik 已提交
1424
    // Open the log file
1425
    std::string fname = LogFileName(immutable_db_options_.wal_dir, log_number);
1426

1427
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
1428
        "Recovering log #%" PRIu64 " mode %d", log_number,
1429
        immutable_db_options_.wal_recovery_mode);
1430 1431 1432
    auto logFileDropped = [this, &fname]() {
      uint64_t bytes;
      if (env_->GetFileSize(fname, &bytes).ok()) {
1433
        auto info_log = immutable_db_options_.info_log.get();
1434 1435 1436 1437 1438 1439 1440 1441 1442
        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;
    }

1443 1444 1445 1446
    unique_ptr<SequentialFileReader> file_reader;
    {
      unique_ptr<SequentialFile> file;
      status = env_->NewSequentialFile(fname, &file, env_options_);
S
Stanislau Hlebik 已提交
1447
      if (!status.ok()) {
1448 1449 1450 1451 1452 1453 1454 1455
        MaybeIgnoreError(&status);
        if (!status.ok()) {
          return status;
        } else {
          // Fail with one log file, but that's ok.
          // Try next one.
          continue;
        }
S
Stanislau Hlebik 已提交
1456
      }
1457
      file_reader.reset(new SequentialFileReader(std::move(file)));
J
jorlow@chromium.org 已提交
1458 1459
    }

S
Stanislau Hlebik 已提交
1460 1461 1462
    // Create the log reader.
    LogReporter reporter;
    reporter.env = env_;
1463
    reporter.info_log = immutable_db_options_.info_log.get();
S
Stanislau Hlebik 已提交
1464
    reporter.fname = fname.c_str();
1465 1466
    if (!immutable_db_options_.paranoid_checks ||
        immutable_db_options_.wal_recovery_mode ==
K
krad 已提交
1467 1468 1469 1470 1471
            WALRecoveryMode::kSkipAnyCorruptedRecords) {
      reporter.status = nullptr;
    } else {
      reporter.status = &status;
    }
S
Stanislau Hlebik 已提交
1472 1473 1474 1475
    // 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).
1476 1477 1478
    log::Reader reader(immutable_db_options_.info_log, std::move(file_reader),
                       &reporter, true /*checksum*/, 0 /*initial_offset*/,
                       log_number);
K
krad 已提交
1479 1480

    // Determine if we should tolerate incomplete records at the tail end of the
S
Stanislau Hlebik 已提交
1481 1482 1483 1484
    // Read all the records and add to a memtable
    std::string scratch;
    Slice record;
    WriteBatch batch;
K
krad 已提交
1485

1486 1487 1488 1489
    while (!stop_replay_by_wal_filter &&
           reader.ReadRecord(&record, &scratch,
                             immutable_db_options_.wal_recovery_mode) &&
           status.ok()) {
1490
      if (record.size() < WriteBatchInternal::kHeader) {
S
Stanislau Hlebik 已提交
1491 1492 1493 1494 1495
        reporter.Corruption(record.size(),
                            Status::Corruption("log record too small"));
        continue;
      }
      WriteBatchInternal::SetContents(&batch, record);
1496 1497
      SequenceNumber sequence = WriteBatchInternal::Sequence(&batch);

1498
      if (immutable_db_options_.wal_recovery_mode ==
1499
          WALRecoveryMode::kPointInTimeRecovery) {
1500 1501 1502 1503 1504
        // 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 (sequence == *next_sequence) {
1505 1506 1507 1508 1509 1510 1511 1512
          stop_replay_for_corruption = false;
        }
        if (stop_replay_for_corruption) {
          logFileDropped();
          break;
        }
      }

S
sdong 已提交
1513
      bool no_prev_seq = true;
1514
      if (!immutable_db_options_.allow_2pc) {
1515 1516
        *next_sequence = sequence;
      } else {
1517 1518 1519 1520 1521 1522
        if (*next_sequence == kMaxSequenceNumber) {
          *next_sequence = sequence;
        } else {
          no_prev_seq = false;
          WriteBatchInternal::SetSequence(&batch, *next_sequence);
        }
1523
      }
S
Stanislau Hlebik 已提交
1524

1525
#ifndef ROCKSDB_LITE
1526
      if (immutable_db_options_.wal_filter != nullptr) {
1527 1528 1529
        WriteBatch new_batch;
        bool batch_changed = false;

1530
        WalFilter::WalProcessingOption wal_processing_option =
1531 1532
            immutable_db_options_.wal_filter->LogRecordFound(
                log_number, fname, batch, &new_batch, &batch_changed);
1533

1534
        switch (wal_processing_option) {
S
sdong 已提交
1535 1536 1537 1538 1539
          case WalFilter::WalProcessingOption::kContinueProcessing:
            // do nothing, proceeed normally
            break;
          case WalFilter::WalProcessingOption::kIgnoreCurrentRecord:
            // skip current record
1540
            continue;
S
sdong 已提交
1541 1542
          case WalFilter::WalProcessingOption::kStopReplay:
            // skip current record and stop replay
1543
            stop_replay_by_wal_filter = true;
1544
            continue;
S
sdong 已提交
1545
          case WalFilter::WalProcessingOption::kCorruptedRecord: {
1546 1547 1548
            status =
                Status::Corruption("Corruption reported by Wal Filter ",
                                   immutable_db_options_.wal_filter->Name());
S
sdong 已提交
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
            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 ",
1561
                immutable_db_options_.wal_filter->Name());
S
sdong 已提交
1562 1563 1564 1565 1566 1567 1568
            MaybeIgnoreError(&status);
            if (!status.ok()) {
              return status;
            } else {
              // Ignore the error with current record processing.
              continue;
            }
1569 1570 1571 1572 1573 1574 1575 1576 1577
          }
        }

        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) {
1578
            Log(InfoLogLevel::FATAL_LEVEL, immutable_db_options_.info_log,
S
sdong 已提交
1579 1580 1581 1582
                "Recovering log #%" PRIu64
                " mode %d log filter %s returned "
                "more records (%d) than original (%d) which is not allowed. "
                "Aborting recovery.",
1583 1584 1585
                log_number, immutable_db_options_.wal_recovery_mode,
                immutable_db_options_.wal_filter->Name(), new_count,
                original_count);
S
sdong 已提交
1586 1587 1588
            status = Status::NotSupported(
                "More than original # of records "
                "returned by Wal Filter ",
1589
                immutable_db_options_.wal_filter->Name());
1590
            return status;
1591 1592 1593
          }
          // Set the same sequence number in the new_batch
          // as the original batch.
S
sdong 已提交
1594 1595
          WriteBatchInternal::SetSequence(&new_batch,
                                          WriteBatchInternal::Sequence(&batch));
1596
          batch = new_batch;
1597 1598
        }
      }
S
sdong 已提交
1599
#endif  // ROCKSDB_LITE
1600

S
Stanislau Hlebik 已提交
1601 1602 1603 1604 1605
      // 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
S
sdong 已提交
1606
      bool has_valid_writes = false;
1607 1608
      status = WriteBatchInternal::InsertInto(
          &batch, column_family_memtables_.get(), &flush_scheduler_, true,
A
Aaron Gao 已提交
1609 1610
          log_number, this, false /* concurrent_memtable_writes */,
          next_sequence, &has_valid_writes);
S
sdong 已提交
1611 1612 1613 1614
      // If it is the first log file and there is no column family updated
      // after replaying the file, this file may be a stale file. We ignore
      // sequence IDs from the file. Otherwise, if a newer stale log file that
      // has been deleted, the sequenceID may be wrong.
1615
      if (immutable_db_options_.allow_2pc) {
1616 1617 1618
        if (no_prev_seq && !has_valid_writes) {
          *next_sequence = kMaxSequenceNumber;
        }
S
sdong 已提交
1619
      }
S
Stanislau Hlebik 已提交
1620 1621
      MaybeIgnoreError(&status);
      if (!status.ok()) {
1622 1623 1624 1625
        // 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 已提交
1626
      }
1627

S
sdong 已提交
1628
      if (has_valid_writes && !read_only) {
I
Igor Canadi 已提交
1629 1630 1631 1632
        // 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;

1633
        while ((cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
1634 1635 1636 1637 1638 1639 1640
          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;
1641
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
I
Igor Canadi 已提交
1642 1643 1644 1645
          if (!status.ok()) {
            // Reflect errors immediately so that conditions like full
            // file-systems cause the DB::Open() to fail.
            return status;
1646
          }
1647
          flushed = true;
A
agiardullo 已提交
1648 1649

          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
1650
                                 *next_sequence);
1651
        }
J
jorlow@chromium.org 已提交
1652 1653 1654
      }
    }

1655
    if (!status.ok()) {
1656 1657
      if (immutable_db_options_.wal_recovery_mode ==
          WALRecoveryMode::kSkipAnyCorruptedRecords) {
1658 1659
        // We should ignore all errors unconditionally
        status = Status::OK();
1660
      } else if (immutable_db_options_.wal_recovery_mode ==
K
krad 已提交
1661 1662 1663
                 WALRecoveryMode::kPointInTimeRecovery) {
        // We should ignore the error but not continue replaying
        status = Status::OK();
1664
        stop_replay_for_corruption = true;
1665
        Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
K
krad 已提交
1666
            "Point in time recovered to log #%" PRIu64 " seq #%" PRIu64,
1667
            log_number, *next_sequence);
1668
      } else {
1669 1670 1671 1672
        assert(immutable_db_options_.wal_recovery_mode ==
                   WALRecoveryMode::kTolerateCorruptedTailRecords ||
               immutable_db_options_.wal_recovery_mode ==
                   WALRecoveryMode::kAbsoluteConsistency);
K
krad 已提交
1673 1674
        return status;
      }
1675 1676
    }

I
Igor Canadi 已提交
1677
    flush_scheduler_.Clear();
1678 1679 1680 1681
    auto last_sequence = *next_sequence - 1;
    if ((*next_sequence != kMaxSequenceNumber) &&
        (versions_->LastSequence() <= last_sequence)) {
      versions_->SetLastSequence(last_sequence);
S
Stanislau Hlebik 已提交
1682
    }
1683 1684
  }

1685
  if (!read_only) {
1686 1687
    // 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 已提交
1688
    auto max_log_number = log_numbers.back();
1689
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1690
      auto iter = version_edits.find(cfd->GetID());
1691 1692 1693
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

S
Stanislau Hlebik 已提交
1694
      if (cfd->GetLogNumber() > max_log_number) {
1695
        // Column family cfd has already flushed the data
S
Stanislau Hlebik 已提交
1696
        // from all logs. Memtable has to be empty because
1697
        // we filter the updates based on log_number
1698
        // (in WriteBatch::InsertInto)
1699 1700 1701 1702 1703 1704 1705
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1706 1707 1708
        // 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.
1709
        if (flushed || !immutable_db_options_.avoid_flush_during_recovery) {
1710 1711 1712 1713 1714 1715
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
          if (!status.ok()) {
            // Recovery failed
            break;
          }
          flushed = true;
A
agiardullo 已提交
1716

1717 1718 1719
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 *next_sequence);
        }
1720
      }
J
jorlow@chromium.org 已提交
1721

1722
      // write MANIFEST with update
S
Stanislau Hlebik 已提交
1723
      // writing log_number in the manifest means that any log file
1724 1725
      // with number strongly less than (log_number + 1) is already
      // recovered and should be ignored on next reincarnation.
S
Stanislau Hlebik 已提交
1726 1727
      // Since we already recovered max_log_number, we want all logs
      // with numbers `<= max_log_number` (includes this one) to be ignored
1728
      if (flushed || cfd->mem()->GetFirstSequenceNumber() == 0) {
1729 1730
        edit->SetLogNumber(max_log_number + 1);
      }
1731 1732 1733
      // 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 已提交
1734
      // log number
1735
      versions_->MarkFileNumberUsedDuringRecovery(max_log_number + 1);
1736 1737
      status = versions_->LogAndApply(
          cfd, *cfd->GetLatestMutableCFOptions(), edit, &mutex_);
1738
      if (!status.ok()) {
S
Stanislau Hlebik 已提交
1739 1740
        // Recovery failed
        break;
1741 1742
      }
    }
1743
  }
I
Igor Canadi 已提交
1744

1745 1746 1747 1748 1749 1750 1751 1752
  if (!flushed) {
    // Mark these as alive so they'll be considered for deletion later by
    // FindObsoleteFiles()
    for (auto log_number : log_numbers) {
      alive_log_files_.push_back(LogFileNumberSize(log_number));
    }
  }

1753 1754 1755
  event_logger_.Log() << "job" << job_id << "event"
                      << "recovery_finished";

J
jorlow@chromium.org 已提交
1756 1757 1758
  return status;
}

1759 1760
Status DBImpl::WriteLevel0TableForRecovery(int job_id, ColumnFamilyData* cfd,
                                           MemTable* mem, VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1761
  mutex_.AssertHeld();
1762
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1763
  FileMetaData meta;
I
Igor Canadi 已提交
1764 1765
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();
1766
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
1767 1768
  ReadOptions ro;
  ro.total_order_seek = true;
1769
  Arena arena;
1770
  Status s;
1771
  TableProperties table_properties;
1772
  {
1773
    ScopedArenaIterator iter(mem->NewIterator(ro, &arena));
1774
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
1775 1776
        "[%s] [WriteLevel0TableForRecovery]"
        " Level-0 table #%" PRIu64 ": started",
1777
        cfd->GetName().c_str(), meta.fd.GetNumber());
1778

A
Aaron Gao 已提交
1779 1780 1781
    // Get the latest mutable cf options while the mutex is still locked
    const MutableCFOptions mutable_cf_options =
        *cfd->GetLatestMutableCFOptions();
1782 1783
    bool paranoid_file_checks =
        cfd->GetLatestMutableCFOptions()->paranoid_file_checks;
1784 1785
    {
      mutex_.Unlock();
1786 1787 1788 1789 1790

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

1791
      s = BuildTable(
A
Aaron Gao 已提交
1792 1793
          dbname_, env_, *cfd->ioptions(), mutable_cf_options, env_options_,
          cfd->table_cache(), iter.get(), &meta, cfd->internal_comparator(),
1794 1795
          cfd->int_tbl_prop_collector_factories(), cfd->GetID(), cfd->GetName(),
          snapshot_seqs, earliest_write_conflict_snapshot,
A
Aaron Gao 已提交
1796
          GetCompressionFlush(*cfd->ioptions(), mutable_cf_options),
1797
          cfd->ioptions()->compression_opts, paranoid_file_checks,
1798 1799
          cfd->internal_stats(), TableFileCreationReason::kRecovery,
          &event_logger_, job_id);
1800 1801
      LogFlush(immutable_db_options_.info_log);
      Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
1802 1803 1804 1805
          "[%s] [WriteLevel0TableForRecovery]"
          " Level-0 table #%" PRIu64 ": %" PRIu64 " bytes %s",
          cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
          s.ToString().c_str());
1806 1807
      mutex_.Lock();
    }
1808
  }
I
Igor Canadi 已提交
1809
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
1810 1811 1812 1813

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1814
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1815 1816
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
1817 1818
                  meta.smallest_seqno, meta.largest_seqno,
                  meta.marked_for_compaction);
1819 1820
  }

L
Lei Jin 已提交
1821
  InternalStats::CompactionStats stats(1);
1822
  stats.micros = env_->NowMicros() - start_micros;
1823
  stats.bytes_written = meta.fd.GetFileSize();
1824
  stats.num_output_files = 1;
1825
  cfd->internal_stats()->AddCompactionStats(level, stats);
1826 1827
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1828
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1829 1830 1831
  return s;
}

1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852
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) {
1853
      Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
1854 1855
          "[JOB %d] Syncing log #%" PRIu64, job_context->job_id,
          log->get_log_number());
1856
      s = log->file()->Sync(immutable_db_options_.use_fsync);
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874
    }
    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;
}

1875 1876
Status DBImpl::FlushMemTableToOutputFile(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
1877
    bool* made_progress, JobContext* job_context, LogBuffer* log_buffer) {
1878
  mutex_.AssertHeld();
1879
  assert(cfd->imm()->NumNotFlushed() != 0);
1880
  assert(cfd->imm()->IsFlushPending());
1881

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

A
Aaron Gao 已提交
1886
  FlushJob flush_job(
1887
      dbname_, cfd, immutable_db_options_, mutable_cf_options, env_options_,
A
Aaron Gao 已提交
1888 1889 1890 1891 1892
      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);
1893

1894
  FileMetaData file_meta;
1895

1896 1897 1898 1899 1900
  flush_job.PickMemTable();

  Status s;
  if (logfile_number_ > 0 &&
      versions_->GetColumnFamilySet()->NumberOfColumnFamilies() > 0 &&
1901
      !immutable_db_options_.disable_data_sync) {
1902 1903 1904 1905 1906 1907 1908 1909 1910
    // 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);
  }

1911 1912 1913 1914 1915 1916
  // 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.
1917 1918 1919
  if (s.ok()) {
    s = flush_job.Run(&file_meta);
  }
J
jorlow@chromium.org 已提交
1920 1921

  if (s.ok()) {
I
Igor Canadi 已提交
1922 1923
    InstallSuperVersionAndScheduleWorkWrapper(cfd, job_context,
                                              mutable_cf_options);
1924 1925
    if (made_progress) {
      *made_progress = 1;
1926
    }
S
sdong 已提交
1927
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Igor Canadi 已提交
1928
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
S
sdong 已提交
1929
                cfd->current()->storage_info()->LevelSummary(&tmp));
J
jorlow@chromium.org 已提交
1930
  }
1931

1932 1933
  if (!s.ok() && !s.IsShutdownInProgress() &&
      immutable_db_options_.paranoid_checks && bg_error_.ok()) {
1934 1935 1936 1937
    // if a bad error happened (not ShutdownInProgress) and paranoid_checks is
    // true, mark DB read-only
    bg_error_ = s;
  }
1938
  if (s.ok()) {
1939
#ifndef ROCKSDB_LITE
1940
    // may temporarily unlock and lock the mutex.
1941
    NotifyOnFlushCompleted(cfd, &file_meta, mutable_cf_options,
1942
                           job_context->job_id, flush_job.GetTableProperties());
1943
#endif  // ROCKSDB_LITE
1944 1945
    auto sfm = static_cast<SstFileManagerImpl*>(
        immutable_db_options_.sst_file_manager.get());
1946 1947
    if (sfm) {
      // Notify sst_file_manager that a new file was added
1948 1949
      std::string file_path = MakeTableFileName(
          immutable_db_options_.db_paths[0].path, file_meta.fd.GetNumber());
1950
      sfm->OnAddFile(file_path);
1951 1952 1953 1954 1955
      if (sfm->IsMaxAllowedSpaceReached() && bg_error_.ok()) {
        bg_error_ = Status::IOError("Max allowed space was reached");
        TEST_SYNC_POINT(
            "DBImpl::FlushMemTableToOutputFile:MaxAllowedSpaceReached");
      }
1956
    }
1957
  }
J
jorlow@chromium.org 已提交
1958 1959 1960
  return s;
}

1961 1962 1963 1964
void DBImpl::NotifyOnFlushCompleted(ColumnFamilyData* cfd,
                                    FileMetaData* file_meta,
                                    const MutableCFOptions& mutable_cf_options,
                                    int job_id, TableProperties prop) {
1965
#ifndef ROCKSDB_LITE
1966
  if (immutable_db_options_.listeners.size() == 0U) {
1967 1968
    return;
  }
1969 1970 1971 1972
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
1973
  bool triggered_writes_slowdown =
1974
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
1975
       mutable_cf_options.level0_slowdown_writes_trigger);
1976
  bool triggered_writes_stop =
1977
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
1978
       mutable_cf_options.level0_stop_writes_trigger);
1979 1980
  // release lock while notifying events
  mutex_.Unlock();
1981
  {
1982 1983 1984 1985
    FlushJobInfo info;
    info.cf_name = cfd->GetName();
    // TODO(yhchiang): make db_paths dynamic in case flush does not
    //                 go to L0 in the future.
1986
    info.file_path = MakeTableFileName(immutable_db_options_.db_paths[0].path,
1987
                                       file_meta->fd.GetNumber());
1988
    info.thread_id = env_->GetThreadID();
1989 1990 1991
    info.job_id = job_id;
    info.triggered_writes_slowdown = triggered_writes_slowdown;
    info.triggered_writes_stop = triggered_writes_stop;
1992 1993
    info.smallest_seqno = file_meta->smallest_seqno;
    info.largest_seqno = file_meta->largest_seqno;
1994
    info.table_properties = prop;
1995
    for (auto listener : immutable_db_options_.listeners) {
1996
      listener->OnFlushCompleted(this, info);
1997 1998
    }
  }
1999 2000 2001
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
2002
#endif  // ROCKSDB_LITE
2003 2004
}

2005 2006 2007
Status DBImpl::CompactRange(const CompactRangeOptions& options,
                            ColumnFamilyHandle* column_family,
                            const Slice* begin, const Slice* end) {
2008
  if (options.target_path_id >= immutable_db_options_.db_paths.size()) {
2009 2010 2011
    return Status::InvalidArgument("Invalid target path ID");
  }

2012 2013
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
2014
  bool exclusive = options.exclusive_manual_compaction;
I
Igor Canadi 已提交
2015 2016

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
2017
  if (!s.ok()) {
2018
    LogFlush(immutable_db_options_.info_log);
L
Lei Jin 已提交
2019 2020 2021
    return s;
  }

I
Igor Canadi 已提交
2022
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
2023
  {
2024
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
2025
    Version* base = cfd->current();
2026 2027
    for (int level = 1; level < base->storage_info()->num_non_empty_levels();
         level++) {
S
sdong 已提交
2028
      if (base->storage_info()->OverlapInLevel(level, begin, end)) {
G
Gabor Cselle 已提交
2029 2030 2031 2032
        max_level_with_files = level;
      }
    }
  }
2033

2034
  int final_output_level = 0;
2035 2036 2037 2038
  if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal &&
      cfd->NumberLevels() > 1) {
    // Always compact all files together.
    s = RunManualCompaction(cfd, ColumnFamilyData::kCompactAllLevels,
2039
                            cfd->NumberLevels() - 1, options.target_path_id,
2040
                            begin, end, exclusive);
2041
    final_output_level = cfd->NumberLevels() - 1;
2042 2043
  } else {
    for (int level = 0; level <= max_level_with_files; level++) {
2044
      int output_level;
A
Andres Notzli 已提交
2045
      // in case the compaction is universal or if we're compacting the
2046 2047 2048 2049
      // 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 ||
2050 2051 2052
          cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
        output_level = level;
      } else if (level == max_level_with_files && level > 0) {
2053 2054 2055 2056 2057 2058 2059
        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 已提交
2060
                   cfd->ioptions()->compaction_filter_factory == nullptr) {
A
Andres Notzli 已提交
2061 2062
          // Skip bottommost level compaction since we don't have a compaction
          // filter
2063 2064
          continue;
        }
2065
        output_level = level;
2066
      } else {
2067
        output_level = level + 1;
2068 2069 2070 2071 2072
        if (cfd->ioptions()->compaction_style == kCompactionStyleLevel &&
            cfd->ioptions()->level_compaction_dynamic_level_bytes &&
            level == 0) {
          output_level = ColumnFamilyData::kCompactToBaseLevel;
        }
2073
      }
2074
      s = RunManualCompaction(cfd, level, output_level, options.target_path_id,
2075
                              begin, end, exclusive);
2076 2077 2078
      if (!s.ok()) {
        break;
      }
2079 2080 2081 2082 2083
      if (output_level == ColumnFamilyData::kCompactToBaseLevel) {
        final_output_level = cfd->NumberLevels() - 1;
      } else if (output_level > final_output_level) {
        final_output_level = output_level;
      }
2084 2085
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::1");
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::2");
2086
    }
G
Gabor Cselle 已提交
2087
  }
2088
  if (!s.ok()) {
2089
    LogFlush(immutable_db_options_.info_log);
2090 2091
    return s;
  }
2092

2093
  if (options.change_level) {
2094
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2095 2096 2097 2098 2099 2100
        "[RefitLevel] waiting for background threads to stop");
    s = PauseBackgroundWork();
    if (s.ok()) {
      s = ReFitLevel(cfd, final_output_level, options.target_level);
    }
    ContinueBackgroundWork();
2101
  }
2102
  LogFlush(immutable_db_options_.info_log);
L
Lei Jin 已提交
2103

2104
  {
2105
    InstrumentedMutexLock l(&mutex_);
2106 2107 2108 2109 2110
    // an automatic compaction that has been scheduled might have been
    // preempted by the manual compactions. Need to schedule it back.
    MaybeScheduleFlushOrCompaction();
  }

L
Lei Jin 已提交
2111
  return s;
2112 2113
}

2114 2115 2116 2117 2118
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 已提交
2119 2120 2121 2122
#ifdef ROCKSDB_LITE
    // not supported in lite version
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
2123 2124 2125 2126 2127 2128
  if (column_family == nullptr) {
    return Status::InvalidArgument("ColumnFamilyHandle must be non-null.");
  }

  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  assert(cfd);
2129 2130 2131 2132

  Status s;
  JobContext job_context(0, true);
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
2133
                       immutable_db_options_.info_log.get());
2134 2135 2136 2137 2138 2139

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

2140
    // This call will unlock/lock the mutex to wait for current running
2141 2142
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
2143

2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157
    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());
2158
  }  // release the mutex
2159 2160 2161 2162 2163 2164 2165 2166 2167 2168

  // 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()) {
2169
      // no mutex is locked here.  No need to Unlock() and Lock() here.
2170 2171 2172 2173 2174
      PurgeObsoleteFiles(job_context);
    }
    job_context.Clean();
  }

2175
  return s;
I
Igor Canadi 已提交
2176
#endif  // ROCKSDB_LITE
2177 2178
}

I
Igor Canadi 已提交
2179
#ifndef ROCKSDB_LITE
2180 2181 2182
Status DBImpl::CompactFilesImpl(
    const CompactionOptions& compact_options, ColumnFamilyData* cfd,
    Version* version, const std::vector<std::string>& input_file_names,
2183 2184
    const int output_level, int output_path_id, JobContext* job_context,
    LogBuffer* log_buffer) {
2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201
  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) {
2202
    if (immutable_db_options_.db_paths.size() == 1U) {
2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216
      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;
  }

2217
  std::vector<CompactionInputFiles> input_files;
2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237
  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(
2238 2239
      compact_options, input_files, output_level, version->storage_info(),
      *cfd->GetLatestMutableCFOptions(), output_path_id));
2240 2241 2242
  if (!c) {
    return Status::Aborted("Another Level 0 compaction is running");
  }
2243 2244
  c->SetInputVersion(version);
  // deletion compaction currently not allowed in CompactFiles.
2245
  assert(!c->deletion_compaction());
2246

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

2251 2252 2253
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();

I
Igor Canadi 已提交
2254
  assert(is_snapshot_supported_ || snapshots_.empty());
2255
  CompactionJob compaction_job(
2256 2257
      job_context->job_id, c.get(), immutable_db_options_, env_options_,
      versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
2258 2259 2260
      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,
2261
      c->mutable_cf_options()->report_bg_io_stats, dbname_,
2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274
      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.
2275 2276 2277 2278 2279

  // 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.
Y
Yi Wu 已提交
2280 2281
  version->storage_info()->ComputeCompactionScore(*cfd->ioptions(),
                                                  *c->mutable_cf_options());
2282

2283 2284 2285
  compaction_job.Prepare();

  mutex_.Unlock();
2286 2287
  TEST_SYNC_POINT("CompactFilesImpl:0");
  TEST_SYNC_POINT("CompactFilesImpl:1");
2288
  compaction_job.Run();
2289 2290
  TEST_SYNC_POINT("CompactFilesImpl:2");
  TEST_SYNC_POINT("CompactFilesImpl:3");
2291
  mutex_.Lock();
2292

2293
  Status status = compaction_job.Install(*c->mutable_cf_options());
2294
  if (status.ok()) {
I
Igor Canadi 已提交
2295 2296
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
2297 2298 2299
  }
  c->ReleaseCompactionFiles(s);

2300
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
2301 2302 2303 2304 2305 2306

  if (status.ok()) {
    // Done
  } else if (status.IsShutdownInProgress()) {
    // Ignore compaction errors found during shutting down
  } else {
2307
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
2308
        "[%s] [JOB %d] Compaction error: %s",
2309
        c->column_family_data()->GetName().c_str(), job_context->job_id,
2310
        status.ToString().c_str());
2311
    if (immutable_db_options_.paranoid_checks && bg_error_.ok()) {
2312 2313 2314 2315
      bg_error_ = status;
    }
  }

2316 2317
  c.reset();

2318
  bg_compaction_scheduled_--;
2319 2320 2321
  if (bg_compaction_scheduled_ == 0) {
    bg_cv_.SignalAll();
  }
2322 2323 2324

  return status;
}
I
Igor Canadi 已提交
2325
#endif  // ROCKSDB_LITE
2326

2327 2328
Status DBImpl::PauseBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
2329
  bg_compaction_paused_++;
2330 2331 2332
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_ > 0) {
    bg_cv_.Wait();
  }
2333
  bg_work_paused_++;
2334 2335 2336 2337 2338
  return Status::OK();
}

Status DBImpl::ContinueBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
2339 2340 2341
  if (bg_work_paused_ == 0) {
    return Status::InvalidArgument();
  }
2342
  assert(bg_work_paused_ > 0);
2343 2344
  assert(bg_compaction_paused_ > 0);
  bg_compaction_paused_--;
2345
  bg_work_paused_--;
2346 2347
  // It's sufficient to check just bg_work_paused_ here since
  // bg_work_paused_ is always no greater than bg_compaction_paused_
2348 2349 2350 2351 2352 2353
  if (bg_work_paused_ == 0) {
    MaybeScheduleFlushOrCompaction();
  }
  return Status::OK();
}

O
Ori Bernstein 已提交
2354
void DBImpl::NotifyOnCompactionCompleted(
2355 2356
    ColumnFamilyData* cfd, Compaction *c, const Status &st,
    const CompactionJobStats& compaction_job_stats,
2357
    const int job_id) {
O
Ori Bernstein 已提交
2358
#ifndef ROCKSDB_LITE
2359
  if (immutable_db_options_.listeners.size() == 0U) {
O
Ori Bernstein 已提交
2360 2361 2362 2363 2364 2365 2366 2367
    return;
  }
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
  // release lock while notifying events
  mutex_.Unlock();
2368
  TEST_SYNC_POINT("DBImpl::NotifyOnCompactionCompleted::UnlockMutex");
2369 2370 2371 2372
  {
    CompactionJobInfo info;
    info.cf_name = cfd->GetName();
    info.status = st;
2373
    info.thread_id = env_->GetThreadID();
2374 2375
    info.job_id = job_id;
    info.base_input_level = c->start_level();
2376
    info.output_level = c->output_level();
2377
    info.stats = compaction_job_stats;
2378
    info.table_properties = c->GetOutputTableProperties();
2379
    info.compaction_reason = c->compaction_reason();
2380
    info.compression = c->output_compression();
2381 2382
    for (size_t i = 0; i < c->num_input_levels(); ++i) {
      for (const auto fmd : *c->inputs(i)) {
2383 2384
        auto fn = TableFileName(immutable_db_options_.db_paths,
                                fmd->fd.GetNumber(), fmd->fd.GetPathId());
2385 2386 2387
        info.input_files.push_back(fn);
        if (info.table_properties.count(fn) == 0) {
          std::shared_ptr<const TableProperties> tp;
2388
          auto s = cfd->current()->GetTableProperties(&tp, fmd, &fn);
2389 2390 2391 2392
          if (s.ok()) {
            info.table_properties[fn] = tp;
          }
        }
2393 2394 2395
      }
    }
    for (const auto newf : c->edit()->GetNewFiles()) {
2396 2397 2398
      info.output_files.push_back(TableFileName(immutable_db_options_.db_paths,
                                                newf.second.fd.GetNumber(),
                                                newf.second.fd.GetPathId()));
2399
    }
2400
    for (auto listener : immutable_db_options_.listeners) {
2401 2402 2403
      listener->OnCompactionCompleted(this, info);
    }
  }
O
Ori Bernstein 已提交
2404 2405 2406 2407 2408 2409
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
#endif  // ROCKSDB_LITE
}

2410
Status DBImpl::SetOptions(ColumnFamilyHandle* column_family,
2411
    const std::unordered_map<std::string, std::string>& options_map) {
I
Igor Canadi 已提交
2412 2413 2414
#ifdef ROCKSDB_LITE
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
L
Lei Jin 已提交
2415 2416
  auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  if (options_map.empty()) {
2417 2418
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
        "SetOptions() on column family [%s], empty input",
L
Lei Jin 已提交
2419
        cfd->GetName().c_str());
2420
    return Status::InvalidArgument("empty input");
L
Lei Jin 已提交
2421 2422 2423
  }

  MutableCFOptions new_options;
2424
  Status s;
2425
  Status persist_options_status;
L
Lei Jin 已提交
2426
  {
2427
    InstrumentedMutexLock l(&mutex_);
2428 2429
    s = cfd->SetOptions(options_map);
    if (s.ok()) {
L
Lei Jin 已提交
2430
      new_options = *cfd->GetLatestMutableCFOptions();
2431 2432 2433 2434
      // Append new version to recompute compaction score.
      VersionEdit dummy_edit;
      versions_->LogAndApply(cfd, new_options, &dummy_edit, &mutex_,
                             directories_.GetDbDir());
2435 2436 2437 2438 2439 2440
      // 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;
2441

2442
      persist_options_status = PersistOptions();
2443 2444
    }
  }
L
Lei Jin 已提交
2445

2446 2447
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
      "SetOptions() on column family [%s], inputs:", cfd->GetName().c_str());
L
Lei Jin 已提交
2448
  for (const auto& o : options_map) {
2449 2450
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log, "%s: %s\n",
        o.first.c_str(), o.second.c_str());
L
Lei Jin 已提交
2451
  }
2452
  if (s.ok()) {
2453
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2454
        "[%s] SetOptions() succeeded", cfd->GetName().c_str());
2455
    new_options.Dump(immutable_db_options_.info_log.get());
2456
    if (!persist_options_status.ok()) {
2457
      if (immutable_db_options_.fail_if_options_file_error) {
2458
        s = Status::IOError(
2459
            "SetOptions() succeeded, but unable to persist options",
2460 2461
            persist_options_status.ToString());
      }
2462
      Warn(immutable_db_options_.info_log,
2463 2464 2465
           "Unable to persist options in SetOptions() -- %s",
           persist_options_status.ToString().c_str());
    }
L
Lei Jin 已提交
2466
  } else {
2467
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528
        "[%s] SetOptions() failed", cfd->GetName().c_str());
  }
  LogFlush(immutable_db_options_.info_log);
  return s;
#endif  // ROCKSDB_LITE
}

Status DBImpl::SetDBOptions(
    const std::unordered_map<std::string, std::string>& options_map) {
#ifdef ROCKSDB_LITE
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
  if (options_map.empty()) {
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
        "SetDBOptions(), empty input.");
    return Status::InvalidArgument("empty input");
  }

  MutableDBOptions new_options;
  Status s;
  Status persist_options_status;
  {
    InstrumentedMutexLock l(&mutex_);
    s = GetMutableDBOptionsFromStrings(mutable_db_options_, options_map,
                                       &new_options);
    if (s.ok()) {
      if (new_options.max_background_compactions >
          mutable_db_options_.max_background_compactions) {
        env_->IncBackgroundThreadsIfNeeded(
            new_options.max_background_compactions, Env::Priority::LOW);
        MaybeScheduleFlushOrCompaction();
      }

      mutable_db_options_ = new_options;

      persist_options_status = PersistOptions();
    }
  }
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
      "SetDBOptions(), inputs:");
  for (const auto& o : options_map) {
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log, "%s: %s\n",
        o.first.c_str(), o.second.c_str());
  }
  if (s.ok()) {
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
        "SetDBOptions() succeeded");
    new_options.Dump(immutable_db_options_.info_log.get());
    if (!persist_options_status.ok()) {
      if (immutable_db_options_.fail_if_options_file_error) {
        s = Status::IOError(
            "SetDBOptions() succeeded, but unable to persist options",
            persist_options_status.ToString());
      }
      Warn(immutable_db_options_.info_log,
           "Unable to persist options in SetDBOptions() -- %s",
           persist_options_status.ToString().c_str());
    }
  } else {
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
        "SetDBOptions failed");
L
Lei Jin 已提交
2529
  }
2530
  LogFlush(immutable_db_options_.info_log);
2531
  return s;
I
Igor Canadi 已提交
2532
#endif  // ROCKSDB_LITE
2533 2534
}

2535 2536 2537 2538 2539 2540 2541 2542 2543
Status DBImpl::PersistOptions() {
  mutex_.AssertHeld();
  WriteThread::Writer w;
  write_thread_.EnterUnbatched(&w, &mutex_);
  Status s = WriteOptionsFile();
  write_thread_.ExitUnbatched(&w);
  return s;
}

2544
// return the same level if it cannot be moved
2545 2546
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd,
    const MutableCFOptions& mutable_cf_options, int level) {
2547
  mutex_.AssertHeld();
S
sdong 已提交
2548
  const auto* vstorage = cfd->current()->storage_info();
2549
  int minimum_level = level;
2550
  for (int i = level - 1; i > 0; --i) {
2551
    // stop if level i is not empty
S
sdong 已提交
2552
    if (vstorage->NumLevelFiles(i) > 0) break;
2553
    // stop if level i is too small (cannot fit the level files)
2554
    if (vstorage->MaxBytesForLevel(i) < vstorage->NumLevelBytes(level)) {
2555 2556
      break;
    }
2557 2558 2559 2560 2561 2562

    minimum_level = i;
  }
  return minimum_level;
}

2563 2564
// REQUIREMENT: block all background work by calling PauseBackgroundWork()
// before calling this function
I
Igor Canadi 已提交
2565 2566
Status DBImpl::ReFitLevel(ColumnFamilyData* cfd, int level, int target_level) {
  assert(level < cfd->NumberLevels());
2567 2568 2569
  if (target_level >= cfd->NumberLevels()) {
    return Status::InvalidArgument("Target level exceeds number of levels");
  }
2570

2571 2572 2573 2574
  std::unique_ptr<SuperVersion> superversion_to_free;
  std::unique_ptr<SuperVersion> new_superversion(new SuperVersion());

  Status status;
I
Igor Canadi 已提交
2575

I
Islam AbdelRahman 已提交
2576
  InstrumentedMutexLock guard_lock(&mutex_);
2577 2578 2579

  // only allow one thread refitting
  if (refitting_level_) {
2580
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2581
        "[ReFitLevel] another thread is refitting");
L
Lei Jin 已提交
2582
    return Status::NotSupported("another thread is refitting");
2583 2584 2585
  }
  refitting_level_ = true;

2586
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
2587
  // move to a smaller level
2588 2589
  int to_level = target_level;
  if (target_level < 0) {
2590
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
2591
  }
2592

2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607
  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) {
2608
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2609 2610
        "[%s] Before refitting:\n%s", cfd->GetName().c_str(),
        cfd->current()->DebugString().data());
2611

2612
    VersionEdit edit;
I
Igor Canadi 已提交
2613
    edit.SetColumnFamily(cfd->GetID());
2614
    for (const auto& f : vstorage->LevelFiles(level)) {
2615
      edit.DeleteFile(level, f->fd.GetNumber());
2616 2617
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
2618 2619
                   f->smallest_seqno, f->largest_seqno,
                   f->marked_for_compaction);
2620
    }
2621
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2622 2623
        "[%s] Apply version edit:\n%s", cfd->GetName().c_str(),
        edit.DebugString().data());
2624

2625 2626
    status = versions_->LogAndApply(cfd, mutable_cf_options, &edit, &mutex_,
                                    directories_.GetDbDir());
2627 2628
    superversion_to_free.reset(InstallSuperVersionAndScheduleWork(
        cfd, new_superversion.release(), mutable_cf_options));
2629

2630
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2631
        "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
2632
        status.ToString().data());
2633 2634

    if (status.ok()) {
2635
      Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2636 2637
          "[%s] After refitting:\n%s", cfd->GetName().c_str(),
          cfd->current()->DebugString().data());
2638 2639 2640 2641
    }
  }

  refitting_level_ = false;
I
Igor Canadi 已提交
2642

L
Lei Jin 已提交
2643
  return status;
G
Gabor Cselle 已提交
2644 2645
}

2646 2647 2648
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
2649 2650
}

2651
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
2652
  return 0;
2653 2654
}

2655 2656
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
2657
  InstrumentedMutexLock l(&mutex_);
L
Lei Jin 已提交
2658 2659
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.level0_stop_writes_trigger;
2660 2661
}

L
Lei Jin 已提交
2662
Status DBImpl::Flush(const FlushOptions& flush_options,
2663 2664
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
2665
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
2666 2667
}

2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688
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(
2689 2690 2691 2692
            "SyncWAL() is not supported for this implementation of WAL file",
            immutable_db_options_.allow_mmap_writes
                ? "try setting Options::allow_mmap_writes to false"
                : Slice());
2693 2694 2695 2696 2697 2698 2699
      }
    }
    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;
2700
      logs_to_sync.push_back(log.writer);
2701 2702 2703 2704 2705
    }

    need_log_dir_sync = !log_dir_synced_;
  }

2706
  RecordTick(stats_, WAL_FILE_SYNCED);
2707 2708
  Status status;
  for (log::Writer* log : logs_to_sync) {
2709
    status = log->file()->SyncWithoutFlush(immutable_db_options_.use_fsync);
2710 2711 2712 2713 2714 2715 2716 2717
    if (!status.ok()) {
      break;
    }
  }
  if (status.ok() && need_log_dir_sync) {
    status = directories_.GetWalDir()->Fsync();
  }

2718
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:1");
2719 2720 2721 2722
  {
    InstrumentedMutexLock l(&mutex_);
    MarkLogsSynced(current_log_number, need_log_dir_sync, status);
  }
2723
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:2");
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739

  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) {
2740
      logs_to_free_.push_back(log.ReleaseWriter());
A
Andres Noetzli 已提交
2741
      it = logs_.erase(it);
2742 2743 2744 2745 2746
    } else {
      log.getting_synced = false;
      ++it;
    }
  }
2747 2748
  assert(logs_.empty() || logs_[0].number > up_to ||
         (logs_.size() == 1 && !logs_[0].getting_synced));
2749 2750 2751
  log_sync_cv_.SignalAll();
}

2752
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
2753 2754 2755
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
2756
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
2757
                                   int output_level, uint32_t output_path_id,
2758
                                   const Slice* begin, const Slice* end,
2759
                                   bool exclusive, bool disallow_trivial_move) {
2760 2761
  assert(input_level == ColumnFamilyData::kCompactAllLevels ||
         input_level >= 0);
2762

G
Gabor Cselle 已提交
2763
  InternalKey begin_storage, end_storage;
2764
  CompactionArg* ca;
G
Gabor Cselle 已提交
2765

2766 2767
  bool scheduled = false;
  bool manual_conflict = false;
H
hans@chromium.org 已提交
2768
  ManualCompaction manual;
I
Igor Canadi 已提交
2769
  manual.cfd = cfd;
2770 2771
  manual.input_level = input_level;
  manual.output_level = output_level;
2772
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
2773
  manual.done = false;
2774
  manual.in_progress = false;
2775 2776
  manual.incomplete = false;
  manual.exclusive = exclusive;
2777
  manual.disallow_trivial_move = disallow_trivial_move;
2778 2779 2780
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
2781 2782
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2783
    manual.begin = nullptr;
G
Gabor Cselle 已提交
2784
  } else {
2785
    begin_storage.SetMaxPossibleForUserKey(*begin);
G
Gabor Cselle 已提交
2786 2787
    manual.begin = &begin_storage;
  }
2788
  if (end == nullptr ||
2789 2790
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2791
    manual.end = nullptr;
G
Gabor Cselle 已提交
2792
  } else {
2793
    end_storage.SetMinPossibleForUserKey(*end);
G
Gabor Cselle 已提交
2794 2795 2796
    manual.end = &end_storage;
  }

2797 2798
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:0");
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:1");
2799
  InstrumentedMutexLock l(&mutex_);
2800

2801 2802 2803 2804 2805
  // 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.
  //
2806
  // HasPendingManualCompaction() is true when at least one thread is inside
2807
  // RunManualCompaction(), i.e. during that time no other compaction will
2808 2809 2810
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
2811
  // RunManualCompaction() from getting to the second while loop below.
2812 2813 2814
  // However, only one of them will actually schedule compaction, while
  // others will wait on a condition variable until it completes.

2815 2816 2817 2818
  AddManualCompaction(&manual);
  TEST_SYNC_POINT_CALLBACK("DBImpl::RunManualCompaction:NotScheduled", &mutex_);
  if (exclusive) {
    while (bg_compaction_scheduled_ > 0) {
2819
      Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2820 2821 2822 2823 2824
          "[%s] Manual compaction waiting for all other scheduled background "
          "compactions to finish",
          cfd->GetName().c_str());
      bg_cv_.Wait();
    }
2825
  }
2826

2827 2828
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
      "[%s] Manual compaction starting", cfd->GetName().c_str());
2829

2830 2831 2832 2833
  // 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) {
2834 2835
    assert(HasPendingManualCompaction());
    manual_conflict = false;
2836
    if (ShouldntRunManualCompaction(&manual) || (manual.in_progress == true) ||
2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847
        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);
2848
      // Running either this or some other manual compaction
G
Gabor Cselle 已提交
2849
      bg_cv_.Wait();
2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864
      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;
2865
      bg_compaction_scheduled_++;
2866 2867 2868
      env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                     &DBImpl::UnscheduleCallback);
      scheduled = true;
G
Gabor Cselle 已提交
2869
    }
H
hans@chromium.org 已提交
2870
  }
2871

2872
  assert(!manual.in_progress);
2873 2874
  assert(HasPendingManualCompaction());
  RemoveManualCompaction(&manual);
2875
  bg_cv_.SignalAll();
L
Lei Jin 已提交
2876
  return manual.status;
J
jorlow@chromium.org 已提交
2877 2878
}

2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895
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);
}

2896
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
2897 2898
                             const FlushOptions& flush_options,
                             bool writes_stopped) {
S
Stanislau Hlebik 已提交
2899 2900 2901
  Status s;
  {
    WriteContext context;
2902
    InstrumentedMutexLock guard_lock(&mutex_);
2903

2904
    if (cfd->imm()->NumNotFlushed() == 0 && cfd->mem()->IsEmpty()) {
2905 2906 2907 2908
      // Nothing to flush
      return Status::OK();
    }

2909
    WriteThread::Writer w;
2910 2911 2912
    if (!writes_stopped) {
      write_thread_.EnterUnbatched(&w, &mutex_);
    }
S
Stanislau Hlebik 已提交
2913

I
Igor Canadi 已提交
2914
    // SwitchMemtable() will release and reacquire mutex
S
Stanislau Hlebik 已提交
2915
    // during execution
I
Igor Canadi 已提交
2916
    s = SwitchMemtable(cfd, &context);
2917 2918 2919 2920

    if (!writes_stopped) {
      write_thread_.ExitUnbatched(&w);
    }
2921

S
Stanislau Hlebik 已提交
2922 2923
    cfd->imm()->FlushRequested();

2924 2925 2926
    // schedule flush
    SchedulePendingFlush(cfd);
    MaybeScheduleFlushOrCompaction();
S
Stanislau Hlebik 已提交
2927
  }
S
Stanislau Hlebik 已提交
2928

L
Lei Jin 已提交
2929
  if (s.ok() && flush_options.wait) {
2930
    // Wait until the compaction completes
2931
    s = WaitForFlushMemTable(cfd);
2932 2933
  }
  return s;
J
jorlow@chromium.org 已提交
2934 2935
}

2936
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
2937 2938
  Status s;
  // Wait until the compaction completes
2939
  InstrumentedMutexLock l(&mutex_);
2940
  while (cfd->imm()->NumNotFlushed() > 0 && bg_error_.ok()) {
2941 2942 2943
    if (shutting_down_.load(std::memory_order_acquire)) {
      return Status::ShutdownInProgress();
    }
2944 2945
    bg_cv_.Wait();
  }
2946
  if (!bg_error_.ok()) {
2947 2948 2949
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
2950 2951
}

2952 2953 2954 2955
Status DBImpl::EnableAutoCompaction(
    const std::vector<ColumnFamilyHandle*>& column_family_handles) {
  Status s;
  for (auto cf_ptr : column_family_handles) {
2956 2957
    Status status =
        this->SetOptions(cf_ptr, {{"disable_auto_compactions", "false"}});
2958
    if (!status.ok()) {
2959
      s = status;
2960 2961 2962 2963 2964 2965
    }
  }

  return s;
}

2966
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
2967
  mutex_.AssertHeld();
2968 2969 2970 2971
  if (!opened_successfully_) {
    // Compaction may introduce data race to DB open
    return;
  }
2972 2973
  if (bg_work_paused_ > 0) {
    // we paused the background work
2974
    return;
I
Igor Canadi 已提交
2975
  } else if (shutting_down_.load(std::memory_order_acquire)) {
J
jorlow@chromium.org 已提交
2976
    // DB is being deleted; no more background compactions
2977 2978
    return;
  }
2979

2980
  while (unscheduled_flushes_ > 0 &&
2981
         bg_flush_scheduled_ < immutable_db_options_.max_background_flushes) {
2982 2983
    unscheduled_flushes_--;
    bg_flush_scheduled_++;
2984
    env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH, this);
2985 2986
  }

2987 2988
  auto bg_compactions_allowed = BGCompactionsAllowed();

2989 2990
  // special case -- if max_background_flushes == 0, then schedule flush on a
  // compaction thread
2991
  if (immutable_db_options_.max_background_flushes == 0) {
2992 2993
    while (unscheduled_flushes_ > 0 &&
           bg_flush_scheduled_ + bg_compaction_scheduled_ <
2994
               bg_compactions_allowed) {
2995 2996 2997 2998 2999 3000
      unscheduled_flushes_--;
      bg_flush_scheduled_++;
      env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::LOW, this);
    }
  }

3001 3002 3003 3004 3005
  if (bg_compaction_paused_ > 0) {
    // we paused the background compaction
    return;
  }

3006
  if (HasExclusiveManualCompaction()) {
3007 3008 3009 3010 3011
    // only manual compactions are allowed to run. don't schedule automatic
    // compactions
    return;
  }

3012
  while (bg_compaction_scheduled_ < bg_compactions_allowed &&
3013
         unscheduled_compactions_ > 0) {
3014 3015 3016
    CompactionArg* ca = new CompactionArg;
    ca->db = this;
    ca->m = nullptr;
3017 3018
    bg_compaction_scheduled_++;
    unscheduled_compactions_--;
3019 3020
    env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                   &DBImpl::UnscheduleCallback);
3021 3022 3023
  }
}

3024 3025 3026 3027 3028 3029 3030 3031 3032
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);
}

3033
int DBImpl::BGCompactionsAllowed() const {
3034
  mutex_.AssertHeld();
3035
  if (write_controller_.NeedSpeedupCompaction()) {
3036
    return mutable_db_options_.max_background_compactions;
3037
  } else {
3038
    return mutable_db_options_.base_background_compactions;
3039 3040 3041
  }
}

3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084
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_;
3085 3086 3087
  }
}

3088 3089 3090 3091 3092 3093 3094 3095
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));
}

3096
void DBImpl::BGWorkFlush(void* db) {
3097
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3098
  TEST_SYNC_POINT("DBImpl::BGWorkFlush");
3099
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
3100
  TEST_SYNC_POINT("DBImpl::BGWorkFlush:done");
3101 3102
}

3103 3104 3105
void DBImpl::BGWorkCompaction(void* arg) {
  CompactionArg ca = *(reinterpret_cast<CompactionArg*>(arg));
  delete reinterpret_cast<CompactionArg*>(arg);
3106
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
3107
  TEST_SYNC_POINT("DBImpl::BGWorkCompaction");
3108 3109 3110
  reinterpret_cast<DBImpl*>(ca.db)->BackgroundCallCompaction(ca.m);
}

3111 3112
void DBImpl::BGWorkPurge(void* db) {
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3113
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:start");
3114
  reinterpret_cast<DBImpl*>(db)->BackgroundCallPurge();
3115
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:end");
3116 3117
}

3118 3119 3120 3121 3122 3123 3124
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");
3125 3126
}

3127 3128 3129
void DBImpl::BackgroundCallPurge() {
  mutex_.Lock();

3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141
  // We use one single loop to clear both queues so that after existing the loop
  // both queues are empty. This is stricter than what is needed, but can make
  // it easier for us to reason the correctness.
  while (!purge_queue_.empty() || !logs_to_free_queue_.empty()) {
    if (!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();
3142

3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155
      mutex_.Unlock();
      Status file_deletion_status;
      DeleteObsoleteFileImpl(file_deletion_status, job_id, fname, type, number,
                             path_id);
      mutex_.Lock();
    } else {
      assert(!logs_to_free_queue_.empty());
      log::Writer* log_writer = *(logs_to_free_queue_.begin());
      logs_to_free_queue_.pop_front();
      mutex_.Unlock();
      delete log_writer;
      mutex_.Lock();
    }
3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166
  }
  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();
}

3167
Status DBImpl::BackgroundFlush(bool* made_progress, JobContext* job_context,
H
Haobo Xu 已提交
3168
                               LogBuffer* log_buffer) {
3169
  mutex_.AssertHeld();
3170

3171 3172 3173 3174 3175 3176 3177
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

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

3180 3181 3182
  ColumnFamilyData* cfd = nullptr;
  while (!flush_queue_.empty()) {
    // This cfd is already referenced
I
Igor Canadi 已提交
3183
    auto first_cfd = PopFirstFromFlushQueue();
3184

I
Igor Canadi 已提交
3185
    if (first_cfd->IsDropped() || !first_cfd->imm()->IsFlushPending()) {
3186
      // can't flush this CF, try next one
I
Igor Canadi 已提交
3187 3188
      if (first_cfd->Unref()) {
        delete first_cfd;
3189 3190
      }
      continue;
3191
    }
3192 3193

    // found a flush!
I
Igor Canadi 已提交
3194
    cfd = first_cfd;
3195 3196 3197 3198 3199 3200 3201 3202 3203
    break;
  }

  if (cfd != nullptr) {
    const MutableCFOptions mutable_cf_options =
        *cfd->GetLatestMutableCFOptions();
    LogToBuffer(
        log_buffer,
        "Calling FlushMemTableToOutputFile with column "
3204 3205
        "family [%s], flush slots available %d, compaction slots allowed %d, "
        "compaction slots scheduled %d",
3206
        cfd->GetName().c_str(), immutable_db_options_.max_background_flushes,
3207
        bg_flush_scheduled_, BGCompactionsAllowed() - bg_compaction_scheduled_);
3208
    status = FlushMemTableToOutputFile(cfd, mutable_cf_options, made_progress,
3209 3210 3211
                                       job_context, log_buffer);
    if (cfd->Unref()) {
      delete cfd;
3212
    }
J
jorlow@chromium.org 已提交
3213
  }
3214
  return status;
J
jorlow@chromium.org 已提交
3215 3216
}

3217
void DBImpl::BackgroundCallFlush() {
3218
  bool made_progress = false;
3219
  JobContext job_context(next_job_id_.fetch_add(1), true);
3220 3221
  assert(bg_flush_scheduled_);

3222 3223
  TEST_SYNC_POINT("DBImpl::BackgroundCallFlush:start");

3224 3225
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
                       immutable_db_options_.info_log.get());
H
Haobo Xu 已提交
3226
  {
3227
    InstrumentedMutexLock l(&mutex_);
3228
    num_running_flushes_++;
H
Haobo Xu 已提交
3229

I
Igor Canadi 已提交
3230 3231 3232
    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

3233
    Status s = BackgroundFlush(&made_progress, &job_context, &log_buffer);
3234 3235 3236 3237 3238 3239 3240 3241 3242
    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();
3243
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
3244 3245 3246 3247
          "Waiting after background flush error: %s"
          "Accumulated background error counts: %" PRIu64,
          s.ToString().c_str(), error_cnt);
      log_buffer.FlushBufferToLog();
3248
      LogFlush(immutable_db_options_.info_log);
3249 3250
      env_->SleepForMicroseconds(1000000);
      mutex_.Lock();
H
Haobo Xu 已提交
3251 3252
    }

I
Igor Canadi 已提交
3253 3254
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

3255 3256 3257
    // 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 已提交
3258
    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
3259
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
3260
      mutex_.Unlock();
3261 3262 3263 3264 3265
      // 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 已提交
3266
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
3267 3268
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
3269
      }
I
Igor Canadi 已提交
3270
      job_context.Clean();
3271 3272
      mutex_.Lock();
    }
I
Igor Canadi 已提交
3273

3274 3275
    assert(num_running_flushes_ > 0);
    num_running_flushes_--;
H
Haobo Xu 已提交
3276
    bg_flush_scheduled_--;
3277 3278
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
H
Haobo Xu 已提交
3279
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
3280 3281 3282 3283
    // 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.
3284
  }
J
jorlow@chromium.org 已提交
3285 3286
}

3287
void DBImpl::BackgroundCallCompaction(void* arg) {
3288
  bool made_progress = false;
3289
  ManualCompaction* m = reinterpret_cast<ManualCompaction*>(arg);
3290
  JobContext job_context(next_job_id_.fetch_add(1), true);
3291
  TEST_SYNC_POINT("BackgroundCallCompaction:0");
H
Haobo Xu 已提交
3292
  MaybeDumpStats();
3293 3294
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
                       immutable_db_options_.info_log.get());
3295
  {
3296
    InstrumentedMutexLock l(&mutex_);
3297 3298

    // This call will unlock/lock the mutex to wait for current running
3299 3300
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
3301

3302
    num_running_compactions_++;
I
Igor Canadi 已提交
3303 3304 3305 3306

    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

3307
    assert(bg_compaction_scheduled_);
3308 3309
    Status s =
        BackgroundCompaction(&made_progress, &job_context, &log_buffer, m);
3310
    TEST_SYNC_POINT("BackgroundCallCompaction:1");
3311 3312 3313 3314 3315 3316
    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 =
3317
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
3318 3319 3320
      bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
      mutex_.Unlock();
      log_buffer.FlushBufferToLog();
3321
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
3322 3323 3324
          "Waiting after background compaction error: %s, "
          "Accumulated background error counts: %" PRIu64,
          s.ToString().c_str(), error_cnt);
3325
      LogFlush(immutable_db_options_.info_log);
3326 3327
      env_->SleepForMicroseconds(1000000);
      mutex_.Lock();
3328
    }
H
Haobo Xu 已提交
3329

I
Igor Canadi 已提交
3330 3331
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

3332 3333 3334 3335
    // 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());
3336 3337

    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
3338
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
3339
      mutex_.Unlock();
3340 3341 3342 3343 3344
      // 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 已提交
3345
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
3346 3347
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
3348
      }
I
Igor Canadi 已提交
3349
      job_context.Clean();
3350 3351
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
3352

3353 3354
    assert(num_running_compactions_ > 0);
    num_running_compactions_--;
3355
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
3356

3357 3358
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

3359 3360
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
3361 3362
    if (made_progress || bg_compaction_scheduled_ == 0 ||
        HasPendingManualCompaction()) {
3363
      // signal if
3364
      // * made_progress -- need to wakeup DelayWrite
3365
      // * bg_compaction_scheduled_ == 0 -- need to wakeup ~DBImpl
3366
      // * HasPendingManualCompaction -- need to wakeup RunManualCompaction
3367 3368 3369 3370
      // If none of this is true, there is no need to signal since nobody is
      // waiting for it
      bg_cv_.SignalAll();
    }
I
Igor Canadi 已提交
3371 3372 3373 3374
    // 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.
3375
  }
J
jorlow@chromium.org 已提交
3376 3377
}

3378 3379
Status DBImpl::BackgroundCompaction(bool* made_progress,
                                    JobContext* job_context,
3380 3381 3382
                                    LogBuffer* log_buffer, void* arg) {
  ManualCompaction* manual_compaction =
      reinterpret_cast<ManualCompaction*>(arg);
3383
  *made_progress = false;
J
jorlow@chromium.org 已提交
3384
  mutex_.AssertHeld();
3385
  TEST_SYNC_POINT("DBImpl::BackgroundCompaction:Start");
3386

3387 3388 3389 3390 3391
  bool is_manual = (manual_compaction != nullptr);

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

3393
  CompactionJobStats compaction_job_stats;
3394 3395 3396 3397 3398 3399
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
3400
    if (is_manual) {
3401 3402 3403 3404 3405
      manual_compaction->status = status;
      manual_compaction->done = true;
      manual_compaction->in_progress = false;
      delete manual_compaction->compaction;
      manual_compaction = nullptr;
3406
    }
3407
    return status;
3408 3409
  }

3410 3411
  if (is_manual) {
    // another thread cannot pick up the same work
3412
    manual_compaction->in_progress = true;
3413 3414 3415
  }

  unique_ptr<Compaction> c;
3416 3417
  // InternalKey manual_end_storage;
  // InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
3418
  if (is_manual) {
3419
    ManualCompaction* m = manual_compaction;
3420
    assert(m->in_progress);
3421
    c.reset(std::move(m->compaction));
3422
    if (!c) {
3423
      m->done = true;
3424
      m->manual_end = nullptr;
3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437
      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)"),
3438
                  ((m->done || m->manual_end == nullptr)
3439
                       ? "(end)"
3440
                       : m->manual_end->DebugString().c_str()));
G
Gabor Cselle 已提交
3441
    }
3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456
  } 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();
    }

3457 3458 3459 3460 3461 3462
    if (HaveManualCompaction(cfd)) {
      // Can't compact right now, but try again later
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction()::Conflict");
      return Status::OK();
    }

3463 3464 3465 3466 3467 3468 3469 3470 3471 3472
    // 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
3473
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction():BeforePickCompaction");
3474
      c.reset(cfd->PickCompaction(*mutable_cf_options, log_buffer));
3475
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction():AfterPickCompaction");
3476 3477 3478 3479 3480 3481
      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 已提交
3482
        // InstallSuperVersionAndScheduleWork
3483
        // 2) When MutableCFOptions changes. This case is also covered by
I
Igor Canadi 已提交
3484 3485
        // InstallSuperVersionAndScheduleWork, because this is when the new
        // options take effect.
3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496
        // 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 已提交
3497
        }
I
Igor Canadi 已提交
3498 3499
      }
    }
J
jorlow@chromium.org 已提交
3500 3501
  }

3502
  if (!c) {
H
hans@chromium.org 已提交
3503
    // Nothing to do
3504
    LogToBuffer(log_buffer, "Compaction nothing to do");
3505
  } else if (c->deletion_compaction()) {
I
Igor Canadi 已提交
3506 3507 3508 3509
    // 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);
3510
    assert(c->column_family_data()->ioptions()->compaction_style ==
I
Igor Canadi 已提交
3511
           kCompactionStyleFIFO);
3512 3513 3514

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

I
Igor Canadi 已提交
3515
    for (const auto& f : *c->inputs(0)) {
3516
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
3517
    }
3518 3519 3520
    status = versions_->LogAndApply(c->column_family_data(),
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
3521 3522
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
3523 3524 3525
    LogToBuffer(log_buffer, "[%s] Deleted %d files\n",
                c->column_family_data()->GetName().c_str(),
                c->num_input_files(0));
3526
    *made_progress = true;
3527
  } else if (!trivial_move_disallowed && c->IsTrivialMove()) {
3528
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:TrivialMove");
3529 3530
    // Instrument for event update
    // TODO(yhchiang): add op details for showing trivial-move.
3531 3532 3533
    ThreadStatusUtil::SetColumnFamily(
        c->column_family_data(), c->column_family_data()->ioptions()->env,
        immutable_db_options_.enable_thread_tracking);
3534 3535
    ThreadStatusUtil::SetThreadOperation(ThreadStatus::OP_COMPACTION);

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

3538 3539 3540
    // Move files to next level
    int32_t moved_files = 0;
    int64_t moved_bytes = 0;
3541
    for (unsigned int l = 0; l < c->num_input_levels(); l++) {
3542
      if (c->level(l) == c->output_level()) {
3543 3544 3545 3546
        continue;
      }
      for (size_t i = 0; i < c->num_input_files(l); i++) {
        FileMetaData* f = c->input(l, i);
3547
        c->edit()->DeleteFile(c->level(l), f->fd.GetNumber());
3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559
        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();
      }
3560
    }
3561

3562
    status = versions_->LogAndApply(c->column_family_data(),
3563 3564
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
3565
    // Use latest MutableCFOptions
I
Igor Canadi 已提交
3566 3567
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
3568

S
sdong 已提交
3569
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Islam AbdelRahman 已提交
3570
    c->column_family_data()->internal_stats()->IncBytesMoved(c->output_level(),
3571
                                                             moved_bytes);
3572 3573 3574 3575
    {
      event_logger_.LogToBuffer(log_buffer)
          << "job" << job_context->job_id << "event"
          << "trivial_move"
I
Islam AbdelRahman 已提交
3576
          << "destination_level" << c->output_level() << "files" << moved_files
3577
          << "total_files_size" << moved_bytes;
3578
    }
3579 3580
    LogToBuffer(
        log_buffer,
3581
        "[%s] Moved #%d files to level-%d %" PRIu64 " bytes %s: %s\n",
I
Islam AbdelRahman 已提交
3582 3583
        c->column_family_data()->GetName().c_str(), moved_files,
        c->output_level(), moved_bytes, status.ToString().c_str(),
3584
        c->column_family_data()->current()->storage_info()->LevelSummary(&tmp));
3585
    *made_progress = true;
3586 3587 3588

    // Clear Instrument
    ThreadStatusUtil::ResetThreadStatus();
J
jorlow@chromium.org 已提交
3589
  } else {
3590 3591 3592
    int output_level  __attribute__((unused)) = c->output_level();
    TEST_SYNC_POINT_CALLBACK("DBImpl::BackgroundCompaction:NonTrivial",
                             &output_level);
3593 3594 3595 3596 3597

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

I
Igor Canadi 已提交
3598
    assert(is_snapshot_supported_ || snapshots_.empty());
3599
    CompactionJob compaction_job(
3600
        job_context->job_id, c.get(), immutable_db_options_, env_options_,
I
Igor Canadi 已提交
3601
        versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
3602 3603 3604
        directories_.GetDataDir(c->output_path_id()), stats_, &mutex_,
        &bg_error_, snapshot_seqs, earliest_write_conflict_snapshot,
        table_cache_, &event_logger_,
3605
        c->mutable_cf_options()->paranoid_file_checks,
3606
        c->mutable_cf_options()->report_bg_io_stats, dbname_,
S
sdong 已提交
3607
        &compaction_job_stats);
I
Igor Canadi 已提交
3608
    compaction_job.Prepare();
3609

I
Igor Canadi 已提交
3610
    mutex_.Unlock();
3611
    compaction_job.Run();
3612
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:NonTrivial:AfterRun");
I
Igor Canadi 已提交
3613
    mutex_.Lock();
3614

3615
    status = compaction_job.Install(*c->mutable_cf_options());
I
Igor Canadi 已提交
3616
    if (status.ok()) {
I
Igor Canadi 已提交
3617 3618
      InstallSuperVersionAndScheduleWorkWrapper(
          c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
3619
    }
3620
    *made_progress = true;
O
Ori Bernstein 已提交
3621 3622
  }
  if (c != nullptr) {
3623 3624
    c->ReleaseCompactionFiles(status);
    *made_progress = true;
3625 3626 3627
    NotifyOnCompactionCompleted(
        c->column_family_data(), c.get(), status,
        compaction_job_stats, job_context->job_id);
J
jorlow@chromium.org 已提交
3628
  }
3629
  // this will unref its input_version and column_family_data
3630
  c.reset();
J
jorlow@chromium.org 已提交
3631 3632 3633

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
3634
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
3635 3636
    // Ignore compaction errors found during shutting down
  } else {
3637 3638 3639
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
        "Compaction error: %s", status.ToString().c_str());
    if (immutable_db_options_.paranoid_checks && bg_error_.ok()) {
J
jorlow@chromium.org 已提交
3640 3641 3642
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
3643 3644

  if (is_manual) {
3645
    ManualCompaction* m = manual_compaction;
3646
    if (!status.ok()) {
L
Lei Jin 已提交
3647
      m->status = status;
3648 3649
      m->done = true;
    }
3650 3651 3652 3653 3654 3655 3656 3657 3658
    // 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.
3659 3660 3661 3662
    //
    // 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
3663
    if (m->manual_end == nullptr) {
3664 3665
      m->done = true;
    }
G
Gabor Cselle 已提交
3666 3667 3668
    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 已提交
3669
      // Universal and FIFO compactions should always compact the whole range
S
sdong 已提交
3670 3671 3672
      assert(m->cfd->ioptions()->compaction_style !=
                 kCompactionStyleUniversal ||
             m->cfd->ioptions()->num_levels > 1);
3673
      assert(m->cfd->ioptions()->compaction_style != kCompactionStyleFIFO);
3674
      m->tmp_storage = *m->manual_end;
G
Gabor Cselle 已提交
3675
      m->begin = &m->tmp_storage;
3676
      m->incomplete = true;
G
Gabor Cselle 已提交
3677
    }
3678
    m->in_progress = false; // not being processed anymore
H
hans@chromium.org 已提交
3679
  }
3680
  TEST_SYNC_POINT("DBImpl::BackgroundCompaction:Finish");
3681
  return status;
J
jorlow@chromium.org 已提交
3682 3683
}

3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706
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;
}

3707
bool DBImpl::ShouldntRunManualCompaction(ManualCompaction* m) {
3708 3709
  if (num_running_ingest_file_ > 0) {
    // We need to wait for other IngestExternalFile() calls to finish
3710 3711 3712
    // before running a manual compaction.
    return true;
  }
3713 3714
  if (m->exclusive) {
    return (bg_compaction_scheduled_ > 0);
3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775
  }
  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;
}

3776 3777
size_t DBImpl::GetWalPreallocateBlockSize(uint64_t write_buffer_size) const {
  size_t bsize = write_buffer_size / 10 + write_buffer_size;
3778 3779
  // Some users might set very high write_buffer_size and rely on
  // max_total_wal_size or other parameters to control the WAL size.
3780 3781
  if (immutable_db_options_.max_total_wal_size > 0) {
    bsize = std::min<size_t>(bsize, immutable_db_options_.max_total_wal_size);
3782
  }
3783 3784
  if (immutable_db_options_.db_write_buffer_size > 0) {
    bsize = std::min<size_t>(bsize, immutable_db_options_.db_write_buffer_size);
3785
  }
3786 3787 3788 3789
  if (immutable_db_options_.write_buffer_manager &&
      immutable_db_options_.write_buffer_manager->enabled()) {
    bsize = std::min<size_t>(
        bsize, immutable_db_options_.write_buffer_manager->buffer_size());
3790 3791 3792 3793 3794
  }

  return bsize;
}

3795 3796
namespace {
struct IterState {
3797
  IterState(DBImpl* _db, InstrumentedMutex* _mu, SuperVersion* _super_version,
3798
            bool _background_purge)
3799 3800 3801
      : db(_db),
        mu(_mu),
        super_version(_super_version),
3802
        background_purge(_background_purge) {}
3803 3804

  DBImpl* db;
3805
  InstrumentedMutex* mu;
3806
  SuperVersion* super_version;
3807
  bool background_purge;
3808 3809 3810 3811
};

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

3813
  if (state->super_version->Unref()) {
3814 3815 3816
    // Job id == 0 means that this is not our background process, but rather
    // user thread
    JobContext job_context(0);
3817

3818 3819
    state->mu->Lock();
    state->super_version->Cleanup();
I
Igor Canadi 已提交
3820
    state->db->FindObsoleteFiles(&job_context, false, true);
3821 3822 3823
    if (state->background_purge) {
      state->db->ScheduleBgLogWriterClose(&job_context);
    }
3824 3825 3826
    state->mu->Unlock();

    delete state->super_version;
I
Igor Canadi 已提交
3827
    if (job_context.HaveSomethingToDelete()) {
3828
      if (state->background_purge) {
3829 3830 3831 3832 3833 3834 3835 3836 3837 3838
        // 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);
      }
3839
    }
I
Igor Canadi 已提交
3840
    job_context.Clean();
I
Igor Canadi 已提交
3841
  }
T
Tomislav Novak 已提交
3842

3843 3844
  delete state;
}
H
Hans Wennborg 已提交
3845
}  // namespace
3846

S
sdong 已提交
3847 3848 3849 3850 3851
InternalIterator* DBImpl::NewInternalIterator(const ReadOptions& read_options,
                                              ColumnFamilyData* cfd,
                                              SuperVersion* super_version,
                                              Arena* arena) {
  InternalIterator* internal_iter;
3852 3853
  assert(arena != nullptr);
  // Need to create internal iterator from the arena.
3854 3855 3856 3857
  MergeIteratorBuilder merge_iter_builder(
      &cfd->internal_comparator(), arena,
      !read_options.total_order_seek &&
          cfd->ioptions()->prefix_extractor != nullptr);
3858 3859
  // Collect iterator for mutable mem
  merge_iter_builder.AddIterator(
L
Lei Jin 已提交
3860
      super_version->mem->NewIterator(read_options, arena));
3861
  // Collect all needed child iterators for immutable memtables
L
Lei Jin 已提交
3862
  super_version->imm->AddIterators(read_options, &merge_iter_builder);
3863
  // Collect iterators for files in L0 - Ln
L
Lei Jin 已提交
3864
  super_version->current->AddIterators(read_options, env_options_,
3865 3866
                                       &merge_iter_builder);
  internal_iter = merge_iter_builder.Finish();
3867
  IterState* cleanup =
3868 3869
      new IterState(this, &mutex_, super_version,
                    read_options.background_purge_on_iterator_cleanup);
3870
  internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);
J
jorlow@chromium.org 已提交
3871 3872 3873 3874

  return internal_iter;
}

3875 3876 3877 3878
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
3879
Status DBImpl::Get(const ReadOptions& read_options,
3880
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3881
                   std::string* value) {
L
Lei Jin 已提交
3882
  return GetImpl(read_options, column_family, key, value);
3883 3884
}

I
Igor Canadi 已提交
3885 3886
// JobContext gets created and destructed outside of the lock --
// we
I
Igor Canadi 已提交
3887 3888
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3889
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3890
//
I
Igor Canadi 已提交
3891 3892 3893
// However, if InstallSuperVersionAndScheduleWork() gets called twice with the
// same job_context, we can't reuse the SuperVersion() that got
// malloced because
I
Igor Canadi 已提交
3894 3895 3896
// 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 已提交
3897
void DBImpl::InstallSuperVersionAndScheduleWorkWrapper(
I
Igor Canadi 已提交
3898
    ColumnFamilyData* cfd, JobContext* job_context,
3899
    const MutableCFOptions& mutable_cf_options) {
3900
  mutex_.AssertHeld();
I
Igor Canadi 已提交
3901
  SuperVersion* old_superversion = InstallSuperVersionAndScheduleWork(
I
Igor Canadi 已提交
3902 3903 3904
      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 已提交
3905 3906
}

I
Igor Canadi 已提交
3907
SuperVersion* DBImpl::InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
3908
    ColumnFamilyData* cfd, SuperVersion* new_sv,
I
Igor Canadi 已提交
3909
    const MutableCFOptions& mutable_cf_options) {
L
Lei Jin 已提交
3910
  mutex_.AssertHeld();
3911 3912 3913 3914 3915 3916 3917 3918 3919

  // 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 已提交
3920 3921 3922
  auto* old = cfd->InstallSuperVersion(
      new_sv ? new_sv : new SuperVersion(), &mutex_, mutable_cf_options);

3923
  // Whenever we install new SuperVersion, we might need to issue new flushes or
I
Igor Canadi 已提交
3924 3925 3926 3927
  // compactions.
  SchedulePendingFlush(cfd);
  SchedulePendingCompaction(cfd);
  MaybeScheduleFlushOrCompaction();
L
Lei Jin 已提交
3928 3929 3930 3931 3932 3933 3934 3935 3936 3937

  // 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,
3938 3939
                       ColumnFamilyHandle* column_family, const Slice& key,
                       std::string* value, bool* value_found) {
L
Lei Jin 已提交
3940
  StopWatch sw(env_, stats_, DB_GET);
3941
  PERF_TIMER_GUARD(get_snapshot_time);
3942

3943 3944 3945
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3946
  SequenceNumber snapshot;
L
Lei Jin 已提交
3947 3948 3949
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3950 3951
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3952
  }
3953
  // Acquire SuperVersion
3954
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
3955
  // Prepare to store a list of merge operations if merge occurs.
3956
  MergeContext merge_context;
3957

3958
  Status s;
3959
  // First look in the memtable, then in the immutable memtable (if any).
3960
  // s is both in/out. When in, s could either be OK or MergeInProgress.
3961
  // merge_operands will contain the sequence of merges in the latter case.
3962
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
3963
  PERF_TIMER_STOP(get_snapshot_time);
3964

3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977
  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) {
3978
    PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3979 3980
    sv->current->Get(read_options, lkey, value, &s, &merge_context,
                     value_found);
L
Lei Jin 已提交
3981
    RecordTick(stats_, MEMTABLE_MISS);
3982
  }
3983

3984 3985
  {
    PERF_TIMER_GUARD(get_post_process_time);
3986

3987
    ReturnAndCleanupSuperVersion(cfd, sv);
3988

3989 3990
    RecordTick(stats_, NUMBER_KEYS_READ);
    RecordTick(stats_, BYTES_READ, value->size());
3991
    MeasureTime(stats_, BYTES_PER_READ, value->size());
3992
  }
3993
  return s;
J
jorlow@chromium.org 已提交
3994 3995
}

3996
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
3997
    const ReadOptions& read_options,
3998
    const std::vector<ColumnFamilyHandle*>& column_family,
3999
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
4000

L
Lei Jin 已提交
4001
  StopWatch sw(env_, stats_, DB_MULTIGET);
4002
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
4003

4004
  SequenceNumber snapshot;
4005

4006
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
4007
    ColumnFamilyData* cfd;
4008 4009 4010 4011 4012
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
4013 4014 4015 4016 4017 4018
    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});
4019 4020 4021
    }
  }

4022
  mutex_.Lock();
L
Lei Jin 已提交
4023 4024 4025
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
4026 4027 4028
  } else {
    snapshot = versions_->LastSequence();
  }
4029
  for (auto mgd_iter : multiget_cf_data) {
4030 4031
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
4032
  }
4033
  mutex_.Unlock();
4034

4035 4036
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
4037

4038
  // Note: this always resizes the values array
4039 4040 4041
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
4042 4043

  // Keep track of bytes that we read for statistics-recording later
4044
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
4045
  PERF_TIMER_STOP(get_snapshot_time);
4046 4047 4048 4049

  // 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.
4050
  // merge_operands will contain the sequence of merges in the latter case.
4051
  for (size_t i = 0; i < num_keys; ++i) {
4052
    merge_context.Clear();
4053
    Status& s = stat_list[i];
4054 4055 4056
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
4057 4058
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
4059 4060 4061
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074
    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) {
4075
      PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
4076 4077
      super_version->current->Get(read_options, lkey, value, &s,
                                  &merge_context);
4078
      // TODO(?): RecordTick(stats_, MEMTABLE_MISS)?
4079 4080 4081
    }

    if (s.ok()) {
4082
      bytes_read += value->size();
4083 4084 4085 4086
    }
  }

  // Post processing (decrement reference counts and record statistics)
4087
  PERF_TIMER_GUARD(get_post_process_time);
4088 4089
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
4090
  // TODO(icanadi) do we need lock here or just around Cleanup()?
4091 4092 4093 4094 4095 4096
  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);
4097 4098
    }
  }
4099 4100 4101 4102 4103 4104 4105
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
4106
  }
4107

L
Lei Jin 已提交
4108 4109 4110
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
4111
  MeasureTime(stats_, BYTES_PER_MULTIGET, bytes_read);
L
Lei Jin 已提交
4112
  PERF_TIMER_STOP(get_post_process_time);
4113

4114
  return stat_list;
4115 4116
}

L
Lei Jin 已提交
4117
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
4118
                                  const std::string& column_family_name,
4119
                                  ColumnFamilyHandle** handle) {
Y
Yueh-Hsuan Chiang 已提交
4120
  Status s;
4121
  Status persist_options_status;
I
Igor Canadi 已提交
4122
  *handle = nullptr;
4123 4124

  s = CheckCompressionSupported(cf_options);
4125
  if (s.ok() && immutable_db_options_.allow_concurrent_memtable_write) {
4126 4127
    s = CheckConcurrentWritesSupported(cf_options);
  }
4128 4129 4130 4131
  if (!s.ok()) {
    return s;
  }

Y
Yueh-Hsuan Chiang 已提交
4132
  {
4133
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
4134

Y
Yueh-Hsuan Chiang 已提交
4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147
    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
I
Igor Canadi 已提交
4148
    {  // write thread
4149 4150
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
I
Igor Canadi 已提交
4151 4152
      // LogAndApply will both write the creation in MANIFEST and create
      // ColumnFamilyData object
4153 4154 4155
      s = versions_->LogAndApply(nullptr, MutableCFOptions(cf_options), &edit,
                                 &mutex_, directories_.GetDbDir(), false,
                                 &cf_options);
4156 4157 4158 4159 4160 4161

      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();
      }
4162
      write_thread_.ExitUnbatched(&w);
I
Igor Canadi 已提交
4163
    }
Y
Yueh-Hsuan Chiang 已提交
4164 4165 4166 4167 4168
    if (s.ok()) {
      single_column_family_mode_ = false;
      auto* cfd =
          versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
      assert(cfd != nullptr);
I
Igor Canadi 已提交
4169
      delete InstallSuperVersionAndScheduleWork(
Y
Yueh-Hsuan Chiang 已提交
4170
          cfd, nullptr, *cfd->GetLatestMutableCFOptions());
S
sdong 已提交
4171 4172 4173 4174 4175

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

Y
Yueh-Hsuan Chiang 已提交
4176
      *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
4177 4178 4179
      Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
          "Created column family [%s] (ID %u)", column_family_name.c_str(),
          (unsigned)cfd->GetID());
Y
Yueh-Hsuan Chiang 已提交
4180
    } else {
4181
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
Y
Yueh-Hsuan Chiang 已提交
4182 4183 4184
          "Creating column family [%s] FAILED -- %s",
          column_family_name.c_str(), s.ToString().c_str());
    }
4185
  }  // InstrumentedMutexLock l(&mutex_)
Y
Yueh-Hsuan Chiang 已提交
4186 4187

  // this is outside the mutex
4188
  if (s.ok()) {
4189 4190
    NewThreadStatusCfInfo(
        reinterpret_cast<ColumnFamilyHandleImpl*>(*handle)->cfd());
4191
    if (!persist_options_status.ok()) {
4192
      if (immutable_db_options_.fail_if_options_file_error) {
4193 4194 4195 4196 4197
        s = Status::IOError(
            "ColumnFamily has been created, but unable to persist"
            "options in CreateColumnFamily()",
            persist_options_status.ToString().c_str());
      }
4198
      Warn(immutable_db_options_.info_log,
4199 4200 4201
           "Unable to persist options in CreateColumnFamily() -- %s",
           persist_options_status.ToString().c_str());
    }
4202
  }
4203
  return s;
4204 4205
}

4206 4207 4208 4209
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
4210 4211
    return Status::InvalidArgument("Can't drop default column family");
  }
4212

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

I
Igor Canadi 已提交
4215 4216
  VersionEdit edit;
  edit.DropColumnFamily();
4217 4218
  edit.SetColumnFamily(cfd->GetID());

4219
  Status s;
4220
  Status options_persist_status;
4221
  {
4222
    InstrumentedMutexLock l(&mutex_);
4223 4224 4225 4226
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
4227
      // we drop column family from a single write thread
4228 4229
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
4230 4231
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
4232 4233 4234 4235 4236
      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();
      }
4237
      write_thread_.ExitUnbatched(&w);
4238
    }
S
sdong 已提交
4239 4240 4241 4242 4243 4244

    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()) {
4245
        if (!c->IsDropped() && !c->mem()->IsSnapshotSupported()) {
S
sdong 已提交
4246 4247 4248 4249 4250 4251
          new_is_snapshot_supported = false;
          break;
        }
      }
      is_snapshot_supported_ = new_is_snapshot_supported;
    }
4252
  }
4253

4254
  if (s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
4255 4256 4257 4258
    // 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 已提交
4259
    assert(cfd->IsDropped());
L
Lei Jin 已提交
4260 4261 4262
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ -= mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
4263
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
4264 4265
        "Dropped column family with id %u\n", cfd->GetID());

4266
    if (!options_persist_status.ok()) {
4267
      if (immutable_db_options_.fail_if_options_file_error) {
4268 4269 4270 4271 4272
        s = Status::IOError(
            "ColumnFamily has been dropped, but unable to persist "
            "options in DropColumnFamily()",
            options_persist_status.ToString().c_str());
      }
4273
      Warn(immutable_db_options_.info_log,
4274 4275 4276
           "Unable to persist options in DropColumnFamily() -- %s",
           options_persist_status.ToString().c_str());
    }
4277
  } else {
4278 4279 4280
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
        "Dropping column family with id %u FAILED -- %s\n", cfd->GetID(),
        s.ToString().c_str());
4281 4282
  }

4283
  return s;
4284 4285
}

L
Lei Jin 已提交
4286
bool DBImpl::KeyMayExist(const ReadOptions& read_options,
4287 4288
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
4289
  if (value_found != nullptr) {
K
Kai Liu 已提交
4290 4291
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
4292
  }
L
Lei Jin 已提交
4293
  ReadOptions roptions = read_options;
4294
  roptions.read_tier = kBlockCacheTier; // read from block cache only
4295
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
4296

4297
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
4298 4299 4300
  // 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();
4301 4302
}

4303
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
4304
                              ColumnFamilyHandle* column_family) {
4305 4306 4307 4308
  if (read_options.read_tier == kPersistedTier) {
    return NewErrorIterator(Status::NotSupported(
        "ReadTier::kPersistedData is not yet supported in iterators."));
  }
4309 4310
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
4311

V
Venkatesh Radhakrishnan 已提交
4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329
  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 已提交
4330 4331 4332 4333
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
4334 4335
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
    auto iter = new ForwardIterator(this, read_options, cfd, sv);
4336 4337
    return NewDBIterator(
        env_, *cfd->ioptions(), cfd->user_comparator(), iter,
4338 4339
        kMaxSequenceNumber,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4340 4341
        sv->version_number, read_options.iterate_upper_bound,
        read_options.prefix_same_as_start, read_options.pin_data);
I
Igor Canadi 已提交
4342
#endif
T
Tomislav Novak 已提交
4343
  } else {
4344
    SequenceNumber latest_snapshot = versions_->LastSequence();
4345
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
4346

I
Igor Canadi 已提交
4347
    auto snapshot =
4348 4349 4350
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
4351
            : latest_snapshot;
T
Tomislav Novak 已提交
4352

4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388
    // 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         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
4389 4390
    // ArenaWrappedDBIter inlines an arena area where all the iterators in
    // the iterator tree are allocated in the order of being accessed when
4391 4392 4393 4394 4395
    // 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(
4396 4397
        env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4398
        sv->version_number, read_options.iterate_upper_bound,
4399 4400
        read_options.prefix_same_as_start, read_options.pin_data,
        read_options.total_order_seek);
4401

S
sdong 已提交
4402
    InternalIterator* internal_iter =
4403
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
4404 4405 4406 4407
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
4408 4409
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
4410 4411
}

4412
Status DBImpl::NewIterators(
4413
    const ReadOptions& read_options,
I
Igor Canadi 已提交
4414
    const std::vector<ColumnFamilyHandle*>& column_families,
4415
    std::vector<Iterator*>* iterators) {
4416 4417 4418 4419
  if (read_options.read_tier == kPersistedTier) {
    return Status::NotSupported(
        "ReadTier::kPersistedData is not yet supported in iterators.");
  }
I
Igor Canadi 已提交
4420 4421
  iterators->clear();
  iterators->reserve(column_families.size());
V
Venkatesh Radhakrishnan 已提交
4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441
  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 已提交
4442 4443 4444 4445
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
4446 4447
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
4448 4449
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
      auto iter = new ForwardIterator(this, read_options, cfd, sv);
4450 4451 4452
      iterators->push_back(NewDBIterator(
          env_, *cfd->ioptions(), cfd->user_comparator(), iter,
          kMaxSequenceNumber,
4453 4454
          sv->mutable_cf_options.max_sequential_skip_in_iterations,
          sv->version_number, nullptr, false, read_options.pin_data));
I
Igor Canadi 已提交
4455
    }
I
Igor Canadi 已提交
4456
#endif
I
Igor Canadi 已提交
4457
  } else {
4458 4459
    SequenceNumber latest_snapshot = versions_->LastSequence();

I
Igor Canadi 已提交
4460
    for (size_t i = 0; i < column_families.size(); ++i) {
4461 4462 4463
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
4464 4465

      auto snapshot =
4466 4467 4468
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
4469 4470
              : latest_snapshot;

4471
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
4472
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
4473 4474
          sv->mutable_cf_options.max_sequential_skip_in_iterations,
          sv->version_number, nullptr, false, read_options.pin_data);
S
sdong 已提交
4475 4476
      InternalIterator* internal_iter =
          NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
4477 4478
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
4479 4480 4481 4482
    }
  }

  return Status::OK();
4483 4484
}

4485 4486
const Snapshot* DBImpl::GetSnapshot() { return GetSnapshotImpl(false); }

4487
#ifndef ROCKSDB_LITE
4488 4489 4490
const Snapshot* DBImpl::GetSnapshotForWriteConflictBoundary() {
  return GetSnapshotImpl(true);
}
4491
#endif  // ROCKSDB_LITE
4492 4493

const Snapshot* DBImpl::GetSnapshotImpl(bool is_write_conflict_boundary) {
4494 4495
  int64_t unix_time = 0;
  env_->GetCurrentTime(&unix_time);  // Ignore error
4496
  SnapshotImpl* s = new SnapshotImpl;
4497

4498
  InstrumentedMutexLock l(&mutex_);
4499
  // returns null if the underlying memtable does not support snapshot.
4500 4501 4502 4503
  if (!is_snapshot_supported_) {
    delete s;
    return nullptr;
  }
4504 4505
  return snapshots_.New(s, versions_->LastSequence(), unix_time,
                        is_write_conflict_boundary);
J
jorlow@chromium.org 已提交
4506 4507 4508
}

void DBImpl::ReleaseSnapshot(const Snapshot* s) {
4509 4510 4511 4512 4513 4514
  const SnapshotImpl* casted_s = reinterpret_cast<const SnapshotImpl*>(s);
  {
    InstrumentedMutexLock l(&mutex_);
    snapshots_.Delete(casted_s);
  }
  delete casted_s;
J
jorlow@chromium.org 已提交
4515 4516 4517
}

// Convenience methods
4518 4519
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
4520
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
4521 4522
}

4523 4524 4525
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
4526
  if (!cfh->cfd()->ioptions()->merge_operator) {
4527 4528
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
4529
    return DB::Merge(o, column_family, key, val);
4530 4531 4532
  }
}

L
Lei Jin 已提交
4533
Status DBImpl::Delete(const WriteOptions& write_options,
4534
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
4535
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
4536 4537
}

A
Andres Noetzli 已提交
4538 4539 4540 4541 4542 4543
Status DBImpl::SingleDelete(const WriteOptions& write_options,
                            ColumnFamilyHandle* column_family,
                            const Slice& key) {
  return DB::SingleDelete(write_options, column_family, key);
}

L
Lei Jin 已提交
4544
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
4545
  return WriteImpl(write_options, my_batch, nullptr, nullptr);
A
agiardullo 已提交
4546 4547
}

A
agiardullo 已提交
4548
#ifndef ROCKSDB_LITE
A
agiardullo 已提交
4549 4550 4551
Status DBImpl::WriteWithCallback(const WriteOptions& write_options,
                                 WriteBatch* my_batch,
                                 WriteCallback* callback) {
4552
  return WriteImpl(write_options, my_batch, callback, nullptr);
A
agiardullo 已提交
4553
}
A
agiardullo 已提交
4554
#endif  // ROCKSDB_LITE
A
agiardullo 已提交
4555 4556

Status DBImpl::WriteImpl(const WriteOptions& write_options,
4557 4558 4559
                         WriteBatch* my_batch, WriteCallback* callback,
                         uint64_t* log_used, uint64_t log_ref,
                         bool disable_memtable) {
S
Stanislau Hlebik 已提交
4560 4561 4562
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
4563 4564 4565
  if (write_options.timeout_hint_us != 0) {
    return Status::InvalidArgument("timeout_hint_us is deprecated");
  }
A
agiardullo 已提交
4566 4567

  Status status;
A
agiardullo 已提交
4568

A
agiardullo 已提交
4569 4570 4571
  bool xfunc_attempted_write = false;
  XFUNC_TEST("transaction", "transaction_xftest_write_impl",
             xf_transaction_write1, xf_transaction_write, write_options,
4572
             immutable_db_options_, my_batch, callback, this, &status,
A
agiardullo 已提交
4573 4574 4575 4576 4577 4578
             &xfunc_attempted_write);
  if (xfunc_attempted_write) {
    // Test already did the write
    return status;
  }

4579
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
4580
  WriteThread::Writer w;
S
Stanislau Hlebik 已提交
4581
  w.batch = my_batch;
L
Lei Jin 已提交
4582 4583
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
4584
  w.disable_memtable = disable_memtable;
S
Stanislau Hlebik 已提交
4585
  w.in_batch_group = false;
4586
  w.callback = callback;
4587
  w.log_ref = log_ref;
S
Stanislau Hlebik 已提交
4588

L
Lei Jin 已提交
4589
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4590 4591 4592
    RecordTick(stats_, WRITE_WITH_WAL);
  }

4593
  StopWatch write_sw(env_, immutable_db_options_.statistics.get(), DB_WRITE);
4594

4595
  write_thread_.JoinBatchGroup(&w);
4596 4597 4598 4599
  if (w.state == WriteThread::STATE_PARALLEL_FOLLOWER) {
    // we are a non-leader in a parallel group
    PERF_TIMER_GUARD(write_memtable_time);

4600 4601 4602 4603 4604
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }

    if (w.ShouldWriteToMemtable()) {
4605 4606 4607 4608
      ColumnFamilyMemTablesImpl column_family_memtables(
          versions_->GetColumnFamilySet());
      WriteBatchInternal::SetSequence(w.batch, w.sequence);
      w.status = WriteBatchInternal::InsertInto(
4609
          &w, &column_family_memtables, &flush_scheduler_,
4610
          write_options.ignore_missing_column_families, 0 /*log_number*/, this,
S
sdong 已提交
4611
          true /*concurrent_memtable_writes*/);
4612
    }
4613 4614 4615

    if (write_thread_.CompleteParallelWorker(&w)) {
      // we're responsible for early exit
4616
      auto last_sequence = w.parallel_group->last_sequence;
4617 4618 4619 4620 4621 4622
      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
4623 4624

    status = w.FinalStatus();
4625 4626
  }
  if (w.state == WriteThread::STATE_COMPLETED) {
4627 4628 4629
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }
4630
    // write is complete and leader has updated sequence
4631
    RecordTick(stats_, WRITE_DONE_BY_OTHER);
4632
    return w.FinalStatus();
4633 4634
  }
  // else we are the leader of the write batch group
4635
  assert(w.state == WriteThread::STATE_GROUP_LEADER);
4636

S
Stanislau Hlebik 已提交
4637 4638
  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4639 4640 4641 4642 4643

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

S
Stanislau Hlebik 已提交
4644 4645
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
4646

4647 4648 4649 4650
  // 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.
4651 4652 4653
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

4654
  uint64_t max_total_wal_size = (immutable_db_options_.max_total_wal_size == 0)
4655
                                    ? 4 * max_total_in_memory_state_
4656
                                    : immutable_db_options_.max_total_wal_size;
4657 4658 4659
  if (UNLIKELY(!single_column_family_mode_ &&
               alive_log_files_.begin()->getting_flushed == false &&
               total_log_size_ > max_total_wal_size)) {
I
Igor Canadi 已提交
4660
    uint64_t flush_column_family_if_log_file = alive_log_files_.begin()->number;
I
Igor Canadi 已提交
4661
    alive_log_files_.begin()->getting_flushed = true;
4662
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
4663 4664 4665
        "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 已提交
4666 4667
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4668
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4669 4670 4671
      if (cfd->IsDropped()) {
        continue;
      }
I
Igor Canadi 已提交
4672
      if (cfd->GetLogNumber() <= flush_column_family_if_log_file) {
I
Igor Canadi 已提交
4673
        status = SwitchMemtable(cfd, &context);
I
Igor Canadi 已提交
4674 4675 4676
        if (!status.ok()) {
          break;
        }
S
Stanislau Hlebik 已提交
4677
        cfd->imm()->FlushRequested();
4678
        SchedulePendingFlush(cfd);
4679
      }
4680
    }
I
Igor Canadi 已提交
4681
    MaybeScheduleFlushOrCompaction();
4682 4683 4684 4685 4686 4687
  } 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.
4688
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
4689 4690
        "Flushing column family with largest mem table size. Write buffer is "
        "using %" PRIu64 " bytes out of a total of %" PRIu64 ".",
4691 4692
        write_buffer_manager_->memory_usage(),
        write_buffer_manager_->buffer_size());
4693 4694
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4695 4696 4697
    ColumnFamilyData* largest_cfd = nullptr;
    size_t largest_cfd_size = 0;

4698
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4699 4700 4701
      if (cfd->IsDropped()) {
        continue;
      }
4702
      if (!cfd->mem()->IsEmpty()) {
4703 4704 4705 4706 4707 4708
        // 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;
4709 4710 4711
        }
      }
    }
4712 4713 4714 4715 4716 4717 4718 4719
    if (largest_cfd != nullptr) {
      status = SwitchMemtable(largest_cfd, &context);
      if (status.ok()) {
        largest_cfd->imm()->FlushRequested();
        SchedulePendingFlush(largest_cfd);
        MaybeScheduleFlushOrCompaction();
      }
    }
I
Igor Canadi 已提交
4720 4721 4722 4723 4724 4725 4726 4727 4728 4729
  }

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

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

4730 4731
  if (UNLIKELY(status.ok() && (write_controller_.IsStopped() ||
                               write_controller_.NeedsDelay()))) {
4732 4733
    PERF_TIMER_STOP(write_pre_and_post_process_time);
    PERF_TIMER_GUARD(write_delay_time);
S
sdong 已提交
4734 4735 4736 4737
    // 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.
4738
    status = DelayWrite(last_batch_group_size_);
4739
    PERF_TIMER_START(write_pre_and_post_process_time);
I
Igor Canadi 已提交
4740 4741
  }

D
dgrogan@chromium.org 已提交
4742
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4743
  WriteThread::Writer* last_writer = &w;
4744
  autovector<WriteThread::Writer*> write_group;
4745 4746
  bool need_log_sync = !write_options.disableWAL && write_options.sync;
  bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
A
agiardullo 已提交
4747

S
Stanislau Hlebik 已提交
4748
  if (status.ok()) {
4749
    if (need_log_sync) {
4750 4751 4752 4753 4754 4755 4756 4757 4758
      while (logs_.front().getting_synced) {
        log_sync_cv_.Wait();
      }
      for (auto& log : logs_) {
        assert(!log.getting_synced);
        log.getting_synced = true;
      }
    }

4759 4760 4761
    // 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
4762
    // into memtables
A
agiardullo 已提交
4763 4764
  }

4765 4766
  mutex_.Unlock();

A
agiardullo 已提交
4767 4768
  // At this point the mutex is unlocked

4769
  bool exit_completed_early = false;
4770 4771
  last_batch_group_size_ =
      write_thread_.EnterAsBatchGroupLeader(&w, &last_writer, &write_group);
4772

A
agiardullo 已提交
4773
  if (status.ok()) {
4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786
    // 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.
4787 4788
    bool parallel = immutable_db_options_.allow_concurrent_memtable_write &&
                    write_group.size() > 1;
4789 4790
    int total_count = 0;
    uint64_t total_byte_size = 0;
4791 4792
    for (auto writer : write_group) {
      if (writer->CheckCallback(this)) {
4793 4794 4795 4796 4797 4798 4799 4800 4801
        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));
        }
4802
      }
4803 4804 4805 4806 4807 4808 4809 4810
    }

    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);
4811
    MeasureTime(stats_, BYTES_PER_WRITE, total_byte_size);
4812
    PERF_TIMER_STOP(write_pre_and_post_process_time);
4813

4814
    if (write_options.disableWAL) {
4815
      has_unpersisted_data_ = true;
4816
    }
4817

4818 4819 4820
    uint64_t log_size = 0;
    if (!write_options.disableWAL) {
      PERF_TIMER_GUARD(write_wal_time);
4821

4822
      WriteBatch* merged_batch = nullptr;
4823 4824 4825 4826 4827
      if (write_group.size() == 1 && write_group[0]->ShouldWriteToWAL() &&
          write_group[0]->batch->GetWalTerminationPoint().is_cleared()) {
        // we simply write the first WriteBatch to WAL if the group only
        // contains one batch, that batch should be written to the WAL,
        // and the batch is not wanting to be truncated
4828
        merged_batch = write_group[0]->batch;
4829
        write_group[0]->log_used = logfile_number_;
4830 4831 4832 4833 4834
      } 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_;
4835
        for (auto writer : write_group) {
4836
          if (writer->ShouldWriteToWAL()) {
4837 4838
            WriteBatchInternal::Append(merged_batch, writer->batch,
                                       /*WAL_only*/ true);
4839
          }
4840
          writer->log_used = logfile_number_;
4841 4842 4843
        }
      }

4844 4845 4846 4847 4848
      if (log_used != nullptr) {
        *log_used = logfile_number_;
      }

      WriteBatchInternal::SetSequence(merged_batch, current_sequence);
4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867

      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_) {
4868
          status = log.writer->file()->Sync(immutable_db_options_.use_fsync);
4869 4870 4871 4872 4873 4874 4875 4876 4877 4878
          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();
        }
4879 4880
      }

4881 4882 4883 4884 4885 4886
      if (merged_batch == &tmp_batch_) {
        tmp_batch_.Clear();
      }
    }
    if (status.ok()) {
      PERF_TIMER_GUARD(write_memtable_time);
4887

4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899
      {
        // 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);
4900
          }
4901
          stats->AddDBStats(InternalStats::WAL_FILE_BYTES, log_size);
4902
        }
4903
        uint64_t for_other = write_group.size() - 1;
4904 4905 4906 4907
        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);
4908
          }
H
heyongqiang 已提交
4909
        }
4910
      }
Y
Yueh-Hsuan Chiang 已提交
4911

4912
      if (!parallel) {
4913
        status = WriteBatchInternal::InsertInto(
4914
            write_group, current_sequence, column_family_memtables_.get(),
4915
            &flush_scheduler_, write_options.ignore_missing_column_families,
S
sdong 已提交
4916
            0 /*log_number*/, this);
4917 4918 4919 4920 4921 4922 4923

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

4924
      } else {
4925
        WriteThread::ParallelGroup pg;
4926 4927
        pg.leader = &w;
        pg.last_writer = last_writer;
4928
        pg.last_sequence = last_sequence;
4929
        pg.early_exit_allowed = !need_log_sync;
4930
        pg.running.store(static_cast<uint32_t>(write_group.size()),
4931
                         std::memory_order_relaxed);
4932 4933
        write_thread_.LaunchParallelFollowers(&pg, current_sequence);

4934
        if (w.ShouldWriteToMemtable()) {
4935 4936 4937 4938 4939 4940
          // do leader write
          ColumnFamilyMemTablesImpl column_family_memtables(
              versions_->GetColumnFamilySet());
          assert(w.sequence == current_sequence);
          WriteBatchInternal::SetSequence(w.batch, w.sequence);
          w.status = WriteBatchInternal::InsertInto(
4941
              &w, &column_family_memtables, &flush_scheduler_,
4942
              write_options.ignore_missing_column_families, 0 /*log_number*/,
S
sdong 已提交
4943
              this, true /*concurrent_memtable_writes*/);
4944 4945
        }

4946 4947 4948
        // CompleteParallelWorker returns true if this thread should
        // handle exit, false means somebody else did
        exit_completed_early = !write_thread_.CompleteParallelWorker(&w);
4949
        status = w.FinalStatus();
4950
      }
A
agiardullo 已提交
4951

4952
      if (!exit_completed_early && w.status.ok()) {
4953 4954 4955
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
        versions_->SetLastSequence(last_sequence);
        if (!need_log_sync) {
4956
          write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
4957
          exit_completed_early = true;
4958
        }
4959
      }
4960 4961 4962 4963 4964 4965 4966 4967 4968

      // 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.
4969
      if (!status.ok() && bg_error_.ok() && !w.CallbackFailed()) {
4970
        bg_error_ = status;
4971
      }
4972
    }
4973
  }
4974
  PERF_TIMER_START(write_pre_and_post_process_time);
A
agiardullo 已提交
4975

4976 4977
  if (immutable_db_options_.paranoid_checks && !status.ok() &&
      !w.CallbackFailed() && !status.IsBusy()) {
4978 4979 4980 4981 4982
    mutex_.Lock();
    if (bg_error_.ok()) {
      bg_error_ = status;  // stop compaction & fail any further writes
    }
    mutex_.Unlock();
I
Igor Canadi 已提交
4983
  }
4984

4985
  if (need_log_sync) {
4986
    mutex_.Lock();
4987
    MarkLogsSynced(logfile_number_, need_log_dir_sync, status);
4988
    mutex_.Unlock();
4989 4990
  }

4991
  if (!exit_completed_early) {
4992
    write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
4993
  }
4994

J
jorlow@chromium.org 已提交
4995 4996 4997
  return status;
}

4998 4999
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
5000
Status DBImpl::DelayWrite(uint64_t num_bytes) {
S
sdong 已提交
5001 5002 5003 5004
  uint64_t time_delayed = 0;
  bool delayed = false;
  {
    StopWatch sw(env_, stats_, WRITE_STALL, &time_delayed);
S
sdong 已提交
5005 5006
    auto delay = write_controller_.GetDelay(env_, num_bytes);
    if (delay > 0) {
S
sdong 已提交
5007 5008
      mutex_.Unlock();
      delayed = true;
S
sdong 已提交
5009
      TEST_SYNC_POINT("DBImpl::DelayWrite:Sleep");
5010 5011
      // hopefully we don't have to sleep more than 2 billion microseconds
      env_->SleepForMicroseconds(static_cast<int>(delay));
S
sdong 已提交
5012 5013
      mutex_.Lock();
    }
5014

5015
    while (bg_error_.ok() && write_controller_.IsStopped()) {
S
sdong 已提交
5016
      delayed = true;
5017 5018
      TEST_SYNC_POINT("DBImpl::DelayWrite:Wait");
      bg_cv_.Wait();
5019 5020
    }
  }
S
sdong 已提交
5021 5022 5023 5024 5025
  if (delayed) {
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_STALL_MICROS,
                                           time_delayed);
    RecordTick(stats_, STALL_MICROS, time_delayed);
  }
I
Igor Canadi 已提交
5026 5027

  return bg_error_;
5028 5029
}

I
Igor Canadi 已提交
5030 5031
Status DBImpl::ScheduleFlushes(WriteContext* context) {
  ColumnFamilyData* cfd;
5032
  while ((cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
5033
    auto status = SwitchMemtable(cfd, context);
I
Igor Canadi 已提交
5034 5035 5036 5037 5038
    if (cfd->Unref()) {
      delete cfd;
    }
    if (!status.ok()) {
      return status;
S
Stanislau Hlebik 已提交
5039 5040
    }
  }
I
Igor Canadi 已提交
5041
  return Status::OK();
S
Stanislau Hlebik 已提交
5042 5043
}

5044 5045 5046
#ifndef ROCKSDB_LITE
void DBImpl::NotifyOnMemTableSealed(ColumnFamilyData* cfd,
                                    const MemTableInfo& mem_table_info) {
5047
  if (immutable_db_options_.listeners.size() == 0U) {
5048 5049 5050 5051 5052 5053
    return;
  }
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }

5054
  for (auto listener : immutable_db_options_.listeners) {
5055
    listener->OnMemTableSealed(mem_table_info);
5056
  }
5057 5058 5059
}
#endif  // ROCKSDB_LITE

S
Stanislau Hlebik 已提交
5060 5061
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
5062
Status DBImpl::SwitchMemtable(ColumnFamilyData* cfd, WriteContext* context) {
S
Stanislau Hlebik 已提交
5063 5064 5065 5066 5067 5068 5069
  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.
5070
  assert(versions_->prev_log_number() == 0);
S
Stanislau Hlebik 已提交
5071
  bool creating_new_log = !log_empty_;
S
Sage Weil 已提交
5072
  uint64_t recycle_log_number = 0;
5073
  if (creating_new_log && immutable_db_options_.recycle_log_file_num &&
S
Sage Weil 已提交
5074 5075 5076 5077
      !log_recycle_files.empty()) {
    recycle_log_number = log_recycle_files.front();
    log_recycle_files.pop_front();
  }
S
Stanislau Hlebik 已提交
5078 5079 5080
  uint64_t new_log_number =
      creating_new_log ? versions_->NewFileNumber() : logfile_number_;
  SuperVersion* new_superversion = nullptr;
5081
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
5082 5083 5084 5085 5086 5087 5088 5089 5090 5091

  // 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
5092 5093 5094
  // 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();
5095 5096
  DBOptions db_options =
      BuildDBOptions(immutable_db_options_, mutable_db_options_);
S
Stanislau Hlebik 已提交
5097 5098 5099 5100
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
5101
      EnvOptions opt_env_opt =
5102
          env_->OptimizeForLogWrite(env_options_, db_options);
S
Sage Weil 已提交
5103
      if (recycle_log_number) {
5104
        Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
S
Sage Weil 已提交
5105 5106
            "reusing log %" PRIu64 " from recycle list\n", recycle_log_number);
        s = env_->ReuseWritableFile(
5107 5108 5109
            LogFileName(immutable_db_options_.wal_dir, new_log_number),
            LogFileName(immutable_db_options_.wal_dir, recycle_log_number),
            &lfile, opt_env_opt);
S
Sage Weil 已提交
5110
      } else {
5111 5112 5113
        s = NewWritableFile(
            env_, LogFileName(immutable_db_options_.wal_dir, new_log_number),
            &lfile, opt_env_opt);
S
Sage Weil 已提交
5114
      }
S
Stanislau Hlebik 已提交
5115 5116 5117
      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 已提交
5118
        lfile->SetPreallocationBlockSize(
5119
            GetWalPreallocateBlockSize(mutable_cf_options.write_buffer_size));
5120 5121
        unique_ptr<WritableFileWriter> file_writer(
            new WritableFileWriter(std::move(lfile), opt_env_opt));
5122 5123 5124
        new_log =
            new log::Writer(std::move(file_writer), new_log_number,
                            immutable_db_options_.recycle_log_file_num > 0);
I
Igor Canadi 已提交
5125
      }
S
Stanislau Hlebik 已提交
5126 5127 5128
    }

    if (s.ok()) {
A
agiardullo 已提交
5129 5130
      SequenceNumber seq = versions_->LastSequence();
      new_mem = cfd->ConstructNewMemtable(mutable_cf_options, seq);
S
Stanislau Hlebik 已提交
5131 5132
      new_superversion = new SuperVersion();
    }
5133 5134 5135 5136 5137 5138 5139

#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 已提交
5140
  }
5141
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
5142 5143
      "[%s] New memtable created with log file: #%" PRIu64
      ". Immutable memtables: %d.\n",
5144
      cfd->GetName().c_str(), new_log_number, num_imm_unflushed);
S
Stanislau Hlebik 已提交
5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156
  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;
5157
    log_dir_synced_ = false;
5158
    logs_.emplace_back(logfile_number_, new_log);
S
Stanislau Hlebik 已提交
5159
    alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
I
Igor Canadi 已提交
5160
    for (auto loop_cfd : *versions_->GetColumnFamilySet()) {
S
Stanislau Hlebik 已提交
5161 5162 5163 5164
      // 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 已提交
5165
      if (loop_cfd->mem()->GetFirstSequenceNumber() == 0 &&
5166
          loop_cfd->imm()->NumNotFlushed() == 0) {
I
Igor Canadi 已提交
5167
        loop_cfd->SetLogNumber(logfile_number_);
5168
      }
5169 5170
    }
  }
S
Stanislau Hlebik 已提交
5171
  cfd->mem()->SetNextLogNumber(logfile_number_);
5172
  cfd->imm()->Add(cfd->mem(), &context->memtables_to_free_);
S
Stanislau Hlebik 已提交
5173 5174
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
I
Igor Canadi 已提交
5175 5176
  context->superversions_to_free_.push_back(InstallSuperVersionAndScheduleWork(
      cfd, new_superversion, mutable_cf_options));
5177 5178 5179
  return s;
}

I
Igor Canadi 已提交
5180
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
5181 5182 5183 5184 5185
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

5186 5187
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
5188
  auto version = cfd->current();
5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
5201 5202

Status DBImpl::GetPropertiesOfTablesInRange(ColumnFamilyHandle* column_family,
5203
                                            const Range* range, std::size_t n,
5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223
                                            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 已提交
5224
#endif  // ROCKSDB_LITE
5225

I
Igor Canadi 已提交
5226 5227 5228 5229
const std::string& DBImpl::GetName() const {
  return dbname_;
}

5230 5231 5232 5233
Env* DBImpl::GetEnv() const {
  return env_;
}

5234 5235
Options DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  InstrumentedMutexLock l(&mutex_);
5236
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
5237 5238
  return Options(BuildDBOptions(immutable_db_options_, mutable_db_options_),
                 cfh->cfd()->GetLatestCFOptions());
I
Igor Canadi 已提交
5239 5240
}

5241 5242 5243 5244
DBOptions DBImpl::GetDBOptions() const {
  InstrumentedMutexLock l(&mutex_);
  return BuildDBOptions(immutable_db_options_, mutable_db_options_);
}
5245

5246
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
5247
                         const Slice& property, std::string* value) {
5248
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
5249
  value->clear();
5250
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5251 5252 5253
  if (property_info == nullptr) {
    return false;
  } else if (property_info->handle_int) {
5254
    uint64_t int_value;
5255 5256
    bool ret_value =
        GetIntPropertyInternal(cfd, *property_info, false, &int_value);
5257
    if (ret_value) {
5258
      *value = ToString(int_value);
5259 5260
    }
    return ret_value;
5261
  } else if (property_info->handle_string) {
5262
    InstrumentedMutexLock l(&mutex_);
5263
    return cfd->internal_stats()->GetStringProperty(*property_info, property,
5264 5265
                                                    value);
  }
5266 5267 5268 5269
  // 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 已提交
5270 5271
}

5272 5273
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
5274 5275
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5276 5277
    return false;
  }
5278
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5279
  return GetIntPropertyInternal(cfd, *property_info, false, value);
5280 5281
}

5282
bool DBImpl::GetIntPropertyInternal(ColumnFamilyData* cfd,
5283 5284 5285 5286
                                    const DBPropertyInfo& property_info,
                                    bool is_locked, uint64_t* value) {
  assert(property_info.handle_int != nullptr);
  if (!property_info.need_out_of_mutex) {
5287 5288
    if (is_locked) {
      mutex_.AssertHeld();
5289
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5290 5291
    } else {
      InstrumentedMutexLock l(&mutex_);
5292
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5293
    }
5294
  } else {
5295 5296 5297 5298 5299 5300
    SuperVersion* sv = nullptr;
    if (!is_locked) {
      sv = GetAndRefSuperVersion(cfd);
    } else {
      sv = cfd->GetSuperVersion();
    }
5301 5302

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

5305 5306 5307
    if (!is_locked) {
      ReturnAndCleanupSuperVersion(cfd, sv);
    }
5308 5309 5310 5311 5312

    return ret;
  }
}

5313 5314
bool DBImpl::GetAggregatedIntProperty(const Slice& property,
                                      uint64_t* aggregated_value) {
5315 5316
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5317 5318 5319 5320 5321 5322 5323 5324 5325
    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()) {
5326
      if (GetIntPropertyInternal(cfd, *property_info, true, &value)) {
5327 5328 5329 5330 5331 5332 5333 5334 5335 5336
        sum += value;
      } else {
        return false;
      }
    }
  }
  *aggregated_value = sum;
  return true;
}

5337 5338
SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
I
Igor Canadi 已提交
5339
  return cfd->GetThreadLocalSuperVersion(&mutex_);
5340 5341
}

A
agiardullo 已提交
5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353
// 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 已提交
5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369
// 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);
}

5370 5371
void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
5372
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
5373 5374 5375 5376 5377

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
5378
        InstrumentedMutexLock l(&mutex_);
5379 5380 5381 5382 5383 5384 5385
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
5386 5387
}

A
agiardullo 已提交
5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399
// 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 已提交
5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415
// 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 已提交
5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427
// 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 已提交
5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441
// 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();
}

5442
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
5443 5444
                                 const Range* range, int n, uint64_t* sizes,
                                 bool include_memtable) {
J
jorlow@chromium.org 已提交
5445
  Version* v;
5446 5447
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
5448 5449
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
  v = sv->current;
J
jorlow@chromium.org 已提交
5450 5451 5452

  for (int i = 0; i < n; i++) {
    // Convert user_key into a corresponding internal key.
5453 5454 5455
    InternalKey k1(range[i].start, kMaxSequenceNumber, kValueTypeForSeek);
    InternalKey k2(range[i].limit, kMaxSequenceNumber, kValueTypeForSeek);
    sizes[i] = versions_->ApproximateSize(v, k1.Encode(), k2.Encode());
5456 5457 5458 5459
    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 已提交
5460 5461
  }

5462
  ReturnAndCleanupSuperVersion(cfd, sv);
J
jorlow@chromium.org 已提交
5463 5464
}

I
Igor Canadi 已提交
5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480
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 已提交
5481 5482 5483 5484 5485
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
5486
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
5487 5488 5489
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
I
Igor Canadi 已提交
5490
  return wal_manager_.GetUpdatesSince(seq, iter, read_options, versions_.get());
I
Igor Canadi 已提交
5491 5492
}

5493 5494 5495
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
5496 5497 5498
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
5499
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
5500
        "DeleteFile %s failed.\n", name.c_str());
5501 5502 5503
    return Status::InvalidArgument("Invalid file name");
  }

5504 5505 5506 5507
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
5508 5509
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
          "DeleteFile %s failed - not archived log.\n", name.c_str());
5510 5511
      return Status::NotSupported("Delete only supported for archived logs");
    }
5512 5513
    status =
        env_->DeleteFile(immutable_db_options_.wal_dir + "/" + name.c_str());
5514
    if (!status.ok()) {
5515 5516 5517
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
          "DeleteFile %s failed -- %s.\n", name.c_str(),
          status.ToString().c_str());
5518 5519 5520 5521
    }
    return status;
  }

5522
  int level;
I
Igor Canadi 已提交
5523
  FileMetaData* metadata;
5524
  ColumnFamilyData* cfd;
5525
  VersionEdit edit;
5526
  JobContext job_context(next_job_id_.fetch_add(1), true);
D
Dhruba Borthakur 已提交
5527
  {
5528
    InstrumentedMutexLock l(&mutex_);
5529
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
5530
    if (!status.ok()) {
5531
      Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5532
          "DeleteFile %s failed. File not found\n", name.c_str());
I
Igor Canadi 已提交
5533
      job_context.Clean();
D
Dhruba Borthakur 已提交
5534 5535
      return Status::InvalidArgument("File not found");
    }
5536
    assert(level < cfd->NumberLevels());
5537

D
Dhruba Borthakur 已提交
5538
    // If the file is being compacted no need to delete.
5539
    if (metadata->being_compacted) {
5540
      Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
5541
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
I
Igor Canadi 已提交
5542
      job_context.Clean();
D
Dhruba Borthakur 已提交
5543
      return Status::OK();
5544 5545
    }

D
Dhruba Borthakur 已提交
5546 5547 5548
    // 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 已提交
5549
    auto* vstoreage = cfd->current()->storage_info();
I
Igor Canadi 已提交
5550
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
S
sdong 已提交
5551
      if (vstoreage->NumLevelFiles(i) != 0) {
5552
        Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5553
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
I
Igor Canadi 已提交
5554
        job_context.Clean();
D
Dhruba Borthakur 已提交
5555 5556 5557
        return Status::InvalidArgument("File not in last level");
      }
    }
5558
    // if level == 0, it has to be the oldest file
S
sdong 已提交
5559 5560
    if (level == 0 &&
        vstoreage->LevelFiles(0).back()->fd.GetNumber() != number) {
5561
      Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5562
          "DeleteFile %s failed ---"
5563 5564
          " target file in level 0 must be the oldest.",
          name.c_str());
I
Igor Canadi 已提交
5565
      job_context.Clean();
5566 5567 5568
      return Status::InvalidArgument("File in level 0, but not oldest");
    }
    edit.SetColumnFamily(cfd->GetID());
D
Dhruba Borthakur 已提交
5569
    edit.DeleteFile(level, number);
5570
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
5571
                                    &edit, &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
5572
    if (status.ok()) {
I
Igor Canadi 已提交
5573 5574
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
5575
    }
I
Igor Canadi 已提交
5576 5577
    FindObsoleteFiles(&job_context, false);
  }  // lock released here
5578

5579
  LogFlush(immutable_db_options_.info_log);
5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594
  // 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;
5595
  std::vector<FileMetaData*> deleted_files;
5596 5597 5598
  JobContext job_context(next_job_id_.fetch_add(1), true);
  {
    InstrumentedMutexLock l(&mutex_);
5599
    Version* input_version = cfd->current();
5600

5601 5602
    auto* vstorage = input_version->storage_info();
    for (int i = 1; i < cfd->NumberLevels(); i++) {
5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623
      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);
5624 5625 5626
      FileMetaData* level_file;
      for (uint32_t j = 0; j < level_files.size(); j++) {
        level_file = level_files[j];
5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637
        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());
5638 5639
          deleted_files.push_back(level_file);
          level_file->being_compacted = true;
5640 5641 5642 5643
        }
      }
    }
    if (edit.GetDeletedFiles().empty()) {
5644
      job_context.Clean();
5645 5646
      return Status::OK();
    }
5647
    input_version->Ref();
5648 5649 5650 5651 5652 5653
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                    &edit, &mutex_, directories_.GetDbDir());
    if (status.ok()) {
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
    }
5654 5655 5656 5657
    for (auto* deleted_file : deleted_files) {
      deleted_file->being_compacted = false;
    }
    input_version->Unref();
5658 5659 5660
    FindObsoleteFiles(&job_context, false);
  }  // lock released here

5661
  LogFlush(immutable_db_options_.info_log);
I
Igor Canadi 已提交
5662
  // remove files outside the db-lock
I
Igor Canadi 已提交
5663
  if (job_context.HaveSomethingToDelete()) {
5664
    // Call PurgeObsoleteFiles() without holding mutex.
I
Igor Canadi 已提交
5665
    PurgeObsoleteFiles(job_context);
5666
  }
I
Igor Canadi 已提交
5667
  job_context.Clean();
5668 5669 5670
  return status;
}

5671
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
5672
  InstrumentedMutexLock l(&mutex_);
5673
  versions_->GetLiveFilesMetaData(metadata);
5674
}
5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685

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 已提交
5686
#endif  // ROCKSDB_LITE
5687

I
Igor Canadi 已提交
5688 5689 5690 5691 5692 5693 5694
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
5698 5699
    uint64_t fsize = 0;
    Status s = env_->GetFileSize(file_path, &fsize);
D
dyniusz 已提交
5700 5701 5702 5703
    if (!s.ok() &&
        env_->GetFileSize(Rocks2LevelTableFileName(file_path), &fsize).ok()) {
      s = Status::OK();
    }
I
Igor Canadi 已提交
5704 5705 5706 5707
    if (!s.ok()) {
      corruption_messages +=
          "Can't access " + md.name + ": " + s.ToString() + "\n";
    } else if (fsize != md.size) {
5708
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
5709
                             ". Size recorded in manifest " +
5710 5711
                             ToString(md.size) + ", actual size " +
                             ToString(fsize) + "\n";
I
Igor Canadi 已提交
5712 5713 5714 5715 5716 5717 5718 5719 5720
    }
  }
  if (corruption_messages.size() == 0) {
    return Status::OK();
  } else {
    return Status::Corruption(corruption_messages);
  }
}

5721
Status DBImpl::GetDbIdentity(std::string& identity) const {
5722 5723
  std::string idfilename = IdentityFileName(dbname_);
  const EnvOptions soptions;
5724 5725 5726 5727 5728 5729 5730 5731 5732
  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)));
5733
  }
5734

5735 5736 5737 5738 5739
  uint64_t file_size;
  s = env_->GetFileSize(idfilename, &file_size);
  if (!s.ok()) {
    return s;
  }
D
Dmitri Smirnov 已提交
5740
  char* buffer = reinterpret_cast<char*>(alloca(file_size));
5741
  Slice id;
5742
  s = id_file_reader->Read(static_cast<size_t>(file_size), &id, buffer);
5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753
  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 已提交
5754 5755
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
5756
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
5757
               const Slice& key, const Slice& value) {
5758 5759 5760 5761
  // 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);
5762
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
5763 5764 5765
  return Write(opt, &batch);
}

5766 5767
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
5768
  WriteBatch batch;
5769
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
5770 5771 5772
  return Write(opt, &batch);
}

A
Andres Noetzli 已提交
5773 5774 5775 5776 5777 5778 5779
Status DB::SingleDelete(const WriteOptions& opt,
                        ColumnFamilyHandle* column_family, const Slice& key) {
  WriteBatch batch;
  batch.SingleDelete(column_family, key);
  return Write(opt, &batch);
}

5780 5781
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
5782
  WriteBatch batch;
5783
  batch.Merge(column_family, key, value);
5784 5785 5786
  return Write(opt, &batch);
}

5787
// Default implementation -- returns not supported status
L
Lei Jin 已提交
5788
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
5789
                              const std::string& column_family_name,
5790
                              ColumnFamilyHandle** handle) {
5791
  return Status::NotSupported("");
5792
}
5793
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
5794
  return Status::NotSupported("");
5795
}
5796 5797 5798 5799
Status DB::DestroyColumnFamilyHandle(ColumnFamilyHandle* column_family) {
  delete column_family;
  return Status::OK();
}
5800

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

J
Jim Paton 已提交
5803
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
5804 5805 5806 5807
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
5808
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
5809
  std::vector<ColumnFamilyHandle*> handles;
5810
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
5811 5812 5813 5814 5815 5816 5817
  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;
5818 5819
}

5820 5821
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
5822
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
5823
  Status s = SanitizeOptionsByTable(db_options, column_families);
5824 5825 5826
  if (!s.ok()) {
    return s;
  }
5827

5828 5829 5830
  s = ValidateOptions(db_options, column_families);
  if (!s.ok()) {
    return s;
5831 5832
  }

5833
  *dbptr = nullptr;
5834
  handles->clear();
J
jorlow@chromium.org 已提交
5835

I
Igor Canadi 已提交
5836 5837 5838 5839
  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);
5840
  }
5841

I
Igor Canadi 已提交
5842
  DBImpl* impl = new DBImpl(db_options, dbname);
5843
  s = impl->env_->CreateDirIfMissing(impl->immutable_db_options_.wal_dir);
5844
  if (s.ok()) {
5845
    for (auto db_path : impl->immutable_db_options_.db_paths) {
5846
      s = impl->env_->CreateDirIfMissing(db_path.path);
5847 5848 5849 5850 5851 5852
      if (!s.ok()) {
        break;
      }
    }
  }

5853 5854 5855 5856 5857 5858
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
5859 5860 5861 5862
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
5863
  impl->mutex_.Lock();
5864 5865
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
5866
  if (s.ok()) {
5867
    uint64_t new_log_number = impl->versions_->NewFileNumber();
5868
    unique_ptr<WritableFile> lfile;
5869
    EnvOptions soptions(db_options);
5870
    EnvOptions opt_env_options =
5871 5872 5873 5874 5875 5876 5877
        impl->immutable_db_options_.env->OptimizeForLogWrite(
            soptions, BuildDBOptions(impl->immutable_db_options_,
                                     impl->mutable_db_options_));
    s = NewWritableFile(
        impl->immutable_db_options_.env,
        LogFileName(impl->immutable_db_options_.wal_dir, new_log_number),
        &lfile, opt_env_options);
J
jorlow@chromium.org 已提交
5878
    if (s.ok()) {
5879 5880
      lfile->SetPreallocationBlockSize(
          impl->GetWalPreallocateBlockSize(max_write_buffer_size));
5881
      impl->logfile_number_ = new_log_number;
5882 5883
      unique_ptr<WritableFileWriter> file_writer(
          new WritableFileWriter(std::move(lfile), opt_env_options));
5884 5885
      impl->logs_.emplace_back(
          new_log_number,
5886 5887 5888
          new log::Writer(
              std::move(file_writer), new_log_number,
              impl->immutable_db_options_.recycle_log_file_num > 0));
I
Igor Canadi 已提交
5889

5890 5891
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
5892 5893
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
5894 5895 5896
        if (cfd != nullptr) {
          handles->push_back(
              new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
5897
          impl->NewThreadStatusCfInfo(cfd);
I
Igor Canadi 已提交
5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913
        } 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 已提交
5914
        }
5915
      }
I
Igor Canadi 已提交
5916 5917
    }
    if (s.ok()) {
5918
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
5919
        delete impl->InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
5920
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
5921
      }
I
Igor Canadi 已提交
5922 5923
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
5924
      impl->DeleteObsoleteFiles();
5925
      s = impl->directories_.GetDbDir()->Fsync();
J
jorlow@chromium.org 已提交
5926 5927
    }
  }
5928

I
Igor Canadi 已提交
5929 5930
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
S
sdong 已提交
5931
      if (cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
S
sdong 已提交
5932
        auto* vstorage = cfd->current()->storage_info();
5933
        for (int i = 1; i < vstorage->num_levels(); ++i) {
S
sdong 已提交
5934
          int num_files = vstorage->NumLevelFiles(i);
I
Igor Canadi 已提交
5935
          if (num_files > 0) {
I
Igor Canadi 已提交
5936 5937
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
S
sdong 已提交
5938
                "open with FIFO compaction style.");
I
Igor Canadi 已提交
5939 5940 5941 5942
            break;
          }
        }
      }
S
sdong 已提交
5943 5944 5945
      if (!cfd->mem()->IsSnapshotSupported()) {
        impl->is_snapshot_supported_ = false;
      }
5946
      if (cfd->ioptions()->merge_operator != nullptr &&
5947 5948 5949 5950 5951
          !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 已提交
5952
      if (!s.ok()) {
5953 5954 5955 5956
        break;
      }
    }
  }
5957
  TEST_SYNC_POINT("DBImpl::Open:Opened");
5958
  Status persist_options_status;
5959
  if (s.ok()) {
5960 5961 5962 5963
    // Persist RocksDB Options before scheduling the compaction.
    // The WriteOptionsFile() will release and lock the mutex internally.
    persist_options_status = impl->WriteOptionsFile();

5964
    *dbptr = impl;
5965 5966 5967
    impl->opened_successfully_ = true;
    impl->MaybeScheduleFlushOrCompaction();
  }
5968 5969
  impl->mutex_.Unlock();

5970
  auto sfm = static_cast<SstFileManagerImpl*>(
5971
      impl->immutable_db_options_.sst_file_manager.get());
5972 5973 5974
  if (s.ok() && sfm) {
    // Notify SstFileManager about all sst files that already exist in
    // db_paths[0] when the DB is opened.
5975
    auto& db_path = impl->immutable_db_options_.db_paths[0];
5976
    std::vector<std::string> existing_files;
5977
    impl->immutable_db_options_.env->GetChildren(db_path.path, &existing_files);
5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988
    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 已提交
5989
  if (s.ok()) {
5990 5991 5992
    Log(InfoLogLevel::INFO_LEVEL, impl->immutable_db_options_.info_log,
        "DB pointer %p", impl);
    LogFlush(impl->immutable_db_options_.info_log);
5993 5994 5995 5996 5997 5998
    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());
      }
5999
      Warn(impl->immutable_db_options_.info_log,
6000 6001 6002 6003
           "Unable to persist options in DB::Open() -- %s",
           persist_options_status.ToString().c_str());
    }
  }
6004
  if (!s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
6005
    for (auto* h : *handles) {
6006 6007
      delete h;
    }
6008
    handles->clear();
J
jorlow@chromium.org 已提交
6009
    delete impl;
6010
    *dbptr = nullptr;
J
jorlow@chromium.org 已提交
6011 6012 6013 6014
  }
  return s;
}

6015 6016 6017
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
6018
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
6019 6020
}

6021 6022 6023
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
6024
Status DestroyDB(const std::string& dbname, const Options& options) {
6025
  const ImmutableDBOptions soptions(SanitizeOptions(dbname, options));
6026
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
6027
  std::vector<std::string> filenames;
6028

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

J
jorlow@chromium.org 已提交
6032
  FileLock* lock;
6033 6034
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
6035 6036 6037
  if (result.ok()) {
    uint64_t number;
    FileType type;
6038
    InfoLogPrefix info_log_prefix(!soptions.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
6039
    for (size_t i = 0; i < filenames.size(); i++) {
6040
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
6041
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
6042
        Status del;
6043
        std::string path_to_delete = dbname + "/" + filenames[i];
K
Kosie van der Merwe 已提交
6044
        if (type == kMetaDatabase) {
6045 6046
          del = DestroyDB(path_to_delete, options);
        } else if (type == kTableFile) {
6047
          del = DeleteSSTFile(&soptions, path_to_delete, 0);
K
Kosie van der Merwe 已提交
6048
        } else {
6049
          del = env->DeleteFile(path_to_delete);
K
Kosie van der Merwe 已提交
6050
        }
J
jorlow@chromium.org 已提交
6051 6052 6053 6054 6055
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
6056

6057 6058
    for (size_t path_id = 0; path_id < options.db_paths.size(); path_id++) {
      const auto& db_path = options.db_paths[path_id];
6059
      env->GetChildren(db_path.path, &filenames);
6060 6061 6062
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
6063
          std::string table_path = db_path.path + "/" + filenames[i];
6064
          Status del = DeleteSSTFile(&soptions, table_path,
6065
                                     static_cast<uint32_t>(path_id));
6066 6067 6068 6069 6070 6071 6072
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

I
Igor Canadi 已提交
6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090
    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;
6091
    env->GetChildren(archivedir, &archiveFiles);
6092 6093
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
6094 6095
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
6096
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
6097 6098 6099 6100 6101
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
6102

6103
    // ignore case where no archival directory is present.
6104
    env->DeleteDir(archivedir);
6105

J
jorlow@chromium.org 已提交
6106
    env->UnlockFile(lock);  // Ignore error since state is already gone
6107
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
6108
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
6109
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
6110 6111 6112 6113
  }
  return result;
}

6114 6115
Status DBImpl::WriteOptionsFile() {
#ifndef ROCKSDB_LITE
6116
  mutex_.AssertHeld();
6117 6118 6119

  std::vector<std::string> cf_names;
  std::vector<ColumnFamilyOptions> cf_opts;
6120 6121 6122 6123 6124

  // This part requires mutex to protect the column family options
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
6125
    }
6126
    cf_names.push_back(cfd->GetName());
6127
    cf_opts.push_back(cfd->GetLatestCFOptions());
6128 6129
  }

6130 6131
  // Unlock during expensive operations.  New writes cannot get here
  // because the single write thread ensures all new writes get queued.
6132 6133
  DBOptions db_options =
      BuildDBOptions(immutable_db_options_, mutable_db_options_);
6134 6135 6136 6137
  mutex_.Unlock();

  std::string file_name =
      TempOptionsFileName(GetName(), versions_->NewFileNumber());
6138 6139
  Status s =
      PersistRocksDBOptions(db_options, cf_names, cf_opts, file_name, GetEnv());
6140 6141 6142 6143 6144

  if (s.ok()) {
    s = RenameTempFileToOptionsFile(file_name);
  }
  mutex_.Lock();
6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193
  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,
6194
                           immutable_db_options_.info_log, GetEnv());
6195 6196 6197 6198 6199 6200 6201 6202 6203
  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 已提交
6204 6205

  versions_->options_file_number_ = versions_->NewFileNumber();
6206
  std::string options_file_name =
W
Wanning Jiang 已提交
6207
      OptionsFileName(GetName(), versions_->options_file_number_);
6208 6209 6210 6211 6212 6213 6214 6215 6216 6217
  // 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 已提交
6218
#if ROCKSDB_USING_THREAD_STATUS
6219

Y
Yueh-Hsuan Chiang 已提交
6220 6221
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6222
  if (immutable_db_options_.enable_thread_tracking) {
6223 6224
    ThreadStatusUtil::NewColumnFamilyInfo(this, cfd, cfd->GetName(),
                                          cfd->ioptions()->env);
6225
  }
Y
Yueh-Hsuan Chiang 已提交
6226 6227 6228 6229
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6230
  if (immutable_db_options_.enable_thread_tracking) {
6231
    ThreadStatusUtil::EraseColumnFamilyInfo(cfd);
6232
  }
Y
Yueh-Hsuan Chiang 已提交
6233 6234 6235
}

void DBImpl::EraseThreadStatusDbInfo() const {
6236
  if (immutable_db_options_.enable_thread_tracking) {
6237
    ThreadStatusUtil::EraseDatabaseInfo(this);
6238
  }
Y
Yueh-Hsuan Chiang 已提交
6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253
}

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

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

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

6254 6255
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
6256
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
6257
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
6258 6259
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
6260 6261 6262 6263
  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 已提交
6264
#endif
6265 6266
}

A
agiardullo 已提交
6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283
#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
6284 6285 6286
Status DBImpl::GetLatestSequenceForKey(SuperVersion* sv, const Slice& key,
                                       bool cache_only, SequenceNumber* seq,
                                       bool* found_record_for_key) {
A
agiardullo 已提交
6287 6288 6289 6290 6291 6292 6293
  Status s;
  MergeContext merge_context;

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

  *seq = kMaxSequenceNumber;
6294 6295
  *found_record_for_key = false;

A
agiardullo 已提交
6296
  // Check if there is a record for this key in the latest memtable
R
Reid Horuff 已提交
6297
  sv->mem->Get(lkey, nullptr, &s, &merge_context, seq);
A
agiardullo 已提交
6298 6299 6300

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6301
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
A
agiardullo 已提交
6302 6303 6304 6305 6306 6307 6308 6309
        "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
6310
    *found_record_for_key = true;
A
agiardullo 已提交
6311 6312 6313 6314
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
R
Reid Horuff 已提交
6315
  sv->imm->Get(lkey, nullptr, &s, &merge_context, seq);
A
agiardullo 已提交
6316 6317 6318

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6319
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
A
agiardullo 已提交
6320 6321 6322 6323 6324 6325 6326 6327
        "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
6328
    *found_record_for_key = true;
A
agiardullo 已提交
6329 6330 6331 6332
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
R
Reid Horuff 已提交
6333
  sv->imm->GetFromHistory(lkey, nullptr, &s, &merge_context, seq);
A
agiardullo 已提交
6334 6335 6336

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6337
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
A
agiardullo 已提交
6338 6339 6340 6341 6342 6343
        "Unexpected status returned from MemTableList::GetFromHistory: %s\n",
        s.ToString().c_str());

    return s;
  }

6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355
  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 已提交
6356
    sv->current->Get(read_options, lkey, nullptr, &s, &merge_context,
6357 6358 6359 6360
                     nullptr /* value_found */, found_record_for_key, seq);

    if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
      // unexpected error reading SST files
6361
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
6362 6363 6364 6365 6366 6367 6368
          "Unexpected status returned from Version::Get: %s\n",
          s.ToString().c_str());

      return s;
    }
  }

A
agiardullo 已提交
6369 6370
  return Status::OK();
}
6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463

Status DBImpl::IngestExternalFile(
    ColumnFamilyHandle* column_family,
    const std::vector<std::string>& external_files,
    const IngestExternalFileOptions& ingestion_options) {
  Status status;
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

  ExternalSstFileIngestionJob ingestion_job(env_, versions_.get(), cfd,
                                            immutable_db_options_, env_options_,
                                            &snapshots_, ingestion_options);

  // Make sure that bg cleanup wont delete the files that we are ingesting
  std::list<uint64_t>::iterator pending_output_elem;
  {
    InstrumentedMutexLock l(&mutex_);
    pending_output_elem = CaptureCurrentFileNumberInPendingOutputs();
  }

  status = ingestion_job.Prepare(external_files);
  if (!status.ok()) {
    return status;
  }

  {
    // Lock db mutex
    InstrumentedMutexLock l(&mutex_);
    TEST_SYNC_POINT("DBImpl::AddFile:MutexLock");
    num_running_ingest_file_++;

    // Stop writes to the DB
    WriteThread::Writer w;
    write_thread_.EnterUnbatched(&w, &mutex_);

    // Figure out if we need to flush the memtable first
    bool need_flush = false;
    status = ingestion_job.NeedsFlush(&need_flush);
    if (status.ok() && need_flush) {
      mutex_.Unlock();
      status = FlushMemTable(cfd, FlushOptions(), true /* writes_stopped */);
      mutex_.Lock();
    }

    // Run the ingestion job
    if (status.ok()) {
      status = ingestion_job.Run();
    }

    // Install job edit [Mutex will be unlocked here]
    auto mutable_cf_options = cfd->GetLatestMutableCFOptions();
    if (status.ok()) {
      status =
          versions_->LogAndApply(cfd, *mutable_cf_options, ingestion_job.edit(),
                                 &mutex_, directories_.GetDbDir());
    }
    if (status.ok()) {
      delete InstallSuperVersionAndScheduleWork(cfd, nullptr,
                                                *mutable_cf_options);
    }

    // Resume writes to the DB
    write_thread_.ExitUnbatched(&w);

    // Update stats
    if (status.ok()) {
      ingestion_job.UpdateStats();
    }

    ReleaseFileNumberFromPendingOutputs(pending_output_elem);

    num_running_ingest_file_--;
    if (num_running_ingest_file_ == 0) {
      bg_cv_.SignalAll();
    }

    TEST_SYNC_POINT("DBImpl::AddFile:MutexUnlock");
  }
  // mutex_ is unlocked here

  // Cleanup
  ingestion_job.Cleanup(status);

  return status;
}

void DBImpl::WaitForIngestFile() {
  mutex_.AssertHeld();
  while (num_running_ingest_file_ > 0) {
    bg_cv_.Wait();
  }
}

A
agiardullo 已提交
6464 6465
#endif  // ROCKSDB_LITE

6466
}  // namespace rocksdb