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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

215 216
namespace {

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

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

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

298
}  // namespace
299

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

J
jorlow@chromium.org 已提交
353
  // Reserve ten files or so for other uses and give the rest to TableCache.
354
  // Give a large number for setting of "infinite" open files.
355 356 357 358 359
  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);
360

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

367 368 369 370 371
  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 已提交
372 373
}

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

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

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

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

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

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

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

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

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

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

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

511 512
  Status s;

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

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

554
const Status DBImpl::CreateArchivalDirectory() {
555 556 557
  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);
558 559 560 561 562
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

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

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

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

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

  const uint64_t now_micros = env_->NowMicros();

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

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

652
    PrintStatistics();
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 700
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 已提交
701
  std::lock_guard<std::mutex> lock(prep_heap_mutex_);
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 728
  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;
}

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

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

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

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

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

I
Igor Canadi 已提交
793
  // store the current filenum, lognum, etc
794
  job_context->manifest_file_number = versions_->manifest_file_number();
I
Igor Canadi 已提交
795
  job_context->pending_manifest_file_number =
796
      versions_->pending_manifest_file_number();
I
Igor Canadi 已提交
797
  job_context->log_number = versions_->MinLogNumber();
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 823

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

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

I
Igor Canadi 已提交
826
  versions_->AddLiveFiles(&job_context->sst_live);
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 861
  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);
      }
    }
  }
862

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

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

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

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

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

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

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

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

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

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

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

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

    if (keep) {
      continue;
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1519
#ifndef ROCKSDB_LITE
1520
      if (immutable_db_options_.wal_filter != nullptr) {
1521 1522 1523
        WriteBatch new_batch;
        bool batch_changed = false;

1524
        WalFilter::WalProcessingOption wal_processing_option =
1525 1526
            immutable_db_options_.wal_filter->LogRecordFound(
                log_number, fname, batch, &new_batch, &batch_changed);
1527

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

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

S
Stanislau Hlebik 已提交
1595 1596 1597 1598 1599
      // 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 已提交
1600
      bool has_valid_writes = false;
1601 1602
      status = WriteBatchInternal::InsertInto(
          &batch, column_family_memtables_.get(), &flush_scheduler_, true,
A
Aaron Gao 已提交
1603 1604
          log_number, this, false /* concurrent_memtable_writes */,
          next_sequence, &has_valid_writes);
S
Stanislau Hlebik 已提交
1605 1606
      MaybeIgnoreError(&status);
      if (!status.ok()) {
1607 1608 1609 1610
        // 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 已提交
1611
      }
1612

S
sdong 已提交
1613
      if (has_valid_writes && !read_only) {
I
Igor Canadi 已提交
1614 1615 1616 1617
        // 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;

1618
        while ((cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
1619 1620 1621 1622 1623 1624 1625
          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;
1626
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
I
Igor Canadi 已提交
1627 1628 1629 1630
          if (!status.ok()) {
            // Reflect errors immediately so that conditions like full
            // file-systems cause the DB::Open() to fail.
            return status;
1631
          }
1632
          flushed = true;
A
agiardullo 已提交
1633 1634

          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
1635
                                 *next_sequence);
1636
        }
J
jorlow@chromium.org 已提交
1637 1638 1639
      }
    }

1640
    if (!status.ok()) {
1641 1642
      if (immutable_db_options_.wal_recovery_mode ==
          WALRecoveryMode::kSkipAnyCorruptedRecords) {
1643 1644
        // We should ignore all errors unconditionally
        status = Status::OK();
1645
      } else if (immutable_db_options_.wal_recovery_mode ==
K
krad 已提交
1646 1647 1648
                 WALRecoveryMode::kPointInTimeRecovery) {
        // We should ignore the error but not continue replaying
        status = Status::OK();
1649
        stop_replay_for_corruption = true;
1650
        Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
K
krad 已提交
1651
            "Point in time recovered to log #%" PRIu64 " seq #%" PRIu64,
1652
            log_number, *next_sequence);
1653
      } else {
1654 1655 1656 1657
        assert(immutable_db_options_.wal_recovery_mode ==
                   WALRecoveryMode::kTolerateCorruptedTailRecords ||
               immutable_db_options_.wal_recovery_mode ==
                   WALRecoveryMode::kAbsoluteConsistency);
K
krad 已提交
1658 1659
        return status;
      }
1660 1661
    }

I
Igor Canadi 已提交
1662
    flush_scheduler_.Clear();
1663 1664 1665 1666
    auto last_sequence = *next_sequence - 1;
    if ((*next_sequence != kMaxSequenceNumber) &&
        (versions_->LastSequence() <= last_sequence)) {
      versions_->SetLastSequence(last_sequence);
S
Stanislau Hlebik 已提交
1667
    }
1668 1669
  }

A
Andrew Kryczka 已提交
1670 1671 1672
  // True if there's any data in the WALs; if not, we can skip re-processing
  // them later
  bool data_seen = false;
1673
  if (!read_only) {
1674 1675
    // 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 已提交
1676
    auto max_log_number = log_numbers.back();
1677
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1678
      auto iter = version_edits.find(cfd->GetID());
1679 1680 1681
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

S
Stanislau Hlebik 已提交
1682
      if (cfd->GetLogNumber() > max_log_number) {
1683
        // Column family cfd has already flushed the data
S
Stanislau Hlebik 已提交
1684
        // from all logs. Memtable has to be empty because
1685
        // we filter the updates based on log_number
1686
        // (in WriteBatch::InsertInto)
1687 1688 1689 1690 1691 1692 1693
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1694 1695 1696
        // 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.
1697
        if (flushed || !immutable_db_options_.avoid_flush_during_recovery) {
1698 1699 1700 1701 1702 1703
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
          if (!status.ok()) {
            // Recovery failed
            break;
          }
          flushed = true;
A
agiardullo 已提交
1704

1705
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
1706
                                 versions_->LastSequence());
1707
        }
A
Andrew Kryczka 已提交
1708
        data_seen = true;
1709
      }
J
jorlow@chromium.org 已提交
1710

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

A
Andrew Kryczka 已提交
1734
  if (data_seen && !flushed) {
1735 1736 1737 1738 1739 1740 1741
    // 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));
    }
  }

1742 1743 1744
  event_logger_.Log() << "job" << job_id << "event"
                      << "recovery_finished";

J
jorlow@chromium.org 已提交
1745 1746 1747
  return status;
}

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

A
Aaron Gao 已提交
1768 1769 1770
    // Get the latest mutable cf options while the mutex is still locked
    const MutableCFOptions mutable_cf_options =
        *cfd->GetLatestMutableCFOptions();
1771 1772
    bool paranoid_file_checks =
        cfd->GetLatestMutableCFOptions()->paranoid_file_checks;
1773 1774
    {
      mutex_.Unlock();
1775 1776 1777 1778 1779

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

1780
      s = BuildTable(
A
Aaron Gao 已提交
1781
          dbname_, env_, *cfd->ioptions(), mutable_cf_options, env_options_,
A
Andrew Kryczka 已提交
1782 1783 1784
          cfd->table_cache(), iter.get(),
          ScopedArenaIterator(mem->NewRangeTombstoneIterator(ro, &arena)),
          &meta, cfd->internal_comparator(),
1785 1786
          cfd->int_tbl_prop_collector_factories(), cfd->GetID(), cfd->GetName(),
          snapshot_seqs, earliest_write_conflict_snapshot,
A
Aaron Gao 已提交
1787
          GetCompressionFlush(*cfd->ioptions(), mutable_cf_options),
1788
          cfd->ioptions()->compression_opts, paranoid_file_checks,
1789 1790
          cfd->internal_stats(), TableFileCreationReason::kRecovery,
          &event_logger_, job_id);
1791 1792
      LogFlush(immutable_db_options_.info_log);
      Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
1793 1794 1795 1796
          "[%s] [WriteLevel0TableForRecovery]"
          " Level-0 table #%" PRIu64 ": %" PRIu64 " bytes %s",
          cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
          s.ToString().c_str());
1797 1798
      mutex_.Lock();
    }
1799
  }
I
Igor Canadi 已提交
1800
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
1801 1802 1803 1804

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1805
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1806 1807
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
1808 1809
                  meta.smallest_seqno, meta.largest_seqno,
                  meta.marked_for_compaction);
1810 1811
  }

L
Lei Jin 已提交
1812
  InternalStats::CompactionStats stats(1);
1813
  stats.micros = env_->NowMicros() - start_micros;
1814
  stats.bytes_written = meta.fd.GetFileSize();
1815
  stats.num_output_files = 1;
1816
  cfd->internal_stats()->AddCompactionStats(level, stats);
1817 1818
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1819
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1820 1821 1822
  return s;
}

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

1866 1867
Status DBImpl::FlushMemTableToOutputFile(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
1868
    bool* made_progress, JobContext* job_context, LogBuffer* log_buffer) {
1869
  mutex_.AssertHeld();
1870
  assert(cfd->imm()->NumNotFlushed() != 0);
1871
  assert(cfd->imm()->IsFlushPending());
1872

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

A
Aaron Gao 已提交
1877
  FlushJob flush_job(
1878
      dbname_, cfd, immutable_db_options_, mutable_cf_options, env_options_,
A
Aaron Gao 已提交
1879 1880 1881 1882 1883
      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);
1884

1885
  FileMetaData file_meta;
1886

1887 1888 1889 1890 1891
  flush_job.PickMemTable();

  Status s;
  if (logfile_number_ > 0 &&
      versions_->GetColumnFamilySet()->NumberOfColumnFamilies() > 0 &&
1892
      !immutable_db_options_.disable_data_sync) {
1893 1894 1895 1896 1897 1898 1899 1900 1901
    // 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);
  }

1902 1903 1904 1905 1906 1907
  // 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.
1908 1909 1910
  if (s.ok()) {
    s = flush_job.Run(&file_meta);
  }
J
jorlow@chromium.org 已提交
1911 1912

  if (s.ok()) {
I
Igor Canadi 已提交
1913 1914
    InstallSuperVersionAndScheduleWorkWrapper(cfd, job_context,
                                              mutable_cf_options);
1915 1916
    if (made_progress) {
      *made_progress = 1;
1917
    }
S
sdong 已提交
1918
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Igor Canadi 已提交
1919
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
S
sdong 已提交
1920
                cfd->current()->storage_info()->LevelSummary(&tmp));
J
jorlow@chromium.org 已提交
1921
  }
1922

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

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

1996 1997 1998
Status DBImpl::CompactRange(const CompactRangeOptions& options,
                            ColumnFamilyHandle* column_family,
                            const Slice* begin, const Slice* end) {
1999
  if (options.target_path_id >= immutable_db_options_.db_paths.size()) {
2000 2001 2002
    return Status::InvalidArgument("Invalid target path ID");
  }

2003 2004
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
2005
  bool exclusive = options.exclusive_manual_compaction;
I
Igor Canadi 已提交
2006 2007

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
2008
  if (!s.ok()) {
2009
    LogFlush(immutable_db_options_.info_log);
L
Lei Jin 已提交
2010 2011 2012
    return s;
  }

I
Igor Canadi 已提交
2013
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
2014
  {
2015
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
2016
    Version* base = cfd->current();
2017 2018
    for (int level = 1; level < base->storage_info()->num_non_empty_levels();
         level++) {
S
sdong 已提交
2019
      if (base->storage_info()->OverlapInLevel(level, begin, end)) {
G
Gabor Cselle 已提交
2020 2021 2022 2023
        max_level_with_files = level;
      }
    }
  }
2024

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

2084
  if (options.change_level) {
2085
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2086 2087 2088 2089 2090 2091
        "[RefitLevel] waiting for background threads to stop");
    s = PauseBackgroundWork();
    if (s.ok()) {
      s = ReFitLevel(cfd, final_output_level, options.target_level);
    }
    ContinueBackgroundWork();
2092
  }
2093
  LogFlush(immutable_db_options_.info_log);
L
Lei Jin 已提交
2094

2095
  {
2096
    InstrumentedMutexLock l(&mutex_);
2097 2098 2099 2100 2101
    // an automatic compaction that has been scheduled might have been
    // preempted by the manual compactions. Need to schedule it back.
    MaybeScheduleFlushOrCompaction();
  }

L
Lei Jin 已提交
2102
  return s;
2103 2104
}

2105 2106 2107 2108 2109
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 已提交
2110 2111 2112 2113
#ifdef ROCKSDB_LITE
    // not supported in lite version
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
2114 2115 2116 2117 2118 2119
  if (column_family == nullptr) {
    return Status::InvalidArgument("ColumnFamilyHandle must be non-null.");
  }

  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  assert(cfd);
2120 2121 2122 2123

  Status s;
  JobContext job_context(0, true);
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
2124
                       immutable_db_options_.info_log.get());
2125 2126 2127 2128 2129 2130

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

2131
    // This call will unlock/lock the mutex to wait for current running
2132 2133
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
2134

2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148
    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());
2149
  }  // release the mutex
2150 2151 2152 2153 2154 2155 2156 2157 2158 2159

  // 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()) {
2160
      // no mutex is locked here.  No need to Unlock() and Lock() here.
2161 2162 2163 2164 2165
      PurgeObsoleteFiles(job_context);
    }
    job_context.Clean();
  }

2166
  return s;
I
Igor Canadi 已提交
2167
#endif  // ROCKSDB_LITE
2168 2169
}

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

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

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

2242 2243 2244
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();

I
Igor Canadi 已提交
2245
  assert(is_snapshot_supported_ || snapshots_.empty());
