db_impl.cc 231.0 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 62
#include "memtable/hash_linklist_rep.h"
#include "memtable/hash_skiplist_rep.h"
63
#include "port/likely.h"
64
#include "port/port.h"
I
Igor Canadi 已提交
65
#include "rocksdb/cache.h"
66 67 68 69 70 71
#include "rocksdb/compaction_filter.h"
#include "rocksdb/db.h"
#include "rocksdb/env.h"
#include "rocksdb/merge_operator.h"
#include "rocksdb/statistics.h"
#include "rocksdb/status.h"
S
Siying Dong 已提交
72
#include "rocksdb/table.h"
73
#include "rocksdb/version.h"
74
#include "rocksdb/wal_filter.h"
75
#include "rocksdb/write_buffer_manager.h"
J
jorlow@chromium.org 已提交
76
#include "table/block.h"
77
#include "table/block_based_table_factory.h"
78
#include "table/merging_iterator.h"
K
kailiu 已提交
79
#include "table/table_builder.h"
J
jorlow@chromium.org 已提交
80
#include "table/two_level_iterator.h"
K
kailiu 已提交
81
#include "util/autovector.h"
82
#include "util/build_version.h"
83
#include "util/cf_options.h"
J
jorlow@chromium.org 已提交
84
#include "util/coding.h"
I
Igor Canadi 已提交
85
#include "util/compression.h"
86
#include "util/crc32c.h"
87
#include "util/file_reader_writer.h"
88
#include "util/file_util.h"
89
#include "util/iostats_context_imp.h"
H
Haobo Xu 已提交
90
#include "util/log_buffer.h"
91
#include "util/logging.h"
J
jorlow@chromium.org 已提交
92
#include "util/mutexlock.h"
93 94
#include "util/options_helper.h"
#include "util/options_parser.h"
95
#include "util/perf_context_imp.h"
96
#include "util/sst_file_manager_impl.h"
97
#include "util/stop_watch.h"
98
#include "util/string_util.h"
99
#include "util/sync_point.h"
100 101
#include "util/thread_status_updater.h"
#include "util/thread_status_util.h"
J
jorlow@chromium.org 已提交
102

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

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

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

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

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

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

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

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

144
  if (result.info_log == nullptr) {
145
    Status s = CreateLoggerFromOptions(dbname, result, &result.info_log);
J
jorlow@chromium.org 已提交
146 147
    if (!s.ok()) {
      // No place suitable for logging
148
      result.info_log = nullptr;
J
jorlow@chromium.org 已提交
149 150
    }
  }
151

152 153 154 155
  if (!result.write_buffer_manager) {
    result.write_buffer_manager.reset(
        new WriteBufferManager(result.db_write_buffer_size));
  }
156 157 158 159 160 161
  if (result.base_background_compactions == -1) {
    result.base_background_compactions = result.max_background_compactions;
  }
  if (result.base_background_compactions > result.max_background_compactions) {
    result.base_background_compactions = result.max_background_compactions;
  }
162 163 164 165
  result.env->IncBackgroundThreadsIfNeeded(src.max_background_compactions,
                                           Env::Priority::LOW);
  result.env->IncBackgroundThreadsIfNeeded(src.max_background_flushes,
                                           Env::Priority::HIGH);
166

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

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

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

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

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

200 201 202 203
  if (result.use_direct_reads && result.compaction_readahead_size == 0) {
    result.compaction_readahead_size = 1024 * 1024 * 2;
  }

204 205 206 207
  if (result.compaction_readahead_size > 0) {
    result.new_table_reader_for_compaction_inputs = true;
  }

208 209 210 211 212 213 214
  // 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 已提交
215 216 217
  return result;
}

218 219
namespace {

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

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
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. ");
  }

A
Aaron Gao 已提交
261
  if (db_options.allow_mmap_reads && db_options.use_direct_reads) {
262 263 264
    // Protect against assert in PosixMMapReadableFile constructor
    return Status::NotSupported(
        "If memory mapped reads (allow_mmap_reads) are enabled "
A
Aaron Gao 已提交
265 266 267 268 269 270 271
        "then direct I/O reads (use_direct_reads) must be disabled. ");
  }

  if (db_options.allow_mmap_writes && db_options.use_direct_writes) {
    return Status::NotSupported(
        "If memory mapped writes (allow_mmap_writes) are enabled "
        "then direct I/O writes (use_direct_writes) must be disabled. ");
272 273
  }

274 275 276 277
  if (db_options.keep_log_file_num == 0) {
    return Status::InvalidArgument("keep_log_file_num must be greater than 0");
  }

278 279 280
  return Status::OK();
}

A
Aaron Gao 已提交
281 282 283
CompressionType GetCompressionFlush(
    const ImmutableCFOptions& ioptions,
    const MutableCFOptions& mutable_cf_options) {
284 285 286
  // 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.
287
  if (ioptions.compaction_style == kCompactionStyleUniversal) {
288 289 290 291 292 293 294 295
    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];
296
  } else {
A
Aaron Gao 已提交
297
    return mutable_cf_options.compression;
298 299
  }
}
I
Igor Canadi 已提交
300

301
void DumpSupportInfo(Logger* logger) {
302 303 304 305 306 307 308
  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 已提交
309 310
}

311
}  // namespace
312

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

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

373
  versions_.reset(new VersionSet(dbname_, &immutable_db_options_, env_options_,
374
                                 table_cache_.get(), write_buffer_manager_,
375
                                 &write_controller_));
376 377
  column_family_memtables_.reset(
      new ColumnFamilyMemTablesImpl(versions_->GetColumnFamilySet()));
378

379 380 381 382 383
  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 已提交
384 385
}

386
// Will lock the mutex_,  will wait for completion if wait is true
387
void DBImpl::CancelAllBackgroundWork(bool wait) {
388
  InstrumentedMutexLock l(&mutex_);
389

390 391 392
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
      "Shutdown: canceling all background work");

393
  if (!shutting_down_.load(std::memory_order_acquire) &&
394
      has_unpersisted_data_.load(std::memory_order_relaxed) &&
Y
Yi Wu 已提交
395
      !mutable_db_options_.avoid_flush_during_shutdown) {
396
    for (auto cfd : *versions_->GetColumnFamilySet()) {
397
      if (!cfd->IsDropped() && !cfd->mem()->IsEmpty()) {
398 399 400 401
        cfd->Ref();
        mutex_.Unlock();
        FlushMemTable(cfd, FlushOptions());
        mutex_.Lock();
402
        cfd->Unref();
403 404
      }
    }
405
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();
406
  }
407 408 409 410 411 412 413 414 415 416 417 418 419

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

439 440 441 442 443 444 445 446 447 448 449 450 451
  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 已提交
452 453 454 455 456
  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();
457 458
  }

I
Igor Canadi 已提交
459 460 461 462 463 464 465 466 467 468
  // 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_) {
469
    JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
470
    FindObsoleteFiles(&job_context, true);
471 472

    mutex_.Unlock();
I
Igor Canadi 已提交
473
    // manifest number starting from 2
I
Igor Canadi 已提交
474 475 476
    job_context.manifest_file_number = 1;
    if (job_context.HaveSomethingToDelete()) {
      PurgeObsoleteFiles(job_context);
477
    }
I
Igor Canadi 已提交
478
    job_context.Clean();
479
    mutex_.Lock();
480 481
  }

482 483 484
  for (auto l : logs_to_free_) {
    delete l;
  }
485 486 487
  for (auto& log : logs_) {
    log.ClearWriter();
  }
488
  logs_.clear();
489

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
  // 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 已提交
505 506 507 508
  for (auto& txn_entry : recovered_transactions_) {
    delete txn_entry.second;
  }

509
  // versions need to be destroyed before table_cache since it can hold
510 511
  // references to table_cache.
  versions_.reset();
512
  mutex_.Unlock();
I
Igor Canadi 已提交
513 514 515
  if (db_lock_ != nullptr) {
    env_->UnlockFile(db_lock_);
  }
516

517 518
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
      "Shutdown complete");
519
  LogFlush(immutable_db_options_.info_log);
J
jorlow@chromium.org 已提交
520 521 522
}

Status DBImpl::NewDB() {
523
  VersionEdit new_db;
524
  new_db.SetLogNumber(0);
J
jorlow@chromium.org 已提交
525 526 527
  new_db.SetNextFile(2);
  new_db.SetLastSequence(0);

528 529
  Status s;

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

void DBImpl::MaybeIgnoreError(Status* s) const {
562
  if (s->ok() || immutable_db_options_.paranoid_checks) {
J
jorlow@chromium.org 已提交
563 564
    // No change needed
  } else {
565 566
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
        "Ignoring error %s", s->ToString().c_str());
J
jorlow@chromium.org 已提交
567 568 569 570
    *s = Status::OK();
  }
}

571
const Status DBImpl::CreateArchivalDirectory() {
572 573 574
  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);
575 576 577 578 579
    return env_->CreateDirIfMissing(archivalPath);
  }
  return Status::OK();
}

580
void DBImpl::PrintStatistics() {
581
  auto dbstats = immutable_db_options_.statistics.get();
582
  if (dbstats) {
583 584
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
        "STATISTICS:\n %s", dbstats->ToString().c_str());
585 586 587
  }
}

588
#ifndef ROCKSDB_LITE
589 590 591 592 593 594 595 596 597 598 599 600 601 602
#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;
  }

603
  snprintf(mstat->cur, buf_size, "%s", status);
604 605 606 607 608 609 610 611
  mstat->cur += status_len;
}
#endif  // ROCKSDB_JEMALLOC

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

621
void DBImpl::MaybeDumpStats() {
622
  if (immutable_db_options_.stats_dump_period_sec == 0) return;
H
Haobo Xu 已提交
623 624 625 626

  const uint64_t now_micros = env_->NowMicros();

  if (last_stats_dump_time_microsec_ +
627 628
          immutable_db_options_.stats_dump_period_sec * 1000000 <=
      now_micros) {
H
Haobo Xu 已提交
629 630 631 632 633
    // 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;
634

635
#ifndef ROCKSDB_LITE
636 637 638 639 640 641 642
    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 已提交
643
    std::string stats;
644
    {
645
      InstrumentedMutexLock l(&mutex_);
646
      for (auto cfd : *versions_->GetColumnFamilySet()) {
647 648
        cfd->internal_stats()->GetStringProperty(
            *cf_property_info, DB::Properties::kCFStats, &stats);
649
      }
650 651
      default_cf_internal_stats_->GetStringProperty(
          *db_property_info, DB::Properties::kDBStats, &stats);
652
    }
653 654 655 656
    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 已提交
657 658 659 660 661 662 663 664 665 666
    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());
      }
    }
667
#endif  // !ROCKSDB_LITE
668

669
    PrintStatistics();
670 671 672
  }
}

673
uint64_t DBImpl::FindMinPrepLogReferencedByMemTable() {
674 675 676 677
  if (!allow_2pc()) {
    return 0;
  }

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
  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() {
722 723 724 725 726

  if (!allow_2pc()) {
    return 0;
  }

R
Reid Horuff 已提交
727
  std::lock_guard<std::mutex> lock(prep_heap_mutex_);
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
  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;
}

755 756 757 758 759 760 761 762 763 764
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();
  }
}

765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
uint64_t DBImpl::MinLogNumberToKeep() {
  uint64_t log_number = versions_->MinLogNumber();

  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 < log_number) {
      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 < log_number) {
      log_number = min_log_refed_by_mem;
    }
  }
  return log_number;
}

I
Igor Canadi 已提交
793
// * Returns the list of live files in 'sst_live'
I
Igor Canadi 已提交
794
// If it's doing full scan:
I
Igor Canadi 已提交
795 796
// * Returns the list of all files in the filesystem in
// 'full_scan_candidate_files'.
I
Igor Canadi 已提交
797
// Otherwise, gets obsolete files from VersionSet.
I
Igor Canadi 已提交
798 799
// no_full_scan = true -- never do the full scan using GetChildren()
// force = false -- don't force the full scan, except every
800
//  mutable_db_options_.delete_obsolete_files_period_micros
I
Igor Canadi 已提交
801
// force = true -- force the full scan
I
Igor Canadi 已提交
802
void DBImpl::FindObsoleteFiles(JobContext* job_context, bool force,
I
Igor Canadi 已提交
803
                               bool no_full_scan) {
D
Dhruba Borthakur 已提交
804 805
  mutex_.AssertHeld();

806
  // if deletion is disabled, do nothing
807
  if (disable_delete_obsolete_files_ > 0) {
808 809 810
    return;
  }

811 812 813 814 815
  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;
816
  } else if (force ||
817
             mutable_db_options_.delete_obsolete_files_period_micros == 0) {
818 819 820
    doing_the_full_scan = true;
  } else {
    const uint64_t now_micros = env_->NowMicros();
821 822 823
    if ((delete_obsolete_files_last_run_ +
         mutable_db_options_.delete_obsolete_files_period_micros) <
        now_micros) {
824
      doing_the_full_scan = true;
825
      delete_obsolete_files_last_run_ = now_micros;
826 827 828
    }
  }

I
Igor Canadi 已提交
829 830
  // don't delete files that might be currently written to from compaction
  // threads
831 832 833
  // 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 已提交
834 835 836 837 838 839 840
  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();
  }

841 842
  // Get obsolete files.  This function will also update the list of
  // pending files in VersionSet().
I
Igor Canadi 已提交
843
  versions_->GetObsoleteFiles(&job_context->sst_delete_files,
844
                              &job_context->manifest_delete_files,
I
Igor Canadi 已提交
845
                              job_context->min_pending_output);
I
Igor Canadi 已提交
846

I
Igor Canadi 已提交
847
  // store the current filenum, lognum, etc
848
  job_context->manifest_file_number = versions_->manifest_file_number();
I
Igor Canadi 已提交
849
  job_context->pending_manifest_file_number =
850
      versions_->pending_manifest_file_number();
851
  job_context->log_number = MinLogNumberToKeep();
852

853
  job_context->prev_log_number = versions_->prev_log_number();
I
Igor Canadi 已提交
854

I
Igor Canadi 已提交
855
  versions_->AddLiveFiles(&job_context->sst_live);
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
  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);
      }
    }
  }
891

892 893 894
  // 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()) {
895
    uint64_t min_log_number = job_context->log_number;
S
sdong 已提交
896
    size_t num_alive_log_files = alive_log_files_.size();
897 898 899
    // find newly obsoleted log files
    while (alive_log_files_.begin()->number < min_log_number) {
      auto& earliest = *alive_log_files_.begin();
900 901 902
      if (immutable_db_options_.recycle_log_file_num >
          log_recycle_files.size()) {
        Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
S
Sage Weil 已提交
903 904 905 906 907
            "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 已提交
908 909 910 911 912
      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;
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
      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 已提交
936 937
  job_context->log_recycle_files.assign(log_recycle_files.begin(),
                                        log_recycle_files.end());
938
  logs_to_free_.clear();
939 940
}

941
namespace {
I
Igor Canadi 已提交
942 943
bool CompareCandidateFile(const JobContext::CandidateFileInfo& first,
                          const JobContext::CandidateFileInfo& second) {
944 945 946 947 948
  if (first.file_name > second.file_name) {
    return true;
  } else if (first.file_name < second.file_name) {
    return false;
  } else {
949
    return (first.path_id > second.path_id);
950 951 952 953
  }
}
};  // namespace

954 955 956 957 958
// 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) {
959 960
    file_deletion_status =
        DeleteSSTFile(&immutable_db_options_, fname, path_id);
961 962 963 964
  } else {
    file_deletion_status = env_->DeleteFile(fname);
  }
  if (file_deletion_status.ok()) {
965
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
966 967 968
        "[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()) {
969
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
970 971 972 973 974
        "[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 {
975
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
976 977 978 979 980 981
        "[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(),
982
        immutable_db_options_.listeners);
983 984 985
  }
}

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

I
Igor Canadi 已提交
994 995 996 997
  // 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 已提交
998 999
    return;
  }
1000

1001
  // Now, convert live list to an unordered map, WITHOUT mutex held;
1002
  // set is slow.
1003
  std::unordered_map<uint64_t, const FileDescriptor*> sst_live_map;
I
Igor Canadi 已提交
1004
  for (const FileDescriptor& fd : state.sst_live) {
1005 1006
    sst_live_map[fd.GetNumber()] = &fd;
  }
A
Andrew Kryczka 已提交
1007 1008
  std::unordered_set<uint64_t> log_recycle_files_set(
      state.log_recycle_files.begin(), state.log_recycle_files.end());
I
Igor Canadi 已提交
1009

I
Igor Canadi 已提交
1010
  auto candidate_files = state.full_scan_candidate_files;
1011 1012 1013
  candidate_files.reserve(
      candidate_files.size() + state.sst_delete_files.size() +
      state.log_delete_files.size() + state.manifest_delete_files.size());
K
kailiu 已提交
1014 1015
  // We may ignore the dbname when generating the file names.
  const char* kDumbDbName = "";
1016
  for (auto file : state.sst_delete_files) {
1017 1018 1019
    candidate_files.emplace_back(
        MakeTableFileName(kDumbDbName, file->fd.GetNumber()),
        file->fd.GetPathId());
1020
    delete file;
I
Igor Canadi 已提交
1021 1022
  }

K
kailiu 已提交
1023 1024
  for (auto file_num : state.log_delete_files) {
    if (file_num > 0) {
1025
      candidate_files.emplace_back(LogFileName(kDumbDbName, file_num), 0);
I
Igor Canadi 已提交
1026 1027
    }
  }
1028 1029 1030
  for (const auto& filename : state.manifest_delete_files) {
    candidate_files.emplace_back(filename, 0);
  }
1031

K
kailiu 已提交
1032
  // dedup state.candidate_files so we don't try to delete the same
I
Igor Canadi 已提交
1033
  // file twice
1034 1035 1036 1037 1038
  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 已提交
1039

S
sdong 已提交
1040
  if (state.prev_total_log_size > 0) {
1041
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
S
sdong 已提交
1042 1043 1044 1045 1046 1047 1048
        "[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);
  }

1049
  std::vector<std::string> old_info_log_files;
1050 1051
  InfoLogPrefix info_log_prefix(!immutable_db_options_.db_log_dir.empty(),
                                dbname_);
1052 1053 1054
  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 已提交
1055 1056 1057
    uint64_t number;
    FileType type;
    // Ignore file if we cannot recognize it.
1058
    if (!ParseFileName(to_delete, &number, info_log_prefix.prefix, &type)) {
K
kailiu 已提交
1059 1060
      continue;
    }
J
jorlow@chromium.org 已提交
1061

K
kailiu 已提交
1062 1063 1064 1065
    bool keep = true;
    switch (type) {
      case kLogFile:
        keep = ((number >= state.log_number) ||
A
Andrew Kryczka 已提交
1066 1067 1068
                (number == state.prev_log_number) ||
                (log_recycle_files_set.find(number) !=
                 log_recycle_files_set.end()));
K
kailiu 已提交
1069 1070 1071
        break;
      case kDescriptorFile:
        // Keep my manifest file, and any newer incarnations'
1072
        // (can happen during manifest roll)
K
kailiu 已提交
1073 1074 1075
        keep = (number >= state.manifest_file_number);
        break;
      case kTableFile:
I
Igor Canadi 已提交
1076 1077 1078 1079
        // 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 已提交
1080 1081 1082
        break;
      case kTempFile:
        // Any temp files that are currently being written to must
1083 1084 1085 1086
        // 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
1087 1088 1089
        //
        // TODO(yhchiang): carefully modify the third condition to safely
        //                 remove the temp options files.
1090
        keep = (sst_live_map.find(number) != sst_live_map.end()) ||
1091 1092
               (number == state.pending_manifest_file_number) ||
               (to_delete.find(kOptionsFileNamePrefix) != std::string::npos);
K
kailiu 已提交
1093 1094 1095 1096
        break;
      case kInfoLogFile:
        keep = true;
        if (number != 0) {
1097
          old_info_log_files.push_back(to_delete);
J
jorlow@chromium.org 已提交
1098
        }
K
kailiu 已提交
1099 1100 1101 1102 1103
        break;
      case kCurrentFile:
      case kDBLockFile:
      case kIdentityFile:
      case kMetaDatabase:
1104
      case kOptionsFile:
K
kailiu 已提交
1105 1106 1107 1108 1109 1110 1111 1112
        keep = true;
        break;
    }

    if (keep) {
      continue;
    }

1113
    std::string fname;
K
kailiu 已提交
1114 1115
    if (type == kTableFile) {
      // evict from cache
1116
      TableCache::Evict(table_cache_.get(), number);
1117
      fname = TableFileName(immutable_db_options_.db_paths, number, path_id);
1118
    } else {
1119 1120
      fname = ((type == kLogFile) ? immutable_db_options_.wal_dir : dbname_) +
              "/" + to_delete;
K
kailiu 已提交
1121
    }
1122

1123
#ifndef ROCKSDB_LITE
1124 1125
    if (type == kLogFile && (immutable_db_options_.wal_ttl_seconds > 0 ||
                             immutable_db_options_.wal_size_limit_mb > 0)) {
I
Igor Canadi 已提交
1126
      wal_manager_.ArchiveWALFile(fname, number);
1127 1128 1129
      continue;
    }
#endif  // !ROCKSDB_LITE
S
sdong 已提交
1130

I
Islam AbdelRahman 已提交
1131
    Status file_deletion_status;
1132 1133 1134
    if (schedule_only) {
      InstrumentedMutexLock guard_lock(&mutex_);
      SchedulePendingPurge(fname, type, number, path_id, state.job_id);
1135
    } else {
1136 1137
      DeleteObsoleteFileImpl(file_deletion_status, state.job_id, fname, type,
                             number, path_id);
J
jorlow@chromium.org 已提交
1138 1139
    }
  }
H
heyongqiang 已提交
1140

1141
  // Delete old info log files.
1142
  size_t old_info_log_file_count = old_info_log_files.size();
1143
  if (old_info_log_file_count != 0 &&
1144
      old_info_log_file_count >= immutable_db_options_.keep_log_file_num) {
1145
    std::sort(old_info_log_files.begin(), old_info_log_files.end());
1146 1147
    size_t end =
        old_info_log_file_count - immutable_db_options_.keep_log_file_num;
1148
    for (unsigned int i = 0; i <= end; i++) {
1149
      std::string& to_delete = old_info_log_files.at(i);
1150 1151 1152 1153 1154 1155
      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,
1156
          "[JOB %d] Delete info log file %s\n", state.job_id,
1157 1158
          full_path_to_delete.c_str());
      Status s = env_->DeleteFile(full_path_to_delete);
1159
      if (!s.ok()) {
1160
        if (env_->FileExists(full_path_to_delete).IsNotFound()) {
1161
          Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
1162 1163 1164 1165
              "[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 {
1166
          Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
1167 1168 1169
              "[JOB %d] Delete info log file %s FAILED -- %s\n", state.job_id,
              to_delete.c_str(), s.ToString().c_str());
        }
1170
      }
H
heyongqiang 已提交
1171 1172
    }
  }
I
Igor Canadi 已提交
1173 1174 1175
#ifndef ROCKSDB_LITE
  wal_manager_.PurgeObsoleteWALFiles();
#endif  // ROCKSDB_LITE
1176
  LogFlush(immutable_db_options_.info_log);
D
Dhruba Borthakur 已提交
1177 1178 1179 1180
}

void DBImpl::DeleteObsoleteFiles() {
  mutex_.AssertHeld();
1181
  JobContext job_context(next_job_id_.fetch_add(1));
I
Igor Canadi 已提交
1182
  FindObsoleteFiles(&job_context, true);
1183 1184

  mutex_.Unlock();
I
Igor Canadi 已提交
1185 1186
  if (job_context.HaveSomethingToDelete()) {
    PurgeObsoleteFiles(job_context);
1187
  }
I
Igor Canadi 已提交
1188
  job_context.Clean();
1189
  mutex_.Lock();
1190 1191
}

1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
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 已提交
1208

1209 1210 1211 1212 1213 1214 1215 1216 1217
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_);
1218 1219 1220
    if (!s.ok()) {
      return s;
    }
1221
  }
1222

1223 1224 1225 1226 1227 1228 1229 1230
  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);
1231 1232 1233
      if (!s.ok()) {
        return s;
      }
1234
      data_dirs_.emplace_back(path_directory.release());
1235
    }
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
  }
  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,
