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 273 274 275
  // Compressing memtable flushes might not help unless the sequential load
  // optimization is used for leveled compaction. Otherwise the CPU and
  // latency overhead is not offset by saving much space.

  bool can_compress;

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

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

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

305
}  // namespace
306

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

J
jorlow@chromium.org 已提交
360
  // Reserve ten files or so for other uses and give the rest to TableCache.
361
  // Give a large number for setting of "infinite" open files.
362 363 364 365 366
  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);
367

368
  versions_.reset(new VersionSet(dbname_, &immutable_db_options_, env_options_,
369
                                 table_cache_.get(), write_buffer_manager_,
370
                                 &write_controller_));
371 372
  column_family_memtables_.reset(
      new ColumnFamilyMemTablesImpl(versions_->GetColumnFamilySet()));
373

374 375 376 377 378
  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 已提交
379 380
}

381
// Will lock the mutex_,  will wait for completion if wait is true
382
void DBImpl::CancelAllBackgroundWork(bool wait) {
383
  InstrumentedMutexLock l(&mutex_);
384

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

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

430 431 432 433 434 435 436 437 438 439 440 441 442
  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 已提交
443 444 445 446 447
  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();
448 449
  }

I
Igor Canadi 已提交
450 451 452 453 454 455 456 457 458 459
  // 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_) {
460
    JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
461
    FindObsoleteFiles(&job_context, true);
462 463

    mutex_.Unlock();
I
Igor Canadi 已提交
464
    // manifest number starting from 2
I
Igor Canadi 已提交
465 466 467
    job_context.manifest_file_number = 1;
    if (job_context.HaveSomethingToDelete()) {
      PurgeObsoleteFiles(job_context);
468
    }
I
Igor Canadi 已提交
469
    job_context.Clean();
470
    mutex_.Lock();
471 472
  }

473 474 475
  for (auto l : logs_to_free_) {
    delete l;
  }
476 477 478
  for (auto& log : logs_) {
    log.ClearWriter();
  }
479
  logs_.clear();
480

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

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

508
  LogFlush(immutable_db_options_.info_log);
J
jorlow@chromium.org 已提交
509 510 511
}

Status DBImpl::NewDB() {
512
  VersionEdit new_db;
513
  new_db.SetLogNumber(0);
J
jorlow@chromium.org 已提交
514 515 516
  new_db.SetNextFile(2);
  new_db.SetLastSequence(0);

517 518
  Status s;

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

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

560
const Status DBImpl::CreateArchivalDirectory() {
561 562 563
  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);
564 565 566 567 568
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

569
void DBImpl::PrintStatistics() {
570
  auto dbstats = immutable_db_options_.statistics.get();
571
  if (dbstats) {
572 573
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
        "STATISTICS:\n %s", dbstats->ToString().c_str());
574 575 576
  }
}

577
#ifndef ROCKSDB_LITE
578 579 580 581 582 583 584 585 586 587 588 589 590 591
#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;
  }

592
  snprintf(mstat->cur, buf_size, "%s", status);
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
  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
}
608
#endif  // !ROCKSDB_LITE
609

610
void DBImpl::MaybeDumpStats() {
611
  if (immutable_db_options_.stats_dump_period_sec == 0) return;
H
Haobo Xu 已提交
612 613 614 615

  const uint64_t now_micros = env_->NowMicros();

  if (last_stats_dump_time_microsec_ +
616 617
          immutable_db_options_.stats_dump_period_sec * 1000000 <=
      now_micros) {
H
Haobo Xu 已提交
618 619 620 621 622
    // 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;
623

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

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

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

751
  // if deletion is disabled, do nothing
752
  if (disable_delete_obsolete_files_ > 0) {
753 754 755
    return;
  }

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

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

786 787
  // Get obsolete files.  This function will also update the list of
  // pending files in VersionSet().
I
Igor Canadi 已提交
788
  versions_->GetObsoleteFiles(&job_context->sst_delete_files,
789
                              &job_context->manifest_delete_files,
I
Igor Canadi 已提交
790
                              job_context->min_pending_output);
I
Igor Canadi 已提交
791

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

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

823
  job_context->prev_log_number = versions_->prev_log_number();
I
Igor Canadi 已提交
824

I
Igor Canadi 已提交
825
  versions_->AddLiveFiles(&job_context->sst_live);
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 856 857 858 859 860
  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);
      }
    }
  }
861

862 863 864
  // 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()) {
865
    uint64_t min_log_number = job_context->log_number;
S
sdong 已提交
866
    size_t num_alive_log_files = alive_log_files_.size();
867 868 869
    // find newly obsoleted log files
    while (alive_log_files_.begin()->number < min_log_number) {
      auto& earliest = *alive_log_files_.begin();
870 871 872
      if (immutable_db_options_.recycle_log_file_num >
          log_recycle_files.size()) {
        Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
S
Sage Weil 已提交
873 874 875 876 877
            "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 已提交
878 879 880 881 882
      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;
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
      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 已提交
906 907
  job_context->log_recycle_files.assign(log_recycle_files.begin(),
                                        log_recycle_files.end());
908
  logs_to_free_.clear();
909 910
}

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

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

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

I
Igor Canadi 已提交
964 965 966 967
  // 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 已提交
968 969
    return;
  }
970

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

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

K
kailiu 已提交
993 994
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
995
      candidate_files.emplace_back(LogFileName(kDumbDbName, file_num), 0);
I
Igor Canadi 已提交
996 997
    }
  }
998 999 1000
  for (const auto& filename : state.manifest_delete_files) {
    candidate_files.emplace_back(filename, 0);
  }
1001

K
kailiu 已提交
1002
  // dedup state.candidate_files so we don't try to delete the same
I
Igor Canadi 已提交
1003
  // file twice
1004 1005 1006 1007 1008
  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 已提交
1009

S
sdong 已提交
1010
  if (state.prev_total_log_size > 0) {
1011
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
S
sdong 已提交
1012 1013 1014 1015 1016 1017 1018
        "[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);
  }

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

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

    if (keep) {
      continue;
    }

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

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

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

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

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
1151
  JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
1152
  FindObsoleteFiles(&job_context, true);
1153 1154

  mutex_.Unlock();
I
Igor Canadi 已提交
1155 1156
  if (job_context.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(job_context);
1157
  }
I
Igor Canadi 已提交
1158
  job_context.Clean();
1159
  mutex_.Lock();
1160 1161
}

1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
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 已提交
1178

1179 1180 1181 1182 1183 1184 1185 1186 1187
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_);
1188 1189 1190
    if (!s.ok()) {
      return s;
    }
1191
  }
1192

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