2246
  CompactionJob compaction_job(
2247 2248
      job_context->job_id, c.get(), immutable_db_options_, env_options_,
      versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
2249 2250 2251
      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,
2252
      c->mutable_cf_options()->report_bg_io_stats, dbname_,
2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265
      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.
2266 2267 2268 2269 2270

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

2274 2275 2276
  compaction_job.Prepare();

  mutex_.Unlock();
2277 2278
  TEST_SYNC_POINT("CompactFilesImpl:0");
  TEST_SYNC_POINT("CompactFilesImpl:1");
2279
  compaction_job.Run();
2280 2281
  TEST_SYNC_POINT("CompactFilesImpl:2");
  TEST_SYNC_POINT("CompactFilesImpl:3");
2282
  mutex_.Lock();
2283

2284
  Status status = compaction_job.Install(*c->mutable_cf_options());
2285
  if (status.ok()) {
I
Igor Canadi 已提交
2286 2287
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
2288 2289 2290
  }
  c->ReleaseCompactionFiles(s);

2291
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
2292 2293 2294 2295 2296 2297

  if (status.ok()) {
    // Done
  } else if (status.IsShutdownInProgress()) {
    // Ignore compaction errors found during shutting down
  } else {
2298
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
2299
        "[%s] [JOB %d] Compaction error: %s",
2300
        c->column_family_data()->GetName().c_str(), job_context->job_id,
2301
        status.ToString().c_str());
2302
    if (immutable_db_options_.paranoid_checks && bg_error_.ok()) {
2303 2304 2305 2306
      bg_error_ = status;
    }
  }

2307 2308
  c.reset();

2309
  bg_compaction_scheduled_--;
2310 2311 2312
  if (bg_compaction_scheduled_ == 0) {
    bg_cv_.SignalAll();
  }
2313 2314 2315

  return status;
}
I
Igor Canadi 已提交
2316
#endif  // ROCKSDB_LITE
2317

2318 2319
Status DBImpl::PauseBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
2320
  bg_compaction_paused_++;
2321 2322 2323
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_ > 0) {
    bg_cv_.Wait();
  }
2324
  bg_work_paused_++;
2325 2326 2327 2328 2329
  return Status::OK();
}

Status DBImpl::ContinueBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
2330 2331 2332
  if (bg_work_paused_ == 0) {
    return Status::InvalidArgument();
  }
2333
  assert(bg_work_paused_ > 0);
2334 2335
  assert(bg_compaction_paused_ > 0);
  bg_compaction_paused_--;
2336
  bg_work_paused_--;
2337 2338
  // It's sufficient to check just bg_work_paused_ here since
  // bg_work_paused_ is always no greater than bg_compaction_paused_
2339 2340 2341 2342 2343 2344
  if (bg_work_paused_ == 0) {
    MaybeScheduleFlushOrCompaction();
  }
  return Status::OK();
}

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

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

  MutableCFOptions new_options;
2415
  Status s;
2416
  Status persist_options_status;
L
Lei Jin 已提交
2417
  {
2418
    InstrumentedMutexLock l(&mutex_);
2419 2420
    s = cfd->SetOptions(options_map);
    if (s.ok()) {
L
Lei Jin 已提交
2421
      new_options = *cfd->GetLatestMutableCFOptions();
2422 2423 2424 2425
      // Append new version to recompute compaction score.
      VersionEdit dummy_edit;
      versions_->LogAndApply(cfd, new_options, &dummy_edit, &mutex_,
                             directories_.GetDbDir());
2426 2427 2428 2429 2430 2431
      // 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;
2432

2433
      persist_options_status = PersistOptions();
2434 2435
    }
  }
L
Lei Jin 已提交
2436

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

2526 2527 2528 2529 2530 2531 2532 2533 2534
Status DBImpl::PersistOptions() {
  mutex_.AssertHeld();
  WriteThread::Writer w;
  write_thread_.EnterUnbatched(&w, &mutex_);
  Status s = WriteOptionsFile();
  write_thread_.ExitUnbatched(&w);
  return s;
}

2535
// return the same level if it cannot be moved
2536 2537
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd,
    const MutableCFOptions& mutable_cf_options, int level) {
2538
  mutex_.AssertHeld();
S
sdong 已提交
2539
  const auto* vstorage = cfd->current()->storage_info();
2540
  int minimum_level = level;
2541
  for (int i = level - 1; i > 0; --i) {
2542
    // stop if level i is not empty
S
sdong 已提交
2543
    if (vstorage->NumLevelFiles(i) > 0) break;
2544
    // stop if level i is too small (cannot fit the level files)
2545
    if (vstorage->MaxBytesForLevel(i) < vstorage->NumLevelBytes(level)) {
2546 2547
      break;
    }
2548 2549 2550 2551 2552 2553

    minimum_level = i;
  }
  return minimum_level;
}

2554 2555
// REQUIREMENT: block all background work by calling PauseBackgroundWork()
// before calling this function
I
Igor Canadi 已提交
2556 2557
Status DBImpl::ReFitLevel(ColumnFamilyData* cfd, int level, int target_level) {
  assert(level < cfd->NumberLevels());
2558 2559 2560
  if (target_level >= cfd->NumberLevels()) {
    return Status::InvalidArgument("Target level exceeds number of levels");
  }
2561

2562 2563 2564 2565
  std::unique_ptr<SuperVersion> superversion_to_free;
  std::unique_ptr<SuperVersion> new_superversion(new SuperVersion());

  Status status;
I
Igor Canadi 已提交
2566

I
Islam AbdelRahman 已提交
2567
  InstrumentedMutexLock guard_lock(&mutex_);
2568 2569 2570

  // only allow one thread refitting
  if (refitting_level_) {
2571
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2572
        "[ReFitLevel] another thread is refitting");
L
Lei Jin 已提交
2573
    return Status::NotSupported("another thread is refitting");
2574 2575 2576
  }
  refitting_level_ = true;

2577
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
2578
  // move to a smaller level
2579 2580
  int to_level = target_level;
  if (target_level < 0) {
2581
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
2582
  }
2583

2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598
  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) {
2599
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2600 2601
        "[%s] Before refitting:\n%s", cfd->GetName().c_str(),
        cfd->current()->DebugString().data());
2602

2603
    VersionEdit edit;
I
Igor Canadi 已提交
2604
    edit.SetColumnFamily(cfd->GetID());
2605
    for (const auto& f : vstorage->LevelFiles(level)) {
2606
      edit.DeleteFile(level, f->fd.GetNumber());
2607 2608
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
2609 2610
                   f->smallest_seqno, f->largest_seqno,
                   f->marked_for_compaction);
2611
    }
2612
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2613 2614
        "[%s] Apply version edit:\n%s", cfd->GetName().c_str(),
        edit.DebugString().data());
2615

2616 2617
    status = versions_->LogAndApply(cfd, mutable_cf_options, &edit, &mutex_,
                                    directories_.GetDbDir());
2618 2619
    superversion_to_free.reset(InstallSuperVersionAndScheduleWork(
        cfd, new_superversion.release(), mutable_cf_options));
2620

2621
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2622
        "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
2623
        status.ToString().data());
2624 2625

    if (status.ok()) {
2626
      Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2627 2628
          "[%s] After refitting:\n%s", cfd->GetName().c_str(),
          cfd->current()->DebugString().data());
2629 2630 2631 2632
    }
  }

  refitting_level_ = false;
I
Igor Canadi 已提交
2633

L
Lei Jin 已提交
2634
  return status;
G
Gabor Cselle 已提交
2635 2636
}

2637 2638 2639
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
2640 2641
}

2642
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
2643
  return 0;
2644 2645
}

2646 2647
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
2648
  InstrumentedMutexLock l(&mutex_);
L
Lei Jin 已提交
2649 2650
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.level0_stop_writes_trigger;
2651 2652
}

L
Lei Jin 已提交
2653
Status DBImpl::Flush(const FlushOptions& flush_options,
2654 2655
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
2656
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
2657 2658
}

2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679
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(
2680 2681 2682 2683
            "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());
2684 2685 2686 2687 2688 2689 2690
      }
    }
    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;
2691
      logs_to_sync.push_back(log.writer);
2692 2693 2694 2695 2696
    }

    need_log_dir_sync = !log_dir_synced_;
  }

2697
  RecordTick(stats_, WAL_FILE_SYNCED);
2698 2699
  Status status;
  for (log::Writer* log : logs_to_sync) {
2700
    status = log->file()->SyncWithoutFlush(immutable_db_options_.use_fsync);
2701 2702 2703 2704 2705 2706 2707 2708
    if (!status.ok()) {
      break;
    }
  }
  if (status.ok() && need_log_dir_sync) {
    status = directories_.GetWalDir()->Fsync();
  }

2709
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:1");
2710 2711 2712 2713
  {
    InstrumentedMutexLock l(&mutex_);
    MarkLogsSynced(current_log_number, need_log_dir_sync, status);
  }
2714
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:2");
2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730

  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) {
2731
      logs_to_free_.push_back(log.ReleaseWriter());
A
Andres Noetzli 已提交
2732
      it = logs_.erase(it);
2733 2734 2735 2736 2737
    } else {
      log.getting_synced = false;
      ++it;
    }
  }
2738 2739
  assert(logs_.empty() || logs_[0].number > up_to ||
         (logs_.size() == 1 && !logs_[0].getting_synced));
2740 2741 2742
  log_sync_cv_.SignalAll();
}

2743
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
2744 2745 2746
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
2747
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
2748
                                   int output_level, uint32_t output_path_id,
2749
                                   const Slice* begin, const Slice* end,
2750
                                   bool exclusive, bool disallow_trivial_move) {
2751 2752
  assert(input_level == ColumnFamilyData::kCompactAllLevels ||
         input_level >= 0);
2753

G
Gabor Cselle 已提交
2754
  InternalKey begin_storage, end_storage;
2755
  CompactionArg* ca;
G
Gabor Cselle 已提交
2756

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

2788 2789
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:0");
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:1");
2790
  InstrumentedMutexLock l(&mutex_);
2791

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

2806 2807 2808 2809
  AddManualCompaction(&manual);
  TEST_SYNC_POINT_CALLBACK("DBImpl::RunManualCompaction:NotScheduled", &mutex_);
  if (exclusive) {
    while (bg_compaction_scheduled_ > 0) {
2810
      Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2811 2812 2813 2814 2815
          "[%s] Manual compaction waiting for all other scheduled background "
          "compactions to finish",
          cfd->GetName().c_str());
      bg_cv_.Wait();
    }
2816
  }
2817

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

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

2863
  assert(!manual.in_progress);
2864 2865
  assert(HasPendingManualCompaction());
  RemoveManualCompaction(&manual);
2866
  bg_cv_.SignalAll();
L
Lei Jin 已提交
2867
  return manual.status;
J
jorlow@chromium.org 已提交
2868 2869
}

2870
InternalIterator* DBImpl::NewInternalIterator(
A
Andrew Kryczka 已提交
2871 2872
    Arena* arena, RangeDelAggregator* range_del_agg,
    ColumnFamilyHandle* column_family) {
2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884
  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;
A
Andrew Kryczka 已提交
2885 2886
  return NewInternalIterator(roptions, cfd, super_version, arena,
                             range_del_agg);
2887 2888
}

2889
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
2890 2891
                             const FlushOptions& flush_options,
                             bool writes_stopped) {
S
Stanislau Hlebik 已提交
2892 2893 2894
  Status s;
  {
    WriteContext context;
2895
    InstrumentedMutexLock guard_lock(&mutex_);
2896

2897
    if (cfd->imm()->NumNotFlushed() == 0 && cfd->mem()->IsEmpty()) {
2898 2899 2900 2901
      // Nothing to flush
      return Status::OK();
    }

2902
    WriteThread::Writer w;
2903 2904 2905
    if (!writes_stopped) {
      write_thread_.EnterUnbatched(&w, &mutex_);
    }
S
Stanislau Hlebik 已提交
2906

I
Igor Canadi 已提交
2907
    // SwitchMemtable() will release and reacquire mutex
S
Stanislau Hlebik 已提交
2908
    // during execution
I
Igor Canadi 已提交
2909
    s = SwitchMemtable(cfd, &context);
2910 2911 2912 2913

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

S
Stanislau Hlebik 已提交
2915 2916
    cfd->imm()->FlushRequested();

2917 2918 2919
    // schedule flush
    SchedulePendingFlush(cfd);
    MaybeScheduleFlushOrCompaction();
S
Stanislau Hlebik 已提交
2920
  }
S
Stanislau Hlebik 已提交
2921

L
Lei Jin 已提交
2922
  if (s.ok() && flush_options.wait) {
2923
    // Wait until the compaction completes
2924
    s = WaitForFlushMemTable(cfd);
2925 2926
  }
  return s;
J
jorlow@chromium.org 已提交
2927 2928
}

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

2945 2946 2947 2948
Status DBImpl::EnableAutoCompaction(
    const std::vector<ColumnFamilyHandle*>& column_family_handles) {
  Status s;
  for (auto cf_ptr : column_family_handles) {
2949 2950
    Status status =
        this->SetOptions(cf_ptr, {{"disable_auto_compactions", "false"}});
2951
    if (!status.ok()) {
2952
      s = status;
2953 2954 2955 2956 2957 2958
    }
  }

  return s;
}

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

2973
  while (unscheduled_flushes_ > 0 &&
2974
         bg_flush_scheduled_ < immutable_db_options_.max_background_flushes) {
2975 2976
    unscheduled_flushes_--;
    bg_flush_scheduled_++;
2977
    env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH, this);
2978 2979
  }

2980 2981
  auto bg_compactions_allowed = BGCompactionsAllowed();

2982 2983
  // special case -- if max_background_flushes == 0, then schedule flush on a
  // compaction thread
2984
  if (immutable_db_options_.max_background_flushes == 0) {
2985 2986
    while (unscheduled_flushes_ > 0 &&
           bg_flush_scheduled_ + bg_compaction_scheduled_ <
2987
               bg_compactions_allowed) {
2988 2989 2990 2991 2992 2993
      unscheduled_flushes_--;
      bg_flush_scheduled_++;
      env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::LOW, this);
    }
  }