1253
    bool error_if_log_file_exist, bool error_if_data_exists_in_logs) {
1254
  mutex_.AssertHeld();
1255

1256 1257 1258
  bool is_new_db = false;
  assert(db_lock_ == nullptr);
  if (!read_only) {
1259 1260 1261
    Status s = directories_.SetDirectories(env_, dbname_,
                                           immutable_db_options_.wal_dir,
                                           immutable_db_options_.db_paths);
1262 1263 1264 1265
    if (!s.ok()) {
      return s;
    }

1266
    s = env_->LockFile(LockFileName(dbname_), &db_lock_);
1267 1268 1269
    if (!s.ok()) {
      return s;
    }
J
jorlow@chromium.org 已提交
1270

A
agiardullo 已提交
1271 1272
    s = env_->FileExists(CurrentFileName(dbname_));
    if (s.IsNotFound()) {
1273
      if (immutable_db_options_.create_if_missing) {
1274
        s = NewDB();
1275
        is_new_db = true;
1276 1277 1278 1279 1280 1281
        if (!s.ok()) {
          return s;
        }
      } else {
        return Status::InvalidArgument(
            dbname_, "does not exist (create_if_missing is false)");
J
jorlow@chromium.org 已提交
1282
      }
A
agiardullo 已提交
1283
    } else if (s.ok()) {
1284
      if (immutable_db_options_.error_if_exists) {
1285 1286 1287
        return Status::InvalidArgument(
            dbname_, "exists (error_if_exists is true)");
      }
A
agiardullo 已提交
1288 1289 1290 1291
    } else {
      // Unexpected error reading file
      assert(s.IsIOError());
      return s;
J
jorlow@chromium.org 已提交
1292
    }
M
Mayank Agarwal 已提交
1293
    // Check for the IDENTITY file and create it if not there
A
agiardullo 已提交
1294 1295
    s = env_->FileExists(IdentityFileName(dbname_));
    if (s.IsNotFound()) {
M
Mayank Agarwal 已提交
1296 1297 1298 1299
      s = SetIdentityFile(env_, dbname_);
      if (!s.ok()) {
        return s;
      }
A
agiardullo 已提交
1300 1301 1302
    } else if (!s.ok()) {
      assert(s.IsIOError());
      return s;
M
Mayank Agarwal 已提交
1303
    }
J
jorlow@chromium.org 已提交
1304 1305
  }

1306
  Status s = versions_->Recover(column_families, read_only);
1307
  if (immutable_db_options_.paranoid_checks && s.ok()) {
I
Igor Canadi 已提交
1308 1309
    s = CheckConsistency();
  }
J
jorlow@chromium.org 已提交
1310
  if (s.ok()) {
1311
    SequenceNumber next_sequence(kMaxSequenceNumber);
1312 1313
    default_cf_handle_ = new ColumnFamilyHandleImpl(
        versions_->GetColumnFamilySet()->GetDefault(), this, &mutex_);
1314
    default_cf_internal_stats_ = default_cf_handle_->cfd()->internal_stats();
1315 1316
    single_column_family_mode_ =
        versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1;
1317 1318 1319 1320 1321

    // 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).
    //
1322
    // Note that prev_log_number() is no longer used, but we pay
1323
    // attention to it in case we are recovering a database
1324
    // produced by an older version of rocksdb.
1325
    std::vector<std::string> filenames;
1326
    s = env_->GetChildren(immutable_db_options_.wal_dir, &filenames);
1327 1328
    if (!s.ok()) {
      return s;
1329
    }
K
kailiu 已提交
1330

1331 1332
    std::vector<uint64_t> logs;
    for (size_t i = 0; i < filenames.size(); i++) {
K
kailiu 已提交
1333 1334
      uint64_t number;
      FileType type;
1335 1336 1337 1338 1339 1340
      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]);
1341
        } else {
1342 1343
          logs.push_back(number);
        }
1344
      }
J
jorlow@chromium.org 已提交
1345
    }
1346

1347 1348 1349 1350 1351 1352 1353
    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) {
1354
          std::string fname = LogFileName(immutable_db_options_.wal_dir, log);
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
          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 已提交
1366 1367
    }

S
Stanislau Hlebik 已提交
1368 1369 1370
    if (!logs.empty()) {
      // Recover in the order in which the logs were generated
      std::sort(logs.begin(), logs.end());
1371
      s = RecoverLogFiles(logs, &next_sequence, read_only);
S
Stanislau Hlebik 已提交
1372 1373 1374
      if (!s.ok()) {
        // Clear memtables if recovery failed
        for (auto cfd : *versions_->GetColumnFamilySet()) {
A
agiardullo 已提交
1375 1376
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
                                 kMaxSequenceNumber);
S
Stanislau Hlebik 已提交
1377 1378
        }
      }
1379
    }
J
jorlow@chromium.org 已提交
1380 1381
  }

L
Lei Jin 已提交
1382 1383
  // Initial value
  max_total_in_memory_state_ = 0;
I
Igor Canadi 已提交
1384
  for (auto cfd : *versions_->GetColumnFamilySet()) {
L
Lei Jin 已提交
1385 1386 1387
    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 已提交
1388 1389
  }

J
jorlow@chromium.org 已提交
1390 1391 1392
  return s;
}

S
Stanislau Hlebik 已提交
1393 1394
// REQUIRES: log_numbers are sorted in ascending order
Status DBImpl::RecoverLogFiles(const std::vector<uint64_t>& log_numbers,
1395
                               SequenceNumber* next_sequence, bool read_only) {
J
jorlow@chromium.org 已提交
1396 1397
  struct LogReporter : public log::Reader::Reporter {
    Env* env;
1398
    Logger* info_log;
J
jorlow@chromium.org 已提交
1399
    const char* fname;
1400
    Status* status;  // nullptr if immutable_db_options_.paranoid_checks==false
I
Igor Sugak 已提交
1401
    virtual void Corruption(size_t bytes, const Status& s) override {
1402 1403
      Log(InfoLogLevel::WARN_LEVEL,
          info_log, "%s%s: dropping %d bytes; %s",
1404
          (this->status == nullptr ? "(ignoring error) " : ""),
J
jorlow@chromium.org 已提交
1405
          fname, static_cast<int>(bytes), s.ToString().c_str());
K
krad 已提交
1406 1407 1408
      if (this->status != nullptr && this->status->ok()) {
        *this->status = s;
      }
J
jorlow@chromium.org 已提交
1409 1410 1411 1412
    }
  };

  mutex_.AssertHeld();
S
Stanislau Hlebik 已提交
1413
  Status status;
1414
  std::unordered_map<int, VersionEdit> version_edits;
1415
  // no need to refcount because iteration is under mutex
1416 1417
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    VersionEdit edit;
1418 1419
    edit.SetColumnFamily(cfd->GetID());
    version_edits.insert({cfd->GetID(), edit});
1420
  }
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
  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 已提交
1433

1434
#ifndef ROCKSDB_LITE
1435
  if (immutable_db_options_.wal_filter != nullptr) {
1436 1437 1438 1439 1440 1441 1442 1443 1444
    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()));
    }

1445 1446
    immutable_db_options_.wal_filter->ColumnFamilyLogNumberMap(cf_lognumber_map,
                                                               cf_name_id_map);
1447 1448 1449
  }
#endif

1450 1451 1452
  bool stop_replay_by_wal_filter = false;
  bool stop_replay_for_corruption = false;
  bool flushed = false;
S
Stanislau Hlebik 已提交
1453 1454 1455 1456
  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.
1457
    versions_->MarkFileNumberUsedDuringRecovery(log_number);
S
Stanislau Hlebik 已提交
1458
    // Open the log file
1459
    std::string fname = LogFileName(immutable_db_options_.wal_dir, log_number);
1460

1461
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
1462
        "Recovering log #%" PRIu64 " mode %d", log_number,
1463
        immutable_db_options_.wal_recovery_mode);
1464 1465 1466
    auto logFileDropped = [this, &fname]() {
      uint64_t bytes;
      if (env_->GetFileSize(fname, &bytes).ok()) {
1467
        auto info_log = immutable_db_options_.info_log.get();
1468 1469 1470 1471 1472 1473 1474 1475 1476
        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;
    }

1477 1478 1479 1480
    unique_ptr<SequentialFileReader> file_reader;
    {
      unique_ptr<SequentialFile> file;
      status = env_->NewSequentialFile(fname, &file, env_options_);
S
Stanislau Hlebik 已提交
1481
      if (!status.ok()) {
1482 1483 1484 1485 1486 1487 1488 1489
        MaybeIgnoreError(&status);
        if (!status.ok()) {
          return status;
        } else {
          // Fail with one log file, but that's ok.
          // Try next one.
          continue;
        }
S
Stanislau Hlebik 已提交
1490
      }
1491
      file_reader.reset(new SequentialFileReader(std::move(file)));
J
jorlow@chromium.org 已提交
1492 1493
    }

S
Stanislau Hlebik 已提交
1494 1495 1496
    // Create the log reader.
    LogReporter reporter;
    reporter.env = env_;
1497
    reporter.info_log = immutable_db_options_.info_log.get();
S
Stanislau Hlebik 已提交
1498
    reporter.fname = fname.c_str();
1499 1500
    if (!immutable_db_options_.paranoid_checks ||
        immutable_db_options_.wal_recovery_mode ==
K
krad 已提交
1501 1502 1503 1504 1505
            WALRecoveryMode::kSkipAnyCorruptedRecords) {
      reporter.status = nullptr;
    } else {
      reporter.status = &status;
    }
S
Stanislau Hlebik 已提交
1506 1507 1508 1509
    // 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).
1510 1511 1512
    log::Reader reader(immutable_db_options_.info_log, std::move(file_reader),
                       &reporter, true /*checksum*/, 0 /*initial_offset*/,
                       log_number);
K
krad 已提交
1513 1514

    // Determine if we should tolerate incomplete records at the tail end of the
S
Stanislau Hlebik 已提交
1515 1516 1517 1518
    // Read all the records and add to a memtable
    std::string scratch;
    Slice record;
    WriteBatch batch;
K
krad 已提交
1519

1520 1521 1522 1523
    while (!stop_replay_by_wal_filter &&
           reader.ReadRecord(&record, &scratch,
                             immutable_db_options_.wal_recovery_mode) &&
           status.ok()) {
1524
      if (record.size() < WriteBatchInternal::kHeader) {
S
Stanislau Hlebik 已提交
1525 1526 1527 1528 1529
        reporter.Corruption(record.size(),
                            Status::Corruption("log record too small"));
        continue;
      }
      WriteBatchInternal::SetContents(&batch, record);
1530 1531
      SequenceNumber sequence = WriteBatchInternal::Sequence(&batch);

1532
      if (immutable_db_options_.wal_recovery_mode ==
1533
          WALRecoveryMode::kPointInTimeRecovery) {
1534 1535 1536 1537 1538
        // 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) {
1539 1540 1541 1542 1543 1544 1545 1546
          stop_replay_for_corruption = false;
        }
        if (stop_replay_for_corruption) {
          logFileDropped();
          break;
        }
      }

1547
#ifndef ROCKSDB_LITE
1548
      if (immutable_db_options_.wal_filter != nullptr) {
1549 1550 1551
        WriteBatch new_batch;
        bool batch_changed = false;

1552
        WalFilter::WalProcessingOption wal_processing_option =
1553 1554
            immutable_db_options_.wal_filter->LogRecordFound(
                log_number, fname, batch, &new_batch, &batch_changed);
1555

1556
        switch (wal_processing_option) {
S
sdong 已提交
1557 1558 1559 1560 1561
          case WalFilter::WalProcessingOption::kContinueProcessing:
            // do nothing, proceeed normally
            break;
          case WalFilter::WalProcessingOption::kIgnoreCurrentRecord:
            // skip current record
1562
            continue;
S
sdong 已提交
1563 1564
          case WalFilter::WalProcessingOption::kStopReplay:
            // skip current record and stop replay
1565
            stop_replay_by_wal_filter = true;
1566
            continue;
S
sdong 已提交
1567
          case WalFilter::WalProcessingOption::kCorruptedRecord: {
1568 1569 1570
            status =
                Status::Corruption("Corruption reported by Wal Filter ",
                                   immutable_db_options_.wal_filter->Name());
S
sdong 已提交
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
            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 ",
1583
                immutable_db_options_.wal_filter->Name());
S
sdong 已提交
1584 1585 1586 1587 1588 1589 1590
            MaybeIgnoreError(&status);
            if (!status.ok()) {
              return status;
            } else {
              // Ignore the error with current record processing.
              continue;
            }
1591 1592 1593 1594 1595 1596 1597 1598 1599
          }
        }

        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) {
1600
            Log(InfoLogLevel::FATAL_LEVEL, immutable_db_options_.info_log,
S
sdong 已提交
1601 1602 1603 1604
                "Recovering log #%" PRIu64
                " mode %d log filter %s returned "
                "more records (%d) than original (%d) which is not allowed. "
                "Aborting recovery.",
1605 1606 1607
                log_number, immutable_db_options_.wal_recovery_mode,
                immutable_db_options_.wal_filter->Name(), new_count,
                original_count);
S
sdong 已提交
1608 1609 1610
            status = Status::NotSupported(
                "More than original # of records "
                "returned by Wal Filter ",
1611
                immutable_db_options_.wal_filter->Name());
1612
            return status;
1613 1614 1615
          }
          // Set the same sequence number in the new_batch
          // as the original batch.
S
sdong 已提交
1616 1617
          WriteBatchInternal::SetSequence(&new_batch,
                                          WriteBatchInternal::Sequence(&batch));
1618
          batch = new_batch;
1619 1620
        }
      }
S
sdong 已提交
1621
#endif  // ROCKSDB_LITE
1622

S
Stanislau Hlebik 已提交
1623 1624 1625 1626 1627
      // 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 已提交
1628
      bool has_valid_writes = false;
1629 1630
      status = WriteBatchInternal::InsertInto(
          &batch, column_family_memtables_.get(), &flush_scheduler_, true,
A
Aaron Gao 已提交
1631 1632
          log_number, this, false /* concurrent_memtable_writes */,
          next_sequence, &has_valid_writes);
S
Stanislau Hlebik 已提交
1633 1634
      MaybeIgnoreError(&status);
      if (!status.ok()) {
1635 1636 1637 1638
        // 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 已提交
1639
      }
1640

S
sdong 已提交
1641
      if (has_valid_writes && !read_only) {
I
Igor Canadi 已提交
1642 1643 1644 1645
        // 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;

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

          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
1663
                                 *next_sequence);
1664
        }
J
jorlow@chromium.org 已提交
1665 1666 1667
      }
    }

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

I
Igor Canadi 已提交
1690
    flush_scheduler_.Clear();
1691 1692 1693 1694
    auto last_sequence = *next_sequence - 1;
    if ((*next_sequence != kMaxSequenceNumber) &&
        (versions_->LastSequence() <= last_sequence)) {
      versions_->SetLastSequence(last_sequence);
S
Stanislau Hlebik 已提交
1695
    }
1696 1697
  }

A
Andrew Kryczka 已提交
1698 1699 1700
  // True if there's any data in the WALs; if not, we can skip re-processing
  // them later
  bool data_seen = false;
1701
  if (!read_only) {
1702 1703
    // 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 已提交
1704
    auto max_log_number = log_numbers.back();
1705
    for (auto cfd : *versions_->GetColumnFamilySet()) {
1706
      auto iter = version_edits.find(cfd->GetID());
1707 1708 1709
      assert(iter != version_edits.end());
      VersionEdit* edit = &iter->second;

S
Stanislau Hlebik 已提交
1710
      if (cfd->GetLogNumber() > max_log_number) {
1711
        // Column family cfd has already flushed the data
S
Stanislau Hlebik 已提交
1712
        // from all logs. Memtable has to be empty because
1713
        // we filter the updates based on log_number
1714
        // (in WriteBatch::InsertInto)
1715 1716 1717 1718 1719 1720 1721
        assert(cfd->mem()->GetFirstSequenceNumber() == 0);
        assert(edit->NumEntries() == 0);
        continue;
      }

      // flush the final memtable (if non-empty)
      if (cfd->mem()->GetFirstSequenceNumber() != 0) {
1722 1723 1724
        // 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.
1725
        if (flushed || !immutable_db_options_.avoid_flush_during_recovery) {
1726 1727 1728 1729 1730 1731
          status = WriteLevel0TableForRecovery(job_id, cfd, cfd->mem(), edit);
          if (!status.ok()) {
            // Recovery failed
            break;
          }
          flushed = true;
A
agiardullo 已提交
1732

1733
          cfd->CreateNewMemtable(*cfd->GetLatestMutableCFOptions(),
1734
                                 versions_->LastSequence());
1735
        }
A
Andrew Kryczka 已提交
1736
        data_seen = true;
1737
      }
J
jorlow@chromium.org 已提交
1738

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

A
Andrew Kryczka 已提交
1762
  if (data_seen && !flushed) {
1763 1764 1765 1766 1767 1768 1769
    // 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));
    }
  }

1770 1771 1772
  event_logger_.Log() << "job" << job_id << "event"
                      << "recovery_finished";

J
jorlow@chromium.org 已提交
1773 1774 1775
  return status;
}

1776 1777
Status DBImpl::WriteLevel0TableForRecovery(int job_id, ColumnFamilyData* cfd,
                                           MemTable* mem, VersionEdit* edit) {
J
jorlow@chromium.org 已提交
1778
  mutex_.AssertHeld();
1779
  const uint64_t start_micros = env_->NowMicros();
J
jorlow@chromium.org 已提交
1780
  FileMetaData meta;
I
Igor Canadi 已提交
1781 1782
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();
1783
  meta.fd = FileDescriptor(versions_->NewFileNumber(), 0, 0);
1784 1785
  ReadOptions ro;
  ro.total_order_seek = true;
1786
  Arena arena;
1787
  Status s;
1788
  TableProperties table_properties;
1789
  {
1790
    ScopedArenaIterator iter(mem->NewIterator(ro, &arena));
1791
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
1792 1793
        "[%s] [WriteLevel0TableForRecovery]"
        " Level-0 table #%" PRIu64 ": started",
1794
        cfd->GetName().c_str(), meta.fd.GetNumber());
1795

A
Aaron Gao 已提交
1796 1797 1798
    // Get the latest mutable cf options while the mutex is still locked
    const MutableCFOptions mutable_cf_options =
        *cfd->GetLatestMutableCFOptions();
1799 1800
    bool paranoid_file_checks =
        cfd->GetLatestMutableCFOptions()->paranoid_file_checks;
1801 1802
    {
      mutex_.Unlock();
1803 1804 1805 1806 1807

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

1808
      s = BuildTable(
A
Aaron Gao 已提交
1809
          dbname_, env_, *cfd->ioptions(), mutable_cf_options, env_options_,
A
Andrew Kryczka 已提交
1810
          cfd->table_cache(), iter.get(),
1811
          std::unique_ptr<InternalIterator>(mem->NewRangeTombstoneIterator(ro)),
A
Andrew Kryczka 已提交
1812
          &meta, cfd->internal_comparator(),
1813 1814
          cfd->int_tbl_prop_collector_factories(), cfd->GetID(), cfd->GetName(),
          snapshot_seqs, earliest_write_conflict_snapshot,
A
Aaron Gao 已提交
1815
          GetCompressionFlush(*cfd->ioptions(), mutable_cf_options),
1816
          cfd->ioptions()->compression_opts, paranoid_file_checks,
1817 1818
          cfd->internal_stats(), TableFileCreationReason::kRecovery,
          &event_logger_, job_id);
1819 1820
      LogFlush(immutable_db_options_.info_log);
      Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
1821 1822 1823 1824
          "[%s] [WriteLevel0TableForRecovery]"
          " Level-0 table #%" PRIu64 ": %" PRIu64 " bytes %s",
          cfd->GetName().c_str(), meta.fd.GetNumber(), meta.fd.GetFileSize(),
          s.ToString().c_str());
1825 1826
      mutex_.Lock();
    }
1827
  }
I
Igor Canadi 已提交
1828
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
1829 1830 1831 1832

  // Note that if file_size is zero, the file has been deleted and
  // should not be added to the manifest.
  int level = 0;
1833
  if (s.ok() && meta.fd.GetFileSize() > 0) {
1834 1835
    edit->AddFile(level, meta.fd.GetNumber(), meta.fd.GetPathId(),
                  meta.fd.GetFileSize(), meta.smallest, meta.largest,
1836 1837
                  meta.smallest_seqno, meta.largest_seqno,
                  meta.marked_for_compaction);
1838 1839
  }

L
Lei Jin 已提交
1840
  InternalStats::CompactionStats stats(1);
1841
  stats.micros = env_->NowMicros() - start_micros;
1842
  stats.bytes_written = meta.fd.GetFileSize();
1843
  stats.num_output_files = 1;
1844
  cfd->internal_stats()->AddCompactionStats(level, stats);
1845 1846
  cfd->internal_stats()->AddCFStats(
      InternalStats::BYTES_FLUSHED, meta.fd.GetFileSize());
L
Lei Jin 已提交
1847
  RecordTick(stats_, COMPACT_WRITE_BYTES, meta.fd.GetFileSize());
J
jorlow@chromium.org 已提交
1848 1849 1850
  return s;
}

1851
Status DBImpl::SyncClosedLogs(JobContext* job_context) {
1852
  TEST_SYNC_POINT("DBImpl::SyncClosedLogs:Start");
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872
  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) {
1873
      Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
1874 1875
          "[JOB %d] Syncing log #%" PRIu64, job_context->job_id,
          log->get_log_number());
1876
      s = log->file()->Sync(immutable_db_options_.use_fsync);
1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888
    }
    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;
1889
      TEST_SYNC_POINT("DBImpl::SyncClosedLogs:Failed");
1890 1891 1892 1893 1894 1895
      return s;
    }
  }
  return s;
}

1896 1897
Status DBImpl::FlushMemTableToOutputFile(
    ColumnFamilyData* cfd, const MutableCFOptions& mutable_cf_options,
1898
    bool* made_progress, JobContext* job_context, LogBuffer* log_buffer) {
1899
  mutex_.AssertHeld();
1900
  assert(cfd->imm()->NumNotFlushed() != 0);
1901
  assert(cfd->imm()->IsFlushPending());
1902

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

A
Aaron Gao 已提交
1907
  FlushJob flush_job(
1908
      dbname_, cfd, immutable_db_options_, mutable_cf_options, env_options_,
A
Aaron Gao 已提交
1909 1910 1911 1912 1913
      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);
1914

1915
  FileMetaData file_meta;
1916

1917 1918 1919 1920
  flush_job.PickMemTable();

  Status s;
  if (logfile_number_ > 0 &&
S
Sagar Vemuri 已提交
1921
      versions_->GetColumnFamilySet()->NumberOfColumnFamilies() > 0) {
1922 1923 1924 1925 1926 1927 1928 1929 1930
    // 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);
  }

1931 1932 1933 1934 1935 1936
  // 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.
1937 1938
  if (s.ok()) {
    s = flush_job.Run(&file_meta);
1939 1940
  } else {
    flush_job.Cancel();
1941
  }
J
jorlow@chromium.org 已提交
1942 1943

  if (s.ok()) {
I
Igor Canadi 已提交
1944 1945
    InstallSuperVersionAndScheduleWorkWrapper(cfd, job_context,
                                              mutable_cf_options);
1946 1947
    if (made_progress) {
      *made_progress = 1;
1948
    }
S
sdong 已提交
1949
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Igor Canadi 已提交
1950
    LogToBuffer(log_buffer, "[%s] Level summary: %s\n", cfd->GetName().c_str(),
S
sdong 已提交
1951
                cfd->current()->storage_info()->LevelSummary(&tmp));
J
jorlow@chromium.org 已提交
1952
  }
1953

1954 1955
  if (!s.ok() && !s.IsShutdownInProgress() &&
      immutable_db_options_.paranoid_checks && bg_error_.ok()) {
1956 1957 1958 1959
    // if a bad error happened (not ShutdownInProgress) and paranoid_checks is
    // true, mark DB read-only
    bg_error_ = s;
  }
1960
  if (s.ok()) {
1961
#ifndef ROCKSDB_LITE
1962
    // may temporarily unlock and lock the mutex.
1963
    NotifyOnFlushCompleted(cfd, &file_meta, mutable_cf_options,
1964
                           job_context->job_id, flush_job.GetTableProperties());
1965 1966
    auto sfm = static_cast<SstFileManagerImpl*>(
        immutable_db_options_.sst_file_manager.get());
1967 1968
    if (sfm) {
      // Notify sst_file_manager that a new file was added
1969 1970
      std::string file_path = MakeTableFileName(
          immutable_db_options_.db_paths[0].path, file_meta.fd.GetNumber());
1971
      sfm->OnAddFile(file_path);
1972 1973
      if (sfm->IsMaxAllowedSpaceReached() && bg_error_.ok()) {
        bg_error_ = Status::IOError("Max allowed space was reached");
L
Leonidas Galanis 已提交
1974 1975 1976
        TEST_SYNC_POINT_CALLBACK(
            "DBImpl::FlushMemTableToOutputFile:MaxAllowedSpaceReached",
            &bg_error_);
1977
      }
1978
    }
1979
#endif  // ROCKSDB_LITE
1980
  }
J
jorlow@chromium.org 已提交
1981 1982 1983
  return s;
}

1984 1985 1986 1987
void DBImpl::NotifyOnFlushCompleted(ColumnFamilyData* cfd,
                                    FileMetaData* file_meta,
                                    const MutableCFOptions& mutable_cf_options,
                                    int job_id, TableProperties prop) {
1988
#ifndef ROCKSDB_LITE
1989
  if (immutable_db_options_.listeners.size() == 0U) {
1990 1991
    return;
  }
1992 1993 1994 1995
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
1996
  bool triggered_writes_slowdown =
1997
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
1998
       mutable_cf_options.level0_slowdown_writes_trigger);
1999
  bool triggered_writes_stop =
2000
      (cfd->current()->storage_info()->NumLevelFiles(0) >=
2001
       mutable_cf_options.level0_stop_writes_trigger);