1226 1227 1228
  bool is_new_db = false;
  assert(db_lock_ == nullptr);
  if (!read_only) {
1229 1230 1231
    Status s = directories_.SetDirectories(env_, dbname_,
                                           immutable_db_options_.wal_dir,
                                           immutable_db_options_.db_paths);
1232 1233 1234 1235
    if (!s.ok()) {
      return s;
    }

1236
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
1237 1238 1239
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
1240

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

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

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

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

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

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

L
Lei Jin 已提交
1353 1354
  // Initial value
  max_total_in_memory_state_ = 0;
I
Igor Canadi 已提交
1355
  for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1356 1357 1358
    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 已提交
1359 1360
  }

J
jorlow@chromium.org 已提交
1361 1362 1363
  return s;
}

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

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

1405
#ifndef ROCKSDB_LITE
1406
  if (immutable_db_options_.wal_filter != nullptr) {
1407 1408 1409 1410 1411 1412 1413 1414 1415
    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()));
    }

1416 1417
    immutable_db_options_.wal_filter->ColumnFamilyLogNumberMap(cf_lognumber_map,
                                                               cf_name_id_map);
1418 1419 1420
  }
#endif

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

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

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

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

    // Determine if we should tolerate incomplete records at the tail end of the
S
Stanislau Hlebik 已提交
1486 1487 1488 1489
    // Read all the records and add to a memtable
    std::string scratch;
    Slice record;
    WriteBatch batch;
K
krad 已提交
1490

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

1503
      if (immutable_db_options_.wal_recovery_mode ==
1504
          WALRecoveryMode::kPointInTimeRecovery) {
1505 1506 1507 1508 1509
        // 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) {
1510 1511 1512 1513 1514 1515 1516 1517
          stop_replay_for_corruption = false;
        }
        if (stop_replay_for_corruption) {
          logFileDropped();
          break;
        }
      }

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

1530
#ifndef ROCKSDB_LITE
1531
      if (immutable_db_options_.wal_filter != nullptr) {
1532 1533 1534
        WriteBatch new_batch;
        bool batch_changed = false;

1535
        WalFilter::WalProcessingOption wal_processing_option =
1536 1537
            immutable_db_options_.wal_filter->LogRecordFound(
                log_number, fname, batch, &new_batch, &batch_changed);
1538

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

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

S
Stanislau Hlebik 已提交
1606 1607 1608 1609 1610
      // 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 已提交
1611
      bool has_valid_writes = false;
1612 1613
      status = WriteBatchInternal::InsertInto(
          &batch, column_family_memtables_.get(), &flush_scheduler_, true,
A
Aaron Gao 已提交
1614 1615
          log_number, this, false /* concurrent_memtable_writes */,
          next_sequence, &has_valid_writes);
S
sdong 已提交
1616 1617 1618 1619
      // 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.
1620
      if (immutable_db_options_.allow_2pc) {
1621 1622 1623
        if (no_prev_seq && !has_valid_writes) {
          *next_sequence = kMaxSequenceNumber;
        }
S
sdong 已提交
1624
      }
S
Stanislau Hlebik 已提交
1625 1626
      MaybeIgnoreError(&status);
      if (!status.ok()) {
1627 1628 1629 1630
        // 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 已提交
1631
      }
1632

S
sdong 已提交
1633
      if (has_valid_writes && !read_only) {
I
Igor Canadi 已提交
1634 1635 1636 1637
        // 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;

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

          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
1655
                                 *next_sequence);
1656
        }
J
jorlow@chromium.org 已提交
1657 1658 1659
      }
    }

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

I
Igor Canadi 已提交
1682
    flush_scheduler_.Clear();
1683 1684 1685 1686
    auto last_sequence = *next_sequence - 1;
    if ((*next_sequence != kMaxSequenceNumber) &&
        (versions_->LastSequence() <= last_sequence)) {
      versions_->SetLastSequence(last_sequence);
S
Stanislau Hlebik 已提交
1687
    }
1688 1689
  }

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

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

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

1722 1723 1724
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 *next_sequence);
        }
1725
      }
J
jorlow@chromium.org 已提交
1726

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

1750 1751 1752 1753 1754 1755 1756 1757
  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));
    }
  }

1758 1759 1760
  event_logger_.Log() << "job" << job_id << "event"
                      << "recovery_finished";

J
jorlow@chromium.org 已提交
1761 1762 1763
  return status;
}

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

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

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

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

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

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

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

1880 1881
Status DBImpl::FlushMemTableToOutputFile(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
1882
    bool* made_progress, JobContext* job_context, LogBuffer* log_buffer) {
1883
  mutex_.AssertHeld();
1884
  assert(cfd->imm()->NumNotFlushed() != 0);
1885
  assert(cfd->imm()->IsFlushPending());
1886

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

A
Aaron Gao 已提交
1891
  FlushJob flush_job(
1892
      dbname_, cfd, immutable_db_options_, mutable_cf_options, env_options_,
A
Aaron Gao 已提交
1893 1894 1895 1896 1897
      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);
1898

1899
  FileMetaData file_meta;
1900

1901 1902 1903 1904 1905
  flush_job.PickMemTable();

  Status s;
  if (logfile_number_ > 0 &&
      versions_->GetColumnFamilySet()->NumberOfColumnFamilies() > 0 &&
1906
      !immutable_db_options_.disable_data_sync) {
1907 1908 1909 1910 1911 1912 1913 1914 1915
    // 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);
  }

1916 1917 1918 1919 1920 1921
  // 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.
1922 1923 1924
  if (s.ok()) {
    s = flush_job.Run(&file_meta);
  }
J
jorlow@chromium.org 已提交
1925 1926

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

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

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

2010 2011 2012
Status DBImpl::CompactRange(const CompactRangeOptions& options,
                            ColumnFamilyHandle* column_family,
                            const Slice* begin, const Slice* end) {
2013
  if (options.target_path_id >= immutable_db_options_.db_paths.size()) {
2014 2015 2016
    return Status::InvalidArgument("Invalid target path ID");
  }

2017 2018
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
2019
  bool exclusive = options.exclusive_manual_compaction;
I
Igor Canadi 已提交
2020 2021

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
2022
  if (!s.ok()) {
2023
    LogFlush(immutable_db_options_.info_log);
L
Lei Jin 已提交
2024 2025 2026
    return s;
  }

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

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

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

2109
  {
2110
    InstrumentedMutexLock l(&mutex_);
2111 2112 2113 2114 2115
    // an automatic compaction that has been scheduled might have been
    // preempted by the manual compactions. Need to schedule it back.
    MaybeScheduleFlushOrCompaction();
  }

L
Lei Jin 已提交
2116
  return s;
2117 2118
}

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

  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  assert(cfd);
2134 2135 2136 2137

  Status s;
  JobContext job_context(0, true);
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
2138
                       immutable_db_options_.info_log.get());