2994 2995 2996 2997 2998
  if (bg_compaction_paused_ > 0) {
    // we paused the background compaction
    return;
  }

2999
  if (HasExclusiveManualCompaction()) {
3000 3001 3002 3003 3004
    // only manual compactions are allowed to run. don't schedule automatic
    // compactions
    return;
  }

3005
  while (bg_compaction_scheduled_ < bg_compactions_allowed &&
3006
         unscheduled_compactions_ > 0) {
3007 3008 3009
    CompactionArg* ca = new CompactionArg;
    ca->db = this;
    ca->m = nullptr;
3010 3011
    bg_compaction_scheduled_++;
    unscheduled_compactions_--;
3012 3013
    env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                   &DBImpl::UnscheduleCallback);
3014 3015 3016
  }
}

3017 3018 3019 3020 3021 3022 3023 3024 3025
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);
}

3026
int DBImpl::BGCompactionsAllowed() const {
3027
  mutex_.AssertHeld();
3028
  if (write_controller_.NeedSpeedupCompaction()) {
3029
    return mutable_db_options_.max_background_compactions;
3030
  } else {
3031
    return mutable_db_options_.base_background_compactions;
3032 3033 3034
  }
}

3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077
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_;
3078 3079 3080
  }
}

3081 3082 3083 3084 3085 3086 3087 3088
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));
}

3089
void DBImpl::BGWorkFlush(void* db) {
3090
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3091
  TEST_SYNC_POINT("DBImpl::BGWorkFlush");
3092
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
3093
  TEST_SYNC_POINT("DBImpl::BGWorkFlush:done");
3094 3095
}

3096 3097 3098
void DBImpl::BGWorkCompaction(void* arg) {
  CompactionArg ca = *(reinterpret_cast<CompactionArg*>(arg));
  delete reinterpret_cast<CompactionArg*>(arg);
3099
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
3100
  TEST_SYNC_POINT("DBImpl::BGWorkCompaction");
3101 3102 3103
  reinterpret_cast<DBImpl*>(ca.db)->BackgroundCallCompaction(ca.m);
}

3104 3105
void DBImpl::BGWorkPurge(void* db) {
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3106
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:start");
3107
  reinterpret_cast<DBImpl*>(db)->BackgroundCallPurge();
3108
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:end");
3109 3110
}

3111 3112 3113 3114 3115 3116 3117
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");
3118 3119
}

3120 3121 3122
void DBImpl::BackgroundCallPurge() {
  mutex_.Lock();

3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134
  // 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();
3135

3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148
      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();
    }
3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159
  }
  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();
}

3160
Status DBImpl::BackgroundFlush(bool* made_progress, JobContext* job_context,
H
Haobo Xu 已提交
3161
                               LogBuffer* log_buffer) {
3162
  mutex_.AssertHeld();
3163

3164 3165 3166 3167 3168 3169 3170
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

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

3173 3174 3175
  ColumnFamilyData* cfd = nullptr;
  while (!flush_queue_.empty()) {
    // This cfd is already referenced
I
Igor Canadi 已提交
3176
    auto first_cfd = PopFirstFromFlushQueue();
3177

I
Igor Canadi 已提交
3178
    if (first_cfd->IsDropped() || !first_cfd->imm()->IsFlushPending()) {
3179
      // can't flush this CF, try next one
I
Igor Canadi 已提交
3180 3181
      if (first_cfd->Unref()) {
        delete first_cfd;
3182 3183
      }
      continue;
3184
    }
3185 3186

    // found a flush!
I
Igor Canadi 已提交
3187
    cfd = first_cfd;
3188 3189 3190 3191 3192 3193 3194 3195 3196
    break;
  }

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

3210
void DBImpl::BackgroundCallFlush() {
3211
  bool made_progress = false;
3212
  JobContext job_context(next_job_id_.fetch_add(1), true);
3213 3214
  assert(bg_flush_scheduled_);

3215 3216
  TEST_SYNC_POINT("DBImpl::BackgroundCallFlush:start");

3217 3218
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
                       immutable_db_options_.info_log.get());
H
Haobo Xu 已提交
3219
  {
3220
    InstrumentedMutexLock l(&mutex_);
3221
    num_running_flushes_++;
H
Haobo Xu 已提交
3222

I
Igor Canadi 已提交
3223 3224 3225
    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

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

I
Igor Canadi 已提交
3246 3247
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

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

3267 3268
    assert(num_running_flushes_ > 0);
    num_running_flushes_--;
H
Haobo Xu 已提交
3269
    bg_flush_scheduled_--;
3270 3271
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
H
Haobo Xu 已提交
3272
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
3273 3274 3275 3276
    // 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.
3277
  }
J
jorlow@chromium.org 已提交
3278 3279
}

3280
void DBImpl::BackgroundCallCompaction(void* arg) {
3281
  bool made_progress = false;
3282
  ManualCompaction* m = reinterpret_cast<ManualCompaction*>(arg);
3283
  JobContext job_context(next_job_id_.fetch_add(1), true);
3284
  TEST_SYNC_POINT("BackgroundCallCompaction:0");
H
Haobo Xu 已提交
3285
  MaybeDumpStats();
3286 3287
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
                       immutable_db_options_.info_log.get());
3288
  {
3289
    InstrumentedMutexLock l(&mutex_);
3290 3291

    // This call will unlock/lock the mutex to wait for current running
3292 3293
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
3294

3295
    num_running_compactions_++;
I
Igor Canadi 已提交
3296 3297 3298 3299

    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

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

I
Igor Canadi 已提交
3323 3324
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

3325 3326 3327 3328
    // 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());
3329 3330

    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
3331
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
3332
      mutex_.Unlock();
3333 3334 3335 3336 3337
      // 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 已提交
3338
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
3339 3340
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
3341
      }
I
Igor Canadi 已提交
3342
      job_context.Clean();
3343 3344
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
3345

3346 3347
    assert(num_running_compactions_ > 0);
    num_running_compactions_--;
3348
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
3349

3350 3351
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

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

3371 3372
Status DBImpl::BackgroundCompaction(bool* made_progress,
                                    JobContext* job_context,
3373 3374 3375
                                    LogBuffer* log_buffer, void* arg) {
  ManualCompaction* manual_compaction =
      reinterpret_cast<ManualCompaction*>(arg);
3376
  *made_progress = false;
J
jorlow@chromium.org 已提交
3377
  mutex_.AssertHeld();
3378
  TEST_SYNC_POINT("DBImpl::BackgroundCompaction:Start");
3379

3380 3381 3382 3383 3384
  bool is_manual = (manual_compaction != nullptr);

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

3386
  CompactionJobStats compaction_job_stats;
3387 3388 3389 3390 3391 3392
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
3393
    if (is_manual) {
3394 3395 3396 3397 3398
      manual_compaction->status = status;
      manual_compaction->done = true;
      manual_compaction->in_progress = false;
      delete manual_compaction->compaction;
      manual_compaction = nullptr;
3399
    }
3400
    return status;
3401 3402
  }

3403 3404
  if (is_manual) {
    // another thread cannot pick up the same work
3405
    manual_compaction->in_progress = true;
3406 3407 3408
  }

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

3450 3451 3452 3453 3454 3455
    if (HaveManualCompaction(cfd)) {
      // Can't compact right now, but try again later
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction()::Conflict");
      return Status::OK();
    }

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

3495
  if (!c) {
H
hans@chromium.org 已提交
3496
    // Nothing to do
3497
    LogToBuffer(log_buffer, "Compaction nothing to do");
3498
  } else if (c->deletion_compaction()) {
I
Igor Canadi 已提交
3499 3500 3501 3502
    // 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);
3503
    assert(c->column_family_data()->ioptions()->compaction_style ==
I
Igor Canadi 已提交
3504
           kCompactionStyleFIFO);
3505 3506 3507

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

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

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

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

3555
    status = versions_->LogAndApply(c->column_family_data(),
3556 3557
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
3558
    // Use latest MutableCFOptions
I
Igor Canadi 已提交
3559 3560
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
3561

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

    // Clear Instrument
    ThreadStatusUtil::ResetThreadStatus();
J
jorlow@chromium.org 已提交
3582
  } else {
3583 3584 3585
    int output_level  __attribute__((unused)) = c->output_level();
    TEST_SYNC_POINT_CALLBACK("DBImpl::BackgroundCompaction:NonTrivial",
                             &output_level);
3586 3587 3588 3589 3590

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

I
Igor Canadi 已提交
3591
    assert(is_snapshot_supported_ || snapshots_.empty());
3592
    CompactionJob compaction_job(
3593
        job_context->job_id, c.get(), immutable_db_options_, env_options_,
I
Igor Canadi 已提交
3594
        versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
3595 3596 3597
        directories_.GetDataDir(c->output_path_id()), stats_, &mutex_,
        &bg_error_, snapshot_seqs, earliest_write_conflict_snapshot,
        table_cache_, &event_logger_,
3598
        c->mutable_cf_options()->paranoid_file_checks,
3599
        c->mutable_cf_options()->report_bg_io_stats, dbname_,
S
sdong 已提交
3600
        &compaction_job_stats);
I
Igor Canadi 已提交
3601
    compaction_job.Prepare();
3602

I
Igor Canadi 已提交
3603
    mutex_.Unlock();
3604
    compaction_job.Run();
3605
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:NonTrivial:AfterRun");
I
Igor Canadi 已提交
3606
    mutex_.Lock();
3607

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

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
3627
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
3628 3629
    // Ignore compaction errors found during shutting down
  } else {
3630 3631 3632
    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 已提交
3633 3634 3635
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
3636 3637

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

3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699
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;
}

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

3769 3770
size_t DBImpl::GetWalPreallocateBlockSize(uint64_t write_buffer_size) const {
  size_t bsize = write_buffer_size / 10 + write_buffer_size;
3771 3772
  // Some users might set very high write_buffer_size and rely on
  // max_total_wal_size or other parameters to control the WAL size.
3773 3774
  if (immutable_db_options_.max_total_wal_size > 0) {
    bsize = std::min<size_t>(bsize, immutable_db_options_.max_total_wal_size);
3775
  }
3776 3777
  if (immutable_db_options_.db_write_buffer_size > 0) {
    bsize = std::min<size_t>(bsize, immutable_db_options_.db_write_buffer_size);
3778
  }
3779 3780 3781 3782
  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());
3783 3784 3785 3786 3787
  }

  return bsize;
}

3788 3789
namespace {
struct IterState {
3790
  IterState(DBImpl* _db, InstrumentedMutex* _mu, SuperVersion* _super_version,
3791
            bool _background_purge)
3792 3793 3794
      : db(_db),
        mu(_mu),
        super_version(_super_version),
3795
        background_purge(_background_purge) {}
3796 3797

  DBImpl* db;
3798
  InstrumentedMutex* mu;
3799
  SuperVersion* super_version;
3800
  bool background_purge;
3801 3802 3803 3804
};

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

3806
  if (state->super_version->Unref()) {
3807 3808 3809
    // Job id == 0 means that this is not our background process, but rather
    // user thread
    JobContext job_context(0);
3810

3811 3812
    state->mu->Lock();
    state->super_version->Cleanup();
I
Igor Canadi 已提交
3813
    state->db->FindObsoleteFiles(&job_context, false, true);
3814 3815 3816
    if (state->background_purge) {
      state->db->ScheduleBgLogWriterClose(&job_context);
    }
3817 3818 3819
    state->mu->Unlock();

    delete state->super_version;
I
Igor Canadi 已提交
3820
    if (job_context.HaveSomethingToDelete()) {
3821
      if (state->background_purge) {
3822 3823 3824 3825 3826 3827 3828 3829 3830 3831
        // 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);
      }
3832
    }
I
Igor Canadi 已提交
3833
    job_context.Clean();
I
Igor Canadi 已提交
3834
  }
T
Tomislav Novak 已提交
3835

3836 3837
  delete state;
}
H
Hans Wennborg 已提交
3838
}  // namespace
3839

A
Andrew Kryczka 已提交
3840 3841 3842 3843
InternalIterator* DBImpl::NewInternalIterator(
    const ReadOptions& read_options, ColumnFamilyData* cfd,
    SuperVersion* super_version, Arena* arena,
    RangeDelAggregator* range_del_agg) {
S
sdong 已提交
3844
  InternalIterator* internal_iter;
3845
  assert(arena != nullptr);
A
Andrew Kryczka 已提交
3846
  assert(range_del_agg != nullptr);
3847
  // Need to create internal iterator from the arena.
3848 3849 3850 3851
  MergeIteratorBuilder merge_iter_builder(
      &cfd->internal_comparator(), arena,
      !read_options.total_order_seek &&
          cfd->ioptions()->prefix_extractor != nullptr);
3852 3853
  // Collect iterator for mutable mem
  merge_iter_builder.AddIterator(
L
Lei Jin 已提交
3854
      super_version->mem->NewIterator(read_options, arena));
A
Andrew Kryczka 已提交
3855 3856 3857 3858 3859 3860 3861
  ScopedArenaIterator range_del_iter;
  Status s;
  if (!read_options.ignore_range_deletions) {
    range_del_iter.set(
        super_version->mem->NewRangeTombstoneIterator(read_options, arena));
    s = range_del_agg->AddTombstones(std::move(range_del_iter));
  }
3862
  // Collect all needed child iterators for immutable memtables
A
Andrew Kryczka 已提交
3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882
  if (s.ok()) {
    super_version->imm->AddIterators(read_options, &merge_iter_builder);
    if (!read_options.ignore_range_deletions) {
      s = super_version->imm->AddRangeTombstoneIterators(read_options, arena,
                                                         range_del_agg);
    }
  }
  if (s.ok()) {
    // Collect iterators for files in L0 - Ln
    super_version->current->AddIterators(read_options, env_options_,
                                         &merge_iter_builder, range_del_agg);
    internal_iter = merge_iter_builder.Finish();
    IterState* cleanup =
        new IterState(this, &mutex_, super_version,
                      read_options.background_purge_on_iterator_cleanup);
    internal_iter->RegisterCleanup(CleanupIteratorState, cleanup, nullptr);

    return internal_iter;
  }
  return NewErrorInternalIterator(s);
J
jorlow@chromium.org 已提交
3883 3884
}