2002 2003
  // release lock while notifying events
  mutex_.Unlock();
2004
  {
2005 2006 2007 2008
    FlushJobInfo info;
    info.cf_name = cfd->GetName();
    // TODO(yhchiang): make db_paths dynamic in case flush does not
    //                 go to L0 in the future.
2009
    info.file_path = MakeTableFileName(immutable_db_options_.db_paths[0].path,
2010
                                       file_meta->fd.GetNumber());
2011
    info.thread_id = env_->GetThreadID();
2012 2013 2014
    info.job_id = job_id;
    info.triggered_writes_slowdown = triggered_writes_slowdown;
    info.triggered_writes_stop = triggered_writes_stop;
2015 2016
    info.smallest_seqno = file_meta->smallest_seqno;
    info.largest_seqno = file_meta->largest_seqno;
2017
    info.table_properties = prop;
2018
    for (auto listener : immutable_db_options_.listeners) {
2019
      listener->OnFlushCompleted(this, info);
2020 2021
    }
  }
2022 2023 2024
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
2025
#endif  // ROCKSDB_LITE
2026 2027
}

2028 2029 2030
Status DBImpl::CompactRange(const CompactRangeOptions& options,
                            ColumnFamilyHandle* column_family,
                            const Slice* begin, const Slice* end) {
2031
  if (options.target_path_id >= immutable_db_options_.db_paths.size()) {
2032 2033 2034
    return Status::InvalidArgument("Invalid target path ID");
  }

2035 2036
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
2037
  bool exclusive = options.exclusive_manual_compaction;
I
Igor Canadi 已提交
2038 2039

  Status s = FlushMemTable(cfd, FlushOptions());
L
Lei Jin 已提交
2040
  if (!s.ok()) {
2041
    LogFlush(immutable_db_options_.info_log);
L
Lei Jin 已提交
2042 2043 2044
    return s;
  }

I
Igor Canadi 已提交
2045
  int max_level_with_files = 0;
G
Gabor Cselle 已提交
2046
  {
2047
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
2048
    Version* base = cfd->current();
2049 2050
    for (int level = 1; level < base->storage_info()->num_non_empty_levels();
         level++) {
S
sdong 已提交
2051
      if (base->storage_info()->OverlapInLevel(level, begin, end)) {
G
Gabor Cselle 已提交
2052 2053 2054 2055
        max_level_with_files = level;
      }
    }
  }
2056

2057
  int final_output_level = 0;
2058 2059 2060 2061
  if (cfd->ioptions()->compaction_style == kCompactionStyleUniversal &&
      cfd->NumberLevels() > 1) {
    // Always compact all files together.
    s = RunManualCompaction(cfd, ColumnFamilyData::kCompactAllLevels,
2062
                            cfd->NumberLevels() - 1, options.target_path_id,
2063
                            begin, end, exclusive);
2064
    final_output_level = cfd->NumberLevels() - 1;
2065 2066
  } else {
    for (int level = 0; level <= max_level_with_files; level++) {
2067
      int output_level;
A
Andres Notzli 已提交
2068
      // in case the compaction is universal or if we're compacting the
2069 2070 2071 2072
      // 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 ||
2073 2074 2075
          cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
        output_level = level;
      } else if (level == max_level_with_files && level > 0) {
2076 2077 2078 2079 2080 2081 2082
        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 已提交
2083
                   cfd->ioptions()->compaction_filter_factory == nullptr) {
A
Andres Notzli 已提交
2084 2085
          // Skip bottommost level compaction since we don't have a compaction
          // filter
2086 2087
          continue;
        }
2088
        output_level = level;
2089
      } else {
2090
        output_level = level + 1;
2091 2092 2093 2094 2095
        if (cfd->ioptions()->compaction_style == kCompactionStyleLevel &&
            cfd->ioptions()->level_compaction_dynamic_level_bytes &&
            level == 0) {
          output_level = ColumnFamilyData::kCompactToBaseLevel;
        }
2096
      }
2097
      s = RunManualCompaction(cfd, level, output_level, options.target_path_id,
2098
                              begin, end, exclusive);
2099 2100 2101
      if (!s.ok()) {
        break;
      }
2102 2103 2104 2105 2106
      if (output_level == ColumnFamilyData::kCompactToBaseLevel) {
        final_output_level = cfd->NumberLevels() - 1;
      } else if (output_level > final_output_level) {
        final_output_level = output_level;
      }
2107 2108
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::1");
      TEST_SYNC_POINT("DBImpl::RunManualCompaction()::2");
2109
    }
G
Gabor Cselle 已提交
2110
  }
2111
  if (!s.ok()) {
2112
    LogFlush(immutable_db_options_.info_log);
2113 2114
    return s;
  }
2115

2116
  if (options.change_level) {
2117
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2118 2119 2120 2121 2122 2123
        "[RefitLevel] waiting for background threads to stop");
    s = PauseBackgroundWork();
    if (s.ok()) {
      s = ReFitLevel(cfd, final_output_level, options.target_level);
    }
    ContinueBackgroundWork();
2124
  }
2125
  LogFlush(immutable_db_options_.info_log);
L
Lei Jin 已提交
2126

2127
  {
2128
    InstrumentedMutexLock l(&mutex_);
2129 2130 2131 2132 2133
    // an automatic compaction that has been scheduled might have been
    // preempted by the manual compactions. Need to schedule it back.
    MaybeScheduleFlushOrCompaction();
  }

L
Lei Jin 已提交
2134
  return s;
2135 2136
}

2137 2138 2139 2140 2141
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 已提交
2142 2143 2144 2145
#ifdef ROCKSDB_LITE
    // not supported in lite version
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
2146 2147 2148 2149 2150 2151
  if (column_family == nullptr) {
    return Status::InvalidArgument("ColumnFamilyHandle must be non-null.");
  }

  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  assert(cfd);
2152 2153 2154 2155

  Status s;
  JobContext job_context(0, true);
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
2156
                       immutable_db_options_.info_log.get());
2157 2158

  // Perform CompactFiles
2159
  SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
2160 2161 2162
  {
    InstrumentedMutexLock l(&mutex_);

2163
    // This call will unlock/lock the mutex to wait for current running
2164 2165
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
2166

2167 2168 2169 2170
    s = CompactFilesImpl(compact_options, cfd, sv->current,
                         input_file_names, output_level,
                         output_path_id, &job_context, &log_buffer);
  }
2171 2172 2173 2174 2175 2176
  if (sv->Unref()) {
    mutex_.Lock();
    sv->Cleanup();
    mutex_.Unlock();
    delete sv;
  }
2177 2178 2179 2180 2181 2182 2183 2184 2185

  // 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());
2186
  }  // release the mutex
2187 2188 2189 2190 2191 2192 2193 2194 2195 2196

  // 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()) {
2197
      // no mutex is locked here.  No need to Unlock() and Lock() here.
2198 2199 2200 2201 2202
      PurgeObsoleteFiles(job_context);
    }
    job_context.Clean();
  }

2203
  return s;
I
Igor Canadi 已提交
2204
#endif  // ROCKSDB_LITE
2205 2206
}

I
Igor Canadi 已提交
2207
#ifndef ROCKSDB_LITE
2208 2209 2210
Status DBImpl::CompactFilesImpl(
    const CompactionOptions& compact_options, ColumnFamilyData* cfd,
    Version* version, const std::vector<std::string>& input_file_names,
2211 2212
    const int output_level, int output_path_id, JobContext* job_context,
    LogBuffer* log_buffer) {
2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229
  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) {
2230
    if (immutable_db_options_.db_paths.size() == 1U) {
2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244
      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;
  }

2245
  std::vector<CompactionInputFiles> input_files;
2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265
  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(
2266 2267
      compact_options, input_files, output_level, version->storage_info(),
      *cfd->GetLatestMutableCFOptions(), output_path_id));
2268 2269 2270
  if (!c) {
    return Status::Aborted("Another Level 0 compaction is running");
  }
2271 2272
  c->SetInputVersion(version);
  // deletion compaction currently not allowed in CompactFiles.
2273
  assert(!c->deletion_compaction());
2274

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

2279 2280 2281
  auto pending_outputs_inserted_elem =
      CaptureCurrentFileNumberInPendingOutputs();

I
Igor Canadi 已提交
2282
  assert(is_snapshot_supported_ || snapshots_.empty());
2283
  CompactionJob compaction_job(
2284 2285
      job_context->job_id, c.get(), immutable_db_options_, env_options_,
      versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
2286 2287 2288
      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,
2289
      c->mutable_cf_options()->report_bg_io_stats, dbname_,
2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302
      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.
2303 2304 2305 2306 2307

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

2311 2312 2313
  compaction_job.Prepare();

  mutex_.Unlock();
2314 2315
  TEST_SYNC_POINT("CompactFilesImpl:0");
  TEST_SYNC_POINT("CompactFilesImpl:1");
2316
  compaction_job.Run();
2317 2318
  TEST_SYNC_POINT("CompactFilesImpl:2");
  TEST_SYNC_POINT("CompactFilesImpl:3");
2319
  mutex_.Lock();
2320

2321
  Status status = compaction_job.Install(*c->mutable_cf_options());
2322
  if (status.ok()) {
I
Igor Canadi 已提交
2323 2324
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
2325 2326 2327
  }
  c->ReleaseCompactionFiles(s);

2328
  ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);
2329 2330 2331 2332 2333 2334

  if (status.ok()) {
    // Done
  } else if (status.IsShutdownInProgress()) {
    // Ignore compaction errors found during shutting down
  } else {
2335
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
2336
        "[%s] [JOB %d] Compaction error: %s",
2337
        c->column_family_data()->GetName().c_str(), job_context->job_id,
2338
        status.ToString().c_str());
2339
    if (immutable_db_options_.paranoid_checks && bg_error_.ok()) {
2340 2341 2342 2343
      bg_error_ = status;
    }
  }

2344 2345
  c.reset();

2346
  bg_compaction_scheduled_--;
2347 2348 2349
  if (bg_compaction_scheduled_ == 0) {
    bg_cv_.SignalAll();
  }
2350 2351 2352

  return status;
}
I
Igor Canadi 已提交
2353
#endif  // ROCKSDB_LITE
2354

2355 2356
Status DBImpl::PauseBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
2357
  bg_compaction_paused_++;
2358 2359 2360
  while (bg_compaction_scheduled_ > 0 || bg_flush_scheduled_ > 0) {
    bg_cv_.Wait();
  }
2361
  bg_work_paused_++;
2362 2363 2364 2365 2366
  return Status::OK();
}

Status DBImpl::ContinueBackgroundWork() {
  InstrumentedMutexLock guard_lock(&mutex_);
2367 2368 2369
  if (bg_work_paused_ == 0) {
    return Status::InvalidArgument();
  }
2370
  assert(bg_work_paused_ > 0);
2371 2372
  assert(bg_compaction_paused_ > 0);
  bg_compaction_paused_--;
2373
  bg_work_paused_--;
2374 2375
  // It's sufficient to check just bg_work_paused_ here since
  // bg_work_paused_ is always no greater than bg_compaction_paused_
2376 2377 2378 2379 2380 2381
  if (bg_work_paused_ == 0) {
    MaybeScheduleFlushOrCompaction();
  }
  return Status::OK();
}

O
Ori Bernstein 已提交
2382
void DBImpl::NotifyOnCompactionCompleted(
2383 2384
    ColumnFamilyData* cfd, Compaction *c, const Status &st,
    const CompactionJobStats& compaction_job_stats,
2385
    const int job_id) {
O
Ori Bernstein 已提交
2386
#ifndef ROCKSDB_LITE
2387
  if (immutable_db_options_.listeners.size() == 0U) {
O
Ori Bernstein 已提交
2388 2389 2390 2391 2392 2393 2394 2395
    return;
  }
  mutex_.AssertHeld();
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }
  // release lock while notifying events
  mutex_.Unlock();
2396
  TEST_SYNC_POINT("DBImpl::NotifyOnCompactionCompleted::UnlockMutex");
2397 2398 2399 2400
  {
    CompactionJobInfo info;
    info.cf_name = cfd->GetName();
    info.status = st;
2401
    info.thread_id = env_->GetThreadID();
2402 2403
    info.job_id = job_id;
    info.base_input_level = c->start_level();
2404
    info.output_level = c->output_level();
2405
    info.stats = compaction_job_stats;
2406
    info.table_properties = c->GetOutputTableProperties();
2407
    info.compaction_reason = c->compaction_reason();
2408
    info.compression = c->output_compression();
2409 2410
    for (size_t i = 0; i < c->num_input_levels(); ++i) {
      for (const auto fmd : *c->inputs(i)) {
2411 2412
        auto fn = TableFileName(immutable_db_options_.db_paths,
                                fmd->fd.GetNumber(), fmd->fd.GetPathId());
2413 2414 2415
        info.input_files.push_back(fn);
        if (info.table_properties.count(fn) == 0) {
          std::shared_ptr<const TableProperties> tp;
2416
          auto s = cfd->current()->GetTableProperties(&tp, fmd, &fn);
2417 2418 2419 2420
          if (s.ok()) {
            info.table_properties[fn] = tp;
          }
        }
2421 2422 2423
      }
    }
    for (const auto newf : c->edit()->GetNewFiles()) {
2424 2425 2426
      info.output_files.push_back(TableFileName(immutable_db_options_.db_paths,
                                                newf.second.fd.GetNumber(),
                                                newf.second.fd.GetPathId()));
2427
    }
2428
    for (auto listener : immutable_db_options_.listeners) {
2429 2430 2431
      listener->OnCompactionCompleted(this, info);
    }
  }
O
Ori Bernstein 已提交
2432 2433 2434 2435 2436 2437
  mutex_.Lock();
  // no need to signal bg_cv_ as it will be signaled at the end of the
  // flush process.
#endif  // ROCKSDB_LITE
}

2438
Status DBImpl::SetOptions(ColumnFamilyHandle* column_family,
2439
    const std::unordered_map<std::string, std::string>& options_map) {
I
Igor Canadi 已提交
2440 2441 2442
#ifdef ROCKSDB_LITE
  return Status::NotSupported("Not supported in ROCKSDB LITE");
#else
L
Lei Jin 已提交
2443 2444
  auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
  if (options_map.empty()) {
2445 2446
    Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
        "SetOptions() on column family [%s], empty input",
L
Lei Jin 已提交
2447
        cfd->GetName().c_str());
2448
    return Status::InvalidArgument("empty input");
L
Lei Jin 已提交
2449 2450 2451
  }

  MutableCFOptions new_options;
2452
  Status s;
2453
  Status persist_options_status;
L
Lei Jin 已提交
2454
  {
2455
    InstrumentedMutexLock l(&mutex_);
2456 2457
    s = cfd->SetOptions(options_map);
    if (s.ok()) {
L
Lei Jin 已提交
2458
      new_options = *cfd->GetLatestMutableCFOptions();
2459 2460 2461 2462
      // Append new version to recompute compaction score.
      VersionEdit dummy_edit;
      versions_->LogAndApply(cfd, new_options, &dummy_edit, &mutex_,
                             directories_.GetDbDir());
2463 2464 2465 2466 2467 2468
      // 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;
2469

2470
      persist_options_status = PersistOptions();
2471 2472
    }
  }
L
Lei Jin 已提交
2473

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

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

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

2529 2530
      write_controller_.set_max_delayed_write_rate(new_options.delayed_write_rate);

2531 2532
      mutable_db_options_ = new_options;

2533
      if (total_log_size_ > GetMaxTotalWalSize()) {
2534
        MaybeFlushColumnFamilies();
2535 2536
      }

2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562
      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 已提交
2563
  }
2564
  LogFlush(immutable_db_options_.info_log);
2565
  return s;
I
Igor Canadi 已提交
2566
#endif  // ROCKSDB_LITE
2567 2568
}

2569 2570 2571 2572 2573 2574 2575 2576 2577
Status DBImpl::PersistOptions() {
  mutex_.AssertHeld();
  WriteThread::Writer w;
  write_thread_.EnterUnbatched(&w, &mutex_);
  Status s = WriteOptionsFile();
  write_thread_.ExitUnbatched(&w);
  return s;
}

2578
// return the same level if it cannot be moved
2579 2580
int DBImpl::FindMinimumEmptyLevelFitting(ColumnFamilyData* cfd,
    const MutableCFOptions& mutable_cf_options, int level) {
2581
  mutex_.AssertHeld();
S
sdong 已提交
2582
  const auto* vstorage = cfd->current()->storage_info();
2583
  int minimum_level = level;
2584
  for (int i = level - 1; i > 0; --i) {
2585
    // stop if level i is not empty
S
sdong 已提交
2586
    if (vstorage->NumLevelFiles(i) > 0) break;
2587
    // stop if level i is too small (cannot fit the level files)
2588
    if (vstorage->MaxBytesForLevel(i) < vstorage->NumLevelBytes(level)) {
2589 2590
      break;
    }
2591 2592 2593 2594 2595 2596

    minimum_level = i;
  }
  return minimum_level;
}

2597 2598
// REQUIREMENT: block all background work by calling PauseBackgroundWork()
// before calling this function
I
Igor Canadi 已提交
2599 2600
Status DBImpl::ReFitLevel(ColumnFamilyData* cfd, int level, int target_level) {
  assert(level < cfd->NumberLevels());
2601 2602 2603
  if (target_level >= cfd->NumberLevels()) {
    return Status::InvalidArgument("Target level exceeds number of levels");
  }
2604

2605 2606 2607 2608
  std::unique_ptr<SuperVersion> superversion_to_free;
  std::unique_ptr<SuperVersion> new_superversion(new SuperVersion());

  Status status;
I
Igor Canadi 已提交
2609

I
Islam AbdelRahman 已提交
2610
  InstrumentedMutexLock guard_lock(&mutex_);
2611 2612 2613

  // only allow one thread refitting
  if (refitting_level_) {
2614
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2615
        "[ReFitLevel] another thread is refitting");
L
Lei Jin 已提交
2616
    return Status::NotSupported("another thread is refitting");
2617 2618 2619
  }
  refitting_level_ = true;

2620
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
2621
  // move to a smaller level
2622 2623
  int to_level = target_level;
  if (target_level < 0) {
2624
    to_level = FindMinimumEmptyLevelFitting(cfd, mutable_cf_options, level);
2625
  }
2626

2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641
  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) {
2642
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2643 2644
        "[%s] Before refitting:\n%s", cfd->GetName().c_str(),
        cfd->current()->DebugString().data());
2645

2646
    VersionEdit edit;
I
Igor Canadi 已提交
2647
    edit.SetColumnFamily(cfd->GetID());
2648
    for (const auto& f : vstorage->LevelFiles(level)) {
2649
      edit.DeleteFile(level, f->fd.GetNumber());
2650 2651
      edit.AddFile(to_level, f->fd.GetNumber(), f->fd.GetPathId(),
                   f->fd.GetFileSize(), f->smallest, f->largest,
2652 2653
                   f->smallest_seqno, f->largest_seqno,
                   f->marked_for_compaction);
2654
    }
2655
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2656 2657
        "[%s] Apply version edit:\n%s", cfd->GetName().c_str(),
        edit.DebugString().data());
2658

2659 2660
    status = versions_->LogAndApply(cfd, mutable_cf_options, &edit, &mutex_,
                                    directories_.GetDbDir());
2661 2662
    superversion_to_free.reset(InstallSuperVersionAndScheduleWork(
        cfd, new_superversion.release(), mutable_cf_options));
2663

2664
    Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2665
        "[%s] LogAndApply: %s\n", cfd->GetName().c_str(),
I
Igor Canadi 已提交
2666
        status.ToString().data());
2667 2668

    if (status.ok()) {
2669
      Log(InfoLogLevel::DEBUG_LEVEL, immutable_db_options_.info_log,
2670 2671
          "[%s] After refitting:\n%s", cfd->GetName().c_str(),
          cfd->current()->DebugString().data());
2672 2673 2674 2675
    }
  }

  refitting_level_ = false;
I
Igor Canadi 已提交
2676

L
Lei Jin 已提交
2677
  return status;
G
Gabor Cselle 已提交
2678 2679
}

2680 2681 2682
int DBImpl::NumberLevels(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  return cfh->cfd()->NumberLevels();
2683 2684
}

2685
int DBImpl::MaxMemCompactionLevel(ColumnFamilyHandle* column_family) {
2686
  return 0;
2687 2688
}

2689 2690
int DBImpl::Level0StopWriteTrigger(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
2691
  InstrumentedMutexLock l(&mutex_);
L
Lei Jin 已提交
2692 2693
  return cfh->cfd()->GetSuperVersion()->
      mutable_cf_options.level0_stop_writes_trigger;
2694 2695
}

L
Lei Jin 已提交
2696
Status DBImpl::Flush(const FlushOptions& flush_options,
2697 2698
                     ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
L
Lei Jin 已提交
2699
  return FlushMemTable(cfh->cfd(), flush_options);
H
heyongqiang 已提交
2700 2701
}

2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722
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(
2723 2724 2725 2726
            "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());
2727 2728 2729 2730 2731 2732 2733
      }
    }
    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;
2734
      logs_to_sync.push_back(log.writer);
2735 2736 2737 2738 2739
    }

    need_log_dir_sync = !log_dir_synced_;
  }

2740
  RecordTick(stats_, WAL_FILE_SYNCED);
2741 2742
  Status status;
  for (log::Writer* log : logs_to_sync) {
2743
    status = log->file()->SyncWithoutFlush(immutable_db_options_.use_fsync);
2744 2745 2746 2747 2748 2749 2750 2751
    if (!status.ok()) {
      break;
    }
  }
  if (status.ok() && need_log_dir_sync) {
    status = directories_.GetWalDir()->Fsync();
  }

2752
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:1");
2753 2754 2755 2756
  {
    InstrumentedMutexLock l(&mutex_);
    MarkLogsSynced(current_log_number, need_log_dir_sync, status);
  }
2757
  TEST_SYNC_POINT("DBImpl::SyncWAL:BeforeMarkLogsSynced:2");
2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773

  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) {
2774
      logs_to_free_.push_back(log.ReleaseWriter());
A
Andres Noetzli 已提交
2775
      it = logs_.erase(it);
2776 2777 2778 2779 2780
    } else {
      log.getting_synced = false;
      ++it;
    }
  }
2781
  assert(!status.ok() || logs_.empty() || logs_[0].number > up_to ||
2782
         (logs_.size() == 1 && !logs_[0].getting_synced));
2783 2784 2785
  log_sync_cv_.SignalAll();
}

2786
SequenceNumber DBImpl::GetLatestSequenceNumber() const {
2787 2788 2789
  return versions_->LastSequence();
}

I
Igor Canadi 已提交
2790
Status DBImpl::RunManualCompaction(ColumnFamilyData* cfd, int input_level,
2791
                                   int output_level, uint32_t output_path_id,
2792
                                   const Slice* begin, const Slice* end,
2793
                                   bool exclusive, bool disallow_trivial_move) {
2794 2795
  assert(input_level == ColumnFamilyData::kCompactAllLevels ||
         input_level >= 0);
2796

G
Gabor Cselle 已提交
2797
  InternalKey begin_storage, end_storage;
2798
  CompactionArg* ca;
G
Gabor Cselle 已提交
2799

2800 2801
  bool scheduled = false;
  bool manual_conflict = false;
H
hans@chromium.org 已提交
2802
  ManualCompaction manual;
I
Igor Canadi 已提交
2803
  manual.cfd = cfd;
2804 2805
  manual.input_level = input_level;
  manual.output_level = output_level;
2806
  manual.output_path_id = output_path_id;
G
Gabor Cselle 已提交
2807
  manual.done = false;
2808
  manual.in_progress = false;
2809 2810
  manual.incomplete = false;
  manual.exclusive = exclusive;
2811
  manual.disallow_trivial_move = disallow_trivial_move;
2812 2813 2814
  // For universal compaction, we enforce every manual compaction to compact
  // all files.
  if (begin == nullptr ||
2815 2816
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2817
    manual.begin = nullptr;
G
Gabor Cselle 已提交
2818
  } else {
2819
    begin_storage.SetMaxPossibleForUserKey(*begin);
G
Gabor Cselle 已提交
2820 2821
    manual.begin = &begin_storage;
  }
2822
  if (end == nullptr ||
2823 2824
      cfd->ioptions()->compaction_style == kCompactionStyleUniversal ||
      cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
2825
    manual.end = nullptr;
G
Gabor Cselle 已提交
2826
  } else {
2827
    end_storage.SetMinPossibleForUserKey(*end);
G
Gabor Cselle 已提交
2828 2829 2830
    manual.end = &end_storage;
  }

2831 2832
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:0");
  TEST_SYNC_POINT("DBImpl::RunManualCompaction:1");
2833
  InstrumentedMutexLock l(&mutex_);
2834

2835 2836 2837 2838 2839
  // 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.
  //
2840
  // HasPendingManualCompaction() is true when at least one thread is inside
2841
  // RunManualCompaction(), i.e. during that time no other compaction will
2842 2843 2844
  // get scheduled (see MaybeScheduleFlushOrCompaction).
  //
  // Note that the following loop doesn't stop more that one thread calling
2845
  // RunManualCompaction() from getting to the second while loop below.
2846 2847 2848
  // However, only one of them will actually schedule compaction, while
  // others will wait on a condition variable until it completes.

2849 2850 2851 2852
  AddManualCompaction(&manual);
  TEST_SYNC_POINT_CALLBACK("DBImpl::RunManualCompaction:NotScheduled", &mutex_);
  if (exclusive) {
    while (bg_compaction_scheduled_ > 0) {
2853
      Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
2854 2855 2856 2857 2858
          "[%s] Manual compaction waiting for all other scheduled background "
          "compactions to finish",
          cfd->GetName().c_str());
      bg_cv_.Wait();
    }
2859
  }