2139 2140 2141 2142 2143 2144

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

2145
    // This call will unlock/lock the mutex to wait for current running
2146 2147
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
2148

2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162
    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());
2163
  }  // release the mutex
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173

  // 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()) {
2174
      // no mutex is locked here.  No need to Unlock() and Lock() here.
2175 2176 2177 2178 2179
      PurgeObsoleteFiles(job_context);
    }
    job_context.Clean();
  }

2180
  return s;
I
Igor Canadi 已提交
2181
#endif  // ROCKSDB_LITE
2182 2183
}

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

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

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

2256 2257 2258
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();

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

  // 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 已提交
2285 2286
  version->storage_info()->ComputeCompactionScore(*cfd->ioptions(),
                                                  *c->mutable_cf_options());
2287

2288 2289 2290
  compaction_job.Prepare();

  mutex_.Unlock();
2291 2292
  TEST_SYNC_POINT("CompactFilesImpl:0");
  TEST_SYNC_POINT("CompactFilesImpl:1");
2293
  compaction_job.Run();
2294 2295
  TEST_SYNC_POINT("CompactFilesImpl:2");
  TEST_SYNC_POINT("CompactFilesImpl:3");
2296
  mutex_.Lock();
2297

2298
  Status status = compaction_job.Install(*c->mutable_cf_options());
2299
  if (status.ok()) {
I
Igor Canadi 已提交
2300 2301
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
2302 2303 2304
  }
  c->ReleaseCompactionFiles(s);

2305
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
2306 2307 2308 2309 2310 2311

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

2321 2322
  c.reset();

2323
  bg_compaction_scheduled_--;
2324 2325 2326
  if (bg_compaction_scheduled_ == 0) {
    bg_cv_.SignalAll();
  }
2327 2328 2329

  return status;
}
I
Igor Canadi 已提交
2330
#endif  // ROCKSDB_LITE
2331

2332 2333
Status DBImpl::PauseBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
2334
  bg_compaction_paused_++;
2335 2336 2337
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_ > 0) {
    bg_cv_.Wait();
  }
2338
  bg_work_paused_++;
2339 2340 2341 2342 2343
  return Status::OK();
}

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

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

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

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

2447
      persist_options_status = PersistOptions();
2448 2449
    }
  }
L
Lei Jin 已提交
2450

2451 2452
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
      "SetOptions() on column family [%s], inputs:", cfd->GetName().c_str());
L
Lei Jin 已提交
2453
  for (const auto& o : options_map) {
2454 2455
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log, "%s: %s\n",
        o.first.c_str(), o.second.c_str());
L
Lei Jin 已提交
2456
  }
2457
  if (s.ok()) {
2458
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2459
        "[%s] SetOptions() succeeded", cfd->GetName().c_str());
2460
    new_options.Dump(immutable_db_options_.info_log.get());
2461
    if (!persist_options_status.ok()) {
2462
      if (immutable_db_options_.fail_if_options_file_error) {
2463
        s = Status::IOError(
2464
            "SetOptions() succeeded, but unable to persist options",
2465 2466
            persist_options_status.ToString());
      }
2467
      Warn(immutable_db_options_.info_log,
2468 2469 2470
           "Unable to persist options in SetOptions() -- %s",
           persist_options_status.ToString().c_str());
    }
L
Lei Jin 已提交
2471
  } else {
2472
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
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 2529 2530 2531 2532 2533
        "[%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 已提交
2534
  }
2535
  LogFlush(immutable_db_options_.info_log);
2536
  return s;
I
Igor Canadi 已提交
2537
#endif  // ROCKSDB_LITE
2538 2539
}

2540 2541 2542 2543 2544 2545 2546 2547 2548
Status DBImpl::PersistOptions() {
  mutex_.AssertHeld();
  WriteThread::Writer w;
  write_thread_.EnterUnbatched(&w, &mutex_);
  Status s = WriteOptionsFile();
  write_thread_.ExitUnbatched(&w);
  return s;
}

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

    minimum_level = i;
  }
  return minimum_level;
}

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

2576 2577 2578 2579
  std::unique_ptr<SuperVersion> superversion_to_free;
  std::unique_ptr<SuperVersion> new_superversion(new SuperVersion());

  Status status;
I
Igor Canadi 已提交
2580

I
Islam AbdelRahman 已提交
2581
  InstrumentedMutexLock guard_lock(&mutex_);
2582 2583 2584

  // only allow one thread refitting
  if (refitting_level_) {
2585
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2586
        "[ReFitLevel] another thread is refitting");
L
Lei Jin 已提交
2587
    return Status::NotSupported("another thread is refitting");
2588 2589 2590
  }
  refitting_level_ = true;

2591
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
2592
  // move to a smaller level
2593 2594
  int to_level = target_level;
  if (target_level < 0) {
2595
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
2596
  }
2597

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

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

2630 2631
    status = versions_->LogAndApply(cfd, mutable_cf_options, &edit, &mutex_,
                                    directories_.GetDbDir());
2632 2633
    superversion_to_free.reset(InstallSuperVersionAndScheduleWork(
        cfd, new_superversion.release(), mutable_cf_options));
2634

2635
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2636
        "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
2637
        status.ToString().data());
2638 2639

    if (status.ok()) {
2640
      Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2641 2642
          "[%s] After refitting:\n%s", cfd->GetName().c_str(),
          cfd->current()->DebugString().data());
2643 2644 2645 2646
    }
  }

  refitting_level_ = false;
I
Igor Canadi 已提交
2647

L
Lei Jin 已提交
2648
  return status;
G
Gabor Cselle 已提交
2649 2650
}

2651 2652 2653
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
2654 2655
}

2656
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
2657
  return 0;
2658 2659
}

2660 2661
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
2662
  InstrumentedMutexLock l(&mutex_);
L
Lei Jin 已提交
2663 2664
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.level0_stop_writes_trigger;
2665 2666
}

L
Lei Jin 已提交
2667
Status DBImpl::Flush(const FlushOptions& flush_options,
2668 2669
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
2670
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
2671 2672
}

2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693
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(
2694 2695 2696 2697
            "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());
2698 2699 2700 2701 2702 2703 2704
      }
    }
    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;
2705
      logs_to_sync.push_back(log.writer);
2706 2707 2708 2709 2710
    }

    need_log_dir_sync = !log_dir_synced_;
  }

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

2723
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:1");
2724 2725 2726 2727
  {
    InstrumentedMutexLock l(&mutex_);
    MarkLogsSynced(current_log_number, need_log_dir_sync, status);
  }
2728
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:2");
2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744

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

2757
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
2758 2759 2760
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
2761
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
2762
                                   int output_level, uint32_t output_path_id,
2763
                                   const Slice* begin, const Slice* end,