3885 3886 3887 3888
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
3889
Status DBImpl::Get(const ReadOptions& read_options,
3890
                   ColumnFamilyHandle* column_family, const Slice& key,
J
jorlow@chromium.org 已提交
3891
                   std::string* value) {
L
Lei Jin 已提交
3892
  return GetImpl(read_options, column_family, key, value);
3893 3894
}

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

I
Igor Canadi 已提交
3917
SuperVersion* DBImpl::InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
3918
    ColumnFamilyData* cfd, SuperVersion* new_sv,
I
Igor Canadi 已提交
3919
    const MutableCFOptions& mutable_cf_options) {
L
Lei Jin 已提交
3920
  mutex_.AssertHeld();
3921 3922 3923 3924 3925 3926 3927 3928 3929

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

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

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

3953 3954 3955
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

3956
  SequenceNumber snapshot;
L
Lei Jin 已提交
3957 3958 3959
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
3960 3961
  } else {
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
3962
  }
3963
  // Acquire SuperVersion
3964
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
3965
  // Prepare to store a list of merge operations if merge occurs.
3966
  MergeContext merge_context;
A
Andrew Kryczka 已提交
3967
  RangeDelAggregator range_del_agg(cfd->internal_comparator(), {snapshot});
3968

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

3976 3977 3978 3979
  bool skip_memtable =
      (read_options.read_tier == kPersistedTier && has_unpersisted_data_);
  bool done = false;
  if (!skip_memtable) {
A
Andrew Kryczka 已提交
3980 3981
    if (sv->mem->Get(lkey, value, &s, &merge_context, &range_del_agg,
                     read_options)) {
3982 3983
      done = true;
      RecordTick(stats_, MEMTABLE_HIT);
A
Andrew Kryczka 已提交
3984 3985 3986
    } else if ((s.ok() || s.IsMergeInProgress()) &&
               sv->imm->Get(lkey, value, &s, &merge_context, &range_del_agg,
                            read_options)) {
3987 3988 3989
      done = true;
      RecordTick(stats_, MEMTABLE_HIT);
    }
A
Andrew Kryczka 已提交
3990 3991 3992
    if (!done && !s.ok() && !s.IsMergeInProgress()) {
      return s;
    }
3993 3994
  }
  if (!done) {
3995
    PERF_TIMER_GUARD(get_from_output_files_time);
L
Lei Jin 已提交
3996
    sv->current->Get(read_options, lkey, value, &s, &merge_context,
A
Andrew Kryczka 已提交
3997
                     &range_del_agg, value_found);
L
Lei Jin 已提交
3998
    RecordTick(stats_, MEMTABLE_MISS);
3999
  }
4000

4001 4002
  {
    PERF_TIMER_GUARD(get_post_process_time);
4003

4004
    ReturnAndCleanupSuperVersion(cfd, sv);
4005

4006 4007
    RecordTick(stats_, NUMBER_KEYS_READ);
    RecordTick(stats_, BYTES_READ, value->size());
4008
    MeasureTime(stats_, BYTES_PER_READ, value->size());
4009
  }
4010
  return s;
J
jorlow@chromium.org 已提交
4011 4012
}

4013
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
4014
    const ReadOptions& read_options,
4015
    const std::vector<ColumnFamilyHandle*>& column_family,
4016
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
4017

L
Lei Jin 已提交
4018
  StopWatch sw(env_, stats_, DB_MULTIGET);
4019
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
4020

4021
  SequenceNumber snapshot;
4022

4023
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
4024
    ColumnFamilyData* cfd;
4025 4026 4027 4028 4029
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
4030 4031 4032 4033 4034 4035
    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});
4036 4037 4038
    }
  }

4039
  mutex_.Lock();
L
Lei Jin 已提交
4040 4041 4042
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
4043 4044 4045
  } else {
    snapshot = versions_->LastSequence();
  }
4046
  for (auto mgd_iter : multiget_cf_data) {
4047 4048
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
4049
  }
4050
  mutex_.Unlock();
4051

4052 4053
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
4054

4055
  // Note: this always resizes the values array
4056 4057 4058
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
4059 4060

  // Keep track of bytes that we read for statistics-recording later
4061
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
4062
  PERF_TIMER_STOP(get_snapshot_time);
4063 4064 4065 4066

  // 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.
4067
  // merge_operands will contain the sequence of merges in the latter case.
4068
  for (size_t i = 0; i < num_keys; ++i) {
4069
    merge_context.Clear();
4070
    Status& s = stat_list[i];
4071 4072 4073
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
4074
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
A
Andrew Kryczka 已提交
4075 4076
    RangeDelAggregator range_del_agg(cfh->cfd()->internal_comparator(),
                                     {snapshot});
4077
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
4078 4079 4080
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
4081 4082 4083 4084
    bool skip_memtable =
        (read_options.read_tier == kPersistedTier && has_unpersisted_data_);
    bool done = false;
    if (!skip_memtable) {
A
Andrew Kryczka 已提交
4085 4086
      if (super_version->mem->Get(lkey, value, &s, &merge_context,
                                  &range_del_agg, read_options)) {
4087 4088
        done = true;
        // TODO(?): RecordTick(stats_, MEMTABLE_HIT)?
A
Andrew Kryczka 已提交
4089 4090
      } else if (super_version->imm->Get(lkey, value, &s, &merge_context,
                                         &range_del_agg, read_options)) {
4091 4092 4093 4094 4095
        done = true;
        // TODO(?): RecordTick(stats_, MEMTABLE_HIT)?
      }
    }
    if (!done) {
4096
      PERF_TIMER_GUARD(get_from_output_files_time);
A
Andrew Kryczka 已提交
4097 4098
      super_version->current->Get(read_options, lkey, value, &s, &merge_context,
                                  &range_del_agg);
4099
      // TODO(?): RecordTick(stats_, MEMTABLE_MISS)?
4100 4101 4102
    }

    if (s.ok()) {
4103
      bytes_read += value->size();
4104 4105 4106 4107
    }
  }

  // Post processing (decrement reference counts and record statistics)
4108
  PERF_TIMER_GUARD(get_post_process_time);
4109 4110
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
4111
  // TODO(icanadi) do we need lock here or just around Cleanup()?
4112 4113 4114 4115 4116 4117
  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);
4118 4119
    }
  }
4120 4121 4122 4123 4124 4125 4126
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
4127
  }
4128

L
Lei Jin 已提交
4129 4130 4131
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
4132
  MeasureTime(stats_, BYTES_PER_MULTIGET, bytes_read);
L
Lei Jin 已提交
4133
  PERF_TIMER_STOP(get_post_process_time);
4134

4135
  return stat_list;
4136 4137
}

L
Lei Jin 已提交
4138
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
4139
                                  const std::string& column_family_name,
4140
                                  ColumnFamilyHandle** handle) {
Y
Yueh-Hsuan Chiang 已提交
4141
  Status s;
4142
  Status persist_options_status;
I
Igor Canadi 已提交
4143
  *handle = nullptr;
4144 4145

  s = CheckCompressionSupported(cf_options);
4146
  if (s.ok() && immutable_db_options_.allow_concurrent_memtable_write) {
4147 4148
    s = CheckConcurrentWritesSupported(cf_options);
  }
4149 4150 4151 4152
  if (!s.ok()) {
    return s;
  }

Y
Yueh-Hsuan Chiang 已提交
4153
  {
4154
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
4155

Y
Yueh-Hsuan Chiang 已提交
4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168
    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 已提交
4169
    {  // write thread
4170 4171
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
I
Igor Canadi 已提交
4172 4173
      // LogAndApply will both write the creation in MANIFEST and create
      // ColumnFamilyData object
4174 4175 4176
      s = versions_->LogAndApply(nullptr, MutableCFOptions(cf_options), &edit,
                                 &mutex_, directories_.GetDbDir(), false,
                                 &cf_options);
4177 4178 4179 4180 4181 4182

      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();
      }
4183
      write_thread_.ExitUnbatched(&w);
I
Igor Canadi 已提交
4184
    }
Y
Yueh-Hsuan Chiang 已提交
4185 4186 4187 4188 4189
    if (s.ok()) {
      single_column_family_mode_ = false;
      auto* cfd =
          versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
      assert(cfd != nullptr);
I
Igor Canadi 已提交
4190
      delete InstallSuperVersionAndScheduleWork(
Y
Yueh-Hsuan Chiang 已提交
4191
          cfd, nullptr, *cfd->GetLatestMutableCFOptions());
S
sdong 已提交
4192 4193 4194 4195 4196

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

Y
Yueh-Hsuan Chiang 已提交
4197
      *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
4198 4199 4200
      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 已提交
4201
    } else {
4202
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
Y
Yueh-Hsuan Chiang 已提交
4203 4204 4205
          "Creating column family [%s] FAILED -- %s",
          column_family_name.c_str(), s.ToString().c_str());
    }
4206
  }  // InstrumentedMutexLock l(&mutex_)
Y
Yueh-Hsuan Chiang 已提交
4207 4208

  // this is outside the mutex
4209
  if (s.ok()) {
4210 4211
    NewThreadStatusCfInfo(
        reinterpret_cast<ColumnFamilyHandleImpl*>(*handle)->cfd());
4212
    if (!persist_options_status.ok()) {
4213
      if (immutable_db_options_.fail_if_options_file_error) {
4214 4215 4216 4217 4218
        s = Status::IOError(
            "ColumnFamily has been created, but unable to persist"
            "options in CreateColumnFamily()",
            persist_options_status.ToString().c_str());
      }
4219
      Warn(immutable_db_options_.info_log,
4220 4221 4222
           "Unable to persist options in CreateColumnFamily() -- %s",
           persist_options_status.ToString().c_str());
    }
4223
  }
4224
  return s;
4225 4226
}

4227 4228 4229 4230
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
4231 4232
    return Status::InvalidArgument("Can't drop default column family");
  }
4233

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

I
Igor Canadi 已提交
4236 4237
  VersionEdit edit;
  edit.DropColumnFamily();
4238 4239
  edit.SetColumnFamily(cfd->GetID());

4240
  Status s;
4241
  Status options_persist_status;
4242
  {
4243
    InstrumentedMutexLock l(&mutex_);
4244 4245 4246 4247
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
4248
      // we drop column family from a single write thread
4249 4250
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
4251 4252
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
4253 4254 4255 4256 4257
      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();
      }
4258
      write_thread_.ExitUnbatched(&w);
4259
    }
S
sdong 已提交
4260 4261 4262 4263 4264 4265

    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()) {
4266
        if (!c->IsDropped() && !c->mem()->IsSnapshotSupported()) {
S
sdong 已提交
4267 4268 4269 4270 4271 4272
          new_is_snapshot_supported = false;
          break;
        }
      }
      is_snapshot_supported_ = new_is_snapshot_supported;
    }
4273
  }
4274

4275
  if (s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
4276 4277 4278 4279
    // 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 已提交
4280
    assert(cfd->IsDropped());
L
Lei Jin 已提交
4281 4282 4283
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ -= mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
4284
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
4285 4286
        "Dropped column family with id %u\n", cfd->GetID());

4287
    if (!options_persist_status.ok()) {
4288
      if (immutable_db_options_.fail_if_options_file_error) {
4289 4290 4291 4292 4293
        s = Status::IOError(
            "ColumnFamily has been dropped, but unable to persist "
            "options in DropColumnFamily()",
            options_persist_status.ToString().c_str());
      }
4294
      Warn(immutable_db_options_.info_log,
4295 4296 4297
           "Unable to persist options in DropColumnFamily() -- %s",
           options_persist_status.ToString().c_str());
    }
4298
  } else {
4299 4300 4301
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
        "Dropping column family with id %u FAILED -- %s\n", cfd->GetID(),
        s.ToString().c_str());
4302 4303
  }

4304
  return s;
4305 4306
}

L
Lei Jin 已提交
4307
bool DBImpl::KeyMayExist(const ReadOptions& read_options,
4308 4309
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
4310
  if (value_found != nullptr) {
K
Kai Liu 已提交
4311 4312
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
4313
  }
L
Lei Jin 已提交
4314
  ReadOptions roptions = read_options;
4315
  roptions.read_tier = kBlockCacheTier; // read from block cache only
4316
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
4317

4318
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
4319 4320 4321
  // 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();
4322 4323
}

4324
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
4325
                              ColumnFamilyHandle* column_family) {
4326 4327 4328 4329
  if (read_options.read_tier == kPersistedTier) {
    return NewErrorIterator(Status::NotSupported(
        "ReadTier::kPersistedData is not yet supported in iterators."));
  }
4330 4331
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
T
Tomislav Novak 已提交
4332

V
Venkatesh Radhakrishnan 已提交
4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350
  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 已提交
4351 4352 4353 4354
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
4355 4356
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
    auto iter = new ForwardIterator(this, read_options, cfd, sv);
4357 4358
    return NewDBIterator(
        env_, *cfd->ioptions(), cfd->user_comparator(), iter,
4359 4360
        kMaxSequenceNumber,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4361 4362
        sv->version_number, read_options.iterate_upper_bound,
        read_options.prefix_same_as_start, read_options.pin_data);
I
Igor Canadi 已提交
4363
#endif
T
Tomislav Novak 已提交
4364
  } else {
4365
    SequenceNumber latest_snapshot = versions_->LastSequence();
4366
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
4367

I
Igor Canadi 已提交
4368
    auto snapshot =
4369 4370 4371
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
4372
            : latest_snapshot;
T
Tomislav Novak 已提交
4373

4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409
    // 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         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
4410 4411
    // ArenaWrappedDBIter inlines an arena area where all the iterators in
    // the iterator tree are allocated in the order of being accessed when
4412 4413 4414 4415 4416
    // 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(
4417 4418
        env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4419
        sv->version_number, read_options.iterate_upper_bound,
4420 4421
        read_options.prefix_same_as_start, read_options.pin_data,
        read_options.total_order_seek);