2860

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

2864 2865 2866 2867
  // 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) {
2868 2869
    assert(HasPendingManualCompaction());
    manual_conflict = false;
2870
    if (ShouldntRunManualCompaction(&manual) || (manual.in_progress == true) ||
2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881
        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);
2882
      // Running either this or some other manual compaction
G
Gabor Cselle 已提交
2883
      bg_cv_.Wait();
2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898
      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;
2899
      bg_compaction_scheduled_++;
2900 2901 2902
      env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                     &DBImpl::UnscheduleCallback);
      scheduled = true;
G
Gabor Cselle 已提交
2903
    }
H
hans@chromium.org 已提交
2904
  }
2905

2906
  assert(!manual.in_progress);
2907 2908
  assert(HasPendingManualCompaction());
  RemoveManualCompaction(&manual);
2909
  bg_cv_.SignalAll();
L
Lei Jin 已提交
2910
  return manual.status;
J
jorlow@chromium.org 已提交
2911 2912
}

2913
InternalIterator* DBImpl::NewInternalIterator(
A
Andrew Kryczka 已提交
2914 2915
    Arena* arena, RangeDelAggregator* range_del_agg,
    ColumnFamilyHandle* column_family) {
2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927
  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 已提交
2928 2929
  return NewInternalIterator(roptions, cfd, super_version, arena,
                             range_del_agg);
2930 2931
}

2932
Status DBImpl::FlushMemTable(ColumnFamilyData* cfd,
2933 2934
                             const FlushOptions& flush_options,
                             bool writes_stopped) {
S
Stanislau Hlebik 已提交
2935 2936 2937
  Status s;
  {
    WriteContext context;
2938
    InstrumentedMutexLock guard_lock(&mutex_);
2939

2940
    if (cfd->imm()->NumNotFlushed() == 0 && cfd->mem()->IsEmpty()) {
2941 2942 2943 2944
      // Nothing to flush
      return Status::OK();
    }

2945
    WriteThread::Writer w;
2946 2947 2948
    if (!writes_stopped) {
      write_thread_.EnterUnbatched(&w, &mutex_);
    }
S
Stanislau Hlebik 已提交
2949

I
Igor Canadi 已提交
2950
    // SwitchMemtable() will release and reacquire mutex
S
Stanislau Hlebik 已提交
2951
    // during execution
I
Igor Canadi 已提交
2952
    s = SwitchMemtable(cfd, &context);
2953 2954 2955 2956

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

S
Stanislau Hlebik 已提交
2958 2959
    cfd->imm()->FlushRequested();

2960 2961 2962
    // schedule flush
    SchedulePendingFlush(cfd);
    MaybeScheduleFlushOrCompaction();
S
Stanislau Hlebik 已提交
2963
  }
S
Stanislau Hlebik 已提交
2964

L
Lei Jin 已提交
2965
  if (s.ok() && flush_options.wait) {
2966
    // Wait until the compaction completes
2967
    s = WaitForFlushMemTable(cfd);
2968 2969
  }
  return s;
J
jorlow@chromium.org 已提交
2970 2971
}

2972
Status DBImpl::WaitForFlushMemTable(ColumnFamilyData* cfd) {
2973 2974
  Status s;
  // Wait until the compaction completes
2975
  InstrumentedMutexLock l(&mutex_);
2976
  while (cfd->imm()->NumNotFlushed() > 0 && bg_error_.ok()) {
2977 2978 2979
    if (shutting_down_.load(std::memory_order_acquire)) {
      return Status::ShutdownInProgress();
    }
2980 2981 2982 2983 2984 2985
    if (cfd->IsDropped()) {
      // FlushJob cannot flush a dropped CF, if we did not break here
      // we will loop forever since cfd->imm()->NumNotFlushed() will never
      // drop to zero
      return Status::InvalidArgument("Cannot flush a dropped CF");
    }
2986 2987
    bg_cv_.Wait();
  }
2988
  if (!bg_error_.ok()) {
2989 2990 2991
    s = bg_error_;
  }
  return s;
H
heyongqiang 已提交
2992 2993
}

2994 2995 2996 2997
Status DBImpl::EnableAutoCompaction(
    const std::vector<ColumnFamilyHandle*>& column_family_handles) {
  Status s;
  for (auto cf_ptr : column_family_handles) {
2998 2999
    Status status =
        this->SetOptions(cf_ptr, {{"disable_auto_compactions", "false"}});
3000
    if (!status.ok()) {
3001
      s = status;
3002 3003 3004 3005 3006 3007
    }
  }

  return s;
}

3008
void DBImpl::MaybeScheduleFlushOrCompaction() {
J
jorlow@chromium.org 已提交
3009
  mutex_.AssertHeld();
3010 3011 3012 3013
  if (!opened_successfully_) {
    // Compaction may introduce data race to DB open
    return;
  }
3014 3015
  if (bg_work_paused_ > 0) {
    // we paused the background work
3016
    return;
I
Igor Canadi 已提交
3017
  } else if (shutting_down_.load(std::memory_order_acquire)) {
J
jorlow@chromium.org 已提交
3018
    // DB is being deleted; no more background compactions
3019 3020
    return;
  }
3021

3022
  while (unscheduled_flushes_ > 0 &&
3023
         bg_flush_scheduled_ < immutable_db_options_.max_background_flushes) {
3024 3025
    unscheduled_flushes_--;
    bg_flush_scheduled_++;
3026
    env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::HIGH, this);
3027 3028
  }

3029 3030
  auto bg_compactions_allowed = BGCompactionsAllowed();

3031 3032
  // special case -- if max_background_flushes == 0, then schedule flush on a
  // compaction thread
3033
  if (immutable_db_options_.max_background_flushes == 0) {
3034 3035
    while (unscheduled_flushes_ > 0 &&
           bg_flush_scheduled_ + bg_compaction_scheduled_ <
3036
               bg_compactions_allowed) {
3037 3038 3039 3040 3041 3042
      unscheduled_flushes_--;
      bg_flush_scheduled_++;
      env_->Schedule(&DBImpl::BGWorkFlush, this, Env::Priority::LOW, this);
    }
  }

3043 3044 3045 3046 3047
  if (bg_compaction_paused_ > 0) {
    // we paused the background compaction
    return;
  }

3048
  if (HasExclusiveManualCompaction()) {
3049 3050 3051 3052 3053
    // only manual compactions are allowed to run. don't schedule automatic
    // compactions
    return;
  }

3054
  while (bg_compaction_scheduled_ < bg_compactions_allowed &&
3055
         unscheduled_compactions_ > 0) {
3056 3057 3058
    CompactionArg* ca = new CompactionArg;
    ca->db = this;
    ca->m = nullptr;
3059 3060
    bg_compaction_scheduled_++;
    unscheduled_compactions_--;
3061 3062
    env_->Schedule(&DBImpl::BGWorkCompaction, ca, Env::Priority::LOW, this,
                   &DBImpl::UnscheduleCallback);
3063 3064 3065
  }
}

3066 3067 3068 3069 3070 3071 3072 3073 3074
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);
}

3075
int DBImpl::BGCompactionsAllowed() const {
3076
  mutex_.AssertHeld();
3077
  if (write_controller_.NeedSpeedupCompaction()) {
3078
    return mutable_db_options_.max_background_compactions;
3079
  } else {
3080
    return mutable_db_options_.base_background_compactions;
3081 3082 3083
  }
}

3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126
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_;
3127 3128 3129
  }
}

3130 3131 3132 3133 3134 3135 3136 3137
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));
}

3138
void DBImpl::BGWorkFlush(void* db) {
3139
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3140
  TEST_SYNC_POINT("DBImpl::BGWorkFlush");
3141
  reinterpret_cast<DBImpl*>(db)->BackgroundCallFlush();
3142
  TEST_SYNC_POINT("DBImpl::BGWorkFlush:done");
3143 3144
}

3145 3146 3147
void DBImpl::BGWorkCompaction(void* arg) {
  CompactionArg ca = *(reinterpret_cast<CompactionArg*>(arg));
  delete reinterpret_cast<CompactionArg*>(arg);
3148
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::LOW);
3149
  TEST_SYNC_POINT("DBImpl::BGWorkCompaction");
3150 3151 3152
  reinterpret_cast<DBImpl*>(ca.db)->BackgroundCallCompaction(ca.m);
}

3153 3154
void DBImpl::BGWorkPurge(void* db) {
  IOSTATS_SET_THREAD_POOL_ID(Env::Priority::HIGH);
3155
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:start");
3156
  reinterpret_cast<DBImpl*>(db)->BackgroundCallPurge();
3157
  TEST_SYNC_POINT("DBImpl::BGWorkPurge:end");
3158 3159
}

3160 3161 3162 3163 3164 3165 3166
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");
3167 3168
}

3169 3170 3171
void DBImpl::BackgroundCallPurge() {
  mutex_.Lock();

3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183
  // 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();
3184

3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197
      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();
    }
3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208
  }
  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();
}

3209
Status DBImpl::BackgroundFlush(bool* made_progress, JobContext* job_context,
H
Haobo Xu 已提交
3210
                               LogBuffer* log_buffer) {
3211
  mutex_.AssertHeld();
3212

3213 3214 3215 3216 3217 3218 3219
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

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

3222 3223 3224
  ColumnFamilyData* cfd = nullptr;
  while (!flush_queue_.empty()) {
    // This cfd is already referenced
I
Igor Canadi 已提交
3225
    auto first_cfd = PopFirstFromFlushQueue();
3226

I
Igor Canadi 已提交
3227
    if (first_cfd->IsDropped() || !first_cfd->imm()->IsFlushPending()) {
3228
      // can't flush this CF, try next one
I
Igor Canadi 已提交
3229 3230
      if (first_cfd->Unref()) {
        delete first_cfd;
3231 3232
      }
      continue;
3233
    }
3234 3235

    // found a flush!
I
Igor Canadi 已提交
3236
    cfd = first_cfd;
3237 3238 3239 3240 3241 3242 3243 3244 3245
    break;
  }

  if (cfd != nullptr) {
    const MutableCFOptions mutable_cf_options =
        *cfd->GetLatestMutableCFOptions();
    LogToBuffer(
        log_buffer,
        "Calling FlushMemTableToOutputFile with column "
3246 3247
        "family [%s], flush slots available %d, compaction slots allowed %d, "
        "compaction slots scheduled %d",
3248
        cfd->GetName().c_str(), immutable_db_options_.max_background_flushes,
3249
        bg_flush_scheduled_, BGCompactionsAllowed() - bg_compaction_scheduled_);
3250
    status = FlushMemTableToOutputFile(cfd, mutable_cf_options, made_progress,
3251 3252 3253
                                       job_context, log_buffer);
    if (cfd->Unref()) {
      delete cfd;
3254
    }
J
jorlow@chromium.org 已提交
3255
  }
3256
  return status;
J
jorlow@chromium.org 已提交
3257 3258
}

3259
void DBImpl::BackgroundCallFlush() {
3260
  bool made_progress = false;
3261
  JobContext job_context(next_job_id_.fetch_add(1), true);
3262 3263
  assert(bg_flush_scheduled_);

3264 3265
  TEST_SYNC_POINT("DBImpl::BackgroundCallFlush:start");

3266 3267
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
                       immutable_db_options_.info_log.get());
H
Haobo Xu 已提交
3268
  {
3269
    InstrumentedMutexLock l(&mutex_);
3270
    num_running_flushes_++;
H
Haobo Xu 已提交
3271

I
Igor Canadi 已提交
3272 3273 3274
    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

3275
    Status s = BackgroundFlush(&made_progress, &job_context, &log_buffer);
3276 3277 3278 3279 3280 3281 3282 3283 3284
    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();
3285
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
3286 3287 3288 3289
          "Waiting after background flush error: %s"
          "Accumulated background error counts: %" PRIu64,
          s.ToString().c_str(), error_cnt);
      log_buffer.FlushBufferToLog();
3290
      LogFlush(immutable_db_options_.info_log);
3291 3292
      env_->SleepForMicroseconds(1000000);
      mutex_.Lock();
H
Haobo Xu 已提交
3293 3294
    }

I
Igor Canadi 已提交
3295 3296
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

3297 3298 3299
    // 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 已提交
3300
    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
3301
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
3302
      mutex_.Unlock();
3303 3304 3305 3306 3307
      // 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 已提交
3308
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
3309 3310
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
3311
      }
I
Igor Canadi 已提交
3312
      job_context.Clean();
3313 3314
      mutex_.Lock();
    }
I
Igor Canadi 已提交
3315

3316 3317
    assert(num_running_flushes_ > 0);
    num_running_flushes_--;
H
Haobo Xu 已提交
3318
    bg_flush_scheduled_--;
3319 3320
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
H
Haobo Xu 已提交
3321
    bg_cv_.SignalAll();
I
Igor Canadi 已提交
3322 3323 3324 3325
    // 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.
3326
  }
J
jorlow@chromium.org 已提交
3327 3328
}

3329
void DBImpl::BackgroundCallCompaction(void* arg) {
3330
  bool made_progress = false;
3331
  ManualCompaction* m = reinterpret_cast<ManualCompaction*>(arg);
3332
  JobContext job_context(next_job_id_.fetch_add(1), true);
3333
  TEST_SYNC_POINT("BackgroundCallCompaction:0");
H
Haobo Xu 已提交
3334
  MaybeDumpStats();
3335 3336
  LogBuffer log_buffer(InfoLogLevel::INFO_LEVEL,
                       immutable_db_options_.info_log.get());
3337
  {
3338
    InstrumentedMutexLock l(&mutex_);
3339 3340

    // This call will unlock/lock the mutex to wait for current running
3341 3342
    // IngestExternalFile() calls to finish.
    WaitForIngestFile();
3343

3344
    num_running_compactions_++;
I
Igor Canadi 已提交
3345 3346 3347 3348

    auto pending_outputs_inserted_elem =
        CaptureCurrentFileNumberInPendingOutputs();

3349
    assert(bg_compaction_scheduled_);
3350 3351
    Status s =
        BackgroundCompaction(&made_progress, &job_context, &log_buffer, m);
3352
    TEST_SYNC_POINT("BackgroundCallCompaction:1");
3353 3354 3355 3356 3357 3358
    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 =
3359
          default_cf_internal_stats_->BumpAndGetBackgroundErrorCount();
3360 3361 3362
      bg_cv_.SignalAll();  // In case a waiter can proceed despite the error
      mutex_.Unlock();
      log_buffer.FlushBufferToLog();
3363
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
3364 3365 3366
          "Waiting after background compaction error: %s, "
          "Accumulated background error counts: %" PRIu64,
          s.ToString().c_str(), error_cnt);
3367
      LogFlush(immutable_db_options_.info_log);
3368 3369
      env_->SleepForMicroseconds(1000000);
      mutex_.Lock();
3370
    }
H
Haobo Xu 已提交
3371

I
Igor Canadi 已提交
3372 3373
    ReleaseFileNumberFromPendingOutputs(pending_outputs_inserted_elem);

3374 3375 3376 3377
    // 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());
3378 3379

    // delete unnecessary files if any, this is done outside the mutex
I
Igor Canadi 已提交
3380
    if (job_context.HaveSomethingToDelete() || !log_buffer.IsEmpty()) {
3381
      mutex_.Unlock();
3382 3383 3384 3385 3386
      // 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 已提交
3387
      log_buffer.FlushBufferToLog();
I
Igor Canadi 已提交
3388 3389
      if (job_context.HaveSomethingToDelete()) {
        PurgeObsoleteFiles(job_context);
3390
      }
I
Igor Canadi 已提交
3391
      job_context.Clean();
3392 3393
      mutex_.Lock();
    }
D
Dhruba Borthakur 已提交
3394

3395 3396
    assert(num_running_compactions_ > 0);
    num_running_compactions_--;
3397
    bg_compaction_scheduled_--;
J
jorlow@chromium.org 已提交
3398

3399 3400
    versions_->GetColumnFamilySet()->FreeDeadColumnFamilies();

3401 3402
    // See if there's more work to be done
    MaybeScheduleFlushOrCompaction();
3403 3404
    if (made_progress || bg_compaction_scheduled_ == 0 ||
        HasPendingManualCompaction()) {
3405
      // signal if
3406
      // * made_progress -- need to wakeup DelayWrite
3407
      // * bg_compaction_scheduled_ == 0 -- need to wakeup ~DBImpl
3408
      // * HasPendingManualCompaction -- need to wakeup RunManualCompaction
3409 3410 3411 3412
      // If none of this is true, there is no need to signal since nobody is
      // waiting for it
      bg_cv_.SignalAll();
    }
I
Igor Canadi 已提交
3413 3414 3415 3416
    // 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.
3417
  }
J
jorlow@chromium.org 已提交
3418 3419
}

3420 3421
Status DBImpl::BackgroundCompaction(bool* made_progress,
                                    JobContext* job_context,
3422 3423 3424
                                    LogBuffer* log_buffer, void* arg) {
  ManualCompaction* manual_compaction =
      reinterpret_cast<ManualCompaction*>(arg);
3425
  *made_progress = false;
J
jorlow@chromium.org 已提交
3426
  mutex_.AssertHeld();
3427
  TEST_SYNC_POINT("DBImpl::BackgroundCompaction:Start");
3428

3429 3430 3431 3432 3433
  bool is_manual = (manual_compaction != nullptr);

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

3435
  CompactionJobStats compaction_job_stats;
3436 3437 3438 3439 3440 3441
  Status status = bg_error_;
  if (status.ok() && shutting_down_.load(std::memory_order_acquire)) {
    status = Status::ShutdownInProgress();
  }

  if (!status.ok()) {
3442
    if (is_manual) {
3443 3444 3445 3446 3447
      manual_compaction->status = status;
      manual_compaction->done = true;
      manual_compaction->in_progress = false;
      delete manual_compaction->compaction;
      manual_compaction = nullptr;
3448
    }
3449
    return status;
3450 3451
  }

3452 3453
  if (is_manual) {
    // another thread cannot pick up the same work
3454
    manual_compaction->in_progress = true;
3455 3456 3457
  }

  unique_ptr<Compaction> c;
3458 3459
  // InternalKey manual_end_storage;
  // InternalKey* manual_end = &manual_end_storage;
H
hans@chromium.org 已提交
3460
  if (is_manual) {
3461
    ManualCompaction* m = manual_compaction;
3462
    assert(m->in_progress);
3463
    c.reset(std::move(m->compaction));
3464
    if (!c) {
3465
      m->done = true;
3466
      m->manual_end = nullptr;
3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479
      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)"),
3480
                  ((m->done || m->manual_end == nullptr)
3481
                       ? "(end)"
3482
                       : m->manual_end->DebugString().c_str()));
G
Gabor Cselle 已提交
3483
    }
3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498
  } 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();
    }

3499 3500 3501 3502 3503 3504
    if (HaveManualCompaction(cfd)) {
      // Can't compact right now, but try again later
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction()::Conflict");
      return Status::OK();
    }

3505 3506 3507 3508 3509 3510 3511 3512 3513 3514
    // 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
3515
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction():BeforePickCompaction");
3516
      c.reset(cfd->PickCompaction(*mutable_cf_options, log_buffer));
3517
      TEST_SYNC_POINT("DBImpl::BackgroundCompaction():AfterPickCompaction");
3518 3519 3520 3521 3522 3523
      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 已提交
3524
        // InstallSuperVersionAndScheduleWork
3525
        // 2) When MutableCFOptions changes. This case is also covered by
I
Igor Canadi 已提交
3526 3527
        // InstallSuperVersionAndScheduleWork, because this is when the new
        // options take effect.
3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538
        // 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 已提交
3539
        }
I
Igor Canadi 已提交
3540 3541
      }
    }
J
jorlow@chromium.org 已提交
3542 3543
  }

3544
  if (!c) {
H
hans@chromium.org 已提交
3545
    // Nothing to do
3546
    LogToBuffer(log_buffer, "Compaction nothing to do");
3547
  } else if (c->deletion_compaction()) {
I
Igor Canadi 已提交
3548 3549 3550 3551
    // 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);
3552
    assert(c->column_family_data()->ioptions()->compaction_style ==
I
Igor Canadi 已提交
3553
           kCompactionStyleFIFO);
3554 3555 3556

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

I
Igor Canadi 已提交
3557
    for (const auto& f : *c->inputs(0)) {
3558
      c->edit()->DeleteFile(c->level(), f->fd.GetNumber());
I
Igor Canadi 已提交
3559
    }
3560 3561 3562
    status = versions_->LogAndApply(c->column_family_data(),
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
3563 3564
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
3565 3566 3567
    LogToBuffer(log_buffer, "[%s] Deleted %d files\n",
                c->column_family_data()->GetName().c_str(),
                c->num_input_files(0));
3568
    *made_progress = true;
3569
  } else if (!trivial_move_disallowed && c->IsTrivialMove()) {
3570
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:TrivialMove");
3571 3572
    // Instrument for event update
    // TODO(yhchiang): add op details for showing trivial-move.
3573 3574 3575
    ThreadStatusUtil::SetColumnFamily(
        c->column_family_data(), c->column_family_data()->ioptions()->env,
        immutable_db_options_.enable_thread_tracking);
3576 3577
    ThreadStatusUtil::SetThreadOperation(ThreadStatus::OP_COMPACTION);

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

3580 3581 3582
    // Move files to next level
    int32_t moved_files = 0;
    int64_t moved_bytes = 0;
3583
    for (unsigned int l = 0; l < c->num_input_levels(); l++) {
3584
      if (c->level(l) == c->output_level()) {
3585 3586 3587 3588
        continue;
      }
      for (size_t i = 0; i < c->num_input_files(l); i++) {
        FileMetaData* f = c->input(l, i);
3589
        c->edit()->DeleteFile(c->level(l), f->fd.GetNumber());
3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601
        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();
      }
3602
    }
3603

3604
    status = versions_->LogAndApply(c->column_family_data(),
3605 3606
                                    *c->mutable_cf_options(), c->edit(),
                                    &mutex_, directories_.GetDbDir());
3607
    // Use latest MutableCFOptions
I
Igor Canadi 已提交
3608 3609
    InstallSuperVersionAndScheduleWorkWrapper(
        c->column_family_data(), job_context, *c->mutable_cf_options());
3610

S
sdong 已提交
3611
    VersionStorageInfo::LevelSummaryStorage tmp;
I
Islam AbdelRahman 已提交
3612
    c->column_family_data()->internal_stats()->IncBytesMoved(c->output_level(),
3613
                                                             moved_bytes);
3614 3615 3616 3617
    {
      event_logger_.LogToBuffer(log_buffer)
          << "job" << job_context->job_id << "event"
          << "trivial_move"
I
Islam AbdelRahman 已提交
3618
          << "destination_level" << c->output_level() << "files" << moved_files
3619
          << "total_files_size" << moved_bytes;
3620
    }
3621 3622
    LogToBuffer(
        log_buffer,
3623
        "[%s] Moved #%d files to level-%d %" PRIu64 " bytes %s: %s\n",
I
Islam AbdelRahman 已提交
3624 3625
        c->column_family_data()->GetName().c_str(), moved_files,
        c->output_level(), moved_bytes, status.ToString().c_str(),
3626
        c->column_family_data()->current()->storage_info()->LevelSummary(&tmp));
3627
    *made_progress = true;
3628 3629 3630

    // Clear Instrument
    ThreadStatusUtil::ResetThreadStatus();
J
jorlow@chromium.org 已提交
3631
  } else {
3632 3633 3634
    int output_level  __attribute__((unused)) = c->output_level();
    TEST_SYNC_POINT_CALLBACK("DBImpl::BackgroundCompaction:NonTrivial",
                             &output_level);
3635 3636 3637 3638 3639

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

I
Igor Canadi 已提交
3640
    assert(is_snapshot_supported_ || snapshots_.empty());
3641
    CompactionJob compaction_job(
3642
        job_context->job_id, c.get(), immutable_db_options_, env_options_,
I
Igor Canadi 已提交
3643
        versions_.get(), &shutting_down_, log_buffer, directories_.GetDbDir(),
3644 3645 3646
        directories_.GetDataDir(c->output_path_id()), stats_, &mutex_,
        &bg_error_, snapshot_seqs, earliest_write_conflict_snapshot,
        table_cache_, &event_logger_,
3647
        c->mutable_cf_options()->paranoid_file_checks,
3648
        c->mutable_cf_options()->report_bg_io_stats, dbname_,
S
sdong 已提交
3649
        &compaction_job_stats);
I
Igor Canadi 已提交
3650
    compaction_job.Prepare();
3651

I
Igor Canadi 已提交
3652
    mutex_.Unlock();
3653
    compaction_job.Run();
3654
    TEST_SYNC_POINT("DBImpl::BackgroundCompaction:NonTrivial:AfterRun");
I
Igor Canadi 已提交
3655
    mutex_.Lock();
3656

3657
    status = compaction_job.Install(*c->mutable_cf_options());
I
Igor Canadi 已提交
3658
    if (status.ok()) {
I
Igor Canadi 已提交
3659 3660
      InstallSuperVersionAndScheduleWorkWrapper(
          c->column_family_data(), job_context, *c->mutable_cf_options());
I
Igor Canadi 已提交
3661
    }
3662
    *made_progress = true;
O
Ori Bernstein 已提交
3663 3664
  }
  if (c != nullptr) {
3665 3666
    c->ReleaseCompactionFiles(status);
    *made_progress = true;
3667 3668 3669
    NotifyOnCompactionCompleted(
        c->column_family_data(), c.get(), status,
        compaction_job_stats, job_context->job_id);
J
jorlow@chromium.org 已提交
3670
  }
3671
  // this will unref its input_version and column_family_data
3672
  c.reset();
J
jorlow@chromium.org 已提交
3673 3674 3675

  if (status.ok()) {
    // Done
F
Feng Zhu 已提交
3676
  } else if (status.IsShutdownInProgress()) {
J
jorlow@chromium.org 已提交
3677 3678
    // Ignore compaction errors found during shutting down
  } else {
3679 3680 3681
    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 已提交
3682 3683 3684
      bg_error_ = status;
    }
  }