2764
                                   bool exclusive, bool disallow_trivial_move) {
2765 2766
  assert(input_level == ColumnFamilyData::kCompactAllLevels ||
         input_level >= 0);
2767

G
Gabor Cselle 已提交
2768
  InternalKey begin_storage, end_storage;
2769
  CompactionArg* ca;
G
Gabor Cselle 已提交
2770

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

2802 2803
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:0");
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:1");
2804
  InstrumentedMutexLock l(&mutex_);
2805

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

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

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

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

2877
  assert(!manual.in_progress);
2878 2879
  assert(HasPendingManualCompaction());
  RemoveManualCompaction(&manual);
2880
  bg_cv_.SignalAll();
L
Lei Jin 已提交
2881
  return manual.status;
J
jorlow@chromium.org 已提交
2882 2883
}

2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900
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);
}

2901
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
2902 2903
                             const FlushOptions& flush_options,
                             bool writes_stopped) {
S
Stanislau Hlebik 已提交
2904 2905 2906
  Status s;
  {
    WriteContext context;
2907
    InstrumentedMutexLock guard_lock(&mutex_);
2908

2909
    if (cfd->imm()->NumNotFlushed() == 0 && cfd->mem()->IsEmpty()) {
2910 2911 2912 2913
      // Nothing to flush
      return Status::OK();
    }

2914
    WriteThread::Writer w;
2915 2916 2917
    if (!writes_stopped) {
      write_thread_.EnterUnbatched(&w, &mutex_);
    }
S
Stanislau Hlebik 已提交
2918

I
Igor Canadi 已提交
2919
    // SwitchMemtable() will release and reacquire mutex
S
Stanislau Hlebik 已提交
2920
    // during execution
I
Igor Canadi 已提交
2921
    s = SwitchMemtable(cfd, &context);
2922 2923 2924 2925

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

S
Stanislau Hlebik 已提交
2927 2928
    cfd->imm()->FlushRequested();

2929 2930 2931
    // schedule flush
    SchedulePendingFlush(cfd);
    MaybeScheduleFlushOrCompaction();
S
Stanislau Hlebik 已提交
2932
  }
S
Stanislau Hlebik 已提交
2933

L
Lei Jin 已提交
2934
  if (s.ok() && flush_options.wait) {
2935
    // Wait until the compaction completes
2936
    s = WaitForFlushMemTable(cfd);
2937 2938
  }
  return s;
J
jorlow@chromium.org 已提交
2939 2940
}

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

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

  return s;
}

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

2985
  while (unscheduled_flushes_ > 0 &&
2986
         bg_flush_scheduled_ < immutable_db_options_.max_background_flushes) {
2987 2988
    unscheduled_flushes_--;
    bg_flush_scheduled_++;
2989
    env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH, this);
2990 2991
  }

2992 2993
  auto bg_compactions_allowed = BGCompactionsAllowed();

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

3006 3007 3008 3009 3010
  if (bg_compaction_paused_ > 0) {
    // we paused the background compaction
    return;
  }

3011
  if (HasExclusiveManualCompaction()) {
3012 3013 3014 3015 3016
    // only manual compactions are allowed to run. don't schedule automatic
    // compactions
    return;
  }

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

3029 3030 3031 3032 3033 3034 3035 3036 3037
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);
}

3038
int DBImpl::BGCompactionsAllowed() const {
3039
  mutex_.AssertHeld();
3040
  if (write_controller_.NeedSpeedupCompaction()) {
3041
    return mutable_db_options_.max_background_compactions;
3042
  } else {
3043
    return mutable_db_options_.base_background_compactions;
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 3085 3086 3087 3088 3089
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_;
3090 3091 3092
  }
}

3093 3094 3095 3096 3097 3098 3099 3100
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));
}

3101
void DBImpl::BGWorkFlush(void* db) {
3102
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3103
  TEST_SYNC_POINT("DBImpl::BGWorkFlush");
3104
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
3105
  TEST_SYNC_POINT("DBImpl::BGWorkFlush:done");
3106 3107
}

3108 3109 3110
void DBImpl::BGWorkCompaction(void* arg) {
  CompactionArg ca = *(reinterpret_cast<CompactionArg*>(arg));
  delete reinterpret_cast<CompactionArg*>(arg);
3111
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
3112
  TEST_SYNC_POINT("DBImpl::BGWorkCompaction");
3113 3114 3115
  reinterpret_cast<DBImpl*>(ca.db)->BackgroundCallCompaction(ca.m);
}

3116 3117
void DBImpl::BGWorkPurge(void* db) {
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3118
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:start");
3119
  reinterpret_cast<DBImpl*>(db)->BackgroundCallPurge();
3120
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:end");
3121 3122
}

3123 3124 3125 3126 3127 3128 3129
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");
3130 3131
}

3132 3133 3134
void DBImpl::BackgroundCallPurge() {
  mutex_.Lock();

3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146
  // 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();
3147

3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160
      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();
    }
3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171
  }
  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();
}