4422

S
sdong 已提交
4423
    InternalIterator* internal_iter =
A
Andrew Kryczka 已提交
4424 4425
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena(),
                            db_iter->GetRangeDelAggregator());
4426 4427 4428 4429
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
4430 4431
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
4432 4433
}

4434
Status DBImpl::NewIterators(
4435
    const ReadOptions& read_options,
I
Igor Canadi 已提交
4436
    const std::vector<ColumnFamilyHandle*>& column_families,
4437
    std::vector<Iterator*>* iterators) {
4438 4439 4440 4441
  if (read_options.read_tier == kPersistedTier) {
    return Status::NotSupported(
        "ReadTier::kPersistedData is not yet supported in iterators.");
  }
I
Igor Canadi 已提交
4442 4443
  iterators->clear();
  iterators->reserve(column_families.size());
V
Venkatesh Radhakrishnan 已提交
4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463
  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 已提交
4464 4465 4466 4467
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
4468 4469
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
4470 4471
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
      auto iter = new ForwardIterator(this, read_options, cfd, sv);
4472 4473 4474
      iterators->push_back(NewDBIterator(
          env_, *cfd->ioptions(), cfd->user_comparator(), iter,
          kMaxSequenceNumber,
4475 4476
          sv->mutable_cf_options.max_sequential_skip_in_iterations,
          sv->version_number, nullptr, false, read_options.pin_data));
I
Igor Canadi 已提交
4477
    }
I
Igor Canadi 已提交
4478
#endif
I
Igor Canadi 已提交
4479
  } else {
4480 4481
    SequenceNumber latest_snapshot = versions_->LastSequence();

I
Igor Canadi 已提交
4482
    for (size_t i = 0; i < column_families.size(); ++i) {
4483 4484 4485
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
4486 4487

      auto snapshot =
4488 4489 4490
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
4491 4492
              : latest_snapshot;

4493
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
4494
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
4495 4496
          sv->mutable_cf_options.max_sequential_skip_in_iterations,
          sv->version_number, nullptr, false, read_options.pin_data);
S
sdong 已提交
4497
      InternalIterator* internal_iter =
A
Andrew Kryczka 已提交
4498 4499
          NewInternalIterator(read_options, cfd, sv, db_iter->GetArena(),
                              db_iter->GetRangeDelAggregator());
4500 4501
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
4502 4503 4504 4505
    }
  }

  return Status::OK();
4506 4507
}

4508 4509
const Snapshot* DBImpl::GetSnapshot() { return GetSnapshotImpl(false); }

4510
#ifndef ROCKSDB_LITE
4511 4512 4513
const Snapshot* DBImpl::GetSnapshotForWriteConflictBoundary() {
  return GetSnapshotImpl(true);
}
4514
#endif  // ROCKSDB_LITE
4515 4516

const Snapshot* DBImpl::GetSnapshotImpl(bool is_write_conflict_boundary) {
4517 4518
  int64_t unix_time = 0;
  env_->GetCurrentTime(&unix_time);  // Ignore error
4519
  SnapshotImpl* s = new SnapshotImpl;
4520

4521
  InstrumentedMutexLock l(&mutex_);
4522
  // returns null if the underlying memtable does not support snapshot.
4523 4524 4525 4526
  if (!is_snapshot_supported_) {
    delete s;
    return nullptr;
  }
4527 4528
  return snapshots_.New(s, versions_->LastSequence(), unix_time,
                        is_write_conflict_boundary);
J
jorlow@chromium.org 已提交
4529 4530 4531
}

void DBImpl::ReleaseSnapshot(const Snapshot* s) {
4532 4533 4534 4535 4536 4537
  const SnapshotImpl* casted_s = reinterpret_cast<const SnapshotImpl*>(s);
  {
    InstrumentedMutexLock l(&mutex_);
    snapshots_.Delete(casted_s);
  }
  delete casted_s;
J
jorlow@chromium.org 已提交
4538 4539 4540
}

// Convenience methods
4541 4542
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
4543
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
4544 4545
}

4546 4547 4548
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
4549
  if (!cfh->cfd()->ioptions()->merge_operator) {
4550 4551
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
4552
    return DB::Merge(o, column_family, key, val);
4553 4554 4555
  }
}

L
Lei Jin 已提交
4556
Status DBImpl::Delete(const WriteOptions& write_options,
4557
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
4558
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
4559 4560
}

A
Andres Noetzli 已提交
4561 4562 4563 4564 4565 4566
Status DBImpl::SingleDelete(const WriteOptions& write_options,
                            ColumnFamilyHandle* column_family,
                            const Slice& key) {
  return DB::SingleDelete(write_options, column_family, key);
}

L
Lei Jin 已提交
4567
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
4568
  return WriteImpl(write_options, my_batch, nullptr, nullptr);
A
agiardullo 已提交
4569 4570
}

A
agiardullo 已提交
4571
#ifndef ROCKSDB_LITE
A
agiardullo 已提交
4572 4573 4574
Status DBImpl::WriteWithCallback(const WriteOptions& write_options,
                                 WriteBatch* my_batch,
                                 WriteCallback* callback) {
4575
  return WriteImpl(write_options, my_batch, callback, nullptr);
A
agiardullo 已提交
4576
}
A
agiardullo 已提交
4577
#endif  // ROCKSDB_LITE
A
agiardullo 已提交
4578 4579

Status DBImpl::WriteImpl(const WriteOptions& write_options,
4580 4581 4582
                         WriteBatch* my_batch, WriteCallback* callback,
                         uint64_t* log_used, uint64_t log_ref,
                         bool disable_memtable) {
S
Stanislau Hlebik 已提交
4583 4584 4585
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
  }
4586 4587 4588
  if (write_options.timeout_hint_us != 0) {
    return Status::InvalidArgument("timeout_hint_us is deprecated");
  }
A
agiardullo 已提交
4589 4590

  Status status;
A
agiardullo 已提交
4591

A
agiardullo 已提交
4592 4593 4594
  bool xfunc_attempted_write = false;
  XFUNC_TEST("transaction", "transaction_xftest_write_impl",
             xf_transaction_write1, xf_transaction_write, write_options,
4595
             immutable_db_options_, my_batch, callback, this, &status,
A
agiardullo 已提交
4596 4597 4598 4599 4600 4601
             &xfunc_attempted_write);
  if (xfunc_attempted_write) {
    // Test already did the write
    return status;
  }

4602
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
4603
  WriteThread::Writer w;
S
Stanislau Hlebik 已提交
4604
  w.batch = my_batch;
L
Lei Jin 已提交
4605 4606
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
4607
  w.disable_memtable = disable_memtable;
S
Stanislau Hlebik 已提交
4608
  w.in_batch_group = false;
4609
  w.callback = callback;
4610
  w.log_ref = log_ref;
S
Stanislau Hlebik 已提交
4611

L
Lei Jin 已提交
4612
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4613 4614 4615
    RecordTick(stats_, WRITE_WITH_WAL);
  }

4616
  StopWatch write_sw(env_, immutable_db_options_.statistics.get(), DB_WRITE);
4617

4618
  write_thread_.JoinBatchGroup(&w);
4619 4620 4621 4622
  if (w.state == WriteThread::STATE_PARALLEL_FOLLOWER) {
    // we are a non-leader in a parallel group
    PERF_TIMER_GUARD(write_memtable_time);

4623 4624 4625 4626 4627
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }

    if (w.ShouldWriteToMemtable()) {
4628 4629 4630 4631
      ColumnFamilyMemTablesImpl column_family_memtables(
          versions_->GetColumnFamilySet());
      WriteBatchInternal::SetSequence(w.batch, w.sequence);
      w.status = WriteBatchInternal::InsertInto(
4632
          &w, &column_family_memtables, &flush_scheduler_,
4633
          write_options.ignore_missing_column_families, 0 /*log_number*/, this,
S
sdong 已提交
4634
          true /*concurrent_memtable_writes*/);
4635
    }
4636 4637 4638

    if (write_thread_.CompleteParallelWorker(&w)) {
      // we're responsible for early exit
4639
      auto last_sequence = w.parallel_group->last_sequence;
4640 4641 4642 4643 4644 4645
      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
4646 4647

    status = w.FinalStatus();
4648 4649
  }
  if (w.state == WriteThread::STATE_COMPLETED) {
4650 4651 4652
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }
4653
    // write is complete and leader has updated sequence
4654
    RecordTick(stats_, WRITE_DONE_BY_OTHER);
4655
    return w.FinalStatus();
4656 4657
  }
  // else we are the leader of the write batch group
4658
  assert(w.state == WriteThread::STATE_GROUP_LEADER);
4659

S
Stanislau Hlebik 已提交
4660 4661
  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4662 4663 4664 4665 4666

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

S
Stanislau Hlebik 已提交
4667 4668
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
4669

4670 4671 4672 4673
  // 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.
4674 4675 4676
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

4677
  uint64_t max_total_wal_size = (immutable_db_options_.max_total_wal_size == 0)
4678
                                    ? 4 * max_total_in_memory_state_
4679
                                    : immutable_db_options_.max_total_wal_size;
4680 4681 4682
  if (UNLIKELY(!single_column_family_mode_ &&
               alive_log_files_.begin()->getting_flushed == false &&
               total_log_size_ > max_total_wal_size)) {
I
Igor Canadi 已提交
4683
    uint64_t flush_column_family_if_log_file = alive_log_files_.begin()->number;
I
Igor Canadi 已提交
4684
    alive_log_files_.begin()->getting_flushed = true;
4685
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
4686 4687 4688
        "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 已提交
4689 4690
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4691
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4692 4693 4694
      if (cfd->IsDropped()) {
        continue;
      }
I
Igor Canadi 已提交
4695
      if (cfd->GetLogNumber() <= flush_column_family_if_log_file) {
I
Igor Canadi 已提交
4696
        status = SwitchMemtable(cfd, &context);
I
Igor Canadi 已提交
4697 4698 4699
        if (!status.ok()) {
          break;
        }
S
Stanislau Hlebik 已提交
4700
        cfd->imm()->FlushRequested();
4701
        SchedulePendingFlush(cfd);
4702
      }
4703
    }
I
Igor Canadi 已提交
4704
    MaybeScheduleFlushOrCompaction();
4705 4706 4707 4708 4709 4710
  } 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.
4711
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
4712 4713
        "Flushing column family with largest mem table size. Write buffer is "
        "using %" PRIu64 " bytes out of a total of %" PRIu64 ".",
4714 4715
        write_buffer_manager_->memory_usage(),
        write_buffer_manager_->buffer_size());
4716 4717
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4718 4719 4720
    ColumnFamilyData* largest_cfd = nullptr;
    size_t largest_cfd_size = 0;

4721
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4722 4723 4724
      if (cfd->IsDropped()) {
        continue;
      }
4725
      if (!cfd->mem()->IsEmpty()) {
4726 4727 4728 4729 4730 4731
        // 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;
4732 4733 4734
        }
      }
    }
4735 4736 4737 4738 4739 4740 4741 4742
    if (largest_cfd != nullptr) {
      status = SwitchMemtable(largest_cfd, &context);
      if (status.ok()) {
        largest_cfd->imm()->FlushRequested();
        SchedulePendingFlush(largest_cfd);
        MaybeScheduleFlushOrCompaction();
      }
    }
I
Igor Canadi 已提交
4743 4744 4745 4746 4747 4748 4749 4750 4751 4752
  }

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

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

4753 4754
  if (UNLIKELY(status.ok() && (write_controller_.IsStopped() ||
                               write_controller_.NeedsDelay()))) {
4755 4756
    PERF_TIMER_STOP(write_pre_and_post_process_time);
    PERF_TIMER_GUARD(write_delay_time);
S
sdong 已提交
4757 4758 4759 4760
    // 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.
4761
    status = DelayWrite(last_batch_group_size_);
4762
    PERF_TIMER_START(write_pre_and_post_process_time);
I
Igor Canadi 已提交
4763 4764
  }

D
dgrogan@chromium.org 已提交
4765
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4766
  WriteThread::Writer* last_writer = &w;
4767
  autovector<WriteThread::Writer*> write_group;
4768 4769
  bool need_log_sync = !write_options.disableWAL && write_options.sync;
  bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
A
agiardullo 已提交
4770

S
Stanislau Hlebik 已提交
4771
  if (status.ok()) {
4772
    if (need_log_sync) {
4773 4774 4775 4776 4777 4778 4779 4780 4781
      while (logs_.front().getting_synced) {
        log_sync_cv_.Wait();
      }
      for (auto& log : logs_) {
        assert(!log.getting_synced);
        log.getting_synced = true;
      }
    }

4782 4783 4784
    // 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
4785
    // into memtables
A
agiardullo 已提交
4786 4787
  }

4788 4789
  mutex_.Unlock();

A
agiardullo 已提交
4790 4791
  // At this point the mutex is unlocked

4792
  bool exit_completed_early = false;
4793 4794
  last_batch_group_size_ =
      write_thread_.EnterAsBatchGroupLeader(&w, &last_writer, &write_group);
4795

A
agiardullo 已提交
4796
  if (status.ok()) {
4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809
    // 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.
4810 4811
    bool parallel = immutable_db_options_.allow_concurrent_memtable_write &&
                    write_group.size() > 1;
4812 4813
    int total_count = 0;
    uint64_t total_byte_size = 0;
4814 4815
    for (auto writer : write_group) {
      if (writer->CheckCallback(this)) {
4816 4817 4818 4819 4820 4821 4822 4823 4824
        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));
        }