H
hans@chromium.org 已提交
3685 3686

  if (is_manual) {
3687
    ManualCompaction* m = manual_compaction;
3688
    if (!status.ok()) {
L
Lei Jin 已提交
3689
      m->status = status;
3690 3691
      m->done = true;
    }
3692 3693 3694 3695 3696 3697 3698 3699 3700
    // 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.
3701 3702 3703 3704
    //
    // 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
3705
    if (m->manual_end == nullptr) {
3706 3707
      m->done = true;
    }
G
Gabor Cselle 已提交
3708 3709 3710
    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 已提交
3711
      // Universal and FIFO compactions should always compact the whole range
S
sdong 已提交
3712 3713 3714
      assert(m->cfd->ioptions()->compaction_style !=
                 kCompactionStyleUniversal ||
             m->cfd->ioptions()->num_levels > 1);
3715
      assert(m->cfd->ioptions()->compaction_style != kCompactionStyleFIFO);
3716
      m->tmp_storage = *m->manual_end;
G
Gabor Cselle 已提交
3717
      m->begin = &m->tmp_storage;
3718
      m->incomplete = true;
G
Gabor Cselle 已提交
3719
    }
3720
    m->in_progress = false; // not being processed anymore
H
hans@chromium.org 已提交
3721
  }
3722
  TEST_SYNC_POINT("DBImpl::BackgroundCompaction:Finish");
3723
  return status;
J
jorlow@chromium.org 已提交
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
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;
}

3749
bool DBImpl::ShouldntRunManualCompaction(ManualCompaction* m) {
3750 3751
  if (num_running_ingest_file_ > 0) {
    // We need to wait for other IngestExternalFile() calls to finish
3752 3753 3754
    // before running a manual compaction.
    return true;
  }
3755 3756
  if (m->exclusive) {
    return (bg_compaction_scheduled_ > 0);
3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817
  }
  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;
}

3818
size_t DBImpl::GetWalPreallocateBlockSize(uint64_t write_buffer_size) const {
3819
  mutex_.AssertHeld();
3820
  size_t bsize = write_buffer_size / 10 + write_buffer_size;
3821 3822
  // Some users might set very high write_buffer_size and rely on
  // max_total_wal_size or other parameters to control the WAL size.
3823 3824
  if (mutable_db_options_.max_total_wal_size > 0) {
    bsize = std::min<size_t>(bsize, mutable_db_options_.max_total_wal_size);
3825
  }
3826 3827
  if (immutable_db_options_.db_write_buffer_size > 0) {
    bsize = std::min<size_t>(bsize, immutable_db_options_.db_write_buffer_size);
3828
  }
3829 3830 3831 3832
  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());
3833 3834 3835 3836 3837
  }

  return bsize;
}

3838 3839
namespace {
struct IterState {
3840
  IterState(DBImpl* _db, InstrumentedMutex* _mu, SuperVersion* _super_version,
3841
            bool _background_purge)
3842 3843 3844
      : db(_db),
        mu(_mu),
        super_version(_super_version),
3845
        background_purge(_background_purge) {}
3846 3847

  DBImpl* db;
3848
  InstrumentedMutex* mu;
3849
  SuperVersion* super_version;
3850
  bool background_purge;
3851 3852 3853 3854
};

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

3856
  if (state->super_version->Unref()) {
3857 3858 3859
    // Job id == 0 means that this is not our background process, but rather
    // user thread
    JobContext job_context(0);
3860

3861 3862
    state->mu->Lock();
    state->super_version->Cleanup();
I
Igor Canadi 已提交
3863
    state->db->FindObsoleteFiles(&job_context, false, true);
3864 3865 3866
    if (state->background_purge) {
      state->db->ScheduleBgLogWriterClose(&job_context);
    }
3867 3868 3869
    state->mu->Unlock();

    delete state->super_version;
I
Igor Canadi 已提交
3870
    if (job_context.HaveSomethingToDelete()) {
3871
      if (state->background_purge) {
3872 3873 3874 3875 3876 3877 3878 3879 3880 3881
        // 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);
      }
3882
    }
I
Igor Canadi 已提交
3883
    job_context.Clean();
I
Igor Canadi 已提交
3884
  }
T
Tomislav Novak 已提交
3885

3886 3887
  delete state;
}
H
Hans Wennborg 已提交
3888
}  // namespace
3889

A
Andrew Kryczka 已提交
3890 3891 3892 3893
InternalIterator* DBImpl::NewInternalIterator(
    const ReadOptions& read_options, ColumnFamilyData* cfd,
    SuperVersion* super_version, Arena* arena,
    RangeDelAggregator* range_del_agg) {
S
sdong 已提交
3894
  InternalIterator* internal_iter;
3895
  assert(arena != nullptr);
A
Andrew Kryczka 已提交
3896
  assert(range_del_agg != nullptr);
3897
  // Need to create internal iterator from the arena.
3898 3899 3900 3901
  MergeIteratorBuilder merge_iter_builder(
      &cfd->internal_comparator(), arena,
      !read_options.total_order_seek &&
          cfd->ioptions()->prefix_extractor != nullptr);
3902 3903
  // Collect iterator for mutable mem
  merge_iter_builder.AddIterator(
L
Lei Jin 已提交
3904
      super_version->mem->NewIterator(read_options, arena));
3905
  std::unique_ptr<InternalIterator> range_del_iter;
A
Andrew Kryczka 已提交
3906 3907
  Status s;
  if (!read_options.ignore_range_deletions) {
3908 3909
    range_del_iter.reset(
        super_version->mem->NewRangeTombstoneIterator(read_options));
A
Andrew Kryczka 已提交
3910 3911
    s = range_del_agg->AddTombstones(std::move(range_del_iter));
  }
3912
  // Collect all needed child iterators for immutable memtables
A
Andrew Kryczka 已提交
3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932
  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 已提交
3933 3934
}

3935 3936 3937 3938
ColumnFamilyHandle* DBImpl::DefaultColumnFamily() const {
  return default_cf_handle_;
}

L
Lei Jin 已提交
3939
Status DBImpl::Get(const ReadOptions& read_options,
3940
                   ColumnFamilyHandle* column_family, const Slice& key,
M
Maysam Yabandeh 已提交
3941 3942
                   std::string* value) {
  return GetImpl(read_options, column_family, key, value);
3943 3944
}

I
Igor Canadi 已提交
3945 3946
// JobContext gets created and destructed outside of the lock --
// we
I
Igor Canadi 已提交
3947 3948
// use this convinently to:
// * malloc one SuperVersion() outside of the lock -- new_superversion
3949
// * delete SuperVersion()s outside of the lock -- superversions_to_free
I
Igor Canadi 已提交
3950
//
I
Igor Canadi 已提交
3951 3952 3953
// However, if InstallSuperVersionAndScheduleWork() gets called twice with the
// same job_context, we can't reuse the SuperVersion() that got
// malloced because
I
Igor Canadi 已提交
3954 3955 3956
// 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 已提交
3957
void DBImpl::InstallSuperVersionAndScheduleWorkWrapper(
I
Igor Canadi 已提交
3958
    ColumnFamilyData* cfd, JobContext* job_context,
3959
    const MutableCFOptions& mutable_cf_options) {
3960
  mutex_.AssertHeld();
I
Igor Canadi 已提交
3961
  SuperVersion* old_superversion = InstallSuperVersionAndScheduleWork(
I
Igor Canadi 已提交
3962 3963 3964
      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 已提交
3965 3966
}

I
Igor Canadi 已提交
3967
SuperVersion* DBImpl::InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
3968
    ColumnFamilyData* cfd, SuperVersion* new_sv,
I
Igor Canadi 已提交
3969
    const MutableCFOptions& mutable_cf_options) {
L
Lei Jin 已提交
3970
  mutex_.AssertHeld();
3971 3972 3973 3974 3975 3976 3977 3978 3979

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

3983
  // Whenever we install new SuperVersion, we might need to issue new flushes or
I
Igor Canadi 已提交
3984 3985 3986 3987
  // compactions.
  SchedulePendingFlush(cfd);
  SchedulePendingCompaction(cfd);
  MaybeScheduleFlushOrCompaction();
L
Lei Jin 已提交
3988 3989 3990 3991 3992 3993 3994 3995 3996 3997

  // 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,
3998
                       ColumnFamilyHandle* column_family, const Slice& key,
M
Maysam Yabandeh 已提交
3999
                       std::string* value, bool* value_found) {
L
Lei Jin 已提交
4000
  StopWatch sw(env_, stats_, DB_GET);
4001
  PERF_TIMER_GUARD(get_snapshot_time);
4002

4003 4004 4005
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

4006 4007 4008 4009 4010 4011
  // Acquire SuperVersion
  SuperVersion* sv = GetAndRefSuperVersion(cfd);

  TEST_SYNC_POINT("DBImpl::GetImpl:1");
  TEST_SYNC_POINT("DBImpl::GetImpl:2");

4012
  SequenceNumber snapshot;
L
Lei Jin 已提交
4013 4014 4015
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
4016
  } else {
4017 4018 4019 4020 4021 4022 4023 4024 4025 4026
    // Since we get and reference the super version before getting
    // the snapshot number, without a mutex protection, it is possible
    // that a memtable switch happened in the middle and not all the
    // data for this snapshot is available. But it will contain all
    // the data available in the super version we have, which is also
    // a valid snapshot to read from.
    // We shouldn't get snapshot before finding and referencing the
    // super versipon because a flush happening in between may compact
    // away data for the snapshot, but the snapshot is earlier than the
    // data overwriting it, so users may see wrong results.
4027
    snapshot = versions_->LastSequence();
J
jorlow@chromium.org 已提交
4028
  }
4029 4030
  TEST_SYNC_POINT("DBImpl::GetImpl:3");
  TEST_SYNC_POINT("DBImpl::GetImpl:4");
4031

4032
  // Prepare to store a list of merge operations if merge occurs.
4033
  MergeContext merge_context;
4034
  RangeDelAggregator range_del_agg(cfd->internal_comparator(), snapshot);
4035

4036
  Status s;
4037
  // First look in the memtable, then in the immutable memtable (if any).
4038
  // s is both in/out. When in, s could either be OK or MergeInProgress.
4039
  // merge_operands will contain the sequence of merges in the latter case.
4040
  LookupKey lkey(key, snapshot);
L
Lei Jin 已提交
4041
  PERF_TIMER_STOP(get_snapshot_time);
4042

4043 4044
  bool skip_memtable = (read_options.read_tier == kPersistedTier &&
                        has_unpersisted_data_.load(std::memory_order_relaxed));
4045 4046
  bool done = false;
  if (!skip_memtable) {
M
Maysam Yabandeh 已提交
4047
    if (sv->mem->Get(lkey, value, &s, &merge_context, &range_del_agg,
A
Andrew Kryczka 已提交
4048
                     read_options)) {
4049 4050
      done = true;
      RecordTick(stats_, MEMTABLE_HIT);
A
Andrew Kryczka 已提交
4051
    } else if ((s.ok() || s.IsMergeInProgress()) &&
M
Maysam Yabandeh 已提交
4052
               sv->imm->Get(lkey, value, &s, &merge_context, &range_del_agg,
A
Andrew Kryczka 已提交
4053
                            read_options)) {
4054 4055 4056
      done = true;
      RecordTick(stats_, MEMTABLE_HIT);
    }
A
Andrew Kryczka 已提交
4057 4058 4059
    if (!done && !s.ok() && !s.IsMergeInProgress()) {
      return s;
    }
4060 4061
  }
  if (!done) {
4062
    PERF_TIMER_GUARD(get_from_output_files_time);
M
Maysam Yabandeh 已提交
4063
    sv->current->Get(read_options, lkey, value, &s, &merge_context,
A
Andrew Kryczka 已提交
4064
                     &range_del_agg, value_found);
L
Lei Jin 已提交
4065
    RecordTick(stats_, MEMTABLE_MISS);
4066
  }
4067

4068 4069
  {
    PERF_TIMER_GUARD(get_post_process_time);
4070

4071
    ReturnAndCleanupSuperVersion(cfd, sv);
4072

4073
    RecordTick(stats_, NUMBER_KEYS_READ);
M
Maysam Yabandeh 已提交
4074 4075
    RecordTick(stats_, BYTES_READ, value->size());
    MeasureTime(stats_, BYTES_PER_READ, value->size());
4076
  }
4077
  return s;
J
jorlow@chromium.org 已提交
4078 4079
}

4080
std::vector<Status> DBImpl::MultiGet(
L
Lei Jin 已提交
4081
    const ReadOptions& read_options,
4082
    const std::vector<ColumnFamilyHandle*>& column_family,
4083
    const std::vector<Slice>& keys, std::vector<std::string>* values) {
4084

L
Lei Jin 已提交
4085
  StopWatch sw(env_, stats_, DB_MULTIGET);
4086
  PERF_TIMER_GUARD(get_snapshot_time);
K
Kai Liu 已提交
4087

4088
  SequenceNumber snapshot;
4089

4090
  struct MultiGetColumnFamilyData {
I
Igor Canadi 已提交
4091
    ColumnFamilyData* cfd;
4092 4093 4094 4095 4096
    SuperVersion* super_version;
  };
  std::unordered_map<uint32_t, MultiGetColumnFamilyData*> multiget_cf_data;
  // fill up and allocate outside of mutex
  for (auto cf : column_family) {
4097 4098 4099 4100 4101 4102
    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});
4103 4104 4105
    }
  }

4106
  mutex_.Lock();
L
Lei Jin 已提交
4107 4108 4109
  if (read_options.snapshot != nullptr) {
    snapshot = reinterpret_cast<const SnapshotImpl*>(
        read_options.snapshot)->number_;
4110 4111 4112
  } else {
    snapshot = versions_->LastSequence();
  }
4113
  for (auto mgd_iter : multiget_cf_data) {
4114 4115
    mgd_iter.second->super_version =
        mgd_iter.second->cfd->GetSuperVersion()->Ref();
4116
  }
4117
  mutex_.Unlock();
4118

4119 4120
  // Contain a list of merge operations if merge occurs.
  MergeContext merge_context;
4121

4122
  // Note: this always resizes the values array
4123 4124 4125
  size_t num_keys = keys.size();
  std::vector<Status> stat_list(num_keys);
  values->resize(num_keys);
4126 4127

  // Keep track of bytes that we read for statistics-recording later
4128
  uint64_t bytes_read = 0;
L
Lei Jin 已提交
4129
  PERF_TIMER_STOP(get_snapshot_time);
4130 4131 4132 4133

  // 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.
4134
  // merge_operands will contain the sequence of merges in the latter case.
4135
  for (size_t i = 0; i < num_keys; ++i) {
4136
    merge_context.Clear();
4137
    Status& s = stat_list[i];
4138 4139 4140
    std::string* value = &(*values)[i];

    LookupKey lkey(keys[i], snapshot);
4141
    auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family[i]);
A
Andrew Kryczka 已提交
4142
    RangeDelAggregator range_del_agg(cfh->cfd()->internal_comparator(),
4143
                                     snapshot);
4144
    auto mgd_iter = multiget_cf_data.find(cfh->cfd()->GetID());
4145 4146 4147
    assert(mgd_iter != multiget_cf_data.end());
    auto mgd = mgd_iter->second;
    auto super_version = mgd->super_version;
4148
    bool skip_memtable =
4149 4150
        (read_options.read_tier == kPersistedTier &&
         has_unpersisted_data_.load(std::memory_order_relaxed));
4151 4152
    bool done = false;
    if (!skip_memtable) {
M
Maysam Yabandeh 已提交
4153
      if (super_version->mem->Get(lkey, value, &s, &merge_context,
A
Andrew Kryczka 已提交
4154
                                  &range_del_agg, read_options)) {
4155 4156
        done = true;
        // TODO(?): RecordTick(stats_, MEMTABLE_HIT)?
M
Maysam Yabandeh 已提交
4157
      } else if (super_version->imm->Get(lkey, value, &s, &merge_context,
A
Andrew Kryczka 已提交
4158
                                         &range_del_agg, read_options)) {
4159 4160 4161 4162 4163
        done = true;
        // TODO(?): RecordTick(stats_, MEMTABLE_HIT)?
      }
    }
    if (!done) {
4164
      PERF_TIMER_GUARD(get_from_output_files_time);
M
Maysam Yabandeh 已提交
4165 4166
      super_version->current->Get(read_options, lkey, value, &s, &merge_context,
                                  &range_del_agg);
4167
      // TODO(?): RecordTick(stats_, MEMTABLE_MISS)?
4168 4169 4170
    }

    if (s.ok()) {
M
Maysam Yabandeh 已提交
4171
      bytes_read += value->size();
4172 4173 4174 4175
    }
  }

  // Post processing (decrement reference counts and record statistics)
4176
  PERF_TIMER_GUARD(get_post_process_time);
4177 4178
  autovector<SuperVersion*> superversions_to_delete;

I
Igor Canadi 已提交
4179
  // TODO(icanadi) do we need lock here or just around Cleanup()?
4180 4181 4182 4183 4184 4185
  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);
4186 4187
    }
  }
4188 4189 4190 4191 4192 4193 4194
  mutex_.Unlock();

  for (auto td : superversions_to_delete) {
    delete td;
  }
  for (auto mgd : multiget_cf_data) {
    delete mgd.second;
4195
  }
4196

L
Lei Jin 已提交
4197 4198 4199
  RecordTick(stats_, NUMBER_MULTIGET_CALLS);
  RecordTick(stats_, NUMBER_MULTIGET_KEYS_READ, num_keys);
  RecordTick(stats_, NUMBER_MULTIGET_BYTES_READ, bytes_read);
4200
  MeasureTime(stats_, BYTES_PER_MULTIGET, bytes_read);
L
Lei Jin 已提交
4201
  PERF_TIMER_STOP(get_post_process_time);
4202

4203
  return stat_list;
4204 4205
}

L
Lei Jin 已提交
4206
Status DBImpl::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
4207
                                  const std::string& column_family_name,
4208
                                  ColumnFamilyHandle** handle) {
Y
Yueh-Hsuan Chiang 已提交
4209
  Status s;
4210
  Status persist_options_status;
I
Igor Canadi 已提交
4211
  *handle = nullptr;
4212 4213

  s = CheckCompressionSupported(cf_options);
4214
  if (s.ok() && immutable_db_options_.allow_concurrent_memtable_write) {
4215 4216
    s = CheckConcurrentWritesSupported(cf_options);
  }
4217 4218 4219 4220
  if (!s.ok()) {
    return s;
  }

Y
Yueh-Hsuan Chiang 已提交
4221
  {
4222
    InstrumentedMutexLock l(&mutex_);
I
Igor Canadi 已提交
4223

Y
Yueh-Hsuan Chiang 已提交
4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236
    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 已提交
4237
    {  // write thread
4238 4239
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
I
Igor Canadi 已提交
4240 4241
      // LogAndApply will both write the creation in MANIFEST and create
      // ColumnFamilyData object
4242 4243 4244
      s = versions_->LogAndApply(nullptr, MutableCFOptions(cf_options), &edit,
                                 &mutex_, directories_.GetDbDir(), false,
                                 &cf_options);
4245 4246 4247 4248 4249 4250

      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();
      }
4251
      write_thread_.ExitUnbatched(&w);
I
Igor Canadi 已提交
4252
    }
Y
Yueh-Hsuan Chiang 已提交
4253 4254 4255 4256 4257
    if (s.ok()) {
      single_column_family_mode_ = false;
      auto* cfd =
          versions_->GetColumnFamilySet()->GetColumnFamily(column_family_name);
      assert(cfd != nullptr);
I
Igor Canadi 已提交
4258
      delete InstallSuperVersionAndScheduleWork(
Y
Yueh-Hsuan Chiang 已提交
4259
          cfd, nullptr, *cfd->GetLatestMutableCFOptions());
S
sdong 已提交
4260 4261 4262 4263 4264

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

Y
Yueh-Hsuan Chiang 已提交
4265
      *handle = new ColumnFamilyHandleImpl(cfd, this, &mutex_);
4266 4267 4268
      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 已提交
4269
    } else {
4270
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
Y
Yueh-Hsuan Chiang 已提交
4271 4272 4273
          "Creating column family [%s] FAILED -- %s",
          column_family_name.c_str(), s.ToString().c_str());
    }
4274
  }  // InstrumentedMutexLock l(&mutex_)
Y
Yueh-Hsuan Chiang 已提交
4275 4276

  // this is outside the mutex
4277
  if (s.ok()) {
4278 4279
    NewThreadStatusCfInfo(
        reinterpret_cast<ColumnFamilyHandleImpl*>(*handle)->cfd());
4280
    if (!persist_options_status.ok()) {
4281
      if (immutable_db_options_.fail_if_options_file_error) {
4282 4283 4284 4285 4286
        s = Status::IOError(
            "ColumnFamily has been created, but unable to persist"
            "options in CreateColumnFamily()",
            persist_options_status.ToString().c_str());
      }
4287
      Warn(immutable_db_options_.info_log,
4288 4289 4290
           "Unable to persist options in CreateColumnFamily() -- %s",
           persist_options_status.ToString().c_str());
    }
4291
  }
4292
  return s;
4293 4294
}

4295 4296 4297 4298
Status DBImpl::DropColumnFamily(ColumnFamilyHandle* column_family) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
  if (cfd->GetID() == 0) {
4299 4300
    return Status::InvalidArgument("Can't drop default column family");
  }
4301

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

I
Igor Canadi 已提交
4304 4305
  VersionEdit edit;
  edit.DropColumnFamily();
4306 4307
  edit.SetColumnFamily(cfd->GetID());

4308
  Status s;
4309
  Status options_persist_status;
4310
  {
4311
    InstrumentedMutexLock l(&mutex_);
4312 4313 4314 4315
    if (cfd->IsDropped()) {
      s = Status::InvalidArgument("Column family already dropped!\n");
    }
    if (s.ok()) {
4316
      // we drop column family from a single write thread
4317 4318
      WriteThread::Writer w;
      write_thread_.EnterUnbatched(&w, &mutex_);
4319 4320
      s = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                 &edit, &mutex_);
4321 4322 4323 4324 4325
      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();
      }
4326
      write_thread_.ExitUnbatched(&w);
4327
    }
S
sdong 已提交
4328 4329 4330 4331 4332 4333

    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()) {
4334
        if (!c->IsDropped() && !c->mem()->IsSnapshotSupported()) {
S
sdong 已提交
4335 4336 4337 4338 4339 4340
          new_is_snapshot_supported = false;
          break;
        }
      }
      is_snapshot_supported_ = new_is_snapshot_supported;
    }
4341
  }
4342

4343
  if (s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
4344 4345 4346 4347
    // 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 已提交
4348
    assert(cfd->IsDropped());
L
Lei Jin 已提交
4349 4350 4351
    auto* mutable_cf_options = cfd->GetLatestMutableCFOptions();
    max_total_in_memory_state_ -= mutable_cf_options->write_buffer_size *
                                  mutable_cf_options->max_write_buffer_number;
4352
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
4353 4354
        "Dropped column family with id %u\n", cfd->GetID());

4355
    if (!options_persist_status.ok()) {
4356
      if (immutable_db_options_.fail_if_options_file_error) {
4357 4358 4359 4360 4361
        s = Status::IOError(
            "ColumnFamily has been dropped, but unable to persist "
            "options in DropColumnFamily()",
            options_persist_status.ToString().c_str());
      }
4362
      Warn(immutable_db_options_.info_log,
4363 4364 4365
           "Unable to persist options in DropColumnFamily() -- %s",
           options_persist_status.ToString().c_str());
    }
4366
  } else {
4367 4368 4369
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
        "Dropping column family with id %u FAILED -- %s\n", cfd->GetID(),
        s.ToString().c_str());
4370 4371
  }

4372
  return s;
4373 4374
}