3172
Status DBImpl::BackgroundFlush(bool* made_progress, JobContext* job_context,
H
Haobo Xu 已提交
3173
                               LogBuffer* log_buffer) {
3174
  mutex_.AssertHeld();
3175

3176 3177 3178 3179 3180 3181 3182
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

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

3185 3186 3187
  ColumnFamilyData* cfd = nullptr;
  while (!flush_queue_.empty()) {
    // This cfd is already referenced
I
Igor Canadi 已提交
3188
    auto first_cfd = PopFirstFromFlushQueue();
3189

I
Igor Canadi 已提交
3190
    if (first_cfd->IsDropped() || !first_cfd->imm()->IsFlushPending()) {
3191
      // can't flush this CF, try next one
I
Igor Canadi 已提交
3192 3193
      if (first_cfd->Unref()) {
        delete first_cfd;
3194 3195
      }
      continue;
3196
    }
3197 3198

    // found a flush!
I
Igor Canadi 已提交
3199
    cfd = first_cfd;
3200 3201 3202 3203 3204 3205 3206 3207 3208
    break;
  }

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

3222
void DBImpl::BackgroundCallFlush() {
3223
  bool made_progress = false;
3224
  JobContext job_context(next_job_id_.fetch_add(1), true);
3225 3226
  assert(bg_flush_scheduled_);

3227 3228
  TEST_SYNC_POINT("DBImpl::BackgroundCallFlush:start");

3229 3230
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
                       immutable_db_options_.info_log.get());
H
Haobo Xu 已提交
3231
  {
3232
    InstrumentedMutexLock l(&mutex_);
3233
    num_running_flushes_++;
H
Haobo Xu 已提交
3234

I
Igor Canadi 已提交
3235 3236 3237
    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

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

I
Igor Canadi 已提交
3258 3259
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

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

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

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

    // This call will unlock/lock the mutex to wait for current running
3304 3305
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
3306

3307
    num_running_compactions_++;
I
Igor Canadi 已提交
3308 3309 3310 3311

    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

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

I
Igor Canadi 已提交
3335 3336
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

3337 3338 3339 3340
    // 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());
3341 3342

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

3358 3359
    assert(num_running_compactions_ > 0);
    num_running_compactions_--;
3360
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
3361

3362 3363
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

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

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

3392 3393 3394 3395 3396
  bool is_manual = (manual_compaction != nullptr);

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

3398
  CompactionJobStats compaction_job_stats;
3399 3400 3401 3402 3403 3404
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
3405
    if (is_manual) {
3406 3407 3408 3409 3410
      manual_compaction->status = status;
      manual_compaction->done = true;
      manual_compaction->in_progress = false;
      delete manual_compaction->compaction;
      manual_compaction = nullptr;
3411
    }
3412
    return status;
3413 3414
  }

3415 3416
  if (is_manual) {
    // another thread cannot pick up the same work
3417
    manual_compaction->in_progress = true;
3418 3419 3420
  }

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

3462 3463 3464 3465 3466 3467
    if (HaveManualCompaction(cfd)) {
      // Can't compact right now, but try again later
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction()::Conflict");
      return Status::OK();
    }

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

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

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

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

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

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

3567
    status = versions_->LogAndApply(c->column_family_data(),
3568 3569
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
3570
    // Use latest MutableCFOptions
I
Igor Canadi 已提交
3571 3572
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
3573

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

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

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

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

I
Igor Canadi 已提交
3615
    mutex_.Unlock();
3616
    compaction_job.Run();
3617
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:NonTrivial:AfterRun");
I
Igor Canadi 已提交
3618
    mutex_.Lock();
3619

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

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
3639
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
3640 3641
    // Ignore compaction errors found during shutting down
  } else {
3642 3643 3644
    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 已提交
3645 3646 3647
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
3648 3649

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

3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711
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;
}

3712
bool DBImpl::ShouldntRunManualCompaction(ManualCompaction* m) {
3713 3714
  if (num_running_ingest_file_ > 0) {
    // We need to wait for other IngestExternalFile() calls to finish
3715 3716 3717
    // before running a manual compaction.
    return true;
  }
3718 3719
  if (m->exclusive) {
    return (bg_compaction_scheduled_ > 0);
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 3776 3777 3778 3779 3780
  }
  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;
}

3781 3782
size_t DBImpl::GetWalPreallocateBlockSize(uint64_t write_buffer_size) const {
  size_t bsize = write_buffer_size / 10 + write_buffer_size;
3783 3784
  // Some users might set very high write_buffer_size and rely on
  // max_total_wal_size or other parameters to control the WAL size.
3785 3786
  if (immutable_db_options_.max_total_wal_size > 0) {
    bsize = std::min<size_t>(bsize, immutable_db_options_.max_total_wal_size);
3787
  }
3788 3789
  if (immutable_db_options_.db_write_buffer_size > 0) {
    bsize = std::min<size_t>(bsize, immutable_db_options_.db_write_buffer_size);
3790
  }
3791 3792 3793 3794
  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());
3795 3796 3797 3798 3799
  }

  return bsize;
}

3800 3801
namespace {
struct IterState {
3802
  IterState(DBImpl* _db, InstrumentedMutex* _mu, SuperVersion* _super_version,
3803
            bool _background_purge)
3804 3805 3806
      : db(_db),
        mu(_mu),
        super_version(_super_version),
3807
        background_purge(_background_purge) {}
3808 3809

  DBImpl* db;
3810
  InstrumentedMutex* mu;
3811
  SuperVersion* super_version;
3812
  bool background_purge;
3813 3814 3815 3816
};

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

3818
  if (state->super_version->Unref()) {
3819 3820 3821
    // Job id == 0 means that this is not our background process, but rather
    // user thread
    JobContext job_context(0);
3822

3823 3824
    state->mu->Lock();
    state->super_version->Cleanup();
I
Igor Canadi 已提交
3825
    state->db->FindObsoleteFiles(&job_context, false, true);
3826 3827 3828
    if (state->background_purge) {
      state->db->ScheduleBgLogWriterClose(&job_context);
    }
3829 3830 3831
    state->mu->Unlock();

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

3848 3849
  delete state;
}
H
Hans Wennborg 已提交
3850
}  // namespace
3851

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

  return internal_iter;
}

3880 3881 3882 3883
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
3884
Status DBImpl::Get(const ReadOptions& read_options,
3885
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3886
                   std::string* value) {
L
Lei Jin 已提交
3887
  return GetImpl(read_options, column_family, key, value);
3888 3889
}

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

I
Igor Canadi 已提交
3912
SuperVersion* DBImpl::InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
3913
    ColumnFamilyData* cfd, SuperVersion* new_sv,
I
Igor Canadi 已提交
3914
    const MutableCFOptions& mutable_cf_options) {
L
Lei Jin 已提交
3915
  mutex_.AssertHeld();
3916 3917 3918 3919 3920 3921 3922 3923 3924

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

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

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

3948 3949 3950
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

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

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

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

3989 3990
  {
    PERF_TIMER_GUARD(get_post_process_time);
3991

3992
    ReturnAndCleanupSuperVersion(cfd, sv);
3993

3994 3995
    RecordTick(stats_, NUMBER_KEYS_READ);
    RecordTick(stats_, BYTES_READ, value->size());
3996
    MeasureTime(stats_, BYTES_PER_READ, value->size());
3997
  }
3998
  return s;
J
jorlow@chromium.org 已提交
3999 4000
}

4001
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
4002
    const ReadOptions& read_options,
4003
    const std::vector<ColumnFamilyHandle*>& column_family,
4004
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
4005

L
Lei Jin 已提交
4006
  StopWatch sw(env_, stats_, DB_MULTIGET);
4007
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
4008

4009
  SequenceNumber snapshot;
4010

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

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

4040 4041
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
4042

4043
  // Note: this always resizes the values array
4044 4045 4046
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
4047 4048

  // Keep track of bytes that we read for statistics-recording later
4049
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
4050
  PERF_TIMER_STOP(get_snapshot_time);
4051 4052 4053 4054

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

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

    if (s.ok()) {
4087
      bytes_read += value->size();
4088 4089 4090 4091
    }
  }

  // Post processing (decrement reference counts and record statistics)
4092
  PERF_TIMER_GUARD(get_post_process_time);
4093 4094
  autovector<SuperVersion*> superversions_to_delete;

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

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
4111
  }
4112