4825
      }
4826 4827 4828 4829 4830 4831 4832 4833
    }

    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);
4834
    MeasureTime(stats_, BYTES_PER_WRITE, total_byte_size);
4835
    PERF_TIMER_STOP(write_pre_and_post_process_time);
4836

4837
    if (write_options.disableWAL) {
4838
      has_unpersisted_data_ = true;
4839
    }
4840

4841 4842 4843
    uint64_t log_size = 0;
    if (!write_options.disableWAL) {
      PERF_TIMER_GUARD(write_wal_time);
4844

4845
      WriteBatch* merged_batch = nullptr;
4846 4847 4848 4849 4850
      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
4851
        merged_batch = write_group[0]->batch;
4852
        write_group[0]->log_used = logfile_number_;
4853 4854 4855 4856 4857
      } 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_;
4858
        for (auto writer : write_group) {
4859
          if (writer->ShouldWriteToWAL()) {
4860 4861
            WriteBatchInternal::Append(merged_batch, writer->batch,
                                       /*WAL_only*/ true);
4862
          }
4863
          writer->log_used = logfile_number_;
4864 4865 4866
        }
      }

4867 4868 4869 4870 4871
      if (log_used != nullptr) {
        *log_used = logfile_number_;
      }

      WriteBatchInternal::SetSequence(merged_batch, current_sequence);
4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890

      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_) {
4891
          status = log.writer->file()->Sync(immutable_db_options_.use_fsync);
4892 4893 4894 4895 4896 4897 4898 4899 4900 4901
          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();
        }
4902 4903
      }

4904 4905 4906 4907 4908 4909
      if (merged_batch == &tmp_batch_) {
        tmp_batch_.Clear();
      }
    }
    if (status.ok()) {
      PERF_TIMER_GUARD(write_memtable_time);
4910

4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922
      {
        // 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);
4923
          }
4924
          stats->AddDBStats(InternalStats::WAL_FILE_BYTES, log_size);
4925
        }
4926
        uint64_t for_other = write_group.size() - 1;
4927 4928 4929 4930
        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);
4931
          }
H
heyongqiang 已提交
4932
        }
4933
      }
Y
Yueh-Hsuan Chiang 已提交
4934

4935
      if (!parallel) {
4936
        status = WriteBatchInternal::InsertInto(
4937
            write_group, current_sequence, column_family_memtables_.get(),
4938
            &flush_scheduler_, write_options.ignore_missing_column_families,
S
sdong 已提交
4939
            0 /*log_number*/, this);
4940 4941 4942 4943 4944 4945 4946

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

4947
      } else {
4948
        WriteThread::ParallelGroup pg;
4949 4950
        pg.leader = &w;
        pg.last_writer = last_writer;
4951
        pg.last_sequence = last_sequence;
4952
        pg.early_exit_allowed = !need_log_sync;
4953
        pg.running.store(static_cast<uint32_t>(write_group.size()),
4954
                         std::memory_order_relaxed);
4955 4956
        write_thread_.LaunchParallelFollowers(&pg, current_sequence);

4957
        if (w.ShouldWriteToMemtable()) {
4958 4959 4960 4961 4962 4963
          // do leader write
          ColumnFamilyMemTablesImpl column_family_memtables(
              versions_->GetColumnFamilySet());
          assert(w.sequence == current_sequence);
          WriteBatchInternal::SetSequence(w.batch, w.sequence);
          w.status = WriteBatchInternal::InsertInto(
4964
              &w, &column_family_memtables, &flush_scheduler_,
4965
              write_options.ignore_missing_column_families, 0 /*log_number*/,
S
sdong 已提交
4966
              this, true /*concurrent_memtable_writes*/);
4967 4968
        }

4969 4970 4971
        // CompleteParallelWorker returns true if this thread should
        // handle exit, false means somebody else did
        exit_completed_early = !write_thread_.CompleteParallelWorker(&w);
4972
        status = w.FinalStatus();
4973
      }
A
agiardullo 已提交
4974

4975
      if (!exit_completed_early && w.status.ok()) {
4976 4977 4978
        SetTickerCount(stats_, SEQUENCE_NUMBER, last_sequence);
        versions_->SetLastSequence(last_sequence);
        if (!need_log_sync) {
4979
          write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
4980
          exit_completed_early = true;
4981
        }
4982
      }
4983 4984 4985 4986 4987 4988 4989 4990 4991

      // 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.
4992
      if (!status.ok() && bg_error_.ok() && !w.CallbackFailed()) {
4993
        bg_error_ = status;
4994
      }
4995
    }
4996
  }
4997
  PERF_TIMER_START(write_pre_and_post_process_time);
A
agiardullo 已提交
4998

4999 5000
  if (immutable_db_options_.paranoid_checks && !status.ok() &&
      !w.CallbackFailed() && !status.IsBusy()) {
5001 5002 5003 5004 5005
    mutex_.Lock();
    if (bg_error_.ok()) {
      bg_error_ = status;  // stop compaction & fail any further writes
    }
    mutex_.Unlock();
I
Igor Canadi 已提交
5006
  }
5007

5008
  if (need_log_sync) {
5009
    mutex_.Lock();
5010
    MarkLogsSynced(logfile_number_, need_log_dir_sync, status);
5011
    mutex_.Unlock();
5012 5013
  }

5014
  if (!exit_completed_early) {
5015
    write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
5016
  }
5017

J
jorlow@chromium.org 已提交
5018 5019 5020
  return status;
}

5021 5022
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
5023
Status DBImpl::DelayWrite(uint64_t num_bytes) {
S
sdong 已提交
5024 5025 5026 5027
  uint64_t time_delayed = 0;
  bool delayed = false;
  {
    StopWatch sw(env_, stats_, WRITE_STALL, &time_delayed);
S
sdong 已提交
5028 5029
    auto delay = write_controller_.GetDelay(env_, num_bytes);
    if (delay > 0) {
S
sdong 已提交
5030 5031
      mutex_.Unlock();
      delayed = true;
S
sdong 已提交
5032
      TEST_SYNC_POINT("DBImpl::DelayWrite:Sleep");
5033 5034
      // hopefully we don't have to sleep more than 2 billion microseconds
      env_->SleepForMicroseconds(static_cast<int>(delay));
S
sdong 已提交
5035 5036
      mutex_.Lock();
    }
5037

5038
    while (bg_error_.ok() && write_controller_.IsStopped()) {
S
sdong 已提交
5039
      delayed = true;
5040 5041
      TEST_SYNC_POINT("DBImpl::DelayWrite:Wait");
      bg_cv_.Wait();
5042 5043
    }
  }
S
sdong 已提交
5044 5045 5046 5047 5048
  if (delayed) {
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_STALL_MICROS,
                                           time_delayed);
    RecordTick(stats_, STALL_MICROS, time_delayed);
  }
I
Igor Canadi 已提交
5049 5050

  return bg_error_;
5051 5052
}

I
Igor Canadi 已提交
5053 5054
Status DBImpl::ScheduleFlushes(WriteContext* context) {
  ColumnFamilyData* cfd;
5055
  while ((cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
5056
    auto status = SwitchMemtable(cfd, context);
I
Igor Canadi 已提交
5057 5058 5059 5060 5061
    if (cfd->Unref()) {
      delete cfd;
    }
    if (!status.ok()) {
      return status;
S
Stanislau Hlebik 已提交
5062 5063
    }
  }
I
Igor Canadi 已提交
5064
  return Status::OK();
S
Stanislau Hlebik 已提交
5065 5066
}

5067 5068 5069
#ifndef ROCKSDB_LITE
void DBImpl::NotifyOnMemTableSealed(ColumnFamilyData* cfd,
                                    const MemTableInfo& mem_table_info) {
5070
  if (immutable_db_options_.listeners.size() == 0U) {
5071 5072 5073 5074 5075 5076
    return;
  }
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }

5077
  for (auto listener : immutable_db_options_.listeners) {
5078
    listener->OnMemTableSealed(mem_table_info);
5079
  }
5080 5081 5082
}
#endif  // ROCKSDB_LITE

S
Stanislau Hlebik 已提交
5083 5084
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
5085
Status DBImpl::SwitchMemtable(ColumnFamilyData* cfd, WriteContext* context) {
S
Stanislau Hlebik 已提交
5086 5087 5088 5089 5090 5091 5092
  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.
5093
  assert(versions_->prev_log_number() == 0);
S
Stanislau Hlebik 已提交
5094
  bool creating_new_log = !log_empty_;
S
Sage Weil 已提交
5095
  uint64_t recycle_log_number = 0;
5096
  if (creating_new_log && immutable_db_options_.recycle_log_file_num &&
S
Sage Weil 已提交
5097 5098 5099 5100
      !log_recycle_files.empty()) {
    recycle_log_number = log_recycle_files.front();
    log_recycle_files.pop_front();
  }
S
Stanislau Hlebik 已提交
5101 5102 5103
  uint64_t new_log_number =
      creating_new_log ? versions_->NewFileNumber() : logfile_number_;
  SuperVersion* new_superversion = nullptr;
5104
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
5105 5106 5107 5108 5109 5110 5111 5112 5113 5114

  // 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
5115 5116 5117
  // 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();
5118 5119
  DBOptions db_options =
      BuildDBOptions(immutable_db_options_, mutable_db_options_);
S
Stanislau Hlebik 已提交
5120 5121 5122 5123
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
5124
      EnvOptions opt_env_opt =
5125
          env_->OptimizeForLogWrite(env_options_, db_options);
S
Sage Weil 已提交
5126
      if (recycle_log_number) {
5127
        Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
S
Sage Weil 已提交
5128 5129
            "reusing log %" PRIu64 " from recycle list\n", recycle_log_number);
        s = env_->ReuseWritableFile(
5130 5131 5132
            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 已提交
5133
      } else {
5134 5135 5136
        s = NewWritableFile(
            env_, LogFileName(immutable_db_options_.wal_dir, new_log_number),
            &lfile, opt_env_opt);
S
Sage Weil 已提交
5137
      }
S
Stanislau Hlebik 已提交
5138 5139 5140
      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 已提交
5141
        lfile->SetPreallocationBlockSize(
5142
            GetWalPreallocateBlockSize(mutable_cf_options.write_buffer_size));
5143 5144
        unique_ptr<WritableFileWriter> file_writer(
            new WritableFileWriter(std::move(lfile), opt_env_opt));
5145 5146 5147
        new_log =
            new log::Writer(std::move(file_writer), new_log_number,
                            immutable_db_options_.recycle_log_file_num > 0);
I
Igor Canadi 已提交
5148
      }
S
Stanislau Hlebik 已提交
5149 5150 5151
    }

    if (s.ok()) {
A
agiardullo 已提交
5152 5153
      SequenceNumber seq = versions_->LastSequence();
      new_mem = cfd->ConstructNewMemtable(mutable_cf_options, seq);
S
Stanislau Hlebik 已提交
5154 5155
      new_superversion = new SuperVersion();
    }
5156 5157 5158 5159 5160 5161 5162

#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 已提交
5163
  }
5164
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
5165 5166
      "[%s] New memtable created with log file: #%" PRIu64
      ". Immutable memtables: %d.\n",
5167
      cfd->GetName().c_str(), new_log_number, num_imm_unflushed);
S
Stanislau Hlebik 已提交
5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179
  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;
5180
    log_dir_synced_ = false;
5181
    logs_.emplace_back(logfile_number_, new_log);
S
Stanislau Hlebik 已提交
5182
    alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
I
Igor Canadi 已提交
5183
    for (auto loop_cfd : *versions_->GetColumnFamilySet()) {
S
Stanislau Hlebik 已提交
5184 5185 5186 5187
      // 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 已提交
5188
      if (loop_cfd->mem()->GetFirstSequenceNumber() == 0 &&
5189
          loop_cfd->imm()->NumNotFlushed() == 0) {
I
Igor Canadi 已提交
5190
        loop_cfd->SetLogNumber(logfile_number_);
5191
      }
5192 5193
    }
  }
S
Stanislau Hlebik 已提交
5194
  cfd->mem()->SetNextLogNumber(logfile_number_);
5195
  cfd->imm()->Add(cfd->mem(), &context->memtables_to_free_);
S
Stanislau Hlebik 已提交
5196 5197
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
I
Igor Canadi 已提交
5198 5199
  context->superversions_to_free_.push_back(InstallSuperVersionAndScheduleWork(
      cfd, new_superversion, mutable_cf_options));
5200 5201 5202
  return s;
}

I
Igor Canadi 已提交
5203
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
5204 5205 5206 5207 5208
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

5209 5210
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
5211
  auto version = cfd->current();
5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
5224 5225

Status DBImpl::GetPropertiesOfTablesInRange(ColumnFamilyHandle* column_family,
5226
                                            const Range* range, std::size_t n,
5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246
                                            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 已提交
5247
#endif  // ROCKSDB_LITE
5248

I
Igor Canadi 已提交
5249 5250 5251 5252
const std::string& DBImpl::GetName() const {
  return dbname_;
}

5253 5254 5255 5256
Env* DBImpl::GetEnv() const {
  return env_;
}

5257 5258
Options DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  InstrumentedMutexLock l(&mutex_);
5259
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
5260 5261
  return Options(BuildDBOptions(immutable_db_options_, mutable_db_options_),
                 cfh->cfd()->GetLatestCFOptions());
I
Igor Canadi 已提交
5262 5263
}

5264 5265 5266 5267
DBOptions DBImpl::GetDBOptions() const {
  InstrumentedMutexLock l(&mutex_);
  return BuildDBOptions(immutable_db_options_, mutable_db_options_);
}
5268