L
Lei Jin 已提交
4375
bool DBImpl::KeyMayExist(const ReadOptions& read_options,
4376 4377
                         ColumnFamilyHandle* column_family, const Slice& key,
                         std::string* value, bool* value_found) {
4378
  if (value_found != nullptr) {
K
Kai Liu 已提交
4379 4380
    // falsify later if key-may-exist but can't fetch value
    *value_found = true;
4381
  }
L
Lei Jin 已提交
4382
  ReadOptions roptions = read_options;
4383
  roptions.read_tier = kBlockCacheTier; // read from block cache only
M
Maysam Yabandeh 已提交
4384
  auto s = GetImpl(roptions, column_family, key, value, value_found);
K
Kai Liu 已提交
4385

4386
  // If block_cache is enabled and the index block of the table didn't
K
Kai Liu 已提交
4387 4388 4389
  // 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();
4390 4391
}

4392
Iterator* DBImpl::NewIterator(const ReadOptions& read_options,
4393
                              ColumnFamilyHandle* column_family) {
4394 4395 4396 4397
  if (read_options.read_tier == kPersistedTier) {
    return NewErrorIterator(Status::NotSupported(
        "ReadTier::kPersistedData is not yet supported in iterators."));
  }
4398 4399
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
V
Venkatesh Radhakrishnan 已提交
4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414
  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 已提交
4415 4416 4417 4418
#ifdef ROCKSDB_LITE
    // not supported in lite version
    return nullptr;
#else
4419 4420
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
    auto iter = new ForwardIterator(this, read_options, cfd, sv);
4421 4422
    return NewDBIterator(
        env_, *cfd->ioptions(), cfd->user_comparator(), iter,
4423 4424
        kMaxSequenceNumber,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4425 4426
        sv->version_number, read_options.iterate_upper_bound,
        read_options.prefix_same_as_start, read_options.pin_data);
I
Igor Canadi 已提交
4427
#endif
T
Tomislav Novak 已提交
4428
  } else {
4429
    SequenceNumber latest_snapshot = versions_->LastSequence();
4430
    SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
4431

I
Igor Canadi 已提交
4432
    auto snapshot =
4433 4434 4435
        read_options.snapshot != nullptr
            ? reinterpret_cast<const SnapshotImpl*>(
                read_options.snapshot)->number_
I
Igor Canadi 已提交
4436
            : latest_snapshot;
T
Tomislav Novak 已提交
4437

4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473
    // 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         | <----+
    // |       |   +-------------------+
    // |       |                       |
    // +-------+-----------------------+
    //
4474 4475
    // ArenaWrappedDBIter inlines an arena area where all the iterators in
    // the iterator tree are allocated in the order of being accessed when
4476 4477 4478 4479 4480
    // 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(
4481 4482
        env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
        sv->mutable_cf_options.max_sequential_skip_in_iterations,
4483
        sv->version_number, read_options.iterate_upper_bound,
4484 4485
        read_options.prefix_same_as_start, read_options.pin_data,
        read_options.total_order_seek);
4486

S
sdong 已提交
4487
    InternalIterator* internal_iter =
A
Andrew Kryczka 已提交
4488 4489
        NewInternalIterator(read_options, cfd, sv, db_iter->GetArena(),
                            db_iter->GetRangeDelAggregator());
4490 4491 4492 4493
    db_iter->SetIterUnderDBIter(internal_iter);

    return db_iter;
  }
4494 4495
  // To stop compiler from complaining
  return nullptr;
J
jorlow@chromium.org 已提交
4496 4497
}

4498
Status DBImpl::NewIterators(
4499
    const ReadOptions& read_options,
I
Igor Canadi 已提交
4500
    const std::vector<ColumnFamilyHandle*>& column_families,
4501
    std::vector<Iterator*>* iterators) {
4502 4503 4504 4505
  if (read_options.read_tier == kPersistedTier) {
    return Status::NotSupported(
        "ReadTier::kPersistedData is not yet supported in iterators.");
  }
I
Igor Canadi 已提交
4506 4507
  iterators->clear();
  iterators->reserve(column_families.size());
V
Venkatesh Radhakrishnan 已提交
4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524
  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 已提交
4525 4526 4527 4528
#ifdef ROCKSDB_LITE
    return Status::InvalidArgument(
        "Tailing interator not supported in RocksDB lite");
#else
I
Igor Canadi 已提交
4529 4530
    for (auto cfh : column_families) {
      auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(cfh)->cfd();
4531 4532
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
      auto iter = new ForwardIterator(this, read_options, cfd, sv);
4533 4534 4535
      iterators->push_back(NewDBIterator(
          env_, *cfd->ioptions(), cfd->user_comparator(), iter,
          kMaxSequenceNumber,
4536 4537
          sv->mutable_cf_options.max_sequential_skip_in_iterations,
          sv->version_number, nullptr, false, read_options.pin_data));
I
Igor Canadi 已提交
4538
    }
I
Igor Canadi 已提交
4539
#endif
I
Igor Canadi 已提交
4540
  } else {
4541 4542
    SequenceNumber latest_snapshot = versions_->LastSequence();

I
Igor Canadi 已提交
4543
    for (size_t i = 0; i < column_families.size(); ++i) {
4544 4545 4546
      auto* cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(
          column_families[i])->cfd();
      SuperVersion* sv = cfd->GetReferencedSuperVersion(&mutex_);
I
Igor Canadi 已提交
4547 4548

      auto snapshot =
4549 4550 4551
          read_options.snapshot != nullptr
              ? reinterpret_cast<const SnapshotImpl*>(
                  read_options.snapshot)->number_
I
Igor Canadi 已提交
4552 4553
              : latest_snapshot;

4554
      ArenaWrappedDBIter* db_iter = NewArenaWrappedDbIterator(
4555
          env_, *cfd->ioptions(), cfd->user_comparator(), snapshot,
4556 4557
          sv->mutable_cf_options.max_sequential_skip_in_iterations,
          sv->version_number, nullptr, false, read_options.pin_data);
S
sdong 已提交
4558
      InternalIterator* internal_iter =
A
Andrew Kryczka 已提交
4559 4560
          NewInternalIterator(read_options, cfd, sv, db_iter->GetArena(),
                              db_iter->GetRangeDelAggregator());
4561 4562
      db_iter->SetIterUnderDBIter(internal_iter);
      iterators->push_back(db_iter);
I
Igor Canadi 已提交
4563 4564 4565 4566
    }
  }

  return Status::OK();
4567 4568
}

4569 4570
const Snapshot* DBImpl::GetSnapshot() { return GetSnapshotImpl(false); }

4571
#ifndef ROCKSDB_LITE
4572 4573 4574
const Snapshot* DBImpl::GetSnapshotForWriteConflictBoundary() {
  return GetSnapshotImpl(true);
}
4575
#endif  // ROCKSDB_LITE
4576 4577

const Snapshot* DBImpl::GetSnapshotImpl(bool is_write_conflict_boundary) {
4578 4579
  int64_t unix_time = 0;
  env_->GetCurrentTime(&unix_time);  // Ignore error
4580
  SnapshotImpl* s = new SnapshotImpl;
4581

4582
  InstrumentedMutexLock l(&mutex_);
4583
  // returns null if the underlying memtable does not support snapshot.
4584 4585 4586 4587
  if (!is_snapshot_supported_) {
    delete s;
    return nullptr;
  }
4588 4589
  return snapshots_.New(s, versions_->LastSequence(), unix_time,
                        is_write_conflict_boundary);
J
jorlow@chromium.org 已提交
4590 4591 4592
}

void DBImpl::ReleaseSnapshot(const Snapshot* s) {
4593 4594 4595 4596 4597 4598
  const SnapshotImpl* casted_s = reinterpret_cast<const SnapshotImpl*>(s);
  {
    InstrumentedMutexLock l(&mutex_);
    snapshots_.Delete(casted_s);
  }
  delete casted_s;
J
jorlow@chromium.org 已提交
4599 4600 4601
}

// Convenience methods
4602 4603
Status DBImpl::Put(const WriteOptions& o, ColumnFamilyHandle* column_family,
                   const Slice& key, const Slice& val) {
4604
  return DB::Put(o, column_family, key, val);
J
jorlow@chromium.org 已提交
4605 4606
}

4607 4608 4609
Status DBImpl::Merge(const WriteOptions& o, ColumnFamilyHandle* column_family,
                     const Slice& key, const Slice& val) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
4610
  if (!cfh->cfd()->ioptions()->merge_operator) {
4611 4612
    return Status::NotSupported("Provide a merge_operator when opening DB");
  } else {
4613
    return DB::Merge(o, column_family, key, val);
4614 4615 4616
  }
}

L
Lei Jin 已提交
4617
Status DBImpl::Delete(const WriteOptions& write_options,
4618
                      ColumnFamilyHandle* column_family, const Slice& key) {
L
Lei Jin 已提交
4619
  return DB::Delete(write_options, column_family, key);
J
jorlow@chromium.org 已提交
4620 4621
}

A
Andres Noetzli 已提交
4622 4623 4624 4625 4626 4627
Status DBImpl::SingleDelete(const WriteOptions& write_options,
                            ColumnFamilyHandle* column_family,
                            const Slice& key) {
  return DB::SingleDelete(write_options, column_family, key);
}

L
Lei Jin 已提交
4628
Status DBImpl::Write(const WriteOptions& write_options, WriteBatch* my_batch) {
4629
  return WriteImpl(write_options, my_batch, nullptr, nullptr);
A
agiardullo 已提交
4630 4631
}

A
agiardullo 已提交
4632
#ifndef ROCKSDB_LITE
A
agiardullo 已提交
4633 4634 4635
Status DBImpl::WriteWithCallback(const WriteOptions& write_options,
                                 WriteBatch* my_batch,
                                 WriteCallback* callback) {
4636
  return WriteImpl(write_options, my_batch, callback, nullptr);
A
agiardullo 已提交
4637
}
A
agiardullo 已提交
4638
#endif  // ROCKSDB_LITE
A
agiardullo 已提交
4639 4640

Status DBImpl::WriteImpl(const WriteOptions& write_options,
4641 4642 4643
                         WriteBatch* my_batch, WriteCallback* callback,
                         uint64_t* log_used, uint64_t log_ref,
                         bool disable_memtable) {
S
Stanislau Hlebik 已提交
4644 4645
  if (my_batch == nullptr) {
    return Status::Corruption("Batch is nullptr!");
4646
  }
A
agiardullo 已提交
4647 4648

  Status status;
A
agiardullo 已提交
4649

4650
  PERF_TIMER_GUARD(write_pre_and_post_process_time);
4651
  WriteThread::Writer w;
S
Stanislau Hlebik 已提交
4652
  w.batch = my_batch;
L
Lei Jin 已提交
4653 4654
  w.sync = write_options.sync;
  w.disableWAL = write_options.disableWAL;
4655
  w.disable_memtable = disable_memtable;
S
Stanislau Hlebik 已提交
4656
  w.in_batch_group = false;
4657
  w.callback = callback;
4658
  w.log_ref = log_ref;
S
Stanislau Hlebik 已提交
4659

L
Lei Jin 已提交
4660
  if (!write_options.disableWAL) {
S
Stanislau Hlebik 已提交
4661 4662 4663
    RecordTick(stats_, WRITE_WITH_WAL);
  }

4664
  StopWatch write_sw(env_, immutable_db_options_.statistics.get(), DB_WRITE);
4665

4666
  write_thread_.JoinBatchGroup(&w);
4667 4668 4669 4670
  if (w.state == WriteThread::STATE_PARALLEL_FOLLOWER) {
    // we are a non-leader in a parallel group
    PERF_TIMER_GUARD(write_memtable_time);

4671 4672 4673 4674 4675
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }

    if (w.ShouldWriteToMemtable()) {
4676 4677 4678 4679
      ColumnFamilyMemTablesImpl column_family_memtables(
          versions_->GetColumnFamilySet());
      WriteBatchInternal::SetSequence(w.batch, w.sequence);
      w.status = WriteBatchInternal::InsertInto(
4680
          &w, &column_family_memtables, &flush_scheduler_,
4681
          write_options.ignore_missing_column_families, 0 /*log_number*/, this,
S
sdong 已提交
4682
          true /*concurrent_memtable_writes*/);
4683
    }
4684 4685 4686

    if (write_thread_.CompleteParallelWorker(&w)) {
      // we're responsible for early exit
4687
      auto last_sequence = w.parallel_group->last_sequence;
4688 4689 4690 4691 4692
      versions_->SetLastSequence(last_sequence);
      write_thread_.EarlyExitParallelGroup(&w);
    }
    assert(w.state == WriteThread::STATE_COMPLETED);
    // STATE_COMPLETED conditional below handles exit
4693 4694

    status = w.FinalStatus();
4695 4696
  }
  if (w.state == WriteThread::STATE_COMPLETED) {
4697 4698 4699
    if (log_used != nullptr) {
      *log_used = w.log_used;
    }
4700
    // write is complete and leader has updated sequence
4701
    RecordTick(stats_, WRITE_DONE_BY_OTHER);
4702
    return w.FinalStatus();
4703 4704
  }
  // else we are the leader of the write batch group
4705
  assert(w.state == WriteThread::STATE_GROUP_LEADER);
4706

S
Stanislau Hlebik 已提交
4707 4708
  WriteContext context;
  mutex_.Lock();
I
Igor Canadi 已提交
4709 4710 4711 4712 4713

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

S
Stanislau Hlebik 已提交
4714 4715
  RecordTick(stats_, WRITE_DONE_BY_SELF);
  default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_DONE_BY_SELF, 1);
4716

4717 4718 4719 4720
  // 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.
4721 4722 4723
  assert(!single_column_family_mode_ ||
         versions_->GetColumnFamilySet()->NumberOfColumnFamilies() == 1);

4724
  if (UNLIKELY(!single_column_family_mode_ &&
4725
               total_log_size_ > GetMaxTotalWalSize())) {
4726
    MaybeFlushColumnFamilies();
4727 4728
  }
  if (UNLIKELY(write_buffer_manager_->ShouldFlush())) {
4729 4730 4731 4732 4733
    // 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.
4734
    Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
4735 4736
        "Flushing column family with largest mem table size. Write buffer is "
        "using %" PRIu64 " bytes out of a total of %" PRIu64 ".",
4737 4738
        write_buffer_manager_->memory_usage(),
        write_buffer_manager_->buffer_size());
4739 4740
    // no need to refcount because drop is happening in write thread, so can't
    // happen while we're in the write thread
4741 4742 4743
    ColumnFamilyData* largest_cfd = nullptr;
    size_t largest_cfd_size = 0;

4744
    for (auto cfd : *versions_->GetColumnFamilySet()) {
4745 4746 4747
      if (cfd->IsDropped()) {
        continue;
      }
4748
      if (!cfd->mem()->IsEmpty()) {
4749 4750 4751 4752 4753 4754
        // 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;
4755 4756 4757
        }
      }
    }
4758 4759 4760 4761 4762 4763 4764 4765
    if (largest_cfd != nullptr) {
      status = SwitchMemtable(largest_cfd, &context);
      if (status.ok()) {
        largest_cfd->imm()->FlushRequested();
        SchedulePendingFlush(largest_cfd);
        MaybeScheduleFlushOrCompaction();
      }
    }
I
Igor Canadi 已提交
4766 4767 4768 4769 4770 4771 4772 4773 4774 4775
  }

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

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

4776 4777
  if (UNLIKELY(status.ok() && (write_controller_.IsStopped() ||
                               write_controller_.NeedsDelay()))) {
4778 4779
    PERF_TIMER_STOP(write_pre_and_post_process_time);
    PERF_TIMER_GUARD(write_delay_time);
S
sdong 已提交
4780 4781 4782 4783
    // 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.
M
Maysam Yabandeh 已提交
4784
    status = DelayWrite(last_batch_group_size_, write_options);
4785
    PERF_TIMER_START(write_pre_and_post_process_time);
I
Igor Canadi 已提交
4786 4787
  }

D
dgrogan@chromium.org 已提交
4788
  uint64_t last_sequence = versions_->LastSequence();
I
Igor Canadi 已提交
4789
  WriteThread::Writer* last_writer = &w;
4790
  autovector<WriteThread::Writer*> write_group;
4791 4792
  bool need_log_sync = !write_options.disableWAL && write_options.sync;
  bool need_log_dir_sync = need_log_sync && !log_dir_synced_;
A
agiardullo 已提交
4793

M
Maysam Yabandeh 已提交
4794
  bool logs_getting_synced = false;
S
Stanislau Hlebik 已提交
4795
  if (status.ok()) {
4796
    if (need_log_sync) {
4797 4798 4799 4800 4801 4802 4803
      while (logs_.front().getting_synced) {
        log_sync_cv_.Wait();
      }
      for (auto& log : logs_) {
        assert(!log.getting_synced);
        log.getting_synced = true;
      }
M
Maysam Yabandeh 已提交
4804
      logs_getting_synced = true;
4805 4806
    }

4807 4808 4809
    // 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
4810
    // into memtables
A
agiardullo 已提交
4811
  }
S
sdong 已提交
4812
  log::Writer* cur_log_writer = logs_.back().writer;
A
agiardullo 已提交
4813

4814 4815
  mutex_.Unlock();

A
agiardullo 已提交
4816 4817
  // At this point the mutex is unlocked

4818
  bool exit_completed_early = false;
4819 4820
  last_batch_group_size_ =
      write_thread_.EnterAsBatchGroupLeader(&w, &last_writer, &write_group);
4821

A
agiardullo 已提交
4822
  if (status.ok()) {
4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835
    // 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.
4836 4837
    bool parallel = immutable_db_options_.allow_concurrent_memtable_write &&
                    write_group.size() > 1;
4838 4839
    int total_count = 0;
    uint64_t total_byte_size = 0;
4840 4841
    for (auto writer : write_group) {
      if (writer->CheckCallback(this)) {
4842 4843 4844 4845 4846 4847 4848 4849 4850
        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));
        }
4851
      }
4852 4853 4854 4855 4856 4857 4858 4859
    }

    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);
4860
    MeasureTime(stats_, BYTES_PER_WRITE, total_byte_size);
4861
    PERF_TIMER_STOP(write_pre_and_post_process_time);
4862

4863
    if (write_options.disableWAL) {
4864
      has_unpersisted_data_.store(true, std::memory_order_relaxed);
4865
    }
4866

4867 4868 4869
    uint64_t log_size = 0;
    if (!write_options.disableWAL) {
      PERF_TIMER_GUARD(write_wal_time);
4870

4871
      WriteBatch* merged_batch = nullptr;
4872 4873 4874 4875 4876
      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
4877
        merged_batch = write_group[0]->batch;
4878
        write_group[0]->log_used = logfile_number_;
4879 4880 4881 4882 4883
      } 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_;
4884
        for (auto writer : write_group) {
4885
          if (writer->ShouldWriteToWAL()) {
4886 4887
            WriteBatchInternal::Append(merged_batch, writer->batch,
                                       /*WAL_only*/ true);
4888
          }
4889
          writer->log_used = logfile_number_;
4890 4891 4892
        }
      }

4893 4894 4895 4896 4897
      if (log_used != nullptr) {
        *log_used = logfile_number_;
      }

      WriteBatchInternal::SetSequence(merged_batch, current_sequence);
4898 4899

      Slice log_entry = WriteBatchInternal::Contents(merged_batch);
S
sdong 已提交
4900
      status = cur_log_writer->AddRecord(log_entry);
4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916
      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_) {
4917
          status = log.writer->file()->Sync(immutable_db_options_.use_fsync);
4918 4919 4920 4921 4922 4923 4924 4925 4926 4927
          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();
        }
4928 4929
      }

4930 4931 4932 4933 4934 4935
      if (merged_batch == &tmp_batch_) {
        tmp_batch_.Clear();
      }
    }
    if (status.ok()) {
      PERF_TIMER_GUARD(write_memtable_time);
4936

4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948
      {
        // 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);
4949
          }
4950
          stats->AddDBStats(InternalStats::WAL_FILE_BYTES, log_size);
4951
        }
4952
        uint64_t for_other = write_group.size() - 1;
4953 4954 4955 4956
        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);
4957
          }
H
heyongqiang 已提交
4958
        }
4959
      }
Y
Yueh-Hsuan Chiang 已提交
4960

4961
      if (!parallel) {
4962
        status = WriteBatchInternal::InsertInto(
4963
            write_group, current_sequence, column_family_memtables_.get(),
4964
            &flush_scheduler_, write_options.ignore_missing_column_families,
S
sdong 已提交
4965
            0 /*log_number*/, this);
4966 4967 4968 4969 4970 4971 4972

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

4973
      } else {
4974
        WriteThread::ParallelGroup pg;
4975 4976
        pg.leader = &w;
        pg.last_writer = last_writer;
4977
        pg.last_sequence = last_sequence;
4978
        pg.early_exit_allowed = !need_log_sync;
4979
        pg.running.store(static_cast<uint32_t>(write_group.size()),
4980
                         std::memory_order_relaxed);
4981 4982
        write_thread_.LaunchParallelFollowers(&pg, current_sequence);

4983
        if (w.ShouldWriteToMemtable()) {
4984 4985 4986 4987 4988 4989
          // do leader write
          ColumnFamilyMemTablesImpl column_family_memtables(
              versions_->GetColumnFamilySet());
          assert(w.sequence == current_sequence);
          WriteBatchInternal::SetSequence(w.batch, w.sequence);
          w.status = WriteBatchInternal::InsertInto(
4990
              &w, &column_family_memtables, &flush_scheduler_,
4991
              write_options.ignore_missing_column_families, 0 /*log_number*/,
S
sdong 已提交
4992
              this, true /*concurrent_memtable_writes*/);
4993 4994
        }

4995 4996 4997
        // CompleteParallelWorker returns true if this thread should
        // handle exit, false means somebody else did
        exit_completed_early = !write_thread_.CompleteParallelWorker(&w);
4998
        status = w.FinalStatus();
4999
      }
A
agiardullo 已提交
5000

5001
      if (!exit_completed_early && w.status.ok()) {
5002 5003
        versions_->SetLastSequence(last_sequence);
        if (!need_log_sync) {
5004
          write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
5005
          exit_completed_early = true;
5006
        }
5007
      }
5008 5009 5010 5011 5012 5013 5014 5015 5016

      // 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.
5017
      if (!status.ok() && bg_error_.ok() && !w.CallbackFailed()) {
5018
        bg_error_ = status;
5019
      }
5020
    }
5021
  }
5022
  PERF_TIMER_START(write_pre_and_post_process_time);
A
agiardullo 已提交
5023

5024
  if (immutable_db_options_.paranoid_checks && !status.ok() &&
M
Maysam Yabandeh 已提交
5025
      !w.CallbackFailed() && !status.IsBusy() && !status.IsIncomplete()) {
5026 5027 5028 5029 5030
    mutex_.Lock();
    if (bg_error_.ok()) {
      bg_error_ = status;  // stop compaction & fail any further writes
    }
    mutex_.Unlock();
I
Igor Canadi 已提交
5031
  }
5032

M
Maysam Yabandeh 已提交
5033
  if (logs_getting_synced) {
5034
    mutex_.Lock();
5035
    MarkLogsSynced(logfile_number_, need_log_dir_sync, status);
5036
    mutex_.Unlock();
5037 5038
  }

5039
  if (!exit_completed_early) {
5040
    write_thread_.ExitAsBatchGroupLeader(&w, last_writer, w.status);
5041
  }
5042

J
jorlow@chromium.org 已提交
5043 5044 5045
  return status;
}

5046
void DBImpl::MaybeFlushColumnFamilies() {
5047 5048 5049 5050 5051 5052
  mutex_.AssertHeld();

  if (alive_log_files_.begin()->getting_flushed) {
    return;
  }

5053 5054 5055 5056 5057 5058
  auto oldest_alive_log = alive_log_files_.begin()->number;
  auto oldest_log_with_uncommited_prep = FindMinLogContainingOutstandingPrep();

  if (allow_2pc() &&
      oldest_log_with_uncommited_prep > 0 &&
      oldest_log_with_uncommited_prep <= oldest_alive_log) {
5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075
    if (unable_to_flush_oldest_log_) {
        // we already attempted to flush all column families dependent on
        // the oldest alive log but the log still contained uncommited transactions.
        // the oldest alive log STILL contains uncommited transaction so there
        // is still nothing that we can do.
        return;
    } else {
      Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
          "Unable to release oldest log due to uncommited transaction");
      unable_to_flush_oldest_log_ = true;
    }
  } else {
    // we only mark this log as getting flushed if we have successfully
    // flushed all data in this log. If this log contains outstanding prepared
    // transactions then we cannot flush this log until those transactions are commited.
    unable_to_flush_oldest_log_ = false;
    alive_log_files_.begin()->getting_flushed = true;
5076 5077 5078 5079
  }

  WriteContext context;

5080 5081 5082
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
      "Flushing all column families with data in WAL number %" PRIu64
      ". Total log size is %" PRIu64 " while max_total_wal_size is %" PRIu64,
5083
      oldest_alive_log, total_log_size_, GetMaxTotalWalSize());
5084 5085 5086 5087 5088 5089
  // no need to refcount because drop is happening in write thread, so can't
  // happen while we're in the write thread
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
    }