L
Lei Jin 已提交
4113 4114 4115
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
4116
  MeasureTime(stats_, BYTES_PER_MULTIGET, bytes_read);
L
Lei Jin 已提交
4117
  PERF_TIMER_STOP(get_post_process_time);
4118

4119
  return stat_list;
4120 4121
}

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

  s = CheckCompressionSupported(cf_options);
4130
  if (s.ok() && immutable_db_options_.allow_concurrent_memtable_write) {
4131 4132
    s = CheckConcurrentWritesSupported(cf_options);
  }
4133 4134 4135 4136
  if (!s.ok()) {
    return s;
  }

Y
Yueh-Hsuan Chiang 已提交
4137
  {
4138
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
4139

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

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

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

Y
Yueh-Hsuan Chiang 已提交
4181
      *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
4182 4183 4184
      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 已提交
4185
    } else {
4186
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
Y
Yueh-Hsuan Chiang 已提交
4187 4188 4189
          "Creating column family [%s] FAILED -- %s",
          column_family_name.c_str(), s.ToString().c_str());
    }
4190
  }  // InstrumentedMutexLock l(&mutex_)
Y
Yueh-Hsuan Chiang 已提交
4191 4192

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

4211 4212 4213 4214
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
4215 4216
    return Status::InvalidArgument("Can't drop default column family");
  }
4217

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

I
Igor Canadi 已提交
4220 4221
  VersionEdit edit;
  edit.DropColumnFamily();
4222 4223
  edit.SetColumnFamily(cfd->GetID());

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

    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()) {
4250
        if (!c->IsDropped() && !c->mem()->IsSnapshotSupported()) {
S
sdong 已提交
4251 4252 4253 4254 4255 4256
          new_is_snapshot_supported = false;
          break;
        }
      }
      is_snapshot_supported_ = new_is_snapshot_supported;
    }
4257
  }
4258

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

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

4288
  return s;
4289 4290
}

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

4302
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
4303 4304 4305
  // 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();
4306 4307
}

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

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

I
Igor Canadi 已提交
4352
    auto snapshot =
4353 4354 4355
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
4356
            : latest_snapshot;
T
Tomislav Novak 已提交
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 4389 4390 4391 4392 4393
    // 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         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
4394 4395
    // ArenaWrappedDBIter inlines an arena area where all the iterators in
    // the iterator tree are allocated in the order of being accessed when
4396 4397 4398 4399 4400
    // 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(
4401 4402
        env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4403
        sv->version_number, read_options.iterate_upper_bound,
4404 4405
        read_options.prefix_same_as_start, read_options.pin_data,
        read_options.total_order_seek);
4406

S
sdong 已提交
4407
    InternalIterator* internal_iter =
4408
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena());
4409 4410 4411 4412
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
4413 4414
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
4415 4416
}

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

I
Igor Canadi 已提交
4465
    for (size_t i = 0; i < column_families.size(); ++i) {
4466 4467 4468
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
4469 4470

      auto snapshot =
4471 4472 4473
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
4474 4475
              : latest_snapshot;

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

  return Status::OK();
4488 4489
}

4490 4491
const Snapshot* DBImpl::GetSnapshot() { return GetSnapshotImpl(false); }

4492
#ifndef ROCKSDB_LITE
4493 4494 4495
const Snapshot* DBImpl::GetSnapshotForWriteConflictBoundary() {
  return GetSnapshotImpl(true);
}
4496
#endif  // ROCKSDB_LITE
4497 4498

const Snapshot* DBImpl::GetSnapshotImpl(bool is_write_conflict_boundary) {
4499 4500
  int64_t unix_time = 0;
  env_->GetCurrentTime(&unix_time);  // Ignore error
4501
  SnapshotImpl* s = new SnapshotImpl;
4502

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

void DBImpl::ReleaseSnapshot(const Snapshot* s) {
4514 4515 4516 4517 4518 4519
  const SnapshotImpl* casted_s = reinterpret_cast<const SnapshotImpl*>(s);
  {
    InstrumentedMutexLock l(&mutex_);
    snapshots_.Delete(casted_s);
  }
  delete casted_s;
J
jorlow@chromium.org 已提交
4520 4521 4522
}

// Convenience methods
4523 4524
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
4525
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
4526 4527
}

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

L
Lei Jin 已提交
4538
Status DBImpl::Delete(const WriteOptions& write_options,
4539
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
4540
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
4541 4542
}

A
Andres Noetzli 已提交
4543 4544 4545 4546 4547 4548
Status DBImpl::SingleDelete(const WriteOptions& write_options,
                            ColumnFamilyHandle* column_family,
                            const Slice& key) {
  return DB::SingleDelete(write_options, column_family, key);
}

L
Lei Jin 已提交
4549
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
4550
  return WriteImpl(write_options, my_batch, nullptr, nullptr);
A
agiardullo 已提交
4551 4552
}

A
agiardullo 已提交
4553
#ifndef ROCKSDB_LITE
A
agiardullo 已提交
4554 4555 4556
Status DBImpl::WriteWithCallback(const WriteOptions& write_options,
                                 WriteBatch* my_batch,
                                 WriteCallback* callback) {
4557
  return WriteImpl(write_options, my_batch, callback, nullptr);
A
agiardullo 已提交
4558
}
A
agiardullo 已提交
4559
#endif  // ROCKSDB_LITE
A
agiardullo 已提交
4560 4561

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

  Status status;
A
agiardullo 已提交
4573

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

4584
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
4585
  WriteThread::Writer w;
S
Stanislau Hlebik 已提交
4586
  w.batch = my_batch;
L
Lei Jin 已提交
4587 4588
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
4589
  w.disable_memtable = disable_memtable;
S
Stanislau Hlebik 已提交
4590
  w.in_batch_group = false;
4591
  w.callback = callback;
4592
  w.log_ref = log_ref;
S
Stanislau Hlebik 已提交
4593

L
Lei Jin 已提交
4594
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4595 4596 4597
    RecordTick(stats_, WRITE_WITH_WAL);
  }

4598
  StopWatch write_sw(env_, immutable_db_options_.statistics.get(), DB_WRITE);
4599

4600
  write_thread_.JoinBatchGroup(&w);