5269
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
5270
                         const Slice& property, std::string* value) {
5271
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
5272
  value->clear();
5273
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5274 5275 5276
  if (property_info == nullptr) {
    return false;
  } else if (property_info->handle_int) {
5277
    uint64_t int_value;
5278 5279
    bool ret_value =
        GetIntPropertyInternal(cfd, *property_info, false, &int_value);
5280
    if (ret_value) {
5281
      *value = ToString(int_value);
5282 5283
    }
    return ret_value;
5284
  } else if (property_info->handle_string) {
5285
    InstrumentedMutexLock l(&mutex_);
5286
    return cfd->internal_stats()->GetStringProperty(*property_info, property,
5287 5288
                                                    value);
  }
5289 5290 5291 5292
  // 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 已提交
5293 5294
}

5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312
bool DBImpl::GetMapProperty(ColumnFamilyHandle* column_family,
                            const Slice& property,
                            std::map<std::string, double>* value) {
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  value->clear();
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  if (property_info == nullptr) {
    return false;
  } else if (property_info->handle_map) {
    InstrumentedMutexLock l(&mutex_);
    return cfd->internal_stats()->GetMapProperty(*property_info, property,
                                                 value);
  }
  // If we reach this point it means that handle_map is not provided for the
  // requested property
  return false;
}

5313 5314
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
5315 5316
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5317 5318
    return false;
  }
5319
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5320
  return GetIntPropertyInternal(cfd, *property_info, false, value);
5321 5322
}

5323
bool DBImpl::GetIntPropertyInternal(ColumnFamilyData* cfd,
5324 5325 5326 5327
                                    const DBPropertyInfo& property_info,
                                    bool is_locked, uint64_t* value) {
  assert(property_info.handle_int != nullptr);
  if (!property_info.need_out_of_mutex) {
5328 5329
    if (is_locked) {
      mutex_.AssertHeld();
5330
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5331 5332
    } else {
      InstrumentedMutexLock l(&mutex_);
5333
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5334
    }
5335
  } else {
5336 5337 5338 5339 5340 5341
    SuperVersion* sv = nullptr;
    if (!is_locked) {
      sv = GetAndRefSuperVersion(cfd);
    } else {
      sv = cfd->GetSuperVersion();
    }
5342 5343

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

5346 5347 5348
    if (!is_locked) {
      ReturnAndCleanupSuperVersion(cfd, sv);
    }
5349 5350 5351 5352 5353

    return ret;
  }
}

5354 5355
bool DBImpl::GetAggregatedIntProperty(const Slice& property,
                                      uint64_t* aggregated_value) {
5356 5357
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5358 5359 5360 5361 5362 5363 5364 5365 5366
    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()) {
5367
      if (GetIntPropertyInternal(cfd, *property_info, true, &value)) {
5368 5369 5370 5371 5372 5373 5374 5375 5376 5377
        sum += value;
      } else {
        return false;
      }
    }
  }
  *aggregated_value = sum;
  return true;
}

5378 5379
SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
I
Igor Canadi 已提交
5380
  return cfd->GetThreadLocalSuperVersion(&mutex_);
5381 5382
}

A
agiardullo 已提交
5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394
// 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 已提交
5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410
// 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);
}

5411 5412
void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
5413
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
5414 5415 5416 5417 5418

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
5419
        InstrumentedMutexLock l(&mutex_);
5420 5421 5422 5423 5424 5425 5426
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
5427 5428
}

A
agiardullo 已提交
5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440
// 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 已提交
5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456
// 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 已提交
5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468
// 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 已提交
5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482
// 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();
}

5483
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
5484 5485
                                 const Range* range, int n, uint64_t* sizes,
                                 bool include_memtable) {
J
jorlow@chromium.org 已提交
5486
  Version* v;
5487 5488
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
5489 5490
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
  v = sv->current;
J
jorlow@chromium.org 已提交
5491 5492 5493

  for (int i = 0; i < n; i++) {
    // Convert user_key into a corresponding internal key.
5494 5495 5496
    InternalKey k1(range[i].start, kMaxSequenceNumber, kValueTypeForSeek);
    InternalKey k2(range[i].limit, kMaxSequenceNumber, kValueTypeForSeek);
    sizes[i] = versions_->ApproximateSize(v, k1.Encode(), k2.Encode());
5497 5498 5499 5500
    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 已提交
5501 5502
  }

5503
  ReturnAndCleanupSuperVersion(cfd, sv);
J
jorlow@chromium.org 已提交
5504 5505
}

I
Igor Canadi 已提交
5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521
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 已提交
5522 5523 5524 5525 5526
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
5527
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
5528 5529 5530
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
I
Igor Canadi 已提交
5531
  return wal_manager_.GetUpdatesSince(seq, iter, read_options, versions_.get());
I
Igor Canadi 已提交
5532 5533
}

5534 5535 5536
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
5537 5538 5539
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
5540
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
5541
        "DeleteFile %s failed.\n", name.c_str());
5542 5543 5544
    return Status::InvalidArgument("Invalid file name");
  }

5545 5546 5547 5548
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
5549 5550
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
          "DeleteFile %s failed - not archived log.\n", name.c_str());
5551 5552
      return Status::NotSupported("Delete only supported for archived logs");
    }
5553 5554
    status =
        env_->DeleteFile(immutable_db_options_.wal_dir + "/" + name.c_str());
5555
    if (!status.ok()) {
5556 5557 5558
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
          "DeleteFile %s failed -- %s.\n", name.c_str(),
          status.ToString().c_str());
5559 5560 5561 5562
    }
    return status;
  }

5563
  int level;
I
Igor Canadi 已提交
5564
  FileMetaData* metadata;
5565
  ColumnFamilyData* cfd;
5566
  VersionEdit edit;
5567
  JobContext job_context(next_job_id_.fetch_add(1), true);
D
Dhruba Borthakur 已提交
5568
  {
5569
    InstrumentedMutexLock l(&mutex_);
5570
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
5571
    if (!status.ok()) {
5572
      Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5573
          "DeleteFile %s failed. File not found\n", name.c_str());
I
Igor Canadi 已提交
5574
      job_context.Clean();
D
Dhruba Borthakur 已提交
5575 5576
      return Status::InvalidArgument("File not found");
    }
5577
    assert(level < cfd->NumberLevels());
5578

D
Dhruba Borthakur 已提交
5579
    // If the file is being compacted no need to delete.
5580
    if (metadata->being_compacted) {
5581
      Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
5582
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
I
Igor Canadi 已提交
5583
      job_context.Clean();
D
Dhruba Borthakur 已提交
5584
      return Status::OK();
5585 5586
    }

D
Dhruba Borthakur 已提交
5587 5588 5589
    // 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 已提交
5590
    auto* vstoreage = cfd->current()->storage_info();
I
Igor Canadi 已提交
5591
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
S
sdong 已提交
5592
      if (vstoreage->NumLevelFiles(i) != 0) {
5593
        Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5594
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
I
Igor Canadi 已提交
5595
        job_context.Clean();
D
Dhruba Borthakur 已提交
5596 5597 5598
        return Status::InvalidArgument("File not in last level");
      }
    }
5599
    // if level == 0, it has to be the oldest file
S
sdong 已提交
5600 5601
    if (level == 0 &&
        vstoreage->LevelFiles(0).back()->fd.GetNumber() != number) {
5602
      Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5603
          "DeleteFile %s failed ---"
5604 5605
          " target file in level 0 must be the oldest.",
          name.c_str());
I
Igor Canadi 已提交
5606
      job_context.Clean();
5607 5608 5609
      return Status::InvalidArgument("File in level 0, but not oldest");
    }
    edit.SetColumnFamily(cfd->GetID());
D
Dhruba Borthakur 已提交
5610
    edit.DeleteFile(level, number);
5611
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
5612
                                    &edit, &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
5613
    if (status.ok()) {
I
Igor Canadi 已提交
5614 5615
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
5616
    }
I
Igor Canadi 已提交
5617 5618
    FindObsoleteFiles(&job_context, false);
  }  // lock released here
5619

5620
  LogFlush(immutable_db_options_.info_log);
5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635
  // 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;
5636
  std::vector<FileMetaData*> deleted_files;
5637 5638 5639
  JobContext job_context(next_job_id_.fetch_add(1), true);
  {
    InstrumentedMutexLock l(&mutex_);
5640
    Version* input_version = cfd->current();
5641

5642 5643
    auto* vstorage = input_version->storage_info();
    for (int i = 1; i < cfd->NumberLevels(); i++) {
5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664
      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);
5665 5666 5667
      FileMetaData* level_file;
      for (uint32_t j = 0; j < level_files.size(); j++) {
        level_file = level_files[j];
5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678
        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());
5679 5680
          deleted_files.push_back(level_file);
          level_file->being_compacted = true;
5681 5682 5683 5684
        }
      }
    }
    if (edit.GetDeletedFiles().empty()) {
5685
      job_context.Clean();
5686 5687
      return Status::OK();
    }
5688
    input_version->Ref();
5689 5690 5691 5692 5693 5694
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                    &edit, &mutex_, directories_.GetDbDir());
    if (status.ok()) {
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
    }
5695 5696 5697 5698
    for (auto* deleted_file : deleted_files) {
      deleted_file->being_compacted = false;
    }
    input_version->Unref();
5699 5700 5701
    FindObsoleteFiles(&job_context, false);
  }  // lock released here

5702
  LogFlush(immutable_db_options_.info_log);
I
Igor Canadi 已提交
5703
  // remove files outside the db-lock
I
Igor Canadi 已提交
5704
  if (job_context.HaveSomethingToDelete()) {
5705
    // Call PurgeObsoleteFiles() without holding mutex.
I
Igor Canadi 已提交
5706
    PurgeObsoleteFiles(job_context);
5707
  }
I
Igor Canadi 已提交
5708
  job_context.Clean();
5709 5710 5711
  return status;
}

5712
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
5713
  InstrumentedMutexLock l(&mutex_);
5714
  versions_->GetLiveFilesMetaData(metadata);
5715
}
5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726

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 已提交
5727
#endif  // ROCKSDB_LITE
5728

I
Igor Canadi 已提交
5729 5730 5731 5732 5733 5734 5735
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
5739 5740
    uint64_t fsize = 0;
    Status s = env_->GetFileSize(file_path, &fsize);
D
dyniusz 已提交
5741 5742 5743 5744
    if (!s.ok() &&
        env_->GetFileSize(Rocks2LevelTableFileName(file_path), &fsize).ok()) {
      s = Status::OK();
    }
I
Igor Canadi 已提交
5745 5746 5747 5748
    if (!s.ok()) {
      corruption_messages +=
          "Can't access " + md.name + ": " + s.ToString() + "\n";
    } else if (fsize != md.size) {
5749
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
5750
                             ". Size recorded in manifest " +
5751 5752
                             ToString(md.size) + ", actual size " +
                             ToString(fsize) + "\n";
I
Igor Canadi 已提交
5753 5754 5755 5756 5757 5758 5759 5760 5761
    }
  }
  if (corruption_messages.size() == 0) {
    return Status::OK();
  } else {
    return Status::Corruption(corruption_messages);
  }
}

5762
Status DBImpl::GetDbIdentity(std::string& identity) const {
5763 5764
  std::string idfilename = IdentityFileName(dbname_);
  const EnvOptions soptions;
5765 5766 5767 5768 5769 5770 5771 5772 5773
  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)));
5774
  }
5775

5776 5777 5778 5779 5780
  uint64_t file_size;
  s = env_->GetFileSize(idfilename, &file_size);
  if (!s.ok()) {
    return s;
  }
D
Dmitri Smirnov 已提交
5781
  char* buffer = reinterpret_cast<char*>(alloca(file_size));
5782
  Slice id;
5783
  s = id_file_reader->Read(static_cast<size_t>(file_size), &id, buffer);
5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794
  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 已提交
5795 5796
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
5797
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
5798
               const Slice& key, const Slice& value) {
5799 5800 5801 5802
  // 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);
5803
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
5804 5805 5806
  return Write(opt, &batch);
}

5807 5808
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
5809
  WriteBatch batch;
5810
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
5811 5812 5813
  return Write(opt, &batch);
}

A
Andres Noetzli 已提交
5814 5815 5816 5817 5818 5819 5820
Status DB::SingleDelete(const WriteOptions& opt,
                        ColumnFamilyHandle* column_family, const Slice& key) {
  WriteBatch batch;
  batch.SingleDelete(column_family, key);
  return Write(opt, &batch);
}

5821 5822
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
5823
  WriteBatch batch;
5824
  batch.Merge(column_family, key, value);
5825 5826 5827
  return Write(opt, &batch);
}

5828
// Default implementation -- returns not supported status
L
Lei Jin 已提交
5829
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
5830
                              const std::string& column_family_name,
5831
                              ColumnFamilyHandle** handle) {
5832
  return Status::NotSupported("");
5833
}
5834
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
5835
  return Status::NotSupported("");
5836
}
5837 5838 5839 5840
Status DB::DestroyColumnFamilyHandle(ColumnFamilyHandle* column_family) {
  delete column_family;
  return Status::OK();
}
5841

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

J
Jim Paton 已提交
5844
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
5845 5846 5847 5848
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
5849
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
5850
  std::vector<ColumnFamilyHandle*> handles;
5851
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
5852 5853 5854 5855 5856 5857 5858
  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;
5859 5860
}

5861 5862
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
5863
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
5864
  Status s = SanitizeOptionsByTable(db_options, column_families);
5865 5866 5867
  if (!s.ok()) {
    return s;
  }
5868

5869 5870 5871
  s = ValidateOptions(db_options, column_families);
  if (!s.ok()) {
    return s;
5872 5873
  }

5874
  *dbptr = nullptr;
5875
  handles->clear();
J
jorlow@chromium.org 已提交
5876

I
Igor Canadi 已提交
5877 5878 5879 5880
  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);