5090
    if (cfd->OldestLogToKeep() <= oldest_alive_log) {
5091 5092 5093 5094 5095 5096 5097 5098 5099
      auto status = SwitchMemtable(cfd, &context);
      if (!status.ok()) {
        break;
      }
      cfd->imm()->FlushRequested();
      SchedulePendingFlush(cfd);
    }
  }
  MaybeScheduleFlushOrCompaction();
5100

5101 5102 5103 5104 5105 5106 5107 5108 5109
}

uint64_t DBImpl::GetMaxTotalWalSize() const {
  mutex_.AssertHeld();
  return mutable_db_options_.max_total_wal_size == 0
             ? 4 * max_total_in_memory_state_
             : mutable_db_options_.max_total_wal_size;
}

5110 5111
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
M
Maysam Yabandeh 已提交
5112 5113
Status DBImpl::DelayWrite(uint64_t num_bytes,
                          const WriteOptions& write_options) {
S
sdong 已提交
5114 5115 5116 5117
  uint64_t time_delayed = 0;
  bool delayed = false;
  {
    StopWatch sw(env_, stats_, WRITE_STALL, &time_delayed);
S
sdong 已提交
5118 5119
    auto delay = write_controller_.GetDelay(env_, num_bytes);
    if (delay > 0) {
M
Maysam Yabandeh 已提交
5120 5121 5122
      if (write_options.no_slowdown) {
        return Status::Incomplete();
      }
S
sdong 已提交
5123 5124
      mutex_.Unlock();
      delayed = true;
S
sdong 已提交
5125
      TEST_SYNC_POINT("DBImpl::DelayWrite:Sleep");
5126 5127
      // hopefully we don't have to sleep more than 2 billion microseconds
      env_->SleepForMicroseconds(static_cast<int>(delay));
S
sdong 已提交
5128 5129
      mutex_.Lock();
    }
5130

5131
    while (bg_error_.ok() && write_controller_.IsStopped()) {
M
Maysam Yabandeh 已提交
5132 5133 5134
      if (write_options.no_slowdown) {
        return Status::Incomplete();
      }
S
sdong 已提交
5135
      delayed = true;
5136 5137
      TEST_SYNC_POINT("DBImpl::DelayWrite:Wait");
      bg_cv_.Wait();
5138 5139
    }
  }
M
Maysam Yabandeh 已提交
5140
  assert(!delayed || !write_options.no_slowdown);
S
sdong 已提交
5141 5142 5143 5144 5145
  if (delayed) {
    default_cf_internal_stats_->AddDBStats(InternalStats::WRITE_STALL_MICROS,
                                           time_delayed);
    RecordTick(stats_, STALL_MICROS, time_delayed);
  }
I
Igor Canadi 已提交
5146 5147

  return bg_error_;
5148 5149
}

I
Igor Canadi 已提交
5150 5151
Status DBImpl::ScheduleFlushes(WriteContext* context) {
  ColumnFamilyData* cfd;
5152
  while ((cfd = flush_scheduler_.TakeNextColumnFamily()) != nullptr) {
I
Igor Canadi 已提交
5153
    auto status = SwitchMemtable(cfd, context);
I
Igor Canadi 已提交
5154 5155 5156 5157 5158
    if (cfd->Unref()) {
      delete cfd;
    }
    if (!status.ok()) {
      return status;
S
Stanislau Hlebik 已提交
5159 5160
    }
  }
I
Igor Canadi 已提交
5161
  return Status::OK();
S
Stanislau Hlebik 已提交
5162 5163
}

5164 5165 5166
#ifndef ROCKSDB_LITE
void DBImpl::NotifyOnMemTableSealed(ColumnFamilyData* cfd,
                                    const MemTableInfo& mem_table_info) {
5167
  if (immutable_db_options_.listeners.size() == 0U) {
5168 5169 5170 5171 5172 5173
    return;
  }
  if (shutting_down_.load(std::memory_order_acquire)) {
    return;
  }

5174
  for (auto listener : immutable_db_options_.listeners) {
5175
    listener->OnMemTableSealed(mem_table_info);
5176
  }
5177 5178 5179
}
#endif  // ROCKSDB_LITE

S
Stanislau Hlebik 已提交
5180 5181
// REQUIRES: mutex_ is held
// REQUIRES: this thread is currently at the front of the writer queue
I
Igor Canadi 已提交
5182
Status DBImpl::SwitchMemtable(ColumnFamilyData* cfd, WriteContext* context) {
S
Stanislau Hlebik 已提交
5183 5184 5185 5186 5187 5188 5189
  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.
5190
  assert(versions_->prev_log_number() == 0);
S
Stanislau Hlebik 已提交
5191
  bool creating_new_log = !log_empty_;
S
Sage Weil 已提交
5192
  uint64_t recycle_log_number = 0;
5193
  if (creating_new_log && immutable_db_options_.recycle_log_file_num &&
S
Sage Weil 已提交
5194 5195 5196 5197
      !log_recycle_files.empty()) {
    recycle_log_number = log_recycle_files.front();
    log_recycle_files.pop_front();
  }
S
Stanislau Hlebik 已提交
5198 5199 5200
  uint64_t new_log_number =
      creating_new_log ? versions_->NewFileNumber() : logfile_number_;
  SuperVersion* new_superversion = nullptr;
5201
  const MutableCFOptions mutable_cf_options = *cfd->GetLatestMutableCFOptions();
5202 5203 5204 5205 5206 5207 5208 5209 5210 5211

  // 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
5212 5213 5214
  // 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();
5215 5216
  DBOptions db_options =
      BuildDBOptions(immutable_db_options_, mutable_db_options_);
5217 5218
  const auto preallocate_block_size =
    GetWalPreallocateBlockSize(mutable_cf_options.write_buffer_size);
S
Stanislau Hlebik 已提交
5219 5220 5221 5222
  mutex_.Unlock();
  Status s;
  {
    if (creating_new_log) {
5223
      EnvOptions opt_env_opt =
5224
          env_->OptimizeForLogWrite(env_options_, db_options);
S
Sage Weil 已提交
5225
      if (recycle_log_number) {
5226
        Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
S
Sage Weil 已提交
5227 5228
            "reusing log %" PRIu64 " from recycle list\n", recycle_log_number);
        s = env_->ReuseWritableFile(
5229 5230 5231
            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 已提交
5232
      } else {
5233 5234 5235
        s = NewWritableFile(
            env_, LogFileName(immutable_db_options_.wal_dir, new_log_number),
            &lfile, opt_env_opt);
S
Sage Weil 已提交
5236
      }
S
Stanislau Hlebik 已提交
5237 5238 5239
      if (s.ok()) {
        // Our final size should be less than write_buffer_size
        // (compression, etc) but err on the side of caution.
5240 5241 5242 5243

        // use preallocate_block_size instead
        // of calling GetWalPreallocateBlockSize()
        lfile->SetPreallocationBlockSize(preallocate_block_size);
5244 5245
        unique_ptr<WritableFileWriter> file_writer(
            new WritableFileWriter(std::move(lfile), opt_env_opt));
5246 5247 5248
        new_log =
            new log::Writer(std::move(file_writer), new_log_number,
                            immutable_db_options_.recycle_log_file_num > 0);
I
Igor Canadi 已提交
5249
      }
S
Stanislau Hlebik 已提交
5250 5251 5252
    }

    if (s.ok()) {
A
agiardullo 已提交
5253 5254
      SequenceNumber seq = versions_->LastSequence();
      new_mem = cfd->ConstructNewMemtable(mutable_cf_options, seq);
S
Stanislau Hlebik 已提交
5255 5256
      new_superversion = new SuperVersion();
    }
5257 5258 5259 5260 5261 5262 5263

#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 已提交
5264
  }
5265
  Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
5266 5267
      "[%s] New memtable created with log file: #%" PRIu64
      ". Immutable memtables: %d.\n",
5268
      cfd->GetName().c_str(), new_log_number, num_imm_unflushed);
S
Stanislau Hlebik 已提交
5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280
  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;
5281
    log_dir_synced_ = false;
5282
    logs_.emplace_back(logfile_number_, new_log);
S
Stanislau Hlebik 已提交
5283
    alive_log_files_.push_back(LogFileNumberSize(logfile_number_));
I
Igor Canadi 已提交
5284
    for (auto loop_cfd : *versions_->GetColumnFamilySet()) {
S
Stanislau Hlebik 已提交
5285 5286 5287 5288
      // 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 已提交
5289
      if (loop_cfd->mem()->GetFirstSequenceNumber() == 0 &&
5290
          loop_cfd->imm()->NumNotFlushed() == 0) {
I
Igor Canadi 已提交
5291
        loop_cfd->SetLogNumber(logfile_number_);
5292
      }
5293 5294
    }
  }
S
Stanislau Hlebik 已提交
5295
  cfd->mem()->SetNextLogNumber(logfile_number_);
5296
  cfd->imm()->Add(cfd->mem(), &context->memtables_to_free_);
S
Stanislau Hlebik 已提交
5297 5298
  new_mem->Ref();
  cfd->SetMemtable(new_mem);
I
Igor Canadi 已提交
5299 5300
  context->superversions_to_free_.push_back(InstallSuperVersionAndScheduleWork(
      cfd, new_superversion, mutable_cf_options));
5301 5302 5303
  return s;
}

I
Igor Canadi 已提交
5304
#ifndef ROCKSDB_LITE
I
Igor Canadi 已提交
5305 5306 5307 5308 5309
Status DBImpl::GetPropertiesOfAllTables(ColumnFamilyHandle* column_family,
                                        TablePropertiesCollection* props) {
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();

5310 5311
  // Increment the ref count
  mutex_.Lock();
I
Igor Canadi 已提交
5312
  auto version = cfd->current();
5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324
  version->Ref();
  mutex_.Unlock();

  auto s = version->GetPropertiesOfAllTables(props);

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

  return s;
}
5325 5326

Status DBImpl::GetPropertiesOfTablesInRange(ColumnFamilyHandle* column_family,
5327
                                            const Range* range, std::size_t n,
5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347
                                            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 已提交
5348
#endif  // ROCKSDB_LITE
5349

I
Igor Canadi 已提交
5350 5351 5352 5353
const std::string& DBImpl::GetName() const {
  return dbname_;
}

5354 5355 5356 5357
Env* DBImpl::GetEnv() const {
  return env_;
}

5358 5359
Options DBImpl::GetOptions(ColumnFamilyHandle* column_family) const {
  InstrumentedMutexLock l(&mutex_);
5360
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
5361 5362
  return Options(BuildDBOptions(immutable_db_options_, mutable_db_options_),
                 cfh->cfd()->GetLatestCFOptions());
I
Igor Canadi 已提交
5363 5364
}

5365 5366 5367 5368
DBOptions DBImpl::GetDBOptions() const {
  InstrumentedMutexLock l(&mutex_);
  return BuildDBOptions(immutable_db_options_, mutable_db_options_);
}
5369

5370
bool DBImpl::GetProperty(ColumnFamilyHandle* column_family,
5371
                         const Slice& property, std::string* value) {
5372
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
5373
  value->clear();
5374
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5375 5376 5377
  if (property_info == nullptr) {
    return false;
  } else if (property_info->handle_int) {
5378
    uint64_t int_value;
5379 5380
    bool ret_value =
        GetIntPropertyInternal(cfd, *property_info, false, &int_value);
5381
    if (ret_value) {
5382
      *value = ToString(int_value);
5383 5384
    }
    return ret_value;
5385
  } else if (property_info->handle_string) {
5386
    InstrumentedMutexLock l(&mutex_);
5387
    return cfd->internal_stats()->GetStringProperty(*property_info, property,
5388 5389
                                                    value);
  }
5390 5391 5392 5393
  // 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 已提交
5394 5395
}

5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413
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;
}

5414 5415
bool DBImpl::GetIntProperty(ColumnFamilyHandle* column_family,
                            const Slice& property, uint64_t* value) {
5416 5417
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5418 5419
    return false;
  }
5420
  auto cfd = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family)->cfd();
5421
  return GetIntPropertyInternal(cfd, *property_info, false, value);
5422 5423
}

5424
bool DBImpl::GetIntPropertyInternal(ColumnFamilyData* cfd,
5425 5426 5427 5428
                                    const DBPropertyInfo& property_info,
                                    bool is_locked, uint64_t* value) {
  assert(property_info.handle_int != nullptr);
  if (!property_info.need_out_of_mutex) {
5429 5430
    if (is_locked) {
      mutex_.AssertHeld();
5431
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5432 5433
    } else {
      InstrumentedMutexLock l(&mutex_);
5434
      return cfd->internal_stats()->GetIntProperty(property_info, value, this);
5435
    }
5436
  } else {
5437 5438 5439 5440 5441 5442
    SuperVersion* sv = nullptr;
    if (!is_locked) {
      sv = GetAndRefSuperVersion(cfd);
    } else {
      sv = cfd->GetSuperVersion();
    }
5443 5444

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

5447 5448 5449
    if (!is_locked) {
      ReturnAndCleanupSuperVersion(cfd, sv);
    }
5450 5451 5452 5453 5454

    return ret;
  }
}

5455 5456
bool DBImpl::GetAggregatedIntProperty(const Slice& property,
                                      uint64_t* aggregated_value) {
5457 5458
  const DBPropertyInfo* property_info = GetPropertyInfo(property);
  if (property_info == nullptr || property_info->handle_int == nullptr) {
5459 5460 5461 5462 5463 5464 5465 5466 5467
    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()) {
5468
      if (GetIntPropertyInternal(cfd, *property_info, true, &value)) {
5469 5470 5471 5472 5473 5474 5475 5476 5477 5478
        sum += value;
      } else {
        return false;
      }
    }
  }
  *aggregated_value = sum;
  return true;
}

5479 5480
SuperVersion* DBImpl::GetAndRefSuperVersion(ColumnFamilyData* cfd) {
  // TODO(ljin): consider using GetReferencedSuperVersion() directly
I
Igor Canadi 已提交
5481
  return cfd->GetThreadLocalSuperVersion(&mutex_);
5482 5483
}

A
agiardullo 已提交
5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495
// 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);
}

5496 5497
void DBImpl::ReturnAndCleanupSuperVersion(ColumnFamilyData* cfd,
                                          SuperVersion* sv) {
I
Igor Canadi 已提交
5498
  bool unref_sv = !cfd->ReturnThreadLocalSuperVersion(sv);
5499 5500 5501 5502 5503

  if (unref_sv) {
    // Release SuperVersion
    if (sv->Unref()) {
      {
5504
        InstrumentedMutexLock l(&mutex_);
5505 5506 5507 5508 5509 5510 5511
        sv->Cleanup();
      }
      delete sv;
      RecordTick(stats_, NUMBER_SUPERVERSION_CLEANUPS);
    }
    RecordTick(stats_, NUMBER_SUPERVERSION_RELEASES);
  }
5512 5513
}

A
agiardullo 已提交
5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537
// 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);
}

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

5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559
void DBImpl::GetApproximateMemTableStats(ColumnFamilyHandle* column_family,
                                         const Range& range,
                                         uint64_t* const count,
                                         uint64_t* const size) {
  ColumnFamilyHandleImpl* cfh =
      reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  ColumnFamilyData* cfd = cfh->cfd();
  SuperVersion* sv = GetAndRefSuperVersion(cfd);

  // Convert user_key into a corresponding internal key.
  InternalKey k1(range.start, kMaxSequenceNumber, kValueTypeForSeek);
  InternalKey k2(range.limit, kMaxSequenceNumber, kValueTypeForSeek);
  MemTable::MemTableStats memStats =
      sv->mem->ApproximateStats(k1.Encode(), k2.Encode());
  MemTable::MemTableStats immStats =
      sv->imm->ApproximateStats(k1.Encode(), k2.Encode());
  *count = memStats.count + immStats.count;
  *size = memStats.size + immStats.size;

  ReturnAndCleanupSuperVersion(cfd, sv);
}

5560
void DBImpl::GetApproximateSizes(ColumnFamilyHandle* column_family,
5561
                                 const Range* range, int n, uint64_t* sizes,
5562 5563 5564
                                 uint8_t include_flags) {
  assert(include_flags & DB::SizeApproximationFlags::INCLUDE_FILES ||
         include_flags & DB::SizeApproximationFlags::INCLUDE_MEMTABLES);
J
jorlow@chromium.org 已提交
5565
  Version* v;
5566 5567
  auto cfh = reinterpret_cast<ColumnFamilyHandleImpl*>(column_family);
  auto cfd = cfh->cfd();
5568 5569
  SuperVersion* sv = GetAndRefSuperVersion(cfd);
  v = sv->current;
J
jorlow@chromium.org 已提交
5570 5571 5572

  for (int i = 0; i < n; i++) {
    // Convert user_key into a corresponding internal key.
5573 5574
    InternalKey k1(range[i].start, kMaxSequenceNumber, kValueTypeForSeek);
    InternalKey k2(range[i].limit, kMaxSequenceNumber, kValueTypeForSeek);
V
Vitaliy Liptchinsky 已提交
5575
    sizes[i] = 0;
5576
    if (include_flags & DB::SizeApproximationFlags::INCLUDE_FILES) {
V
Vitaliy Liptchinsky 已提交
5577
      sizes[i] += versions_->ApproximateSize(v, k1.Encode(), k2.Encode());
5578 5579
    }
    if (include_flags & DB::SizeApproximationFlags::INCLUDE_MEMTABLES) {
5580 5581
      sizes[i] += sv->mem->ApproximateStats(k1.Encode(), k2.Encode()).size;
      sizes[i] += sv->imm->ApproximateStats(k1.Encode(), k2.Encode()).size;
5582
    }
J
jorlow@chromium.org 已提交
5583 5584
  }

5585
  ReturnAndCleanupSuperVersion(cfd, sv);
J
jorlow@chromium.org 已提交
5586 5587
}

I
Igor Canadi 已提交
5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603
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 已提交
5604 5605 5606 5607 5608
#ifndef ROCKSDB_LITE
Status DBImpl::GetUpdatesSince(
    SequenceNumber seq, unique_ptr<TransactionLogIterator>* iter,
    const TransactionLogIterator::ReadOptions& read_options) {

L
Lei Jin 已提交
5609
  RecordTick(stats_, GET_UPDATES_SINCE_CALLS);
I
Igor Canadi 已提交
5610 5611 5612
  if (seq > versions_->LastSequence()) {
    return Status::NotFound("Requested sequence not yet written in the db");
  }
I
Igor Canadi 已提交
5613
  return wal_manager_.GetUpdatesSince(seq, iter, read_options, versions_.get());
I
Igor Canadi 已提交
5614 5615
}

5616 5617 5618
Status DBImpl::DeleteFile(std::string name) {
  uint64_t number;
  FileType type;
5619 5620 5621
  WalFileType log_type;
  if (!ParseFileName(name, &number, &type, &log_type) ||
      (type != kTableFile && type != kLogFile)) {
5622
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
5623
        "DeleteFile %s failed.\n", name.c_str());
5624 5625 5626
    return Status::InvalidArgument("Invalid file name");
  }

5627 5628 5629 5630
  Status status;
  if (type == kLogFile) {
    // Only allow deleting archived log files
    if (log_type != kArchivedLogFile) {
5631 5632
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
          "DeleteFile %s failed - not archived log.\n", name.c_str());
5633 5634
      return Status::NotSupported("Delete only supported for archived logs");
    }
5635 5636
    status =
        env_->DeleteFile(immutable_db_options_.wal_dir + "/" + name.c_str());
5637
    if (!status.ok()) {
5638 5639 5640
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
          "DeleteFile %s failed -- %s.\n", name.c_str(),
          status.ToString().c_str());
5641 5642 5643 5644
    }
    return status;
  }

5645
  int level;
I
Igor Canadi 已提交
5646
  FileMetaData* metadata;
5647
  ColumnFamilyData* cfd;
5648
  VersionEdit edit;
5649
  JobContext job_context(next_job_id_.fetch_add(1), true);
D
Dhruba Borthakur 已提交
5650
  {
5651
    InstrumentedMutexLock l(&mutex_);
5652
    status = versions_->GetMetadataForFile(number, &level, &metadata, &cfd);
D
Dhruba Borthakur 已提交
5653
    if (!status.ok()) {
5654
      Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5655
          "DeleteFile %s failed. File not found\n", name.c_str());
I
Igor Canadi 已提交
5656
      job_context.Clean();
D
Dhruba Borthakur 已提交
5657 5658
      return Status::InvalidArgument("File not found");
    }
5659
    assert(level < cfd->NumberLevels());
5660

D
Dhruba Borthakur 已提交
5661
    // If the file is being compacted no need to delete.
5662
    if (metadata->being_compacted) {
5663
      Log(InfoLogLevel::INFO_LEVEL, immutable_db_options_.info_log,
5664
          "DeleteFile %s Skipped. File about to be compacted\n", name.c_str());
I
Igor Canadi 已提交
5665
      job_context.Clean();
D
Dhruba Borthakur 已提交
5666
      return Status::OK();
5667 5668
    }

D
Dhruba Borthakur 已提交
5669 5670 5671
    // 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 已提交
5672
    auto* vstoreage = cfd->current()->storage_info();
I
Igor Canadi 已提交
5673
    for (int i = level + 1; i < cfd->NumberLevels(); i++) {
S
sdong 已提交
5674
      if (vstoreage->NumLevelFiles(i) != 0) {
5675
        Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5676
            "DeleteFile %s FAILED. File not in last level\n", name.c_str());
I
Igor Canadi 已提交
5677
        job_context.Clean();
D
Dhruba Borthakur 已提交
5678 5679 5680
        return Status::InvalidArgument("File not in last level");
      }
    }
5681
    // if level == 0, it has to be the oldest file
S
sdong 已提交
5682 5683
    if (level == 0 &&
        vstoreage->LevelFiles(0).back()->fd.GetNumber() != number) {
5684
      Log(InfoLogLevel::WARN_LEVEL, immutable_db_options_.info_log,
5685
          "DeleteFile %s failed ---"
5686 5687
          " target file in level 0 must be the oldest.",
          name.c_str());
I
Igor Canadi 已提交
5688
      job_context.Clean();
5689 5690 5691
      return Status::InvalidArgument("File in level 0, but not oldest");
    }
    edit.SetColumnFamily(cfd->GetID());
D
Dhruba Borthakur 已提交
5692
    edit.DeleteFile(level, number);
5693
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
5694
                                    &edit, &mutex_, directories_.GetDbDir());
I
Igor Canadi 已提交
5695
    if (status.ok()) {
I
Igor Canadi 已提交
5696 5697
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
I
Igor Canadi 已提交
5698
    }
I
Igor Canadi 已提交
5699 5700
    FindObsoleteFiles(&job_context, false);
  }  // lock released here
5701

5702
  LogFlush(immutable_db_options_.info_log);
5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717
  // 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;
5718
  std::vector<FileMetaData*> deleted_files;
5719 5720 5721
  JobContext job_context(next_job_id_.fetch_add(1), true);
  {
    InstrumentedMutexLock l(&mutex_);
5722
    Version* input_version = cfd->current();
5723

5724 5725
    auto* vstorage = input_version->storage_info();
    for (int i = 1; i < cfd->NumberLevels(); i++) {
5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746
      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);
5747 5748 5749
      FileMetaData* level_file;
      for (uint32_t j = 0; j < level_files.size(); j++) {
        level_file = level_files[j];
5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760
        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());
5761 5762
          deleted_files.push_back(level_file);
          level_file->being_compacted = true;
5763 5764 5765 5766
        }
      }
    }
    if (edit.GetDeletedFiles().empty()) {
5767
      job_context.Clean();
5768 5769
      return Status::OK();
    }
5770
    input_version->Ref();
5771 5772 5773 5774 5775 5776
    status = versions_->LogAndApply(cfd, *cfd->GetLatestMutableCFOptions(),
                                    &edit, &mutex_, directories_.GetDbDir());
    if (status.ok()) {
      InstallSuperVersionAndScheduleWorkWrapper(
          cfd, &job_context, *cfd->GetLatestMutableCFOptions());
    }
5777 5778 5779 5780
    for (auto* deleted_file : deleted_files) {
      deleted_file->being_compacted = false;
    }
    input_version->Unref();
5781 5782 5783
    FindObsoleteFiles(&job_context, false);
  }  // lock released here

5784
  LogFlush(immutable_db_options_.info_log);
I
Igor Canadi 已提交
5785
  // remove files outside the db-lock
I
Igor Canadi 已提交
5786
  if (job_context.HaveSomethingToDelete()) {
5787
    // Call PurgeObsoleteFiles() without holding mutex.
I
Igor Canadi 已提交
5788
    PurgeObsoleteFiles(job_context);
5789
  }
I
Igor Canadi 已提交
5790
  job_context.Clean();
5791 5792 5793
  return status;
}

5794
void DBImpl::GetLiveFilesMetaData(std::vector<LiveFileMetaData>* metadata) {
5795
  InstrumentedMutexLock l(&mutex_);
5796
  versions_->GetLiveFilesMetaData(metadata);
5797
}
5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808

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 已提交
5809
#endif  // ROCKSDB_LITE
5810