4601 4602 4603 4604
  if (w.state == WriteThread::STATE_PARALLEL_FOLLOWER) {
    // we are a non-leader in a parallel group
    PERF_TIMER_GUARD(write_memtable_time);

4605 4606 4607 4608 4609
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }

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

    if (write_thread_.CompleteParallelWorker(&w)) {
      // we're responsible for early exit
4621
      auto last_sequence = w.parallel_group->last_sequence;
4622 4623 4624 4625 4626 4627
      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
4628 4629

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

S
Stanislau Hlebik 已提交
4642 4643
  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4644 4645 4646 4647 4648

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

S
Stanislau Hlebik 已提交
4649 4650
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
4651

4652 4653 4654 4655
  // 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.
4656 4657 4658
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

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

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

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

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

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

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

S
Stanislau Hlebik 已提交
4753
  if (status.ok()) {
4754
    if (need_log_sync) {
4755 4756 4757 4758 4759 4760 4761 4762 4763
      while (logs_.front().getting_synced) {
        log_sync_cv_.Wait();
      }
      for (auto& log : logs_) {
        assert(!log.getting_synced);
        log.getting_synced = true;
      }
    }

4764 4765 4766
    // 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
4767
    // into memtables
A
agiardullo 已提交
4768 4769
  }

4770 4771
  mutex_.Unlock();

A
agiardullo 已提交
4772 4773
  // At this point the mutex is unlocked

4774
  bool exit_completed_early = false;
4775 4776
  last_batch_group_size_ =
      write_thread_.EnterAsBatchGroupLeader(&w, &last_writer, &write_group);
4777

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

    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);
4816
    MeasureTime(stats_, BYTES_PER_WRITE, total_byte_size);
4817
    PERF_TIMER_STOP(write_pre_and_post_process_time);
4818

4819
    if (write_options.disableWAL) {
4820
      has_unpersisted_data_ = true;
4821
    }
4822

4823 4824 4825
    uint64_t log_size = 0;
    if (!write_options.disableWAL) {
      PERF_TIMER_GUARD(write_wal_time);
4826

4827
      WriteBatch* merged_batch = nullptr;
4828 4829 4830 4831 4832
      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
4833
        merged_batch = write_group[0]->batch;
4834
        write_group[0]->log_used = logfile_number_;
4835 4836 4837 4838 4839
      } 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_;
4840
        for (auto writer : write_group) {
4841
          if (writer->ShouldWriteToWAL()) {
4842 4843
            WriteBatchInternal::Append(merged_batch, writer->batch,
                                       /*WAL_only*/ true);
4844
          }
4845
          writer->log_used = logfile_number_;
4846 4847 4848
        }
      }

4849 4850 4851 4852 4853
      if (log_used != nullptr) {
        *log_used = logfile_number_;
      }

      WriteBatchInternal::SetSequence(merged_batch, current_sequence);
4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872

      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_) {
4873
          status = log.writer->file()->Sync(immutable_db_options_.use_fsync);
4874 4875 4876 4877 4878 4879 4880 4881 4882 4883
          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();
        }
4884 4885
      }

4886 4887 4888 4889 4890 4891
      if (merged_batch == &tmp_batch_) {
        tmp_batch_.Clear();
      }
    }
    if (status.ok()) {
      PERF_TIMER_GUARD(write_memtable_time);
4892

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

4917
      if (!parallel) {
4918
        status = WriteBatchInternal::InsertInto(
4919
            write_group, current_sequence, column_family_memtables_.get(),
4920
            &flush_scheduler_, write_options.ignore_missing_column_families,
S
sdong 已提交
4921
            0 /*log_number*/, this);
4922 4923 4924 4925 4926 4927 4928

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

4929
      } else {
4930
        WriteThread::ParallelGroup pg;
4931 4932
        pg.leader = &w;
        pg.last_writer = last_writer;
4933
        pg.last_sequence = last_sequence;
4934
        pg.early_exit_allowed = !need_log_sync;
4935
        pg.running.store(static_cast<uint32_t>(write_group.size()),
4936
                         std::memory_order_relaxed);
4937 4938
        write_thread_.LaunchParallelFollowers(&pg, current_sequence);

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

4951 4952 4953
        // CompleteParallelWorker returns true if this thread should
        // handle exit, false means somebody else did
        exit_completed_early = !write_thread_.CompleteParallelWorker(&w);
4954
        status = w.FinalStatus();
4955
      }
A
agiardullo 已提交
4956

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

      // 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.
4974
      if (!status.ok() && bg_error_.ok() && !w.CallbackFailed()) {
4975
        bg_error_ = status;
4976
      }
4977
    }
4978
  }
4979
  PERF_TIMER_START(write_pre_and_post_process_time);
A
agiardullo 已提交
4980

4981 4982
  if (immutable_db_options_.paranoid_checks && !status.ok() &&
      !w.CallbackFailed() && !status.IsBusy()) {
4983 4984 4985 4986 4987
    mutex_.Lock();
    if (bg_error_.ok()) {
      bg_error_ = status;  // stop compaction & fail any further writes
    }
    mutex_.Unlock();
I
Igor Canadi 已提交
4988
  }
4989

4990
  if (need_log_sync) {
4991
    mutex_.Lock();
4992
    MarkLogsSynced(logfile_number_, need_log_dir_sync, status);
4993
    mutex_.Unlock();
4994 4995
  }

4996
  if (!exit_completed_early) {
4997
    write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
4998
  }
4999

J
jorlow@chromium.org 已提交
5000 5001 5002
  return status;
}

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

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

  return bg_error_;
5033 5034
}

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

5049 5050 5051
#ifndef ROCKSDB_LITE
void DBImpl::NotifyOnMemTableSealed(ColumnFamilyData* cfd,
                                    const MemTableInfo& mem_table_info) {
5052
  if (immutable_db_options_.listeners.size() == 0U) {
5053 5054 5055 5056 5057 5058
    return;
  }
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }

5059
  for (auto listener : immutable_db_options_.listeners) {
5060
    listener->OnMemTableSealed(mem_table_info);
5061
  }
5062 5063 5064
}
#endif  // ROCKSDB_LITE

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

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

    if (s.ok()) {
A
agiardullo 已提交
5134 5135
      SequenceNumber seq = versions_->LastSequence();
      new_mem = cfd->ConstructNewMemtable(mutable_cf_options, seq);
S
Stanislau Hlebik 已提交
5136 5137
      new_superversion = new SuperVersion();
    }
5138 5139 5140 5141 5142 5143 5144

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

I
Igor Canadi 已提交
5185
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
5186 5187 5188 5189 5190
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

5191 5192
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
5193
  auto version = cfd->current();
5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
5206 5207

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

I
Igor Canadi 已提交
5231 5232 5233 5234
const std::string& DBImpl::GetName() const {
  return dbname_;
}

5235 5236 5237 5238
Env* DBImpl::GetEnv() const {
  return env_;
}

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

5246 5247 5248 5249
DBOptions DBImpl::GetDBOptions() const {
  InstrumentedMutexLock l(&mutex_);
  return BuildDBOptions(immutable_db_options_, mutable_db_options_);
}
5250

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

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

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

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

5310 5311 5312
    if (!is_locked) {
      ReturnAndCleanupSuperVersion(cfd, sv);
    }
5313 5314 5315 5316 5317

    return ret;
  }
}

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