5881
  }
5882

I
Igor Canadi 已提交
5883
  DBImpl* impl = new DBImpl(db_options, dbname);
5884
  s = impl->env_->CreateDirIfMissing(impl->immutable_db_options_.wal_dir);
5885
  if (s.ok()) {
5886
    for (auto db_path : impl->immutable_db_options_.db_paths) {
5887
      s = impl->env_->CreateDirIfMissing(db_path.path);
5888 5889 5890 5891 5892 5893
      if (!s.ok()) {
        break;
      }
    }
  }

5894 5895 5896 5897 5898 5899
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
5900 5901 5902 5903
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
5904
  impl->mutex_.Lock();
5905 5906
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
5907
  if (s.ok()) {
5908
    uint64_t new_log_number = impl->versions_->NewFileNumber();
5909
    unique_ptr<WritableFile> lfile;
5910
    EnvOptions soptions(db_options);
5911
    EnvOptions opt_env_options =
5912 5913 5914 5915 5916 5917 5918
        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 已提交
5919
    if (s.ok()) {
5920 5921
      lfile->SetPreallocationBlockSize(
          impl->GetWalPreallocateBlockSize(max_write_buffer_size));
5922
      impl->logfile_number_ = new_log_number;
5923 5924
      unique_ptr<WritableFileWriter> file_writer(
          new WritableFileWriter(std::move(lfile), opt_env_options));
5925 5926
      impl->logs_.emplace_back(
          new_log_number,
5927 5928 5929
          new log::Writer(
              std::move(file_writer), new_log_number,
              impl->immutable_db_options_.recycle_log_file_num > 0));
I
Igor Canadi 已提交
5930

5931 5932
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
5933 5934
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
5935 5936 5937
        if (cfd != nullptr) {
          handles->push_back(
              new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
5938
          impl->NewThreadStatusCfInfo(cfd);
I
Igor Canadi 已提交
5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954
        } 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 已提交
5955
        }
5956
      }
I
Igor Canadi 已提交
5957 5958
    }
    if (s.ok()) {
5959
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
5960
        delete impl->InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
5961
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
5962
      }
I
Igor Canadi 已提交
5963 5964
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
5965
      impl->DeleteObsoleteFiles();
5966
      s = impl->directories_.GetDbDir()->Fsync();
J
jorlow@chromium.org 已提交
5967 5968
    }
  }
5969

I
Igor Canadi 已提交
5970 5971
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
S
sdong 已提交
5972
      if (cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
S
sdong 已提交
5973
        auto* vstorage = cfd->current()->storage_info();
5974
        for (int i = 1; i < vstorage->num_levels(); ++i) {
S
sdong 已提交
5975
          int num_files = vstorage->NumLevelFiles(i);
I
Igor Canadi 已提交
5976
          if (num_files > 0) {
I
Igor Canadi 已提交
5977 5978
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
S
sdong 已提交
5979
                "open with FIFO compaction style.");
I
Igor Canadi 已提交
5980 5981 5982 5983
            break;
          }
        }
      }
S
sdong 已提交
5984 5985 5986
      if (!cfd->mem()->IsSnapshotSupported()) {
        impl->is_snapshot_supported_ = false;
      }
5987
      if (cfd->ioptions()->merge_operator != nullptr &&
5988 5989 5990 5991 5992
          !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 已提交
5993
      if (!s.ok()) {
5994 5995 5996 5997
        break;
      }
    }
  }
5998
  TEST_SYNC_POINT("DBImpl::Open:Opened");
5999
  Status persist_options_status;
6000
  if (s.ok()) {
6001 6002 6003 6004
    // Persist RocksDB Options before scheduling the compaction.
    // The WriteOptionsFile() will release and lock the mutex internally.
    persist_options_status = impl->WriteOptionsFile();

6005
    *dbptr = impl;
6006 6007 6008
    impl->opened_successfully_ = true;
    impl->MaybeScheduleFlushOrCompaction();
  }
6009 6010
  impl->mutex_.Unlock();

6011
  auto sfm = static_cast<SstFileManagerImpl*>(
6012
      impl->immutable_db_options_.sst_file_manager.get());
6013 6014 6015
  if (s.ok() && sfm) {
    // Notify SstFileManager about all sst files that already exist in
    // db_paths[0] when the DB is opened.
6016
    auto& db_path = impl->immutable_db_options_.db_paths[0];
6017
    std::vector<std::string> existing_files;
6018
    impl->immutable_db_options_.env->GetChildren(db_path.path, &existing_files);
6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029
    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 已提交
6030
  if (s.ok()) {
6031 6032 6033
    Log(InfoLogLevel::INFO_LEVEL, impl->immutable_db_options_.info_log,
        "DB pointer %p", impl);
    LogFlush(impl->immutable_db_options_.info_log);
6034 6035 6036 6037 6038 6039
    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());
      }
6040
      Warn(impl->immutable_db_options_.info_log,
6041 6042 6043 6044
           "Unable to persist options in DB::Open() -- %s",
           persist_options_status.ToString().c_str());
    }
  }
6045
  if (!s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
6046
    for (auto* h : *handles) {
6047 6048
      delete h;
    }
6049
    handles->clear();
J
jorlow@chromium.org 已提交
6050
    delete impl;
6051
    *dbptr = nullptr;
J
jorlow@chromium.org 已提交
6052 6053 6054 6055
  }
  return s;
}

6056 6057 6058
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
6059
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
6060 6061
}

6062 6063 6064
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
6065
Status DestroyDB(const std::string& dbname, const Options& options) {
6066
  const ImmutableDBOptions soptions(SanitizeOptions(dbname, options));
6067
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
6068
  std::vector<std::string> filenames;
6069

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

J
jorlow@chromium.org 已提交
6073
  FileLock* lock;
6074 6075
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
6076 6077 6078
  if (result.ok()) {
    uint64_t number;
    FileType type;
6079
    InfoLogPrefix info_log_prefix(!soptions.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
6080
    for (size_t i = 0; i < filenames.size(); i++) {
6081
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
6082
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
6083
        Status del;
6084
        std::string path_to_delete = dbname + "/" + filenames[i];
K
Kosie van der Merwe 已提交
6085
        if (type == kMetaDatabase) {
6086 6087
          del = DestroyDB(path_to_delete, options);
        } else if (type == kTableFile) {
6088
          del = DeleteSSTFile(&soptions, path_to_delete, 0);
K
Kosie van der Merwe 已提交
6089
        } else {
6090
          del = env->DeleteFile(path_to_delete);
K
Kosie van der Merwe 已提交
6091
        }
J
jorlow@chromium.org 已提交
6092 6093 6094 6095 6096
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
6097

6098 6099
    for (size_t path_id = 0; path_id < options.db_paths.size(); path_id++) {
      const auto& db_path = options.db_paths[path_id];
6100
      env->GetChildren(db_path.path, &filenames);
6101 6102 6103
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
6104
          std::string table_path = db_path.path + "/" + filenames[i];
6105
          Status del = DeleteSSTFile(&soptions, table_path,
6106
                                     static_cast<uint32_t>(path_id));
6107 6108 6109 6110 6111 6112 6113
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

I
Igor Canadi 已提交
6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131
    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;
6132
    env->GetChildren(archivedir, &archiveFiles);
6133 6134
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
6135 6136
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
6137
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
6138 6139 6140 6141 6142
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
6143

6144
    // ignore case where no archival directory is present.
6145
    env->DeleteDir(archivedir);
6146

J
jorlow@chromium.org 已提交
6147
    env->UnlockFile(lock);  // Ignore error since state is already gone
6148
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
6149
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
6150
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
6151 6152 6153 6154
  }
  return result;
}

6155 6156
Status DBImpl::WriteOptionsFile() {
#ifndef ROCKSDB_LITE
6157
  mutex_.AssertHeld();
6158 6159 6160

  std::vector<std::string> cf_names;
  std::vector<ColumnFamilyOptions> cf_opts;
6161 6162 6163 6164 6165

  // This part requires mutex to protect the column family options
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
6166
    }
6167
    cf_names.push_back(cfd->GetName());
6168
    cf_opts.push_back(cfd->GetLatestCFOptions());
6169 6170
  }

6171 6172
  // Unlock during expensive operations.  New writes cannot get here
  // because the single write thread ensures all new writes get queued.
6173 6174
  DBOptions db_options =
      BuildDBOptions(immutable_db_options_, mutable_db_options_);
6175 6176 6177 6178
  mutex_.Unlock();

  std::string file_name =
      TempOptionsFileName(GetName(), versions_->NewFileNumber());
6179 6180
  Status s =
      PersistRocksDBOptions(db_options, cf_names, cf_opts, file_name, GetEnv());
6181 6182 6183 6184 6185

  if (s.ok()) {
    s = RenameTempFileToOptionsFile(file_name);
  }
  mutex_.Lock();
6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234
  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,
6235
                           immutable_db_options_.info_log, GetEnv());
6236 6237 6238 6239 6240 6241 6242 6243 6244
  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 已提交
6245 6246

  versions_->options_file_number_ = versions_->NewFileNumber();
6247
  std::string options_file_name =
W
Wanning Jiang 已提交
6248
      OptionsFileName(GetName(), versions_->options_file_number_);
6249 6250 6251 6252 6253 6254 6255 6256 6257 6258
  // 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 已提交
6259
#if ROCKSDB_USING_THREAD_STATUS
6260

Y
Yueh-Hsuan Chiang 已提交
6261 6262
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6263
  if (immutable_db_options_.enable_thread_tracking) {
6264 6265
    ThreadStatusUtil::NewColumnFamilyInfo(this, cfd, cfd->GetName(),
                                          cfd->ioptions()->env);
6266
  }
Y
Yueh-Hsuan Chiang 已提交
6267 6268 6269 6270
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6271
  if (immutable_db_options_.enable_thread_tracking) {
6272
    ThreadStatusUtil::EraseColumnFamilyInfo(cfd);
6273
  }
Y
Yueh-Hsuan Chiang 已提交
6274 6275 6276
}

void DBImpl::EraseThreadStatusDbInfo() const {
6277
  if (immutable_db_options_.enable_thread_tracking) {
6278
    ThreadStatusUtil::EraseDatabaseInfo(this);
6279
  }
Y
Yueh-Hsuan Chiang 已提交
6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294
}

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

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

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

6295 6296
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
6297
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
6298
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
6299 6300
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
6301 6302 6303 6304
  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 已提交
6305
#endif
6306 6307
}

A
agiardullo 已提交
6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324
#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
6325 6326 6327
Status DBImpl::GetLatestSequenceForKey(SuperVersion* sv, const Slice& key,
                                       bool cache_only, SequenceNumber* seq,
                                       bool* found_record_for_key) {
A
agiardullo 已提交
6328 6329
  Status s;
  MergeContext merge_context;
A
Andrew Kryczka 已提交
6330
  RangeDelAggregator range_del_agg(sv->mem->GetInternalKeyComparator(), {});
A
agiardullo 已提交
6331

A
Andrew Kryczka 已提交
6332
  ReadOptions read_options;
A
agiardullo 已提交
6333 6334 6335 6336
  SequenceNumber current_seq = versions_->LastSequence();
  LookupKey lkey(key, current_seq);

  *seq = kMaxSequenceNumber;
6337 6338
  *found_record_for_key = false;

A
agiardullo 已提交
6339
  // Check if there is a record for this key in the latest memtable
A
Andrew Kryczka 已提交
6340 6341
  sv->mem->Get(lkey, nullptr, &s, &merge_context, &range_del_agg, seq,
               read_options);
A
agiardullo 已提交
6342 6343 6344

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6345
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
A
agiardullo 已提交
6346 6347 6348 6349 6350 6351 6352 6353
        "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
6354
    *found_record_for_key = true;
A
agiardullo 已提交
6355 6356 6357 6358
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
A
Andrew Kryczka 已提交
6359 6360
  sv->imm->Get(lkey, nullptr, &s, &merge_context, &range_del_agg, seq,
               read_options);
A
agiardullo 已提交
6361 6362 6363

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6364
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
A
agiardullo 已提交
6365 6366 6367 6368 6369 6370 6371 6372
        "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
6373
    *found_record_for_key = true;
A
agiardullo 已提交
6374 6375 6376 6377
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
A
Andrew Kryczka 已提交
6378 6379
  sv->imm->GetFromHistory(lkey, nullptr, &s, &merge_context, &range_del_agg,
                          seq, read_options);
A
agiardullo 已提交
6380 6381 6382

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6383
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
A
agiardullo 已提交
6384 6385 6386 6387 6388 6389
        "Unexpected status returned from MemTableList::GetFromHistory: %s\n",
        s.ToString().c_str());

    return s;
  }

6390 6391 6392 6393 6394 6395 6396 6397 6398 6399
  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
R
Reid Horuff 已提交
6400
    sv->current->Get(read_options, lkey, nullptr, &s, &merge_context,
A
Andrew Kryczka 已提交
6401 6402
                     &range_del_agg, nullptr /* value_found */,
                     found_record_for_key, seq);
6403 6404 6405

    if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
      // unexpected error reading SST files
6406
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
6407 6408 6409 6410 6411 6412 6413
          "Unexpected status returned from Version::Get: %s\n",
          s.ToString().c_str());

      return s;
    }
  }

A
agiardullo 已提交
6414 6415
  return Status::OK();
}
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

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

6441
  TEST_SYNC_POINT("DBImpl::AddFile:Start");
6442 6443 6444 6445 6446 6447 6448 6449 6450
  {
    // Lock db mutex
    InstrumentedMutexLock l(&mutex_);
    TEST_SYNC_POINT("DBImpl::AddFile:MutexLock");

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

6451 6452
    num_running_ingest_file_++;

6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510
    // 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 已提交
6511 6512
#endif  // ROCKSDB_LITE

6513
}  // namespace rocksdb