I
Igor Canadi 已提交
5811 5812 5813 5814 5815 5816 5817
Status DBImpl::CheckConsistency() {
  mutex_.AssertHeld();
  std::vector<LiveFileMetaData> metadata;
  versions_->GetLiveFilesMetaData(&metadata);

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

I
Igor Canadi 已提交
5821 5822
    uint64_t fsize = 0;
    Status s = env_->GetFileSize(file_path, &fsize);
D
dyniusz 已提交
5823 5824 5825 5826
    if (!s.ok() &&
        env_->GetFileSize(Rocks2LevelTableFileName(file_path), &fsize).ok()) {
      s = Status::OK();
    }
I
Igor Canadi 已提交
5827 5828 5829 5830
    if (!s.ok()) {
      corruption_messages +=
          "Can't access " + md.name + ": " + s.ToString() + "\n";
    } else if (fsize != md.size) {
5831
      corruption_messages += "Sst file size mismatch: " + file_path +
I
Igor Canadi 已提交
5832
                             ". Size recorded in manifest " +
5833 5834
                             ToString(md.size) + ", actual size " +
                             ToString(fsize) + "\n";
I
Igor Canadi 已提交
5835 5836 5837 5838 5839 5840 5841 5842 5843
    }
  }
  if (corruption_messages.size() == 0) {
    return Status::OK();
  } else {
    return Status::Corruption(corruption_messages);
  }
}

5844
Status DBImpl::GetDbIdentity(std::string& identity) const {
5845 5846
  std::string idfilename = IdentityFileName(dbname_);
  const EnvOptions soptions;
5847 5848 5849 5850 5851 5852 5853 5854 5855
  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)));
5856
  }
5857

5858 5859 5860 5861 5862
  uint64_t file_size;
  s = env_->GetFileSize(idfilename, &file_size);
  if (!s.ok()) {
    return s;
  }
D
Dmitri Smirnov 已提交
5863
  char* buffer = reinterpret_cast<char*>(alloca(file_size));
5864
  Slice id;
5865
  s = id_file_reader->Read(static_cast<size_t>(file_size), &id, buffer);
5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876
  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 已提交
5877 5878
// Default implementations of convenience methods that subclasses of DB
// can call if they wish
5879
Status DB::Put(const WriteOptions& opt, ColumnFamilyHandle* column_family,
5880
               const Slice& key, const Slice& value) {
5881 5882 5883 5884
  // 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);
5885
  batch.Put(column_family, key, value);
J
jorlow@chromium.org 已提交
5886 5887 5888
  return Write(opt, &batch);
}

5889 5890
Status DB::Delete(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                  const Slice& key) {
J
jorlow@chromium.org 已提交
5891
  WriteBatch batch;
5892
  batch.Delete(column_family, key);
J
jorlow@chromium.org 已提交
5893 5894 5895
  return Write(opt, &batch);
}

A
Andres Noetzli 已提交
5896 5897 5898 5899 5900 5901 5902
Status DB::SingleDelete(const WriteOptions& opt,
                        ColumnFamilyHandle* column_family, const Slice& key) {
  WriteBatch batch;
  batch.SingleDelete(column_family, key);
  return Write(opt, &batch);
}

A
Andrew Kryczka 已提交
5903 5904 5905 5906 5907 5908 5909 5910
Status DB::DeleteRange(const WriteOptions& opt,
                       ColumnFamilyHandle* column_family,
                       const Slice& begin_key, const Slice& end_key) {
  WriteBatch batch;
  batch.DeleteRange(column_family, begin_key, end_key);
  return Write(opt, &batch);
}

5911 5912
Status DB::Merge(const WriteOptions& opt, ColumnFamilyHandle* column_family,
                 const Slice& key, const Slice& value) {
5913
  WriteBatch batch;
5914
  batch.Merge(column_family, key, value);
5915 5916 5917
  return Write(opt, &batch);
}

5918
// Default implementation -- returns not supported status
L
Lei Jin 已提交
5919
Status DB::CreateColumnFamily(const ColumnFamilyOptions& cf_options,
5920
                              const std::string& column_family_name,
5921
                              ColumnFamilyHandle** handle) {
5922
  return Status::NotSupported("");
5923
}
5924
Status DB::DropColumnFamily(ColumnFamilyHandle* column_family) {
5925
  return Status::NotSupported("");
5926
}
5927 5928 5929 5930
Status DB::DestroyColumnFamilyHandle(ColumnFamilyHandle* column_family) {
  delete column_family;
  return Status::OK();
}
5931

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

J
Jim Paton 已提交
5934
Status DB::Open(const Options& options, const std::string& dbname, DB** dbptr) {
5935 5936 5937 5938
  DBOptions db_options(options);
  ColumnFamilyOptions cf_options(options);
  std::vector<ColumnFamilyDescriptor> column_families;
  column_families.push_back(
5939
      ColumnFamilyDescriptor(kDefaultColumnFamilyName, cf_options));
5940
  std::vector<ColumnFamilyHandle*> handles;
5941
  Status s = DB::Open(db_options, dbname, column_families, &handles, dbptr);
5942 5943 5944 5945 5946 5947 5948
  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;
5949 5950
}

5951 5952
Status DB::Open(const DBOptions& db_options, const std::string& dbname,
                const std::vector<ColumnFamilyDescriptor>& column_families,
5953
                std::vector<ColumnFamilyHandle*>* handles, DB** dbptr) {
5954
  Status s = SanitizeOptionsByTable(db_options, column_families);
5955 5956 5957
  if (!s.ok()) {
    return s;
  }
5958

5959 5960 5961
  s = ValidateOptions(db_options, column_families);
  if (!s.ok()) {
    return s;
5962 5963
  }

5964
  *dbptr = nullptr;
5965
  handles->clear();
J
jorlow@chromium.org 已提交
5966

I
Igor Canadi 已提交
5967 5968 5969 5970
  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);
5971
  }
5972

I
Igor Canadi 已提交
5973
  DBImpl* impl = new DBImpl(db_options, dbname);
5974
  s = impl->env_->CreateDirIfMissing(impl->immutable_db_options_.wal_dir);
5975
  if (s.ok()) {
5976
    for (auto db_path : impl->immutable_db_options_.db_paths) {
5977
      s = impl->env_->CreateDirIfMissing(db_path.path);
5978 5979 5980 5981 5982 5983
      if (!s.ok()) {
        break;
      }
    }
  }

5984 5985 5986 5987 5988 5989
  if (!s.ok()) {
    delete impl;
    return s;
  }

  s = impl->CreateArchivalDirectory();
5990 5991 5992 5993
  if (!s.ok()) {
    delete impl;
    return s;
  }
J
jorlow@chromium.org 已提交
5994
  impl->mutex_.Lock();
5995 5996
  // Handles create_if_missing, error_if_exists
  s = impl->Recover(column_families);
J
jorlow@chromium.org 已提交
5997
  if (s.ok()) {
5998
    uint64_t new_log_number = impl->versions_->NewFileNumber();
5999
    unique_ptr<WritableFile> lfile;
6000
    EnvOptions soptions(db_options);
6001
    EnvOptions opt_env_options =
6002 6003 6004 6005 6006 6007 6008
        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 已提交
6009
    if (s.ok()) {
6010 6011
      lfile->SetPreallocationBlockSize(
          impl->GetWalPreallocateBlockSize(max_write_buffer_size));
6012
      impl->logfile_number_ = new_log_number;
6013 6014
      unique_ptr<WritableFileWriter> file_writer(
          new WritableFileWriter(std::move(lfile), opt_env_options));
6015 6016
      impl->logs_.emplace_back(
          new_log_number,
6017 6018 6019
          new log::Writer(
              std::move(file_writer), new_log_number,
              impl->immutable_db_options_.recycle_log_file_num > 0));
I
Igor Canadi 已提交
6020

6021 6022
      // set column family handles
      for (auto cf : column_families) {
I
Igor Canadi 已提交
6023 6024
        auto cfd =
            impl->versions_->GetColumnFamilySet()->GetColumnFamily(cf.name);
I
Igor Canadi 已提交
6025 6026 6027
        if (cfd != nullptr) {
          handles->push_back(
              new ColumnFamilyHandleImpl(cfd, impl, &impl->mutex_));
6028
          impl->NewThreadStatusCfInfo(cfd);
I
Igor Canadi 已提交
6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044
        } 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 已提交
6045
        }
6046
      }
I
Igor Canadi 已提交
6047 6048
    }
    if (s.ok()) {
6049
      for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
I
Igor Canadi 已提交
6050
        delete impl->InstallSuperVersionAndScheduleWork(
L
Lei Jin 已提交
6051
            cfd, nullptr, *cfd->GetLatestMutableCFOptions());
6052
      }
I
Igor Canadi 已提交
6053 6054
      impl->alive_log_files_.push_back(
          DBImpl::LogFileNumberSize(impl->logfile_number_));
J
jorlow@chromium.org 已提交
6055
      impl->DeleteObsoleteFiles();
6056
      s = impl->directories_.GetDbDir()->Fsync();
J
jorlow@chromium.org 已提交
6057 6058
    }
  }
6059

I
Igor Canadi 已提交
6060 6061
  if (s.ok()) {
    for (auto cfd : *impl->versions_->GetColumnFamilySet()) {
S
sdong 已提交
6062
      if (cfd->ioptions()->compaction_style == kCompactionStyleFIFO) {
S
sdong 已提交
6063
        auto* vstorage = cfd->current()->storage_info();
6064
        for (int i = 1; i < vstorage->num_levels(); ++i) {
S
sdong 已提交
6065
          int num_files = vstorage->NumLevelFiles(i);
I
Igor Canadi 已提交
6066
          if (num_files > 0) {
I
Igor Canadi 已提交
6067 6068
            s = Status::InvalidArgument(
                "Not all files are at level 0. Cannot "
S
sdong 已提交
6069
                "open with FIFO compaction style.");
I
Igor Canadi 已提交
6070 6071 6072 6073
            break;
          }
        }
      }
S
sdong 已提交
6074 6075 6076
      if (!cfd->mem()->IsSnapshotSupported()) {
        impl->is_snapshot_supported_ = false;
      }
6077
      if (cfd->ioptions()->merge_operator != nullptr &&
6078 6079 6080 6081 6082
          !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 已提交
6083
      if (!s.ok()) {
6084 6085 6086 6087
        break;
      }
    }
  }
6088
  TEST_SYNC_POINT("DBImpl::Open:Opened");
6089
  Status persist_options_status;
6090
  if (s.ok()) {
6091 6092 6093 6094
    // Persist RocksDB Options before scheduling the compaction.
    // The WriteOptionsFile() will release and lock the mutex internally.
    persist_options_status = impl->WriteOptionsFile();

6095
    *dbptr = impl;
6096 6097 6098
    impl->opened_successfully_ = true;
    impl->MaybeScheduleFlushOrCompaction();
  }
6099 6100
  impl->mutex_.Unlock();

6101
#ifndef ROCKSDB_LITE
6102
  auto sfm = static_cast<SstFileManagerImpl*>(
6103
      impl->immutable_db_options_.sst_file_manager.get());
6104 6105 6106
  if (s.ok() && sfm) {
    // Notify SstFileManager about all sst files that already exist in
    // db_paths[0] when the DB is opened.
6107
    auto& db_path = impl->immutable_db_options_.db_paths[0];
6108
    std::vector<std::string> existing_files;
6109
    impl->immutable_db_options_.env->GetChildren(db_path.path, &existing_files);
6110 6111 6112 6113 6114 6115 6116 6117 6118 6119
    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);
      }
    }
  }
6120
#endif  // !ROCKSDB_LITE
6121

J
jorlow@chromium.org 已提交
6122
  if (s.ok()) {
6123 6124 6125
    Log(InfoLogLevel::INFO_LEVEL, impl->immutable_db_options_.info_log,
        "DB pointer %p", impl);
    LogFlush(impl->immutable_db_options_.info_log);
6126 6127 6128 6129 6130 6131
    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());
      }
6132
      Warn(impl->immutable_db_options_.info_log,
6133 6134 6135 6136
           "Unable to persist options in DB::Open() -- %s",
           persist_options_status.ToString().c_str());
    }
  }
6137
  if (!s.ok()) {
Y
Yueh-Hsuan Chiang 已提交
6138
    for (auto* h : *handles) {
6139 6140
      delete h;
    }
6141
    handles->clear();
J
jorlow@chromium.org 已提交
6142
    delete impl;
6143
    *dbptr = nullptr;
J
jorlow@chromium.org 已提交
6144 6145 6146 6147
  }
  return s;
}

6148 6149 6150
Status DB::ListColumnFamilies(const DBOptions& db_options,
                              const std::string& name,
                              std::vector<std::string>* column_families) {
I
Igor Canadi 已提交
6151
  return VersionSet::ListColumnFamilies(column_families, name, db_options.env);
6152 6153
}

6154 6155 6156
Snapshot::~Snapshot() {
}

J
jorlow@chromium.org 已提交
6157
Status DestroyDB(const std::string& dbname, const Options& options) {
6158
  const ImmutableDBOptions soptions(SanitizeOptions(dbname, options));
6159
  Env* env = soptions.env;
J
jorlow@chromium.org 已提交
6160
  std::vector<std::string> filenames;
6161

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

J
jorlow@chromium.org 已提交
6165
  FileLock* lock;
6166 6167
  const std::string lockname = LockFileName(dbname);
  Status result = env->LockFile(lockname, &lock);
J
jorlow@chromium.org 已提交
6168 6169 6170
  if (result.ok()) {
    uint64_t number;
    FileType type;
6171
    InfoLogPrefix info_log_prefix(!soptions.db_log_dir.empty(), dbname);
D
dgrogan@chromium.org 已提交
6172
    for (size_t i = 0; i < filenames.size(); i++) {
6173
      if (ParseFileName(filenames[i], &number, info_log_prefix.prefix, &type) &&
6174
          type != kDBLockFile) {  // Lock file will be deleted at end
K
Kosie van der Merwe 已提交
6175
        Status del;
6176
        std::string path_to_delete = dbname + "/" + filenames[i];
K
Kosie van der Merwe 已提交
6177
        if (type == kMetaDatabase) {
6178 6179
          del = DestroyDB(path_to_delete, options);
        } else if (type == kTableFile) {
6180
          del = DeleteSSTFile(&soptions, path_to_delete, 0);
K
Kosie van der Merwe 已提交
6181
        } else {
6182
          del = env->DeleteFile(path_to_delete);
K
Kosie van der Merwe 已提交
6183
        }
J
jorlow@chromium.org 已提交
6184 6185 6186 6187 6188
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
6189

6190 6191
    for (size_t path_id = 0; path_id < options.db_paths.size(); path_id++) {
      const auto& db_path = options.db_paths[path_id];
6192
      env->GetChildren(db_path.path, &filenames);
6193 6194 6195
      for (size_t i = 0; i < filenames.size(); i++) {
        if (ParseFileName(filenames[i], &number, &type) &&
            type == kTableFile) {  // Lock file will be deleted at end
6196
          std::string table_path = db_path.path + "/" + filenames[i];
6197
          Status del = DeleteSSTFile(&soptions, table_path,
6198
                                     static_cast<uint32_t>(path_id));
6199 6200 6201 6202 6203 6204 6205
          if (result.ok() && !del.ok()) {
            result = del;
          }
        }
      }
    }

I
Igor Canadi 已提交
6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223
    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;
6224
    env->GetChildren(archivedir, &archiveFiles);
6225 6226
    // Delete archival files.
    for (size_t i = 0; i < archiveFiles.size(); ++i) {
6227 6228
      if (ParseFileName(archiveFiles[i], &number, &type) &&
          type == kLogFile) {
6229
        Status del = env->DeleteFile(archivedir + "/" + archiveFiles[i]);
6230 6231 6232 6233 6234
        if (result.ok() && !del.ok()) {
          result = del;
        }
      }
    }
6235

6236
    // ignore case where no archival directory is present.
6237
    env->DeleteDir(archivedir);
6238

J
jorlow@chromium.org 已提交
6239
    env->UnlockFile(lock);  // Ignore error since state is already gone
6240
    env->DeleteFile(lockname);
J
jorlow@chromium.org 已提交
6241
    env->DeleteDir(dbname);  // Ignore error in case dir contains other files
6242
    env->DeleteDir(soptions.wal_dir);
J
jorlow@chromium.org 已提交
6243 6244 6245 6246
  }
  return result;
}

6247 6248
Status DBImpl::WriteOptionsFile() {
#ifndef ROCKSDB_LITE
6249
  mutex_.AssertHeld();
6250 6251 6252

  std::vector<std::string> cf_names;
  std::vector<ColumnFamilyOptions> cf_opts;
6253 6254 6255 6256 6257

  // This part requires mutex to protect the column family options
  for (auto cfd : *versions_->GetColumnFamilySet()) {
    if (cfd->IsDropped()) {
      continue;
6258
    }
6259
    cf_names.push_back(cfd->GetName());
6260
    cf_opts.push_back(cfd->GetLatestCFOptions());
6261 6262
  }

6263 6264
  // Unlock during expensive operations.  New writes cannot get here
  // because the single write thread ensures all new writes get queued.
6265 6266
  DBOptions db_options =
      BuildDBOptions(immutable_db_options_, mutable_db_options_);
6267 6268 6269 6270
  mutex_.Unlock();

  std::string file_name =
      TempOptionsFileName(GetName(), versions_->NewFileNumber());
6271 6272
  Status s =
      PersistRocksDBOptions(db_options, cf_names, cf_opts, file_name, GetEnv());
6273 6274 6275 6276 6277

  if (s.ok()) {
    s = RenameTempFileToOptionsFile(file_name);
  }
  mutex_.Lock();
6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326
  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,
6327
                           immutable_db_options_.info_log, GetEnv());
6328 6329 6330 6331 6332 6333 6334 6335 6336
  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 已提交
6337 6338

  versions_->options_file_number_ = versions_->NewFileNumber();
6339
  std::string options_file_name =
W
Wanning Jiang 已提交
6340
      OptionsFileName(GetName(), versions_->options_file_number_);
6341 6342 6343 6344 6345 6346 6347 6348 6349 6350
  // 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
}

D
Daniel Black 已提交
6351
#ifdef ROCKSDB_USING_THREAD_STATUS
6352

Y
Yueh-Hsuan Chiang 已提交
6353 6354
void DBImpl::NewThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6355
  if (immutable_db_options_.enable_thread_tracking) {
6356 6357
    ThreadStatusUtil::NewColumnFamilyInfo(this, cfd, cfd->GetName(),
                                          cfd->ioptions()->env);
6358
  }
Y
Yueh-Hsuan Chiang 已提交
6359 6360 6361 6362
}

void DBImpl::EraseThreadStatusCfInfo(
    ColumnFamilyData* cfd) const {
6363
  if (immutable_db_options_.enable_thread_tracking) {
6364
    ThreadStatusUtil::EraseColumnFamilyInfo(cfd);
6365
  }
Y
Yueh-Hsuan Chiang 已提交
6366 6367 6368
}

void DBImpl::EraseThreadStatusDbInfo() const {
6369
  if (immutable_db_options_.enable_thread_tracking) {
6370
    ThreadStatusUtil::EraseDatabaseInfo(this);
6371
  }
Y
Yueh-Hsuan Chiang 已提交
6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386
}

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

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

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

6387 6388
//
// A global method that can dump out the build version
I
Igor Canadi 已提交
6389
void DumpRocksDBBuildVersion(Logger * log) {
I
Igor Canadi 已提交
6390
#if !defined(IOS_CROSS_COMPILE)
I
Igor Canadi 已提交
6391 6392
  // if we compile with Xcode, we don't run build_detect_vesion, so we don't
  // generate util/build_version.cc
6393 6394 6395 6396
  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 已提交
6397
#endif
6398 6399
}

A
agiardullo 已提交
6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416
#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
6417 6418 6419
Status DBImpl::GetLatestSequenceForKey(SuperVersion* sv, const Slice& key,
                                       bool cache_only, SequenceNumber* seq,
                                       bool* found_record_for_key) {
A
agiardullo 已提交
6420 6421
  Status s;
  MergeContext merge_context;
6422 6423
  RangeDelAggregator range_del_agg(sv->mem->GetInternalKeyComparator(),
                                   kMaxSequenceNumber);
A
agiardullo 已提交
6424

A
Andrew Kryczka 已提交
6425
  ReadOptions read_options;
A
agiardullo 已提交
6426 6427 6428 6429
  SequenceNumber current_seq = versions_->LastSequence();
  LookupKey lkey(key, current_seq);

  *seq = kMaxSequenceNumber;
6430 6431
  *found_record_for_key = false;

A
agiardullo 已提交
6432
  // Check if there is a record for this key in the latest memtable
M
Maysam Yabandeh 已提交
6433
  sv->mem->Get(lkey, nullptr, &s, &merge_context, &range_del_agg, seq,
A
Andrew Kryczka 已提交
6434
               read_options);
A
agiardullo 已提交
6435 6436 6437

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6438
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
A
agiardullo 已提交
6439 6440 6441 6442 6443 6444 6445 6446
        "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
6447
    *found_record_for_key = true;
A
agiardullo 已提交
6448 6449 6450 6451
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
M
Maysam Yabandeh 已提交
6452
  sv->imm->Get(lkey, nullptr, &s, &merge_context, &range_del_agg, seq,
A
Andrew Kryczka 已提交
6453
               read_options);
A
agiardullo 已提交
6454 6455 6456

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6457
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
A
agiardullo 已提交
6458 6459 6460 6461 6462 6463 6464 6465
        "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
6466
    *found_record_for_key = true;
A
agiardullo 已提交
6467 6468 6469 6470
    return Status::OK();
  }

  // Check if there is a record for this key in the immutable memtables
A
Andrew Kryczka 已提交
6471 6472
  sv->imm->GetFromHistory(lkey, nullptr, &s, &merge_context, &range_del_agg,
                          seq, read_options);
A
agiardullo 已提交
6473 6474 6475

  if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
    // unexpected error reading memtable.
6476
    Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
A
agiardullo 已提交
6477 6478 6479 6480 6481 6482
        "Unexpected status returned from MemTableList::GetFromHistory: %s\n",
        s.ToString().c_str());

    return s;
  }

6483 6484 6485 6486 6487 6488 6489 6490 6491 6492
  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 已提交
6493
    sv->current->Get(read_options, lkey, nullptr, &s, &merge_context,
A
Andrew Kryczka 已提交
6494 6495
                     &range_del_agg, nullptr /* value_found */,
                     found_record_for_key, seq);
6496 6497 6498

    if (!(s.ok() || s.IsNotFound() || s.IsMergeInProgress())) {
      // unexpected error reading SST files
6499
      Log(InfoLogLevel::ERROR_LEVEL, immutable_db_options_.info_log,
6500 6501 6502 6503 6504 6505 6506
          "Unexpected status returned from Version::Get: %s\n",
          s.ToString().c_str());

      return s;
    }
  }

A
agiardullo 已提交
6507 6508
  return Status::OK();
}
6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524

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

  std::list<uint64_t>::iterator pending_output_elem;
  {
    InstrumentedMutexLock l(&mutex_);
6525 6526 6527 6528 6529 6530
    if (!bg_error_.ok()) {
      // Don't ingest files when there is a bg_error
      return bg_error_;
    }

    // Make sure that bg cleanup wont delete the files that we are ingesting
6531 6532 6533 6534 6535 6536 6537 6538
    pending_output_elem = CaptureCurrentFileNumberInPendingOutputs();
  }

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

6539
  TEST_SYNC_POINT("DBImpl::AddFile:Start");
6540 6541 6542 6543 6544 6545 6546 6547 6548
  {
    // 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_);

6549 6550
    num_running_ingest_file_++;

6551 6552 6553 6554 6555 6556
    // We cannot ingest a file into a dropped CF
    if (cfd->IsDropped()) {
      status = Status::InvalidArgument(
          "Cannot ingest an external file into a dropped CF");
    }

6557
    // Figure out if we need to flush the memtable first
6558 6559 6560 6561 6562 6563 6564 6565 6566
    if (status.ok()) {
      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();
      }
6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607
    }

    // 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);

6608 6609 6610 6611
  if (status.ok()) {
    NotifyOnExternalFileIngested(cfd, ingestion_job);
  }

6612 6613 6614
  return status;
}

6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636
void DBImpl::NotifyOnExternalFileIngested(
    ColumnFamilyData* cfd, const ExternalSstFileIngestionJob& ingestion_job) {
#ifndef ROCKSDB_LITE
  if (immutable_db_options_.listeners.empty()) {
    return;
  }

  for (const IngestedFileInfo& f : ingestion_job.files_to_ingest()) {
    ExternalFileIngestionInfo info;
    info.cf_name = cfd->GetName();
    info.external_file_path = f.external_file_path;
    info.internal_file_path = f.internal_file_path;
    info.global_seqno = f.assigned_seqno;
    info.table_properties = f.table_properties;
    for (auto listener : immutable_db_options_.listeners) {
      listener->OnExternalFileIngested(this, info);
    }
  }

#endif
}

6637 6638 6639 6640 6641 6642 6643
void DBImpl::WaitForIngestFile() {
  mutex_.AssertHeld();
  while (num_running_ingest_file_ > 0) {
    bg_cv_.Wait();
  }
}

A
agiardullo 已提交
6644 6645
#endif  // ROCKSDB_LITE

6646
}  // namespace rocksdb