5342 5343
SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
I
Igor Canadi 已提交
5344
  return cfd->GetThreadLocalSuperVersion(&mutex_);
5345 5346
}

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

5375 5376
void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
5377
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
5378 5379 5380 5381 5382

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
5383
        InstrumentedMutexLock l(&mutex_);
5384 5385 5386 5387 5388 5389 5390
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
5391 5392
}

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

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

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

5467
  ReturnAndCleanupSuperVersion(cfd, sv);
J
jorlow@chromium.org 已提交
5468 5469
}

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

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

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

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

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

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

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

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

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

5666
  LogFlush(immutable_db_options_.info_log);
I
Igor Canadi 已提交
5667
  // remove files outside the db-lock
I
Igor Canadi 已提交
5668
  if (job_context.HaveSomethingToDelete()) {
5669
    // Call PurgeObsoleteFiles() without holding mutex.
I
Igor Canadi 已提交
5670
    PurgeObsoleteFiles(job_context);
5671
  }
I
Igor Canadi 已提交
5672
  job_context.Clean();
5673 5674 5675
  return status;
}

5676
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
5677
  InstrumentedMutexLock l(&mutex_);
5678
  versions_->GetLiveFilesMetaData(metadata);
5679
}
5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690

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 已提交
5691
#endif  // ROCKSDB_LITE
5692

I
Igor Canadi 已提交
5693 5694 5695 5696 5697 5698 5699
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

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

5726
Status DBImpl::GetDbIdentity(std::string& identity) const {
5727 5728
  std::string idfilename = IdentityFileName(dbname_);
  const EnvOptions soptions;
5729 5730 5731 5732 5733 5734 5735 5736 5737
  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)));
5738
  }
5739

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

5771 5772
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
5773
  WriteBatch batch;
5774
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
5775 5776 5777
  return Write(opt, &batch);
}

A
Andres Noetzli 已提交
5778 5779 5780 5781 5782 5783 5784
Status DB::SingleDelete(const WriteOptions& opt,
                        ColumnFamilyHandle* column_family, const Slice& key) {
  WriteBatch batch;
  batch.SingleDelete(column_family, key);
  return Write(opt, &batch);
}

5785 5786
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
5787
  WriteBatch batch;
5788
  batch.Merge(column_family, key, value);
5789 5790 5791
  return Write(opt, &batch);
}

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

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

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

5825 5826
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
5827
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
5828
  Status s = SanitizeOptionsByTable(db_options, column_families);
5829 5830 5831
  if (!s.ok()) {
    return s;
  }
5832

5833 5834 5835
  s = ValidateOptions(db_options, column_families);
  if (!s.ok()) {
    return s;
5836 5837
  }

5838
  *dbptr = nullptr;
5839
  handles->clear();
J
jorlow@chromium.org 已提交
5840

I
Igor Canadi 已提交
5841 5842 5843 5844
  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);
5845
  }
5846

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

5858 5859 5860 5861 5862 5863
  if (!s.ok()) {
    delete impl;
    return s;
  }

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

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

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

5969
    *dbptr = impl;
5970 5971 5972
    impl->opened_successfully_ = true;
    impl->MaybeScheduleFlushOrCompaction();
  }
5973 5974
  impl->mutex_.Unlock();

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

6020 6021 6022
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
6023
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
6024 6025
}

6026 6027 6028
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
6029
Status DestroyDB(const std::string& dbname, const Options& options) {
6030
  const ImmutableDBOptions soptions(SanitizeOptions(dbname, options));
6031
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
6032
  std::vector<std::string> filenames;
6033

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

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

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

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

6108
    // ignore case where no archival directory is present.
6109
    env->DeleteDir(archivedir);
6110

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

6119 6120
Status DBImpl::WriteOptionsFile() {
#ifndef ROCKSDB_LITE
6121
  mutex_.AssertHeld();
6122 6123 6124

  std::vector<std::string> cf_names;
  std::vector<ColumnFamilyOptions> cf_opts;
6125 6126 6127 6128 6129

  // This part requires mutex to protect the column family options
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
6130
    }
6131
    cf_names.push_back(cfd->GetName());
6132
    cf_opts.push_back(cfd->GetLatestCFOptions());
6133 6134
  }

6135 6136
  // Unlock during expensive operations.  New writes cannot get here
  // because the single write thread ensures all new writes get queued.
6137 6138
  DBOptions db_options =
      BuildDBOptions(immutable_db_options_, mutable_db_options_);
6139 6140 6141 6142
  mutex_.Unlock();

  std::string file_name =
      TempOptionsFileName(GetName(), versions_->NewFileNumber());
6143 6144
  Status s =
      PersistRocksDBOptions(db_options, cf_names, cf_opts, file_name, GetEnv());
6145 6146 6147 6148 6149

  if (s.ok()) {
    s = RenameTempFileToOptionsFile(file_name);
  }
  mutex_.Lock();
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 6194 6195 6196 6197 6198
  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,
6199
                           immutable_db_options_.info_log, GetEnv());
6200 6201 6202 6203 6204 6205 6206 6207 6208
  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 已提交
6209 6210

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

Y
Yueh-Hsuan Chiang 已提交
6225 6226
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6227
  if (immutable_db_options_.enable_thread_tracking) {
6228 6229
    ThreadStatusUtil::NewColumnFamilyInfo(this, cfd, cfd->GetName(),
                                          cfd->ioptions()->env);
6230
  }
Y
Yueh-Hsuan Chiang 已提交
6231 6232 6233 6234
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6235
  if (immutable_db_options_.enable_thread_tracking) {
6236
    ThreadStatusUtil::EraseColumnFamilyInfo(cfd);
6237
  }
Y
Yueh-Hsuan Chiang 已提交
6238 6239 6240
}

void DBImpl::EraseThreadStatusDbInfo() const {
6241
  if (immutable_db_options_.enable_thread_tracking) {
6242
    ThreadStatusUtil::EraseDatabaseInfo(this);
6243
  }
Y
Yueh-Hsuan Chiang 已提交
6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258
}

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

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

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

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

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

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

  *seq = kMaxSequenceNumber;
6299 6300
  *found_record_for_key = false;

A
agiardullo 已提交
6301
  // Check if there is a record for this key in the latest memtable
R
Reid Horuff 已提交
6302
  sv->mem->Get(lkey, nullptr, &s, &merge_context, seq);
A
agiardullo 已提交
6303 6304 6305

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

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

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

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

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

    return s;
  }

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

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

      return s;
    }
  }

A
agiardullo 已提交
6374 6375
  return Status::OK();
}
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 6464 6465 6466 6467 6468

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 已提交
6469 6470
#endif  // ROCKSDB_LITE

6471
}  // namespace rocksdb